bibliothek.gui.dock.component
Enum DockComponentRootHandler.TraverseResult

java.lang.Object
  java.lang.Enum<DockComponentRootHandler.TraverseResult>
      bibliothek.gui.dock.component.DockComponentRootHandler.TraverseResult

All Implemented Interfaces:

Serializable, Comparable<DockComponentRootHandler.TraverseResult>

Enclosing class:

DockComponentRootHandler

protected static enum DockComponentRootHandler.TraverseResult
extends Enum<DockComponentRootHandler.TraverseResult>

Behavior for traversing the Component tree

Author:

Benjamin Sigg

Enum Constant Summary

EXCLUDE
do not traverse a Component

EXCLUDE_CHILDREN
traverse a Component, but do not visit the children

INCLUDE_CHILDREN
traverse a Component and its children

Method Summary

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

INCLUDE_CHILDREN

public static final DockComponentRootHandler.TraverseResult INCLUDE_CHILDREN

traverse a Component and its children

EXCLUDE_CHILDREN

public static final DockComponentRootHandler.TraverseResult EXCLUDE_CHILDREN

traverse a Component, but do not visit the children

EXCLUDE

public static final DockComponentRootHandler.TraverseResult EXCLUDE

do not traverse a Component

Method Detail

values

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

Returns:

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

valueOf

public static DockComponentRootHandler.TraverseResult 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