Overview | Library | Tag | Help
| FRAMES NO FRAMES

## RichFaces
Tag tree

The <rich:tree> component is designed for hierarchical data presentation and is applied for building a tree structure with a drag-and-drop capability.

Tag Information
Tag Class | org.richfaces.taglib.TreeTag
TagExtraInfo Class | None
Body Content | JSP
Display Name | None

Attributes
Name | Required | Request-time | Type | Description
acceptCursors | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | List of comma separated cursors that indicates when acceptable draggable over dropzone
acceptedTypes | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | A list of drag zones types, which elements are accepted by a drop zone
adviseNodeOpened | false | false | `javax.el.MethodExpression` (signature must match `java.lang.Boolean adviseNodeOpened(org.richfaces.component.UITree)`) | MethodBinding pointing at a method accepting an org.richfaces.component.UITree with return of java.lang.Boolean type. If returned value is: java.lang.Boolean. TRUE, a particular treeNode is expanded; java.lang.Boolean.FALSE, a particular treeNode is collapsed; null, a particular treeNode saves the current state
adviseNodeSelected | false | false | `javax.el.MethodExpression` (signature must match `java.lang.Boolean adviseNodeSelected(org.richfaces.component.UITree)`) | MethodBinding pointing at a method accepting an org.richfaces.component.UITree with return of java.lang.Boolean type. If returned value is: java.lang.Boolean. TRUE, a particular treeNode is selected; java.lang.Boolean.FALSE, a particular treeNode is unselected; null, a particular treeNode saves the current state
ajaxChildActivationEncodeBehavior | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines which nodes keys will be added to AjaxNodeKeys automatically on the request from the children of the node. Values: "none" - nothing, "node" - only current node, "subtree" - node and all its children.
ajaxKeys | false | false | `javax.el.ValueExpression` (must evaluate to `java.util.Set`) | ajaxKeys
ajaxNodeKeys | false | false | `javax.el.ValueExpression` (must evaluate to `java.util.Set`) | Keys of the nodes (without subtree) to be updated for ajax request risen by the node itself
ajaxNodeSelectionEncodeBehavior | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines which nodes keys will be added to AjaxNodeKeys automatically on selecting ajax request from the node. Values: "none" - nothing, "node" - only current node, "subtree" - node and all its children.
ajaxSingle | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | boolean attribute which provides possibility to limit JSF tree processing(decoding, conversion/validation, value applying) to the component which send the request only
ajaxSubmitSelection | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If "true", an Ajax request to be submit when selecting node. Default value is "false".
binding | false | false | `javax.el.ValueExpression` (must evaluate to `javax.faces.component.UIComponent`) | The attribute takes a value-binding expression for a component property of a backing bean
bypassUpdates | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If "true", after process validations phase it skips updates of model beans on a force render response. It can be used for validating components input
changeExpandListener | false | false | `javax.el.MethodExpression` (signature must match `void changeExpandListener(org.richfaces.event.NodeExpandedEvent)`) | Listener called on expand/collapse event on the node
componentState | false | false | `javax.el.ValueExpression` (must evaluate to `org.ajax4jsf.model.DataComponentState`) | It defines EL-binding for a component state for saving or redefinition
cursorTypeMapping | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | Mapping between drop types and acceptable cursors
data | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | Serialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via "data.foo" syntax
disableKeyboardNavigation | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | Disables keyboard navigation. Default value is "false"
dragIndicator | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Id of a component that is used as drag pointer during the drag operation
dragListener | false | false | `javax.el.MethodExpression` (signature must match `void dragListener(org.richfaces.event.DragEvent)`) | MethodBinding representing an action listener method that will be notified after drag operation
dragType | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | A drag zone type that is used for zone definition, which elements can be accepted by a drop zone
dragValue | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | Data to be sent to the drop zone after a drop event. Default value is "getRowKey()".
dropListener | false | false | `javax.el.MethodExpression` (signature must match `void dropListener(org.richfaces.event.DropEvent)`) | MethodBinding representing an action listener method that will be notified after drop operation
dropValue | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | Data to be processed after a drop event. Default value is "getRowKey()".
eventsQueue | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Name of requests queue to avoid send next request before complete other from same event. Can be used to reduce number of requests of frequently events (key press, mouse move etc.)
focus | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | id of element to set focus after request completed on client side
grabCursors | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | List of comma separated cursors that indicates when you can grab and drag an object
grabbingCursors | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | List of comma separated cursors that indicates when you has grabbed something
highlightedClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Corresponds to the HTML class attribute. Applied to highlighted node
icon | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The icon for node
iconCollapsed | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The icon for collapsed node
iconExpanded | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The icon for expanded node
iconLeaf | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | An icon for component leaves
id | false | false | `java.lang.String` | Every component may have a unique id that is automatically created if omitted
ignoreDupResponses | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | Attribute allows to ignore an Ajax Response produced by a request if the newest 'similar' request is in a queue already. ignoreDupResponses="true" does not cancel the request while it is processed on the server, but just allows to avoid unnecessary updates on the client side if the response isn't actual now
immediate | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | A flag indicating that this component value must be converted and validated immediately (during an Apply Request Values phase), rather than waiting until a Process Validations phase
limitToList | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If "true", then of all AJAX-rendered on the page components only those will be updated, which ID's are passed to the "reRender" attribute of the describable component. "false"-the default value-means that all components with ajaxRendered="true" will be updated.
nodeFace | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Node face facet name
nodeSelectListener | false | false | `javax.el.MethodExpression` (signature must match `void nodeSelectListener(org.richfaces.event.NodeSelectedEvent)`) | MethodBinding representing an action listener method that will be notified after selection of node.
onbeforedomupdate | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | JavaScript code for call before DOM has been updated on client side
onclick | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a pointer button is clicked
oncollapse | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: script expression to invoke on node collapsing
oncomplete | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | JavaScript code for call after request completed on client side
oncontextmenu | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | JavaScript handler to be called on right click. Returning false prevents default browser context menu from being displayed
ondblclick | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a pointer button is double-clicked
ondragend | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | A JavaScript event handler called after a drag operation
ondragenter | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | A JavaScript event handler called on enter draggable object to zone
ondragexit | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | A JavaScript event handler called after a drag object leaves zone
ondragstart | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | A JavaScript event handler called before drag operation
ondrop | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | It's an event that is called when something is dropped on a drop zone
ondropend | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | A JavaScript handler for event fired on a drop even the drop for a given type is not available
ondropout | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | A JavaScript event handler called after a out operation
ondropover | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | A JavaScript event handler called after a drop operation
onexpand | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: script expression to invoke on node expansion
onkeydown | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a key is pressed down
onkeypress | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a key is pressed and released
onkeyup | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a key is released
onmousedown | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: script expression; a pointer button is pressed down
onmousemove | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a pointer is moved within
onmouseout | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a pointer is moved away
onmouseover | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a pointer is moved onto
onmouseup | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: script expression; a pointer button is released
onselected | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: script expression to invoke on node selection
preserveDataInRequest | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If "true", data is preserved in a request. Default value is "true".
preserveModel | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Possible values are "state", "request", "none". Default value is "request"
process | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | Id['s] (in format of call UIComponent.findComponent()) of components, processed at the phases 2-5 in case of AjaxRequest caused by this component. Can be single id, comma-separated list of Id's, or EL Expression with array or Collection
reRender | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | Id['s] (in format of call UIComponent.findComponent()) of components, rendered in case of AjaxRequest caused by this component. Can be single id, comma-separated list of Id's, or EL Expression with array or Collection
rejectCursors | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | List of comma separated cursors that indicates when rejectable draggable over dropzone
rendered | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If "false", this component is not rendered
requestDelay | false | false | `javax.el.ValueExpression` (must evaluate to `int`) | Attribute defines the time (in ms.) that the request will be wait in the queue before it is ready to send. When the delay time is over, the request will be sent to the server or removed if the newest 'similar' request is in a queue already
rightClickSelection | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | Allow to select tree item using mouse right click
rowKeyConverter | false | false | `javax.el.ValueExpression` (must evaluate to `javax.faces.convert.Converter`) | Converter for a row key object
rowKeyVar | false | false | `java.lang.String` | The attribute provides access to a row key in a Request scope
selectedClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Corresponds to the HTML class attribute. Applied to selected node
showConnectingLines | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If "true", connecting lines are show
similarityGroupingId | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | If there are any component requests with identical IDs then these requests will be grouped.
stateAdvisor | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | ValueBinding pointing at instance of class implementing org.richfaces.component.state.TreeStateAdvisor interface.
stateVar | false | false | `java.lang.String` | The attribute provides access to a component state on the client side
status | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | ID (in format of call UIComponent.findComponent()) of Request status component
style | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | CSS style(s) is/are to be applied when this component is rendered
styleClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Corresponds to the HTML class attribute
switchType | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Tree Nodes switch mode: "client", "server", "ajax"
timeout | false | false | `javax.el.ValueExpression` (must evaluate to `int`) | Response waiting time on a particular request. If a response is not received during this time, the request is aborted
toggleOnClick | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If "false" do not toggle node state on click. If "true", than node will be toggles on click on ether node content, or node icon. Default value is "false".
treeNodeVar | false | false | `java.lang.String` | The attribute provides access to a TreeNode instance in a Request scope
typeMapping | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | The attribute associates a type of dragable zone (dragType) with <rich:dndParam> defined for <rich:dropSupport> for passing parameter value to <rich:dragIndicator>. It uses JSON format: (drag_type: parameter_name).
value | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | The current value for this component
var | false | false | `java.lang.String` | Attribute contains a name providing an access to data defined with value

Variables
| No Variables Defined.

Overview | Library | Tag | Help
| FRAMES NO FRAMES

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.