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
public static class DataGrid.SortEvent
extends DataGrid.AbstractDataGridEvent
implements HasUserOriginated
An event that is fired when a sort order is changed.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected final List<DataGrid.SortOrder>
protected final boolean
Fields inherited from class java.util.EventObject
source
-
Constructor Summary
ConstructorDescriptionSortEvent
(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 TypeMethodDescriptionboolean
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
-
Field Details
-
sortOrder
-
userOriginated
protected final boolean userOriginated
-
-
Constructor Details
-
SortEvent
Creates a new sort order change event with a sort order list.- Parameters:
component
- the DataGrid from which this event originatessortOrder
- the new sort order list
-
SortEvent
Creates a new sort order change event with a sort order list.- Parameters:
component
- the DataGrid from which this event originatessortOrder
- the new sort order listuserOriginated
-true
if an event is a result of user interaction,false
if from the API call
-
-
Method Details
-
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 interfaceHasUserOriginated
- Returns:
true
if this event originates by user interaction,false
otherwise.
-