com.vaadin.event.selection

Interface SelectionEvent<T>

Type Parameters:

T - the data type of the selection model

All Superinterfaces:

Serializable

All Known Implementing Classes:

MultiSelectionEvent, SingleSelectionEvent

public interface SelectionEvent<T>
extends Serializable

A selection event that unifies the way to access to selection event for multi selection and single selection components (in case when only one selected item is required).

Since:

8.0

Author:

Vaadin Ltd

Method Summary

Modifier and Type	Method and Description
Set<T>	getAllSelectedItems() Gets all the currently selected items.
Optional<T>	getFirstSelectedItem() Get first selected data item.
boolean	isUserOriginated() Returns whether this selection event was triggered by user interaction, on the client side, or programmatically, on the server side.

Method Detail

getFirstSelectedItem

Optional<T> getFirstSelectedItem()

Get first selected data item.

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

Returns:

the first selected item.

getAllSelectedItems

Set<T> getAllSelectedItems()

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.

Returns:

return all the selected items, if any, never null

isUserOriginated

boolean isUserOriginated()

Returns whether this selection event was triggered by user interaction, on the client side, or programmatically, on the server side.

Returns:

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