| Attributes |
| Name | Required | Request-time | Type | Description |
| frequency | false | false | java.lang.String | Defines in seconds the interval of reloads. if no value is specified 2 seconds will be default. |
| onSuccess | false | false | java.lang.String | Define javascript function to call after successful refresh. |
| first | false | false | java.lang.String | The index of the first row to be displayed, where 0 is the first row. |
| rows | false | false | java.lang.String | The number of rows to be displayed. Specify zero for all remaining rows in the table. |
| forceIdIndexFormula | false | false | java.lang.String | A formula that overrides the default row index in the
construction of table's body components.
Example : #{myRowVar.key} Warning, the EL should
evaluate to a unique value for each row ! |
| sortColumn | false | false | java.lang.String | Value reference to a model property that gives the current
sort column name. The target String property is set to
the "columnName" of whichever column has been chosen
to sort by, and the method which is bound to the "value"
attribute of this table (ie which provides the DataModel used)
is expected to use this property to determine how to sort
the DataModel's contents. |
| sortAscending | false | false | java.lang.String | Value reference to a model property that gives the current
sort direction. The target Boolean property is set to true
when the selected sortColumn should be sorted in ascending
order, and false otherwise. The method which is bound to
the "value" attribute of this table (ie which provides the
DataModel used) is expected to use this property to
determine how to sort the DataModel's contents. |
| sortable | false | false | java.lang.String | Define if the table is sortable or not |
| embedded | false | false | java.lang.String | Avoids rendering the html table tags, thus, giving you a
table rendering just rows. You can use this together
with the detailStamp faces of the parent datatable
to render child-tables using the same layout as the parent.
Notice: You have to ensure both tables do have the same
number of columns. Using the colspan attribute of the
column tag might help alot. |
| detailStampExpandedDefault | false | false | java.lang.String | true|false - true if the detailStamp should be expanded by default. default: false |
| detailStampLocation | false | false | java.lang.String | before|after - where to render the detailStamp, before the
actual row or after it. default: after |
| rowOnMouseOver | false | false | java.lang.String | Defines a JavaScript onmouseover event handler for each table row |
| rowOnMouseOut | false | false | java.lang.String | Defines a JavaScript onmouseout event handler for each table row |
| rowOnClick | false | false | java.lang.String | Defines a JavaScript onclick event handler for each table row |
| rowOnDblClick | false | false | java.lang.String | Defines a JavaScript ondblclick event handler for each table row |
| rowOnKeyDown | false | false | java.lang.String | Defines a JavaScript onkeydown event handler for each table row |
| rowOnKeyPress | false | false | java.lang.String | Defines a JavaScript onkeypress event handler for each table row |
| rowOnKeyUp | false | false | java.lang.String | Defines a JavaScript onkeyup event handler for each table row |
| rowStyleClass | false | false | java.lang.String | Corresponds to the HTML class attribute for the row tr tag. |
| rowStyle | false | false | java.lang.String | Corresponds to the HTML style attribute for the row tr tag. |
| rowOnMouseDown | false | false | java.lang.String | Defines a JavaScript onmpusedown event handler for each table row |
| rowOnMouseMove | false | false | java.lang.String | Defines a JavaScript onmousemove event handler for each table row |
| rowOnMouseUp | false | false | java.lang.String | Defines a JavaScript onmouseup event handler for each table row |
| varDetailToggler | false | false | java.lang.String | This variable has the boolean property "currentdetailExpanded"
which is true if the current detail row is expanded and the
action method "toggleDetail" which expand/collapse the current
detail row. |
| rowGroupStyle | false | false | java.lang.String | Corresponds to the HTML style attribute for grouped rows. |
| rowGroupStyleClass | false | false | java.lang.String | StyleClass for grouped rows. |
| bodyStyle | false | false | java.lang.String | Corresponds to the HTML style attribute for the table body tag |
| bodyStyleClass | false | false | java.lang.String | Corresponds to the HTML class attribute for the table body tag. |
| newspaperColumns | false | false | java.lang.String | The number of columns to wrap the table over. Default: 1
Set the number of columns the table will be divided over. |
| newspaperOrientation | false | false | java.lang.String | The orientation of the newspaper columns in the newspaper
table - "horizontal" or "vertical". Default: vertical |
| preserveDataModel | false | false | java.lang.String | Indicates whether the state of the whole DataModel should
be saved and restored. When set to false, the value-binding
for the "value" attribute of this table is executed each
time the page is rendered. When set to true, that
value-binding is only executed when the component is first
created, and the DataModel state is thereafter saved/restored
automatically by the component. When column sorting is
used for a table this property needs to be false so that
the DataModel can be updated to reflect any changes in the
sort criteria. Default: false |
| preserveSort | false | false | java.lang.String | Indicates whether the state of the sortColumn and sortAscending
attribute should be saved and restored and written back to the
model during the update model phase. Default: true |
| renderedIfEmpty | false | false | java.lang.String | Indicates whether this table should be rendered if the
underlying DataModel is empty. You could as well use
rendered="#{not empty bean.list}", but this one causes
the getList method of your model bean beeing called up
to five times per request, which is not optimal when
the list is backed by a DB table. Using
renderedIfEmpty="false" solves this problem, because
the MyFaces extended HtmlDataTable automatically caches
the DataModel and calles the model getter only once
per request. Default: true |
| rowIndexVar | false | false | java.lang.String | A parameter name, under which the current rowIndex is set
in request scope similar to the var parameter. |
| rowCountVar | false | false | java.lang.String | A parameter name, under which the rowCount is set in
request scope similar to the var parameter. |
| previousRowDataVar | false | false | java.lang.String | A parameter name, under which the previous RowData Object
is set in request scope similar to the rowIndexVar and
rowCountVar parameters. Mind that the value of this
request scope attribute is null in the first row or
when isRowAvailable returns false for the previous row. |
| sortedColumnVar | false | false | java.lang.String | A parameter name, under which the a boolean is set in request
scope similar to the var parameter. TRUE for the column that
is currently sorted, FALSE otherwise. |
| align | false | false | java.lang.String | HTML: Specifies the horizontal alignment of this element.
Deprecated in HTML 4.01. |
| rowId | false | false | java.lang.String | The id to use for |
| datafld | false | false | java.lang.String | Reserved for future use. |
| datasrc | false | false | java.lang.String | Reserved for future use. |
| dataformatas | false | false | java.lang.String | Reserved for future use. |
| valueType | false | false | java.lang.String | Indicate the expected type of the EL expression pointed
by value property. It is useful when vb.getType() cannot
found the type, like when a map value is resolved on
the expression. |
| enabledOnUserRole | false | false | java.lang.String | If user is in given role, this component will be rendered
normally. If not, no hyperlink is rendered but all nested
tags (=body) are rendered. |
| visibleOnUserRole | false | false | java.lang.String | If user is in given role, this component will be rendered
normally. If not, nothing is rendered and the body of this
tag will be skipped. |
| preserveRowStates | false | false | java.lang.String | Indicates whether the state for each row should not be
discarded before the datatable is rendered again.
Setting this to true might be hepful if an input
component inside the datatable has no valuebinding and
the value entered in there should be displayed again.
This will only work reliable if the datamodel of the
datatable did not change either by sorting, removing or
adding rows. Default: false |
| forceId | false | false | java.lang.String | If true, this component will force the use of the specified id when rendering. |
| forceIdIndex | false | false | java.lang.String | If false, this component will not append a '[n]' suffix
(where 'n' is the row index) to components that are
contained within a "list." This value will be true by
default and the value will be ignored if the value of
forceId is false (or not specified.) |
| rowKey | false | false | java.lang.String | Used to assign a value expression that identify in a unique way a row. This value
will be used later instead of rowIndex as a key to be appended to the container
client id using getDerivedSubClientId() method. |
| derivedRowKeyPrefix | false | false | java.lang.String | This attribute is used to append an unique prefix when rowKey is not used, to prevent
a key match a existing component id (note two different components can't have the
same unique id). |
| bgcolor | false | false | java.lang.String | HTML: The background color of this element. |
| border | false | false | java.lang.String | HTML: Specifies the width of the border of this element, in pixels. Deprecated in HTML 4.01. |
| cellpadding | false | false | java.lang.String | HTML: Specifies the amount of empty space between the cell border and
its contents. It can be either a pixel length or a percentage. |
| cellspacing | false | false | java.lang.String | HTML: Specifies the amount of space between the cells of the table.
It can be either a pixel length or a percentage of available
space. |
| columnClasses | false | false | java.lang.String | A comma separated list of CSS class names to apply to td elements in
each column. |
| footerClass | false | false | java.lang.String | The CSS class to be applied to footer cells. |
| frame | false | false | java.lang.String | HTML: Controls what part of the frame that surrounds a table is
visible. Values include: void, above, below, hsides, lhs,
rhs, vsides, box, and border. |
| headerClass | false | false | java.lang.String | The CSS class to be applied to header cells. |
| rowClasses | false | false | java.lang.String | A comma separated list of CSS class names to apply to td elements in
each row. |
| rules | false | false | java.lang.String | HTML: Controls how rules are rendered between cells. Values include:
none, groups, rows, cols, and all. |
| summary | false | false | java.lang.String | HTML: Provides a summary of the contents of the table, for
accessibility purposes. |
| width | false | false | java.lang.String | HTML: Specifies the desired width of the table, as a pixel length or
a percentage of available space. |
| style | false | false | java.lang.String | HTML: CSS styling instructions. |
| styleClass | false | false | java.lang.String | The CSS class for this element. Corresponds to the HTML 'class' attribute. |
| onclick | false | false | java.lang.String | HTML: Script to be invoked when the element is clicked. |
| ondblclick | false | false | java.lang.String | HTML: Script to be invoked when the element is double-clicked. |
| onkeydown | false | false | java.lang.String | HTML: Script to be invoked when a key is pressed down over this element. |
| onkeypress | false | false | java.lang.String | HTML: Script to be invoked when a key is pressed over this element. |
| onkeyup | false | false | java.lang.String | HTML: Script to be invoked when a key is released over this element. |
| onmousedown | false | false | java.lang.String | HTML: Script to be invoked when the pointing device is pressed over this element. |
| onmousemove | false | false | java.lang.String | HTML: Script to be invoked when the pointing device is moved while it is in this element. |
| onmouseout | false | false | java.lang.String | HTML: Script to be invoked when the pointing device is moves out of this element. |
| onmouseover | false | false | java.lang.String | HTML: Script to be invoked when the pointing device is moved into this element. |
| onmouseup | false | false | java.lang.String | HTML: Script to be invoked when the pointing device is released over this element. |
| dir | false | false | java.lang.String | HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left). |
| lang | false | false | java.lang.String | HTML: The base language of this document. |
| title | false | false | java.lang.String | HTML: An advisory title for this element. Often used by the user agent as a tooltip. |
| var | true | false | java.lang.String | Defines the name of the request-scope variable that will hold the current row during iteration. This value must be a static value. |
| value | false | false | java.lang.String | An EL expression that specifies the data model that backs this table. The value can be of any type.
A value of type DataModel is used directly. Array-like parameters of type java.util.List, array of Object,
java.sql.ResultSet, or javax.servlet.jsp.jstl.sql.Result are wrapped in a DataModel.
Other values are wrapped in a DataModel as a single row. |
| id | false | false | java.lang.String | An identifier for this particular component instance within
a component view.
The id must be unique within the scope of the tag's enclosing
NamingContainer (eg h:form or f:subview). The id is
not necessarily unique across all components in the current view
This value must be a static value, ie not change over the lifetime
of a component. It cannot be defined via an EL expression; only
a string is permitted.
|
| rendered | false | false | java.lang.String | A boolean value that indicates whether this component should be rendered.
Default value: true. |
| binding | false | false | java.lang.String | Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression. |