We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
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 componentAll Implemented Interfaces:
AttachNotifier, DetachNotifier, HasComponents, HasElement, HasEnabled, HasValue<AbstractField.ComponentValueChangeEvent<ListBox<T>,T>,T>, HasValueAndElement<AbstractField.ComponentValueChangeEvent<ListBox<T>,T>,T>, HasDataProvider<T>, HasItems<T>, HasItemsAndComponents<T>, SingleSelect<ListBox<T>,T>, Serializable
@Tag(value="vaadin-list-box") @HtmlImport(value="frontend://bower_components/vaadin-list-box/src/vaadin-list-box.html") public class ListBox<T> extends AbstractSinglePropertyField<ListBox<T>,T> implements HasItemsAndComponents<T>, SingleSelect<ListBox<T>,T>, HasDataProvider<T>, HasComponentsServer-side component for the
vaadin-list-boxelement.Author:
Vaadin Ltd
See Also:
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.vaadin.flow.component.AbstractField
AbstractField.ComponentValueChangeEvent<C extends Component,V>
-
Nested classes/interfaces inherited from interface com.vaadin.flow.data.binder.HasItemsAndComponents
HasItemsAndComponents.ItemComponent<T>
-
Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasValue
HasValue.ValueChangeEvent<V>, HasValue.ValueChangeListener<E extends HasValue.ValueChangeEvent<?>>
-
-
Constructor Summary
Constructors Constructor and Description ListBox()
-
Method Summary
All Methods Modifier and Type Method and Description DataProvider<T,?>getDataProvider()Gets the data provider.
SerializablePredicate<T>getItemEnabledProvider()Returns the item enabled predicate.
ComponentRenderer<? extends Component,T>getItemRenderer()Returns the item component renderer.
voidonEnabledStateChanged(boolean enabled)Handle component enable state when the enabled state changes.
voidsetDataProvider(DataProvider<T,?> dataProvider)Sets the data provider for this listing.
voidsetItemEnabledProvider(SerializablePredicate<T> itemEnabledProvider)Sets the item enabled predicate for this ListBox.
voidsetRenderer(ComponentRenderer<? extends Component,T> itemRenderer)Sets the item renderer for this ListBox.
voidsetRequiredIndicatorVisible(boolean requiredIndicatorVisible)Not supported!
-
Methods inherited from class com.vaadin.flow.component.AbstractSinglePropertyField
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, 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.component.AttachNotifier
addAttachListener
-
Methods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListener
-
-
-
-
Method Detail
-
setDataProvider
public void setDataProvider(DataProvider<T,?> dataProvider)Description copied from interface:
HasDataProviderSets the data provider for this listing. The data provider is queried for displayed items as needed.
Specified by:
setDataProviderin interfaceHasDataProvider<T>Parameters:
dataProvider- the data provider, not null
-
getDataProvider
public DataProvider<T,?> getDataProvider()Gets the data provider.
Returns:
the data provider, not
null
-
getItemRenderer
public ComponentRenderer<? extends Component,T> getItemRenderer()Returns the item component renderer.
Returns:
the item renderer
See Also:
-
setRenderer
public void setRenderer(ComponentRenderer<? extends 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, notnull
-
setItemEnabledProvider
public void setItemEnabledProvider(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, notnull
-
getItemEnabledProvider
public 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:
setRequiredIndicatorVisiblein interfaceHasValue<AbstractField.ComponentValueChangeEvent<ListBox<T>,T>,T>Specified by:
setRequiredIndicatorVisiblein interfaceHasValueAndElement<AbstractField.ComponentValueChangeEvent<ListBox<T>,T>,T>Parameters:
requiredIndicatorVisible-trueto make the required indicator visible,falseif notThrows:
-
onEnabledStateChanged
public void onEnabledStateChanged(boolean enabled)Description copied from class:
ComponentHandle component enable state when the enabled state changes.
By default this sets or removes the 'disabled' attribute from the element. This can be overridden to have custom handling.
Overrides:
onEnabledStateChangedin classComponentParameters:
enabled- the new enabled state of the component
-
-