net.sf.mmm.client.ui.api.common

Enum SelectionChoice

java.lang.Object

java.lang.Enum<SelectionChoice>

net.sf.mmm.client.ui.api.common.SelectionChoice

All Implemented Interfaces:

Serializable, Comparable<SelectionChoice>

public enum SelectionChoice
extends Enum<SelectionChoice>

This enum contains the available choices for a selection of items from a container widget (list, tree, etc.).

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

UiFeatureSelectedValue.setSelection(SelectionChoice, SelectionOperation)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL This choice will affect all available items.
FIRST This choice will affect the first available item.
LAST This choice will affect the last available item.

Method Summary

Modifier and Type	Method and Description
static SelectionChoice	valueOf(String name) Returns the enum constant of this type with the specified name.
static SelectionChoice[]	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

ALL

public static final SelectionChoice ALL

This choice will affect all available items.
ATTENTION:
This choice only makes sense for SelectionMode.MULTIPLE_SELECTION. Further some widgets allow lazy loading of their data. This choice will only affect the items that are already loaded and available. Otherwise a very large or infinite tree would be loaded completely into the client causing undesired performance issues.

FIRST

public static final SelectionChoice FIRST

This choice will affect the first available item. It will affect nothing if there is no item at all. In case there is only one single item available FIRST will mean the same as LAST.

LAST

public static final SelectionChoice LAST

This choice will affect the last available item.

See Also:

FIRST

Method Detail

values

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

Returns:

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

valueOf

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