t
Tag dataTable


Extended data_table that adds some additional features to the standard data_table action: see attribute descriptions for preserveDataModel, sortColumn, sortAscending and preserveSort. Unless otherwise specified, all attributes accept static values or EL expressions.


Tag Information
Tag Classorg.apache.myfaces.taglib.html.ext.HtmlDataTableTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

elements that are generated by the table.
Attributes
NameRequiredRequest-timeTypeDescription
idfalsefalsejava.lang.StringThe developer-assigned ID of this component. The ID must be unique within the scope of the tag's enclosing naming container (e.g. h:form or f:subview). This value must be a static value.
bindingfalsefalsejava.lang.StringIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.
renderedfalsefalsejava.lang.StringA boolean value that indicates whether this component should be rendered. Default value: true.
columnClassesfalsefalsejava.lang.StringA comma separated list of CSS class names to apply to td elements in each column.
footerClassfalsefalsejava.lang.StringThe CSS class to be applied to footer cells.
headerClassfalsefalsejava.lang.StringThe CSS class to be applied to header cells.
rowClassesfalsefalsejava.lang.StringA comma separated list of CSS class names to apply to td elements in each row.
dirfalsefalsejava.lang.StringHTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
langfalsefalsejava.lang.StringHTML: The base language of this document.
stylefalsefalsejava.lang.StringHTML: CSS styling instructions.
titlefalsefalsejava.lang.StringHTML: An advisory title for this element. Often used by the user agent as a tooltip.
styleClassfalsefalsejava.lang.StringThe CSS class for this element. Corresponds to the HTML 'class' attribute.
onclickfalsefalsejava.lang.StringHTML: Script to be invoked when the element is clicked.
ondblclickfalsefalsejava.lang.StringHTML: Script to be invoked when the element is double-clicked.
onmousedownfalsefalsejava.lang.StringHTML: Script to be invoked when the pointing device is pressed over this element.
onmouseupfalsefalsejava.lang.StringHTML: Script to be invoked when the pointing device is released over this element.
onmouseoverfalsefalsejava.lang.StringHTML: Script to be invoked when the pointing device is moved into this element.
onmousemovefalsefalsejava.lang.StringHTML: Script to be invoked when the pointing device is moved while it is in this element.
onmouseoutfalsefalsejava.lang.StringHTML: Script to be invoked when the pointing device is moves out of this element.
onkeypressfalsefalsejava.lang.StringHTML: Script to be invoked when a key is pressed over this element.
onkeydownfalsefalsejava.lang.StringHTML: Script to be invoked when a key is pressed down over this element.
onkeyupfalsefalsejava.lang.StringHTML: Script to be invoked when a key is released over this element.
alignfalsefalsejava.lang.StringHTML: Specifies the horizontal alignment of this element. Deprecated in HTML 4.01.
borderfalsefalsejava.lang.StringHTML: Specifies the width of the border of this element, in pixels. Deprecated in HTML 4.01.
bgcolorfalsefalsejava.lang.StringHTML: The background color of this element.
datafldfalsefalsejava.lang.StringReserved for future use.
datasrcfalsefalsejava.lang.StringReserved for future use.
dataformatasfalsefalsejava.lang.StringReserved for future use.
cellpaddingfalsefalsejava.lang.StringHTML: Specifies the amount of empty space between the cell border and its contents. It can be either a pixel length or a percentage.
cellspacingfalsefalsejava.lang.StringHTML: Specifies the amount of space between the cells of the table. It can be either a pixel length or a percentage of available space.
framefalsefalsejava.lang.StringHTML: Controls what part of the frame that surrounds a table is visible. Values include: void, above, below, hsides, lhs, rhs, vsides, box, and border.
rulesfalsefalsejava.lang.StringHTML: Controls how rules are rendered between cells. Values include: none, groups, rows, cols, and all.
summaryfalsefalsejava.lang.StringHTML: Provides a summary of the contents of the table, for accessibility purposes.
widthfalsefalsejava.lang.StringHTML: Specifies the desired width of the table, as a pixel length or a percentage of available space.
valuefalsefalsejava.lang.StringAn 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.
vartruefalsejava.lang.StringDefines the name of the request-scope variable that will hold the current row during iteration. This value must be a static value.
rowsfalsefalsejava.lang.StringThe number of rows to be displayed. Specify zero for all remaining rows in the table.
firstfalsefalsejava.lang.StringThe index of the first row to be displayed, where 0 is the first row.
preserveDataModelfalsefalsejava.lang.StringIndicates 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
preserveRowStatesfalsefalsejava.lang.StringIndicates 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
forceIdIndexFormulafalsefalsejava.lang.StringA 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 !
sortColumnfalsefalsejava.lang.StringValue 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.
sortAscendingfalsefalsejava.lang.StringValue 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.
sortablefalsefalsejava.lang.StringNo Description
preserveSortfalsefalsejava.lang.StringIndicates 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
renderedIfEmptyfalsefalsejava.lang.StringIndicates 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
rowIndexVarfalsefalsejava.lang.StringA parameter name, under which the current rowIndex is set in request scope similar to the var parameter.
rowCountVarfalsefalsejava.lang.StringA parameter name, under which the rowCount is set in request scope similar to the var parameter.
previousRowDataVarfalsefalsejava.lang.StringA 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.
sortedColumnVarfalsefalsejava.lang.StringA 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.
rowOnClickfalsefalsejava.lang.StringDefines a JavaScript onclick event handler for each table row
rowOnDblClickfalsefalsejava.lang.StringDefines a JavaScript ondblclick event handler for each table row
rowOnMouseDownfalsefalsejava.lang.StringDefines a JavaScript onmpusedown event handler for each table row
rowOnMouseUpfalsefalsejava.lang.StringDefines a JavaScript onmouseup event handler for each table row
rowOnMouseOverfalsefalsejava.lang.StringDefines a JavaScript onmouseover event handler for each table row
rowOnMouseMovefalsefalsejava.lang.StringDefines a JavaScript onmousemove event handler for each table row
rowOnMouseOutfalsefalsejava.lang.StringDefines a JavaScript onmouseout event handler for each table row
rowOnKeyPressfalsefalsejava.lang.StringDefines a JavaScript onkeypress event handler for each table row
rowOnKeyDownfalsefalsejava.lang.StringDefines a JavaScript onkeydown event handler for each table row
rowOnKeyUpfalsefalsejava.lang.StringDefines a JavaScript onkeyup event handler for each table row
rowIdfalsefalsejava.lang.StringThe id to use for
rowStyleClassfalsefalsejava.lang.StringCorresponds to the HTML class attribute for the row tr tag.
rowStylefalsefalsejava.lang.StringCorresponds to the HTML style attribute for the row tr tag.
rowGroupStylefalsefalsejava.lang.StringCorresponds to the HTML style attribute for grouped rows.
rowGroupStyleClassfalsefalsejava.lang.StringStyleClass for grouped rows.
varDetailTogglerfalsefalsejava.lang.StringThis 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.
bodyStyleClassfalsefalsejava.lang.StringCorresponds to the HTML class attribute for the table body tag.
bodyStylefalsefalsejava.lang.StringCorresponds to the HTML style attribute for the table body tag.
forceIdfalsefalsejava.lang.StringIf true, this component will force the use of the specified id when rendering.
forceIdIndexfalsefalsejava.lang.StringIf 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.)
enabledOnUserRolefalsefalsejava.lang.StringIf user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.
visibleOnUserRolefalsefalsejava.lang.StringIf 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.
newspaperColumnsfalsefalsejava.lang.StringThe number of columns to wrap the table over. Default: 1
newspaperOrientationfalsefalsejava.lang.StringThe orientation of the newspaper columns in the newspaper table - "horizontal" or "vertical". Default: vertical

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.