Package org.dellroad.stuff.vaadin7

Annotation Type FieldBuilder.AbstractSelect

@Retention(RUNTIME)
@Target(METHOD)
@Documented
public static @interface FieldBuilder.AbstractSelect

Specifies how a Java property should be edited in Vaadin using an AbstractSelect.

See Also:

FieldBuilder.AbstractField, FieldBuilder

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
AbstractSelect.ItemCaptionMode	itemCaptionMode	Get the item caption mode.
String	itemCaptionPropertyId	Get the item caption property ID (which must be a string).
String	itemIconPropertyId	Get the item icon property ID (which must be a string).
boolean	multiSelect	Get multi-select setting.
boolean	newItemsAllowed	Get whether new items are allowed.
boolean	nullSelectionAllowed	Get whether null selection is allowed.
String	nullSelectionItemId	Get the null selection item ID.
Class<? extends AbstractSelect>	type	Get the AbstractSelect type that will edit the property.

Element Detail

type

Class<? extends AbstractSelect> type

Get the AbstractSelect type that will edit the property.

Although this property has a default value, it must be overridden either in this annotation, or by also including a more specific annotation such as FieldBuilder.ComboBox.

Returns:

field type

Default:

com.vaadin.ui.AbstractSelect.class

itemCaptionMode

AbstractSelect.ItemCaptionMode itemCaptionMode

Get the item caption mode.

Returns:

caption mode

See Also:

AbstractSelect.setItemCaptionMode(com.vaadin.ui.AbstractSelect.ItemCaptionMode)

Default:

com.vaadin.ui.AbstractSelect.ItemCaptionMode.EXPLICIT_DEFAULTS_ID

itemCaptionPropertyId

String itemCaptionPropertyId

Get the item caption property ID (which must be a string).

Returns:

caption property ID

See Also:

AbstractSelect.setItemCaptionPropertyId(java.lang.Object)

Default:

""

itemIconPropertyId

String itemIconPropertyId

Get the item icon property ID (which must be a string).

Returns:

icon property ID

See Also:

AbstractSelect.setItemIconPropertyId(java.lang.Object)

Default:

""

nullSelectionItemId

String nullSelectionItemId

Get the null selection item ID.

Returns:

null selection item ID

See Also:

AbstractSelect.setNullSelectionItemId(java.lang.Object)

Default:

""

multiSelect

boolean multiSelect

Get multi-select setting.

Returns:

true to allow multiple select

See Also:

AbstractSelect.setMultiSelect(boolean)

Default:

false

newItemsAllowed

boolean newItemsAllowed

Get whether new items are allowed.

Returns:

true to allow new items

See Also:

AbstractSelect.setNewItemsAllowed(boolean)

Default:

false

nullSelectionAllowed

boolean nullSelectionAllowed

Get whether null selection is allowed.

Returns:

true to allow null selection

See Also:

AbstractSelect.setNullSelectionAllowed(boolean)

Default:

true