com.sencha.gxt.widget.core.client.treegrid

Class TreeGrid<M>

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.sencha.gxt.widget.core.client.Component

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

com.sencha.gxt.widget.core.client.treegrid.TreeGrid<M>

Type Parameters:

M - the model type

All Implemented Interfaces:

HasAttachHandlers, HasResizeHandlers, HasHandlers, EventListener, HasVisibility, IsWidget, BeforeHideEvent.HasBeforeHideHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, BodyScrollEvent.HasBodyScrollHandlers, CellClickEvent.HasCellClickHandlers, CellDoubleClickEvent.HasCellDoubleClickHandlers, CellMouseDownEvent.HasCellMouseDownHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HeaderClickEvent.HasHeaderClickHandlers, HeaderContextMenuEvent.HasHeaderContextMenuHandlers, HeaderDoubleClickEvent.HasHeaderDoubleClickHandlers, HideEvent.HasHideHandlers, MoveEvent.HasMoveHandlers, ReconfigureEvent.HasReconfigureHandlers, RefreshEvent.HasRefreshHandlers, RowClickEvent.HasRowClickHandlers, RowDoubleClickEvent.HasRowDoubleClickHandlers, RowMouseDownEvent.HasRowMouseDownHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, SortChangeEvent.HasSortChangeHandlers, ViewReadyEvent.HasViewReadyHandlers, HasFocusSupport, HasItemId

public class TreeGrid<M>
extends Grid<M>

A hierarchical tree grid bound to a TreeStore.

A TreeGridCellRenderer can be assigned to the ColumnConfig in which the tree will be displayed.

With state enabled, TreePanel will save and restore the expand state of the nodes in the tree. A ModelKeyProvider must specified with the TreeStore this tree is bound to. Save and restore works with both local, and asynchronous loading of children.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TreeGrid.TreeGridNode<M>

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

Grid.Callback, Grid.GridAppearance, Grid.GridCell

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
TreeGrid(TreeStore<M> store, ColumnModel<M> cm, ColumnConfig<M,?> treeColumn)
TreeGrid(TreeStore<M> store, ColumnModel<M> cm, ColumnConfig<M,?> treeColumn, Grid.GridAppearance appearance)
TreeGrid(TreeStore<M> store, ColumnModel<M> cm, ColumnConfig<M,?> treeColumn, Grid.GridAppearance appearance, Tree.TreeAppearance treeAppearance)

Method Summary

Methods

Modifier and Type	Method and Description
void	collapseAll() Collapses all nodes.
void	expandAll() Expands all nodes.
Tree.TreeNode<M>	findNode(Element target) Returns the tree node for the given target.
Grid.GridAppearance	getAppearance() Returns the grid appearance.
IconProvider<M>	getIconProvider() Returns the model icon provider.
TreeStyle	getStyle() Returns the tree style.
Tree.TreeAppearance	getTreeAppearance()
ColumnConfig<M,?>	getTreeColumn()
TreeLoader<M>	getTreeLoader()
TreeStore<M>	getTreeStore() Returns the tree's tree store.
TreeGridView<M>	getTreeView() Returns the tree's view.
boolean	isAutoExpand() Returns true if auto expand is enabled.
boolean	isAutoLoad() Returns true if auto load is enabled.
boolean	isCaching() Returns true when a loader is queried for it's children each time a node is expanded.
boolean	isExpanded(M model) Returns true if the model is expanded.
boolean	isExpandOnFilter() Returns the if expand all and collapse all is enabled on filter changes.
boolean	isLeaf(M model) Returns true if the model is a leaf node.
void	reconfigure(ListStore<M> store, ColumnModel<M> cm) Reconfigures the grid to use a different Store and Column Model.
void	reconfigure(TreeStore<M> store, ColumnModel<M> cm, ColumnConfig<M,?> treeColumn)
void	refresh(M model)
void	setAutoExpand(boolean autoExpand) If set to true, all non leaf nodes will be expanded automatically (defaults to false).
void	setAutoLoad(boolean autoLoad) Sets whether all children should automatically be loaded recursively (defaults to false).
void	setCaching(boolean caching) Sets whether the children should be cached after first being retrieved from the store (defaults to true).
void	setExpanded(M model, boolean expand) Sets the item's expand state.
void	setExpanded(M model, boolean expand, boolean deep) Sets the item's expand state.
void	setExpandOnFilter(boolean expandOnFilter) Sets whether the tree should expand all and collapse all when filters are applied (defaults to true).
void	setIconProvider(IconProvider<M> iconProvider) Sets the tree's model icon provider which provides the icon style for each model.
void	setLeaf(M model, boolean leaf) Sets the item's leaf state.
void	setTreeLoader(TreeLoader<M> treeLoader)
void	setView(GridView<M> view) Sets the view's grid (pre-render).
void	toggle(M model) Toggles the model's expand state.

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

addBodyScrollHandler, addCellClickHandler, addCellDoubleClickHandler, addCellMouseDownHandler, addHeaderClickHandler, addHeaderContextMenuHandler, addHeaderDoubleClickHandler, addReconfigureHandler, addRefreshHandler, addRowClickHandler, addRowDoubleClickHandler, addRowMouseDownHandler, addSortChangeHandler, addViewReadyHandler, getColumnModel, getLazyRowRender, getLoader, getMinColumnWidth, getSelectionModel, getStore, getView, isColumnLines, isColumnReordering, isColumnResize, isHideHeaders, isLoadMask, isStripeRows, isTrackMouseOver, isViewReady, onBrowserEvent, setAllowTextSelection, setColumnLines, setColumnReordering, setColumnResize, setHideHeaders, setLazyRowRender, setLoader, setLoadMask, setMinColumnWidth, setSelectionModel, setStripeRows, setTrackMouseOver, walkCells

Methods inherited from class com.sencha.gxt.widget.core.client.Component

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleOnOver, clearSizeCache, disable, disableEvents, enable, enableEvents, fireEvent, focus, getData, getElement, getFocusSupport, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getShadow, getStateId, getToolTip, hide, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isRendered, isStateful, isVisible, isVisible, mask, mask, removeHandler, removeToolTip, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setPagePosition, setPixelSize, setPosition, setShadow, setSize, setStateful, setStateId, setTabIndex, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, getLayoutData, getParent, isAttached, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, removeStyleName, setStyleDependentName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

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

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

fireEvent

Constructor Detail

TreeGrid

public TreeGrid(TreeStore<M> store,
        ColumnModel<M> cm,
        ColumnConfig<M,?> treeColumn)

TreeGrid

public TreeGrid(TreeStore<M> store,
        ColumnModel<M> cm,
        ColumnConfig<M,?> treeColumn,
        Grid.GridAppearance appearance)

TreeGrid

public TreeGrid(TreeStore<M> store,
        ColumnModel<M> cm,
        ColumnConfig<M,?> treeColumn,
        Grid.GridAppearance appearance,
        Tree.TreeAppearance treeAppearance)

Method Detail

collapseAll

public void collapseAll()

Collapses all nodes.

expandAll

public void expandAll()

Expands all nodes.

findNode

public Tree.TreeNode<M> findNode(Element target)

Returns the tree node for the given target.

Parameters:

target - the target element

Returns:

the tree node or null if no match

getAppearance

public Grid.GridAppearance getAppearance()

Description copied from class: Grid

Returns the grid appearance.

Overrides:

getAppearance in class Grid<M>

Returns:

the grid appearance

getIconProvider

public IconProvider<M> getIconProvider()

Returns the model icon provider.

Returns:

the icon provider

getStyle

public TreeStyle getStyle()

Returns the tree style.

Returns:

the tree style

getTreeAppearance

public Tree.TreeAppearance getTreeAppearance()

getTreeColumn

public ColumnConfig<M,?> getTreeColumn()

getTreeLoader

public TreeLoader<M> getTreeLoader()

getTreeStore

public TreeStore<M> getTreeStore()

Returns the tree's tree store.

Returns:

the tree store

getTreeView

public TreeGridView<M> getTreeView()

Returns the tree's view.

Returns:

the view

isAutoExpand

public boolean isAutoExpand()

Returns true if auto expand is enabled.

Returns:

the auto expand state

isAutoLoad

public boolean isAutoLoad()

Returns true if auto load is enabled.

Returns:

the auto load state

isCaching

public boolean isCaching()

Returns true when a loader is queried for it's children each time a node is expanded. Only applies when using a loader with the tree store.

Returns:

true if caching

isExpanded

public boolean isExpanded(M model)

Returns true if the model is expanded.

Parameters:

model - the model

Returns:

true if expanded

isExpandOnFilter

public boolean isExpandOnFilter()

Returns the if expand all and collapse all is enabled on filter changes.

Returns:

the expand all collapse all state

isLeaf

public boolean isLeaf(M model)

Returns true if the model is a leaf node. The leaf state allows a tree item to specify if it has children before the children have been realized.

Parameters:

model - the model

Returns:

the leaf state

reconfigure

public void reconfigure(ListStore<M> store,
               ColumnModel<M> cm)

Description copied from class: Grid

Reconfigures the grid to use a different Store and Column Model. The View will be bound to the new objects and refreshed.

Overrides:

reconfigure in class Grid<M>

Parameters:

store - the new store

cm - the new column model

reconfigure

public void reconfigure(TreeStore<M> store,
               ColumnModel<M> cm,
               ColumnConfig<M,?> treeColumn)

refresh

public void refresh(M model)

setAutoExpand

public void setAutoExpand(boolean autoExpand)

If set to true, all non leaf nodes will be expanded automatically (defaults to false).

Parameters:

autoExpand - the auto expand state to set.

setAutoLoad

public void setAutoLoad(boolean autoLoad)

Sets whether all children should automatically be loaded recursively (defaults to false). Useful when the tree must be fully populated when initially rendered.

Parameters:

autoLoad - true to auto load

setCaching

public void setCaching(boolean caching)

Sets whether the children should be cached after first being retrieved from the store (defaults to true). When false, a load request will be made each time a node is expanded.

Parameters:

caching - the caching state

setExpanded

public void setExpanded(M model,
               boolean expand)

Sets the item's expand state.

Parameters:

model - the model

expand - true to expand

setExpanded

public void setExpanded(M model,
               boolean expand,
               boolean deep)

Sets the item's expand state.

Parameters:

model - the model

expand - true to expand

deep - true to expand all children recursively

setExpandOnFilter

public void setExpandOnFilter(boolean expandOnFilter)

Sets whether the tree should expand all and collapse all when filters are applied (defaults to true).

Parameters:

expandOnFilter - true to expand and collapse on filter changes

setIconProvider

public void setIconProvider(IconProvider<M> iconProvider)

Sets the tree's model icon provider which provides the icon style for each model.

Parameters:

iconProvider - the icon provider

setLeaf

public void setLeaf(M model,
           boolean leaf)

Sets the item's leaf state. The leaf state allows control of the expand icon before the children have been realized.

Parameters:

model - the model

leaf - the leaf state

setTreeLoader

public void setTreeLoader(TreeLoader<M> treeLoader)

setView

public void setView(GridView<M> view)

Description copied from class: Grid

Sets the view's grid (pre-render).

Overrides:

setView in class Grid<M>

Parameters:

view - the view

toggle

public void toggle(M model)

Toggles the model's expand state.

Parameters:

model - the model