com.vaadin.fluent.api

Interface FluentNativeSelect<THIS extends FluentNativeSelect<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>, FluentHasDataProvider<THIS,ITEM>, FluentHasItems<THIS,ITEM>, FluentHasValue<THIS,ITEM>, FluentSizeable<THIS>, com.vaadin.data.HasDataProvider<ITEM>, com.vaadin.data.HasItems<ITEM>, com.vaadin.data.HasValue<ITEM>, Serializable, com.vaadin.server.Sizeable

All Known Implementing Classes:

FNativeSelect

public interface FluentNativeSelect<THIS extends FluentNativeSelect<THIS,ITEM>,ITEM>
extends FluentAbstractSingleSelect<THIS,ITEM>, FluentFieldEvents.FluentFocusNotifier<THIS>, FluentFieldEvents.FluentBlurNotifier<THIS>, FluentHasDataProvider<THIS,ITEM>

The base interface for fluent versions of NativeSelect

See Also:

NativeSelect

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	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	withVisibleItemCount(int visibleItemCount) Sets the number of items that are visible.

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.FluentFocusNotifier

withFocusListener

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

addFocusListener

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.FluentHasDataProvider

withDataProvider, withItems

Methods inherited from interface com.vaadin.data.HasDataProvider

setDataProvider, setItems

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:

NativeSelect.setItemCaptionGenerator(ItemCaptionGenerator)

withVisibleItemCount

default THIS withVisibleItemCount(int visibleItemCount)

Sets the number of items that are visible. If only one item is visible, then the box will be displayed as a drop-down list (the default).

Parameters:

visibleItemCount - the visible item count

Returns:

this for method chaining

Throws:

IllegalArgumentException - if the value is smaller than one

See Also:

NativeSelect.setVisibleItemCount(int)

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:

NativeSelect.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 NativeSelect.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:

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