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 Classorg.richfaces.taglib.TreeTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
acceptCursorsfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
List of comma separated cursors that indicates when acceptable draggable over dropzone
acceptedTypesfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
A list of drag zones types, which elements are accepted by a drop zone
adviseNodeOpenedfalsefalsejavax.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
adviseNodeSelectedfalsefalsejavax.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
ajaxChildActivationEncodeBehaviorfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
ajaxChildActivationEncodeBehavior
ajaxKeysfalsefalsejavax.el.ValueExpression
(must evaluate to java.util.Set)
ajaxKeys
ajaxNodeKeysfalsefalsejavax.el.ValueExpression
(must evaluate to java.util.Set)
ajaxNodeKeys
ajaxNodeSelectionEncodeBehaviorfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
ajaxNodeSelectionEncodeBehavior
ajaxSinglefalsefalsejavax.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
ajaxSubmitSelectionfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
If "true", an Ajax request to be submit when selecting node. Default value is "false".
bindingfalsefalsejavax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
The attribute takes a value-binding expression for a component property of a backing bean
bypassUpdatesfalsefalsejavax.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
changeExpandListenerfalsefalsejavax.el.MethodExpression
(signature must match void changeExpandListener(org.richfaces.event.NodeExpandedEvent))
Listener called on expand/collapse event on the node
componentStatefalsefalsejavax.el.ValueExpression
(must evaluate to org.ajax4jsf.model.DataComponentState)
It defines EL-binding for a component state for saving or redefinition
cursorTypeMappingfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Mapping between drop types and acceptable cursors
datafalsefalsejavax.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
disableKeyboardNavigationfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
${prop.xmlEncodedDescription}
dragIndicatorfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Id of a component that is used as drag pointer during the drag operation
dragListenerfalsefalsejavax.el.MethodExpression
(signature must match void dragListener(org.richfaces.event.DragEvent))
MethodBinding representing an action listener method that will be notified after drag operation
dragTypefalsefalsejavax.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
dragValuefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Data to be sent to the drop zone after a drop event. Default value is "getRowKey()".
dropListenerfalsefalsejavax.el.MethodExpression
(signature must match void dropListener(org.richfaces.event.DropEvent))
MethodBinding representing an action listener method that will be notified after drop operation
dropValuefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Data to be processed after a drop event. Default value is "getRowKey()".
eventsQueuefalsefalsejavax.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.)
focusfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
id of element to set focus after request completed on client side
grabCursorsfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
List of comma separated cursors that indicates when you can grab and drag an object
grabbingCursorsfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
List of comma separated cursors that indicates when you has grabbed something
highlightedClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Corresponds to the HTML class attribute. Applied to highlighted node
iconfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The icon for node
iconCollapsedfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The icon for collapsed node
iconExpandedfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The icon for expanded node
iconLeaffalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
An icon for component leaves
idfalsefalsejava.lang.StringEvery component may have a unique id that is automatically created if omitted
ignoreDupResponsesfalsefalsejavax.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
immediatefalsefalsejavax.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
limitToListfalsefalsejavax.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.
nodeFacefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Node face facet name
nodeSelectListenerfalsefalsejavax.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.
onbeforedomupdatefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
JavaScript code for call before DOM has been updated on client side
onclickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: a script expression; a pointer button is clicked
oncollapsefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: script expression to invoke on node collapsing
oncompletefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
JavaScript code for call after request completed on client side
oncontextmenufalsefalsejavax.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
ondblclickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: a script expression; a pointer button is double-clicked
ondragendfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
A JavaScript event handler called after a drag operation
ondragenterfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
A JavaScript event handler called on enter draggable object to zone
ondragexitfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
A JavaScript event handler called after a drag object leaves zone
ondragstartfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
A JavaScript event handler called before drag operation
ondropfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
It's an event that is called when something is dropped on a drop zone
ondropendfalsefalsejavax.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
ondropoutfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
A JavaScript event handler called after a out operation
ondropoverfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
A JavaScript event handler called after a drop operation
onexpandfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: script expression to invoke on node expansion
onkeydownfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: a script expression; a key is pressed down
onkeypressfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: a script expression; a key is pressed and released
onkeyupfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: a script expression; a key is released
onmousedownfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: script expression; a pointer button is pressed down
onmousemovefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: a script expression; a pointer is moved within
onmouseoutfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: a script expression; a pointer is moved away
onmouseoverfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: a script expression; a pointer is moved onto
onmouseupfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: script expression; a pointer button is released
onselectedfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: script expression to invoke on node selection
preserveDataInRequestfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
If "true", data is preserved in a request. Default value is "true".
preserveModelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Possible values are "state", "request", "none". Default value is "request"
processfalsefalsejavax.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
reRenderfalsefalsejavax.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
rejectCursorsfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
List of comma separated cursors that indicates when rejectable draggable over dropzone
renderedfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
If "false", this component is not rendered
requestDelayfalsefalsejavax.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
rowKeyVarfalsefalsejava.lang.StringThe attribute provides access to a row key in a Request scope
selectedClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Corresponds to the HTML class attribute. Applied to selected node
showConnectingLinesfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
If "true", connecting lines are show
similarityGroupingIdfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
If there are any component requests with identical IDs then these requests will be grouped.
stateAdvisorfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
ValueBinding pointing at instance of class implementing org.richfaces.component.state.TreeStateAdvisor interface.
stateVarfalsefalsejava.lang.StringThe attribute provides access to a component state on the client side
statusfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
ID (in format of call UIComponent.findComponent()) of Request status component
stylefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
CSS style(s) is/are to be applied when this component is rendered
styleClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Corresponds to the HTML class attribute
switchTypefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Tree Nodes switch mode: "client", "server", "ajax"
timeoutfalsefalsejavax.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
toggleOnClickfalsefalsejavax.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".
treeNodeVarfalsefalsejava.lang.StringThe attribute provides access to a TreeNode instance in a Request scope
typeMappingfalsefalsejavax.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).
valuefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
The current value for this component
varfalsefalsejava.lang.StringAttribute contains a name providing an access to data defined with value

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.