Package io.jmix.ui.component

Class DataGrid.SelectionEvent<E>

java.lang.Object

java.util.EventObject

io.jmix.ui.component.DataGrid.AbstractDataGridEvent

io.jmix.ui.component.DataGrid.SelectionEvent<E>

All Implemented Interfaces:

HasUserOriginated, Serializable

Enclosing interface:

DataGrid<E>

public static class DataGrid.SelectionEvent<E>
extends DataGrid.AbstractDataGridEvent
implements HasUserOriginated

Event sent when the selection changes. It specifies what in a selection has changed, and where the selection took place.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected final Set<E>	oldSelection
protected final Set<E>	selected
protected final boolean	userOriginated

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
SelectionEvent(DataGrid<E> component, Set<E> oldSelection, boolean userOriginated)	Constructor for a selection event.

Method Summary

Modifier and Type	Method	Description
Set<E>	getAdded()	A Set of all the items that became selected.
Set<E>	getOldSelection()	A Set of all the items that were selected before the selection was changed.
Set<E>	getRemoved()	A Set of all the items that became deselected.
Set<E>	getSelected()	A Set of all the items that are currently selected.
boolean	isUserOriginated()	Returns whether this event was triggered by user interaction or programmatically.

Methods inherited from class io.jmix.ui.component.DataGrid.AbstractDataGridEvent

getSource

Methods inherited from class java.util.EventObject

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

selected

protected final Set<E> selected

oldSelection

protected final Set<E> oldSelection

userOriginated

protected final boolean userOriginated

Constructor Details

SelectionEvent

public SelectionEvent(DataGrid<E> component,
 Set<E> oldSelection,
 boolean userOriginated)

Constructor for a selection event.

Parameters:

component - the DataGrid from which this event originates

oldSelection - the old set of selected items

userOriginated - true if an event is a result of user interaction, false if from the API call

Method Details

getAdded

public Set<E> getAdded()

A Set of all the items that became selected. Note: this excludes all items that might have been previously selected.

Returns:

a set of the items that became selected

getRemoved

public Set<E> getRemoved()

A Set of all the items that became deselected. Note: this excludes all items that might have been previously deselected.

Returns:

a set of the items that became deselected

getSelected

public Set<E> getSelected()

A Set of all the items that are currently selected.

Returns:

a set of the items that are currently selected

getOldSelection

public Set<E> getOldSelection()

A Set of all the items that were selected before the selection was changed.

Returns:

a set of items selected before the selection was changed

isUserOriginated

public boolean isUserOriginated()

Description copied from interface: HasUserOriginated

Returns whether this event was triggered by user interaction or programmatically.

Specified by:

isUserOriginated in interface HasUserOriginated

Returns:

true if this event originates by user interaction, false otherwise.