Package com.vaadin.ui

Enum Table.RowHeaderMode

java.lang.Object

java.lang.Enum<Table.RowHeaderMode>

com.vaadin.ui.Table.RowHeaderMode

All Implemented Interfaces:

Serializable, Comparable<Table.RowHeaderMode>

Enclosing class:

Table

public static enum Table.RowHeaderMode
extends Enum<Table.RowHeaderMode>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXPLICIT	Row caption mode: Item captions are explicitly specified.
EXPLICIT_DEFAULTS_ID	Row caption mode: Item captions are explicitly specified, but if the caption is missing, the item id objects toString() is used instead.
HIDDEN	Row caption mode: The row headers are hidden.
ICON_ONLY	Row caption mode: Only icons are shown, the captions are hidden.
ID	Row caption mode: Items Id-objects toString is used as row caption.
INDEX	Row caption mode: Index of the item is used as item caption.
ITEM	Row caption mode: Item-objects toString is used as row caption.
PROPERTY	Row caption mode: Item captions are read from property specified with AbstractSelect.setItemCaptionPropertyId(Object) .

Method Summary

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

HIDDEN

public static final Table.RowHeaderMode HIDDEN

Row caption mode: The row headers are hidden. This is the default mode.

ID

public static final Table.RowHeaderMode ID

Row caption mode: Items Id-objects toString is used as row caption.

ITEM

public static final Table.RowHeaderMode ITEM

Row caption mode: Item-objects toString is used as row caption.

INDEX

public static final Table.RowHeaderMode INDEX

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

EXPLICIT_DEFAULTS_ID

public static final Table.RowHeaderMode EXPLICIT_DEFAULTS_ID

Row caption mode: Item captions are explicitly specified, but if the caption is missing, the item id objects toString() is used instead.

EXPLICIT

public static final Table.RowHeaderMode EXPLICIT

Row caption mode: Item captions are explicitly specified.

ICON_ONLY

public static final Table.RowHeaderMode ICON_ONLY

Row caption mode: Only icons are shown, the captions are hidden.

PROPERTY

public static final Table.RowHeaderMode PROPERTY

Row caption mode: Item captions are read from property specified with AbstractSelect.setItemCaptionPropertyId(Object) .

Method Detail

values

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

Returns:

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

valueOf

public static Table.RowHeaderMode 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

getItemCaptionMode

public AbstractSelect.ItemCaptionMode getItemCaptionMode()