Class SingleSelectionEvent<T>

Constructor Detail

• SingleSelectionEvent

  public SingleSelectionEvent​(AbstractSingleSelect<T> source,
                              T oldSelection,
                              boolean userOriginated)

  Creates a new selection change event.

  Parameters:

  source - the listing that fired the event

  oldSelection - the item that was previously selected

  userOriginated - true if this event originates from the client, false otherwise.

• SingleSelectionEvent

  public SingleSelectionEvent​(Component component,
                              SingleSelect<T> source,
                              T oldSelection,
                              boolean userOriginated)

  Creates a new selection change event in a component.

  Parameters:

  component - the component where the event originated

  source - the single select source

  oldSelection - the item that was previously selected

  userOriginated - true if this event originates from the client, false otherwise.

Method Detail

• getSelectedItem

  public Optional<T> getSelectedItem()

  Returns an optional of the item that was selected, or an empty optional if a previously selected item was deselected.

  The result is the current selection of the source AbstractSingleSelect object. So it's always exactly the same as optional describing AbstractSingleSelect.getValue().

  Returns:

  the selected item or an empty optional if deselected

  See Also:

  HasValue.ValueChangeEvent.getValue(), SelectionModel.Single#getSelectedItem()

• getSource

  public SingleSelect<T> getSource()

  The single select on which the Event initially occurred.

  Overrides:

  getSource in class HasValue.ValueChangeEvent<T>

  Returns:

  The single select on which the Event initially occurred.

• getFirstSelectedItem

  public Optional<T> getFirstSelectedItem()

  Description copied from interface: SelectionEvent

  Get first selected data item.

  This is the same as getSelectedItem() in case of single selection and the first selected item from MultiSelectionEvent.getNewSelection() in case of multi selection.

  Specified by:

  getFirstSelectedItem in interface SelectionEvent<T>

  Returns:

  the first selected item.

• getAllSelectedItems

  public Set<T> getAllSelectedItems()

  Description copied from interface: SelectionEvent

  Gets all the currently selected items.

  This method applies more to multiselection - for single select it returns either an empty set or a set containing the only selected item.

  Specified by:

  getAllSelectedItems in interface SelectionEvent<T>

  Returns:

  return all the selected items, if any, never null