q
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 QuipuKit DataTable component. Child tags: treeColumn, staticTreeStructure, dynamicTreeStructure column, selectionColumn, checkboxColumn, singleNodeSelection, multipleNodeSelection, cellStyle, rowStyle.


Tag Information
Tag Classteamdev.jsf.taglib.TreeTableJspTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredBinding TypeELDefaultDescription
alignfalsejava.lang.StringtruenullThe alignment of the table content.
Available values are:
"left"
"center"
"right"
allRecordsFilterNamefalsejava.lang.Stringtrue"<All>"The text that is displayed instead of "" in the "comboBox" or "dropDownField" when filtering is used.
applyDefaultStylefalsebooleantruetrueA flag that indicates whether or not to apply the default style.
bgcolorfalsejava.lang.StringtruenullThe background color behind the table content.
bindingfalseteamdev.jsf.component.treetable.TreeTableonlynullA value-binding expression that associates the TreeTable with a backing bean property.
bodyOddRowClassfalsejava.lang.StringtruenullA CSS class name for TreeTable odd rows, if it should be different from bodyRowClass.
bodyOddRowStylefalsejava.lang.StringtruenullA style for TreeTable odd rows, if it should be different from bodyRowStyle.
bodyRowClassfalsejava.lang.StringtruenullA CSS class name for TreeTable rows.
bodyRowStylefalsejava.lang.StringtruenullA style for TreeTable rows.
bodySectionClassfalsejava.lang.StringtruenullA CSS class name for the TreeTable body section.
bodySectionStylefalsejava.lang.StringtruenullA style for the TreeTable body section.
borderfalseinttrueInteger.MIN_VALUEThe number of pixels in the TreeTable border. The value Integer.MIN_VALUE means there is no border rendered.
cellpaddingfalsejava.lang.StringtruenullThe amount of space between the border of the cell and its content. The value null means there is no cell spacing rendered.
cellspacingfalsejava.lang.StringtruenullThe amount of space between cells in the TreeTable. The value null means there is no cell spacing rendered.
columnIdVarfalsejava.lang.StringfalsenullThe 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.
columnIndexVarfalsejava.lang.StringfalsenullThe name of a request-scope variable under which a column index is available. It is a zero-based integer number.
columnsOrderfalsejava.util.ListonlynullThe 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.
commonFooterRowClassfalsejava.lang.StringtruenullA CSS class name for the TreeTable footer row.
commonFooterRowStylefalsejava.lang.StringtruenullA style for the TreeTable footer row.
commonFooterSeparatorfalsejava.lang.StringtruenullA 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:".
commonHeaderRowClassfalsejava.lang.StringtruenullA CSS class name for the TreeTable header row.
commonHeaderRowStylefalsejava.lang.StringtruenullA style for the TreeTable header row.
commonHeaderSeparatorfalsejava.lang.StringtruenullA 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:".
dirfalsejava.lang.Stringtrue"ltr"The reading order of the table columns and content.
Available values are:
"ltr" — left to right
"rtl" — right to left
emptyRecordsFilterNamefalsejava.lang.Stringtrue"<Empty>"The text that is displayed instead of "" in the "comboBox" or "dropDownField" when filtering is used.
expansionStatefalseteamdev.jsf.component.treetable.ExpansionStatefalse"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
filterAcceptedRowClassfalsejava.lang.StringtruenullA CSS class name for the nodes that satisfy the filter criteria.
filterAcceptedRowStylefalsejava.lang.StringtruenullA style for the nodes that satisfy the filter criteria.
filterRowClassfalsejava.lang.StringtruenullA CSS class name for the row that contains the filter components.
filterRowSeparatorfalsejava.lang.StringtruenullA style for the line that separates the filter row and the column header.
filterRowStylefalsejava.lang.StringtruenullA style for the row that contains the filter components.
filterSubsidiaryRowClassfalsejava.lang.StringtruenullA CSS class name for the nodes that do not satisfy the filter criteria but are needed to keep the hierarchy visible.
filterSubsidiaryRowStylefalsejava.lang.StringtruenullA style for the nodes that do not satisfy the filter criteria but are needed to keep the hierarchy visible.
focusedClassfalsejava.lang.StringtruenullA CSS class name of the TreeTable component when it is focused.
focusedStylefalsejava.lang.StringtruenullA style of the TreeTable component when it is focused.
foldingEnabledfalsebooleantruetrueA flag that indicates whether or not the user can expand and collapse nodes in the TreeTable.
footerHorizSeparatorfalsejava.lang.StringtruenullA style a line that separates the footer section from the body section. Should be specified as the CSS "border" property but without the prefix "border:".
footerRowClassfalsejava.lang.StringtruenullA CSS class name for the column footer row.
footerRowStylefalsejava.lang.StringtruenullA style for the column footer row.
footerSectionClassfalsejava.lang.StringtruenullA CSS class name for the TreeTable footer section.
footerSectionStylefalsejava.lang.StringtruenullA style for the TreeTable footer section.
footerVertSeparatorfalsejava.lang.StringtruenullA style for vertical lines between column footers. Should be specified as the CSS "border" property but without the prefix "border:".
headerHorizSeparatorfalsejava.lang.StringtruenullA style a line that separates the header section from the body section. Should be specified as the CSS "border" property but without the prefix "border:".
headerRowClassfalsejava.lang.StringtruenullA CSS class name for the column header row.
headerRowStylefalsejava.lang.StringtruenullA style for the column header row.
headerSectionClassfalsejava.lang.StringtruenullA CSS class name for the TreeTable header section.
headerSectionStylefalsejava.lang.StringtruenullA style for the TreeTable header section.
headerVertSeparatorfalsejava.lang.StringtruenullA style for vertical lines between column headers. Should be specified as the CSS "border" property but without the prefix "border:".
horizontalGridLinesfalsejava.lang.StringtruenullA style for horizontal lines in the TreeTable body. Should be specified as the CSS "border" property but without the prefix "border:".
idfalsejava.lang.StringfalsenullThe component identifier.
noDataMessageAllowedfalsebooleantruetrueA flag that indicates whether or not to show a message when there is no data to show.
noDataRowClassfalsejava.lang.StringtruenullA CSS class name for the row that displays a message when there is no data to show.
noDataRowStylefalsejava.lang.StringtruenullA style for the row that displays a message when there is no data to show.
nodeHasChildrenVarfalsejava.lang.StringfalsenullThe name of a boolean request-scope variable under which the flag that indicates whether a node has children is available.
nodeLevelVarfalsejava.lang.StringfalsenullThe 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.
nodePathVarfalsejava.lang.StringfalsenullThe name of a request-scope variable under which the full path of a node for the current node is available. This variable has the teamdev.jsf.component.treetable.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.
nonEmptyRecordsFilterNamefalsejava.lang.Stringtrue"<Non-empty>"The text that is displayed instead of "" in the "comboBox" or "dropDownField" when filtering is used.
onblurfalsejava.lang.StringtruenullJavaScript code that should be executed when the TreeTable loses focus.
onclickfalsejava.lang.StringtruenullJavaScript code that should be executed on the client when the user clicks the left mouse button over the TreeTable.
ondblclickfalsejava.lang.StringtruenullJavaScript code that should be executed on the client when the user double-clicks the left mouse button over the TreeTable.
onfocusfalsejava.lang.StringtruenullJavaScript code that should be executed when the TreeTable receives focus.
onkeydownfalsejava.lang.StringtruenullJavaScript code that should be executed when the user presses a key over the TreeTable.
onkeypressfalsejava.lang.StringtruenullJavaScript code that should be executed on the client when the user presses and releases a key over the TreeTable.
onkeyupfalsejava.lang.StringtruenullJavaScript code that should be executed when the user releases a key over the TreeTable.
onmousedownfalsejava.lang.StringtruenullJavaScript code that should be executed when the user clicks over the TreeTable with either mouse button.
onmousemovefalsejava.lang.StringtruenullJavaScript code that should be executed when the user moves the mouse pointer over the TreeTable.
onmouseoutfalsejava.lang.StringtruenullJavaScript code that should be executed when the user moves the mouse pointer away from the TreeTable.
onmouseoverfalsejava.lang.StringtruenullJavaScript code that should be executed when the user moves the mouse pointer onto the TreeTable.
onmouseupfalsejava.lang.StringtruenullJavaScript code that should be executed when the user releases the mouse button over the TreeTable.
preloadedNodesfalseteamdev.jsf.component.treetable.PreloadedNodestrue"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 will be shown immediately without any server request being sent.
Available values are:
"none" — no children of collapsed nodes will be preloaded
"all" — all children of collapsed nodes at all levels will be 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 will be preloaded. For example, preloadedNodes="levelsPreloaded:2" means that only root nodes and their immediate children are preloaded
renderedfalsebooleantruetrueA flag that indicates whether or not the component is visible.
rolloverClassfalsejava.lang.StringtruenullA CSS class name for the TreeTable component in the rollover state.
rolloverRowClassfalsejava.lang.StringtruenullA CSS class name for a TreeTable row in the rollover state.
rolloverRowStylefalsejava.lang.StringtruenullA style for a TreeTable row in the rollover state.
rolloverStylefalsejava.lang.StringtruenullA style for the TreeTable component in the rollover state.
rowOnclickfalsejava.lang.StringtruenullJavaScript code that should be executed on the client when the user clicks the left mouse button over a TreeTable row.
rowOndblclickfalsejava.lang.StringtruenullJavaScript code that should be executed on the client when the user double-clicks the left mouse button over a TreeTable row.
rowOnmousedownfalsejava.lang.StringtruenullJavaScript code that should be executed when the user clicks over a TreeTable row with either mouse button.
rowOnmousemovefalsejava.lang.StringtruenullJavaScript code that should be executed when the user moves the mouse pointer over a TreeTable row.
rowOnmouseoutfalsejava.lang.StringtruenullJavaScript code that should be executed when the user moves the mouse pointer away from a TreeTable row.
rowOnmouseoverfalsejava.lang.StringtruenullJavaScript code that should be executed when the user moves the mouse pointer onto a TreeTable row.
rowOnmouseupfalsejava.lang.StringtruenullJavaScript code that should be executed when the user releases the mouse button over a TreeTable row.
rulesfalsejava.lang.Stringtrue"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
sortAscendingfalsebooleantruenullThe sort order of the data when the TreeTable component is loaded for the first time. The "true" value means the table is sorted in ascending order.
sortColumnIdfalsejava.lang.StringtruenullID of the column by which to sort the TreeTable component when it is loaded for the first time.
sortedAscendingImageUrlfalsejava.lang.StringtruenullNo Description
sortedColumnBodyClassfalsejava.lang.StringtruenullA CSS class name for a sorted column's body.
sortedColumnBodyStylefalsejava.lang.StringtruenullA style for a sorted column's body.
sortedColumnClassfalsejava.lang.StringtruenullA CSS class name for the entire sorted column.
sortedColumnFooterClassfalsejava.lang.StringtruenullA CSS class name for a sorted column's footer.
sortedColumnFooterStylefalsejava.lang.StringtruenullA style for a sorted column's footer.
sortedColumnHeaderClassfalsejava.lang.StringtruenullA CSS class name for a sorted column's header.
sortedColumnHeaderStylefalsejava.lang.StringtruenullA style for a sorted column's header.
sortedColumnStylefalsejava.lang.StringtruenullA style for the entire sorted column.
sortedDescendingImageUrlfalsejava.lang.StringtruenullNo Description
sortLevelfalseinttrue-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.
stylefalsejava.lang.StringtruenullA style for the entire TreeTable component.
styleClassfalsejava.lang.StringtruenullA CSS class name for the entire TreeTable component.
textClassfalsejava.lang.StringtruenullThis 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.
textStylefalsejava.lang.StringtruenullThis 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.
useAjaxfalsebooleantruetrueA flag that indicates whether or not to use Ajax for sorting, filtering and node expansion.
varfalsejava.lang.StringfalsenullThe name of a request-scope variable under which the current row data is available when specifying the columns.
verticalGridLinesfalsejava.lang.StringtruenullA style for vertical lines in the TreeTable body. Should be specified as the CSS "border" property but without the prefix "border:".
widthfalsejava.lang.StringtruenullThe 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.