com.smartgwt.client.widgets.grid.events

Interface HasGroupByCompleteHandlers

All Superinterfaces:

com.google.gwt.event.shared.HasHandlers

All Known Implementing Classes:

CalendarView, CubeGrid, DateGrid, EditTree, ListGrid, ListPalette, Menu, MenuPalette, PickListMenu, RecordEditor, SelectionTreeMenu, TableView, TreeGrid, TreePalette

public interface HasGroupByCompleteHandlers
extends com.google.gwt.event.shared.HasHandlers

Method Summary

Modifier and Type	Method and Description
com.google.gwt.event.shared.HandlerRegistration	addGroupByCompleteHandler(GroupByCompleteHandler handler) Callback fired when the listGrid is grouped or ungrouped.

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Method Detail

addGroupByCompleteHandler

com.google.gwt.event.shared.HandlerRegistration addGroupByCompleteHandler(GroupByCompleteHandler handler)

Callback fired when the listGrid is grouped or ungrouped.

Unlike ListGrid.groupBy(), this notification will fire when grouping is complete, and the data object has been updated. On successful grouping the fields argument will list the new grouping and the groupTree will have been updated to reflect the grouped data.

Note that the fields argument may be an empty array if the data is not grouped. This implies that a user or developer explicitly ungrouped the grid, or that a groupBy attempt failed due to the data length exceeding groupByMaxRecords.

Parameters:

handler - the groupByComplete handler

Returns:

HandlerRegistration used to remove this handler