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

java.lang.Object
  extended by com.google.web.bindery.event.shared.Event<H>
      extended by com.google.gwt.event.shared.GwtEvent<H>
          extended by com.smartgwt.client.event.AbstractSmartEvent<H>
              extended by com.smartgwt.client.widgets.events.BrowserEvent<GroupByHandler>
                  extended by 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
GwtEvent.Type<H>
 
Field Summary
 
Fields inherited from class com.smartgwt.client.event.AbstractSmartEvent
jsObj
 
Constructor Summary
GroupByEvent(JavaScriptObject jsObj)
           
 
Method Summary
 void cancel()
          Call this method to cancel groupBy change.
protected  void dispatch(GroupByHandler handler)
           
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.
 GwtEvent.Type<GroupByHandler> getAssociatedType()
           
 String[] getFields()
          ListGrid field names by which the grid is being grouped.
static 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.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(JavaScriptObject jsObj)
Method Detail

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 handlers
jsObj - the native event

getType

public static 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 GwtEvent<GroupByHandler>

getAssociatedType

public final GwtEvent.Type<GroupByHandler> getAssociatedType()
Overrides:
getAssociatedType in class GwtEvent<GroupByHandler>

cancel

public void cancel()
Call this method to cancel groupBy change.

Specified by:
cancel in interface Cancellable

isCancelled

public boolean isCancelled()
Specified by:
isCancelled in interface Cancellable
Returns:
true if cancelled

getFields

public String[] getFields()
ListGrid field names by which the grid is being grouped. If the user is ungrouping the grid, this param will be an empty array.

Returns:
ListGrid field names by which the grid is being grouped. If the user is ungrouping the grid, this param will be an empty array.