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

Enum SelectionOperation

java.lang.Object

java.lang.Enum<SelectionOperation>

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

All Implemented Interfaces:

Serializable, Comparable<SelectionOperation>

public enum SelectionOperation
extends Enum<SelectionOperation>

This enum contains the available operations 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
ADD This operation will add the indicated items to the current selection.
REMOVE This operation will remove the indicated items from the current selection.
SET This operation set the selection so only the indicated items are selected.
TOGGLE This operation will toggle (invert) the selection of the indicated items.

Method Summary

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

SET

public static final SelectionOperation SET

This operation set the selection so only the indicated items are selected.

ADD

public static final SelectionOperation ADD

This operation will add the indicated items to the current selection.
ATTENTION:
This operation only makes sense in SelectionMode.MULTIPLE_SELECTION. Use SET in case of SelectionMode.SINGLE_SELECTION.

REMOVE

public static final SelectionOperation REMOVE

This operation will remove the indicated items from the current selection.

TOGGLE

public static final SelectionOperation TOGGLE

This operation will toggle (invert) the selection of the indicated items.

Method Detail

values

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

Returns:

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

valueOf

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