com.vaadin.ui

Enum AbstractSelect.ItemCaptionMode

java.lang.Object

java.lang.Enum<AbstractSelect.ItemCaptionMode>

com.vaadin.ui.AbstractSelect.ItemCaptionMode

All Implemented Interfaces:

Serializable, Comparable<AbstractSelect.ItemCaptionMode>

Enclosing class:

AbstractSelect

public static enum AbstractSelect.ItemCaptionMode
extends Enum<AbstractSelect.ItemCaptionMode>

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXPLICIT Item caption mode: Captions must be explicitly specified.
EXPLICIT_DEFAULTS_ID Item caption mode: If an Item has a caption it's used, if not, Item's ID converted to a String using VaadinSession.getConverterFactory() is used as caption.
ICON_ONLY Item caption mode: Only icons are shown, captions are hidden.
ID Item caption mode: Item's ID converted to a String using VaadinSession.getConverterFactory() is used as caption.
ID_TOSTRING Item caption mode: Item's ID's String representation is used as caption.
INDEX Item caption mode: Index of the item is used as caption.
ITEM Item caption mode: Item's String representation is used as caption.
PROPERTY Item caption mode: Item captions are read from property specified with setItemCaptionPropertyId.

Method Summary

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

ID

public static final AbstractSelect.ItemCaptionMode ID

Item caption mode: Item's ID converted to a String using VaadinSession.getConverterFactory() is used as caption.

ID_TOSTRING

public static final AbstractSelect.ItemCaptionMode ID_TOSTRING

Item caption mode: Item's ID's String representation is used as caption.

Since:

7.5.6

ITEM

public static final AbstractSelect.ItemCaptionMode ITEM

Item caption mode: Item's String representation is used as caption.

INDEX

public static final AbstractSelect.ItemCaptionMode INDEX

Item caption mode: Index of the item is used as caption. The index mode can only be used with the containers implementing the Container.Indexed interface.

EXPLICIT_DEFAULTS_ID

public static final AbstractSelect.ItemCaptionMode EXPLICIT_DEFAULTS_ID

Item caption mode: If an Item has a caption it's used, if not, Item's ID converted to a String using VaadinSession.getConverterFactory() is used as caption. This is the default.

EXPLICIT

public static final AbstractSelect.ItemCaptionMode EXPLICIT

Item caption mode: Captions must be explicitly specified.

ICON_ONLY

public static final AbstractSelect.ItemCaptionMode ICON_ONLY

Item caption mode: Only icons are shown, captions are hidden.

PROPERTY

public static final AbstractSelect.ItemCaptionMode PROPERTY

Item caption mode: Item captions are read from property specified with setItemCaptionPropertyId.

Method Detail

values

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

Returns:

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

valueOf

public static AbstractSelect.ItemCaptionMode 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