org.apache.pivot.wtk
Enum TreeView.NodeCheckState

java.lang.Object
  extended by java.lang.Enum<TreeView.NodeCheckState>
      extended by org.apache.pivot.wtk.TreeView.NodeCheckState
All Implemented Interfaces:
Serializable, Comparable<TreeView.NodeCheckState>
Enclosing class:
TreeView

public static enum TreeView.NodeCheckState
extends Enum<TreeView.NodeCheckState>

Enumeration defining node check states. Note that TreeView does not involve itself in the propagation of checkmarks (either up or down the tree). Developers who wish to propagate checkmarks may do so by registering a TreeViewNodeStateListener and setting the desired checkmark states manually.


Enum Constant Summary
CHECKED
          The node is checked.
MIXED
          The node's check state is mixed, meaning that it is not checked, but at least one of its descendants is checked.
UNCHECKED
          The node is unchecked.
 
Method Summary
static TreeView.NodeCheckState valueOf(String name)
          Returns the enum constant of this type with the specified name.
static TreeView.NodeCheckState[] 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

CHECKED

public static final TreeView.NodeCheckState CHECKED
The node is checked.


UNCHECKED

public static final TreeView.NodeCheckState UNCHECKED
The node is unchecked. If showMixedCheckmarkState is true, this implies that all of the node's descendants are unchecked as well.


MIXED

public static final TreeView.NodeCheckState MIXED
The node's check state is mixed, meaning that it is not checked, but at least one of its descendants is checked. This state will only be reported if showMixedCheckmarkState is true. Otherwise, the node will be reported as UNCHECKED.

Method Detail

values

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

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

valueOf

public static TreeView.NodeCheckState 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