ICEfaces-EE ACE Components
Tag tree


Renders a hierarchical structure of ace:node contents. Supports client-side and server-side node selection and expansion. Other features available include: user reordering of nodes, multiple selection and lazy node state initialization.

For more information, see the Tree Wiki Documentation.


Client Events
NameDescriptionSupported classes for argument
expandFired when a node switch is clicked to show children a node.javax.faces.event.AjaxBehaviorEvent
contractFired when a node switch is clicked to hide children a node.javax.faces.event.AjaxBehaviorEvent
selectFired when a node is clicked to select it.javax.faces.event.AjaxBehaviorEvent
deselectFired when a selected node is clicked to deselect it.javax.faces.event.AjaxBehaviorEvent
reorderFired when a node is dragged into a new position.javax.faces.event.AjaxBehaviorEvent
Client events can be used with Client Behaviors and the ace:ajax tag.


Tag Information
Tag Classorg.icefaces.ace.component.tree.TreeTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
bindingnotruejavax.el.ValueExpressionUsing an EL expression, bind the component reference to a bean property, so that the component may be accessed in the bean.
expansionnotruejava.lang.BooleanEnable expansion feature of this tree component. This toggles this feature for the entire tree, per-node configuration of this feature available via the NodeState. Default = 'false'.
expansionModenotrueorg.icefaces.ace.component.tree.TreeExpansionModeSelect the request behaviour of the expansion feature. When 'client', the children of every node are pre-rendered in the DOM and exposed by JavaScript when nodes are expanded. In the default 'server' mode, only visible nodes are inthe DOM and expansion and contraction are caused by ajax page updates. Default = 'org.icefaces.ace.component.tree.TreeExpansionMode.server'.
firstnotrueintZero-relative row number of the first row in the underlying data model to be displayed, or zero to start at the beginning of the data model. Default = '0'.
idnotruejava.lang.StringThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.
keyConverternotrueorg.icefaces.ace.model.tree.KeySegmentConverterOptionally define a custom KeySegmentConverter object to produce segmented identifier keys for nodes based on something other than indexes.
renderednotruebooleanReturn true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. Default = 'true'.
reorderingnotruejava.lang.BooleanEnable reordering of the nodes of this tree. Default = 'false'.
rowIndexnotrueintZero-relative index of the row currently being accessed in the underlying DataModel, or -1 for no current row. Default = '0'.
rowsnotrueintThe number of rows (starting with the one identified by the first property) to be displayed, or zero to display the entire set of available rows. Default = '0'.
selectMultiplenotruejava.lang.BooleanDisable the selection of multiple nodes simultaneously. Default = 'true'.
selectionnotruejava.lang.BooleanEnable selection feature of this tree component. This toggles this feature for the entire tree, per-node configuration of this feature available via the NodeState. Default = 'false'.
selectionModenotrueorg.icefaces.ace.component.tree.TreeSelectionModeSelect the request behaviour of the selection feature. When 'client', the (de)selection of a node is recorded on the client, and communicated to the server on the next request executing this component. In the default 'server' mode, when a node is (de)selected, the component communicates the change the server immediately with an ajax update. Default = 'org.icefaces.ace.component.tree.TreeSelectionMode.server'.
stateCreationCallbacknotrueorg.icefaces.ace.model.tree.NodeStateCreationCallbackBind an implementer of the NodeStateCreationCallback interface to take as input, a node object and a default NodeState and return a NodeState configured with the state appropriatefor the given node object.
stateMapnotrueorg.icefaces.ace.model.tree.NodeStateMapDefine a NodeStateMap ValueExpression to access the store of Tree node object state information. The state map provides an API for looking up the state of a particular node object, as well as reverse look-ups to get node objects with a particular state.
stateVarnotruejava.lang.StringThe request-scope attribute exposing the state object for the currentnode when iterating. Default = 'nodeState'.
typenotruejava.lang.StringDefine a ValueExpression that returns a String representation of the 'rendering type' of this node. The rendering type is matched against the String 'type' attribute of ace:node tag instances to determine which node template should be used to render a given node object.
valuenotruejava.lang.ObjectThe Java objects representing the nodes of the tree. Supports either a List of javax.swing.tree.TreeNode implementations, MutableTreeNode implementations or an implementation of NodeDataModel.
varnotruejava.lang.StringThe request-scope attribute (if any) under which the data object for the current row will be exposed when iterating.

Variables
No Variables Defined.


Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.