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 "javax.faces.Table
".
This value can be changed by calling the setRendererType()
method.
Modifier and Type | Class and Description |
---|---|
protected static class |
HtmlDataTable.PropertyKeys |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENT_TYPE
The standard component type for this component.
|
COMPONENT_FAMILY
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
SEPARATOR_CHAR
Constructor and Description |
---|
HtmlDataTable() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getBgcolor()
Return the value of the
bgcolor property. |
java.lang.String |
getBodyrows()
Return the value of the
bodyrows property. |
int |
getBorder()
Return the value of the
border property. |
java.lang.String |
getCaptionClass()
Return the value of the
captionClass property. |
java.lang.String |
getCaptionStyle()
Return the value of the
captionStyle property. |
java.lang.String |
getCellpadding()
Return the value of the
cellpadding property. |
java.lang.String |
getCellspacing()
Return the value of the
cellspacing property. |
java.lang.String |
getColumnClasses()
Return the value of the
columnClasses property. |
java.lang.String |
getDefaultEventName()
This is a default implementation of
|
java.lang.String |
getDir()
Return the value of the
dir property. |
java.util.Collection<java.lang.String> |
getEventNames()
This is a default implementation of
|
java.lang.String |
getFooterClass()
Return the value of the
footerClass property. |
java.lang.String |
getFrame()
Return the value of the
frame property. |
java.lang.String |
getHeaderClass()
Return the value of the
headerClass property. |
java.lang.String |
getLang()
Return the value of the
lang property. |
java.lang.String |
getOnclick()
Return the value of the
onclick property. |
java.lang.String |
getOndblclick()
Return the value of the
ondblclick property. |
java.lang.String |
getOnkeydown()
Return the value of the
onkeydown property. |
java.lang.String |
getOnkeypress()
Return the value of the
onkeypress property. |
java.lang.String |
getOnkeyup()
Return the value of the
onkeyup property. |
java.lang.String |
getOnmousedown()
Return the value of the
onmousedown property. |
java.lang.String |
getOnmousemove()
Return the value of the
onmousemove property. |
java.lang.String |
getOnmouseout()
Return the value of the
onmouseout property. |
java.lang.String |
getOnmouseover()
Return the value of the
onmouseover property. |
java.lang.String |
getOnmouseup()
Return the value of the
onmouseup property. |
java.lang.String |
getRole()
Return the value of the
role property. |
java.lang.String |
getRowClass()
Return the value of the
rowClass property. |
java.lang.String |
getRowClasses()
Return the value of the
rowClasses property. |
java.lang.String |
getRules()
Return the value of the
rules property. |
java.lang.String |
getStyle()
Return the value of the
style property. |
java.lang.String |
getStyleClass()
Return the value of the
styleClass property. |
java.lang.String |
getSummary()
Return the value of the
summary property. |
java.lang.String |
getTitle()
Return the value of the
title property. |
java.lang.String |
getWidth()
Return the value of the
width property. |
void |
setBgcolor(java.lang.String bgcolor)
Set the value of the
bgcolor property. |
void |
setBodyrows(java.lang.String bodyrows)
Set the value of the
bodyrows property. |
void |
setBorder(int border)
Set the value of the
border property. |
void |
setCaptionClass(java.lang.String captionClass)
Set the value of the
captionClass property. |
void |
setCaptionStyle(java.lang.String captionStyle)
Set the value of the
captionStyle property. |
void |
setCellpadding(java.lang.String cellpadding)
Set the value of the
cellpadding property. |
void |
setCellspacing(java.lang.String cellspacing)
Set the value of the
cellspacing property. |
void |
setColumnClasses(java.lang.String columnClasses)
Set the value of the
columnClasses property. |
void |
setDir(java.lang.String dir)
Set the value of the
dir property. |
void |
setFooterClass(java.lang.String footerClass)
Set the value of the
footerClass property. |
void |
setFrame(java.lang.String frame)
Set the value of the
frame property. |
void |
setHeaderClass(java.lang.String headerClass)
Set the value of the
headerClass property. |
void |
setLang(java.lang.String lang)
Set the value of the
lang property. |
void |
setOnclick(java.lang.String onclick)
Set the value of the
onclick property. |
void |
setOndblclick(java.lang.String ondblclick)
Set the value of the
ondblclick property. |
void |
setOnkeydown(java.lang.String onkeydown)
Set the value of the
onkeydown property. |
void |
setOnkeypress(java.lang.String onkeypress)
Set the value of the
onkeypress property. |
void |
setOnkeyup(java.lang.String onkeyup)
Set the value of the
onkeyup property. |
void |
setOnmousedown(java.lang.String onmousedown)
Set the value of the
onmousedown property. |
void |
setOnmousemove(java.lang.String onmousemove)
Set the value of the
onmousemove property. |
void |
setOnmouseout(java.lang.String onmouseout)
Set the value of the
onmouseout property. |
void |
setOnmouseover(java.lang.String onmouseover)
Set the value of the
onmouseover property. |
void |
setOnmouseup(java.lang.String onmouseup)
Set the value of the
onmouseup property. |
void |
setRole(java.lang.String role)
Set the value of the
role property. |
void |
setRowClass(java.lang.String rowClass)
Set the value of the
rowClass property. |
void |
setRowClasses(java.lang.String rowClasses)
Set the value of the
rowClasses property. |
void |
setRules(java.lang.String rules)
Set the value of the
rules property. |
void |
setStyle(java.lang.String style)
Set the value of the
style property. |
void |
setStyleClass(java.lang.String styleClass)
Set the value of the
styleClass property. |
void |
setSummary(java.lang.String summary)
Set the value of the
summary property. |
void |
setTitle(java.lang.String title)
Set the value of the
title property. |
void |
setWidth(java.lang.String width)
Set the value of the
width property. |
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
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
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addClientBehavior, getClientBehaviors
public static final java.lang.String COMPONENT_TYPE
The standard component type for this component.
public java.lang.String getBgcolor()
Return the value of the bgcolor
property.
Contents: Name or code of the background color for this table.
public void setBgcolor(java.lang.String bgcolor)
Set the value of the bgcolor
property.
bgcolor
- the new property valuepublic java.lang.String getBodyrows()
Return the value of the bodyrows
property.
Contents: Comma separated list of row indices for which a new "tbody" element should be started (and any previously opened one should be ended).
public void setBodyrows(java.lang.String bodyrows)
Set the value of the bodyrows
property.
bodyrows
- the new property valuepublic int getBorder()
Return the value of the border
property.
Contents: Width (in pixels) of the border to be drawn around this table.
public void setBorder(int border)
Set the value of the border
property.
border
- the new property valuepublic java.lang.String getCaptionClass()
Return the value of the captionClass
property.
Contents: Space-separated list of CSS style class(es) that will be applied to any caption generated for this table.
public void setCaptionClass(java.lang.String captionClass)
Set the value of the captionClass
property.
captionClass
- the new property valuepublic java.lang.String getCaptionStyle()
Return the value of the captionStyle
property.
Contents: CSS style(s) to be applied when this caption is rendered.
public void setCaptionStyle(java.lang.String captionStyle)
Set the value of the captionStyle
property.
captionStyle
- the new property valuepublic java.lang.String getCellpadding()
Return the value of the cellpadding
property.
Contents: Definition of how much space the user agent should leave between the border of each cell and its contents.
public void setCellpadding(java.lang.String cellpadding)
Set the value of the cellpadding
property.
cellpadding
- the new property valuepublic java.lang.String getCellspacing()
Return the value of the cellspacing
property.
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.
public void setCellspacing(java.lang.String cellspacing)
Set the value of the cellspacing
property.
cellspacing
- the new property valuepublic java.lang.String getColumnClasses()
Return the value of the columnClasses
property.
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.
public void setColumnClasses(java.lang.String columnClasses)
Set the value of the columnClasses
property.
columnClasses
- the new property valuepublic java.lang.String getDir()
Return the value of the dir
property.
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.
public void setDir(java.lang.String dir)
Set the value of the dir
property.
dir
- the new property valuepublic java.lang.String getFooterClass()
Return the value of the footerClass
property.
Contents: Space-separated list of CSS style class(es) that will be applied to any footer generated for this table.
public void setFooterClass(java.lang.String footerClass)
Set the value of the footerClass
property.
footerClass
- the new property valuepublic java.lang.String getFrame()
Return the value of the frame
property.
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).
public void setFrame(java.lang.String frame)
Set the value of the frame
property.
frame
- the new property valuepublic java.lang.String getHeaderClass()
Return the value of the headerClass
property.
Contents: Space-separated list of CSS style class(es) that will be applied to any header generated for this table.
public void setHeaderClass(java.lang.String headerClass)
Set the value of the headerClass
property.
headerClass
- the new property valuepublic java.lang.String getLang()
Return the value of the lang
property.
Contents: Code describing the language used in the generated markup for this component.
public void setLang(java.lang.String lang)
Set the value of the lang
property.
lang
- the new property valuepublic java.lang.String getOnclick()
Return the value of the onclick
property.
Contents: Javascript code executed when a pointer button is clicked over this element.
public void setOnclick(java.lang.String onclick)
Set the value of the onclick
property.
onclick
- the new property valuepublic java.lang.String getOndblclick()
Return the value of the ondblclick
property.
Contents: Javascript code executed when a pointer button is double clicked over this element.
public void setOndblclick(java.lang.String ondblclick)
Set the value of the ondblclick
property.
ondblclick
- the new property valuepublic java.lang.String getOnkeydown()
Return the value of the onkeydown
property.
Contents: Javascript code executed when a key is pressed down over this element.
public void setOnkeydown(java.lang.String onkeydown)
Set the value of the onkeydown
property.
onkeydown
- the new property valuepublic java.lang.String getOnkeypress()
Return the value of the onkeypress
property.
Contents: Javascript code executed when a key is pressed and released over this element.
public void setOnkeypress(java.lang.String onkeypress)
Set the value of the onkeypress
property.
onkeypress
- the new property valuepublic java.lang.String getOnkeyup()
Return the value of the onkeyup
property.
Contents: Javascript code executed when a key is released over this element.
public void setOnkeyup(java.lang.String onkeyup)
Set the value of the onkeyup
property.
onkeyup
- the new property valuepublic java.lang.String getOnmousedown()
Return the value of the onmousedown
property.
Contents: Javascript code executed when a pointer button is pressed down over this element.
public void setOnmousedown(java.lang.String onmousedown)
Set the value of the onmousedown
property.
onmousedown
- the new property valuepublic java.lang.String getOnmousemove()
Return the value of the onmousemove
property.
Contents: Javascript code executed when a pointer button is moved within this element.
public void setOnmousemove(java.lang.String onmousemove)
Set the value of the onmousemove
property.
onmousemove
- the new property valuepublic java.lang.String getOnmouseout()
Return the value of the onmouseout
property.
Contents: Javascript code executed when a pointer button is moved away from this element.
public void setOnmouseout(java.lang.String onmouseout)
Set the value of the onmouseout
property.
onmouseout
- the new property valuepublic java.lang.String getOnmouseover()
Return the value of the onmouseover
property.
Contents: Javascript code executed when a pointer button is moved onto this element.
public void setOnmouseover(java.lang.String onmouseover)
Set the value of the onmouseover
property.
onmouseover
- the new property valuepublic java.lang.String getOnmouseup()
Return the value of the onmouseup
property.
Contents: Javascript code executed when a pointer button is released over this element.
public void setOnmouseup(java.lang.String onmouseup)
Set the value of the onmouseup
property.
onmouseup
- the new property valuepublic java.lang.String getRole()
Return the value of the role
property.
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.
public void setRole(java.lang.String role)
Set the value of the role
property.
role
- the new property valuepublic java.lang.String getRowClass()
Return the value of the rowClass
property.
Contents:
Assigns one or more space-separated CSS class names to each "tr"
public void setRowClass(java.lang.String rowClass)
Set the value of the rowClass
property.
rowClass
- the new property valuepublic java.lang.String getRowClasses()
Return the value of the rowClasses
property.
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.
public void setRowClasses(java.lang.String rowClasses)
Set the value of the rowClasses
property.
rowClasses
- the new property valuepublic java.lang.String getRules()
Return the value of the rules
property.
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).
public void setRules(java.lang.String rules)
Set the value of the rules
property.
rules
- the new property valuepublic java.lang.String getStyle()
Return the value of the style
property.
Contents: CSS style(s) to be applied when this component is rendered.
public void setStyle(java.lang.String style)
Set the value of the style
property.
style
- the new property valuepublic java.lang.String getStyleClass()
Return the value of the styleClass
property.
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.
public void setStyleClass(java.lang.String styleClass)
Set the value of the styleClass
property.
styleClass
- the new property valuepublic java.lang.String getSummary()
Return the value of the summary
property.
Contents: Summary of this table's purpose and structure, for user agents rendering to non-visual media such as speech and Braille.
public void setSummary(java.lang.String summary)
Set the value of the summary
property.
summary
- the new property valuepublic java.lang.String getTitle()
Return the value of the title
property.
Contents: Advisory title information about markup elements generated for this component.
public void setTitle(java.lang.String title)
Set the value of the title
property.
title
- the new property valuepublic java.lang.String getWidth()
Return the value of the width
property.
Contents: Width of the entire table, for visual user agents.
public void setWidth(java.lang.String width)
Set the value of the width
property.
width
- the new property valuepublic java.util.Collection<java.lang.String> getEventNames()
UIComponentBase
This is a default implementation of
ClientBehaviorHolder.getEventNames()
.
UIComponent
does not implement the
ClientBehaviorHolder
interface, but provides default
implementations for the methods defined by
ClientBehaviorHolder
to simplify subclass
implementations. Subclasses that wish to support the
ClientBehaviorHolder
contract must declare that the
subclass implements ClientBehaviorHolder
, and must
override this method to return a non-Empty Collection
of the client event names
that the component supports.
getEventNames
in interface ClientBehaviorHolder
getEventNames
in class UIComponentBase
public java.lang.String getDefaultEventName()
UIComponentBase
This is a default implementation of
ClientBehaviorHolder.getDefaultEventName()
.
UIComponent
does not implement the
ClientBehaviorHolder
interface, but provides default
implementations for the methods defined by
ClientBehaviorHolder
to simplify subclass
implementations. Subclasses that wish to support the
ClientBehaviorHolder
contract must declare that the
subclass implements ClientBehaviorHolder
, and must
provide an implementation of
ClientBehaviorHolder.getEventNames()
.
getDefaultEventName
in interface ClientBehaviorHolder
getDefaultEventName
in class UIComponentBase