Enum Axis

  • All Implemented Interfaces:
    Serializable, Comparable<Axis>

    public enum Axis
    extends Enum<Axis>
    An enumeration of the axes.
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    • Enum Constant Detail

      • LEFT

        public static final Axis LEFT
        left of the content panel.
      • RIGHT

        public static final Axis RIGHT
        right of the content panel.
      • TOP

        public static final Axis TOP
        over of the content panel.
      • BOTTOM

        public static final Axis BOTTOM
        below of the content panel.
    • Method Detail

      • values

        public static Axis[] 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 (Axis c : Axis.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static Axis 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
      • getRaw

        public String getRaw()
        Returns the raw string, used in super.toString().
        Returns:
        the raw string
      • getDisplay

        public String getDisplay()
        Returns the display string, used in toString().
        Returns:
        the display string
        See Also:
        toString()
      • getDisplayShort

        public String getDisplayShort()
        Returns the short display string.
        Returns:
        the display string
      • toString

        public String toString()
        Returns the display string.
        Overrides:
        toString in class Enum<Axis>
        Returns:
        the display string
      • parse

        public static Axis parse​(String str)
        Returns an enum generated from the string.
        Parameters:
        str - the string to convert to an enum
        Returns:
        the generated enum or null in case of error