Package 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

  • Constructor Details

  • Method Details

    • getFiringCanvas

      public Canvas getFiringCanvas()
      Returns the Canvas firing 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 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()
      Specified by:
      getAssociatedType in class 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 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