net.sf.gridarta.gui.utils.tristate

Enum TristateState

java.lang.Object

java.lang.Enum<TristateState>

net.sf.gridarta.gui.utils.tristate.TristateState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TristateState>

public enum TristateState
extends java.lang.Enum<TristateState>

Possible states for TristateButtonModels.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DESELECTED The check box is not selected.
INDETERMINATE The check box is in indeterminate state.
SELECTED The check box is selected.

Method Summary

Modifier and Type	Method and Description
static @NotNull TristateState	getTristateState(boolean state) Returns the tristate state for a boolean state.
abstract @NotNull TristateState	nextTristateState() Returns the next state when selected.
static TristateState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TristateState[]	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

DESELECTED

public static final TristateState DESELECTED

The check box is not selected.

INDETERMINATE

public static final TristateState INDETERMINATE

The check box is in indeterminate state.

SELECTED

public static final TristateState SELECTED

The check box is selected.

Method Detail

values

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

Returns:

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

valueOf

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

nextTristateState

@NotNull
public abstract @NotNull TristateState nextTristateState()

Returns the next state when selected.

Returns:

the next state

getTristateState

@NotNull
public static @NotNull TristateState getTristateState(boolean state)

Returns the tristate state for a boolean state.

Parameters:

state - the boolean state

Returns:

the tristate state