Package io.jmix.ui.component

Class DataGrid.SortEvent

java.lang.Object

java.util.EventObject

io.jmix.ui.component.DataGrid.AbstractDataGridEvent

io.jmix.ui.component.DataGrid.SortEvent

All Implemented Interfaces:

HasUserOriginated, Serializable

Enclosing interface:

DataGrid<E>

public static class DataGrid.SortEvent
extends DataGrid.AbstractDataGridEvent
implements HasUserOriginated

An event that is fired when a sort order is changed.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<DataGrid.SortOrder>	sortOrder
protected final boolean	userOriginated

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
SortEvent(DataGrid component, List<DataGrid.SortOrder> sortOrder)	Creates a new sort order change event with a sort order list.
SortEvent(DataGrid component, List<DataGrid.SortOrder> sortOrder, boolean userOriginated)	Creates a new sort order change event with a sort order list.

Method Summary

Modifier and Type	Method	Description
List<DataGrid.SortOrder>	getSortOrder()
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

sortOrder

protected final List<DataGrid.SortOrder> sortOrder

userOriginated

protected final boolean userOriginated

Constructor Details

SortEvent

public SortEvent(DataGrid component,
 List<DataGrid.SortOrder> sortOrder)

Creates a new sort order change event with a sort order list.

Parameters:

component - the DataGrid from which this event originates

sortOrder - the new sort order list

SortEvent

public SortEvent(DataGrid component,
 List<DataGrid.SortOrder> sortOrder,
 boolean userOriginated)

Creates a new sort order change event with a sort order list.

Parameters:

component - the DataGrid from which this event originates

sortOrder - the new sort order list

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

Method Details

getSortOrder

public List<DataGrid.SortOrder> getSortOrder()

Returns:

the sort order list

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.