Package com.vaadin.flow.data.selection
Class SingleSelectionEvent<C extends Component,T>
- java.lang.Object
-
- java.util.EventObject
-
- com.vaadin.flow.component.ComponentEvent<C>
-
- com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<C,T>
-
- com.vaadin.flow.data.selection.SingleSelectionEvent<C,T>
-
- Type Parameters:
C
- the selection component typeT
- the type of the selected item
- All Implemented Interfaces:
HasValue.ValueChangeEvent<T>
,SelectionEvent<C,T>
,Serializable
public class SingleSelectionEvent<C extends Component,T> extends AbstractField.ComponentValueChangeEvent<C,T> implements SelectionEvent<C,T>
Fired when the selection changes in a listing component.- Since:
- 1.0.
- Author:
- Vaadin Ltd
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class java.util.EventObject
source
-
-
Constructor Summary
Constructors Constructor Description SingleSelectionEvent(C listing, SingleSelect<C,T> source, T oldSelection, boolean userOriginated)
Creates a new selection change event in a component.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Set<T>
getAllSelectedItems()
Gets all the currently selected items.Optional<T>
getFirstSelectedItem()
Get first selected data item.Optional<T>
getSelectedItem()
Returns an optional of the item that was selected, or an empty optional if a previously selected item was deselected.C
getSource()
The listing component on which the Event initially occurred.-
Methods inherited from class com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent
getHasValue, getOldValue, getValue, toString
-
Methods inherited from class com.vaadin.flow.component.ComponentEvent
isFromClient, unregisterListener
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.vaadin.flow.component.HasValue.ValueChangeEvent
isFromClient
-
Methods inherited from interface com.vaadin.flow.data.selection.SelectionEvent
isFromClient
-
-
-
-
Constructor Detail
-
SingleSelectionEvent
public SingleSelectionEvent(C listing, SingleSelect<C,T> source, T oldSelection, boolean userOriginated)
Creates a new selection change event in a component.- Parameters:
listing
- the listing component where the event originatedsource
- the single select sourceoldSelection
- the item that was previously selecteduserOriginated
-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.- Returns:
- the selected item or an empty optional if deselected
- See Also:
AbstractField.ComponentValueChangeEvent.getValue()
,SelectionModel.Single.getSelectedItem()
-
getSource
public C getSource()
The listing component on which the Event initially occurred.- Specified by:
getSource
in interfaceSelectionEvent<C extends Component,T>
- Overrides:
getSource
in classComponentEvent<C extends Component>
- Returns:
- The listing component 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.- Specified by:
getFirstSelectedItem
in interfaceSelectionEvent<C extends Component,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 interfaceSelectionEvent<C extends Component,T>
- Returns:
- return all the selected items, if any, never
null
-
-