Package com.vaadin.flow.component.listbox

Class MultiSelectListBox<T>

java.lang.Object

com.vaadin.flow.component.Component

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

com.vaadin.flow.component.AbstractSinglePropertyField<MultiSelectListBox<T>,Set<T>>

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:

AttachNotifier, DetachNotifier, HasAriaLabel, HasComponents, HasElement, HasEnabled, HasSize, HasStyle, HasValue<AbstractField.ComponentValueChangeEvent<MultiSelectListBox<T>,Set<T>>,Set<T>>, HasValueAndElement<AbstractField.ComponentValueChangeEvent<MultiSelectListBox<T>,Set<T>>,Set<T>>, HasTooltip, HasItemComponents<T>, HasDataView<T,Void,ListBoxDataView<T>>, HasListDataView<T,ListBoxListDataView<T>>, MultiSelect<MultiSelectListBox<T>,T>, Serializable

public class MultiSelectListBox<T>
extends ListBoxBase<MultiSelectListBox<T>,T,Set<T>>
implements 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

AbstractField.ComponentValueChangeEvent<C extends Component,V>

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

HasItemComponents.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	Description
MultiSelectListBox()	Creates a new list box component with multi-selection.

Method Summary

Modifier and Type	Method	Description
Registration	addSelectionListener(MultiSelectionListener<MultiSelectListBox<T>,T> listener)	Adds a selection listener that will be called when the selection is changed either by the user or programmatically.
Set<T>	getSelectedItems()	Returns an immutable set of the currently selected items.
SelectionPreservationMode	getSelectionPreservationMode()	Gets the selection preservation mode.
protected void	setModelValue(Set<T> newModelValue, boolean fromClient)	Updates the model value if the value has actually changed.
void	setSelectionPreservationMode(SelectionPreservationMode selectionPreservationMode)	Sets the selection preservation mode.
void	setValue(Set<T> value)	Sets the value of this component.
void	updateSelection(Set<T> addedItems, Set<T> removedItems)	Updates the selection by adding and removing the given items from it.
protected boolean	valueEquals(Set<T> value1, Set<T> value2)	Compares two value instances to each other to determine whether they are equal.

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

bindRequiredIndicatorVisible, getDataProvider, getGenericDataView, getItemEnabledProvider, getItemId, getItemLabelGenerator, getItemRenderer, getListDataView, onAttach, onDetach, onEnabledStateChanged, setDataProvider, setItemEnabledProvider, setItemLabelGenerator, setItems, setItems, setItems, 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, bindValue, getEmptyValue, getValue, isEmpty

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

addListener, bindVisible, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTestId, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setTestId, 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.component.AttachNotifier

addAttachListener

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

addDetachListener

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

getAriaLabel, getAriaLabelledBy, setAriaLabel, setAriaLabelledBy

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

add, add, add, addComponentAsFirst, addComponentAtIndex, bindChildren, getChildren, getComponentAt, getComponentCount, indexOf, remove, remove, removeAll, replace

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

getElement

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

bindEnabled, isEnabled, setEnabled

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

addComponents, getItemPosition, prependComponents

Methods inherited from interface com.vaadin.flow.data.provider.HasListDataView

setItems, setItems

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

bindHeight, bindWidth, 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.HasStyle

addClassName, addClassNames, bindClassName, bindClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Methods inherited from interface com.vaadin.flow.component.shared.HasTooltip

getTooltip, setTooltipMarkdown, setTooltipText

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

addValueChangeListener, bindValue, clear, getOptionalValue, isEmpty

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

bindReadOnly, bindRequiredIndicatorVisible, isReadOnly, isRequiredIndicatorVisible, setReadOnly, setRequiredIndicatorVisible

Methods inherited from interface com.vaadin.flow.data.selection.MultiSelect

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

Constructor Details

MultiSelectListBox

public MultiSelectListBox()

Creates a new list box component with multi-selection.

Method Details

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 HasValue<AbstractField.ComponentValueChangeEvent<MultiSelectListBox<T>,Set<T>>,Set<T>>

Specified by:

setValue in interface MultiSelect<MultiSelectListBox<T>,T>

Overrides:

setValue in class 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)

Description copied from interface: MultiSelect

Updates the selection by adding and removing the given items from it.

If all the added items were already selected and the removed items were not selected, this is a NO-OP.

Duplicate items (in both add and remove sets) are ignored.

Specified by:

updateSelection in interface MultiSelect<MultiSelectListBox<T>,T>

Parameters:

addedItems - the items to add, not null

removedItems - the items to remove, not null

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 MultiSelect<MultiSelectListBox<T>,T>

Returns:

the items in the current selection, not null

addSelectionListener

public Registration addSelectionListener(MultiSelectionListener<MultiSelectListBox<T>,T> listener)

Description copied from interface: MultiSelect

Adds a selection listener that will be called when the selection is changed either by the user or programmatically.

Specified by:

addSelectionListener in interface MultiSelect<MultiSelectListBox<T>,T>

Parameters:

listener - the value change listener, not null

Returns:

a registration for the listener

setSelectionPreservationMode

public void setSelectionPreservationMode(SelectionPreservationMode selectionPreservationMode)

Sets the selection preservation mode. Determines what happens with the selection when DataProvider.refreshAll() is called. The selection is discarded in any case when a new data provider is set. The default is SelectionPreservationMode.DISCARD.

Parameters:

selectionPreservationMode - the selection preservation mode to switch to, not null

See Also:

• SelectionPreservationMode

getSelectionPreservationMode

public SelectionPreservationMode getSelectionPreservationMode()

Gets the selection preservation mode.

Returns:

the selection preservation mode

See Also:

• setSelectionPreservationMode(SelectionPreservationMode)

setModelValue

protected void setModelValue(Set<T> newModelValue,
 boolean fromClient)

Description copied from class: AbstractField

Updates the model value if the value has actually changed. Subclasses should call this method whenever the user has changed the value. A value change event is fired if the new value is different from the previous value according to AbstractField.valueEquals(Object, Object).

If the value is from the client-side and this field is in readonly mode, then the new model value will be ignored. AbstractField.setPresentationValue(Object) will be called with the previous model value so that the representation shown to the user can be reverted.

See AbstractField for an overall description on the difference between model values and presentation values.

Overrides:

setModelValue in class AbstractField<MultiSelectListBox<T>,Set<T>>

Parameters:

newModelValue - the new internal value to use

fromClient - true if the new value originates from the client; otherwise false

valueEquals

protected boolean valueEquals(Set<T> value1,
 Set<T> value2)

Compares two value instances to each other to determine whether they are equal. Equality is used to determine whether to update internal state and fire an event when AbstractField.setValue(Object) or AbstractField.setModelValue(Object, boolean) is called. Subclasses can override this method to define an alternative comparison method instead of Object.equals(Object).

Overrides:

valueEquals in class AbstractField<MultiSelectListBox<T>,Set<T>>

Parameters:

value1 - the first set of instance

value2 - the second set of instance

Returns:

true if sets are equal in size and also the items; otherwise false