<af:table>

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 Table is used to display tabular data. It also supports row/column selection (both single and multiple), sorting, record navigation.

Table Model

The Table component uses a model to access the data in the underlying list. The specific model class is oracle.adf.view.rich.model.CollectionModel. You may also use other model instances, e.g., java.util.List, array, and javax.faces.model.DataModel. The Table will automatically convert the instance into a CollectionModel.

Columns

The immediate children of a Table component must all be <af:column> components. Each visibleColumn component creates a separate column in the Table. For more information see the documentation for <column>

Headers

Use the "header" facet on a Column to create the column header. You can also use the "headerText" attribute to set the column header text.

DetailStamp

Use the "detailStamp" facet on the Table to include a collapsable content area for each table row. Please note that the height of the open detail area will be a set height based on the height of the detailStamp component. Adding a component that changes in height (like showDetail or panelBox) will by default produce strange results when the detailStamp component's height changes.

Selection

The selection feature of a Table lets the user select one or more rows in the list. The user can then perform some operation on the selected rows by activating an appropriate ActionSource component (e.g., by clicking on an CommandButton). Use the "rowselection" attribute on the Table to enable the selection feature.

Grid Lines and Banding

By default, the table draws both horizontal and vertical grid lines. These may be independently turned off by setting the "horizontalGridVisible" and/or "verticalGridVisible" attributes to "false".

Banding is a technique where groups of rows (or columns) are displayed with alternating background colors. This helps to differentiate between adjacent groups of rows (or columns).

The "rowBandingInterval" attribute on the Table controls how many consecutive rows form a row group (for the purposes of banding). If this is "0" all rows will have the same background color. If this is a positive number then adjacent row groups will have different background colors.

The "columnBandingInterval" attribute on the Table controls how many columns form a column group (for the purposes of banding). If this is "0" all columns will have the same background color. If this is a positive number then adjacent column groups will have different background colors.

Column Groups

<af:column> tags can be nested to produce groups of columns. The header of a column group spans across all the columns it contains.

Sorting

The Table component supports sorting columns in ascending or descending order. The table displays up/down arrow icons in the column header for sortable columns. Clicking on the up arrow sorts the column in ascending order. Clicking on the down arrow sorts the column in descending order. The ctrl+shift+up-arrow/down-arrow shortcut keys are also available to sort a column in ascending/descending order using the keyboard. The table shows a previously sorted column with a filled-in up/down arrow icon to indicate the ascending/descending sort order.

There are three requirements to enable sorting: the underlying table model must support sorting, the "sortProperty" and "sortable" attributes must be set on the column to enable the sort capability for that column.

To support sorting, the CollectionModel instance must implement the following methods:

If the underlying model is not a CollectionModel, the Table automatically examines the actual data to determine which properties are sortable. Any column that has data that implements java.lang.Comparable is sortable. This automatic support cannot be nearly as efficient as coding sorting directly into a CollectionModel (for instance, by translating the sort into an "ORDER BY" SQL clause), but is sufficient for small data sets.

To associate a column with a particular property-name to be used for sorting purposes, use the "sortProperty" attribute on the column. To enable the UI for sorting a particular column, set the "sortable" property to true. For more information see the documentation for <column>.

In the following example, both columns are sortable. Sorting the first column sorts by the "firstname" property; sorting the second column sorts by the "lastname" property.

Fetch Size

The table/treeTable and tree components are virtualized. This means that not all the rows that are available for the component on the server are fetched and displayed on the client. The number of rows that are displayed on the client are just enough to fill the viewport. More rows are fetched as the user scrolls the component vertically.

"fetchSize" is the number of rows requested from the client to the server on each attempt to fill the component. So if the height of the table is small, the fetch size of 25 is sufficient to fill the component. However if the height of the component is large, there might be a need to request the data multiple times from the server. For example, if the height of the table is 600px and height of each row is 18px. You need at least 45 rows to fill the table. With a fetchSize of 25 the table has to make a request to the server 2 times to fill the table. So it is appropriate to set the fetchSize to 50.

CSS Style Restriction

"width:auto" inside inline style or style class is not supported.

"width" attribute value should not be "auto".

Attribute Notes

Examples of the "width" attribute: width="700" for 700 pixels, or width="100%" to fill up the entire width of the container. If no value is defined then the default will be 300 px.

The "rows" attribute is not currently supported for the rich renderer kit. Use inlineStyle to set the height of a table.

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.RangeChangeEvent

Apply Request Values,
Invoke Application

The range change event is delivered when the user navigates.

org.apache.myfaces.trinidad.event.SortEvent

Apply Request Values,
Invoke Application

The sort event is delivered when the table column sort criteria is changed.

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

detailStamp

the component to stamp below every row which is disclosed. Adding a detail facet will automatically cause the detail column to be displayed.

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

Attributes

Name

Type

Supports EL?

Description

allDetailsEnabled

boolean

Yes

whether or not to enable the show/hide all links above the table, which allow the user to show/hide all the detail rows. To enable the detail rows, a "detailStamp" facet must be set on this Table. This attribute existed in 10.1.3, but is currently not supported in RichTableNot supported on the following renderkits: oracle.adf.rich

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 table height. The default value is -1 (no auto-sizing for any number of rows). Table height auto-sizing is performed only when the contentDelivery property is set to immediate. This 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 table is used to size the table height. Note that specifying a CSS "height" in the "inlineStyle" attribute will override auto-sized height, while specifying CSS "min-height" and "max-height" values in the "inlineStyle" attribute will provide limits for auto-sizing results. When table 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.RichTable

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.

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.

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

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". 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. Only a maximum of one column may be stretched at a time.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. The CollectionModel must implement the "oracle.adf.view.rich.model.AsyncFetch" interface for "whenAvailable" contentDelivery to work. ADFm/BC4J - based CollectionModels implement this interface by default.

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 intial 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).

dontPersist

String[]

Yes

a list of attributes whose changes are NOT to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. The token 'ALL' can be used in the list here to indicate that all attribute changes that the component implicitly persists should be excluded. If there is a conflict of values, "dontPersist" always precedes "persist".

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 editable at a time. A row becomes editable by double clicking on it. If a user types F2, the currently selected row becomes editable. Typing Esc removes the user from editing mode. User can then navigate next/previous rows using tab, <shift>tab, or enter.

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.

fetchSize

int

Yes

the number of rows in the data fetch blockNot supported on the following renderkits: org.apache.myfaces.trinidad.core

filterModel

Object

Yes

the model used for filtering of data in the table. This attribute must be bound to an instance of FilterableQueryDescriptor class.

filterVisible

boolean

Yes

whether the filter fields are displayed on the top of the table.

first

int

Yes

the index of the first row in the currently range of rows. This index is zero-based. This attribute is used to control which range of rows to display to the user.

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.

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.

persist

String[]

Yes

a list of attributes whose changes are to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. The token 'ALL' can be used in the list here to indicate that all attribute changes that the component implicitly persists should be included.

queryListener

javax.faces.el.MethodBinding

Only EL

a method reference to a Querylistener

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.

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.

rows

int

Yes

the maximum number of rows to display in a single range of rows. Some ranges might have fewer than the number of rows specified by this attribute (eg: the last range might have an insufficient number of rows). To display all rows at once, set this attribute to 0. The default is 25.

selectedRowKeys

org.apache.myfaces.trinidad.model.RowKeySet

Yes

the selection state for this component.

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.

sortListener

javax.el.MethodExpression

Only EL

a method reference to a sort listener

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 data model being used by this component. The specific model class is org.apache.myfaces.trinidad.model.CollectionModel. You may also use other model instances, e.g., java.util.List , array, and javax.faces.model.DataModel. This component will automatically convert the instance into a CollectionModel.

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

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