Tree (GXT 4.0.0)

java.lang.Object
- Widget
- - com.sencha.gxt.widget.core.client.Component
  - - com.sencha.gxt.widget.core.client.tree.Tree<M,C>

Type Parameters:

M - the model type

C - the cell data type

All Implemented Interfaces:

HasGestureRecognizers, CheckProvider<M>, BeforeCheckChangeEvent.HasBeforeCheckChangeHandlers<M>, BeforeCollapseItemEvent.HasBeforeCollapseItemHandlers<M>, BeforeExpandItemEvent.HasBeforeExpandItemHandlers<M>, BeforeHideEvent.HasBeforeHideHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, CheckChangedEvent.HasCheckChangedHandlers<M>, CheckChangeEvent.HasCheckChangeHandlers<M>, CollapseItemEvent.HasCollapseItemHandlers<M>, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, ExpandItemEvent.HasExpandItemHandlers<M>, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, MoveEvent.HasMoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, HasFocusSupport, HasItemId
```
public class Tree<M,C>
extends Component
implements BeforeExpandItemEvent.HasBeforeExpandItemHandlers<M>, ExpandItemEvent.HasExpandItemHandlers<M>, BeforeCollapseItemEvent.HasBeforeCollapseItemHandlers<M>, CollapseItemEvent.HasCollapseItemHandlers<M>, BeforeCheckChangeEvent.HasBeforeCheckChangeHandlers<M>, CheckChangeEvent.HasCheckChangeHandlers<M>, CheckProvider<M>
```
A Tree provides support for displaying hierarchical data. The tree gets its data from a TreeStore. Each model in the store is rendered as an item in the tree. Any updates to the store are automatically pushed to the tree.
In GXT version 3, ModelKeyProviders and ValueProviders provide the interface between your data model, the tree store and the tree. This enables a tree to work with data of any object type. The tree uses a value provider, passed to the constructor, to get the value to display for each model in the tree.
You can provide your own implementation of these interfaces, or you can use a Sencha supplied generator to create them for you automatically. A generator runs at compile time to create a Java class that is compiled to JavaScript. The Sencha supplied generator can create classes for interfaces that extend the PropertyAccess interface. The generator transparently creates the class at compile time and the GWT#create(Class) method returns an instance of that class at run time. The generated class is managed by GWT and GXT and you generally do not need to worry about what the class is called, where it is located, or other similar details.
To customize the appearance of the item in the tree, provide a cell implementation using Tree#setCell(Cell).
The following code snippet illustrates the creation of a simple tree with local data for test purposes. For more practical examples that show how to load data from remote sources, see the Async Tree and Async Json Tree examples in the online Explorer demo.
```
 
    // Generate the key provider and value provider for the Data class
    DataProperties dp = GWT.create(DataProperties.class);

    // Create the store that the contains the data to display in the tree
    TreeStore<Data> s = new TreeStore<Test.Data>(dp.key());
    
    Data r1 = new Data("Parent 1", "value1");
    s.add(r1);
    s.add(r1, new Data("Child 1.1", "value2"));
    s.add(r1, new Data("Child 1.2", "value3"));

    Data r2 = new Data("Parent 2", "value4");
    s.add(r2);
    s.add(r2, new Data("Child 2.1", "value5"));
    s.add(r2, new Data("Child 2.2", "value6"));

    // Create the tree using the store and value provider for the name field
    Tree<Data, String> t = new Tree<Data, String>(s, dp.name());

    // Add the tree to a container
    RootPanel.get().add(t);
 
```
To use the Sencha supplied generator to create model key providers and value providers, extend the PropertyAccess interface, parameterized with the type of data you want to access (as shown below) and invoke the GWT.create method on its class member (as shown in the code snippet above). This creates an instance of the class that can be used to initialize the tree and tree store. In the following code snippet we define a new interface called DataProperties that extends the PropertyAccess interface and is parameterized with Data, a Plain Old Java Object (POJO).
```
  public interface DataProperties extends PropertyAccess {
    @Path("name")
    ModelKeyProvider key();
    ValueProvider<Data, String> name();
    ValueProvider<Data, String> value();
  }

  public class Data {
    private String name;
    private String value;

    public Data(String name, String value) {
      super();
      this.name = name;
      this.value = value;
    }
    public String getName() {
      return name;
    }
    public String getValue() {
      return value;
    }
    public void setName(String name) {
      this.name = name;
    }
    public void setValue(String value) {
      this.value = value;
    }
  }
 
```
To enable check box support for a tree, add the following:
```
    t.setCheckable(true);
    t.setCheckStyle(CheckCascade.CHILDREN);
 
```
See Tree.CheckCascade for additional check box styles.
To save and restore the expand / collapse state of tree items, add the following (must be after the tree is added to the container). This works with both local and asynchronous loading of tree items.
```
    t.setStateId("TreeCodeSnippetTest");
    StateManager.get().setProvider(new CookieProvider("/", null, null, GXT.isSecure()));
    TreeStateHandler sh = new TreeStateHandler(t);
    sh.loadState();
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Tree.CheckCascade` Check cascade enum.
`static class`	`Tree.CheckNodes` Check nodes enum.
`static class`	`Tree.CheckState`
`static class`	`Tree.Joint` Joint enum.
`static interface`	`Tree.TreeAppearance`
`static class`	`Tree.TreeNode<M>` Maintains the internal state of nodes contained in the tree.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`filtering`
`protected boolean`	`focusConstrainScheduled`
`protected XElement`	`focusEl`
`protected FocusImpl`	`focusImpl`
`protected TreeLoader<M>`	`loader`
`protected Map<String,Tree.TreeNode<M>>`	`nodes`
`protected Map<String,Tree.TreeNode<M>>`	`nodesByDom`
`protected Element`	`rootContainer`
`protected TreeSelectionModel<M>`	`sm`
`protected TreeStore<M>`	`store`
`protected ValueProvider<? super M,C>`	`valueProvider`
`protected TreeView<M>`	`view`

Fields inherited from class com.sencha.gxt.widget.core.client.Component
adjustSize, allowTextSelection, cacheSizes, disableContextMenu, disabled, disabledStyle, ensureVisibilityOnSizing, height, hidden, lastSize, layer, left, mask, maskMessage, monitorWindowResize, pageX, pageY, resizeHandler, shim, tabIndex, toolTip, toolTipConfig, top, width, windowResizeDelay, windowResizeTask

Constructor Summary

Constructors
Constructor and Description
`Tree(TreeStore<M> store, ValueProvider<? super M,C> valueProvider)` Creates a new tree panel.
`Tree(TreeStore<M> store, ValueProvider<? super M,C> valueProvider, Tree.TreeAppearance appearance)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HandlerRegistration`	`addBeforeCheckChangeHandler(BeforeCheckChangeEvent.BeforeCheckChangeHandler<M> handler)` Adds a `BeforeCheckChangeEvent.BeforeCheckChangeHandler` handler for `BeforeCheckChangeEvent` events.
`HandlerRegistration`	`addBeforeCollapseHandler(BeforeCollapseItemEvent.BeforeCollapseItemHandler<M> handler)` Adds a `BeforeCollapseItemEvent.BeforeCollapseItemHandler` handler for `BeforeCollapseItemEvent` events.
`HandlerRegistration`	`addBeforeExpandHandler(BeforeExpandItemEvent.BeforeExpandItemHandler<M> handler)` Adds a `BeforeExpandItemEvent.BeforeExpandItemHandler` handler for `BeforeExpandItemEvent` events.
`HandlerRegistration`	`addCheckChangedHandler(CheckChangedEvent.CheckChangedHandler<M> handler)` Adds a `CheckChangedEvent.CheckChangedHandler` handler for `CheckChangedEvent` events.
`HandlerRegistration`	`addCheckChangeHandler(CheckChangeEvent.CheckChangeHandler<M> handler)` Adds a `CheckChangeEvent.CheckChangeHandler` handler for `CheckChangeEvent` events.
`HandlerRegistration`	`addCollapseHandler(CollapseItemEvent.CollapseItemHandler<M> handler)` Adds a `CollapseItemEvent.CollapseItemHandler` handler for `CollapseItemEvent` events.
`HandlerRegistration`	`addExpandHandler(ExpandItemEvent.ExpandItemHandler<M> handler)` Adds a `ExpandItemEvent.ExpandItemHandler` handler for `ExpandItemEvent` events.
`protected ImageResource`	`calculateIconStyle(M model)`
`protected Tree.Joint`	`calculateJoint(M model)`
`protected boolean`	`cellConsumesEventType(<any> cell, String eventType)`
`protected void`	`clean()`
`protected void`	`cleanCollapsed(M parent)`
`protected void`	`cleanNode(Tree.TreeNode<M> node)`
`protected void`	`clear()`
`void`	`collapseAll()` Collapses all nodes.
`protected void`	`constrainFocusElement()`
`protected void`	`doClean()`
`protected void`	`doUpdate()`
`void`	`expandAll()` Expands all nodes.
`protected void`	`findChildren(M parent, List<M> list, boolean onlyVisible)`
`Tree.TreeNode<M>`	`findNode(Element target)` Returns the tree node for the given target.
`protected void`	`fireEventToCell(Event event, String eventType, Element cellParent, M m, Context context)`
`void`	`focus()` Try to focus this widget.
`protected String`	`generateModelId(M m)`
`Tree.TreeAppearance`	`getAppearance()` Returns the tree appearance.
`<any>`	`getCell()` Return the tree's cell.
`protected SafeHtml`	`getCellContent(M model)`
`Tree.CheckState`	`getChecked(M model)` Returns the models checked state.
`List<M>`	`getCheckedSelection()` Returns the current checked selection.
`Tree.CheckNodes`	`getCheckNodes()` Returns the child nodes value which determines what node types have a check box.
`Tree.CheckCascade`	`getCheckStyle()` The check cascade style value which determines if check box changes cascade to parent and children.
`protected List<M>`	`getChildModel(List<M> l, boolean onlyVisible)`
`protected Element`	`getContainer(M model)`
`IconProvider<M>`	`getIconProvider()` Returns the model icon provider.
`protected Element`	`getRootContainer()`
`TreeSelectionModel<M>`	`getSelectionModel()` Returns the tree's selection model.
`TreeStore<M>`	`getStore()` Returns the tree's store.
`TreeStyle`	`getStyle()` Returns the tree style.
`protected C`	`getValue(M m)`
`TreeView<M>`	`getView()` Returns the tree's view.
`protected int`	`getVisibleRowCount()`
`protected int[]`	`getVisibleRows(List<M> visible, int count)`
`protected void`	`handleEventForCell(Event event)`
`protected boolean`	`hasChildren(M model)`
`boolean`	`isAutoExpand()` Returns `true` if auto expand is enabled.
`boolean`	`isAutoLoad()` Returns `true` if auto load is enabled.
`boolean`	`isAutoSelect()` Returns `true` if select on load is enabled.
`boolean`	`isBufferedRender()` Returns `true` if buffered rendering is enabled.
`boolean`	`isCaching()` Returns `true` when a loader is queried for it's children each time a node is expanded.
`boolean`	`isCheckable()` Returns `true` if check boxes are enabled.
`protected boolean`	`isCheckable(Tree.TreeNode<M> node)`
`boolean`	`isChecked(M model)` Returns true if the model is checked.
`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.
`protected boolean`	`isRowRendered(int i, List<M> visible)`
`boolean`	`isTrackMouseOver()` Returns `true` if nodes are highlighted on mouse over.
`protected void`	`moveFocus(Element selectedElem)`
`protected void`	`notifyShow()`
`protected void`	`onAdd(StoreAddEvent<M> event)`
`protected void`	`onAfterFirstAttach()` Called immediately after the first time the widget becomes attached to the browser's document only the first time.
`protected void`	`onAttach()`
`void`	`onBrowserEvent(Event event)`
`protected void`	`onCheckCascade(M model, Tree.CheckState checked)`
`protected void`	`onCheckClick(Event event, Tree.TreeNode<M> node)`
`protected void`	`onClear(StoreClearEvent<M> event)`
`protected void`	`onClick(Event event)`
`protected void`	`onCollapse(M model, Tree.TreeNode<M> node, boolean deep)`
`protected void`	`onDataChanged(StoreDataChangeEvent<M> event)`
`protected void`	`onDoubleClick(Event event)`
`protected void`	`onExpand(M model, Tree.TreeNode<M> node, boolean deep)`
`protected void`	`onFilter(StoreFilterEvent<M> se)`
`protected void`	`onRemove(StoreRemoveEvent<M> se)`
`protected void`	`onResize(int width, int height)` Called after the widget is resized, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a resize occurs.
`protected void`	`onScroll(Event event)`
`protected void`	`onSort(StoreSortEvent<M> se)`
`protected void`	`onTriCheckCascade(M model, Tree.CheckState checked)`
`protected void`	`onUpdate(StoreUpdateEvent<M> event)`
`protected void`	`redraw(M parent)` Completely redraws the children of the given parent (or all items if parent is null), throwing away details like currently expanded nodes, etc.
`void`	`refresh(M model)`
`protected String`	`register(M m)`
`protected SafeHtml`	`renderChild(M parent, M child, int depth, TreeView.TreeViewRenderMode renderMode)`
`protected void`	`renderChildren(M parent)`
`void`	`scrollIntoView(M model)` Scrolls the tree to ensure the given model is visible.
`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`	`setAutoSelect(boolean autoSelect)` True to select the first model after the store's data changes (defaults to `false`).
`void`	`setBufferedRender(boolean bufferRender)` True to only render tree nodes that are in view (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`	`setCell(<any> cell)` Sets the tree's cell.
`void`	`setCheckable(boolean checkable)` Sets whether check boxes are used in the tree (defaults to `false`).
`void`	`setChecked(M item, Tree.CheckState checked)` Sets the check state of the item.
`void`	`setCheckedSelection(List<M> selection)` Sets the current checked selection.
`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`	`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`	`setLoader(TreeLoader<M> loader)` Sets the tree loader.
`void`	`setSelectionModel(TreeSelectionModel<M> sm)` Sets the tree's selection model.
`void`	`setStore(TreeStore<M> store)` Assigns a new store to the tree.
`void`	`setStyle(TreeStyle style)` Sets the tree style.
`void`	`setTrackMouseOver(boolean trackMouseOver)` True to highlight nodes when the mouse is over (defaults to `true`).
`void`	`setView(TreeView<M> view)` Sets the tree's view.
`void`	`toggle(M model)` Toggles the model's expand state.
`protected void`	`unregister(M m)`
`protected void`	`update()`

Methods inherited from class com.sencha.gxt.widget.core.client.Component
addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addGestureRecognizer, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleDependentName, addStyleOnOver, adjustPosition, adjustSize, applyState, assertAfterRender, assertPreRender, blur, clearSizeCache, disable, disableContextMenu, disableEvents, enable, enableEvents, fireCancellableEvent, fireEvent, getData, getElement, getFocusEl, getFocusSupport, getGestureRecognizer, getGestureRecognizerCount, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getPositionEl, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideShadow, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, notifyHide, onBlur, onDetach, onDisable, onEnable, onFocus, onHide, onHideContextMenu, onLoad, onPosition, onRightClick, onShow, onShowContextMenu, onTouch, onUnload, onWindowResize, removeStyleDependentName, removeStyleOnOver, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setMonitorWindowResize, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setStyleDependentName, setTabIndex, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - filtering
```
protected boolean filtering
```
  - focusEl
```
protected XElement focusEl
```
  - focusImpl
```
protected final FocusImpl focusImpl
```
  - focusConstrainScheduled
```
protected boolean focusConstrainScheduled
```
  - loader
```
protected TreeLoader<M> loader
```
  - nodes
```
protected Map<String,Tree.TreeNode<M>> nodes
```
  - nodesByDom
```
protected Map<String,Tree.TreeNode<M>> nodesByDom
```
  - sm
```
protected TreeSelectionModel<M> sm
```
  - store
```
protected TreeStore<M> store
```
  - valueProvider
```
protected final ValueProvider<? super M,C> valueProvider
```
  - view
```
protected TreeView<M> view
```
  - rootContainer
```
protected Element rootContainer
```
- Constructor Detail
  - Tree
```
public Tree(TreeStore<M> store,
            ValueProvider<? super M,C> valueProvider)
```
    Creates a new tree panel.
    
    Parameters:
    
    store - the tree store
  - Tree
```
public Tree(TreeStore<M> store,
            ValueProvider<? super M,C> valueProvider,
            Tree.TreeAppearance appearance)
```
- Method Detail
  - addBeforeCheckChangeHandler
```
public HandlerRegistration addBeforeCheckChangeHandler(BeforeCheckChangeEvent.BeforeCheckChangeHandler<M> handler)
```
    Description copied from interface: BeforeCheckChangeEvent.HasBeforeCheckChangeHandlers
    
    Adds a BeforeCheckChangeEvent.BeforeCheckChangeHandler handler for BeforeCheckChangeEvent events.
    
    Specified by:
    
    addBeforeCheckChangeHandler in interface BeforeCheckChangeEvent.HasBeforeCheckChangeHandlers<M>
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addBeforeCollapseHandler
```
public HandlerRegistration addBeforeCollapseHandler(BeforeCollapseItemEvent.BeforeCollapseItemHandler<M> handler)
```
    Description copied from interface: BeforeCollapseItemEvent.HasBeforeCollapseItemHandlers
    
    Adds a BeforeCollapseItemEvent.BeforeCollapseItemHandler handler for BeforeCollapseItemEvent events.
    
    Specified by:
    
    addBeforeCollapseHandler in interface BeforeCollapseItemEvent.HasBeforeCollapseItemHandlers<M>
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addBeforeExpandHandler
```
public HandlerRegistration addBeforeExpandHandler(BeforeExpandItemEvent.BeforeExpandItemHandler<M> handler)
```
    Description copied from interface: BeforeExpandItemEvent.HasBeforeExpandItemHandlers
    
    Adds a BeforeExpandItemEvent.BeforeExpandItemHandler handler for BeforeExpandItemEvent events.
    
    Specified by:
    
    addBeforeExpandHandler in interface BeforeExpandItemEvent.HasBeforeExpandItemHandlers<M>
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addCheckChangedHandler
```
public HandlerRegistration addCheckChangedHandler(CheckChangedEvent.CheckChangedHandler<M> handler)
```
    Description copied from interface: CheckChangedEvent.HasCheckChangedHandlers
    
    Adds a CheckChangedEvent.CheckChangedHandler handler for CheckChangedEvent events.
    
    Specified by:
    
    addCheckChangedHandler in interface CheckChangedEvent.HasCheckChangedHandlers<M>
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addCheckChangeHandler
```
public HandlerRegistration addCheckChangeHandler(CheckChangeEvent.CheckChangeHandler<M> handler)
```
    Description copied from interface: CheckChangeEvent.HasCheckChangeHandlers
    
    Adds a CheckChangeEvent.CheckChangeHandler handler for CheckChangeEvent events.
    
    Specified by:
    
    addCheckChangeHandler in interface CheckChangeEvent.HasCheckChangeHandlers<M>
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addCollapseHandler
```
public HandlerRegistration addCollapseHandler(CollapseItemEvent.CollapseItemHandler<M> handler)
```
    Description copied from interface: CollapseItemEvent.HasCollapseItemHandlers
    
    Adds a CollapseItemEvent.CollapseItemHandler handler for CollapseItemEvent events.
    
    Specified by:
    
    addCollapseHandler in interface CollapseItemEvent.HasCollapseItemHandlers<M>
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addExpandHandler
```
public HandlerRegistration addExpandHandler(ExpandItemEvent.ExpandItemHandler<M> handler)
```
    Description copied from interface: ExpandItemEvent.HasExpandItemHandlers
    
    Adds a ExpandItemEvent.ExpandItemHandler handler for ExpandItemEvent events.
    
    Specified by:
    
    addExpandHandler in interface ExpandItemEvent.HasExpandItemHandlers<M>
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - 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
  - focus
```
public void focus()
```
    Description copied from class: Component
    
    Try to focus this widget.
    
    Overrides:
    
    focus in class Component
  - getAppearance
```
public Tree.TreeAppearance getAppearance()
```
    Returns the tree appearance.
    
    Returns:
    
    the tree appearance
  - getCell
```
public <any> getCell()
```
    Return the tree's cell.
    
    Returns:
    
    the cell
  - getChecked
```
public Tree.CheckState getChecked(M model)
```
    Returns the models checked state.
    
    Parameters:
    
    model - the model
    
    Returns:
    
    the check state
  - getCheckedSelection
```
public List<M> getCheckedSelection()
```
    Returns the current checked selection. Only items that have been rendered will be returned in this list. Set setAutoLoad(boolean) to true to fully render the tree to receive all checked items in the tree.
    
    Specified by:
    
    getCheckedSelection in interface CheckProvider<M>
    
    Returns:
    
    the checked selection
  - getCheckNodes
```
public Tree.CheckNodes getCheckNodes()
```
    Returns the child nodes value which determines what node types have a check box. Only applies when check boxes have been enabled ( setCheckable(boolean).
    
    Returns:
    
    the child nodes value
  - getCheckStyle
```
public Tree.CheckCascade getCheckStyle()
```
    The check cascade style value which determines if check box changes cascade to parent and children.
    
    Returns:
    
    the check cascade style
  - getIconProvider
```
public IconProvider<M> getIconProvider()
```
    Returns the model icon provider.
    
    Returns:
    
    the icon provider
  - getSelectionModel
```
public TreeSelectionModel<M> getSelectionModel()
```
    Returns the tree's selection model.
    
    Returns:
    
    the selection model
  - getStore
```
public TreeStore<M> getStore()
```
    Returns the tree's store.
    
    Returns:
    
    the store
  - getStyle
```
public TreeStyle getStyle()
```
    Returns the tree style.
    
    Returns:
    
    the tree style
  - getView
```
public TreeView<M> getView()
```
    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
  - isAutoSelect
```
public boolean isAutoSelect()
```
    Returns true if select on load is enabled.
    
    Returns:
    
    the auto select state
  - isBufferedRender
```
public boolean isBufferedRender()
```
    Returns true if buffered rendering is enabled.
    
    Returns:
    
    true for buffered rendering
  - 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
  - isCheckable
```
public boolean isCheckable()
```
    Returns true if check boxes are enabled.
    
    Returns:
    
    the check box state
  - isChecked
```
public boolean isChecked(M model)
```
    Description copied from interface: CheckProvider
    
    Returns true if the model is checked.
    
    Specified by:
    
    isChecked in interface CheckProvider<M>
    
    Parameters:
    
    model - the model
    
    Returns:
    
    the check state
  - 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
  - isTrackMouseOver
```
public boolean isTrackMouseOver()
```
    Returns true if nodes are highlighted on mouse over.
    
    Returns:
    
    true if enabled
  - onBrowserEvent
```
public void onBrowserEvent(Event event)
```
    Overrides:
    
    onBrowserEvent in class Component
  - refresh
```
public void refresh(M model)
```
  - scrollIntoView
```
public void scrollIntoView(M model)
```
    Scrolls the tree to ensure the given model is visible.
    
    Parameters:
    
    model - the model to scroll into view
  - 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
  - setAutoSelect
```
public void setAutoSelect(boolean autoSelect)
```
    True to select the first model after the store's data changes (defaults to false).
    
    Parameters:
    
    autoSelect - true to auto select
  - setBufferedRender
```
public void setBufferedRender(boolean bufferRender)
```
    True to only render tree nodes that are in view (defaults to false). Set this to true when dealing with very large trees.
    
    Parameters:
    
    bufferRender - true to buffer render
  - 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
  - setCell
```
public void setCell(<any> cell)
```
    Sets the tree's cell.
    
    Parameters:
    
    cell - the cell
  - setCheckable
```
public void setCheckable(boolean checkable)
```
    Sets whether check boxes are used in the tree (defaults to false).
    
    Parameters:
    
    checkable - true for check boxes
  - setChecked
```
public void setChecked(M item,
                       Tree.CheckState checked)
```
    Sets the check state of the item. The checked state will only be set for nodes that have been rendered, setAutoLoad(boolean) can be used to render all children.
    
    Parameters:
    
    item - the item
    
    checked - the check state
  - setCheckedSelection
```
public void setCheckedSelection(List<M> selection)
```
    Description copied from interface: CheckProvider
    
    Sets the current checked selection.
    
    Specified by:
    
    setCheckedSelection in interface CheckProvider<M>
    
    Parameters:
    
    selection - the checked selection
  - 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). When using CHILDREN, it is important to note that the cascade will only be applied to rendered nodes. setAutoLoad(boolean) can be used to fully render the tree on render.
    Valid values are:
    - NONE - no cascading
    - PARENTS - cascade to parents
    - CHILDREN - cascade to children
    Parameters:
    
    checkStyle - the child style
  - 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
  - setLoader
```
public void setLoader(TreeLoader<M> loader)
```
    Sets the tree loader.
    
    Parameters:
    
    loader - the loader
  - setSelectionModel
```
public void setSelectionModel(TreeSelectionModel<M> sm)
```
    Sets the tree's selection model.
    
    Parameters:
    
    sm - the selection model
  - setStore
```
public void setStore(TreeStore<M> store)
```
    Assigns a new store to the tree. May be null, in which case the tree must not be attached to the dom. All selection is lost when this takes place and items are re-rendered.
    
    Parameters:
    
    store - the new store to bind to, or null to detach from the store
  - setStyle
```
public void setStyle(TreeStyle style)
```
    Sets the tree style.
    
    Parameters:
    
    style - the tree style
  - setTrackMouseOver
```
public void setTrackMouseOver(boolean trackMouseOver)
```
    True to highlight nodes when the mouse is over (defaults to true).
    
    Parameters:
    
    trackMouseOver - true to highlight nodes on mouse over
  - setView
```
public void setView(TreeView<M> view)
```
    Sets the tree's view. Only needs to be called when customizing the tree's presentation.
    
    Parameters:
    
    view - the view
  - toggle
```
public void toggle(M model)
```
    Toggles the model's expand state. If the model is not visible, does nothing.
    
    Parameters:
    
    model - the model
  - calculateIconStyle
```
protected ImageResource calculateIconStyle(M model)
```
  - calculateJoint
```
protected Tree.Joint calculateJoint(M model)
```
  - cellConsumesEventType
```
protected boolean cellConsumesEventType(<any> cell,
                                        String eventType)
```
  - clean
```
protected void clean()
```
  - cleanCollapsed
```
protected void cleanCollapsed(M parent)
```
  - cleanNode
```
protected void cleanNode(Tree.TreeNode<M> node)
```
  - clear
```
protected void clear()
```
  - moveFocus
```
protected void moveFocus(Element selectedElem)
```
  - constrainFocusElement
```
protected void constrainFocusElement()
```
  - doClean
```
protected void doClean()
```
  - doUpdate
```
protected void doUpdate()
```
  - findChildren
```
protected void findChildren(M parent,
                            List<M> list,
                            boolean onlyVisible)
```
  - fireEventToCell
```
protected void fireEventToCell(Event event,
                               String eventType,
                               Element cellParent,
                               M m,
                               Context context)
```
  - generateModelId
```
protected String generateModelId(M m)
```
  - getCellContent
```
protected SafeHtml getCellContent(M model)
```
  - getChildModel
```
protected List<M> getChildModel(List<M> l,
                                boolean onlyVisible)
```
  - getContainer
```
protected Element getContainer(M model)
```
  - getRootContainer
```
protected Element getRootContainer()
```
  - getValue
```
protected C getValue(M m)
```
  - getVisibleRowCount
```
protected int getVisibleRowCount()
```
  - getVisibleRows
```
protected int[] getVisibleRows(List<M> visible,
                               int count)
```
  - handleEventForCell
```
protected void handleEventForCell(Event event)
```
  - hasChildren
```
protected boolean hasChildren(M model)
```
  - isCheckable
```
protected boolean isCheckable(Tree.TreeNode<M> node)
```
  - isRowRendered
```
protected boolean isRowRendered(int i,
                                List<M> visible)
```
  - notifyShow
```
protected void notifyShow()
```
    Overrides:
    
    notifyShow in class Component
  - onAdd
```
protected void onAdd(StoreAddEvent<M> event)
```
  - onAfterFirstAttach
```
protected void onAfterFirstAttach()
```
    Description copied from class: Component
    
    Called immediately after the first time the widget becomes attached to the browser's document only the first time.
    
    Overrides:
    
    onAfterFirstAttach in class Component
  - onAttach
```
protected void onAttach()
```
    Overrides:
    
    onAttach in class Component
  - onCheckCascade
```
protected void onCheckCascade(M model,
                              Tree.CheckState checked)
```
  - onCheckClick
```
protected void onCheckClick(Event event,
                            Tree.TreeNode<M> node)
```
  - onClear
```
protected void onClear(StoreClearEvent<M> event)
```
  - onClick
```
protected void onClick(Event event)
```
  - onCollapse
```
protected void onCollapse(M model,
                          Tree.TreeNode<M> node,
                          boolean deep)
```
  - onDataChanged
```
protected void onDataChanged(StoreDataChangeEvent<M> event)
```
  - onDoubleClick
```
protected void onDoubleClick(Event event)
```
  - onExpand
```
protected void onExpand(M model,
                        Tree.TreeNode<M> node,
                        boolean deep)
```
  - onFilter
```
protected void onFilter(StoreFilterEvent<M> se)
```
  - onRemove
```
protected void onRemove(StoreRemoveEvent<M> se)
```
  - onResize
```
protected void onResize(int width,
                        int height)
```
    Description copied from class: Component
    
    Called after the widget is resized, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a resize occurs.
    
    Overrides:
    
    onResize in class Component
    
    Parameters:
    
    width - the width
    
    height - the height
  - onScroll
```
protected void onScroll(Event event)
```
  - onSort
```
protected void onSort(StoreSortEvent<M> se)
```
  - onTriCheckCascade
```
protected void onTriCheckCascade(M model,
                                 Tree.CheckState checked)
```
  - onUpdate
```
protected void onUpdate(StoreUpdateEvent<M> event)
```
  - redraw
```
protected void redraw(M parent)
```
    Completely redraws the children of the given parent (or all items if parent is null), throwing away details like currently expanded nodes, etc. Not designed to be used to update nodes, look into refresh(Object) or Store.update(Object).
    
    Parameters:
    
    parent - the parent of the items to redraw
  - register
```
protected String register(M m)
```
  - renderChild
```
protected SafeHtml renderChild(M parent,
                               M child,
                               int depth,
                               TreeView.TreeViewRenderMode renderMode)
```
  - renderChildren
```
protected void renderChildren(M parent)
```
  - unregister
```
protected void unregister(M m)
```
  - update
```
protected void update()
```

Class Tree<M,C>

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

filtering

focusEl

focusImpl

focusConstrainScheduled

loader

nodes

nodesByDom

sm

store

valueProvider

view

rootContainer

Constructor Detail

Tree

Tree

Method Detail

addBeforeCheckChangeHandler

addBeforeCollapseHandler

addBeforeExpandHandler

addCheckChangedHandler

addCheckChangeHandler

addCollapseHandler

addExpandHandler

collapseAll

expandAll

findNode

focus

getAppearance

getCell

getChecked

getCheckedSelection

getCheckNodes

getCheckStyle

getIconProvider

getSelectionModel

getStore

getStyle

getView

isAutoExpand

isAutoLoad

isAutoSelect

isBufferedRender

isCaching

isCheckable

isChecked

isExpanded

isExpandOnFilter

isLeaf

isTrackMouseOver

onBrowserEvent

refresh

scrollIntoView

setAutoExpand

setAutoLoad

setAutoSelect

setBufferedRender

setCaching

setCell

setCheckable

setChecked

setCheckedSelection

setCheckNodes

setCheckStyle

setExpanded

setExpanded

setExpandOnFilter

setIconProvider

setLeaf

setLoader

setSelectionModel

setStore