org.richfaces

## Enum HeaderPosition

- java.lang.Object
- - java.lang.Enum<HeaderPosition>
  - - org.richfaces.HeaderPosition

- All Implemented Interfaces:
    Serializable, Comparable<HeaderPosition>

      public enum HeaderPosition
      extends Enum<HeaderPosition>

  Since:
    Aug 24, 2010
  Author:
    akolonitsky

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant and Description
    `bottom`
    `left`
    `right`
    `top`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `static HeaderPosition` | `valueOf(String name)` Returns the enum constant of this type with the specified name.
    `static HeaderPosition[]` | `values()` Returns an array containing the constants of this enum type, in the order they are declared.

    - ### Methods inherited from class java.lang.Enum

      `clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

    - ### Methods inherited from class java.lang.Object

      `getClass, notify, notifyAll, wait, wait, wait`

- - ### Enum Constant Detail

    - #### top

          public static final HeaderPosition top

    - #### left

          public static final HeaderPosition left

    - #### right

          public static final HeaderPosition right

    - #### bottom

          public static final HeaderPosition bottom

  - ### Method Detail

    - #### values

          public static HeaderPosition[] values()

      Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

          for (HeaderPosition c : HeaderPosition.values())
              System.out.println(c);

      Returns:
        an array containing the constants of this enum type, in the order they are declared

    - #### valueOf

          public static HeaderPosition valueOf(String name)

      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
        `name` - the name of the enum constant to be returned.
      Returns:
        the enum constant with the specified name
      Throws:
        `IllegalArgumentException` - if this enum type has no constant with the specified name
        `NullPointerException` - if the argument is null

Copyright © 2013 JBoss by Red Hat. All Rights Reserved.