org.apache.myfaces.tobago.model

Enum Selectable

java.lang.Object

java.lang.Enum<Selectable>

org.apache.myfaces.tobago.model.Selectable

All Implemented Interfaces:

Serializable, Comparable<Selectable>

public enum Selectable
extends Enum<Selectable>

Enum Constant Summary

Enum Constants

Enum Constant and Description
multi Multi selection possible.
multiCascade Multi selection possible.
multiLeafOnly Only leafs are selectable.
none Not selectable.
sibling Only siblings are selectable.
siblingLeafOnly Only siblings are selectable and they have to be leafs.
single Only one item is selectable.
singleLeafOnly Only one item is selectable and it must be a leaf.
singleOrNone Only one of no item is selectable.

Field Summary

Fields

Modifier and Type	Field and Description
static Selectable	MULTI Deprecated.
static Selectable	MULTI_CASCADE Deprecated.
static Selectable	MULTI_LEAF_ONLY Deprecated.
static Selectable	NONE Deprecated.
static Set<Selectable>	SHEET_VALUES
static Selectable	SIBLING Deprecated.
static Selectable	SIBLING_LEAF_ONLY Deprecated.
static Selectable	SINGLE Deprecated.
static Selectable	SINGLE_LEAF_ONLY Deprecated.
static Selectable	SINGLE_OR_NONE Deprecated.
static String	STRING_MULTI
static String	STRING_MULTI_CASCADE
static String	STRING_MULTI_LEAF_ONLY
static String	STRING_NONE
static String	STRING_SIBLING
static String	STRING_SIBLING_LEAF_ONLY
static String	STRING_SINGLE
static String	STRING_SINGLE_LEAF_ONLY
static String	STRING_SINGLE_OR_NONE
static Set<Selectable>	TREE_LISTBOX_VALUES
static Set<Selectable>	TREE_VALUES

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isLeafOnly()
boolean	isSingle()
boolean	isSupportedBySheet()
boolean	isSupportedByTree()
boolean	isSupportedByTreeListbox()
static Selectable	parse(Object name)
static Selectable	valueOf(String name) Returns the enum constant of this type with the specified name.
static Selectable[]	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

none

public static final Selectable none

Not selectable.

multi

public static final Selectable multi

Multi selection possible. No other limitations.

single

public static final Selectable single

Only one item is selectable.

singleOrNone

public static final Selectable singleOrNone

Only one of no item is selectable.

multiLeafOnly

public static final Selectable multiLeafOnly

Only leafs are selectable.

singleLeafOnly

public static final Selectable singleLeafOnly

Only one item is selectable and it must be a leaf.

sibling

public static final Selectable sibling

Only siblings are selectable.

siblingLeafOnly

public static final Selectable siblingLeafOnly

Only siblings are selectable and they have to be leafs.

multiCascade

public static final Selectable multiCascade

Multi selection possible. When selecting or deselecting an item, the subtree will also be selected or unselected.

Field Detail

NONE

@Deprecated
public static final Selectable NONE

Deprecated.

MULTI

@Deprecated
public static final Selectable MULTI

Deprecated.

SINGLE

@Deprecated
public static final Selectable SINGLE

Deprecated.

SINGLE_OR_NONE

@Deprecated
public static final Selectable SINGLE_OR_NONE

Deprecated.

MULTI_LEAF_ONLY

@Deprecated
public static final Selectable MULTI_LEAF_ONLY

Deprecated.

SINGLE_LEAF_ONLY

@Deprecated
public static final Selectable SINGLE_LEAF_ONLY

Deprecated.

SIBLING

@Deprecated
public static final Selectable SIBLING

Deprecated.

SIBLING_LEAF_ONLY

@Deprecated
public static final Selectable SIBLING_LEAF_ONLY

Deprecated.

MULTI_CASCADE

@Deprecated
public static final Selectable MULTI_CASCADE

Deprecated.

STRING_NONE

public static final String STRING_NONE

See Also:

Constant Field Values

STRING_MULTI

public static final String STRING_MULTI

See Also:

Constant Field Values

STRING_SINGLE

public static final String STRING_SINGLE

See Also:

Constant Field Values

STRING_SINGLE_OR_NONE

public static final String STRING_SINGLE_OR_NONE

See Also:

Constant Field Values

STRING_MULTI_LEAF_ONLY

public static final String STRING_MULTI_LEAF_ONLY

See Also:

Constant Field Values

STRING_SINGLE_LEAF_ONLY

public static final String STRING_SINGLE_LEAF_ONLY

See Also:

Constant Field Values

STRING_SIBLING

public static final String STRING_SIBLING

See Also:

Constant Field Values

STRING_SIBLING_LEAF_ONLY

public static final String STRING_SIBLING_LEAF_ONLY

See Also:

Constant Field Values

STRING_MULTI_CASCADE

public static final String STRING_MULTI_CASCADE

See Also:

Constant Field Values

SHEET_VALUES

public static final Set<Selectable> SHEET_VALUES

TREE_VALUES

public static final Set<Selectable> TREE_VALUES

TREE_LISTBOX_VALUES

public static final Set<Selectable> TREE_LISTBOX_VALUES

Method Detail

values

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

Returns:

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

valueOf

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

parse

public static Selectable parse(Object name)
                        throws IllegalArgumentException

Parameters:

name - Name of the Selectable

Returns:

The matching tree selection (can't be null).

Throws:

IllegalArgumentException - When the name doesn't match any Selectable.

isLeafOnly

public boolean isLeafOnly()

isSingle

public boolean isSingle()

isSupportedBySheet

public boolean isSupportedBySheet()

isSupportedByTree

public boolean isSupportedByTree()

isSupportedByTreeListbox

public boolean isSupportedByTreeListbox()