### Create new RichFaces Documentation Jira issue

Summary
255 characters left
Description
Environment
This will launch the RichFaces Jira page - to complete your feedback please login if needed, and submit the Jira.

JBoss.org Community Documentation

- Prev
- Next

### 6.9.1. < rich:tree > available since 3.0.0

expand all

#### 6.9.1.1. Description

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

Figure 6.105. Expanded <rich:tree> with child elements

#### 6.9.1.2. Key Features

- Highly customizable look-and-feel

- Built-in drag and drop capability, than enable relocating tree nodes within the tree

- Built-in Ajax processing

- Possibility to define a visual representation by node type

- Support of several root elements in a tree

Table 6.166. rich : tree attributes

Attribute Name | Description
--- | ---
acceptCursors | List of comma separated cursors that indicates when acceptable draggable over dropzone
acceptedTypes | A list of drag zones types, which elements are accepted by a drop zone
adviseNodeOpened | 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 | 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 | 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 | This attribute defines row keys that are updated after an AJAX request.
ajaxNodeKeys | Keys of the nodes (without subtree) to be updated for ajax request risen by the node itself
ajaxNodeSelectionEncodeBehavior | 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 | Limits JSF tree processing (decoding, conversion, validation and model updating) only to a component that sends the request. Boolean
ajaxSubmitSelection | If "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
bypassUpdates | 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 | Listener called on expand/collapse event on the node
componentState | It defines EL-binding for a component state for saving or redefinition
cursorTypeMapping | Mapping between drop types and acceptable cursors
data | Serialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via "data.foo" syntax
disableKeyboardNavigation | Disables keyboard navigation. Default value is "false"
dragIndicator | Id of a component that is used as drag pointer during the drag operation
dragListener | MethodBinding representing an action listener method that will be notified after drag operation
dragType | A drag zone type that is used for zone definition, which elements can be accepted by a drop zone
dragValue | Data to be sent to the drop zone after a drop event. Default value is "getRowKey()".
dropListener | MethodBinding representing an action listener method that will be notified after drop operation
dropValue | Data to be processed after a drop event. Default value is "getRowKey()".
eventsQueue | 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 | ID of an element to set focus after request is completed on client side
grabbingCursors | List of comma separated cursors that indicates when you has grabbed something
grabCursors | List of comma separated cursors that indicates when you can grab and drag an object
highlightedClass | Assigns one or more space-separated CSS class names to the component highlighted node
icon | The icon for node
iconCollapsed | The icon for collapsed node
iconExpanded | The icon for expanded node
iconLeaf | An icon for component leaves
id | JSF: Every component may have a unique id that is automatically created if omitted
ignoreDupResponses | 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 | 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 | 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 | Node face facet name
nodeSelectListener | MethodBinding representing an action listener method that will be notified after selection of node.
onbeforedomupdate | The 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
oncollapse | The client-side script method to be called when a node is collapsed
oncomplete | The client-side script method to be called after the request is completed
oncontextmenu | The 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
ondragend | The client-side script method to be called when the dragging operation is finished
ondragenter | The client-side script method to be called when a draggable object enters the zone
ondragexit | The client-side script method to be called after a draggable object leaves the zone
ondragstart | The client-side script method to be called when the dragging operation is started
ondrop | The client-side script method to be called when something is dropped into the drop zone
ondropend | The client-side script method to be called when a draggable object is dropped into any zone
ondropout | The client-side script method to be called when the draggable object is moved away from the drop zone
ondropover | The client-side script method to be called when the draggable object is over the drop zone
onexpand | The 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
onselected | The client-side script method to be called when a node is selected
preserveDataInRequest | If "true", data is preserved in a request. Default value is "true".
preserveModel | Possible values are "state", "request", "none". Default value is "request"
process | 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
rejectCursors | List of comma separated cursors that indicates when rejectable draggable over dropzone
rendered | JSF: If "false", this component is not rendered
requestDelay | 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
reRender | 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
rightClickSelection | Allow to select tree item using mouse right click
rowKeyConverter | Converter for a row key object
rowKeyVar | The attribute provides access to a row key in a Request scope
selectedClass | Assigns one or more space-separated CSS class names to the component selected node
showConnectingLines | If "true", connecting lines are show
similarityGroupingId | If there are any component requests with identical IDs then these requests will be grouped.
stateAdvisor | ValueBinding pointing at instance of class implementing org.richfaces.component.state.TreeStateAdvisor interface.
stateVar | The attribute provides access to a component state on the client side
status | ID (in format of call UIComponent.findComponent()) of Request status component
style | HTML: 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.
switchType | Tree Nodes switch mode: "client", "server", "ajax"
timeout | Response waiting time on a particular request. If a response is not received during this time, the request is aborted
toggleOnClick | 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 | The attribute provides access to a TreeNode instance in a Request scope
typeMapping | 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 | JSF: The current value for this component
var | Attribute contains a name providing an access to data defined with value

- Prev6.9. Rich Trees
- Top of page
- Front page
- Next6.9.2. < rich:treeNode > ...