com.vaadin.event

Class SortEvent<T extends SortOrder<?>>

java.lang.Object

java.util.EventObject

com.vaadin.event.ConnectorEvent

com.vaadin.ui.Component.Event

com.vaadin.event.SortEvent<T>

Type Parameters:

T - the type of the sorting information

All Implemented Interfaces:

Serializable

public class SortEvent<T extends SortOrder<?>>
extends Component.Event

Event describing a change in sorting of a DataProvider. Fired by SortNotifiers.

Since:

8.0

Author:

Vaadin Ltd

See Also:

SortEvent.SortListener, SortOrder, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SortEvent.SortListener<T extends SortOrder<?>> Listener for sort order change events.
static interface	SortEvent.SortNotifier<T 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 and Description
SortEvent(Component source, List<T> sortOrder, boolean userOriginated) Creates a new sort order change event with a sort order list.

Method Summary

Modifier and Type	Method and Description
List<T>	getSortOrder() Gets the sort order list.
boolean	isUserOriginated() Returns whether this event originated from actions done by the user.

Methods inherited from class com.vaadin.ui.Component.Event

getComponent

Methods inherited from class com.vaadin.event.ConnectorEvent

getConnector

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SortEvent

public SortEvent(Component source,
                 List<T> sortOrder,
                 boolean userOriginated)

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

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

Method Detail

getSortOrder

public List<T> getSortOrder()

Gets the sort order list.

Returns:

the sort order list

isUserOriginated

public boolean isUserOriginated()

Returns whether this event originated from actions done by the user.

Returns:

true if sort event originated from user interaction