public class

CellTree

extends AbstractCellTree
implements Focusable HasAnimation

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

Class Overview

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: {@example com.google.gwt.examples.cellview.CellTreeExample}
Complex example: {@example com.google.gwt.examples.cellview.CellTreeExample2}

Summary

Nested Classes
interface	CellTree.BasicResources	Resources that match the GWT standard style theme.
class	CellTree.NodeAnimation	A node animation.
interface	CellTree.Resources	A ClientBundle that provides images for this widget.
class	CellTree.RevealAnimation	A `CellTree.NodeAnimation` that reveals the contents of child nodes.
class	CellTree.SlideAnimation	A `CellTree.NodeAnimation` that slides children into view.
interface	CellTree.Style	Styles used by this widget.

[Expand]

Inherited Constants

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

Public Constructors
<T>	CellTree(TreeViewModel viewModel, T rootValue) Construct a new `CellTree`.
<T>	CellTree(TreeViewModel viewModel, T rootValue, CellTree.Resources resources) Construct a new `CellTree`.

Public Methods
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	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.
void	onBrowserEvent(Event event) Fired whenever a browser event is received.
void	setAccessKey(char key) Sets the widget's 'access key'. Setting the key to (int) 0 will disable the 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	setTabIndex(int index) Sets the widget's position in the tab index.

Protected Methods
char	getAccessKey() Get the access key.
void	onBlur() Called when the keyboard selected node loses focus.
void	onFocus() Called when the keyboard selected node gains focus.

[Expand]

Inherited Methods

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

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

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

HandlerRegistration	addAttachHandler(AttachEvent.Handler handler) Adds an `AttachEvent` handler.
final <H extends EventHandler> HandlerRegistration	addDomHandler(H handler, Type<H> type) Adds a native event handler to the widget and sinks the corresponding native event.
final <H extends EventHandler> HandlerRegistration	addHandler(H handler, Type<H> type) Adds this handler to the widget.
Widget	asWidget() Returns the `Widget` aspect of the receiver.
static Widget	asWidgetOrNull(IsWidget w) This convenience method makes a null-safe call to `asWidget()`.
HandlerManager	createHandlerManager() Creates the `HandlerManager` used by this Widget.
void	delegateEvent(Widget target, GwtEvent<?> event) Fires an event on a child widget.
void	doAttachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onAttach()` for each of its child widgets.
void	doDetachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onDetach()` for each of its child widgets.
void	fireEvent(GwtEvent<?> event) Fires the given event to the handlers listening to the event's type.
int	getHandlerCount(Type<?> type) Gets the number of handlers listening to the event type.
Object	getLayoutData() Gets the panel-defined layout data associated with this widget.
Widget	getParent() Gets this widget's parent panel.
boolean	isAttached() Determines whether this widget is currently attached to the browser's document (i.e., there is an unbroken chain of widgets between this widget and the underlying browser document).
final boolean	isOrWasAttached() Has this widget ever been attached?
void	onAttach() This method is called when a widget is attached to the browser's document.
void	onBrowserEvent(Event event) Fired whenever a browser event is received.
void	onDetach() This method is called when a widget is detached from the browser's document.
void	onLoad() This method is called immediately after a widget becomes attached to the browser's document.
void	onUnload() This method is called immediately before a widget will be detached from the browser's document.
void	removeFromParent() Removes this widget from its parent widget, if one exists.
void	setLayoutData(Object layoutData) Sets the panel-defined layout data associated with this widget.
void	sinkEvents(int eventBitsToAdd) Overridden to defer the call to super.sinkEvents until the first time this widget is attached to the dom, as a performance enhancement.

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

void	addStyleDependentName(String styleSuffix) Adds a dependent style name by specifying the style name's suffix.
void	addStyleName(String style) Adds a secondary or dependent style name to this object.
static void	ensureDebugId(Element elem, String baseID, String id) Set the debug id of a specific element.
final void	ensureDebugId(String id) Ensure that the main `Element` for this `UIObject` has an ID property set, which allows it to integrate with third-party libraries and test tools.
static void	ensureDebugId(Element elem, String id) Ensure that elem has an ID property set, which allows it to integrate with third-party libraries and test tools.
int	getAbsoluteLeft() Gets the object's absolute left position in pixels, as measured from the browser window's client area.
int	getAbsoluteTop() Gets the object's absolute top position in pixels, as measured from the browser window's client area.
Element	getElement() Gets a handle to the object's underlying DOM element.
int	getOffsetHeight() Gets the object's offset height in pixels.
int	getOffsetWidth() Gets the object's offset width in pixels.
Element	getStyleElement() Template method that returns the element to which style names will be applied.
String	getStyleName() Gets all of the object's style names, as a space-separated list.
static String	getStyleName(Element elem) Gets all of the element's style names, as a space-separated list.
String	getStylePrimaryName() Gets the primary style name associated with the object.
static String	getStylePrimaryName(Element elem) Gets the element's primary style name.
String	getTitle() Gets the title associated with this object.
boolean	isVisible() Determines whether or not this object is visible.
static boolean	isVisible(Element elem)
void	onEnsureDebugId(String baseID) Called when the user sets the id using the `ensureDebugId(String)` method.
void	removeStyleDependentName(String styleSuffix) Removes a dependent style name by specifying the style name's suffix.
void	removeStyleName(String style) Removes a style name.
final void	setElement(Element elem) Sets this object's browser element.
void	setElement(Element elem) Sets this object's browser element.
void	setHeight(String height) Sets the object's height.
void	setPixelSize(int width, int height) Sets the object's size, in pixels, not including decorations such as border, margin, and padding.
void	setSize(String width, String height) Sets the object's size.
void	setStyleDependentName(String styleSuffix, boolean add) Adds or removes a dependent style name by specifying the style name's suffix.
static void	setStyleName(Element elem, String styleName) Clears all of the element's style names and sets it to the given style.
static void	setStyleName(Element elem, String style, boolean add) This convenience method adds or removes a style name for a given element.
void	setStyleName(String style) Clears all of the object's style names and sets it to the given style.
void	setStyleName(String style, boolean add) Adds or removes a style name.
void	setStylePrimaryName(String style) Sets the object's primary style name and updates all dependent style names.
static void	setStylePrimaryName(Element elem, String style) Sets the element's primary style name and updates all dependent style names.
void	setTitle(String title) Sets the title associated with this object.
void	setVisible(boolean visible) Sets whether this object is visible.
static void	setVisible(Element elem, boolean visible)
void	setWidth(String width) Sets the object's width.
void	sinkEvents(int eventBitsToAdd) Adds a set of events to be sunk by this object.
String	toString() This method is overridden so that any object can be viewed in the debugger as an HTML snippet.
void	unsinkEvents(int eventBitsToRemove) Removes a set of events from this object's event list.

From class java.lang.Object

From interface com.google.gwt.event.logical.shared.HasAttachHandlers

From interface com.google.gwt.event.logical.shared.HasCloseHandlers

From interface com.google.gwt.event.logical.shared.HasOpenHandlers

From interface com.google.gwt.event.shared.HasHandlers

From interface com.google.gwt.user.cellview.client.HasKeyboardSelectionPolicy

From interface com.google.gwt.user.client.EventListener

From interface com.google.gwt.user.client.ui.Focusable

From interface com.google.gwt.user.client.ui.HasAnimation

From interface com.google.gwt.user.client.ui.IsWidget

Public Constructors

public CellTree (TreeViewModel viewModel, T rootValue)

Construct a new CellTree.

Parameters

viewModel	the `TreeViewModel` that backs the tree
rootValue	the hidden root value of the tree

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

Construct a new CellTree.

Parameters

viewModel	the `TreeViewModel` that backs the tree
rootValue	the hidden root value of the tree
resources	the resources used to render the tree

Public Methods

public CellTree.NodeAnimation getAnimation ()

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

Returns

the animation

public int getDefaultNodeSize ()

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

Returns

the default node size

public TreeNode getRootTreeNode ()

Get the root TreeNode.

Returns

the TreeNode at the root of the tree

public int getTabIndex ()

Gets the widget's position in the tab index.

Returns

the widget's tab index

public boolean isAnimationEnabled ()

Returns true if animations are enabled, false if not.

public void onBrowserEvent (Event event)

Fired whenever a browser event is received.

Parameters

event	the event received

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.

Parameters

key	the widget's access key

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`

public void setAnimationEnabled (boolean enable)

Enable or disable animations.

Parameters

enable	true to enable, false to disable

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 tree nodes that are already open.

Parameters

defaultNodeSize	the max

public void setFocus (boolean focused)

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

Parameters

focused	whether this widget should take focus or release it

public void setTabIndex (int index)

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.

Parameters

index	the widget's tab index

Protected Methods

protected char getAccessKey ()

Get the access key.

Returns

the access key, or -1 if not set

protected void onBlur ()

Called when the keyboard selected node loses focus.

protected void onFocus ()

Called when the keyboard selected node gains focus.

Interfaces

Classes

Enums

CellTree

Class Overview

Examples

Summary

Public Constructors

public CellTree (TreeViewModel viewModel, T rootValue)

Parameters

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

Parameters

Public Methods

public CellTree.NodeAnimation getAnimation ()

Returns

See Also

public int getDefaultNodeSize ()

Returns

See Also

public TreeNode getRootTreeNode ()

Returns

public int getTabIndex ()

Returns

public boolean isAnimationEnabled ()

public void onBrowserEvent (Event event)

Parameters

public void setAccessKey (char key)

Parameters

See Also

public void setAnimation (CellTree.NodeAnimation animation)

Parameters

See Also

public void setAnimationEnabled (boolean enable)

Parameters

public void setDefaultNodeSize (int defaultNodeSize)

Parameters

See Also

public void setFocus (boolean focused)

Parameters

public void setTabIndex (int index)

Parameters

Protected Methods

protected char getAccessKey ()

Returns

See Also

protected void onBlur ()

protected void onFocus ()