com.extjs.gxt.ui.client.widget.tree
Class Tree

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.extjs.gxt.ui.client.widget.Component
              com.extjs.gxt.ui.client.widget.BoxComponent
                  com.extjs.gxt.ui.client.widget.Container<TreeItem>
                      com.extjs.gxt.ui.client.widget.tree.Tree

All Implemented Interfaces:

Observable, Selectable<TreeItem>, com.google.gwt.user.client.EventListener

Direct Known Subclasses:

TreeTable

public class Tree
extends Container<TreeItem>
implements Selectable<TreeItem>

A standard hierarchical tree widget. The tree contains a hierarchy of TreeItems that the user can open, close, and select.

The root item cannot be displayed.

Events:

BeforeAdd : TreeEvent(item, child, index)

Fires before a item is added or inserted. Listeners can set the doit field to false to cancel the action.

• item : this
• child : the item being added
• index : the index at which the item will be added

BeforeRemove : TreeEvent(item, child)

Fires before a item is removed. Listeners can set the doit field to false to cancel the action.

• item : this
• child : the item being removed

BeforeExpand : TreeEvent(item)

Fires before a item is expanded. Listeners can set the doit field to false to cancel the expand.

• item : this

BeforeCollapse : TreeEvent(item)

Fires before a item is collapsed. Listeners can set the doit field to false to cancel the collapse.

• item : this

Add : TreeEvent(item, child, index)

Fires after a item has been added or inserted.

• item : this
• child : the item that was added
• index : the index at which the item will be added

Remove : TreeEvent(tree, item, child)

Fires after a item has been removed.

• tree : this
• item : item
• child : the item being removed

SelectionChange : TreeEvent(tree, selected)

Fires after a item has been removed.

• tree : this
• selected : the selected items

Expand : TreeEvent(tree, item)

Fires after a item has been expanded.

• item : this

Collapse : TreeEvent(tree, item)

Fires ater a item is collapsed.

• item : this

CheckChange : TreeEvent(tree, item)

Fires after a check state change.

• item : this

ContextMenu : TreeEvent(tree)

Fires before the tree's context menu is shown.

• component : this

KeyPress : TreeEvent(tree, event)

Fires when a key is pressed.

• event : dom event

CSS:

.my-tree (the tree itself)

.my-tree-item-text span (the tree item text)

Nested Class Summary

static class	Tree.CheckCascade Check cascade enum.
static class	Tree.CheckNodes Check nodes enum.

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

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

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

DEBUG_ID_PREFIX

Constructor Summary

Tree()
Creates a new single select tree.

Method Summary

void	collapseAll() Collapses all item's.
void	expandAll() Expands all item's.
boolean	expandPath(java.lang.String path) Expands a specified path.
TreeItem	findItem(com.google.gwt.user.client.Element element) Returns the tree whose element or child elements match the passed target.
java.util.List<TreeItem>	getAllItems() Returns all tree item's contained by the tree.
boolean	getAnimate() Returns true if animations are enabled.
boolean	getCheckable() Returns true if check boxs are enabled.
java.util.List<TreeItem>	getChecked() Returns a list of id's for all checked items.
Tree.CheckNodes	getCheckNodes() Returns the child nodes value.
Tree.CheckCascade	getCheckStyle() The check style value.
Menu	getContextMenu() Returns the component's context menu.
int	getIndentWidth() Returns the indent width.
TreeItem	getItem(int index) Returns the item at the given index or null if index out of bounds.
TreeItem	getItemById(java.lang.String id) Returns the item by id.
java.lang.String	getItemIconStyle() Returns the item icon style.
java.lang.String	getNodeIconStyle() Returns the node icon style.
java.lang.String	getOpenNodeIconStyle() Returns the open node icon style.
TreeItem	getRootItem() Returns the tree's root item.
TreeItem	getSelectedItem() Returns the selected item.
java.util.List<TreeItem>	getSelectedItems() Returns the selected items.
Style.SelectionMode	getSelectionMode()
TreeSelectionModel	getSelectionModel() Returns the tree's selection model.
void	onComponentEvent(ComponentEvent ce) Any events a component receives will be forwarded to this method.
void	onSelectChange(TreeItem item, boolean select) Called when the visual state of a item is changed.
boolean	removeAll() Removes all the container's items.
void	setAnimate(boolean animate) Sets whether expand /collapse should be animated (defaults to true).
void	setCheckable(boolean checkable) Sets whether checkboxes are used in the tree.
void	setCheckNodes(Tree.CheckNodes checkNodes) Sets which tree items will display a check box (defaults to BOTH).
void	setCheckStyle(Tree.CheckCascade checkStyle) Sets the cascading behavior for check tree (defaults to PARENTS).
void	setContextMenu(Menu menu) Sets the component's context menu.
void	setIndentWidth(int indentWidth) Sets the number of pixels child items are indented.
void	setItemIconStyle(java.lang.String itemImageStyle) Sets the global icon style for leaf tree items.
void	setNodeIconStyle(java.lang.String nodeIconStyle) The global icon style for tree items with children (defaults to 'tree-folder').
void	setOpenNodeIconStyle(java.lang.String openNodeIconStyle) Sets the global icon style for expanded tree items (defaults to 'tree-folder-open').
void	setSelectedItem(TreeItem item) Selects the item.
void	setSelectedItems(java.util.List<TreeItem> items) Selects the items.
void	setSelectionMode(Style.SelectionMode mode) Sets the table's selection mode.
void	setSelectionModel(TreeSelectionModel sm) Sets the tree's selection model.

Methods inherited from class com.extjs.gxt.ui.client.widget.Container

getItemByItemId, getItemCount, getItems, getWidget, indexOf, iterator, scrollIntoView

Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent

getBounds, getHeight, getHeight, getPosition, getShadow, getSize, getWidth, getWidth, isAutoHeight, isAutoWidth, isDeferHeight, isShim, setAutoHeight, setAutoWidth, setBounds, setBounds, setDeferHeight, setHeight, setHeight, setPagePosition, setPagePosition, setPixelSize, setPosition, setShadow, setShim, setSize, setSize, setWidth, setWidth

Methods inherited from class com.extjs.gxt.ui.client.widget.Component

addListener, addStyleName, addWidgetListener, disable, disableEvents, disableTextSelection, el, enable, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, getBaseStyle, getBorders, getData, getData, getElement, getId, getItemId, getModel, getState, getToolTip, hide, hideToolTip, isEnabled, isRendered, isVisible, onBrowserEvent, recalculate, removeAllListeners, removeFromParent, removeListener, removeStyleName, removeWidgetListener, render, render, saveState, setBorders, setData, setData, setElement, setEnabled, setEnableState, setId, setIntStyleAttribute, setItemId, setStyleAttribute, setStyleName, setTitle, setToolTip, setToolTip, setVisible, show, toString

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

getParent, isAttached

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

addStyleDependentName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, setStylePrimaryName, setVisible, sinkEvents, unsinkEvents

Methods inherited from class java.lang.Object

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

Constructor Detail

Tree

public Tree()

Creates a new single select tree.

Method Detail

collapseAll

public void collapseAll()

Collapses all item's.

expandAll

public void expandAll()

Expands all item's.

expandPath

public boolean expandPath(java.lang.String path)

Expands a specified path. A path can be retrieved from a tree item with TreeItem.getPath().

Parameters:

path - the path to expand

Returns:

true if all paths expanded

findItem

public TreeItem findItem(com.google.gwt.user.client.Element element)

Returns the tree whose element or child elements match the passed target.

Overrides:

findItem in class Container<TreeItem>

Parameters:

element - the target element

Returns:

the matching tree item or null if no match

getAllItems

public java.util.List<TreeItem> getAllItems()

Returns all tree item's contained by the tree.

Returns:

all tree item's

getAnimate

public boolean getAnimate()

Returns true if animations are enabled.

Returns:

the animate state

getCheckable

public boolean getCheckable()

Returns true if check boxs are enabled.

Returns:

the checkbox state

getChecked

public java.util.List<TreeItem> getChecked()

Returns a list of id's for all checked items.

Returns:

the list of checked id's

getCheckNodes

public Tree.CheckNodes getCheckNodes()

Returns the child nodes value.

Returns:

the child nodes value

getCheckStyle

public Tree.CheckCascade getCheckStyle()

The check style value.

Returns:

the check style

getContextMenu

public Menu getContextMenu()

Description copied from class: Component

Returns the component's context menu. This method is marked protected, subclasses can change access to public to expose the contenxt menu.

Returns:

the context menu

getIndentWidth

public int getIndentWidth()

Returns the indent width.

Returns:

the indent width

getItem

public TreeItem getItem(int index)

Description copied from class: Container

Returns the item at the given index or null if index out of bounds.

Overrides:

getItem in class Container<TreeItem>

Parameters:

index - the index

Returns:

the item

getItemById

public TreeItem getItemById(java.lang.String id)

Returns the item by id.

Parameters:

id - the id of the element to return

Returns:

the item

getItemIconStyle

public java.lang.String getItemIconStyle()

Returns the item icon style.

Returns:

the icon style

getNodeIconStyle

public java.lang.String getNodeIconStyle()

Returns the node icon style.

Returns:

the icon style

getOpenNodeIconStyle

public java.lang.String getOpenNodeIconStyle()

Returns the open node icon style.

Returns:

the icon style

getRootItem

public TreeItem getRootItem()

Returns the tree's root item. The root item cannot be displayed.

Returns:

the root item

getSelectedItem

public TreeItem getSelectedItem()

Returns the selected item.

Specified by:

getSelectedItem in interface Selectable<TreeItem>

Returns:

the item

getSelectedItems

public java.util.List<TreeItem> getSelectedItems()

Returns the selected items.

Specified by:

getSelectedItems in interface Selectable<TreeItem>

Returns:

the selected items

getSelectionMode

public Style.SelectionMode getSelectionMode()

getSelectionModel

public TreeSelectionModel getSelectionModel()

Returns the tree's selection model.

Returns:

the selection model

onComponentEvent

public void onComponentEvent(ComponentEvent ce)

Description copied from class: Component

Any events a component receives will be forwarded to this method. Subclasses should override as needed. The Component.onBrowserEvent(com.google.gwt.user.client.Event) method should not be overridden or modified.

Overrides:

onComponentEvent in class Component

Parameters:

ce - the base event

onSelectChange

public void onSelectChange(TreeItem item,
                           boolean select)

Description copied from interface: Selectable

Called when the visual state of a item is changed.

Specified by:

onSelectChange in interface Selectable<TreeItem>

Parameters:

item - the item

select - the select state

removeAll

public boolean removeAll()

Description copied from class: Container

Removes all the container's items.

Overrides:

removeAll in class Container<TreeItem>

Returns:

true if all items where removed

setAnimate

public void setAnimate(boolean animate)

Sets whether expand /collapse should be animated (defaults to true).

Parameters:

animate - the animate state

setCheckable

public void setCheckable(boolean checkable)

Sets whether checkboxes are used in the tree.

Parameters:

checkable - true for checkboxes

setCheckNodes

public void setCheckNodes(Tree.CheckNodes checkNodes)

Sets which tree items will display a check box (defaults to BOTH).

Valid values are:

• BOTH - both nodes and leafs
• PARENT - only nodes with children
• LEAF - only leafs

Parameters:

checkNodes - the child nodes value

setCheckStyle

public void setCheckStyle(Tree.CheckCascade checkStyle)

Sets the cascading behavior for check tree (defaults to PARENTS).

Valid values are:

• NONE - no cascading
• PARENTS - cascade to parents
• CHILDREN - cascade to children

Parameters:

checkStyle - the child style

setContextMenu

public void setContextMenu(Menu menu)

Description copied from class: Component

Sets the component's context menu.

Parameters:

menu - the context menu

setIndentWidth

public void setIndentWidth(int indentWidth)

Sets the number of pixels child items are indented. Default value is 18.

Parameters:

indentWidth - the indent width

setItemIconStyle

public void setItemIconStyle(java.lang.String itemImageStyle)

Sets the global icon style for leaf tree items. Individual tree items can override this value by setting the the item's icon style.

Parameters:

itemImageStyle - the image style

setNodeIconStyle

public void setNodeIconStyle(java.lang.String nodeIconStyle)

The global icon style for tree items with children (defaults to 'tree-folder'). Individual tree items can override this value by setting the the item's icon style.

Parameters:

nodeIconStyle - the node icon style

setOpenNodeIconStyle

public void setOpenNodeIconStyle(java.lang.String openNodeIconStyle)

Sets the global icon style for expanded tree items (defaults to 'tree-folder-open'). Individual tree items can override this value by setting the the item's icon style.

Parameters:

openNodeIconStyle - the open node icon style

setSelectedItem

public void setSelectedItem(TreeItem item)

Description copied from interface: Selectable

Selects the item. Any existing selections are cleared.

Specified by:

setSelectedItem in interface Selectable<TreeItem>

Parameters:

item - the item to select

setSelectedItems

public void setSelectedItems(java.util.List<TreeItem> items)

Description copied from interface: Selectable

Selects the items. Only the first item is selected for single-select. Any existing selections are cleared.

Specified by:

setSelectedItems in interface Selectable<TreeItem>

Parameters:

items - the items to select

setSelectionMode

public void setSelectionMode(Style.SelectionMode mode)

Sets the table's selection mode.

Parameters:

mode - the selection mode

setSelectionModel

public void setSelectionModel(TreeSelectionModel sm)

Sets the tree's selection model.

Parameters:

sm - the tree selection model