com.vaadin.ui.components.grid
Class SortOrderChangeEvent

java.lang.Object
  java.util.EventObject
      com.vaadin.event.ConnectorEvent
          com.vaadin.ui.Component.Event
              com.vaadin.ui.components.grid.SortOrderChangeEvent

All Implemented Interfaces:

java.io.Serializable

public class SortOrderChangeEvent
extends Component.Event

Event fired by Grid when the sort order has changed.

Since:

Author:

Vaadin Ltd

See Also:

SortOrderChangeListener, Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

SortOrderChangeEvent(Grid grid, java.util.List<SortOrder> sortOrder, com.vaadin.shared.ui.grid.SortEventOriginator originator)
Creates a new sort order change event for a grid and a sort order list.

Method Summary

com.vaadin.shared.ui.grid.SortEventOriginator	getOriginator() Gets a value describing the originator of this event, i.e.
java.util.List<SortOrder>	getSortOrder() Gets the sort order list.

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

SortOrderChangeEvent

public SortOrderChangeEvent(Grid grid,
                            java.util.List<SortOrder> sortOrder,
                            com.vaadin.shared.ui.grid.SortEventOriginator originator)

Creates a new sort order change event for a grid and a sort order list.

Parameters:

grid - the grid from which the event originates

sortOrder - the new sort order list

wasInitiatedByUser - should be set to true if this event results from end-user interaction instead of an API call or side effect

Method Detail

getSortOrder

public java.util.List<SortOrder> getSortOrder()

Gets the sort order list.

Returns:

the sort order list

getOriginator

public com.vaadin.shared.ui.grid.SortEventOriginator getOriginator()

Gets a value describing the originator of this event, i.e. what actions resulted in this event being fired.

Returns:

a sort event originator value

See Also:

SortEventOriginator