com.vaadin.fluent.api

Interface FluentComboBox<THIS extends FluentComboBox<THIS,ITEM>,ITEM>

Type Parameters:

THIS - Self-referential generic THIS

ITEM - the item object type in the listing

All Superinterfaces:

com.vaadin.server.ClientConnector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, com.vaadin.shared.Connector, com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.FieldEvents.BlurNotifier, com.vaadin.event.FieldEvents.FocusNotifier, FluentAbstractComponent<THIS>, FluentAbstractListing<THIS,ITEM>, FluentAbstractSingleSelect<THIS,ITEM>, FluentClientConnector<THIS>, FluentComponent<THIS>, FluentComponent.FluentFocusable<THIS>, FluentContextClickNotifier<THIS>, FluentFieldEvents.FluentBlurNotifier<THIS>, FluentFieldEvents.FluentFocusNotifier<THIS>, FluentHasFilterableDataProvider<THIS,ITEM,String>, FluentHasItems<THIS,ITEM>, FluentHasValue<THIS,ITEM>, FluentSizeable<THIS>, com.vaadin.data.HasFilterableDataProvider<ITEM,String>, com.vaadin.data.HasItems<ITEM>, com.vaadin.data.HasValue<ITEM>, Serializable, com.vaadin.server.Sizeable

All Known Implementing Classes:

FComboBox

public interface FluentComboBox<THIS extends FluentComboBox<THIS,ITEM>,ITEM>
extends FluentAbstractSingleSelect<THIS,ITEM>, FluentHasValue<THIS,ITEM>, FluentFieldEvents.FluentBlurNotifier<THIS>, FluentFieldEvents.FluentFocusNotifier<THIS>, FluentHasFilterableDataProvider<THIS,ITEM,String>

The base interface for fluent versions of ComboBox

See Also:

ComboBox

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.fluent.api.FluentComponent

FluentComponent.FluentFocusable<C extends FluentComponent.FluentFocusable<C>>

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

com.vaadin.server.Sizeable.Unit

Nested classes/interfaces inherited from interface com.vaadin.data.HasValue

com.vaadin.data.HasValue.ValueChangeEvent<V>, com.vaadin.data.HasValue.ValueChangeListener<V>

Field Summary

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Method Summary

Modifier and Type	Method and Description
default THIS	withDataProvider(com.vaadin.ui.ComboBox.CaptionFilter captionFilter, com.vaadin.data.provider.ListDataProvider<ITEM> listDataProvider) Sets a list data provider with an item caption filter as the data provider of this combo box.
default THIS	withDataProvider(com.vaadin.data.provider.ListDataProvider<ITEM> listDataProvider) Sets a list data provider as the data provider of this combo box.
default THIS	withEmptySelectionAllowed(boolean emptySelectionAllowed) Sets whether the user is allowed to select nothing in the combo box.
default THIS	withEmptySelectionCaption(String caption) Sets the empty selection caption.
default THIS	withItemCaptionGenerator(com.vaadin.ui.ItemCaptionGenerator<ITEM> itemCaptionGenerator) Sets the item caption generator that is used to produce the strings shown in the combo box for each item.
default THIS	withItemIconGenerator(com.vaadin.ui.IconGenerator<ITEM> itemIconGenerator)
default THIS	withItems(com.vaadin.ui.ComboBox.CaptionFilter captionFilter, Collection<ITEM> items) Sets the data items of this listing and a simple string filter with which the item string and the text the user has input are compared.
default THIS	withItems(com.vaadin.ui.ComboBox.CaptionFilter captionFilter, ITEM... items) Sets the data items of this listing and a simple string filter with which the item string and the text the user has input are compared.
default THIS	withPageLength(int pageLength) Sets the page length for the suggestion popup.
default THIS	withPlaceholder(String placeholder) Sets the placeholder string - a textual prompt that is displayed when the select would otherwise be empty, to prompt the user for input.
default THIS	withTextInputAllowed(boolean textInputAllowed) Sets whether it is possible to input text into the field or whether the field area of the component is just used to show what is selected.

Methods inherited from interface com.vaadin.fluent.api.FluentAbstractSingleSelect

withSelectedItem, withSelectionListener, withValueChangeListener

Methods inherited from interface com.vaadin.fluent.api.FluentAbstractComponent

withCaption, withCaptionAsHtml, withComponentError, withData, withDescription, withDescription, withLocale, withResponsive, withShortcutListener, withStyleName

Methods inherited from interface com.vaadin.fluent.api.FluentClientConnector

withAttachListener, withDetachListener

Methods inherited from interface com.vaadin.fluent.api.FluentContextClickNotifier

withContextClickListener

Methods inherited from interface com.vaadin.event.ContextClickEvent.ContextClickNotifier

addContextClickListener, removeContextClickListener

Methods inherited from interface com.vaadin.fluent.api.FluentHasItems

withItems, withItems, withItems

Methods inherited from interface com.vaadin.data.HasItems

getDataProvider, setItems, setItems, setItems

Methods inherited from interface com.vaadin.fluent.api.FluentComponent.FluentFocusable

withTabIndex

Methods inherited from interface com.vaadin.ui.Component.Focusable

focus, getTabIndex, setTabIndex

Methods inherited from interface com.vaadin.fluent.api.FluentComponent

withCaption, withEnabled, withIcon, withId, withParent, withPrimaryStyleName, withStyleName, withStyleName, withVisible

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, readDesign, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setVisible, writeDesign

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.fluent.api.FluentSizeable

withFullHeight, withFullSize, withFullWidth, withHeight, withHeight, withSize, withUndefinedHeight, withUndefinedSize, withUndefinedWidth, withWidth, withWidth

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

Methods inherited from interface com.vaadin.fluent.api.FluentHasValue

withReadOnly, withRequiredIndicatorVisible, withValue

Methods inherited from interface com.vaadin.data.HasValue

addValueChangeListener, clear, getDefaultValidator, getEmptyValue, getOptionalValue, getValue, isEmpty, isReadOnly, isRequiredIndicatorVisible, setReadOnly, setRequiredIndicatorVisible, setValue

Methods inherited from interface com.vaadin.fluent.api.FluentFieldEvents.FluentBlurNotifier

withBlurListener

Methods inherited from interface com.vaadin.event.FieldEvents.BlurNotifier

addBlurListener

Methods inherited from interface com.vaadin.fluent.api.FluentFieldEvents.FluentFocusNotifier

withFocusListener

Methods inherited from interface com.vaadin.event.FieldEvents.FocusNotifier

addFocusListener

Methods inherited from interface com.vaadin.fluent.api.FluentHasFilterableDataProvider

withDataProvider, withDataProvider

Methods inherited from interface com.vaadin.data.HasFilterableDataProvider

setDataProvider, setDataProvider

Method Detail

withItemCaptionGenerator

default THIS withItemCaptionGenerator(com.vaadin.ui.ItemCaptionGenerator<ITEM> itemCaptionGenerator)

Sets the item caption generator that is used to produce the strings shown in the combo box for each item. By default, String.valueOf(Object) is used.

Parameters:

itemCaptionGenerator - the item caption provider to use, not null

Returns:

this for method chaining

See Also:

ComboBox.setItemCaptionGenerator(ItemCaptionGenerator)

withItemIconGenerator

default THIS withItemIconGenerator(com.vaadin.ui.IconGenerator<ITEM> itemIconGenerator)

Parameters:

itemIconGenerator - the item icon generator to set, not null

Returns:

this for method chaining

See Also:

IconGenerator, AbstractListing.setItemIconGenerator(IconGenerator)

withEmptySelectionAllowed

default THIS withEmptySelectionAllowed(boolean emptySelectionAllowed)

Sets whether the user is allowed to select nothing in the combo box. When true, a special empty item is shown to the user.

Parameters:

emptySelectionAllowed - true to allow not selecting anything, false to require selection

Returns:

this for method chaining

See Also:

ComboBox.setEmptySelectionAllowed(boolean)

withEmptySelectionCaption

default THIS withEmptySelectionCaption(String caption)

Sets the empty selection caption.

The empty string "" is the default empty selection caption.

If empty selection is allowed via the ComboBox.setEmptySelectionAllowed(boolean) method (it is by default) then the empty item will be shown with the given caption.

Parameters:

caption - the caption to set, not null

Returns:

this for method chaining

See Also:

ComboBox.setEmptySelectionCaption(String), AbstractSingleSelect.isSelected(Object)

withPageLength

default THIS withPageLength(int pageLength)

Sets the page length for the suggestion popup. Setting the page length to 0 will disable suggestion popup paging (all items visible).

Parameters:

pageLength - the pageLength to set

Returns:

this for method chaining

See Also:

ComboBox.setPageLength(int)

withPlaceholder

default THIS withPlaceholder(String placeholder)

Sets the placeholder string - a textual prompt that is displayed when the select would otherwise be empty, to prompt the user for input.

Parameters:

placeholder - the desired placeholder, or null to disable

Returns:

this for method chaining

See Also:

ComboBox.setPlaceholder(String)

withTextInputAllowed

default THIS withTextInputAllowed(boolean textInputAllowed)

Sets whether it is possible to input text into the field or whether the field area of the component is just used to show what is selected. By disabling text input, the comboBox will work in the same way as a NativeSelect

Parameters:

textInputAllowed - true to allow entering text, false to just show the current selection

Returns:

this for method chaining

See Also:

ComboBox.setTextInputAllowed(boolean)

withDataProvider

default THIS withDataProvider(com.vaadin.data.provider.ListDataProvider<ITEM> listDataProvider)

Sets a list data provider as the data provider of this combo box. Filtering will use a case insensitive match to show all items where the filter text is a substring of the caption displayed for that item.

Note that this is a shorthand that calls HasFilterableDataProvider.setDataProvider(DataProvider) with a wrapper of the provided list data provider. This means that HasItems.getDataProvider() will return the wrapper instead of the original list data provider.

Parameters:

listDataProvider - the list data provider to use, not null

Returns:

this for method chaining

See Also:

ComboBox.setDataProvider(ListDataProvider)

withDataProvider

default THIS withDataProvider(com.vaadin.ui.ComboBox.CaptionFilter captionFilter,
                              com.vaadin.data.provider.ListDataProvider<ITEM> listDataProvider)

Sets a list data provider with an item caption filter as the data provider of this combo box. The caption filter is used to compare the displayed caption of each item to the filter text entered by the user.

Parameters:

captionFilter - filter to check if an item is shown when user typed some text into the ComboBox

listDataProvider - the list data provider to use, not null

Returns:

this for method chaining

See Also:

ComboBox.setDataProvider(CaptionFilter, ListDataProvider)

withItems

default THIS withItems(com.vaadin.ui.ComboBox.CaptionFilter captionFilter,
                       ITEM... items)

Sets the data items of this listing and a simple string filter with which the item string and the text the user has input are compared.

Note that unlike HasItems.setItems(Collection), no automatic case conversion is performed before the comparison.

Parameters:

captionFilter - filter to check if an item is shown when user typed some text into the ComboBox

items - the data items to display

Returns:

this for method chaining

See Also:

ComboBox.setItems(CaptionFilter, Object...)

withItems

default THIS withItems(com.vaadin.ui.ComboBox.CaptionFilter captionFilter,
                       Collection<ITEM> items)

Sets the data items of this listing and a simple string filter with which the item string and the text the user has input are compared.

Note that unlike HasItems.setItems(Collection), no automatic case conversion is performed before the comparison.

Parameters:

captionFilter - filter to check if an item is shown when user typed some text into the ComboBox

items - the data items to display

Returns:

this for method chaining

See Also:

ComboBox.setItems(CaptionFilter, Collection)