com.vaadin.flow.component.listbox

Class ListBox<T>

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.AbstractField<C,T>

com.vaadin.flow.component.AbstractSinglePropertyField<ListBox<T>,T>

com.vaadin.flow.component.listbox.ListBox<T>

Type Parameters:

T - the type of the items contained by this component

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasComponents, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<ListBox<T>,T>,T>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<ListBox<T>,T>,T>, com.vaadin.flow.data.binder.HasDataProvider<T>, com.vaadin.flow.data.binder.HasItems<T>, com.vaadin.flow.data.binder.HasItemsAndComponents<T>, com.vaadin.flow.data.selection.SingleSelect<ListBox<T>,T>, Serializable

@Tag(value="vaadin-list-box")
 @NpmPackage(value="@vaadin/vaadin-list-box",
            version="1.1.1")
 @JsModule(value="@vaadin/vaadin-list-box/src/vaadin-list-box.js")
 @HtmlImport(value="frontend://bower_components/vaadin-list-box/src/vaadin-list-box.html")
public class ListBox<T>
extends com.vaadin.flow.component.AbstractSinglePropertyField<ListBox<T>,T>
implements com.vaadin.flow.data.binder.HasItemsAndComponents<T>, com.vaadin.flow.data.selection.SingleSelect<ListBox<T>,T>, com.vaadin.flow.data.binder.HasDataProvider<T>, com.vaadin.flow.component.HasComponents, com.vaadin.flow.component.HasSize

Server-side component for the vaadin-list-box element.

Author:

Vaadin Ltd

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.flow.component.AbstractField

com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<C extends com.vaadin.flow.component.Component,V>

Nested classes/interfaces inherited from interface com.vaadin.flow.data.binder.HasItemsAndComponents

com.vaadin.flow.data.binder.HasItemsAndComponents.ItemComponent<T>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasValue

com.vaadin.flow.component.HasValue.ValueChangeEvent<V>, com.vaadin.flow.component.HasValue.ValueChangeListener<E extends com.vaadin.flow.component.HasValue.ValueChangeEvent<?>>

Constructor Summary

Constructors

Constructor and Description
ListBox()

Method Summary

Modifier and Type	Method and Description
com.vaadin.flow.data.provider.DataProvider<T,?>	getDataProvider() Gets the data provider.
com.vaadin.flow.function.SerializablePredicate<T>	getItemEnabledProvider() Returns the item enabled predicate.
com.vaadin.flow.data.renderer.ComponentRenderer<? extends com.vaadin.flow.component.Component,T>	getItemRenderer() Returns the item component renderer.
void	onEnabledStateChanged(boolean enabled)
void	setDataProvider(com.vaadin.flow.data.provider.DataProvider<T,?> dataProvider)
void	setItemEnabledProvider(com.vaadin.flow.function.SerializablePredicate<T> itemEnabledProvider) Sets the item enabled predicate for this ListBox.
void	setRenderer(com.vaadin.flow.data.renderer.ComponentRenderer<? extends com.vaadin.flow.component.Component,T> itemRenderer) Sets the item renderer for this ListBox.
void	setRequiredIndicatorVisible(boolean requiredIndicatorVisible) Not supported!

Methods inherited from class com.vaadin.flow.component.AbstractSinglePropertyField

getSynchronizationRegistration, hasValidValue, setPresentationValue, setSynchronizedEvent

Methods inherited from class com.vaadin.flow.component.AbstractField

addValueChangeListener, getEmptyValue, getValue, isEmpty, setModelValue, setValue, valueEquals

Methods inherited from class com.vaadin.flow.component.Component

addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getUI, hasListener, isTemplateMapped, isVisible, onAttach, onDetach, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.flow.data.binder.HasItemsAndComponents

addComponents, getItemPosition, prependComponents

Methods inherited from interface com.vaadin.flow.component.HasComponents

add, add, addComponentAsFirst, addComponentAtIndex, remove, removeAll

Methods inherited from interface com.vaadin.flow.component.HasValueAndElement

isReadOnly, isRequiredIndicatorVisible, setReadOnly

Methods inherited from interface com.vaadin.flow.component.HasValue

addValueChangeListener, clear, getEmptyValue, getOptionalValue, getValue, isEmpty, setValue

Methods inherited from interface com.vaadin.flow.component.HasEnabled

isEnabled, setEnabled

Methods inherited from interface com.vaadin.flow.data.binder.HasDataProvider

setItems

Methods inherited from interface com.vaadin.flow.data.binder.HasItems

setItems, setItems

Methods inherited from interface com.vaadin.flow.component.HasSize

getHeight, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, setHeight, setHeightFull, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidthFull

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Constructor Detail

ListBox

public ListBox()

Method Detail

setDataProvider

public void setDataProvider(com.vaadin.flow.data.provider.DataProvider<T,?> dataProvider)

Specified by:

setDataProvider in interface com.vaadin.flow.data.binder.HasDataProvider<T>

getDataProvider

public com.vaadin.flow.data.provider.DataProvider<T,?> getDataProvider()

Gets the data provider.

Returns:

the data provider, not null

getItemRenderer

public com.vaadin.flow.data.renderer.ComponentRenderer<? extends com.vaadin.flow.component.Component,T> getItemRenderer()

Returns the item component renderer.

Returns:

the item renderer

See Also:

setRenderer(com.vaadin.flow.data.renderer.ComponentRenderer<? extends com.vaadin.flow.component.Component, T>)

setRenderer

public void setRenderer(com.vaadin.flow.data.renderer.ComponentRenderer<? extends com.vaadin.flow.component.Component,T> itemRenderer)

Sets the item renderer for this ListBox. The renderer is applied to each item to create a component which represents the item.

Parameters:

itemRenderer - the item renderer, not null

setItemEnabledProvider

public void setItemEnabledProvider(com.vaadin.flow.function.SerializablePredicate<T> itemEnabledProvider)

Sets the item enabled predicate for this ListBox. The predicate is applied to each item to determine whether the item should be enabled (true) or disabled (false). Disabled items are displayed as grayed out and the user cannot select them. The default predicate always returns true (all the items are enabled).

Parameters:

itemEnabledProvider - the item enable predicate, not null

getItemEnabledProvider

public com.vaadin.flow.function.SerializablePredicate<T> getItemEnabledProvider()

Returns the item enabled predicate.

Returns:

the item enabled predicate

See Also:

setItemEnabledProvider(com.vaadin.flow.function.SerializablePredicate<T>)

setRequiredIndicatorVisible

public void setRequiredIndicatorVisible(boolean requiredIndicatorVisible)

Not supported!

Not supported by the client-side web-component, see issue in GitHub.

Specified by:

setRequiredIndicatorVisible in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<ListBox<T>,T>,T>

Specified by:

setRequiredIndicatorVisible in interface com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<ListBox<T>,T>,T>

Throws:

UnsupportedOperationException

onEnabledStateChanged

public void onEnabledStateChanged(boolean enabled)

Overrides:

onEnabledStateChanged in class com.vaadin.flow.component.Component