@Tag(value="vaadin-list-box") @NpmPackage(value="@vaadin/vaadin-list-box", version="1.4.0") @JsModule(value="@vaadin/vaadin-list-box/src/vaadin-list-box.js") public abstract class ListBoxBase<C extends ListBoxBase<C,ITEM,VALUE>,ITEM,VALUE> extends AbstractSinglePropertyField<C,VALUE> implements HasItemsAndComponents<ITEM>, HasDataProvider<ITEM>, HasSize
ListBox
and MultiSelectListBox
.AbstractField.ComponentValueChangeEvent<C extends Component,V>
HasItemsAndComponents.ItemComponent<T>
HasValue.ValueChangeEvent<V>, HasValue.ValueChangeListener<E extends HasValue.ValueChangeEvent<?>>
Modifier and Type | Method and Description |
---|---|
DataProvider<ITEM,?> |
getDataProvider()
Gets the data provider.
|
SerializablePredicate<ITEM> |
getItemEnabledProvider()
Returns the item enabled predicate.
|
ComponentRenderer<? extends Component,ITEM> |
getItemRenderer()
Returns the item component renderer.
|
protected void |
onAttach(AttachEvent attachEvent)
Called when the component is attached to a UI.
|
protected void |
onDetach(DetachEvent detachEvent)
Called when the component is detached from a UI.
|
void |
onEnabledStateChanged(boolean enabled)
Handle component enable state when the enabled state changes.
|
void |
setDataProvider(DataProvider<ITEM,?> dataProvider)
Sets the data provider for this listing.
|
void |
setItemEnabledProvider(SerializablePredicate<ITEM> itemEnabledProvider)
Sets the item enabled predicate for this ListBox.
|
void |
setRenderer(ComponentRenderer<? extends Component,ITEM> itemRenderer)
Sets the item renderer for this ListBox.
|
void |
setRequiredIndicatorVisible(boolean requiredIndicatorVisible)
Not supported!
|
getSynchronizationRegistration, hasValidValue, setPresentationValue, setSynchronizedEvent
addValueChangeListener, getEmptyValue, getValue, isEmpty, setModelValue, setValue, valueEquals
addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, set, setElement, setId, setVisible
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addComponents, getItemPosition, prependComponents
add, add, addComponentAsFirst, addComponentAtIndex, remove, removeAll
isEnabled, setEnabled
getElement
setItems
getCssSize, getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull
isReadOnly, isRequiredIndicatorVisible, setReadOnly
clear, getOptionalValue
addAttachListener
addDetachListener
public void setDataProvider(DataProvider<ITEM,?> dataProvider)
HasDataProvider
setDataProvider
in interface HasDataProvider<ITEM>
dataProvider
- the data provider, not nullprotected void onAttach(AttachEvent attachEvent)
Component
The default implementation does nothing.
This method is invoked before the AttachEvent
is fired for the
component.
protected void onDetach(DetachEvent detachEvent)
Component
The default implementation does nothing.
This method is invoked before the DetachEvent
is fired for the
component.
public DataProvider<ITEM,?> getDataProvider()
null
public ComponentRenderer<? extends Component,ITEM> getItemRenderer()
setRenderer(com.vaadin.flow.data.renderer.ComponentRenderer<? extends com.vaadin.flow.component.Component, ITEM>)
public void setRenderer(ComponentRenderer<? extends Component,ITEM> itemRenderer)
itemRenderer
- the item renderer, not null
public void setItemEnabledProvider(SerializablePredicate<ITEM> itemEnabledProvider)
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).itemEnabledProvider
- the item enable predicate, not null
public SerializablePredicate<ITEM> getItemEnabledProvider()
setItemEnabledProvider(com.vaadin.flow.function.SerializablePredicate<ITEM>)
public void setRequiredIndicatorVisible(boolean requiredIndicatorVisible)
Not supported by the client-side web-component, see issue in GitHub.
setRequiredIndicatorVisible
in interface HasValue<AbstractField.ComponentValueChangeEvent<C extends ListBoxBase<C,ITEM,VALUE>,VALUE>,VALUE>
setRequiredIndicatorVisible
in interface HasValueAndElement<AbstractField.ComponentValueChangeEvent<C extends ListBoxBase<C,ITEM,VALUE>,VALUE>,VALUE>
requiredIndicatorVisible
- true
to make the required indicator visible,
false
if notUnsupportedOperationException
public void onEnabledStateChanged(boolean enabled)
Component
By default this sets or removes the 'disabled' attribute from the element. This can be overridden to have custom handling.
onEnabledStateChanged
in class Component
enabled
- the new enabled state of the componentCopyright © 2025. All rights reserved.