| Info | Value |
|---|---|
| Component Type | org.primefaces.component.Tree |
| Handler Class | org.primefaces.component.tree.TreeComponentHandler |
| Renderer Type | org.primefaces.component.TreeRenderer |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
animate | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When enabled, Displays slide effect during toggling of a node. |
binding | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| An el expression referring to a server side UIComponent instance in a backing bean. |
cache | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Specifies caching on dynamically loaded nodes. When set to true expanded nodes will be kept in memory. Default is true. |
datakey | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Unique key of the data presented by tree nodes. |
dir | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines text direction, valid values are "ltr" (default) and "rtl". |
disabled | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Disables tree. |
dragdropScope | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Scope key to group a set of tree components for transferring nodes using drag and drop. |
draggable | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Controls dragging of tree nodes. Default is false. |
dragMode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines parent-child relationship when a node is dragged, valid values are self (default), parent and ancestor. |
dropCopyNode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When enabled and dropMode='move', the copy of the selected nodes can be dropped from a tree to another tree using Shift key. |
dropMode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Whether to 'move' or 'copy' the node on drop. Default is 'move'. |
droppable | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Controls dropping of tree nodes. Default is false. |
dropRestrict | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines parent-child restrictions when a node is dropped valid values are none (default) and sibling. |
dynamic | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Specifies the ajax/client toggleMode. Default is false. |
filterBy | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Property to be used for filtering. |
filterDelay | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Delay to wait in milliseconds before sending each filter query. Default is 300. |
filterEvent | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side event to invoke filtering. If "enter" it will only filter after ENTER key is pressed. Default is keyup. |
filterFunction | false | jakarta.el.ValueExpression
(must evaluate to javax.el.MethodExpression)
| Custom implementation to filter TreeNodes against a constraint. |
filterMatchMode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Match mode for filtering. |
filterMode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Mode for filtering valid values are lenient and strict. Default is lenient. |
highlight | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Highlights nodes on hover when selection is enabled, set to false to disable highlighting. |
id | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer. |
multipleDrag | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When enabled, the selected multiple nodes can be dragged from a tree to another tree. |
nodeVar | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the request-scoped variable that'll be used to refer current treenode using EL. |
onDrop | false | jakarta.el.ValueExpression
(must evaluate to javax.el.MethodExpression)
| Method returning whether the dragged node(s) can be dropped on the dropped node. |
onNodeClick | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript event to process when a tree node is clicked. |
orientation | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines the orientation of the tree, valid values are, "vertical" (default) and horizontal. |
propagateSelectionDown | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines upwards selection propagation for checkbox mode, default is true. |
propagateSelectionUp | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines upwards selection propagation for checkbox mode, default is true. |
rendered | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Boolean value to specify the rendering of the component, when set to false component will not be rendered. |
required | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Validation constraint for selection. |
requiredMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Message for required selection validation. |
selection | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| TreeNode array to reference the selections. |
selectionMode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines the selectionMode, valid values are "single", "multiple" and "checkbox". |
showUnselectableCheckbox | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if in checkbox selection mode, a readonly checkbox should be displayed for an unselectable node. Default is false. |
skipChildren | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Ignores processing of children during lifecycle, improves performance if table only has output components, default is false. |
style | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style of the main container element of tree. |
styleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the main container element of tree. |
tabindex | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Position of the element in the tabbing order. Default is 0. |
value | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| A TreeNode instance as the backing model. |
var | false | java.lang.String | Name of the request-scoped variable that'll be used to refer each treenode data during rendering. |
widgetVar | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the client side widget. |
Output generated by Vdldoc View Declaration Language Documentation Generator.