com.flagstone.transform.button
Enum ButtonState

java.lang.Object
  java.lang.Enum<ButtonState>
      com.flagstone.transform.button.ButtonState

All Implemented Interfaces:

Serializable, Comparable<ButtonState>

public enum ButtonState
extends Enum<ButtonState>

ButtonState is used to identify the different states of a button.

Enum Constant Summary

ACTIVE
The active area of the button.

DOWN
The button is being clicked.

OVER
The mouse is over the active area of the button.

UP
The button is up.

Method Summary

static ButtonState	valueOf(String name) Returns the enum constant of this type with the specified name.
static ButtonState[]	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

UP

public static final ButtonState UP

The button is up.

OVER

public static final ButtonState OVER

The mouse is over the active area of the button.

DOWN

public static final ButtonState DOWN

The button is being clicked.

ACTIVE

public static final ButtonState ACTIVE

The active area of the button.

Method Detail

values

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

Returns:

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

valueOf

public static ButtonState 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