A table whose content is populated from either a javax.faces.model.DataModel
object, or a com.webmethods.caf.faces.data.ITableContentProvider
object.
The Async Table pages and sorts using asynchronous requests. When the Async Table control's clientSideCache
property is set to true, the table caches rows that it has retrieved from the server until the page is refreshed, or the table or a parent of the table is refreshed. You can refresh the Async Table using the refresh()
method of its client-side model. You can also use the Refresh Interval control to refresh the table on a timed basis.
You can configure the Async Table to buffer in its cache rows on either side of the visible page. When the bufferMin
and bufferMax
properties are set to positive integers, the table ensures that at least the bufferMin
number of rows are cached on either side of the visible page.
bufferMax
number of rows on either side of the visible page to store in the cache.bufferChunk
property is set to zero (0), the Async Table control retrieves the rows as one group.bufferChunk
property is set to a positive integer, the Async Table control uses multiple asynchronous requests to retrieve the specific number of rows set in the bufferChunk
propertyFor example, an Async Table has the following property settings:
clientSideCache=true
bufferMin=10
bufferMax=100
bufferChunk=0
In this example, the Async Table displays rows 1 through 10 of 1000. When the page is rendered initially, the Async Table displays rows 1 - 10, and buffer rows 11 - 110. If the user pages forward to rows 91 - 100, these rows are in the client-side cache, and the user can display the rows immediately without an additional request. If the user pages forward to rows 101 - 110, these rows are also in the client-side cache, and the user can see the rows immediately. However, the buffer now contains less than 10 rows on the next side of the visible page. The buffer contains zero rows, so the Async Table must request rows 111 - 210. If the user jumps to rows 991 - 1000, these rows are not in the client-side cache and neither are the previous 10 rows. This requires that the Async Table send a request for the rows 891 - 1000, displaying the last 10 rows in the table, and buffering the previous 100 rows.
In this second example, the Async Table has the following property settings:
clientSideCache=true
bufferMin=50
bufferMax=50
bufferChunk=10
In this second example, the Async Table displays rows 1 - 10 of 1000. When the page is rendered initially, the Async Table displays rows 1 - 10. As the Async Table waits for the user to do something, it makes 5 asynchronous requests, each for 10 more rows, buffering 50 rows on the next side of the cache. If the user pages forward to rows 11 - 20, these rows are available in the client-side cache and can display immediately without an additional request. However, the buffer contains less than 50 rows on the next side of the visible page. The buffer contains the next 40 rows. The Async Table must request rows 61 - 70. If the user jumps to rows 991 - 1000, these rows are not in the client-side cache. The Async Table must request rows 991 - 1000 to display the requested rows. The Async Table makes 5 more asynchronous requests, each retrieving 10 more previous rows, bringing the buffer up to 50 on the previous side of the cache.
Children
javax.faces.Column
, Basic Column control
Info | Value |
---|---|
Component Type | com.webmethods.caf.faces.table.AsyncTable |
Handler Class | com.webmethods.caf.faces.component.DynamicControlHandler |
Renderer Type | com.webmethods.caf.faces.table.AsyncTable |
Description | Displays data model as a table that pages asynchronously |
Palette Location | CAF Html/Control/Table/Async Table |
Client-Side Model | CAF.Table.Model |
Name | Description |
---|---|
caption | Table caption |
header | Table header |
footer | Table footer |
empty | Empty message content |
Name | Required | Type | Description |
---|---|---|---|
bgcolor | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| The background color for all table cells |
border | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer )
| Specifies the size of the border around the table. If the value is 0 or absent, no border is rendered |
bufferChunk | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer )
|
Chunk size in rows to use when filling client-side cache buffer (0=don't chunk)
If not specified, the default value is "0". |
bufferMax | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer )
|
Maximum buffer size in rows for client-side caching (0=no buffer)
If not specified, the default value is "0". |
bufferMin | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer )
|
Minimum buffer size in rows for client-side caching (0=no buffer)
If not specified, the default value is "0". |
cellpadding | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Specifies the spacing between data in a table cell and the border of the cell. |
cellspacing | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Specifies the spacing between table cells. |
clientSideCache | false | javax.el.ValueExpression
(must evaluate to boolean )
|
True to cache rows on the client
If not specified, the default value is "false". |
columnClasses | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| A comma separated list of CSS classes for the table body <td> elements. |
customRowClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Binding expression that specifies a custom CSS class name to add to the current row |
dir | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
|
Specifies the directionality of the flow of the content for the current element
Valid values are:
|
filter | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Filter expression |
first | true | javax.el.ValueExpression
(must evaluate to java.lang.Integer )
|
Index of first item in model to display (zero-based)
If not specified, the default value is "0". |
fixedHeight | false | javax.el.ValueExpression
(must evaluate to boolean )
|
True if the table should have a fixed height, based on the number of rows-per-page
If not specified, the default value is "false". |
flashOnChange | false | javax.el.ValueExpression
(must evaluate to boolean )
|
True to flash rows that have changed
If not specified, the default value is "true". |
footerClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| The CSS class for footer cells |
frame | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
|
Specifies the sides of the outer table border for which to draw borders.
Valid values are:
|
headerClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| The CSS class for header cells |
id | false | java.lang.String | Control identifier |
lang | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Specifies the language of the enclosed content |
maxOrdinal | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer )
| Maximum number of sort ordinals allowed (1=primary only, 2=primary and secondary only, etc.) |
onclick | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| JavaScript "onclick" event handler |
ondblclick | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| JavaScript "ondblclick" event handler |
onkeydown | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| JavaScript "onkeydown" event handler |
onkeypress | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| JavaScript "onkeypress" event handler |
onkeyup | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| JavaScript "onkeyup" event handler |
onmousedown | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| JavaScript "onmousedown" event handler |
onmousemove | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| JavaScript "onmousemove" event handler |
onmouseout | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| JavaScript "onmouseout" event handler |
onmouseover | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| JavaScript "onmouseover" event handler |
onmouseup | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| JavaScript "onmouseup" event handler |
progressDelay | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer )
|
Milliseconds to wait before showing progress dialog
If not specified, the default value is "0". |
progressMsg | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Progress dialog message; defaults to a localized message, in English "Loading..." |
rendered | false | javax.el.ValueExpression
(must evaluate to boolean )
|
True to render control; false to ignore it
If not specified, the default value is "true". |
rowClasses | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| A comma separated list of CSS classes for the table rows. The classes are used for the <tr> elements in the order they are listed, repeating the list over all rows in the table. |
rowHeight | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Row height in pixels (ex '20px') or ems (ex '2em') |
rows | true | javax.el.ValueExpression
(must evaluate to java.lang.Integer )
| Number of rows to display per page |
rules | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
|
Specifies the interior dividing line display in a table.
Valid values are:
|
selectedRowClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| CSS class name for selected rows |
style | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| HTML "style" attribute value |
styleClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
|
HTML "class" attribute value
Valid values are:
|
summary | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Aids accessibility for non-visual browsers by providing a summary of the table's purpose and structure |
suppressInputs | false | javax.el.ValueExpression
(must evaluate to java.util.Collection )
|
WARNING: This property has been deprecated. Ids of controls on which to disallow update processing while handling asynchronous requestsIf not specified, the default value is "false". |
title | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| HTML "title" attribute value (often displayed as a tooltip) |
value | true | java.lang.String | Data model |
var | true | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Name of variable reference to the current row object |
width | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Specifies the table width in pixels or a percentage of the available width |
Output generated by Vdldoc View Declaration Language Documentation Generator.