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

Class TreeGridView<M>

java.lang.Object

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

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

public class TreeGridView<M>
extends GridView<M>

A GridView subclass that adds tree related view features.

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor and Description
TreeGridView() Creates a new view instance.
TreeGridView(GridView.GridAppearance appearance) Creates a new view instance with the given grid appearance.

Method Summary

Methods

Modifier and Type	Method and Description
void	collapse(Tree.TreeNode<M> node) Collapses the given node.
void	expand(Tree.TreeNode<M> node) Expands the given node.
XElement	getElement(Tree.TreeNode<M> node) Gets the rendered element, if any, for the given tree node object.
XElement	getElementContainer(Tree.TreeNode<M> node) Returns the element which wraps the children of the given node.
Element	getIconElement(Tree.TreeNode<M> node) Returns the element in which the nodes icon is rendered.
Element	getJointElement(Tree.TreeNode<M> node) Returns the element in which the nodes joint (expand / collapse) icon is rendered.
Store.StoreSortInfo<M>	getSortState() Returns the grid's sort information.
SafeHtml	getTemplate(M m, String id, SafeHtml text, ImageResource icon, boolean checkable, Tree.Joint joint, int level) Returns the markup that is used to render a node.
Element	getTextElement(Tree.TreeNode<M> node) Returns the element in which the node's text is rendered.
boolean	isSelectableTarget(Element target) Returns true if the given element is selectable.
void	onDropChange(Element e, boolean drop)
void	onIconStyleChange(Tree.TreeNode<M> node, ImageResource icon)
void	onJointChange(Tree.TreeNode<M> node, Tree.Joint joint)
void	onLoading(Tree.TreeNode<M> node)
void	refresh(boolean headerToo) Rebuilds the grid using its current configuration and data.

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

addHandler, ensureVisible, ensureVisible, findCell, findCellIndex, findRow, findRowIndex, fireEvent, focus, focusCell, focusRow, getAppearance, getAutoExpandColumn, getAutoExpandMax, getAutoExpandMin, getBody, getCell, getEditorParent, getEmptyText, getHeader, getRow, getRow, getRowBody, getRowBodyRowSpan, getScroller, getScrollState, getStateStyles, getViewConfig, isAdjustForHScroll, isAutoFill, isColumnLines, isDeferUpdates, isEnableRowBody, isForceFit, isShowDirtyCells, isSortingEnabled, isStripeRows, isTrackMouseOver, layout, scrollToTop, scrollToTop, setAdjustForHScroll, setAutoExpandColumn, setAutoExpandMax, setAutoExpandMin, setAutoFill, setColumnHeader, setColumnLines, setDeferUpdates, setEmptyText, setEnableRowBody, setForceFit, setRowBodyRowSpan, setShowDirtyCells, setSortingEnabled, setStripeRows, setTrackMouseOver, setViewConfig

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeGridView

public TreeGridView()

Creates a new view instance.

TreeGridView

public TreeGridView(GridView.GridAppearance appearance)

Creates a new view instance with the given grid appearance.

Parameters:

appearance - the grid appearance

Method Detail

collapse

public void collapse(Tree.TreeNode<M> node)

Collapses the given node.

Parameters:

node - the node to be collapsed

expand

public void expand(Tree.TreeNode<M> node)

Expands the given node.

Parameters:

node - the node to be expanded

getElement

public XElement getElement(Tree.TreeNode<M> node)

Gets the rendered element, if any, for the given tree node object. This method will look up the dom element if it has not yet been seen. The getElement() method for the node will return the same value as this method does after it has been cached.

Parameters:

node - the tree node to find an element for

Returns:

the element that the node represents, or null if not yet rendered

getElementContainer

public XElement getElementContainer(Tree.TreeNode<M> node)

Returns the element which wraps the children of the given node. This is the element that is displayed / hidden when a node is expanded / collapsed.

Parameters:

node - the target node

Returns:

the element

getIconElement

public Element getIconElement(Tree.TreeNode<M> node)

Returns the element in which the nodes icon is rendered.

Parameters:

node - the target node

Returns:

the icon elmeent

getJointElement

public Element getJointElement(Tree.TreeNode<M> node)

Returns the element in which the nodes joint (expand / collapse) icon is rendered.

Parameters:

node - the target node

Returns:

the joint element

getTemplate

public SafeHtml getTemplate(M m,
                   String id,
                   SafeHtml text,
                   ImageResource icon,
                   boolean checkable,
                   Tree.Joint joint,
                   int level)

Returns the markup that is used to render a node.

Parameters:

m - the model

id - the id of the node (store model key provider)

text - the node text

icon - the node icon or null

checkable - true if the node is checked

joint - the joint state

level - the tree depth

Returns:

the markup as safe html

getTextElement

public Element getTextElement(Tree.TreeNode<M> node)

Returns the element in which the node's text is rendered.

Parameters:

node - the target node

Returns:

the text element

isSelectableTarget

public boolean isSelectableTarget(Element target)

Description copied from class: GridView

Returns true if the given element is selectable.

Overrides:

isSelectableTarget in class GridView<M>

Parameters:

target - the element to check

Returns:

true if the given element is selectable

onDropChange

public void onDropChange(Element e,
                boolean drop)

onIconStyleChange

public void onIconStyleChange(Tree.TreeNode<M> node,
                     ImageResource icon)

onJointChange

public void onJointChange(Tree.TreeNode<M> node,
                 Tree.Joint joint)

onLoading

public void onLoading(Tree.TreeNode<M> node)

refresh

public void refresh(boolean headerToo)

Description copied from class: GridView

Rebuilds the grid using its current configuration and data.

Overrides:

refresh in class GridView<M>

Parameters:

headerToo - true to refresh the header

getSortState

public Store.StoreSortInfo<M> getSortState()

Description copied from class: GridView

Returns the grid's sort information.

Overrides:

getSortState in class GridView<M>

Returns:

the grid's sort information (or null if the grid is not sorted).