Package org.dellroad.stuff.vaadin8

Annotation Type FieldBuilder.ComboBox

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

Specifies how a Java property should be edited using an ComboBox.

See Also:

FieldBuilder.AbstractSingleSelect, FieldBuilder

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
Class<? extends ListDataProvider>	dataProvider	Get the ListDataProvider data provider class.
boolean	emptySelectionAllowed	Get whether empty selection is allowed.
String	emptySelectionCaption	Get the input prompt.
Class<? extends ItemCaptionGenerator>	itemCaptionGenerator	Get the item caption generator class.
Class<? extends IconGenerator>	itemIconGenerator	Get the item icon generator class.
Class<? extends ComboBox.NewItemProvider>	newItemProvider	Get the new item provider class.
int	pageLength	Get the page length.
String	placeholder	Get the placeholder.
String	popupWidth	Get the popup width.
boolean	scrollToSelectedItem	Get whether to scroll to the selected item.
boolean	textInputAllowed	Get whether text input is allowed.
Class<? extends ComboBox>	type	Get the ComboBox type that will edit the property.

Element Detail

type

Class<? extends ComboBox> type

Get the ComboBox type that will edit the property. Type must have a no-arg constructor.

Returns:

field type

Default:

com.vaadin.ui.ComboBox.class

itemIconGenerator

Class<? extends IconGenerator> itemIconGenerator

Get the item icon generator class.

Returns:

icon generator

See Also:

ComboBox.setItemIconGenerator(com.vaadin.ui.IconGenerator<T>)

Default:

com.vaadin.ui.IconGenerator.class

itemCaptionGenerator

Class<? extends ItemCaptionGenerator> itemCaptionGenerator

Get the item caption generator class.

Returns:

caption generator

See Also:

ComboBox.setItemCaptionGenerator(com.vaadin.ui.ItemCaptionGenerator<T>)

Default:

com.vaadin.ui.ItemCaptionGenerator.class

dataProvider

Class<? extends ListDataProvider> dataProvider

Get the ListDataProvider data provider class.

Returns:

data provider class

See Also:

ComboBox.setDataProvider(com.vaadin.data.provider.ListDataProvider<T>)

Default:

com.vaadin.data.provider.ListDataProvider.class

newItemProvider

Class<? extends ComboBox.NewItemProvider> newItemProvider

Get the new item provider class.

Returns:

new item provider

See Also:

ComboBox.setNewItemProvider(com.vaadin.ui.ComboBox.NewItemProvider<T>)

Default:

com.vaadin.ui.ComboBox.NewItemProvider.class

emptySelectionAllowed

boolean emptySelectionAllowed

Get whether empty selection is allowed.

Returns:

true to allow empty selection

See Also:

ComboBox.setEmptySelectionAllowed(boolean)

Default:

true

emptySelectionCaption

String emptySelectionCaption

Get the input prompt.

Returns:

input prompt

See Also:

ComboBox.setEmptySelectionCaption(java.lang.String)

Default:

""

placeholder

String placeholder

Get the placeholder.

Returns:

placeholder

See Also:

ComboBox.setPlaceholder(java.lang.String)

Default:

""

popupWidth

String popupWidth

Get the popup width.

Returns:

popup width

See Also:

ComboBox.setPopupWidth(java.lang.String)

Default:

""

pageLength

int pageLength

Get the page length.

Returns:

page length, or -1 for none

See Also:

ComboBox.setPageLength(int)

Default:

-1

scrollToSelectedItem

boolean scrollToSelectedItem

Get whether to scroll to the selected item.

Returns:

true to scroll to the selected item

See Also:

ComboBox.setScrollToSelectedItem(boolean)

Default:

true

textInputAllowed

boolean textInputAllowed

Get whether text input is allowed.

Returns:

true to allow text input

See Also:

ComboBox.setTextInputAllowed(boolean)

Default:

true