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)

• 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