Method Details

• setDataProvider

  public void setDataProvider(DataProvider<ITEM,?> dataProvider)

  Sets a generic data provider for the ListBox to use.

  Use this method when none of the setItems methods are applicable, e.g. when having a data provider with filter that cannot be transformed to DataProvider<T, Void>.

  Parameters:

  dataProvider - DataProvider instance to use, not null

• onAttach

  protected void onAttach(AttachEvent attachEvent)

  Description copied from class: Component

  Called when the component is attached to a UI.

  This method is invoked before the AttachEvent is fired for the component.

  Make sure to call super.onAttach when overriding this method.

  Overrides:

  onAttach in class Component

  Parameters:

  attachEvent - the attach event

• onDetach

  protected void onDetach(DetachEvent detachEvent)

  Description copied from class: Component

  Called when the component is detached from a UI.

  This method is invoked before the DetachEvent is fired for the component.

  Make sure to call super.onDetach when overriding this method.

  Overrides:

  onDetach in class Component

  Parameters:

  detachEvent - the detach event

• getDataProvider

  public DataProvider<ITEM,?> getDataProvider()

  Gets the data provider used by this ListBox.

  To get information and control over the items in the ListBox, use either getListDataView() or getGenericDataView() instead.

  Returns:

  the data provider used by this ListBox

• getItemRenderer

  public ComponentRenderer<? extends Component,ITEM> 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, ITEM>)

• setRenderer

  public void setRenderer(ComponentRenderer<? extends Component,ITEM> 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

• setItemLabelGenerator

  public void setItemLabelGenerator(ItemLabelGenerator<ITEM> itemLabelGenerator)

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

  Parameters:

  itemLabelGenerator - the item label provider to use, not null

• getItemLabelGenerator

  public ItemLabelGenerator<ITEM> getItemLabelGenerator()

  Gets the item label generator that is used to produce the strings shown in the ListBox for each item.

  Returns:

  the item label generator used, not null

• setItemEnabledProvider

  public void setItemEnabledProvider(SerializablePredicate<ITEM> 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 SerializablePredicate<ITEM> getItemEnabledProvider()

  Returns the item enabled predicate.

  Returns:

  the item enabled predicate

  See Also:

  • setItemEnabledProvider(com.vaadin.flow.function.SerializablePredicate<ITEM>)

• 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 HasValue<C extends ListBoxBase<C,ITEM,VALUE>,ITEM>

  Specified by:

  setRequiredIndicatorVisible in interface HasValueAndElement<C extends ListBoxBase<C,ITEM,VALUE>,ITEM>

  Parameters:

  requiredIndicatorVisible - true to make the required indicator visible, false if not

  Throws:

  UnsupportedOperationException

• onEnabledStateChanged

  public void onEnabledStateChanged(boolean enabled)

  Description copied from class: Component

  Handle 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:

  onEnabledStateChanged in class Component

  Parameters:

  enabled - the new enabled state of the component

• setItems

  public ListBoxDataView<ITEM> setItems(DataProvider<ITEM,Void> dataProvider)

  Set a generic data provider for the ListBox to use and returns the base ListBoxDataView that provides API to get information on the items.

  This method should be used only when the data provider type is not either ListDataProvider or BackEndDataProvider.

  Specified by:

  setItems in interface HasDataView<C extends ListBoxBase<C,ITEM,VALUE>,ITEM,VALUE>

  Parameters:

  dataProvider - DataProvider instance to use, not null

  Returns:

  ListBoxDataView providing information on the data

• setItems

  public ListBoxDataView<ITEM> setItems(InMemoryDataProvider<ITEM> inMemoryDataProvider)

  Sets an in-memory data provider for the ListBox to use

  Note! Using a ListDataProvider instead of a InMemoryDataProvider is recommended to get access to ListBoxListDataView API by using HasListDataView.setItems(ListDataProvider).

  Specified by:

  setItems in interface HasDataView<C extends ListBoxBase<C,ITEM,VALUE>,ITEM,VALUE>

  Parameters:

  inMemoryDataProvider - InMemoryDataProvider to use, not null

  Returns:

  ListBoxDataView providing information on the data

• setItems

  public ListBoxListDataView<ITEM> setItems(ListDataProvider<ITEM> listDataProvider)

  Sets a ListDataProvider for the ListBox to use and returns a ListDataView that provides information and allows operations on the items.

  Specified by:

  setItems in interface HasListDataView<C extends ListBoxBase<C,ITEM,VALUE>,ITEM>

  Parameters:

  listDataProvider - ListDataProvider providing items to the ListBox.

  Returns:

  ListBoxListDataView providing access to the items

• getListDataView

  public ListBoxListDataView<ITEM> getListDataView()

  Gets the list data view for the ListBox. This data view should only be used when the items are in-memory and set with:

  • HasListDataView.setItems(Collection)
  • HasListDataView.setItems(Object[])
  • setItems(ListDataProvider)

  If the items are not in-memory an exception is thrown.

  Specified by:

  getListDataView in interface HasListDataView<C extends ListBoxBase<C,ITEM,VALUE>,ITEM>

  Returns:

  the list data view that provides access to the data bound to the ListBox

• getGenericDataView

  public ListBoxDataView<ITEM> getGenericDataView()

  Gets the generic data view for the ListBox. This data view should only be used when getListDataView() is not applicable for the underlying data provider.

  Specified by:

  getGenericDataView in interface HasDataView<C extends ListBoxBase<C,ITEM,VALUE>,ITEM,VALUE>

  Returns:

  the generic DataView instance implementing ListBoxDataView

• getItemId

  protected Object getItemId(ITEM item)