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

Class GroupSummaryView<M>

java.lang.Object

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

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

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

All Implemented Interfaces:

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

public class GroupSummaryView<M>
extends GroupingView<M>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GroupSummaryView.GroupSummaryViewAppearance
static interface	GroupSummaryView.GroupSummaryViewStyle

Nested classes/interfaces inherited from class com.sencha.gxt.widget.core.client.grid.GroupingView

GroupingView.GroupingData<M>, GroupingView.GroupingViewAppearance, GroupingView.GroupingViewStyle, GroupingView.GroupSummaryTemplate<M>

Nested classes/interfaces inherited from class com.sencha.gxt.widget.core.client.grid.GridView

GridView.GridAppearance, GridView.GridStateStyles, GridView.GridStyles, GridView.GridTemplates

Field Summary

Fields inherited from class com.sencha.gxt.widget.core.client.grid.GroupingView

enableGrouping, groupingColumn, lastGroupField, state

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

autoFill, body, borderWidth, cm, columnListener, dataTable, dataTableBody, dataTableSizingHead, deferUpdateDelay, deferUpdates, ds, emptyText, enableRowBody, footer, forceFit, grid, header, headerColumnIndex, headerDisabled, headerElem, lastViewWidth, listener, overRow, preventScrollToTopOnRefresh, scroller, scrollOffset, selectable, sortState, splitterWidth, states, storeSortInfo, styles, tpls, unselectable, vbar, viewConfig

Constructor Summary

Constructors

Constructor and Description
GroupSummaryView()
GroupSummaryView(GridView.GridAppearance appearance, GroupSummaryView.GroupSummaryViewAppearance groupingAppearance)
GroupSummaryView(GroupSummaryView.GroupSummaryViewAppearance groupAppearance)

Method Summary

Modifier and Type	Method and Description
protected Map<ValueProvider<? super M,?>,Number>	calculate(List<M> models)
protected int	getGroupIndex(XElement group)
GroupSummaryView.GroupSummaryViewAppearance	getGroupingAppearance() Returns the grouping view appearance.
<any>	getSummaries() Gets all summary nodes currently rendered in the grid
boolean	isSummaryVisible() Returns true if summaries are visible.
protected void	onRemove(M m, int index, boolean isUpdate) Handles removing a data model from the store.
protected void	onUpdate(ListStore<M> store, List<M> models) Handles an update to data in the store.
protected void	refreshSummaries()
protected void	renderGroup(SafeHtmlBuilder buf, GroupingView.GroupingData<M> g, SafeHtml renderedRows)
protected SafeHtml	renderGroupSummary(GroupingView.GroupingData<M> groupInfo)
protected SafeHtml	renderSummary(GroupingView.GroupingData<M> groupInfo, Map<ValueProvider<? super M,?>,Number> data)
void	toggleSummaries(boolean visible) Toggles the summary information visibility.

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

addCollapseHandler, addExpandHandler, afterRender, collapseAllGroups, createContextMenu, createGroupingData, createGroupingData, doLastSort, doRender, doSort, expandAllGroups, getGroups, getRows, getSortState, groupBy, isEnabledNoGroups, isEnableGroupingMenu, isExpanded, isShowGroupedColumn, isStartCollapsed, makeGroupForRow, onAdd, onMouseDown, refreshRow, renderGroupHeader, renderRows, setEnableGroupingMenu, setEnableNoGroups, setShowGroupedColumn, setStartCollapsed, toggleAllGroups, toggleGroup, toggleGroup, valueBelongsInGroup, verifyNewGroup

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

addHandler, adjustColumnWidths, applyEmptyText, autoExpand, calculateVBar, createStoreSortInfo, doAttach, doDetach, ensureVisible, ensureVisible, findCell, findCellIndex, findRow, findRowIndex, fireEvent, fitColumns, focus, focusCell, focusRow, getAppearance, getAutoExpandColumn, getAutoExpandMax, getAutoExpandMin, getBody, getCell, getColumnData, getColumnStyle, getColumnWidth, getColumnWidths, getEditorParent, getEmptyText, getHeader, getOffsetWidth, getRenderedValue, getRow, getRow, getRowBody, getRowBodyRowSpan, getScrollAdjust, getScroller, getScrollState, getStateStyles, getTotalWidth, getViewConfig, handleComponentEvent, hasRows, init, initData, initElements, initHeader, initListeners, initUI, insertRows, isAdjustForHScroll, isAutoFill, isColumnLines, isDeferUpdates, isEnableRowBody, isForceFit, isRemoteSort, isSelectableTarget, isShowDirtyCells, isSortingEnabled, isStripeRows, isTrackMouseOver, layout, layout, notifyHide, notifyShow, onAfterRenderView, onCellDeselect, onCellSelect, onClear, onClick, onColumnMove, onColumnWidthChange, onDataChanged, onFocus, onHeaderChange, onHeaderClick, onHiddenChange, onHighlightRow, onNoNext, onNoPrev, onRowDeselect, onRowOut, onRowOver, onRowSelect, processRows, refresh, removeRow, renderFooter, renderHeader, renderHiddenHeaders, renderUI, repaintGrid, resize, restoreScroll, scrollToTop, scrollToTop, setAdjustForHScroll, setAutoExpandColumn, setAutoExpandMax, setAutoExpandMin, setAutoFill, setColumnHeader, setColumnLines, setDeferUpdates, setEmptyText, setEnableRowBody, setForceFit, setRowBodyRowSpan, setShowDirtyCells, setSortingEnabled, setStripeRows, setTrackMouseOver, setViewConfig, syncHeaderScroll, syncScroll, templateOnAllColumnWidthsUpdated, templateOnColumnHiddenUpdated, templateOnColumnWidthUpdated, updateAllColumnWidths, updateColumnHidden, updateColumnWidth, updateHeaderSortState, updateSortIcon

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupSummaryView

public GroupSummaryView()

GroupSummaryView

public GroupSummaryView(GridView.GridAppearance appearance,
                        GroupSummaryView.GroupSummaryViewAppearance groupingAppearance)

GroupSummaryView

public GroupSummaryView(GroupSummaryView.GroupSummaryViewAppearance groupAppearance)

Method Detail

getGroupingAppearance

public GroupSummaryView.GroupSummaryViewAppearance getGroupingAppearance()

Description copied from class: GroupingView

Returns the grouping view appearance.

Overrides:

getGroupingAppearance in class GroupingView<M>

Returns:

the grouping appearance

getGroupIndex

protected int getGroupIndex(XElement group)

Overrides:

getGroupIndex in class GroupingView<M>

getSummaries

public <any> getSummaries()

Gets all summary nodes currently rendered in the grid

Returns:

all summary nodes

isSummaryVisible

public boolean isSummaryVisible()

Returns true if summaries are visible.

Returns:

true for visible

toggleSummaries

public void toggleSummaries(boolean visible)

Toggles the summary information visibility.

Parameters:

visible - true for visible, false to hide

calculate

protected Map<ValueProvider<? super M,?>,Number> calculate(List<M> models)

onRemove

protected void onRemove(M m,
                        int index,
                        boolean isUpdate)

Description copied from class: GridView

Handles removing a data model from the store.

Overrides:

onRemove in class GroupingView<M>

Parameters:

m - the data model

index - the row index

isUpdate - true to indicate an update an existing row

onUpdate

protected void onUpdate(ListStore<M> store,
                        List<M> models)

Description copied from class: GridView

Handles an update to data in the store.

Overrides:

onUpdate in class GridView<M>

Parameters:

store - the store

models - the updated data

refreshSummaries

protected void refreshSummaries()

renderGroup

protected void renderGroup(SafeHtmlBuilder buf,
                           GroupingView.GroupingData<M> g,
                           SafeHtml renderedRows)

Overrides:

renderGroup in class GroupingView<M>

renderGroupSummary

protected SafeHtml renderGroupSummary(GroupingView.GroupingData<M> groupInfo)

renderSummary

protected SafeHtml renderSummary(GroupingView.GroupingData<M> groupInfo,
                                 Map<ValueProvider<? super M,?>,Number> data)