org.xith3d.ui.hud.base
Enum StateButton.State

java.lang.Object
  java.lang.Enum<StateButton.State>
      org.xith3d.ui.hud.base.StateButton.State

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<StateButton.State>

Enclosing class:

StateButton

public static enum StateButton.State
extends java.lang.Enum<StateButton.State>

All states of a StateButton

Enum Constant Summary

ACTIVATED_HOVERED

ACTIVATED_NORMAL

DEACTIVATED_HOVERED

DEACTIVATED_NORMAL

Method Summary

boolean	isActivated()
boolean	isHovered()
static StateButton.State	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static StateButton.State[]	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

DEACTIVATED_NORMAL

public static final StateButton.State DEACTIVATED_NORMAL

DEACTIVATED_HOVERED

public static final StateButton.State DEACTIVATED_HOVERED

ACTIVATED_NORMAL

public static final StateButton.State ACTIVATED_NORMAL

ACTIVATED_HOVERED

public static final StateButton.State ACTIVATED_HOVERED

Method Detail

values

public static StateButton.State[] 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 (StateButton.State c : StateButton.State.values())
    System.out.println(c);

Returns:

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

valueOf

public static StateButton.State 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

isActivated

public boolean isActivated()

Returns:

Is this state an ACTIVATED state?

isHovered

public boolean isHovered()

Returns:

Is this state a HOVERED state?