com.google.gwt.user.cellview.client

Class CellTree

java.lang.Object

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

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

com.google.gwt.user.client.ui.Composite

com.google.gwt.user.cellview.client.AbstractCellTree

com.google.gwt.user.cellview.client.CellTree

All Implemented Interfaces:

HasAttachHandlers, HasCloseHandlers<TreeNode>, HasOpenHandlers<TreeNode>, HasHandlers, HasKeyboardSelectionPolicy, EventListener, Focusable, HasAnimation, HasVisibility, IsRenderable, IsWidget

public class CellTree
extends AbstractCellTree
implements HasAnimation, Focusable

A view of a tree.

This widget will only work in standards mode, which requires that the HTML page in which it is run have an explicit <!DOCTYPE> declaration.

Examples

Trivial example

Complex example

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CellTree.BasicResources Resources that match the GWT standard style theme.
static interface	CellTree.CellTreeMessages Constants for labeling the cell tree.
static class	CellTree.NodeAnimation A node animation.
static interface	CellTree.Resources A ClientBundle that provides images for this widget.
static class	CellTree.RevealAnimation A CellTree.NodeAnimation that reveals the contents of child nodes.
static class	CellTree.SlideAnimation A CellTree.NodeAnimation that slides children into view.
static interface	CellTree.Style Styles used by this widget.

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

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.user.cellview.client.HasKeyboardSelectionPolicy

HasKeyboardSelectionPolicy.KeyboardSelectionPolicy

Field Summary

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
CellTree(TreeViewModel viewModel, T rootValue) Construct a new CellTree.
CellTree(TreeViewModel viewModel, T rootValue, CellTree.Resources resources) Construct a new CellTree.
CellTree(TreeViewModel viewModel, T rootValue, CellTree.Resources resources, CellTree.CellTreeMessages messages) Construct a new CellTree.
CellTree(TreeViewModel viewModel, T rootValue, CellTree.Resources resources, CellTree.CellTreeMessages messages, int defaultNodeSize) Construct a new CellTree.

Method Summary

Methods

Modifier and Type	Method and Description
protected char	getAccessKey() Get the access key.
CellTree.NodeAnimation	getAnimation() Get the animation used to open and close nodes in this tree if animations are enabled.
int	getDefaultNodeSize() Get the default maximum number of children to display under each tree node.
TreeNode	getKeyboardSelectedTreeNode() Returns the TreeNode that is selected when the CellTree has keyboard focus.
TreeNode	getRootTreeNode() Get the root TreeNode.
int	getTabIndex() Gets the widget's position in the tab index.
boolean	isAnimationEnabled() Returns true if animations are enabled, false if not.
protected void	onBlur() Called when the keyboard selected node loses focus.
void	onBrowserEvent(Event event) Fired whenever a browser event is received.
protected void	onFocus() Called when the keyboard selected node gains focus.
void	setAccessKey(char key) Sets the widget's 'access key'.
void	setAnimation(CellTree.NodeAnimation animation) Set the animation used to open and close nodes in this tree.
void	setAnimationEnabled(boolean enable) Enable or disable animations.
void	setDefaultNodeSize(int defaultNodeSize) Set the default number of children to display beneath each child node.
void	setFocus(boolean focused) Explicitly focus/unfocus this widget.
void	setKeyboardSelectedTreeNode(TreeNode parentNode, int childIndex, boolean stealFocus) Sets the node that will be selected when the CellTree gains keyboard focus.
void	setTabIndex(int index) Sets the widget's position in the tab index.

Methods inherited from class com.google.gwt.user.cellview.client.AbstractCellTree

addCloseHandler, addOpenHandler, getKeyboardSelectionPolicy, getNodeInfo, getTreeViewModel, isKeyboardSelectionDisabled, isLeaf, setKeyboardSelectionPolicy

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

claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, onDetach, render, render, resolvePotentialElement, setWidget

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

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

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode

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

fireEvent

Constructor Detail

CellTree

public CellTree(TreeViewModel viewModel,
        T rootValue)

Construct a new CellTree.

Type Parameters:

T - the type of data in the root node

Parameters:

viewModel - the TreeViewModel that backs the tree

rootValue - the hidden root value of the tree

CellTree

public CellTree(TreeViewModel viewModel,
        T rootValue,
        CellTree.Resources resources)

Construct a new CellTree. Uses default translations that means that messages will be always in English.

Type Parameters:

T - the type of data in the root node

Parameters:

viewModel - the TreeViewModel that backs the tree

rootValue - the hidden root value of the tree

resources - the resources used to render the tree

CellTree

public CellTree(TreeViewModel viewModel,
        T rootValue,
        CellTree.Resources resources,
        CellTree.CellTreeMessages messages)

Construct a new CellTree.

Type Parameters:

T - the type of data in the root node

Parameters:

viewModel - the TreeViewModel that backs the tree

rootValue - the hidden root value of the tree

resources - the resources used to render the tree

messages - translation messages. Users should inherit an empty interface from CellTree.CellTreeMessages and add annotations needed for their specific translation systems. Then create the new interface with GWT.create and pass as this argument.

CellTree

public CellTree(TreeViewModel viewModel,
        T rootValue,
        CellTree.Resources resources,
        CellTree.CellTreeMessages messages,
        int defaultNodeSize)

Construct a new CellTree.

Type Parameters:

T - the type of data in the root node

Parameters:

viewModel - the TreeViewModel that backs the tree

rootValue - the hidden root value of the tree

resources - the resources used to render the tree

messages - translation messages. Users should inherit an empty interface from CellTree.CellTreeMessages and add annotations needed for their specific translation systems. Then create the new interface with GWT.create and pass as this argument.

defaultNodeSize - default number of children to display beneath each child node

Method Detail

getAnimation

public CellTree.NodeAnimation getAnimation()

Get the animation used to open and close nodes in this tree if animations are enabled.

Returns:

the animation

See Also:

isAnimationEnabled(), setAnimation(NodeAnimation)

getDefaultNodeSize

public int getDefaultNodeSize()

Get the default maximum number of children to display under each tree node.

Returns:

the default node size

See Also:

setDefaultNodeSize(int)

getRootTreeNode

public TreeNode getRootTreeNode()

Description copied from class: AbstractCellTree

Get the root TreeNode.

Specified by:

getRootTreeNode in class AbstractCellTree

Returns:

the TreeNode at the root of the tree

getTabIndex

public int getTabIndex()

Description copied from interface: Focusable

Gets the widget's position in the tab index.

Specified by:

getTabIndex in interface Focusable

Returns:

the widget's tab index

isAnimationEnabled

public boolean isAnimationEnabled()

Description copied from interface: HasAnimation

Returns true if animations are enabled, false if not.

Specified by:

isAnimationEnabled in interface HasAnimation

onBrowserEvent

public void onBrowserEvent(Event event)

Description copied from interface: EventListener

Fired whenever a browser event is received.

Specified by:

onBrowserEvent in interface EventListener

Overrides:

onBrowserEvent in class Composite

Parameters:

event - the event received

setAccessKey

public void setAccessKey(char key)

Sets the widget's 'access key'. This key is used (in conjunction with a browser-specific modifier key) to automatically focus the widget.

Setting the key to (int) 0 will disable the access key.

Specified by:

setAccessKey in interface Focusable

Parameters:

key - the widget's access key

See Also:

getAccessKey()

setAnimation

public void setAnimation(CellTree.NodeAnimation animation)

Set the animation used to open and close nodes in this tree. You must call setAnimationEnabled(boolean) to enable or disable animation.

Parameters:

animation - a CellTree.NodeAnimation

See Also:

setAnimationEnabled(boolean), getAnimation()

setAnimationEnabled

public void setAnimationEnabled(boolean enable)

Description copied from interface: HasAnimation

Enable or disable animations.

Specified by:

setAnimationEnabled in interface HasAnimation

Parameters:

enable - true to enable, false to disable

setDefaultNodeSize

public void setDefaultNodeSize(int defaultNodeSize)

Set the default number of children to display beneath each child node. If more nodes are available, a button will appear at the end of the list allowing the user to show more items. Changing this value will not affect other tree nodes that are already open (including the hidden root node).

Parameters:

defaultNodeSize - the max

See Also:

getDefaultNodeSize()

setFocus

public void setFocus(boolean focused)

Description copied from interface: Focusable

Explicitly focus/unfocus this widget. Only one widget can have focus at a time, and the widget that does will receive all keyboard events.

Specified by:

setFocus in interface Focusable

Parameters:

focused - whether this widget should take focus or release it

setKeyboardSelectedTreeNode

public void setKeyboardSelectedTreeNode(TreeNode parentNode,
                               int childIndex,
                               boolean stealFocus)

Sets the node that will be selected when the CellTree gains keyboard focus.

Parameters:

parentNode - a node in the tree that is currently open

childIndex - the index of the child to select

stealFocus - if true, also change keyboard focus to this CellTree.

setTabIndex

public void setTabIndex(int index)

Description copied from interface: Focusable

Sets the widget's position in the tab index. If more than one widget has the same tab index, each such widget will receive focus in an arbitrary order. Setting the tab index to -1 will cause this widget to be removed from the tab order.

Specified by:

setTabIndex in interface Focusable

Parameters:

index - the widget's tab index

getAccessKey

protected char getAccessKey()

Get the access key.

Returns:

the access key, or -1 if not set

See Also:

setAccessKey(char)

onBlur

protected void onBlur()

Called when the keyboard selected node loses focus.

onFocus

protected void onFocus()

Called when the keyboard selected node gains focus.

getKeyboardSelectedTreeNode

public TreeNode getKeyboardSelectedTreeNode()

Returns the TreeNode that is selected when the CellTree has keyboard focus.