o
Tag dataTable


The DataTable component is used to display data in a tabular format and effectively manipulate it. It supports all the features of the standard JSF HtmlDataTable component and, in addition, provides a number of features of its own. Child tags: column, selectionColumn, checkboxColumn, singleRowSelection, multipleRowSelection, dataTablePaginator, cell, row, columnResizing.


Tag Information
Tag Classorg.openfaces.taglib.jsp.table.DataTableJspTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredBinding TypeELDefaultDescription
alignfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullThe alignment of the table content.
Available values are:
"left"
"center"
"right"
allRecordsFilterTextfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
true"<All>"Text that is displayed instead of "" in the "comboBox" or "dropDownField" when filtering is used.
applyDefaultStylefalsejavax.el.ValueExpression
(must evaluate to boolean)
truetrueA flag that indicates whether or not to apply the default style.
autoFilterDelayfalsejavax.el.ValueExpression
(must evaluate to int)
true700Specifies the delay in milliseconds when the filtering is performed automatically after the user has entered some value in an associated filter, or turns off automatic filtering in case -1 is specified as a value for this attribute.
bgcolorfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullThe background color behind the table content.
bindingfalsejavax.el.ValueExpression
(must evaluate to org.openfaces.component.table.DataTable)
onlynullA value-binding expression that associates the DataTable with a backing bean property.
bodyOddRowClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for DataTable odd rows, if it should be different from bodyRowClass.
bodyOddRowStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for DataTable odd rows, if should be different from bodyRowStyle.
bodyRowClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for DataTable rows.
bodyRowStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for DataTable rows.
bodySectionClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the DataTable body section.
bodySectionStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the DataTable body section.
borderfalsejavax.el.ValueExpression
(must evaluate to int)
trueInteger.MIN_VALUEThe number of pixels in the DataTable border. The value Integer.MIN_VALUE means there is no border rendered.
cellpaddingfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullThe amount of space between the border of the cell and its content. The value null means there is no cell spacing rendered.
cellspacingfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullThe amount of space between the cells in the DataTable. The value null means there is no cell spacing rendered.
columnIdVarfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
falsenullThe name of the variable under which the column identifier is available when specifying a condition for the cell tag.
columnIndexVarfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
falsenullThe name of the variable under which the column index is available when specifying a condition for the cell tag.
columnsOrderfalsejavax.el.ValueExpression
(must evaluate to java.util.List)
onlynullThe order of columns in the DataTable component. This attribute should be bound to a list containing column IDs for each column in the order you want them to be displayed. If the "columnsOrder" attribute is not specified, all the columns are rendered in the order they are defined.
commonFooterRowClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the DataTable footer row.
commonFooterRowStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the DataTable footer row.
commonFooterSeparatorfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
true"1px solid #a0a0a0"A style for a line that separates the table footer from the rest of the table. Should be specified as the CSS "border" property but without the prefix "border:".
commonHeaderRowClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the DataTable header row.
commonHeaderRowStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the DataTable header row.
commonHeaderSeparatorfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
true"1px solid #a0a0a0"A style for a line that separates the table header from the rest of the table. Should be specified as the CSS "border" property but without the prefix "border:".
customDataProvidingfalsejavax.el.ValueExpression
(must evaluate to boolean)
truefalseIf this attribute is set to "true", then it is the responsibility of a developer to provide the paged data through the "value" attribute. In this case, two additional request-scope variables are available when evaluating the "value" attribute: rangeStart and rangeSize. These variables specify which rows the "value" attribute should return. rangeStart is the index of the first returned row, and rangeSize defines the number of rows that should be returned. When this attribute is set to "true", the "totalRowCount" and "rowDataByKey" attributes must also be defined.
dirfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
true"LTR"The reading order of the table columns and content. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left)
Available values are:
"LTR" — from left to right
"RTL" — from right to left
emptyRecordsFilterTextfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
true"<Empty>"Text that is displayed instead of "" in the "comboBox" or "dropDownField" when filtering is used.
focusedClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name of the DataTable component when it is focused.
focusedStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style of the DataTable component when it is focused.
footerHorizSeparatorfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
true"1px solid #a0a0a0"A style for a line that separates the footer section from the body section. Should be specified as the CSS "border" property but without the prefix "border:".
footerRowClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the column footer row.
footerRowStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the column footer row.
footerSectionClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the DataTable footer section.
footerSectionStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the DataTable footer section.
footerVertSeparatorfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
true"none, 1px solid #a0a0a0"A style for vertical lines between column footers. Should be specified as the CSS "border" property but without the prefix "border:". It can also be specified as a list of comma-separated gridline styles when column groups are used and group separators should be different from column separators. See verticalGridLines attribute for details.
headerHorizSeparatorfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
true"1px solid #a0a0a0"A style for a line that separates the header section from the body section. Should be specified as the CSS "border" property but without the prefix "border:".
headerRowClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the column header row.
headerRowStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the column header row.
headerSectionClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the DataTable header section.
headerSectionStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the DataTable header section.
headerVertSeparatorfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
true"none, 1px solid #a0a0a0"A style for vertical lines between column headers. Should be specified as the CSS "border" property but without the prefix "border:". It can also be specified as a list of comma-separated gridline styles when column groups are used and group separators should be different from column separators. See verticalGridLines attribute for details.
horizontalGridLinesfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
true"1px solid #e0e0e0"A style for horizontal lines in the DataTable body. Should be specified as the CSS "border" property but without the prefix "border:".
idfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
falsenullThe component identifier.
multiFooterSeparatorfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
true"none, 1px solid #a0a0a0"A style for a line that separates multiple footer rows when column groups are used. It can also be specified as a list of comma-separated gridline styles when there are multiple levels of nested column groups.
multiHeaderSeparatorfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
true"none, 1px solid #a0a0a0"A style for a line that separates multiple header rows when column groups are used. It can also be specified as a list of comma-separated gridline styles when there are multiple levels of nested column groups.
noDataMessageAllowedfalsejavax.el.ValueExpression
(must evaluate to boolean)
truetrueA flag that indicates whether or not to show "noDataMessage".
noDataRowClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the row that displays "noDataMessage".
noDataRowStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the row that displays "noDataMessage".
nonEmptyRecordsFilterTextfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
true"<Non-empty>"Text that is displayed instead of "" in the "comboBox" or "dropDownField" when filtering is used.
onblurfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed when the DataTable loses focus.
onclickfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed on the client when the user clicks the left mouse button over the DataTable.
oncontextmenufalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed when the user presses right mouse button over the component (or performs the other context menu invocation action depending on the platform).
ondblclickfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed on the client when the user double-clicks the left mouse button over the DataTable.
onfocusfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed when the DataTable receives focus.
onkeydownfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed when the user presses a key over the DataTable.
onkeypressfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed on the client when the user presses and releases a key over the DataTable.
onkeyupfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed when the user releases a key over the DataTable.
onmousedownfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed when the user clicks over the DataTable with either mouse button.
onmousemovefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed when the user moves the mouse pointer over the DataTable.
onmouseoutfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed when the user moves the mouse pointer away from the DataTable.
onmouseoverfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed when the user moves the mouse pointer onto the DataTable.
onmouseupfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullJavaScript code that should be executed when the user releases a mouse button over the DataTable.
pageIndexfalsejavax.el.ValueExpression
(must evaluate to int)
true0The number of a currently displayed page. This attribute is effective only if the "pageSize" attribute is specified.
pageSizefalsejavax.el.ValueExpression
(must evaluate to int)
true0The number of rows to be displayed on each table page. If it is set to "0", no pagination is available.
paginationKeyboardSupportfalsejavax.el.ValueExpression
(must evaluate to boolean)
truetrueA flag that indicates whether or not to enable the keyboard support for pagination.
renderedfalsejavax.el.ValueExpression
(must evaluate to boolean)
truetrueA flag that indicates whether or not the component is visible.
rolloverClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the DataTable component in the rollover state.
rolloverRowClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for a DataTable row in the rollover state.
rolloverRowStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for a DataTable row in the rollover state.
rolloverStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the DataTable component in the rollover state.
rowDataByKeyfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
onlynullA value-binding expression that should return row data by a request-scope rowKey variable. This variable is required when the "customPaging" attribute is set to "true".
rowIndexVarfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
falsenullThe name of the variable under which the current row index is available when declaring components inside columns or specifying a condition for the row and cell tags.
rowKeyfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
onlynullA row key that must uniquely identify an appropriate row. All rowKey objects should be serializable and correctly implement the equals() and hashCode() methods.
rulesfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
true"none"Specifies which gridlines are displayed between the cells in the DataTable component.
Available values are:
"all" — between all rows and columns
"cols" — between columns only
"groups" — between row groups and column groups only
"none" — no grid lines
"rows" — between rows only
sortableHeaderClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name that is applied to the header of a sortable column.
sortableHeaderRolloverClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name that is applied to the header of a sortable column in the rollover state.
sortableHeaderRolloverStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style that is applied to the header of a sortable column in the rollover state.
sortableHeaderStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style that is applied to the header of a sortable column.
sortAscendingfalsejavax.el.ValueExpression
(must evaluate to boolean)
truetrueThe sorting order of the data in the DataTable component. The "true" value means the table is sorted in ascending order.
sortColumnIdfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullThe identifier of a column by which the DataTable component is sorted.
sortedAscendingImageUrlfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullURL to the image file that is used to render the image that displays the ascending sort direction.
sortedColumnBodyClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the sorted column's body.
sortedColumnBodyStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the sorted column's body.
sortedColumnClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the entire sorted column.
sortedColumnFooterClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the sorted column's footer.
sortedColumnFooterStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the sorted column's footer.
sortedColumnHeaderClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the sorted column's header.
sortedColumnHeaderStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the sorted column's header.
sortedColumnStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the entire sorted column.
sortedDescendingImageUrlfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullURL to the image file that is used to render the image that displays the descending sort direction.
stylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the entire DataTable component.
styleClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the entire DataTable component.
subHeaderRowClassfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA CSS class name for the sub-header row (usually contains the filter components).
subHeaderRowSeparatorfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for a line that separates a sub-header row and the column header.
subHeaderRowStylefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullA style for the sub-header row (usually contains the filter components).
tabindexfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullSpecifies a numeric value that defines input focus traversing order for this component.
totalRowCountfalsejavax.el.ValueExpression
(must evaluate to int)
onlynullThe number of rows on all table pages according to current filtering options. Must be specified if the "customPaging" attribute is set to "true".
useAjaxfalsejavax.el.ValueExpression
(must evaluate to boolean)
truetrueA flag that indicates whether or not to use Ajax for sorting, filtering and pagination.
valuefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
onlynullSpecifies a set of rows displayed in the DataTable component.
varfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
falsenullThe name of a request-scope variable under which the current row data is available when specifying columns.
verticalGridLinesfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
true"none, 1px solid #e0e0e0"A style for vertical lines in the DataTable body. Should be specified as the CSS "border" property but without the prefix "border:". This attribute can also accept the comma-separated list of similarly-formatted gridline styles for specifying separators between different levels of column groups. The first item in this list corresponds to separators between the columns, the second one specifies styles for separators between group separators, and so on if more separators are required in case of a deeper hierarchy of column groups.
widthfalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
truenullThe width of the DataTable. Can be specified in any units (px, mm, em, etc.).

Variables
No Variables Defined.


Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.