| Info | Value |
|---|---|
| Component Type | org.primefaces.component.TreeTable |
| Handler Class | org.primefaces.component.treetable.TreeTableHandler |
| Renderer Type | org.primefaces.component.TreeTableRenderer |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
allowUnsorting | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines whether columns are allowed to be unsorted. Default is false. |
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. |
cellEditMode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines the cell edit behavior, valid values are "eager" (default) and "lazy". |
cellSeparator | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Separator text to use in output mode of editable cells with multiple components. |
cloneOnFilter | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if nodes should be cloned on filter via Cloneable interface or Copy-Constructor (CustomNode(CustomNode original) or CustomNode(String type, Object data, TreeNode parent)). Normally the filtered nodes are new instanceof of DefaultTreeNode. Default is false. |
currentPageReportTemplate | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Template of the currentPageReport UI. |
dataLocale | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Locale to be used in features such as sorting, defaults to view locale. |
disabledTextSelection | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Disables text selection on row click. Default is true. |
editable | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Controls incell editing. |
editingRow | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if cell editors of row should be displayed as editable or not. Default is false meaning display mode. |
editInitEvent | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines a client side event to open cell on editable table. |
editMode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines edit mode, valid values are "row" (default) and "cell". |
emptyMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Text to display when there is no data to display. Default is "No records found." |
expandMode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Updates children only when set to "children" or the node itself with children when set to "self" on node expand. |
exportRowTag | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| If XML data exporter in use, this allows customization of the row tag in the XML. |
exportTag | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| If XML data exporter in use, this allows customization of the document tag in the XML. |
filterBy | false | jakarta.el.ValueExpression
(must evaluate to java.util.Map)
| Property to be used for default filtering. Expects a single or a collection of FilterMeta. |
filterDelay | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Delay to wait in milliseconds before sending each filter query. Default is 300. |
filteredValue | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Node to keep the filtered nodes if filtering is enabled. |
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. |
first | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Index of the first data to display. |
globalFilter | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Value of the global filter to use when filtering by default. |
globalFilterFunction | false | jakarta.el.ValueExpression
(must evaluate to javax.el.MethodExpression)
| Custom implementation to globally filter a value against a constraint. |
globalFilterOnly | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When true this will hide all column filters and allow all columns to be filtered by global filter only, defaults to false. |
id | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer. |
liveResize | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Columns are resized live in this mode without using a resize helper. |
multiViewState | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Whether to keep TreeTable state across views, defaults to false. |
nativeElements | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| In native mode, treetable uses native checkboxes. |
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. |
pageLinks | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Maximum number of page links to display. Default is 10. |
paginator | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Enables pagination. Default is false. |
paginatorAlwaysVisible | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if paginator should be hidden if total data count is less than number of rows per page. Default is true. |
paginatorPosition | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Position of the paginator. Default is both. |
paginatorTemplate | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Template of the paginator. |
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. |
resizableColumns | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if columns can be resized or not. |
rows | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Number of rows to display per page. Default value is 0 meaning to display all data available. |
rowsPerPageTemplate | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Template of the rowsPerPage dropdown. |
rowStyleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style class for each row. |
saveOnCellBlur | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Saves the changes in cell editing on blur, when set to false changes are discarded. |
scrollable | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Makes data scrollable with fixed header. Default is false. |
scrollHeight | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Height for scrollable data. |
scrollWidth | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Width for scrollable data. |
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". |
showGridlines | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When enables, cell borders are displayed. Default is false. |
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. |
size | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Size of the table content, valid values are "small" and "large". Leave empty for regular size. |
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. |
sortBy | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Property to be used for default sorting. Expects a single or a collection of SortMeta. |
sortMode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines sorting mode, valid values are "single" and "multiple" (default). |
stickyHeader | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Sticky header stays in window viewport during scrolling. |
style | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style of the container element. |
styleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the container element. |
tableStyle | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style of the table element. |
tableStyleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the table element. |
touchable | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Enable touch support if browser detection supports it. Default is false because it is globally enabled by default. |
value | true | jakarta.el.ValueExpression
(must evaluate to org.primefaces.model.TreeNode)
| No Description |
var | false | java.lang.String | Name of the iterator variable that references each element in the data set. |
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.