o
Tag treeTable


The TreeTable component displays hierarchical data in a tabular format. One of the component's columns displays a tree structure in which each row representing a node can be expanded to reveal lower-level rows of data. In general, the TreeTable provides most of the functionality of the OpenFaces DataTable component. Child tags: treeColumn, staticTreeStructure, dynamicTreeStructure, column, selectionColumn, checkboxColumn, singleNodeSelection, multipleNodeSelection, cell, row, columnResizing.


Tag Information
Tag Classorg.openfaces.taglib.jsp.table.TreeTableJspTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredBinding TypeELDefaultDescription
alignfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullThe alignment of the table content.
Available values are:
"left"
"center"
"right"
allRecordsFilterTextfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
true"<All>"The text that is displayed instead of "" in the "comboBox" or "dropDownField" when filtering is used.
applyDefaultStylefalsejavax.el.ValueExpression
(must evaluate to boolean)
truetrueA flag that indicates whether or not to apply the default style.
autoFilterDelayfalsejavax.el.ValueExpression
(must evaluate to int)
true700Specifies the delay in milliseconds when the filtering is performed automatically after the user has entered some value in an associated filter, or turns off automatic filtering in case -1 is specified as a value for this attribute.
bgcolorfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullThe background color behind the table content.
bindingfalsejavax.el.ValueExpression
(must evaluate to org.openfaces.component.table.TreeTable)
onlynullA value-binding expression that associates the TreeTable with a backing bean property.
bodyOddRowClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for TreeTable odd rows, if it should be different from bodyRowClass.
bodyOddRowStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for TreeTable odd rows, if it should be different from bodyRowStyle.
bodyRowClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for TreeTable rows.
bodyRowStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for TreeTable rows.
bodySectionClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the TreeTable body section.
bodySectionStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the TreeTable body section.
borderfalsejavax.el.ValueExpression
(must evaluate to int)
trueInteger.MIN_VALUEThe number of pixels in the TreeTable border. The value Integer.MIN_VALUE means there is no border rendered.
cellpaddingfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullThe amount of space between the border of the cell and its content. The value null means there is no cell spacing rendered.
cellspacingfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullThe amount of space between cells in the TreeTable. The value null means there is no cell spacing rendered.
columnIdVarfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
falsenullThe name of a request-scope variable under which the column id is available. It is a string variable that contains the id specified in the corresponding column tag.
columnIndexVarfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
falsenullThe name of a request-scope variable under which a column index is available. It is a zero-based integer number.
columnsOrderfalsejavax.el.ValueExpression
(must evaluate to java.util.List)
onlynullThe order of columns in the TreeTable component. This attribute should be bound to a list containing column IDs for each column in the order you want them to be displayed. If the "columnsOrder" attribute is not specified, all the columns are rendered in the order they are defined.
commonFooterRowClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the TreeTable footer row.
commonFooterRowStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the TreeTable footer row.
commonFooterSeparatorfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
true"1px solid #a0a0a0"A style for a line that separates the table footer from the rest of the table. Should be specified as the CSS "border" property but without the prefix "border:".
commonHeaderRowClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the TreeTable header row.
commonHeaderRowStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the TreeTable header row.
commonHeaderSeparatorfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
true"1px solid #a0a0a0"A style for a line that separates the table header from the rest of the table. Should be specified as the CSS "border" property but without the prefix "border:".
dirfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
true"LTR"The reading order of the table columns and content.
Available values are:
"LTR" — left to right
"RTL" — right to left
emptyRecordsFilterTextfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
true"<Empty>"The text that is displayed instead of "" in the "comboBox" or "dropDownField" when filtering is used.
expansionStatefalsejavax.el.ValueExpression
(must evaluate to org.openfaces.component.table.ExpansionState)
true"allCollapsed"Defines the state of the TreeTable nodes when the component is loaded.
Available values are:
"allExpanded" — all nodes are displayed in the expanded state
"allCollapsed" — all nodes are displayed in the collapsed state
"levelsExpanded:NUMBER" — where NUMBER is an integer number greater than or equal to zero. It specifies the hierarchy level at which the nodes are displayed in the expanded state, while all nodes below this level are collapsed. For example, expansionState="levelsExpanded:1" means that only the root nodes are expanded. The value of "0" means that no nodes are expanded
filterAcceptedRowClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the nodes that satisfy the filter criteria.
filterAcceptedRowStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the nodes that satisfy the filter criteria.
filterSubsidiaryRowClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the nodes that do not satisfy the filter criteria but are needed to keep the hierarchy visible.
filterSubsidiaryRowStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the nodes that do not satisfy the filter criteria but are needed to keep the hierarchy visible.
focusedClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name of the TreeTable component when it is focused.
focusedStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style of the TreeTable component when it is focused.
foldingEnabledfalsejavax.el.ValueExpression
(must evaluate to boolean)
truetrueA flag that indicates whether or not the user can expand and collapse nodes in the TreeTable.
footerHorizSeparatorfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
true"1px solid #a0a0a0"A style for a line that separates the footer section from the body section. Should be specified as the CSS "border" property but without the prefix "border:".
footerRowClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the column footer row.
footerRowStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the column footer row.
footerSectionClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the TreeTable footer section.
footerSectionStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the TreeTable footer section.
footerVertSeparatorfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
true"none, 1px solid #a0a0a0"A style for vertical lines between column footers. Should be specified as the CSS "border" property but without the prefix "border:". It can also be specified as a list of comma-separated gridline styles when column groups are used and group separators should be different from column separators. See verticalGridLines attribute for details.
headerHorizSeparatorfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
true"1px solid #a0a0a0"A style for a line that separates the header section from the body section. Should be specified as the CSS "border" property but without the prefix "border:".
headerRowClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the column header row.
headerRowStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the column header row.
headerSectionClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the TreeTable header section.
headerSectionStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the TreeTable header section.
headerVertSeparatorfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
true"none, 1px solid #a0a0a0"A style for vertical lines between column headers. Should be specified as the CSS "border" property but without the prefix "border:". It can also be specified as a list of comma-separated gridline styles when column groups are used and group separators should be different from column separators. See verticalGridLines attribute for details.
horizontalGridLinesfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
true"1px solid #e0e0e0"A style for horizontal lines in the TreeTable body. Should be specified as the CSS "border" property but without the prefix "border:".
idfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
falsenullThe component identifier.
multiFooterSeparatorfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
true"none, 1px solid #a0a0a0"A style for a line that separates multiple footer rows when column groups are used. It can also be specified as a list of comma-separated gridline styles when there are multiple levels of nested column groups.
multiHeaderSeparatorfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
true"none, 1px solid #a0a0a0"A style for a line that separates multiple header rows when column groups are used. It can also be specified as a list of comma-separated gridline styles when there are multiple levels of nested column groups.
noDataMessageAllowedfalsejavax.el.ValueExpression
(must evaluate to boolean)
truetrueA flag that indicates whether or not to show a message when there is no data to show.
noDataRowClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the row that displays a message when there is no data to show.
noDataRowStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the row that displays a message when there is no data to show.
nodeHasChildrenVarfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
falsenullThe name of a boolean request-scope variable under which the flag that indicates whether a node has children is available.
nodeLevelVarfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
falsenullThe name of an Integer request-scope variable under which the level number of the current node is available, where "0" corresponds to the topmost level.
nodePathVarfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
falsenullThe name of a request-scope variable under which the full path of a node for the current node is available. This variable has the org.openfaces.component.table.TreePath type. Instances of the TreePath class are used to reference a node in the tree structure by its node value and node values of all its parent nodes.
nonEmptyRecordsFilterTextfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
true"<Non-empty>"The text that is displayed instead of "" in the "comboBox" or "dropDownField" when filtering is used.
onblurfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed when the TreeTable loses focus.
onclickfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed on the client when the user clicks the left mouse button over the TreeTable.
oncontextmenufalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed when the user presses right mouse button over the component (or performs the other context menu invocation action depending on the platform).
ondblclickfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed on the client when the user double-clicks the left mouse button over the TreeTable.
onfocusfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed when the TreeTable receives focus.
onkeydownfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed when the user presses a key over the TreeTable.
onkeypressfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed on the client when the user presses and releases a key over the TreeTable.
onkeyupfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed when the user releases a key over the TreeTable.
onmousedownfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed when the user clicks over the TreeTable with either mouse button.
onmousemovefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed when the user moves the mouse pointer over the TreeTable.
onmouseoutfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed when the user moves the mouse pointer away from the TreeTable.
onmouseoverfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed when the user moves the mouse pointer onto the TreeTable.
onmouseupfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed when the user releases the mouse button over the TreeTable.
preloadedNodesfalsejavax.el.ValueExpression
(must evaluate to org.openfaces.component.table.PreloadedNodes)
true"none"Defines whether child nodes of collapsed nodes are preloaded to the client. When a collapsed node whose child nodes are preloaded is expanded by the user, these nodes are shown immediately without any server request being sent.
Available values are:
"none" — no children of collapsed nodes are preloaded
"all" — all children of collapsed nodes at all levels are preloaded. So the entire TreeTable can be browsed without any requests to the server
"levelsPreloaded:NUMBER" — where NUMBER is a positive integer number. It specifies the total number of node levels, starting from the top-most one, in which the nodes are preloaded. For example, preloadedNodes="levelsPreloaded:2" means that only root nodes and their immediate children are preloaded
renderedfalsejavax.el.ValueExpression
(must evaluate to boolean)
truetrueA flag that indicates whether or not the component is visible.
rolloverClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the TreeTable component in the rollover state.
rolloverRowClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for a TreeTable row in the rollover state.
rolloverRowStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for a TreeTable row in the rollover state.
rolloverStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the TreeTable component in the rollover state.
rulesfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
true"none"Specifies what gridlines are displayed between the cells within the TreeTable.
Available values are:
"all" — between all rows and columns
"cols" — between columns only
"groups" — between row groups and column groups only
"none" — no grid lines
"rows" — between rows only
sortableHeaderClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name that is applied to the header of a sortable column.
sortableHeaderRolloverClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name that is applied to the header of a sortable column in the rollover state.
sortableHeaderRolloverStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style that is applied to the header of a sortable column in the rollover state.
sortableHeaderStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style that is applied to the header of a sortable column.
sortAscendingfalsejavax.el.ValueExpression
(must evaluate to boolean)
truetrueThe sorting order of the data in the TreeTable component. The "true" value means the table is sorted in ascending order.
sortColumnIdfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullID of the column by which the TreeTable is sorted.
sortedAscendingImageUrlfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullURL to the image file that is used to render the image that displays the ascending sort direction.
sortedColumnBodyClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for a sorted column's body.
sortedColumnBodyStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for a sorted column's body.
sortedColumnClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the entire sorted column.
sortedColumnFooterClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for a sorted column's footer.
sortedColumnFooterStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for a sorted column's footer.
sortedColumnHeaderClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for a sorted column's header.
sortedColumnHeaderStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for a sorted column's header.
sortedColumnStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the entire sorted column.
sortedDescendingImageUrlfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullURL to the image file that is used to render the image that displays the descending sort direction.
sortLevelfalsejavax.el.ValueExpression
(must evaluate to int)
true-1The level at which to perform sorting. The value "-1" means that sorting is applied to all levels of the hierarchy. When set to "0" (topmost level) or greater, sorting in the TreeTable is restricted to only one specified level.
stylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the entire TreeTable component.
styleClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the entire TreeTable component.
subHeaderRowClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the sub-header row (usually contains the filter components).
subHeaderRowSeparatorfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the line that separates the sub-header row.
subHeaderRowStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the sub-header row (usually contains the filter components).
tabindexfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullSpecifies a numeric value that defines input focus traversing order for this component.
textClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullThis attribute should be used instead of the "styleClass" attribute for specifying text-related styles (font, color, text-alignment etc.) Only the text-related styles can be configured using this attribute.
textStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullThis attribute should be used instead of the "style" attribute for specifying text-related styles (font, color, text-alignment etc.) Only the text-related styles can be configured using this attribute.
useAjaxfalsejavax.el.ValueExpression
(must evaluate to boolean)
truetrueA flag that indicates whether or not to use Ajax for sorting, filtering and node expansion.
varfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
falsenullThe name of a request-scope variable under which the current row data is available when specifying the columns.
verticalGridLinesfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
true"none, 1px solid #e0e0e0"A style for vertical lines in the TreeTable body. Should be specified as the CSS "border" property but without the prefix "border:". This attribute can also accept the comma-separated list of similarly-formatted gridline styles for specifying separators between different levels of column groups. The first item in this list corresponds to separators between the columns, the second one specifies styles for separators between group separators, and so on if more separators are required in case of a deeper hierarchy of column groups.
widthfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullThe width of the TreeTable component. Can be specified in any units (px, mm, em, etc.).

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.