We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
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 itemAll 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:
-
-
Field Summary
-
Fields inherited from class java.util.EventObject
source
-
-
Constructor Summary
Constructors Constructor and 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 Modifier and Type Method and 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.
CgetSource()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.data.selection.SelectionEvent
isFromClient
-
Methods inherited from interface com.vaadin.flow.component.HasValue.ValueChangeEvent
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-trueif this event originates from the client,falseotherwise.
-
-
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:
getSourcein interfaceSelectionEvent<C extends Component,T>Overrides:
getSourcein classComponentEvent<C extends Component>Returns:
The listing component on which the Event initially occurred.
-
getFirstSelectedItem
public Optional<T> getFirstSelectedItem()Description copied from interface:
SelectionEventGet first selected data item.
This is the same as
getSelectedItem()in case of single selection.Specified by:
getFirstSelectedItemin interfaceSelectionEvent<C extends Component,T>Returns:
the first selected item.
-
getAllSelectedItems
public Set<T> getAllSelectedItems()Description copied from interface:
SelectionEventGets 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:
getAllSelectedItemsin interfaceSelectionEvent<C extends Component,T>Returns:
return all the selected items, if any, never
null
-
-