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
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.gwt.event.shared.GwtEvent
GwtEvent.Type<H extends Object> -
Field Summary
Fields inherited from class com.smartgwt.client.event.AbstractSmartEvent
jsObj -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidcancel()Call this method to cancel grouping on the passed specificationprotected voiddispatch(GroupByHandler handler) static <S extends HasGroupByHandlers & HasHandlers>
voidfire(S source, JavaScriptObject jsObj) Fires a open event on all registered handlers in the handler manager.If no such handlers exist, this method will do nothing.final GwtEvent.Type<GroupByHandler>String[]the list of ListGrid field-names by which the grid is about to be grouped.Returns theCanvasfiring the event.list of GroupSpecifier objects detailing grouping specifics for each grouped fieldstatic GwtEvent.Type<GroupByHandler>getType()Gets the type associated with this event.booleanMethods inherited from class com.smartgwt.client.widgets.events.BrowserEvent
getX, getY, isAltKeyDown, isCtrlKeyDown, isLeftButtonDown, isRightButtonDownMethods inherited from class com.smartgwt.client.event.AbstractSmartEvent
getFiringInstanceAsJavaScriptObjectMethods inherited from class com.google.gwt.event.shared.GwtEvent
assertLive, getSource, isLive, kill, reviveMethods inherited from class com.google.web.bindery.event.shared.Event
setSource, toDebugString, toString
-
Constructor Details
-
GroupByEvent
-
-
Method Details
-
getFiringCanvas
Returns theCanvasfiring the event.- Returns:
- Canvas firing the event
-
fire
public static <S extends HasGroupByHandlers & HasHandlers> void fire(S source, 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 handlersjsObj- the native event
-
getType
Gets the type associated with this event.- Returns:
- returns the handler type
-
dispatch
- Specified by:
dispatchin classGwtEvent<GroupByHandler>
-
getAssociatedType
- Specified by:
getAssociatedTypein classGwtEvent<GroupByHandler>
-
cancel
public void cancel()Call this method to cancel grouping on the passed specification- Specified by:
cancelin interfaceCancellable
-
isCancelled
public boolean isCancelled()- Specified by:
isCancelledin interfaceCancellable- Returns:
- true if cancelled
-
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
list of GroupSpecifier objects detailing grouping specifics for each grouped field- Returns:
- list of GroupSpecifier objects detailing grouping specifics for each grouped field
-