com.vaadin.flow.component.listbox

Class MultiSelectListBox<T>

java.lang.Object

com.vaadin.flow.component.Component

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

com.vaadin.flow.component.AbstractSinglePropertyField<C,VALUE>

com.vaadin.flow.component.listbox.ListBoxBase<MultiSelectListBox<T>,T,Set<T>>

com.vaadin.flow.component.listbox.MultiSelectListBox<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<MultiSelectListBox<T>,Set<T>>,Set<T>>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<MultiSelectListBox<T>,Set<T>>,Set<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.MultiSelect<MultiSelectListBox<T>,T>, Serializable

public class MultiSelectListBox<T>
extends ListBoxBase<MultiSelectListBox<T>,T,Set<T>>
implements com.vaadin.flow.data.selection.MultiSelect<MultiSelectListBox<T>,T>

Server-side component for the vaadin-list-box element with multi-selection.

Author:

Vaadin Ltd

See Also:

ListBox, 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.component.HasValue

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

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

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

Constructor Summary

Constructors

Constructor and Description
MultiSelectListBox() Creates a new list box component with multi-selection.

Method Summary

Modifier and Type	Method and Description
com.vaadin.flow.shared.Registration	addSelectionListener(com.vaadin.flow.data.selection.MultiSelectionListener<MultiSelectListBox<T>,T> listener)
Set<T>	getSelectedItems() Returns an immutable set of the currently selected items.
void	setValue(Set<T> value) Sets the value of this component.
void	updateSelection(Set<T> addedItems, Set<T> removedItems)

Methods inherited from class com.vaadin.flow.component.listbox.ListBoxBase

getDataProvider, getItemEnabledProvider, getItemRenderer, onAttach, onDetach, onEnabledStateChanged, setDataProvider, setItemEnabledProvider, setRenderer, setRequiredIndicatorVisible

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, valueEquals

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

addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, 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.selection.MultiSelect

deselect, deselect, deselectAll, getEmptyValue, getValue, isSelected, select, select

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

isReadOnly, isRequiredIndicatorVisible, setReadOnly, setRequiredIndicatorVisible

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

addValueChangeListener, clear, getOptionalValue, isEmpty

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

isEnabled, setEnabled

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

getElement

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

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

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

addAttachListener

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

addDetachListener

Constructor Detail

MultiSelectListBox

public MultiSelectListBox()

Creates a new list box component with multi-selection.

Method Detail

setValue

public void setValue(Set<T> value)

Sets the value of this component. If the new value is not equal to the previous value, fires a value change event.

The component doesn't accept null values. The value of multi select list box without any selected items is an empty set. You can use the HasValue.clear() method to set the empty value.

Specified by:

setValue in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<MultiSelectListBox<T>,Set<T>>,Set<T>>

Specified by:

setValue in interface com.vaadin.flow.data.selection.MultiSelect<MultiSelectListBox<T>,T>

Overrides:

setValue in class com.vaadin.flow.component.AbstractField<MultiSelectListBox<T>,Set<T>>

Parameters:

value - the new value to set, not null

Throws:

NullPointerException - if value is null

updateSelection

public void updateSelection(Set<T> addedItems,
                            Set<T> removedItems)

Specified by:

updateSelection in interface com.vaadin.flow.data.selection.MultiSelect<MultiSelectListBox<T>,T>

getSelectedItems

public Set<T> getSelectedItems()

Returns an immutable set of the currently selected items. It is safe to invoke other SelectionModel methods while iterating over the set.

There are no guarantees of the iteration order of the returned set of items.

Specified by:

getSelectedItems in interface com.vaadin.flow.data.selection.MultiSelect<MultiSelectListBox<T>,T>

Returns:

the items in the current selection, not null

addSelectionListener

public com.vaadin.flow.shared.Registration addSelectionListener(com.vaadin.flow.data.selection.MultiSelectionListener<MultiSelectListBox<T>,T> listener)

Specified by:

addSelectionListener in interface com.vaadin.flow.data.selection.MultiSelect<MultiSelectListBox<T>,T>