Top Description Inners Fields Constructors Methods
jakarta.faces.component.html

public Class HtmlPanelGrid

extends UIPanel
implements ClientBehaviorHolder
Class Inheritance
All Implemented Interfaces
jakarta.faces.component.behavior.ClientBehaviorHolder
Static Imports
jakarta.faces.component.html.HtmlComponentUtils.handleAttribute

Renders child components in a table, starting a new row after the specified number of columns.

By default, the rendererType property must be set to "jakarta.faces.Grid". This value can be changed by calling the setRendererType() method.

Nested and Inner Type Summary

Modifier and TypeClass and Description
protected static enum
HtmlPanelGrid.PropertyKeys

Properties used by this component

Field Summary

Modifier and TypeField and Description
public static final String
COMPONENT_TYPE

Hides jakarta.faces.component.UIPanel.COMPONENT_TYPE.

The standard component type for this component.

private static final Collection<String>
EVENT_NAMES

Inherited from jakarta.faces.component.UIPanel:
COMPONENT_FAMILY

Constructor Summary

AccessConstructor and Description
public
HtmlPanelGrid()

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the property value

Contents: Name or code of the background color for this table.

getBgcolor()

Return the value of the bgcolor property.

public String

Returns:

the property value

Contents: Comma separated list of row indices for which a new "tbody" element should be started (and any previously opened one should be ended).

getBodyrows()

Return the value of the bodyrows property.

public int

Returns:

the property value

Contents: Width (in pixels) of the border to be drawn around this table.

getBorder()

Return the value of the border property.

public String

Returns:

the property value

Contents: Space-separated list of CSS style class(es) that will be applied to any caption generated for this table.

getCaptionClass()

Return the value of the captionClass property.

public String

Returns:

the property value

Contents: CSS style(s) to be applied when this caption is rendered.

getCaptionStyle()

Return the value of the captionStyle property.

public String

Returns:

the property value

Contents: Definition of how much space the user agent should leave between the border of each cell and its contents.

getCellpadding()

Return the value of the cellpadding property.

public String

Returns:

the property value

Contents: 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.

getCellspacing()

Return the value of the cellspacing property.

public String

Returns:

the property value

Contents: 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.

getColumnClasses()

Return the value of the columnClasses property.

public int

Returns:

the property value

Contents: The number of columns to render before starting a new row.

getColumns()

Return the value of the columns property.

public String
getDefaultEventName()

Overrides jakarta.faces.component.UIComponentBase.getDefaultEventName.

Implements jakarta.faces.component.behavior.ClientBehaviorHolder.getDefaultEventName.

Returns the default event name for this ClientBehaviorHolder implementation.

public String

Returns:

the property value

Contents: Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). These attributes are case sensitive when rendering to XHTML, so care must be taken to have the correct case.

getDir()

Return the value of the dir property.

public Collection<String>
getEventNames()

Overrides jakarta.faces.component.UIComponentBase.getEventNames.

Implements jakarta.faces.component.behavior.ClientBehaviorHolder.getEventNames.

Returns a non-null, unmodifiable Collection containing the names of the logical events supported by the component implementing this interface.

public String

Returns:

the property value

Contents: Space-separated list of CSS style class(es) that will be applied to any footer generated for this table.

getFooterClass()

Return the value of the footerClass property.

public String

Returns:

the property value

Contents: 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).

getFrame()

Return the value of the frame property.

public String

Returns:

the property value

Contents: Space-separated list of CSS style class(es) that will be applied to any header generated for this table.

getHeaderClass()

Return the value of the headerClass property.

public String

Returns:

the property value

Contents: Code describing the language used in the generated markup for this component.

getLang()

Return the value of the lang property.

public String

Returns:

the property value

Contents: Javascript code executed when a pointer button is clicked over this element.

getOnclick()

Return the value of the onclick property.

public String

Returns:

the property value

Contents: Javascript code executed when a pointer button is double clicked over this element.

getOndblclick()

Return the value of the ondblclick property.

public String

Returns:

the property value

Contents: Javascript code executed when a key is pressed down over this element.

getOnkeydown()

Return the value of the onkeydown property.

public String

Returns:

the property value

Contents: Javascript code executed when a key is pressed and released over this element.

getOnkeypress()

Return the value of the onkeypress property.

public String

Returns:

the property value

Contents: Javascript code executed when a key is released over this element.

getOnkeyup()

Return the value of the onkeyup property.

public String

Returns:

the property value

Contents: Javascript code executed when a pointer button is pressed down over this element.

getOnmousedown()

Return the value of the onmousedown property.

public String

Returns:

the property value

Contents: Javascript code executed when a pointer button is moved within this element.

getOnmousemove()

Return the value of the onmousemove property.

public String

Returns:

the property value

Contents: Javascript code executed when a pointer button is moved away from this element.

getOnmouseout()

Return the value of the onmouseout property.

public String

Returns:

the property value

Contents: Javascript code executed when a pointer button is moved onto this element.

getOnmouseover()

Return the value of the onmouseover property.

public String

Returns:

the property value

Contents: Javascript code executed when a pointer button is released over this element.

getOnmouseup()

Return the value of the onmouseup property.

public String

Returns:

the property value

Contents:

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.

getRole()

Return the value of the role property.

public String

Returns:

the property value

Contents:

Assigns one or more space-separated CSS class names to each "tr"

getRowClass()

Return the value of the rowClass property.

public String

Returns:

the property value

Contents: 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.

getRowClasses()

Return the value of the rowClasses property.

public String

Returns:

the property value

Contents: 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).

getRules()

Return the value of the rules property.

public String

Returns:

the property value

Contents: CSS style(s) to be applied when this component is rendered.

getStyle()

Return the value of the style property.

public String

Returns:

the property value

Contents: 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.

getStyleClass()

Return the value of the styleClass property.

public String

Returns:

the property value

Contents: Summary of this table's purpose and structure, for user agents rendering to non-visual media such as speech and Braille.

getSummary()

Return the value of the summary property.

public String

Returns:

the property value

Contents: Advisory title information about markup elements generated for this component.

getTitle()

Return the value of the title property.

public String

Returns:

the property value

Contents: Width of the entire table, for visual user agents.

getWidth()

Return the value of the width property.

public void
setBgcolor(String
the new property value
bgcolor)

Set the value of the bgcolor property.

public void
setBodyrows(String
the new property value
bodyrows)

Set the value of the bodyrows property.

public void
setBorder(int
the new property value
border)

Set the value of the border property.

public void
setCaptionClass(String
the new property value
captionClass)

Set the value of the captionClass property.

public void
setCaptionStyle(String
the new property value
captionStyle)

Set the value of the captionStyle property.

public void
setCellpadding(String
the new property value
cellpadding)

Set the value of the cellpadding property.

public void
setCellspacing(String
the new property value
cellspacing)

Set the value of the cellspacing property.

public void
setColumnClasses(String
the new property value
columnClasses)

Set the value of the columnClasses property.

public void
setColumns(int
the new property value
columns)

Set the value of the columns property.

public void
setDir(String
the new property value
dir)

Set the value of the dir property.

public void
setFooterClass(String
the new property value
footerClass)

Set the value of the footerClass property.

public void
setFrame(String
the new property value
frame)

Set the value of the frame property.

public void
setHeaderClass(String
the new property value
headerClass)

Set the value of the headerClass property.

public void
setLang(String
the new property value
lang)

Set the value of the lang property.

public void
setOnclick(String
the new property value
onclick)

Set the value of the onclick property.

public void
setOndblclick(String
the new property value
ondblclick)

Set the value of the ondblclick property.

public void
setOnkeydown(String
the new property value
onkeydown)

Set the value of the onkeydown property.

public void
setOnkeypress(String
the new property value
onkeypress)

Set the value of the onkeypress property.

public void
setOnkeyup(String
the new property value
onkeyup)

Set the value of the onkeyup property.

public void
setOnmousedown(String
the new property value
onmousedown)

Set the value of the onmousedown property.

public void
setOnmousemove(String
the new property value
onmousemove)

Set the value of the onmousemove property.

public void
setOnmouseout(String
the new property value
onmouseout)

Set the value of the onmouseout property.

public void
setOnmouseover(String
the new property value
onmouseover)

Set the value of the onmouseover property.

public void
setOnmouseup(String
the new property value
onmouseup)

Set the value of the onmouseup property.

public void
setRole(String
the new property value
role)

Set the value of the role property.

public void
setRowClass(String
the new property value
rowClass)

Set the value of the rowClass property.

public void
setRowClasses(String
the new property value
rowClasses)

Set the value of the rowClasses property.

public void
setRules(String
the new property value
rules)

Set the value of the rules property.

public void
setStyle(String
the new property value
style)

Set the value of the style property.

public void
setStyleClass(String
the new property value
styleClass)

Set the value of the styleClass property.

public void
setSummary(String
the new property value
summary)

Set the value of the summary property.

public void
setTitle(String
the new property value
title)

Set the value of the title property.

public void
setWidth(String
the new property value
width)

Set the value of the width property.

Inherited from jakarta.faces.component.UIPanel:
getFamily