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.
MULTI_CASCADE Multi selection possible.
MULTI_LEAF_ONLY Only leafs are selectable.
NONE Not selectable.
SIBLING Only siblings are selectable.
SIBLING_LEAF_ONLY Only siblings are selectable and they have to be leafs.
SINGLE Only one item is selectable.
SINGLE_LEAF_ONLY Only one item is selectable and it must be a leaf.
SINGLE_OR_NONE Only one of no item is selectable.

Method Summary

Methods

Modifier and Type	Method and Description
String	getValue()
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.

SINGLE_OR_NONE

public static final Selectable SINGLE_OR_NONE

Only one of no item is selectable.

MULTI_LEAF_ONLY

public static final Selectable MULTI_LEAF_ONLY

Only leafs are selectable.

SINGLE_LEAF_ONLY

public static final Selectable SINGLE_LEAF_ONLY

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

SIBLING

public static final Selectable SIBLING

Only siblings are selectable.

SIBLING_LEAF_ONLY

public static final Selectable SIBLING_LEAF_ONLY

Only siblings are selectable and they have to be leafs.

MULTI_CASCADE

public static final Selectable MULTI_CASCADE

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

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

getValue

public String getValue()

parse

public static Selectable parse(Object name)
                        throws IllegalArgumentException

Parameters:

name - Name of the TreeSelectable

Returns:

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

Throws:

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

isLeafOnly

public boolean isLeafOnly()

isSingle

public boolean isSingle()

isSupportedBySheet

public boolean isSupportedBySheet()

isSupportedByTree

public boolean isSupportedByTree()

isSupportedByTreeListbox

public boolean isSupportedByTreeListbox()