com.vaadin.flow.data.event.SortEvent API 23.1.17 | Vaadin

You're viewing an older version of Vaadin JavaDoc. Please see version 24.7.0 for the latest.

com.vaadin.flow.data.event.

java.lang.Object
- java.util.EventObject
- - com.vaadin.flow.component.ComponentEvent<T>
  - - com.vaadin.flow.data.event.SortEvent<T,S>

Type Parameters:

T - the event source type

S - the type of the sorting information

All Implemented Interfaces:

Serializable
```
public class SortEvent<T extends Component,S extends SortOrder<?>>
extends ComponentEvent<T>
```
Event describing a change in sorting of a DataProvider. Fired by SortNotifiers.

Since:

1.0

Author:

Vaadin Ltd

See Also:

SortOrder, Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static interface`	`SortEvent.SortNotifier<T extends Component,S extends SortOrder<?>>`	The interface for adding and removing listeners for `SortEvents`.

Field Summary
- Fields inherited from class java.util.EventObject
  source

Constructor Summary

Constructors
Constructor Description

SortEvent(T source, List<S> sortOrder, boolean fromClient)
Creates a new sort order change event with a sort order list.

Method Summary

All Methods
Modifier and Type Method Description

List<S> getSortOrder()
Gets the sort order list.
- Methods inherited from class com.vaadin.flow.component.ComponentEvent
  getSource, isFromClient, unregisterListener
- 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

- Constructor Detail
  - SortEvent
```
public SortEvent(T source,
                 List<S> sortOrder,
                 boolean fromClient)
```
    Creates a new sort order change event with a sort order list.
    
    Parameters:
    
    source - the component from which the event originates
    
    sortOrder - the new sort order list
    
    fromClient - true if event is a result of user interaction, false if from API call
- Method Detail
  - getSortOrder
```
public List<S> getSortOrder()
```
    Gets the sort order list.
    
    Returns:
    
    the sort order list