com.google.gwt.user.cellview.client

Class ColumnSortEvent

java.lang.Object

com.google.web.bindery.event.shared.Event<H>

com.google.gwt.event.shared.GwtEvent<ColumnSortEvent.Handler>

com.google.gwt.user.cellview.client.ColumnSortEvent

public class ColumnSortEvent
extends GwtEvent<ColumnSortEvent.Handler>

Represents a column sort event.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ColumnSortEvent.AsyncHandler A default handler used with views attached to asynchronous data providers such as AsyncDataProvider.
static interface	ColumnSortEvent.Handler Handler for ColumnSortEvent.
static class	ColumnSortEvent.ListHandler<T> A default handler used to sort a List backing a table.

Nested classes/interfaces inherited from class com.google.gwt.event.shared.GwtEvent

GwtEvent.Type<H>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ColumnSortEvent(ColumnSortList sortList) Construct a new ColumnSortEvent.

Method Summary

Modifier and Type	Method and Description
protected void	dispatch(ColumnSortEvent.Handler handler) Should only be called by HandlerManager.
static ColumnSortEvent	fire(HasHandlers source, ColumnSortList sortList) Fires a column sort event on all registered handlers in the handler manager.
GwtEvent.Type<ColumnSortEvent.Handler>	getAssociatedType() Returns the Event.Type used to register this event, allowing an EventBus to find handlers of the appropriate class.
Column<?,?>	getColumn() Get the Column that was sorted.
ColumnSortList	getColumnSortList() Get the ColumnSortList that contains the ordered list of sorted columns.
static GwtEvent.Type<ColumnSortEvent.Handler>	getType() Gets the type associated with this event.
boolean	isSortAscending() Check if the Column is sorted in ascending order.

Methods inherited from class com.google.gwt.event.shared.GwtEvent

assertLive, getSource, isLive, kill, revive

Methods inherited from class com.google.web.bindery.event.shared.Event

setSource, toDebugString, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode

Constructor Detail

ColumnSortEvent

protected ColumnSortEvent(ColumnSortList sortList)

Construct a new ColumnSortEvent.

Parameters:

sortList - the ColumnSortList

Method Detail

fire

public static ColumnSortEvent fire(HasHandlers source,
                                   ColumnSortList sortList)

Fires a column sort 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:

the ColumnSortEvent that was fired

getType

public static GwtEvent.Type<ColumnSortEvent.Handler> getType()

Gets the type associated with this event.

Returns:

returns the handler type

getAssociatedType

public GwtEvent.Type<ColumnSortEvent.Handler> getAssociatedType()

Description copied from class: com.google.web.bindery.event.shared.Event

Returns the Event.Type used to register this event, allowing an EventBus to find handlers of the appropriate class.

Specified by:

getAssociatedType in class GwtEvent<ColumnSortEvent.Handler>

Returns:

the type

getColumn

public Column<?,?> getColumn()

Get the Column that was sorted.

Returns:

the sorted Column, or null if not sorted

getColumnSortList

public ColumnSortList getColumnSortList()

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

Returns:

the ColumnSortList

isSortAscending

public boolean isSortAscending()

Check if the Column is sorted in ascending order.

Returns:

true if ascending, false if descending or not sorted

dispatch

protected void dispatch(ColumnSortEvent.Handler handler)

Description copied from class: GwtEvent

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

Specified by:

dispatch in class GwtEvent<ColumnSortEvent.Handler>

Parameters:

handler - handler

See Also:

EventBus.dispatchEvent(Event, Object)