Create new RichFaces Documentation Jira issue

This will launch the RichFaces Jira page - to complete your feedback please login if needed, and submit the Jira.

JBoss.orgCommunity Documentation

6.9.1.  < rich:tree > available since 3.0.0

expand all
6.9.1.1. Description
6.9.1.2. Key Features

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


Table 6.166. rich : tree attributes

Attribute Name Description
acceptCursorsList of comma separated cursors that indicates when acceptable draggable over dropzone
acceptedTypesA list of drag zones types, which elements are accepted by a drop zone
adviseNodeOpenedMethodBinding 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
adviseNodeSelectedMethodBinding 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
ajaxChildActivationEncodeBehaviorDefines 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.
ajaxKeysThis attribute defines row keys that are updated after an AJAX request.
ajaxNodeKeysKeys of the nodes (without subtree) to be updated for ajax request risen by the node itself
ajaxNodeSelectionEncodeBehaviorDefines 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.
ajaxSingleLimits JSF tree processing (decoding, conversion, validation and model updating) only to a component that sends the request. Boolean
ajaxSubmitSelectionIf "true", an Ajax request to be submit when selecting node. Default value is "false".
binding JSF: The attribute takes a value-binding expression for a component property of a backing bean
bypassUpdatesIf "true", after process validations phase it skips updates of model beans on a force render response. It can be used for validating components input
changeExpandListenerListener called on expand/collapse event on the node
componentStateIt defines EL-binding for a component state for saving or redefinition
cursorTypeMappingMapping between drop types and acceptable cursors
dataSerialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via "data.foo" syntax
disableKeyboardNavigationDisables keyboard navigation. Default value is "false"
dragIndicatorId of a component that is used as drag pointer during the drag operation
dragListenerMethodBinding representing an action listener method that will be notified after drag operation
dragTypeA drag zone type that is used for zone definition, which elements can be accepted by a drop zone
dragValueData to be sent to the drop zone after a drop event. Default value is "getRowKey()".
dropListenerMethodBinding representing an action listener method that will be notified after drop operation
dropValueData to be processed after a drop event. Default value is "getRowKey()".
eventsQueueName 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.)
focusID of an element to set focus after request is completed on client side
grabbingCursorsList of comma separated cursors that indicates when you has grabbed something
grabCursorsList of comma separated cursors that indicates when you can grab and drag an object
highlightedClassAssigns one or more space-separated CSS class names to the component highlighted node
iconThe icon for node
iconCollapsedThe icon for collapsed node
iconExpandedThe icon for expanded node
iconLeafAn icon for component leaves
id JSF: Every component may have a unique id that is automatically created if omitted
ignoreDupResponsesAttribute 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
immediateA 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
limitToListIf "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.
nodeFaceNode face facet name
nodeSelectListenerMethodBinding representing an action listener method that will be notified after selection of node.
onbeforedomupdateThe client-side script method to be called before DOM is updated
onclick DHTML: The client-side script method to be called when the element is clicked
oncollapseThe client-side script method to be called when a node is collapsed
oncompleteThe client-side script method to be called after the request is completed
oncontextmenuThe client-side script method to be called when the right mouse button is clicked over the component. Returning false prevents a default browser context menu from being displayed.
ondblclick DHTML: The client-side script method to be called when the element is double-clicked
ondragendThe client-side script method to be called when the dragging operation is finished
ondragenterThe client-side script method to be called when a draggable object enters the zone
ondragexitThe client-side script method to be called after a draggable object leaves the zone
ondragstartThe client-side script method to be called when the dragging operation is started
ondropThe client-side script method to be called when something is dropped into the drop zone
ondropendThe client-side script method to be called when a draggable object is dropped into any zone
ondropoutThe client-side script method to be called when the draggable object is moved away from the drop zone
ondropoverThe client-side script method to be called when the draggable object is over the drop zone
onexpandThe client-side script method to be called when a node is expanded
onkeydown DHTML: The client-side script method to be called when a key is pressed down over the element
onkeypress DHTML: The client-side script method to be called when a key is pressed over the element and released
onkeyup DHTML: The client-side script method to be called when a key is released
onmousedown DHTML: The client-side script method to be called when a mouse button is pressed down over the element
onmousemove DHTML: The client-side script method to be called when a pointer is moved within the element
onmouseout DHTML: The client-side script method to be called when a pointer is moved away from the element
onmouseover DHTML: The client-side script method to be called when a pointer is moved onto the element
onmouseup DHTML: The client-side script method to be called when a mouse button is released
onselectedThe client-side script method to be called when a node is selected
preserveDataInRequestIf "true", data is preserved in a request. Default value is "true".
preserveModelPossible values are "state", "request", "none". Default value is "request"
processId['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
rejectCursorsList of comma separated cursors that indicates when rejectable draggable over dropzone
rendered JSF: If "false", this component is not rendered
requestDelayAttribute 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
reRenderId['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
rightClickSelectionAllow to select tree item using mouse right click
rowKeyConverterConverter for a row key object
rowKeyVarThe attribute provides access to a row key in a Request scope
selectedClassAssigns one or more space-separated CSS class names to the component selected node
showConnectingLinesIf "true", connecting lines are show
similarityGroupingIdIf there are any component requests with identical IDs then these requests will be grouped.
stateAdvisorValueBinding pointing at instance of class implementing org.richfaces.component.state.TreeStateAdvisor interface.
stateVarThe attribute provides access to a component state on the client side
statusID (in format of call UIComponent.findComponent()) of Request status component
styleHTML: CSS style rules to be applied to the component
styleClass JSF: Assigns one or more CSS class names to the component. Corresponds to the HTML "class" attribute.
switchTypeTree Nodes switch mode: "client", "server", "ajax"
timeoutResponse waiting time on a particular request. If a response is not received during this time, the request is aborted
toggleOnClickIf "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".
treeNodeVarThe attribute provides access to a TreeNode instance in a Request scope
typeMappingThe 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 JSF: The current value for this component
varAttribute contains a name providing an access to data defined with value