org.apache.tapestry5.corelib.components
Class Tree

java.lang.Object
  extended by org.apache.tapestry5.corelib.components.Tree

@Events(value={"nodeSelected","nodeUnselected"})
public class Tree
extends Object

A component used to render a recursive tree structure, with expandable/collapsable/selectable nodes. The data that is displayed by the component is provided as a TreeModel. A secondary model, the TreeExpansionModel, is used to track which nodes have been expanded. The optional TreeSelectionModel is used to track node selections (as currently implemented, only leaf nodes may be selected).

The Tree component uses special tricks to support recursive rendering of the Tree as necessary.

Since:
5.3

Constructor Summary
Tree()
           
 
Method Summary
 void clearExpansions()
          Clears the tree's TreeExpansionModel.
 String getContainerClass()
           
 TreeExpansionModel getDefaultTreeExpansionModel()
           
 TreeExpansionModel getExpansionModel()
          Returns the actual TreeExpansionModel in use for this Tree component, as per the expansionModel parameter.
 Object getRenderRootNodes()
           
 TreeSelectionModel getSelectionModel()
          Returns the actual TreeSelectionModel in use for this Tree component, as per the selectionModel parameter.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Tree

public Tree()
Method Detail

getContainerClass

public String getContainerClass()

getDefaultTreeExpansionModel

public TreeExpansionModel getDefaultTreeExpansionModel()

getExpansionModel

public TreeExpansionModel getExpansionModel()
Returns the actual TreeExpansionModel in use for this Tree component, as per the expansionModel parameter. This is often, but not always, the same as getDefaultTreeExpansionModel().


getSelectionModel

public TreeSelectionModel getSelectionModel()
Returns the actual TreeSelectionModel in use for this Tree component, as per the selectionModel parameter.


getRenderRootNodes

public Object getRenderRootNodes()

clearExpansions

public void clearExpansions()
Clears the tree's TreeExpansionModel.



Copyright © 2003-2011 The Apache Software Foundation.