com.extjs.gxt.ui.client.widget.grid
Class GroupingView

java.lang.Object
  com.extjs.gxt.ui.client.event.BaseObservable
      com.extjs.gxt.ui.client.widget.grid.GridView
          com.extjs.gxt.ui.client.widget.grid.GroupingView

All Implemented Interfaces:

Observable

Direct Known Subclasses:

GroupSummaryView

public class GroupingView
extends GridView

GridView that groups data based on a GroupingStore.

Nested Class Summary

class

GroupingView.GroupingViewImages

Nested classes/interfaces inherited from class com.extjs.gxt.ui.client.widget.grid.GridView

GridView.GridViewImages

Constructor Summary

GroupingView()

Method Summary

void	collapseAllGroups() Collapses all groups.
void	expandAllGroups() Expands all groups.
GridGroupRenderer	getGroupRenderer() Returns the group renderer.
GroupingView.GroupingViewImages	getImages() Returns the images used by grid.
void	initData(ListStore ds, ColumnModel cm) Initializes the data.
boolean	isEnableGroupingMenu() Returns true if the grouping menu is enabled.
boolean	isEnableNoGroups() Returns true if the user can turn off grouping.
boolean	isShowGroupedColumn() Returns true if the grouped column is visible.
boolean	isStartCollapsed() Returns true if start collapsed is enabled.
void	setEnableGroupingMenu(boolean enableGroupingMenu) True to enable the grouping entry in the header context menu (defaults to true).
void	setEnableNoGroups(boolean enableNoGroups) True to allow the user to turn off grouping by adding a check item to the header context menu (defaults to true).
void	setGroupRenderer(GridGroupRenderer groupRenderer) Sets the group renderer.
void	setShowGroupedColumn(boolean showGroupedColumn) Sets whether the grouped column is visible (defaults to true).
void	setStartCollapsed(boolean startCollapsed) Sets whether the groups should start collapsed (defaults to false).
void	toggleAllGroups(boolean expanded) Toggles all groups.

Methods inherited from class com.extjs.gxt.ui.client.widget.grid.GridView

ensureVisible, findCell, findCellIndex, findRow, findRowIndex, focusCell, focusRow, getBody, getCell, getCellSelectorDepth, getEditorParent, getEmptyText, getHeader, getHeaderCell, getRow, getRow, getRowSelectorDepth, getScrollState, getViewConfig, getWidget, isAutoFill, isForceFit, isShowDirtyCells, isSortingEnabled, layout, refresh, scrollToTop, setAutoFill, setCellSelectorDepth, setEmptyText, setForceFit, setRowSelectorDepth, setShowDirtyCells, setSortingEnabled, setViewConfig

Methods inherited from class com.extjs.gxt.ui.client.event.BaseObservable

addListener, fireEvent, fireEvent, getFiresEvents, getListeners, hasActiveEvent, hasListeners, hasListeners, removeAllListeners, removeListener, setFiresEvents

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupingView

public GroupingView()

Method Detail

collapseAllGroups

public void collapseAllGroups()

Collapses all groups.

expandAllGroups

public void expandAllGroups()

Expands all groups.

getGroupRenderer

public GridGroupRenderer getGroupRenderer()

Returns the group renderer.

Returns:

the group renderer

getImages

public GroupingView.GroupingViewImages getImages()

Description copied from class: GridView

Returns the images used by grid.

Overrides:

getImages in class GridView

Returns:

the images

initData

public void initData(ListStore ds,
                     ColumnModel cm)

Description copied from class: GridView

Initializes the data.

Parameters:

ds - the data store

cm - the column model

isEnableGroupingMenu

public boolean isEnableGroupingMenu()

Returns true if the grouping menu is enabled.

Returns:

the enable grouping state

isEnableNoGroups

public boolean isEnableNoGroups()

Returns true if the user can turn off grouping.

Returns:

the enable no groups state

isShowGroupedColumn

public boolean isShowGroupedColumn()

Returns true if the grouped column is visible.

Returns:

the show grouped column

isStartCollapsed

public boolean isStartCollapsed()

Returns true if start collapsed is enabled.

Returns:

the start collapsed state

setEnableGroupingMenu

public void setEnableGroupingMenu(boolean enableGroupingMenu)

True to enable the grouping entry in the header context menu (defaults to true).

Parameters:

enableGroupingMenu - true to enable

setEnableNoGroups

public void setEnableNoGroups(boolean enableNoGroups)

True to allow the user to turn off grouping by adding a check item to the header context menu (defaults to true).

Parameters:

enableNoGroups - true to enable turning off grouping

setGroupRenderer

public void setGroupRenderer(GridGroupRenderer groupRenderer)

Sets the group renderer.

Parameters:

groupRenderer - the group renderer

setShowGroupedColumn

public void setShowGroupedColumn(boolean showGroupedColumn)

Sets whether the grouped column is visible (defaults to true).

Parameters:

showGroupedColumn - true to show the grouped column

setStartCollapsed

public void setStartCollapsed(boolean startCollapsed)

Sets whether the groups should start collapsed (defaults to false).

Parameters:

startCollapsed - true to start collapsed

toggleAllGroups

public void toggleAllGroups(boolean expanded)

Toggles all groups.

Parameters:

expanded - true to expand