com.sencha.gxt.widget.core.client.grid

Class GroupingView<M>

java.lang.Object

com.sencha.gxt.widget.core.client.grid.GridView<M>

com.sencha.gxt.widget.core.client.grid.GroupingView<M>

Type Parameters:

M - the model type

All Implemented Interfaces:

CollapseItemEvent.HasCollapseItemHandlers<List<M>>, ExpandItemEvent.HasExpandItemHandlers<List<M>>

Direct Known Subclasses:

GroupSummaryView

public class GroupingView<M>
extends GridView<M>
implements CollapseItemEvent.HasCollapseItemHandlers<List<M>>, ExpandItemEvent.HasExpandItemHandlers<List<M>>

GridView that groups data based on a given grouping column.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GroupingView.DefaultGroupHeaderTemplate
static interface	GroupingView.DefaultGroupingViewTemplate
static interface	GroupingView.GroupHeaderTemplate<M>
static class	GroupingView.GroupingData<M>
static interface	GroupingView.GroupingViewTemplate<M>
static interface	GroupingView.GroupSummaryTemplate<M>

Constructor Summary

Constructors

Constructor and Description
GroupingView()

Method Summary

Methods

Modifier and Type	Method and Description
HandlerRegistration	addCollapseHandler(CollapseItemEvent.CollapseItemHandler<List<M>> handler) Adds a CollapseItemEvent.CollapseItemHandler handler for CollapseItemEvent events.
HandlerRegistration	addExpandHandler(ExpandItemEvent.ExpandItemHandler<List<M>> handler) Adds a ExpandItemEvent.ExpandItemHandler handler for ExpandItemEvent events.
void	collapseAllGroups() Collapses all groups.
void	expandAllGroups() Expands all groups.
GroupingView.GroupSummaryTemplate<M>	getGroupSummaryTemplate()
GroupingView.GroupHeaderTemplate<M>	getGroupTemplate()
GroupingView.GroupingViewTemplate<M>	getGroupViewTemplate()
void	groupBy(ColumnConfig<M,?> column)
boolean	isEnabledNoGroups()
boolean	isEnableGroupingMenu()
boolean	isShowGroupedColumn()
boolean	isStartCollapsed()
void	setEnableGroupingMenu(boolean enableGroupingMenu)
void	setEnableNoGroups(boolean enableNoGroups)
void	setGroupSummaryTemplate(GroupingView.GroupSummaryTemplate<M> groupSummaryTemplate)
void	setGroupTemplate(GroupingView.GroupHeaderTemplate<M> groupTemplate)
void	setGroupViewTemplate(GroupingView.GroupingViewTemplate<M> groupTemplate)
void	setShowGroupedColumn(boolean showGroupedColumn)
void	setStartCollapsed(boolean startCollapsed)
void	toggleAllGroups(boolean expanded)

Methods inherited from class com.sencha.gxt.widget.core.client.grid.GridView

ensureVisible, findCell, findCellIndex, findRow, findRowIndex, focusCell, focusRow, getAutoExpandColumn, getAutoExpandMax, getAutoExpandMin, getBody, getCell, getCellSelectorDepth, getEditorParent, getEmptyText, getHeader, getHeaderCell, getInnerCellElement, getRow, getRow, getRowSelectorDepth, getScroller, getScrollState, getViewConfig, isAdjustForHScroll, isAutoFill, isForceFit, isSelectableTarget, isShowDirtyCells, isSortingEnabled, layout, refresh, scrollToTop, setAdjustForHScroll, setAutoExpandColumn, setAutoExpandMax, setAutoExpandMin, setAutoFill, setCellSelectorDepth, setEmptyText, setForceFit, setRowSelectorDepth, setShowDirtyCells, setSortingEnabled, setViewConfig

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GroupingView

public GroupingView()

Method Detail

addCollapseHandler

public HandlerRegistration addCollapseHandler(CollapseItemEvent.CollapseItemHandler<List<M>> handler)

Description copied from interface: CollapseItemEvent.HasCollapseItemHandlers

Adds a CollapseItemEvent.CollapseItemHandler handler for CollapseItemEvent events.

Specified by:

addCollapseHandler in interface CollapseItemEvent.HasCollapseItemHandlers<List<M>>

Parameters:

handler - the handler

Returns:

the registration for the event

addExpandHandler

public HandlerRegistration addExpandHandler(ExpandItemEvent.ExpandItemHandler<List<M>> handler)

Description copied from interface: ExpandItemEvent.HasExpandItemHandlers

Adds a ExpandItemEvent.ExpandItemHandler handler for ExpandItemEvent events.

Specified by:

addExpandHandler in interface ExpandItemEvent.HasExpandItemHandlers<List<M>>

Parameters:

handler - the handler

Returns:

the registration for the event

collapseAllGroups

public void collapseAllGroups()

Collapses all groups.

expandAllGroups

public void expandAllGroups()

Expands all groups.

getGroupSummaryTemplate

public GroupingView.GroupSummaryTemplate<M> getGroupSummaryTemplate()

getGroupTemplate

public GroupingView.GroupHeaderTemplate<M> getGroupTemplate()

getGroupViewTemplate

public GroupingView.GroupingViewTemplate<M> getGroupViewTemplate()

groupBy

public void groupBy(ColumnConfig<M,?> column)

isEnabledNoGroups

public boolean isEnabledNoGroups()

isEnableGroupingMenu

public boolean isEnableGroupingMenu()

isShowGroupedColumn

public boolean isShowGroupedColumn()

isStartCollapsed

public boolean isStartCollapsed()

setEnableGroupingMenu

public void setEnableGroupingMenu(boolean enableGroupingMenu)

setEnableNoGroups

public void setEnableNoGroups(boolean enableNoGroups)

setGroupSummaryTemplate

public void setGroupSummaryTemplate(GroupingView.GroupSummaryTemplate<M> groupSummaryTemplate)

setGroupTemplate

public void setGroupTemplate(GroupingView.GroupHeaderTemplate<M> groupTemplate)

setGroupViewTemplate

public void setGroupViewTemplate(GroupingView.GroupingViewTemplate<M> groupTemplate)

setShowGroupedColumn

public void setShowGroupedColumn(boolean showGroupedColumn)

setStartCollapsed

public void setStartCollapsed(boolean startCollapsed)

toggleAllGroups

public void toggleAllGroups(boolean expanded)