facesdoc.HTML_BASIC.javax.faces.Paneljavax.faces.Grid.html Maven / Gradle / Ivy
Show all versions of javax.faces-api Show documentation
<font size="-1">component-family:</font> javax.faces.Panel <font size="-1">renderer-type:</font> javax.faces.Grid
HTML_BASIC render-kit
component-family: javax.faces.Panel renderer-type: javax.faces.Grid
Renders an HTML "table" element, conforming to the
rules in 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. If the "styleClass" attribute is specified, render
its value as the value of the "class" attribute. Render the pass-through
attributes in the table below. Render the "header" facet, if present, inside of
"thead", "tr", and "th" elements, nested in that order. If the
"headerClass" attribute is specifed, render its value as the value
of the "class" attribute on the "th" element. Render "colgroup"
as the value of the "scope" attribute. Render the value of the
"columns" attribute as the value of the "colspan" attribute on the
"th" element. Render the "footer" facet if present, using similar
logic to the rendering of the "header", but replacing "thead" with
"tfoot", "th" with "td", and "headerClass" with "footerClass".
Render the children of the UIPanel component inside
of a "tbody" element. Render the children based on the value of
the "columns" attribute, creating a new row each time a "columns"
worth of children have been rendered. For the start of each row,
render a "tr" element. Output the value of the "rowClasses" per
the attribute description below. For each child, output a "td"
element, attaching the value of the "columnClasses" attribute per
the attribute description below. Recursively encode each child.
Close out the "td" element. When done with the row, close out the
"tr" element. If a child has "rendered==false" it is not rendered,
and the column counter must not be incremented.
This renderer is responsible for rendering its children.
Note:
Attributes with a pass-through value of
true are not interpreted by the renderer and are passed
straight through to the rendered markup, without checking for validity. Attributes with a
pass-through value of false are interpreted
by the renderer, and may or may not be checked for validity by the renderer.
Attributes
attribute-name
pass-through
attribute-class
description
default-value
bgcolor
true
java.lang.String
Name or code of the background color for this table.
undefined
bodyrows
false
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).
undefined
border
true
int
Width (in pixels) of the border to be drawn
around this table.
undefined
captionClass
false
java.lang.String
Space-separated list of CSS style class(es) that will be
applied to any caption generated for this table.
undefined
captionStyle
false
java.lang.String
CSS style(s) to be applied when this caption is rendered.
undefined
cellpadding
true
java.lang.String
Definition of how much space the user agent should
leave between the border of each cell and its contents.
undefined
cellspacing
true
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.
undefined
columnClasses
false
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.
undefined
columns
false
int
The number of columns to render before
starting a new row.
undefined
dir
true
java.lang.String
Direction indication for text that does not inherit directionality.
Valid values are "LTR" (left-to-right) and "RTL" (right-to-left).
undefined
footerClass
false
java.lang.String
Space-separated list of CSS style class(es) that will be
applied to any footer generated for this table.
undefined
frame
true
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).
undefined
headerClass
false
java.lang.String
Space-separated list of CSS style class(es) that will be
applied to any header generated for this table.
undefined
lang
true
java.lang.String
Code describing the language used in the generated markup
for this component.
undefined
onclick
true
java.lang.String
Javascript code executed when a pointer button is
clicked over this element.
undefined
ondblclick
true
java.lang.String
Javascript code executed when a pointer button is
double clicked over this element.
undefined
onkeydown
true
java.lang.String
Javascript code executed when a key is
pressed down over this element.
undefined
onkeypress
true
java.lang.String
Javascript code executed when a key is
pressed and released over this element.
undefined
onkeyup
true
java.lang.String
Javascript code executed when a key is
released over this element.
undefined
onmousedown
true
java.lang.String
Javascript code executed when a pointer button is
pressed down over this element.
undefined
onmousemove
true
java.lang.String
Javascript code executed when a pointer button is
moved within this element.
undefined
onmouseout
true
java.lang.String
Javascript code executed when a pointer button is
moved away from this element.
undefined
onmouseover
true
java.lang.String
Javascript code executed when a pointer button is
moved onto this element.
undefined
onmouseup
true
java.lang.String
Javascript code executed when a pointer button is
released over this element.
undefined
rowClasses
false
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.
undefined
rules
true
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).
undefined
style
true
java.lang.String
CSS style(s) to be applied when this component is rendered.
undefined
styleClass
false
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.
undefined
summary
true
java.lang.String
Summary of this table's purpose and structure, for
user agents rendering to non-visual media such as
speech and Braille.
undefined
title
true
java.lang.String
Advisory title information about markup elements generated
for this component.
undefined
width
true
java.lang.String
Width of the entire table, for visual user agents.
undefined
Copyright (c) 2003-2010 Oracle America, Inc. All Rights Reserved.