UI-Component Sets
Project Documentation

Summary

Tag name: <h:dataTable>
UIComponent class: javax.faces.component.html.HtmlDataTable
Tag class: org.apache.myfaces.taglib.html.HtmlDataTableTag
Component type: javax.faces.HtmlDataTable
Component family: javax.faces.Data
Renderer type: javax.faces.Table
Renderer class: org.apache.myfaces.renderkit.html.HtmlTableRenderer

This component renders as an HTML table element. It has as its children h:column entities, which describe the columns of the table. It can be decorated with facets named "header" and "footer" to specify header and footer rows.

Unless otherwise specified, all attributes accept static values or EL expressions.

Extend standard UIData component to add support for html-specific features such as CSS style attributes and event handler scripts.

see Javadoc of JSF Specification

Supported Facets

Name Required Description
footer false
header false

Attributes

Name Type Supports EL? Description
bgcolor String Yes HTML: The background color of this element.
binding String Only EL Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.
border int Yes HTML: Specifies the width of the border of this element, in pixels. Deprecated in HTML 4.01.
cellpadding String Yes 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 String Yes 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 String Yes A comma separated list of CSS class names to apply to td elements in each column.
dir String Yes HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
first int Yes The index of the first row to be displayed, where 0 is the first row.
footerClass String Yes The CSS class to be applied to footer cells.
frame String Yes 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 String Yes The CSS class to be applied to header cells.
id String Yes 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.

lang String Yes HTML: The base language of this document.
onclick String Yes HTML: Script to be invoked when the element is clicked.
ondblclick String Yes HTML: Script to be invoked when the element is double-clicked.
onkeydown String Yes HTML: Script to be invoked when a key is pressed down over this element.
onkeypress String Yes HTML: Script to be invoked when a key is pressed over this element.
onkeyup String Yes HTML: Script to be invoked when a key is released over this element.
onmousedown String Yes HTML: Script to be invoked when the pointing device is pressed over this element.
onmousemove String Yes HTML: Script to be invoked when the pointing device is moved while it is in this element.
onmouseout String Yes HTML: Script to be invoked when the pointing device is moves out of this element.
onmouseover String Yes HTML: Script to be invoked when the pointing device is moved into this element.
onmouseup String Yes HTML: Script to be invoked when the pointing device is released over this element.
rendered boolean Yes A boolean value that indicates whether this component should be rendered. Default value: true.
rowClasses String Yes A comma separated list of CSS class names to apply to td elements in each row.
rows int Yes The number of rows to be displayed. Specify zero for all remaining rows in the table.
rules String Yes HTML: Controls how rules are rendered between cells. Values include: none, groups, rows, cols, and all.
style String Yes HTML: CSS styling instructions.
styleClass String Yes The CSS class for this element. Corresponds to the HTML 'class' attribute.
summary String Yes HTML: Provides a summary of the contents of the table, for accessibility purposes.
title String Yes HTML: An advisory title for this element. Often used by the user agent as a tooltip.
value Object Yes 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.
var String No Defines the name of the request-scope variable that will hold the current row during iteration. This value must be a static value.
width String Yes HTML: Specifies the desired width of the table, as a pixel length or a percentage of available space.