Table is used to display tabular data. It also supports row/column selection (both single and multiple), sorting, record navigation. Table is not meant for use as a layout component of disparate information. For more information about this, see the Accessibility Guidelines section. <section name="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.

</section> <section name="Columns">

The immediate children of a Table component must all be <af:column> components. Each visibleColumn component creates a separate column in the Table. Because of this stamping behavior, some components may not work inside the column. Most components will work without problems, for example any input and output components. If you need to use multiple components inside a cell, you can wrap them inside a panelGroupLayout component. Components that themselves support stamping are not supported, such as tables within a table. For more information see the documentation for <column>

</section> <section name="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.

</section> <section name="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.

Detail Stamp can be selectively displayed for rows in the table by EL binding the "rendered" attribute of the "detailStamp" facet to "true" or "false". The EL binding can contain references to the table "var" attribute since during rendering it will be executed in the context of the row. Disclosure icon is displayed only for rows which have rendered="true".

Components that themselves support stamping are not supported within this facet of the table, such as table, treeTable, tree, region or carousel.

</section> <section name="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.

</section> <section name="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.

</section> <section name="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.

</section> <section name="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.

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.

</section> <section name="CSS_Style_Restriction">

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

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

</section> <section name="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 render kit. Use inlineStyle to set the height of a table.

</section> <section name="Emailable_and_Printable_Modes">

Note that when a collection is displayed in emailable or printable mode, only the collection rows currently present on the client will be included as part of the emailable or printable content. If you are looking for a way to provide all table rows, your best strategy is to provide an export data option for the collection (using an exportCollectionActionListener). However, an alternative to an export option would be to dynamically adjust the rows and fetchSize properties to a upper limit in printable mode. This would of course be subject to some good judgment. If the table contained one thousand rows, you would want to place a upper limit of maybe one hundred rows in print mode.

</section> <section name="Geometry_Management"> <html:ul> <html:li>This component can be stretched by a parent layout component that stretches its children, e.g. panelStretchLayout.</html:li> <html:li>When stretching this component, the only valid setting for autoHeightRows is "-1" (a value of 0 will be treated as -1 when stretched).</html:li> <html:li>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.</html:li> <html:li>Use the columnStretching attribute to configure stretching of the children column components.</html:li> </html:ul>

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.

</section>

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.

oracle.adf.view.rich.event.QueryEvent

Invoke
Application

The Query event is delivered when a query action is triggered.

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.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 event might include the width of a column that supported client-side resizing.

setBodyContextMenu(javax.faces.component.UIComponent bodyContextMenuFacet)
popup component containing the context menu that will be shown on right click within the table body, but outside of any table row.

void

setBodyContextMenuId(java.lang.String bodyContextMenuId)Deprecated.This attribute is deprecated, "bodyContextMenu" facet should be used instead.

void

setClearTokenCacheOnPPR(boolean clearTokenCacheOnPPR)
Sets private property to turn on/off the clearing of the row key token cache when the component is PPRed.

setDisplayRow(java.lang.String displayRow)
Sets the row to display in the table during intial display.

void

setDisplayRowKey(java.lang.Object displayRowKey)
Sets the rowkey to display in the table during intial display.

void

setDontPersist(java.lang.String[] dontPersist)
Sets a list of attributes whose changes are NOT to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml.

void

setEditingMode(java.lang.String editingMode)
Sets Indicates the mode used to edit the table when it contains editable components.

void

setEmptyText(java.lang.String emptyText)
Sets the text of an empty table.

void

setFetchSize(int fetchSize)
Sets the number of rows in the data fetch block

void

setFilterVisible(boolean filterVisible)
Sets whether the filter fields are displayed on the top of the table.

void

setFooter(javax.faces.component.UIComponent footerFacet)
the component used to render the table footer.

void

setHeader(javax.faces.component.UIComponent headerFacet)
the component used to render the table header.

getFooter

the component used to render the table footer. This facet existed in 10.1.3, but is currently not supported in RichTable and RichTreeTable

setFooter

public final void setFooter(javax.faces.component.UIComponent footerFacet)

the component used to render the table footer. This facet existed in 10.1.3, but is currently not supported in RichTable and RichTreeTable

getHeader

public final javax.faces.component.UIComponent getHeader()

the component used to render the table header. This facet existed in 10.1.3, but is currently not supported in RichTable and RichTreeTable

setHeader

public final void setHeader(javax.faces.component.UIComponent headerFacet)

the component used to render the table header. This facet existed in 10.1.3, but is currently not supported in RichTable and RichTreeTable

getContextMenu

public final javax.faces.component.UIComponent getContextMenu()

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.

setContextMenu

public final void setContextMenu(javax.faces.component.UIComponent contextMenuFacet)

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.

getBodyContextMenu

public final javax.faces.component.UIComponent getBodyContextMenu()

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. Note that the bodyContextMenu facet does not currently support a popup with the childCreation attribute set to deferred.

setBodyContextMenu

public final void setBodyContextMenu(javax.faces.component.UIComponent bodyContextMenuFacet)

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. Note that the bodyContextMenu facet does not currently support a popup with the childCreation attribute set to deferred.

getInlineStyle

public final java.lang.String getInlineStyle()

Gets 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. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute. 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.

Returns:

the new inlineStyle value

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)

Sets 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. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute. 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.

Parameters:

inlineStyle - the new inlineStyle value

getStyleClass

public final java.lang.String getStyleClass()

Gets 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'.

Returns:

the new styleClass value

setStyleClass

public final void setStyleClass(java.lang.String styleClass)

Sets 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'.

Parameters:

styleClass - the new styleClass value

getShortDesc

public final java.lang.String getShortDesc()

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

Returns:

the new shortDesc value

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)

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

Parameters:

shortDesc - the new shortDesc value

getUnsecure

public final java.util.Set<java.lang.String> getUnsecure()

Gets 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. Note that when you are able to set a property on the client, you will be allowed to by using the the .setProperty('attribute', newValue) method, but not the .setXXXAttribute(newValue) method. For example, if you have unsecure="disabled", then on the client you can use the method .setProperty('disabled', false), while the method .setDisabled(false) will not work and will provide a javascript error that setDisabled is not a function.

Returns:

the new unsecure value

setUnsecure

public final void setUnsecure(java.util.Set<java.lang.String> unsecure)

Sets 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. Note that when you are able to set a property on the client, you will be allowed to by using the the .setProperty('attribute', newValue) method, but not the .setXXXAttribute(newValue) method. For example, if you have unsecure="disabled", then on the client you can use the method .setProperty('disabled', false), while the method .setDisabled(false) will not work and will provide a javascript error that setDisabled is not a function.

Parameters:

unsecure - the new unsecure value

isVisible

public final boolean isVisible()

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

Returns:

the new visible value

setVisible

public final void setVisible(boolean visible)

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

Parameters:

visible - the new visible value

getCustomizationId

@Deprecated
public final java.lang.String getCustomizationId()

Deprecated.This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

Gets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Returns:

the new customizationId value

setCustomizationId

@Deprecated
public final void setCustomizationId(java.lang.String customizationId)

Deprecated.This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

Sets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Parameters:

customizationId - the new customizationId value

isClientComponent

public final boolean isClientComponent()

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

Returns:

the new clientComponent value

setClientComponent

public final void setClientComponent(boolean clientComponent)

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

Parameters:

clientComponent - the new clientComponent value

getClientAttributes

public final java.util.Set getClientAttributes()

Gets a set of client attribute names.

Returns:

the new clientAttributes value

setClientAttributes

public final void setClientAttributes(java.util.Set clientAttributes)

Sets a set of client attribute names.

Parameters:

clientAttributes - the new clientAttributes value

getPartialTriggers

public final java.lang.String[] getPartialTriggers()

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

Returns:

the new partialTriggers value

setPartialTriggers

public final void setPartialTriggers(java.lang.String[] partialTriggers)

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

setClientListeners

getBodyContextMenuId

@Deprecated
public final java.lang.String getBodyContextMenuId()

Deprecated.This attribute is deprecated, "bodyContextMenu" facet should be used instead.

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

Returns:

the new bodyContextMenuId value

setBodyContextMenuId

@Deprecated
public final void setBodyContextMenuId(java.lang.String bodyContextMenuId)

Deprecated.This attribute is deprecated, "bodyContextMenu" facet should be used instead.

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

Parameters:

bodyContextMenuId - the new bodyContextMenuId value

getColumnSelection

public final java.lang.String getColumnSelection()

Gets whether columns in this table are selectable.

Returns:

the new columnSelection value

setColumnSelection

public final void setColumnSelection(java.lang.String columnSelection)

Sets whether columns in this table are selectable.

Parameters:

columnSelection - the new columnSelection value

getColumnStretching

public final java.lang.String getColumnStretching()

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

Returns:

the new columnStretching value

setColumnStretching

public final void setColumnStretching(java.lang.String columnStretching)

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

Parameters:

columnStretching - the new columnStretching value

getColumnResizing

public final java.lang.String getColumnResizing()

Gets Setting this value to "disabled" will turn off user column resizing. The default is "enabled".

Returns:

the new columnResizing value

setColumnResizing

public final void setColumnResizing(java.lang.String columnResizing)

Sets Setting this value to "disabled" will turn off user column resizing. The default is "enabled".

Parameters:

columnResizing - the new columnResizing value

getContextMenuId

@Deprecated
public final java.lang.String getContextMenuId()

Deprecated.This attribute is deprecated, "contextMenu" facet should be used instead.

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

Returns:

the new contextMenuId value

setContextMenuId

@Deprecated
public final void setContextMenuId(java.lang.String contextMenuId)

Deprecated.This attribute is deprecated, "contextMenu" facet should be used instead.

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

Parameters:

contextMenuId - the new contextMenuId value

isDisableColumnReordering

public final boolean isDisableColumnReordering()

Gets whether column reordering is disabled in the table. Column reordering is on by default.

Returns:

the new disableColumnReordering value

setDisableColumnReordering

public final void setDisableColumnReordering(boolean disableColumnReordering)

Sets whether column reordering is disabled in the table. Column reordering is on by default.

Parameters:

disableColumnReordering - the new disableColumnReordering value

isHorizontalGridVisible

public final boolean isHorizontalGridVisible()

Gets whether the Horizontal GridLines are to be drawn.

Returns:

the new horizontalGridVisible value

setHorizontalGridVisible

public final void setHorizontalGridVisible(boolean horizontalGridVisible)

Sets whether the Horizontal GridLines are to be drawn.

Parameters:

horizontalGridVisible - the new horizontalGridVisible value

isVerticalGridVisible

public final boolean isVerticalGridVisible()

Gets whether the vertical GridLines are to be drawn.

Returns:

the new verticalGridVisible value

setVerticalGridVisible

public final void setVerticalGridVisible(boolean verticalGridVisible)

Sets whether the vertical GridLines are to be drawn.

Parameters:

verticalGridVisible - the new verticalGridVisible value

getEmptyText

public final java.lang.String getEmptyText()

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

Returns:

the new emptyText value

setEmptyText

public final void setEmptyText(java.lang.String emptyText)

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

Parameters:

emptyText - the new emptyText value

getColumnBandingInterval

public final int getColumnBandingInterval()

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

Returns:

the new columnBandingInterval value

setColumnBandingInterval

public final void setColumnBandingInterval(int columnBandingInterval)

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

Parameters:

columnBandingInterval - the new columnBandingInterval value

getRowBandingInterval

public final int getRowBandingInterval()

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

Returns:

the new rowBandingInterval value

setRowBandingInterval

public final void setRowBandingInterval(int rowBandingInterval)

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

Parameters:

rowBandingInterval - the new rowBandingInterval value

getRowSelection

public final java.lang.String getRowSelection()

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

Returns:

the new rowSelection value

setRowSelection

public final void setRowSelection(java.lang.String rowSelection)

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

Parameters:

rowSelection - the new rowSelection value

getWidth

public final java.lang.String getWidth()

Gets the width of this component. Default value is 300 PX

Returns:

the new width value

setWidth

public final void setWidth(java.lang.String width)

Sets the width of this component. Default value is 300 PX

Parameters:

width - the new width value

getSummary

public final java.lang.String getSummary()

Gets the summary of this table's purpose and structure for user agents rendering to non-visual media.

Returns:

the new summary value

setSummary

public final void setSummary(java.lang.String summary)

Sets the summary of this table's purpose and structure for user agents rendering to non-visual media.

Parameters:

summary - the new summary value

getFetchSize

public final int getFetchSize()

Gets the number of rows in the data fetch block

Returns:

the new fetchSize value

setFetchSize

public final void setFetchSize(int fetchSize)

Sets the number of rows in the data fetch block

Parameters:

fetchSize - the new fetchSize value

getDisplayRow

public final java.lang.String getDisplayRow()

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

Returns:

the new displayRow value

setDisplayRow

public final void setDisplayRow(java.lang.String displayRow)

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

Parameters:

displayRow - the new displayRow value

getDisplayRowKey

public final java.lang.Object getDisplayRowKey()

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

Returns:

the new displayRowKey value

setDisplayRowKey

public final void setDisplayRowKey(java.lang.Object displayRowKey)

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

Parameters:

displayRowKey - the new displayRowKey value

getActiveRowKey

public final java.lang.Object getActiveRowKey()

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

Returns:

the new activeRowKey value

setActiveRowKey

public final void setActiveRowKey(java.lang.Object activeRowKey)

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

Parameters:

activeRowKey - the new activeRowKey value

isContextMenuSelect

public final boolean isContextMenuSelect()

Gets 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()".

Returns:

the new contextMenuSelect value

setContextMenuSelect

public final void setContextMenuSelect(boolean contextMenuSelect)

Sets 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()".

Parameters:

contextMenuSelect - the new contextMenuSelect value

getEditingMode

public final java.lang.String getEditingMode()

Gets Indicates the mode used to edit the table when it contains editable components. When a table is rendered as readOnly, the editingMode attribute is ignored. 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 the user hits Esc key 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 the user hits F2 key, it takes the user into edit mode. Hitting F2 again (now that you are in edit mode) 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.

Returns:

the new editingMode value

setEditingMode

public final void setEditingMode(java.lang.String editingMode)

Sets Indicates the mode used to edit the table when it contains editable components. When a table is rendered as readOnly, the editingMode attribute is ignored. 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 the user hits Esc key 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 the user hits F2 key, it takes the user into edit mode. Hitting F2 again (now that you are in edit mode) 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.

Parameters:

editingMode - the new editingMode value

getScrollTop

public final int getScrollTop()

Gets private property to indicate current vertical scroll position.

Returns:

the new scrollTop value

setScrollTop

public final void setScrollTop(int scrollTop)

Sets private property to indicate current vertical scroll position.

Parameters:

scrollTop - the new scrollTop value

getScrollLeft

public final int getScrollLeft()

Gets private property to indicate current horizontal scroll position.

Returns:

the new scrollLeft value

setScrollLeft

public final void setScrollLeft(int scrollLeft)

Sets private property to indicate current horizontal scroll position.

Parameters:

scrollLeft - the new scrollLeft value

getScrollTopRowKey

public final java.lang.Object getScrollTopRowKey()

Gets private property to indicate row key for the first visible row.

Returns:

the new scrollTopRowKey value

setScrollTopRowKey

public final void setScrollTopRowKey(java.lang.Object scrollTopRowKey)

Sets private property to indicate row key for the first visible row.

Parameters:

scrollTopRowKey - the new scrollTopRowKey value

getContentDelivery

public final java.lang.String getContentDelivery()

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

Returns:

the new contentDelivery value

setContentDelivery

public final void setContentDelivery(java.lang.String contentDelivery)

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

Parameters:

contentDelivery - the new contentDelivery value

isClearTokenCacheOnPPR

public final boolean isClearTokenCacheOnPPR()

Gets private property to turn on/off the clearing of the row key token cache when the component is PPRed. Default is true

Returns:

the new clearTokenCacheOnPPR value

setClearTokenCacheOnPPR

public final void setClearTokenCacheOnPPR(boolean clearTokenCacheOnPPR)

Sets private property to turn on/off the clearing of the row key token cache when the component is PPRed. Default is true

Parameters:

clearTokenCacheOnPPR - the new clearTokenCacheOnPPR value

getAutoHeightRows

public final int getAutoHeightRows()

Gets

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.

In screen reader mode, the default 'autoHeightRows' value of -1 still indicates no auto-sizing. With a value of 0+ the component will expand horizontally, but beyond this the '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).

Returns:

the new autoHeightRows value

setAutoHeightRows

public final void setAutoHeightRows(int autoHeightRows)

Sets

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.

In screen reader mode, the default 'autoHeightRows' value of -1 still indicates no auto-sizing. With a value of 0+ the component will expand horizontally, but beyond this the '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).

Parameters:

autoHeightRows - the new autoHeightRows value

getPersist

public final java.lang.String[] getPersist()

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

Returns:

the new persist value

setPersist

public final void setPersist(java.lang.String[] persist)

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

Parameters:

persist - the new persist value

getDontPersist

public final java.lang.String[] getDontPersist()

Gets 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".

Returns:

the new dontPersist value

setDontPersist

public final void setDontPersist(java.lang.String[] dontPersist)

Sets 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".

Parameters:

dontPersist - the new dontPersist value

isAllDetailsEnabled

public final boolean isAllDetailsEnabled()

Gets 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 RichTable

Returns:

the new allDetailsEnabled value

setAllDetailsEnabled

public final void setAllDetailsEnabled(boolean allDetailsEnabled)

Sets 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 RichTable

Parameters:

allDetailsEnabled - the new allDetailsEnabled value

isFilterVisible

public final boolean isFilterVisible()

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

Returns:

the new filterVisible value

setFilterVisible

public final void setFilterVisible(boolean filterVisible)

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

Parameters:

filterVisible - the new filterVisible value

getColumnSelectionListener

public final javax.el.MethodExpression getColumnSelectionListener()

Gets a method reference to a ColumnSelectionListener

Returns:

the new columnSelectionListener value

setColumnSelectionListener

public final void setColumnSelectionListener(javax.el.MethodExpression columnSelectionListener)