Renders an HTML "table" element compliant with the HTML 401 specification. Render the "caption" facet, if present, inside a "caption" element immediately below the "table" element. If the "captionClass" attribute is specified, render its value as the value of the "class" attribute on the "caption" element. If the "captionStyle" attribute is specified, render its value as the value of the "style" attribute on the "caption" element.
Please consult the javadoc for UIData
to
supplement this specification. If the "styleClass" attribute is
specified, render its value as the value of the "class" attribute
on the "table" element. Any pass-through attributes are also
rendered on the "table" element.
Column Groups
If the UIData component has a
"colgroups" facet,
render its contents. Consistent with the rules of facets in
general, this facet must have only one child. In general, this
will be a panel group component that will
contain
colgroup and col
elements per the HTML
Table specification. Use of column grouping can improve
accessibility. This facet must be rendered before the table
header and footer.
Rendering the header
If the UIData component has a
"header" facet, or
any of the child UIColumn components has a
"header"
facet, render a "thead" element. If the UIData
component has a "header" facet, encode its contents inside of "tr"
and "th" elements, respectively. Output the value of the
"headerClass" attribute of the UIData
component, if
present, as the value of the "class" attribute on the "th".
Output the number of child UIColumn
components of the
UIData component as the value of the
"colspan"
attribute on the "th". Output "colgroup" as the value of the
"scope" attribute on the "th" element.
If any of the child UIColumn
components has a
"header" facet render a "tr" element. For each
UIColumn that actually has a "header"
facet, render
it inside of a "th" element. Columns that don't have a "header"
facet cause an empty "th" element to be rendered. Output the
value of the "headerClass" attribute of the UIColumn
component, if present, as the value of the "class" attribute on
the "th". If the "headerClass" attribute of the UIColumn
component is not present, output the value of the "headerClass"
attribute of the UIData component, if
present, as
the value of the "class" attribute on the "th". Output "col" as
the value of the "scope" attribute on the "th" element.
Close out the "thead" element.
Rendering the footer
Follow the same process as for the header, except replace "header" with "footer", "th" with "td", "thead" with "tfoot", and "headerClass" with "footerClass". Do not render any "scope" attribute for the footer.
Rendering the table body
Look at the value of the "bodyrows" attribute. If present, this must be a comma separated list of integers. Each entry in this list is the row index of the row before which a "tbody" element should be rendered.
If there was no "bodyrows" attribute, or it was empty,
render a
"tbody" element. Keep track of the result of the "rows" property
on the UIData component. Keep track of the
number of
rows we have rendered so far. Iterate through the rows. Set the
"rowIndex" property of the UIData component
to be
correct as we iterate through the rows. Stop rendering children
and close out the "tbody" element if the "rowAvailable" property
of the UIData returned false. If the
current row
index is contained in the "bodyrows" attribute, check if a "tbody"
start element was rendered that needs to be closed, and if so,
close the "tbody" element. Then render a "tbody" element start.
Otherwise, do not render a "tbody" element.
Output a "tr" element. Output the value of the "rowClasses"
per the attribute description below. For each
UIColumn child, if the column component has
a
"rowHeader" attribute with a value of "true", output a "th"
element with a "scope" attribute with the value of "row".
Otherwise, if the column component has no "rowHeader" attribute,
or its value is false, output a "td" element. In either case
attach the value of the "columnClasses" attribute of the
UIData component per the attribute
description below.
Recursively encode each child of each UIColumn
child.
Close out the "td" or "th" element. When done with the row, close
out the "tr" element. When done with all the rows, close out the
"tbody" element.
When done rendering all the rows, set the "rowIndex"
property of
the UIData to -1, and close out the "table"
element.
| Info | Value |
|---|---|
| Component Type | jakarta.faces.HtmlDataTable |
| Handler Class | None |
| Renderer Type | jakarta.faces.Table |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
first | false | jakarta.el.ValueExpression
(must evaluate to int)
| Zero-relative row number of the first row to be displayed. If this property is set to zero, rendering will begin with the first row of the underlying data. |
id | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| The component identifier for this component. This value must be unique within the closest parent component that is a naming container. |
rendered | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value for this property is true. |
rows | false | jakarta.el.ValueExpression
(must evaluate to int)
| The number of rows to display, starting with the one identified by the "first" property. If this value is set to zero, all available rows in the underlying data model will be displayed. |
value | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| The current value of this component. |
var | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of a request-scope attribute under which the model data for the row selected by the current value of the "rowIndex" property (i.e. also the current value of the "rowData" property) will be exposed. |
bgcolor | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name or code of the background color for this table. |
bodyrows | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Comma separated list of row indices for which a new "tbody" element should be started (and any previously opened one should be ended). |
border | false | jakarta.el.ValueExpression
(must evaluate to int)
| Width (in pixels) of the border to be drawn around this table. |
captionClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Space-separated list of CSS style class(es) that will be applied to any caption generated for this table. |
captionStyle | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| CSS style(s) to be applied when this caption is rendered. |
cellpadding | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Definition of how much space the user agent should leave between the border of each cell and its contents. |
cellspacing | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Definition of how much space the user agent should leave between the left side of the table and the leftmost column, the top of the table and the top of the top side of the topmost row, and so on for the right and bottom of the table. It also specifies the amount of space to leave between cells. |
columnClasses | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Comma-delimited list of CSS style classes that will be applied to the columns of this table. A space separated list of classes may also be specified for any individual column. If the number of elements in this list is less than the number of actual column children of the UIData, no "class" attribute is output for each column greater than the number of elements in the list. If the number of elements in the list is greater than the number of actual column children of the UIData, the elements at the posisiton in the list after the last column are ignored. |
dir | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). |
footerClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Space-separated list of CSS style class(es) that will be applied to any footer generated for this table. |
frame | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Code specifying which sides of the frame surrounding this table will be visible. Valid values are: none (no sides, default value); above (top side only); below (bottom side only); hsides (top and bottom sides only); vsides (right and left sides only); lhs (left hand side only); rhs (right hand side only); box (all four sides); and border (all four sides). |
headerClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Space-separated list of CSS style class(es) that will be applied to any header generated for this table. |
lang | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Code describing the language used in the generated markup for this component. |
onclick | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is clicked over this element. |
ondblclick | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is double clicked over this element. |
onkeydown | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a key is pressed down over this element. |
onkeypress | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a key is pressed and released over this element. |
onkeyup | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a key is released over this element. |
onmousedown | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is pressed down over this element. |
onmousemove | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is moved within this element. |
onmouseout | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is moved away from this element. |
onmouseover | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is moved onto this element. |
onmouseup | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is released over this element. |
rowClasses | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Comma-delimited list of CSS style classes that will be applied to the rows of this table. A space separated list of classes may also be specified for any individual row. Thes styles are applied, in turn, to each row in the table. For example, if the list has two elements, the first style class in the list is applied to the first row, the second to the second row, the first to the third row, the second to the fourth row, etc. In other words, we keep iterating through the list until we reach the end, and then we start at the beginning again. |
rules | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Code specifying which rules will appear between cells within this table. Valid values are: none (no rules, default value); groups (between row groups); rows (between rows only); cols (between columns only); and all (between all rows and columns). |
style | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| CSS style(s) to be applied when this component is rendered. |
styleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup. |
summary | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Summary of this table's purpose and structure, for user agents rendering to non-visual media such as speech and Braille. |
title | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Advisory title information about markup elements generated for this component. |
width | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Width of the entire table, for visual user agents. |
binding | false | jakarta.el.ValueExpression
(must evaluate to jakarta.faces.component.UIComponent)
| The ValueExpression linking this component to a property in a backing bean |
role | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
|
Per the WAI-ARIA spec and its relationship to HTML5 (Section title ARIA Role Attriubute), every HTML element may have a "role" attribute whose value must be passed through unmodified on the element on which it is declared in the final rendered markup. The attribute, if specified, must have a value that is a string literal that is, or an EL Expression that evaluates to, a set of space-separated tokens representing the various WAI-ARIA roles that the element belongs to. It is the page author's responsibility to ensure that the user agent is capable of correctly interpreting the value of this attribute. |