com.smartgwt.client.widgets.grid.events

Class GroupByEvent

java.lang.Object

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

com.google.gwt.event.shared.GwtEvent<H>

com.smartgwt.client.event.AbstractSmartEvent<H>

com.smartgwt.client.widgets.events.BrowserEvent<GroupByHandler>

com.smartgwt.client.widgets.grid.events.GroupByEvent

All Implemented Interfaces:

Cancellable

public class GroupByEvent
extends BrowserEvent<GroupByHandler>
implements Cancellable

Nested Class Summary

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

com.google.gwt.event.shared.GwtEvent.Type<H>

Field Summary

Fields inherited from class com.smartgwt.client.event.AbstractSmartEvent

jsObj

Constructor Summary

Constructors

Constructor and Description
GroupByEvent(com.google.gwt.core.client.JavaScriptObject jsObj)

Method Summary

Modifier and Type	Method and Description
void	cancel() Call this method to cancel grouping on the passed specification
protected void	dispatch(GroupByHandler handler)
static <S extends HasGroupByHandlers & com.google.gwt.event.shared.HasHandlers> void	fire(S source, com.google.gwt.core.client.JavaScriptObject jsObj) Fires a open event on all registered handlers in the handler manager.If no such handlers exist, this method will do nothing.
com.google.gwt.event.shared.GwtEvent.Type<GroupByHandler>	getAssociatedType()
java.lang.String[]	getFields() the list of ListGrid field-names by which the grid is about to be grouped.
Canvas	getFiringCanvas() Returns the Canvas firing the event.
GroupSpecifier[]	getSpecifiers() list of GroupSpecifier objects detailing grouping specifics for each grouped field
static com.google.gwt.event.shared.GwtEvent.Type<GroupByHandler>	getType() Gets the type associated with this event.
boolean	isCancelled()

Methods inherited from class com.smartgwt.client.widgets.events.BrowserEvent

getX, getY, isAltKeyDown, isCtrlKeyDown, isLeftButtonDown, isRightButtonDown

Methods inherited from class com.smartgwt.client.event.AbstractSmartEvent

getFiringInstanceAsJavaScriptObject

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

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

Constructor Detail

GroupByEvent

public GroupByEvent(com.google.gwt.core.client.JavaScriptObject jsObj)

Method Detail

getFiringCanvas

public Canvas getFiringCanvas()

Returns the Canvas firing the event.

Returns:

Canvas firing the event

fire

public static <S extends HasGroupByHandlers & com.google.gwt.event.shared.HasHandlers> void fire(S source,
                                                                                                 com.google.gwt.core.client.JavaScriptObject jsObj)

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

Type Parameters:

S - The event source

Parameters:

source - the source of the handlers

jsObj - the native event

getType

public static com.google.gwt.event.shared.GwtEvent.Type<GroupByHandler> getType()

Gets the type associated with this event.

Returns:

returns the handler type

dispatch

protected void dispatch(GroupByHandler handler)

Specified by:

dispatch in class com.google.gwt.event.shared.GwtEvent<GroupByHandler>

getAssociatedType

public final com.google.gwt.event.shared.GwtEvent.Type<GroupByHandler> getAssociatedType()

Overrides:

getAssociatedType in class com.google.gwt.event.shared.GwtEvent<GroupByHandler>

cancel

public void cancel()

Call this method to cancel grouping on the passed specification

Specified by:

cancel in interface Cancellable

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Cancellable

Returns:

true if cancelled

getFields

public java.lang.String[] getFields()

the list of ListGrid field-names by which the grid is about to be grouped. If the grid is being ungrouped, this param will be an empty array

Returns:

the list of ListGrid field-names by which the grid is about to be grouped. If the grid is being ungrouped, this param will be an empty array

getSpecifiers

public GroupSpecifier[] getSpecifiers()

list of GroupSpecifier objects detailing grouping specifics for each grouped field

Returns:

list of GroupSpecifier objects detailing grouping specifics for each grouped field