|
Attributes
|
|
Name
|
Required
|
Request-time
|
Type
|
Description
|
| dragValue |
false |
false |
java.lang.String
|
Data to be sent to the drop zone after a drop event |
| ajaxSubmitSelection |
false |
false |
java.lang.String
|
If "true", an Ajax request to be submit when selecting node |
| stateVar |
false |
false |
java.lang.String
|
The attribute provides access to a component state on the client side |
| rowKeyVar |
false |
false |
java.lang.String
|
The attribute provides access to a row key in a Request scope |
| focus |
false |
false |
java.lang.String
|
id of element to set focus after request completed on client side |
| id |
false |
false |
java.lang.String
|
Every component may have a unique id that is automatically created if omitted |
| onexpand |
false |
false |
java.lang.String
|
HTML: script expression to invoke on node expansion |
| bypassUpdates |
false |
false |
java.lang.String
|
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 |
| switchType |
false |
false |
java.lang.String
|
Tree switch algorithm: "client", "server", "ajax" |
| preserveDataInRequest |
false |
false |
java.lang.String
|
If "true", data is preserved in a request |
| ondropend |
false |
false |
java.lang.String
|
A JavaScript handler for event fired on a drop even the drop for a given type is not available |
| limitToList |
false |
false |
java.lang.String
|
If "true", updates on client side ONLY elements from this 'reRender' property. If "false" (default) updates all rendered by ajax region components |
| style |
false |
false |
java.lang.String
|
CSS style(s) is/are to be applied when this component is rendered |
| oncollapse |
false |
false |
java.lang.String
|
HTML: script expression to invoke on node collapsing |
| onmouseover |
false |
false |
java.lang.String
|
HTML: a script expression; a pointer is moved onto |
| var |
false |
false |
java.lang.String
|
Attribute contains a name providing an access to data defined with value |
| showConnectingLines |
false |
false |
java.lang.String
|
If "true", connecting lines are show |
| dragListener |
false |
false |
java.lang.String
|
MethodBinding representing an action listener method that will be notified after drag operation |
| onkeyup |
false |
false |
java.lang.String
|
HTML: a script expression; a key is released |
| timeout |
false |
false |
java.lang.String
|
Response waiting time on a particular request. If a response is not received during this time, the request is aborted |
| nodeSelectListener |
false |
false |
java.lang.String
|
MethodBinding representing an action listener method that will be notified after selection of node. |
| dropValue |
false |
false |
java.lang.String
|
Data to be processed after a drop event |
| dropListener |
false |
false |
java.lang.String
|
MethodBinding representing an action listener method that will be notified after drop operation |
| onmouseout |
false |
false |
java.lang.String
|
HTML: a script expression; a pointer is moved away |
| iconLeaf |
false |
false |
java.lang.String
|
An icon for component leaves |
| ondragexit |
false |
false |
java.lang.String
|
A JavaScript event handler called after a drag object leaves zone |
| onmouseup |
false |
false |
java.lang.String
|
HTML: script expression; a pointer button is released |
| ondragstart |
false |
false |
java.lang.String
|
A JavaScript event handler called before drag object |
| nodeFace |
false |
false |
java.lang.String
|
Node face facet name |
| binding |
false |
false |
java.lang.String
|
The attribute takes a value-binding expression for a component property of a backing bean |
| onmousemove |
false |
false |
java.lang.String
|
HTML: a script expression; a pointer is moved within |
| adviseNodeSelected |
false |
false |
java.lang.String
|
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 |
| ondragend |
false |
false |
java.lang.String
|
A JavaScript event handler called after a drag operation |
| ondragenter |
false |
false |
java.lang.String
|
A JavaScript event handler called on enter draggable object to zone |
| iconExpanded |
false |
false |
java.lang.String
|
The icon for expanded node |
| oncomplete |
false |
false |
java.lang.String
|
JavaScript code for call after request completed on client side |
| componentState |
false |
false |
java.lang.String
|
It defines EL-binding for a component state for saving or redefinition |
| rendered |
false |
false |
java.lang.String
|
If "false", this component is not rendered |
| reRender |
false |
false |
java.lang.String
|
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 |
| iconCollapsed |
false |
false |
java.lang.String
|
The icon for collapsed node |
| styleClass |
false |
false |
java.lang.String
|
Corresponds to the HTML class attribute |
| onkeypress |
false |
false |
java.lang.String
|
HTML: a script expression; a key is pressed and released |
| selectedClass |
false |
false |
java.lang.String
|
Corresponds to the HTML class attribute. Applied to selected node |
| icon |
false |
false |
java.lang.String
|
The icon for node |
| ajaxSingle |
false |
false |
java.lang.String
|
if "true", submits ONLY one field/link, instead of all form controls |
| ondblclick |
false |
false |
java.lang.String
|
HTML: a script expression; a pointer button is double-clicked |
| dragIndicator |
false |
false |
java.lang.String
|
An indicator component id |
| ondrop |
false |
false |
java.lang.String
|
It's an event that is called when something is dropped on a drop zone |
| changeExpandListener |
false |
false |
java.lang.String
|
Listener called on expand/collapse event on the node |
| adviseNodeOpened |
false |
false |
java.lang.String
|
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 |
| preserveModel |
false |
false |
java.lang.String
|
It can be "state", "request", "none". The default is "request" |
| value |
false |
false |
java.lang.String
|
The current value for this component |
| acceptedTypes |
false |
false |
java.lang.String
|
List of drag types to be processed by the current drop zone |
| onclick |
false |
false |
java.lang.String
|
HTML: a script expression; a pointer button is clicked |
| highlightedClass |
false |
false |
java.lang.String
|
Corresponds to the HTML class attribute. Applied to highlighted node |
| dragType |
false |
false |
java.lang.String
|
Key of a drag object. It's used to define a necessity of processing the current dragged element on the drop zone side |
| status |
false |
false |
java.lang.String
|
ID (in format of call UIComponent.findComponent()) of Request status component |
| toggleOnClick |
false |
false |
java.lang.String
|
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. |
| onkeydown |
false |
false |
java.lang.String
|
HTML: a script expression; a key is pressed down |
| onmousedown |
false |
false |
java.lang.String
|
HTML: script expression; a pointer button is pressed down |
| requestDelay |
false |
false |
java.lang.String
|
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 |
| eventsQueue |
false |
false |
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.) |
| onselected |
false |
false |
java.lang.String
|
HTML: script expression to invoke on node selection |
| immediate |
false |
false |
java.lang.String
|
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 |
| data |
false |
false |
java.lang.String
|
Serialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via "data.foo" syntax |
| onbeforedomupdate |
false |
false |
java.lang.String
|
JavaScript code for call before DOM has been updated on client side |
| ignoreDupResponses |
false |
false |
java.lang.String
|
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 |
| stateAdvisor |
false |
false |
java.lang.String
|
ValueBinding pointing at instance of class implementing org.richfaces.component.state.TreeStateAdvisor interface. |
| typeMapping |
false |
false |
java.lang.String
|
Map between a draggable type and an indicator name on zone. it's defined with the pair (drag type:indicator name)) |