tree (VDL Documentation Generator - Generated Documentation)

Description:

Tree is is used for displaying hierarchical data and creating site navigations.

Component Information
Info	Value
Component Type	`org.primefaces.component.Tree`
Handler Class	`org.primefaces.component.tree.TreeComponentHandler`
Renderer Type	`org.primefaces.component.TreeRenderer`
Description	None

Attributes
Name	Required	Type	Description
`id`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Unique identifier of the component in a namingContainer.
`rendered`	`false`	`javax.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.
`binding`	`false`	`javax.el.ValueExpression` (must evaluate to `javax.faces.component.UIComponent`)	An el expression referring to a server side UIComponent instance in a backing bean.
`widgetVar`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Name of the client side widget.
`value`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Object`)	A TreeNode instance as the backing model.
`var`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Name of the request-scoped variable that'll be used to refer each treenode data during rendering.
`dynamic`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Specifies the ajax/client toggleMode. Default is false.
`cache`	`false`	`javax.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.
`onNodeClick`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript event to process when a tree node is clicked.
`selection`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Object`)	TreeNode array to reference the selections.
`style`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Style of the main container element of tree.
`styleClass`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Style class of the main container element of tree.
`selectionMode`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Defines the selectionMode.
`highlight`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Highlights nodes on hover when selection is enabled, set to false to disable highlighting.
`datakey`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Object`)	Unique key of the data presented by tree nodes.
`animate`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	When enabled, Displays slide effect during toggling of a node.
`orientation`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Defines the orientation of the tree, valid values are, "vertical" (default) and horizontal.
`propagateSelectionUp`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Defines upwards selection propagation for checkbox mode, default is true.
`propagateSelectionDown`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Defines upwards selection propagation for checkbox mode, default is true.
`dir`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Defines text direction, valid values are "ltr" (default) and "rtl".
`draggable`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Controls dragging of tree nodes. Default is false.
`droppable`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Controls dropping of tree nodes. Default is false.
`dragdropScope`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Scope key to group a set of tree components for transferring nodes using drag and drop.
`dragMode`	`false`	`javax.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.
`dropRestrict`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Defines parent-child restrictions when a node is dropped valid values are none (default) and sibling.
`required`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Validation constraint for selection.
`requiredMessage`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Message for required selection validation.
`skipChildren`	`false`	`javax.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.
`showUnselectableCheckbox`	`false`	`javax.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.
`tabindex`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Integer`)	Position of the element in the tabbing order. Default is 0.
`nodeVar`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Name of the request-scoped variable that'll be used to refer current treenode using EL.
`filterBy`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Object`)	Property to be used for filtering.
`filterMatchMode`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Match mode for filtering.
`disabled`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Disables tree.
`multipleDrag`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	When enabled, the selected multiple nodes can be dragged from a tree to another tree.
`dropCopyNode`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	When enabled, the copy of the selected nodes can be dropped from a tree to another tree using Shift key.
`onDrop`	`false`	`javax.el.ValueExpression` (must evaluate to `javax.el.MethodExpression`)	Method providing suggestions.
`filterMode`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Mode for filtering valid values are lenient and strict. Default is lenient.

primefaces-p

Tag tree