Class HtmlDataTable
- All Implemented Interfaces:
ClientBehaviorHolder
,NamingContainer
,PartialStateHolder
,StateHolder
,TransientStateHolder
,UniqueIdVendor
,ComponentSystemEventListener
,FacesListener
,SystemEventListenerHolder
,EventListener
public class HtmlDataTable extends UIData implements ClientBehaviorHolder
Represents a set of repeating data (segregated into columns by child UIColumn components) that will be rendered in an
HTML table
element.
By default, the rendererType
property must be set to "jakarta.faces.Table
". This value can
be changed by calling the setRendererType()
method.
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static class
HtmlDataTable.PropertyKeys
-
Field Summary
Fields Modifier and Type Field Description static String
COMPONENT_TYPE
The standard component type for this component.Fields inherited from class jakarta.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY
-
Constructor Summary
Constructors Constructor Description HtmlDataTable()
-
Method Summary
Modifier and Type Method Description String
getBgcolor()
Return the value of thebgcolor
property.String
getBodyrows()
Return the value of thebodyrows
property.int
getBorder()
Return the value of theborder
property.String
getCaptionClass()
Return the value of thecaptionClass
property.String
getCaptionStyle()
Return the value of thecaptionStyle
property.String
getCellpadding()
Return the value of thecellpadding
property.String
getCellspacing()
Return the value of thecellspacing
property.String
getColumnClasses()
Return the value of thecolumnClasses
property.String
getDefaultEventName()
This is a default implementation ofClientBehaviorHolder.getDefaultEventName()
.String
getDir()
Return the value of thedir
property.Collection<String>
getEventNames()
This is a default implementation ofClientBehaviorHolder.getEventNames()
.String
getFooterClass()
Return the value of thefooterClass
property.String
getFrame()
Return the value of theframe
property.String
getHeaderClass()
Return the value of theheaderClass
property.String
getLang()
Return the value of thelang
property.String
getOnclick()
Return the value of theonclick
property.String
getOndblclick()
Return the value of theondblclick
property.String
getOnkeydown()
Return the value of theonkeydown
property.String
getOnkeypress()
Return the value of theonkeypress
property.String
getOnkeyup()
Return the value of theonkeyup
property.String
getOnmousedown()
Return the value of theonmousedown
property.String
getOnmousemove()
Return the value of theonmousemove
property.String
getOnmouseout()
Return the value of theonmouseout
property.String
getOnmouseover()
Return the value of theonmouseover
property.String
getOnmouseup()
Return the value of theonmouseup
property.String
getRole()
Return the value of therole
property.String
getRowClass()
Return the value of therowClass
property.String
getRowClasses()
Return the value of therowClasses
property.String
getRules()
Return the value of therules
property.String
getStyle()
Return the value of thestyle
property.String
getStyleClass()
Return the value of thestyleClass
property.String
getSummary()
Return the value of thesummary
property.String
getTitle()
Return the value of thetitle
property.String
getWidth()
Return the value of thewidth
property.void
setBgcolor(String bgcolor)
Set the value of thebgcolor
property.void
setBodyrows(String bodyrows)
Set the value of thebodyrows
property.void
setBorder(int border)
Set the value of theborder
property.void
setCaptionClass(String captionClass)
Set the value of thecaptionClass
property.void
setCaptionStyle(String captionStyle)
Set the value of thecaptionStyle
property.void
setCellpadding(String cellpadding)
Set the value of thecellpadding
property.void
setCellspacing(String cellspacing)
Set the value of thecellspacing
property.void
setColumnClasses(String columnClasses)
Set the value of thecolumnClasses
property.void
setDir(String dir)
Set the value of thedir
property.void
setFooterClass(String footerClass)
Set the value of thefooterClass
property.void
setFrame(String frame)
Set the value of theframe
property.void
setHeaderClass(String headerClass)
Set the value of theheaderClass
property.void
setLang(String lang)
Set the value of thelang
property.void
setOnclick(String onclick)
Set the value of theonclick
property.void
setOndblclick(String ondblclick)
Set the value of theondblclick
property.void
setOnkeydown(String onkeydown)
Set the value of theonkeydown
property.void
setOnkeypress(String onkeypress)
Set the value of theonkeypress
property.void
setOnkeyup(String onkeyup)
Set the value of theonkeyup
property.void
setOnmousedown(String onmousedown)
Set the value of theonmousedown
property.void
setOnmousemove(String onmousemove)
Set the value of theonmousemove
property.void
setOnmouseout(String onmouseout)
Set the value of theonmouseout
property.void
setOnmouseover(String onmouseover)
Set the value of theonmouseover
property.void
setOnmouseup(String onmouseup)
Set the value of theonmouseup
property.void
setRole(String role)
Set the value of therole
property.void
setRowClass(String rowClass)
Set the value of therowClass
property.void
setRowClasses(String rowClasses)
Set the value of therowClasses
property.void
setRules(String rules)
Set the value of therules
property.void
setStyle(String style)
Set the value of thestyle
property.void
setStyleClass(String styleClass)
Set the value of thestyleClass
property.void
setSummary(String summary)
Set the value of thesummary
property.void
setTitle(String title)
Set the value of thetitle
property.void
setWidth(String width)
Set the value of thewidth
property.Methods inherited from class jakarta.faces.component.UIData
broadcast, createUniqueId, encodeBegin, getClientId, getDataModel, getFamily, getFirst, getFooter, getHeader, getRowCount, getRowData, getRowIndex, getRows, getValue, getVar, invokeOnComponent, isRowAvailable, isRowStatePreserved, markInitialState, processDecodes, processUpdates, processValidators, queueEvent, restoreState, saveState, setDataModel, setFirst, setFooter, setHeader, setRowIndex, setRows, setRowStatePreserved, setValue, setValueBinding, setValueExpression, setVar, visitTree
Methods inherited from class jakarta.faces.component.UIComponentBase
addClientBehavior, addFacesListener, clearInitialState, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent
Methods inherited from class jakarta.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors
-
Field Details
-
COMPONENT_TYPE
The standard component type for this component.
- See Also:
- Constant Field Values
-
-
Constructor Details
-
HtmlDataTable
public HtmlDataTable()
-
-
Method Details
-
getBgcolor
Return the value of the
bgcolor
property.- Returns:
- the property value
Contents: Name or code of the background color for this table.
-
setBgcolor
Set the value of the
bgcolor
property.- Parameters:
bgcolor
- the new property value
-
getBodyrows
Return the value of the
bodyrows
property.- 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).
-
setBodyrows
Set the value of the
bodyrows
property.- Parameters:
bodyrows
- the new property value
-
getBorder
public int getBorder()Return the value of the
border
property.- Returns:
- the property value
Contents: Width (in pixels) of the border to be drawn around this table.
-
setBorder
public void setBorder(int border)Set the value of the
border
property.- Parameters:
border
- the new property value
-
getCaptionClass
Return the value of the
captionClass
property.- Returns:
- the property value
Contents: Space-separated list of CSS style class(es) that will be applied to any caption generated for this table.
-
setCaptionClass
Set the value of the
captionClass
property.- Parameters:
captionClass
- the new property value
-
getCaptionStyle
Return the value of the
captionStyle
property.- Returns:
- the property value
Contents: CSS style(s) to be applied when this caption is rendered.
-
setCaptionStyle
Set the value of the
captionStyle
property.- Parameters:
captionStyle
- the new property value
-
getCellpadding
Return the value of the
cellpadding
property.- Returns:
- the property value
Contents: Definition of how much space the user agent should leave between the border of each cell and its contents.
-
setCellpadding
Set the value of the
cellpadding
property.- Parameters:
cellpadding
- the new property value
-
getCellspacing
Return the value of the
cellspacing
property.- 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.
-
setCellspacing
Set the value of the
cellspacing
property.- Parameters:
cellspacing
- the new property value
-
getColumnClasses
Return the value of the
columnClasses
property.- 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.
-
setColumnClasses
Set the value of the
columnClasses
property.- Parameters:
columnClasses
- the new property value
-
getDir
Return the value of the
dir
property.- 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.
-
setDir
Set the value of the
dir
property.- Parameters:
dir
- the new property value
-
getFooterClass
Return the value of the
footerClass
property.- Returns:
- the property value
Contents: Space-separated list of CSS style class(es) that will be applied to any footer generated for this table.
-
setFooterClass
Set the value of the
footerClass
property.- Parameters:
footerClass
- the new property value
-
getFrame
Return the value of the
frame
property.- 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).
-
setFrame
Set the value of the
frame
property.- Parameters:
frame
- the new property value
-
getHeaderClass
Return the value of the
headerClass
property.- Returns:
- the property value
Contents: Space-separated list of CSS style class(es) that will be applied to any header generated for this table.
-
setHeaderClass
Set the value of the
headerClass
property.- Parameters:
headerClass
- the new property value
-
getLang
Return the value of the
lang
property.- Returns:
- the property value
Contents: Code describing the language used in the generated markup for this component.
-
setLang
Set the value of the
lang
property.- Parameters:
lang
- the new property value
-
getOnclick
Return the value of the
onclick
property.- Returns:
- the property value
Contents: Javascript code executed when a pointer button is clicked over this element.
-
setOnclick
Set the value of the
onclick
property.- Parameters:
onclick
- the new property value
-
getOndblclick
Return the value of the
ondblclick
property.- Returns:
- the property value
Contents: Javascript code executed when a pointer button is double clicked over this element.
-
setOndblclick
Set the value of the
ondblclick
property.- Parameters:
ondblclick
- the new property value
-
getOnkeydown
Return the value of the
onkeydown
property.- Returns:
- the property value
Contents: Javascript code executed when a key is pressed down over this element.
-
setOnkeydown
Set the value of the
onkeydown
property.- Parameters:
onkeydown
- the new property value
-
getOnkeypress
Return the value of the
onkeypress
property.- Returns:
- the property value
Contents: Javascript code executed when a key is pressed and released over this element.
-
setOnkeypress
Set the value of the
onkeypress
property.- Parameters:
onkeypress
- the new property value
-
getOnkeyup
Return the value of the
onkeyup
property.- Returns:
- the property value
Contents: Javascript code executed when a key is released over this element.
-
setOnkeyup
Set the value of the
onkeyup
property.- Parameters:
onkeyup
- the new property value
-
getOnmousedown
Return the value of the
onmousedown
property.- Returns:
- the property value
Contents: Javascript code executed when a pointer button is pressed down over this element.
-
setOnmousedown
Set the value of the
onmousedown
property.- Parameters:
onmousedown
- the new property value
-
getOnmousemove
Return the value of the
onmousemove
property.- Returns:
- the property value
Contents: Javascript code executed when a pointer button is moved within this element.
-
setOnmousemove
Set the value of the
onmousemove
property.- Parameters:
onmousemove
- the new property value
-
getOnmouseout
Return the value of the
onmouseout
property.- Returns:
- the property value
Contents: Javascript code executed when a pointer button is moved away from this element.
-
setOnmouseout
Set the value of the
onmouseout
property.- Parameters:
onmouseout
- the new property value
-
getOnmouseover
Return the value of the
onmouseover
property.- Returns:
- the property value
Contents: Javascript code executed when a pointer button is moved onto this element.
-
setOnmouseover
Set the value of the
onmouseover
property.- Parameters:
onmouseover
- the new property value
-
getOnmouseup
Return the value of the
onmouseup
property.- Returns:
- the property value
Contents: Javascript code executed when a pointer button is released over this element.
-
setOnmouseup
Set the value of the
onmouseup
property.- Parameters:
onmouseup
- the new property value
-
getRole
Return the value of the
role
property.- 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.
-
setRole
Set the value of the
role
property.- Parameters:
role
- the new property value
-
getRowClass
Return the value of the
rowClass
property.- Returns:
- the property value
Contents:
Assigns one or more space-separated CSS class names to each "tr"
-
setRowClass
Set the value of the
rowClass
property.- Parameters:
rowClass
- the new property value
-
getRowClasses
Return the value of the
rowClasses
property.- 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.
-
setRowClasses
Set the value of the
rowClasses
property.- Parameters:
rowClasses
- the new property value
-
getRules
Return the value of the
rules
property.- 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).
-
setRules
Set the value of the
rules
property.- Parameters:
rules
- the new property value
-
getStyle
Return the value of the
style
property.- Returns:
- the property value
Contents: CSS style(s) to be applied when this component is rendered.
-
setStyle
Set the value of the
style
property.- Parameters:
style
- the new property value
-
getStyleClass
Return the value of the
styleClass
property.- 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.
-
setStyleClass
Set the value of the
styleClass
property.- Parameters:
styleClass
- the new property value
-
getSummary
Return the value of the
summary
property.- 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.
-
setSummary
Set the value of the
summary
property.- Parameters:
summary
- the new property value
-
getTitle
Return the value of the
title
property.- Returns:
- the property value
Contents: Advisory title information about markup elements generated for this component.
-
setTitle
Set the value of the
title
property.- Parameters:
title
- the new property value
-
getWidth
Return the value of the
width
property.- Returns:
- the property value
Contents: Width of the entire table, for visual user agents.
-
setWidth
Set the value of the
width
property.- Parameters:
width
- the new property value
-
getEventNames
Description copied from class:UIComponentBase
This is a default implementation of
ClientBehaviorHolder.getEventNames()
.UIComponent
does not implement theClientBehaviorHolder
interface, but provides default implementations for the methods defined byClientBehaviorHolder
to simplify subclass implementations. Subclasses that wish to support theClientBehaviorHolder
contract must declare that the subclass implementsClientBehaviorHolder
, and must override this method to return a non-EmptyCollection
of the client event names that the component supports.- Specified by:
getEventNames
in interfaceClientBehaviorHolder
- Overrides:
getEventNames
in classUIComponentBase
- Returns:
- the collection of event names.
-
getDefaultEventName
Description copied from class:UIComponentBase
This is a default implementation of
ClientBehaviorHolder.getDefaultEventName()
.UIComponent
does not implement theClientBehaviorHolder
interface, but provides default implementations for the methods defined byClientBehaviorHolder
to simplify subclass implementations. Subclasses that wish to support theClientBehaviorHolder
contract must declare that the subclass implementsClientBehaviorHolder
, and must provide an implementation ofClientBehaviorHolder.getEventNames()
.- Specified by:
getDefaultEventName
in interfaceClientBehaviorHolder
- Overrides:
getDefaultEventName
in classUIComponentBase
- Returns:
- the default event name.
-