com.vaadin.event.SortEvent API 7.7.16 | Vaadin

You're viewing an older version of Framework JavaDoc. Please see version 7.7.46 for the latest.

com.vaadin.event.

java.lang.Object
- java.util.EventObject
- - com.vaadin.event.ConnectorEvent
  - - com.vaadin.ui.Component.Event
    - - com.vaadin.event.SortEvent

All Implemented Interfaces:

Serializable
```
public class SortEvent
extends Component.Event
```
Event describing a change in sorting of a Container. Fired by SortNotifiers.

Since:

7.4

Author:

Vaadin Ltd

See Also:

SortEvent.SortListener, Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SortEvent.SortListener` Listener for sort order change events.
`static interface`	`SortEvent.SortNotifier` 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<SortOrder> sortOrder, boolean userOriginated)` Creates a new sort order change event with a sort order list.

Method Summary

All Methods
Modifier and Type	Method and Description
`List<SortOrder>`	`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<SortOrder> 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<SortOrder> 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