Oracle Fusion Middleware Tag Reference for Oracle ADF Faces
11g Release 1 (11.1.1.7.0)
E12419-09

<af:treeTable>

UIComponent class: oracle.adf.view.rich.component.rich.data.RichTreeTable
Component type: oracle.adf.RichTreeTable

Naming container: Yes. When referring to children of this component ("partialTriggers", findComponent(), etc.), you must prefix the child's ID with this component's ID and a colon (':')

The TreeTable is used to display data that is structured in a hierarchical format. This component displays a hierarchy in a UI similar to a Table, and is more elaborate than the Tree component. TreeTable supports displaying columns of data per tree node in the hierarchy. The features of the TreeTable include mechanisms for focusing in on subtrees (within the main tree), as well as expanding and collapsing elements in the hierarchy.

Tree Model

The TreeTable component uses a model to access the underlying hierarchical data. The specific model class is org.apache.myfaces.trinidad.model.TreeModel. There is a utility class available that wraps a Java List of beans or maps in an implementation of the org.apache.myfaces.trinidad.model.TreeModel (See org.apache.myfaces.trinidad.model.ChildPropertyTreeModel).

Columns

Like the Table, the TreeTable's children must be Column components (see Table Columns). Like the Tree, the TreeTable has a "nodeStamp" facet which renders the "Object Name" Column. The "Object Name" Column contains the primary identifier of an element in the hierarchy. For example, in an organization chart of employees, the "Object Name" Column might be the employee name.

Sorting

See Table Sorting. Unlike the Table, the TreeTable does not support automatic sorting. The underlying TreeModel must support sorting by implementing it's sorting logic in the setSortCriteria(List criteria) method of the TreeModel.

Fetch Size

See Table Fetch Size.

CSS Style Restriction

See Table CSS Style Restrictions.

Hierachical Selector

See Tree Hierachical Selector.

Attachment Mode

The treeTable is rendered with all nodes expanded. The menu items "Expand/Collapse All", "Expand/Collapse All Below" and "Show As Top" are not rendered.

Geometry Management

This component can be stretched by a parent layout component that stretches its children, e.g. panelStretchLayout, panelSplitter.
When stretching this component, the only valid setting for autoHeightRows is "-1" (a value of 0 will be treated as -1 when stretched).
When NOT stretched, autoHeightRows="0" can be used to size the height to the fetch size, which is similar to dimensionsFrom="children". Please refer to 'autoHeightRows' attribute for more information.
Use the columnStretching attribute to configure stretching of the children column components.

If the oracle.adf.view.rich.geometry.DEFAULT_DIMENSIONS context-param is set to "auto" in the project's web.xml, and the autoHeightRows value is set to 0, or is not set, the AFStretchWidth style class will be rendered for this component.

Code Example(s)

<af:treeTable var="node" value="#{myBean.orgChart.root}">
  <f:facet name="nodeStamp">
    <af:column>
      <f:facet name="header">
        <af:outputText value="Employee Name"/>
      </f:facet>
      <af:outputText value="#{node.ename}"/>
    </af:column>
  </f:facet>
  <af:column>
    <f:facet name="header">
      <af:outputText value="Employee Id"/>
    </f:facet>
    <af:outputText value="#{node.empid}"/>
  </af:column>
  <af:column>
    <f:facet name="header">
      <af:outputText value="Department"/>
    </f:facet>
    <af:outputText value="#{node.dname}"/>
  </af:column>
</af:treeTable>

Events

Type	Phases	Description
oracle.adf.view.rich.event.ColumnSelectionEvent	Invoke Application	The ColumnSelectionEvent is delivered when a column selection change occurs in Table or TreeTable.
org.apache.myfaces.trinidad.event.RowDisclosureEvent	Apply Request Values, Invoke Application	The expansion event is generated for a table when the detail facet of a row is expanded or collapsed. For tree or a treeTable, the expansion event is generated when tree nodes are expanded or collapsed.
org.apache.myfaces.trinidad.event.SelectionEvent	Apply Request Values, Invoke Application	The selection event is delivered when the table selection changes.
org.apache.myfaces.trinidad.event.FocusEvent	Apply Request Values, Invoke Application	Event delivered when user clicks to focus on (or zoom into) a particular element's subtree of children. The TreeTable responds to this event by modifying the "focusPath" property appropriately. Subsequently, any registered FocusListener instances are called.
org.apache.myfaces.trinidad.event.AttributeChangeEvent	Invoke Application, Apply Request Values	Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.

Supported Facets

Name	Description
bodyContextMenu	popup component containing the context menu that will be shown on right click within the table body, but outside of any table row. The af:popup must contain an af:menu to display the context menu
contextMenu	popup component containing the context menu that will be shown on right click of any table row. The af:popup must contain an af:menu to display the context menu. Note that the contextMenu facet does not currently support a popup with the childCreation attribute set to deferred.
footer	the component used to render the table footer. This facet existed in 10.1.3, but is currently not supported in RichTable and RichTreeTable
header	the component used to render the table header. This facet existed in 10.1.3, but is currently not supported in RichTable and RichTreeTable
nodeStamp	the component to use to stamp each element in the tree. Only certain types of components are supported, including all components with no behavior and most components that implement the EditableValueHolder or ActionSource interfaces. In a treeTable, this must be a column.
pathStamp	the component used to stamp each step of the focus path when the Hierachical Selector popup is displayed. This component can be a a combination of simple outputText, image, or outputFormatted tags and must not be an "input" component (EditableValueHolder) since no user input is allowed in the Hierarchical Selector popup. If this facet is not provided, then the Hierarchical Selector icon is not rendered.

Attributes

Name	Type	Supports EL?	Description
activeRowKey	Object	Yes	this is the row that is currently active on the client. In click-to-edit mode, the active row will be made editable and is brought into view (if not already visible). Upon initial display, the click-to-edit component defaults the active row to the first visible row.
attributeChangeListener	javax.el.MethodExpression	Only EL	a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
autoHeightRows	int	Yes	The number of rows used to size the component height. If the oracle.adf.view.rich.geometry.DEFAULT_DIMENSIONS context-param is set to "auto" in the project's web.xml, the default value for this attribute will be 0. Otherwise, the default value will be -1 (no auto-sizing for any number of rows). The height of the component can grow to a maximum of 'autoHeightRows' after which a scrollbar is displayed. This attribute is also supported when the component is inside PanelCollection. A value of 0 can be used to default the autoHeightRows to the current fetchSize. 'autoHeightRows' value cannot be larger than "fetchSize" attribute. If a value larger than fetchSize is specified, the value is capped at the fetchSize. If a value larger than the number of rows is specified, the number of rows in the component is used to size the component height. 'autoHeightRows' works with contentDelivery=immediate/lazy/whenAvailable. 'autoHeightRows' attribute has no effect in screen reader mode. Note that specifying a CSS "height" in the "inlineStyle" attribute will have no effect and will get overriden by the auto-sized height. Specifying CSS "min-height" and "max-height" values in the "inlineStyle" attribute is not recommended and is incompatible with the autoHeightRows attribute. When the component is placed in a layout-managing container, such as panelSplitter, it will be sized by the container (no auto-sizing will occur). Not supported on the following renderkits: org.apache.myfaces.trinidad.core
binding	oracle.adf.view.rich.component.rich.data.RichTreeTable	Only EL	an EL reference that will store the component instance on a bean. This can be used to give programmatic access to a component from a backing bean, or to move creation of the component to a backing bean.
blockRowNavigationOnError	String	Yes	Valid Values: always, never, auto Whether we want to block row navigation in case of validation failure. This is when you select a row and do some editing inside the table or in a related form, and this editing causes some validation failures. At this time, if you click on a different row in table, we want to block you from moving to the new row. possible values are: always, never and auto. default value is auto. always means we block the row navigation never means we don't block and let the row navigation happen auto means the framework will make the decision
bodyContextMenuId	String	Yes	A search expression to identify the popup component containing the context menu that will be shown within the table body, for clicks outside of any table row. Expressions are relative to this table component and must account for NamingContainers (for example, table and panelCollection are NamingContainer components). You can prepend a single colon to start the search from the root, or multiple colons to move up through the NamingContainers. For example, a leading "::" will pop out of one NamingContainer (including the component itself if it is a naming container, like table) and begin search from there, ":::" will pop out of two NamingContainers and begin search from there, etc. Not supported on the following renderkits: org.apache.myfaces.trinidad.core
clientComponent	boolean	Yes	whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.
columnBandingInterval	int	Yes	the interval between which the column banding occurs. This value controls the display of the column banding in the table. For e.g, columnBandingInterval=1 would display alternately banded columns in the Grid.
columnResizing	String	Yes	Valid Values: enabled, disabled Setting this value to "disabled" will turn off user column resizing. The default is "enabled". Not supported on the following renderkits: org.apache.myfaces.trinidad.core
columnSelection	String	Yes	Valid Values: none, single, multiple whether columns in this table are selectable. Not supported on the following renderkits: org.apache.myfaces.trinidad.core
columnSelectionListener	javax.el.MethodExpression	Only EL	a method reference to a ColumnSelectionListener
columnStretching	String	Yes	Indicates what kind of stretching you want applied to the columns. For optimal performance, use the "none" (default) option. If you want the last column to stretch to fill up any unused space inside of the viewport, use the "last" option. If you want to have an empty blank column be automatically inserted and have it stretch (so the row background colors will span the entire width of the table), use the "blank" option. If you want to have a specific leaf (non-group) column stretch to fill up any unused space inside of the viewport, use the option where you specify "column:" followed by the ID of the column that you want to have stretched, e.g. "column:myColId". If you want more than one column stretched, use the "multiple" option. When the "multiple" option is used you can set the widths in the columns (non-group) to be percentages. See the column documentation for how percentages are handled. Note that row headers and frozen columns will not be stretched because doing so could easily leave the user unable to access the scrollable data body of the table. Not supported on the following renderkits: org.apache.myfaces.trinidad.core
contentDelivery	String	Yes	Valid Values: immediate, lazy, whenAvailable whether data should be fetched when the component is rendered initially. When contentDelivery is "immediate", data is fetched and inlined into the component chrome. If contentDelivery is "lazy", data will be fetched and delivered to the client during a subsequent request. If contentDelivery is set to "whenAvailable", upon initial rendering, the renderer queries the model for available data. Data is fetched and rendered immediately if model indicates that data is available. So contentDelivery="whenAvailable" behaves like "immediate" if data is available upon initial rendering.
contextMenuId	String	Yes	A search expression to identify the popup component containing the context menu that will be shown on right click of any table row. Expressions are relative to this table component and must account for NamingContainers (for example, table and panelCollection are NamingContainer components). You can prepend a single colon to start the search from the root, or multiple colons to move up through the NamingContainers. For example, a leading "::" will pop out of one NamingContainer (including the component itself if it is a naming container, like table) and begin search from there, ":::" will pop out of two NamingContainers and begin search from there, etc. Not supported on the following renderkits: org.apache.myfaces.trinidad.core
contextMenuSelect	boolean	Yes	Indicates if we should actually select the row clicked when right clicking to show a context menu. By default the row is selected before the context menu is displayed. However if contextMenuSelect="false", and if user right clicks a row, the new row is highlighted and the highlighting for the currently selected row(s) is cleared when the context menus is displayed. The highlighting of the currently selected row(s) is restored after the context menu is dismissed. It should be noted that when the context menu is displayed, the attribute selectedRowKeys still contains the selected row(s). The highlighted row key is established as a currency in the table when the action for context menu item is executed. The currency in the table can be retrieved by calling "table.getRowKey()".
customizationId	String	Yes	This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
disableColumnReordering	boolean	Yes	whether column reordering is disabled in the table. Column reordering is on by default. Not supported on the following renderkits: org.apache.myfaces.trinidad.core
disclosedRowKeys	org.apache.myfaces.trinidad.model.RowKeySet	Yes	the set of disclosed rows for this component. Each entry in the set is a rowKey.
displayRow	String	Yes	Valid Values: first, last, selected the row to display in the table during initial display. The possible values are "first" to display the first row, "last" to display the last row and "selected" to display the first selected row in the table. The default value for this is null which means that the first row is displayed. Please note that this API will have no effect if the total number of rows are not known from the table model (model.getRowCount()==-1).
displayRowKey	Object	Yes	the rowkey to display in the table during intial display. Specifying this attribute will override the displayRow attribute. Please note that this API will have no effect if the total number of rows are not known from the table model (model.getRowCount()==-1).
editingMode	String	Yes	Valid Values: editAll, clickToEdit Indicates the mode used to edit the table when it contains editable components. The possible values are "clickToEdit" and "editAll". In "editAll" mode all the editable components are displayed at a time in the table view area. In "clickToEdit" mode a single row is editable at a time. The following is the behavior: Stay in edit mode: If in edit mode, stay in edit mode when a read/only cell is reached via keyboard navigation. Enter key navigation: When in edit mode, ensure that pressing Enter or Shift+Enter navigates to the adjacent cell when possible. Esc key reverts cell edits: When in edit mode, pressing the Esc key reverts all edits made to cells in a row and disables edit mode. (NEW) Navigation pattern recognition: Using the Tab and Enter keys to navigate in edit mode establishes a row-wise navigation pattern that is repeated in adjacent rows. Input Field Text Selection: When a cell contains an input text field widget, the text is selected automatically when the widget has focus. In "clickToEdit" mode, quick row navigation is supported with arrow up/down key by changing to read-only mode with Esc key. Hitting F2 or Enter key changes the row back to edit mode with focus on the column that was previously focused. Here is how it works by clicking the following keys: Esc Key When the edit navigation focus is within an input component and hitting Esc, reverts the cell back to its original value. Navigation focus is at the cell level to enable navigation between cells. Then if Esc key is hit again, the row goes into read only mode. When it is in edit mode and the cell has focus, hitting Esc changes the row directly into read only mode. Once focused row is in read-only mode, user can use the arrow up/down key to quickly navigate between rows. F2 Key When in read only mode and F2 key is clicked, it takes the user into edit mode. Hitting F2 again will turn off cell navigation mode so that user can navigate within cell or input component. Enter Key When in read only mode and the user hits enter key, it changes to edit mode and the focus is on the previously focused column.
emptyText	String	Yes	the text of an empty table. If the text is enclosed in an open and closing html tag, it will be formatted. The formatting behavior is similar to outputFormatted component. If it is not enclosed in an open and closing html tag, it will not be formatted.
expandAllEnabled	boolean	Yes	Indicates whether the "Expand/Collapse All", and "Expand/Collapse All Below" menu items are rendered. These menu items are rendered by default.
fetchSize	int	Yes	the number of rows in the data fetch block Not supported on the following renderkits: org.apache.myfaces.trinidad.core
focusListener	javax.el.MethodExpression	Only EL	a method reference to a focus listener
focusRowKey	Object	Yes	the rowKey of the currently focused row. The rowKeys of the ancestor rows of the focus row are added to the expandedRowKeys RowKeySet by default.
freezeDirection	String	Yes	Valid Values: start, end How column freezing is handled, whether the freezing zone is from the specified column to the start or the end of the table row. Default value is start Not supported on the following renderkits: org.apache.myfaces.trinidad.core
horizontalGridVisible	boolean	Yes	whether the Horizontal GridLines are to be drawn.
id	String	No	the identifier for the component. The identifier must follow a subset of the syntax allowed in HTML: Must not be a zero-length String. First character must be an ASCII letter (A-Za-z) or an underscore ('_'). Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').
immediate	boolean	Yes	whether or not data validation - client-side or server-side - should take place when events are generated by this component. When immediate is true, the default ActionListener provided by the JavaServer Faces implementation should be executed during Apply Request Values phase of the request processing lifecycle, rather than waiting until the Invoke Application phase.
initiallyExpanded	boolean	Yes	If upon initial rendering, the current subtree under the focused row path should be expanded. A RowDisclosureEvent is broadcast from the encode begin of the component so that listeners are properly notified of the disclosure.
inlineStyle	String	Yes	the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.
partialTriggers	String[]	Yes	the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.
rangeChangeListener	javax.el.MethodExpression	Only EL	a method reference to a rangeChange listener that will be called when a new range is selected.
rendered	boolean	Yes	whether the component is rendered. When set to false, no output will be delivered for this component (the component will not in any way be rendered, and cannot be made visible on the client). If you want to change a component's rendered attribute from false to true using PPR, set the partialTrigger attribute of its parent component so the parent refreshes and in turn will render this component.
rootNodeRendered	boolean	Yes	If the root node should be rendered or not. Defaults to true.
rowBandingInterval	int	Yes	the interval between which the row banding occurs. This value controls the display of the row banding in the table. For e.g, rowBandingInterval=1 would display alternately banded rows in the Grid.
rowDisclosureListener	javax.el.MethodExpression	Only EL	a method reference to an ExpansionListener
rowSelection	String	Yes	Valid Values: none, single, multiple, multipleNoSelectAll whether rows in this table are selectable. If row selection is allowed, you need to make sure at least one column is set as a row header with rowHeader=true. Use the value "single" to enable single selection, "multiple" to enable multiple selection and "multipleNoSelectAll" to enable multiple selection but disable the user from doing select all.
rowsByDepth	int[]	Yes	the maximum number of records that can be displayed at one time (range size). Each level of depth in the tree can have a different range size. The first number in the array sets the range size for the root collection. Each subsequent number sets the range size for the corresponding depth. The last number becomes the default for each subsequent level of depth. If a node has more children than the range size, navigation rows will be rendered above and below the child nodes.
scrollPolicy	String	Yes	Valid Values: page, scroll, auto specifies the mechanism used to scroll the data inside the table. possible values are: auto(depends on your device), page, and scroll
selectedRowKeys	org.apache.myfaces.trinidad.model.RowKeySet	Yes	the selection state for this component.
selectionEventDelay	String	Yes	Valid Values: disabled, enabled whether or not it is enabled to delay row selection event for 300ms when a user navigates rows with arrow up/down key. When it is enabled, it can improve the performance by avoiding sending many events to server while a user keeps arrow up/down key down to navigate. It can have a vlue of enabled/disabled. The default value is disabled. Not supported on the following renderkits: org.apache.myfaces.trinidad.core
selectionListener	javax.el.MethodExpression	Only EL	a method reference to a selection listener
shortDesc	String	Yes	the short description of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.
styleClass	String	Yes	a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.
summary	String	Yes	the summary of this table's purpose and structure for user agents rendering to non-visual media.
unsecure	java.util.Set	Yes	A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute.
value	Object	Yes	the hierarchy of tree data - must be of type org.apache.myfaces.trinidad.model.TreeModel
var	String	No	Name of the EL variable used to reference each element of this collection. Once this component has completed rendering, this variable is removed (or reverted back to its previous value).
varStatus	String	No	Name of the EL variable used to reference the varStatus information. Once this component has completed rendering, this variable is removed (or reverted back to its previous value). The VarStatus provides contextual information about the state of the component to EL expressions. For components that iterate, varStatus also provides loop counter information. Please see the this component's documentation for the specific properties on the varStatus. The common properties on varStatus include: "model" - returns the CollectionModel for this component "index" - returns the zero based row index "hierarchicalIndex" - returns an array containing the row indices of heirarchy of the currrent row, for e.g. [0,1,2] Please use this attribute with caution since it requires moving currency to calculate the row index for each parent collection in the tree hierarchy. "hierarchicalLabel" - returns a string label representing the hierarchy of that row, for e.g. 1.1, 1.1.1. It should be noted that the labels are 1 based vs 0 based for rowIndex. Please use this attribute with caution since it requires moving currency to calculate the row index for each parent collection in the tree hierarchy.
verticalGridVisible	boolean	Yes	whether the vertical GridLines are to be drawn.
visible	boolean	Yes	the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property. Not supported on the following renderkits: org.apache.myfaces.trinidad.core
width	String	Yes	the width of this component. Default value is 300 PX