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

Enum SelectionMode

java.lang.Object

java.lang.Enum<SelectionMode>

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

All Implemented Interfaces:

Serializable, Comparable<SelectionMode>

public enum SelectionMode
extends Enum<SelectionMode>

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

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

AttributeWriteSelectedValue

Enum Constant Summary

Enum Constants

Enum Constant and Description
MULTIPLE_SELECTION The selection mode for selection of multiple items.
SINGLE_SELECTION The selection mode for a single selection.

Method Summary

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

SINGLE_SELECTION

public static final SelectionMode SINGLE_SELECTION

The selection mode for a single selection. By clicking on the item of a list or tree, that item will be selected and visually highlighted. The previous selection will be replaced. Typically if you hold the [control] key and click the selected item again, it will be deselected so that the selection is empty (nothing is selected).

MULTIPLE_SELECTION

public static final SelectionMode MULTIPLE_SELECTION

The selection mode for selection of multiple items. The best usability for this mode is provided by having checkboxes in front of every item. The user can select or deselect items by checking or unchecking the according checkbox.
A simplified variant works without checkboxes and allows to extend the selection by holding the [control] key and clicking on additional items. In that variant additionally when holding the [shift] key and and clicking on an item, the including range from the first to the last items clicked is selected.

Method Detail

values

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

Returns:

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

valueOf

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