public class

ColumnSortEvent

extends GwtEvent<H extends EventHandler>
java.lang.Object
   ↳ com.google.gwt.event.shared.GwtEvent<H extends com.google.gwt.event.shared.EventHandler>
     ↳ com.google.gwt.user.cellview.client.ColumnSortEvent

Class Overview

Represents a column sort event.

Summary

Nested Classes
class ColumnSortEvent.AsyncHandler A default handler used with views attached to asynchronous data providers such as AsyncDataProvider. 
interface ColumnSortEvent.Handler Handler for ColumnSortEvent
class ColumnSortEvent.ListHandler<T>

A default handler used to sort a List backing a table. 

Protected Constructors
ColumnSortEvent(ColumnSortList sortList)
Construct a new ColumnSortEvent.
Public Methods
static ColumnSortEvent fire(HasHandlers source, ColumnSortList sortList)
Fires a cell preview event on all registered handlers in the handler manager.
Type<ColumnSortEvent.Handler> getAssociatedType()
Returns the type used to register this event.
Column<?, ?> getColumn()
Get the Column that was sorted.
ColumnSortList getColumnSortList()
Get the ColumnSortList that contains the ordered list of sorted columns.
static Type<ColumnSortEvent.Handler> getType()
Gets the type associated with this event.
boolean isSortAscending()
Check if the Column is sorted in ascending order.
Protected Methods
void dispatch(ColumnSortEvent.Handler handler)
Should only be called by HandlerManager.
[Expand]
Inherited Methods
From class com.google.gwt.event.shared.GwtEvent
From class java.lang.Object

Protected Constructors

protected ColumnSortEvent (ColumnSortList sortList)

Construct a new ColumnSortEvent.

Parameters
sortList the ColumnSortList

Public Methods

public static ColumnSortEvent fire (HasHandlers source, ColumnSortList sortList)

Fires a cell preview event on all registered handlers in the handler manager. If no such handlers exist, this implementation will do nothing.

Parameters
source the source of the event
sortList the ColumnSortList of sorted columns
Returns

public Type<ColumnSortEvent.Handler> getAssociatedType ()

Returns the type used to register this event. Used by handler manager to dispatch events to the correct handlers.

Returns
  • the type

public Column<?, ?> getColumn ()

Get the Column that was sorted.

Returns
  • the sorted Column, or null if not sorted

public ColumnSortList getColumnSortList ()

Get the ColumnSortList that contains the ordered list of sorted columns.

Returns

public static Type<ColumnSortEvent.Handler> getType ()

Gets the type associated with this event.

Returns
  • returns the handler type

public boolean isSortAscending ()

Check if the Column is sorted in ascending order.

Returns
  • true if ascending, false if descending or not sorted

Protected Methods

protected void dispatch (ColumnSortEvent.Handler handler)

Should only be called by HandlerManager. In other words, do not use or call.

Parameters
handler handler