Package com.iizix.prop

Enum StylesStates

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<StylesStates>
    public enum StylesStates
extends java.lang.Enum<StylesStates>
    The enum for the supported Styles States for UI components.

    This enum maps directly onto the image states, except the two last ones "READ_ONLY" and "HYPERLINK".

    Author:
    Christopher Mindus

    • Enum Constant Summary

      Enum Constants 
      Enum ConstantDescription
      CAPTURE
      Capture (0x40) means mouse capture.
      DISABLE
      Disabled (0x02).
      FOCUS
      Focused (0x10).
      HOVER
      Hover (0x20), i.e.
      HYPERLINK
      Hyperlink (0x100).
      PRESS
      Pressed (0x04).
      READ_ONLY
      Read-only.
      RTL
      Right-to-left (0x01).
      SELECT
      Selected (0x08): selected checkbox, radio button, checked or radio menu item item, switch, plain button, etc.

    • Field Summary

      Fields 
      Modifier and TypeFieldDescription
      intbitValue
      The bit value of the state, or'ed together to make up a specific state.
      java.lang.Stringdescription
      The description of the value.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static java.lang.StringgetDescription​(int mask)
      Returns the states descriptive text for a bit mask value.
      static java.lang.StringgetDescriptionNoHyperlink​(int mask)
      Returns the states descriptive text for a bit mask value, including the hyperlink state.
      static StylesStatesvalueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static StylesStates[]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

      • RTL

        public static final StylesStates RTL
        Right-to-left (0x01).

      • DISABLE

        public static final StylesStates DISABLE
        Disabled (0x02).

      • SELECT

        public static final StylesStates SELECT
        Selected (0x08): selected checkbox, radio button, checked or radio menu item item, switch, plain button, etc.

      • HOVER

        public static final StylesStates HOVER
        Hover (0x20), i.e. mouse hovers over component.

      • CAPTURE

        public static final StylesStates CAPTURE
        Capture (0x40) means mouse capture. This state may have to go away but remains here for compatibility with Styles of Images.

      • READ_ONLY

        public static final StylesStates READ_ONLY
        Read-only.

      • HYPERLINK

        public static final StylesStates HYPERLINK
        Hyperlink (0x100). This state is typically used with the Label component.

    • Field Detail

      • bitValue

        public final int bitValue
        The bit value of the state, or'ed together to make up a specific state.

      • description

        public final java.lang.String description
        The description of the value.

    • Method Detail

      • values

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

      • valueOf

        public static StylesStates valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getDescription

        public static java.lang.String getDescription​(int mask)
        Returns the states descriptive text for a bit mask value.
        Parameters:
        mask - The mask value, -1 if undefined.
        Returns:
        The corresponding mask description text.

      • getDescriptionNoHyperlink

        public static java.lang.String getDescriptionNoHyperlink​(int mask)
        Returns the states descriptive text for a bit mask value, including the hyperlink state.
        Parameters:
        mask - The mask value, -1 if undefined.
        Returns:
        The corresponding mask description text.