javax.faces.component.html
Class HtmlDataTable

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIData
              extended by javax.faces.component.html.HtmlDataTable
All Implemented Interfaces:
NamingContainer, StateHolder

public class HtmlDataTable
extends UIData


Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
 
Constructor Summary
HtmlDataTable()
          Construct an instance of the HtmlDataTable.
 
Method Summary
 java.lang.String getBgcolor()
          Gets The background color of this element.
 int getBorder()
          Gets Specifies the width of the border of this element, in pixels.
 java.lang.String getCaptionClass()
          Gets A comma separated list of CSS class names to apply to all captions.
 java.lang.String getCaptionStyle()
          Gets The CSS class to be applied to the Caption.
 java.lang.String getCellpadding()
          Gets Specifies the amount of empty space between the cell border and its contents.
 java.lang.String getCellspacing()
          Gets Specifies the amount of space between the cells of the table.
 java.lang.String getColumnClasses()
          Gets A comma separated list of CSS class names to apply to td elements in each column.
 java.lang.String getDir()
          Gets The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
 java.lang.String getFamily()
           
 java.lang.String getFooterClass()
          Gets The CSS class to be applied to footer cells.
 java.lang.String getFrame()
          Gets Controls what part of the frame that surrounds a table is visible.
 java.lang.String getHeaderClass()
          Gets The CSS class to be applied to header cells.
 java.lang.String getLang()
          Gets The base language of this document.
 java.lang.String getOnclick()
          Gets Script to be invoked when the element is clicked.
 java.lang.String getOndblclick()
          Gets Script to be invoked when the element is double-clicked.
 java.lang.String getOnkeydown()
          Gets Script to be invoked when a key is pressed down over this element.
 java.lang.String getOnkeypress()
          Gets Script to be invoked when a key is pressed over this element.
 java.lang.String getOnkeyup()
          Gets Script to be invoked when a key is released over this element.
 java.lang.String getOnmousedown()
          Gets Script to be invoked when the pointing device is pressed over this element.
 java.lang.String getOnmousemove()
          Gets Script to be invoked when the pointing device is moved while it is in this element.
 java.lang.String getOnmouseout()
          Gets Script to be invoked when the pointing device is moves out of this element.
 java.lang.String getOnmouseover()
          Gets Script to be invoked when the pointing device is moved into this element.
 java.lang.String getOnmouseup()
          Gets Script to be invoked when the pointing device is released over this element.
 java.lang.String getRowClasses()
          Gets A comma separated list of CSS class names to apply to td elements in each row.
 java.lang.String getRules()
          Gets Controls how rules are rendered between cells.
 java.lang.String getStyle()
          Gets CSS styling instructions.
 java.lang.String getStyleClass()
          Gets The CSS class for this element.
 java.lang.String getSummary()
          Gets Provides a summary of the contents of the table, for accessibility purposes.
 java.lang.String getTitle()
          Gets An advisory title for this element.
 java.lang.String getWidth()
          Gets Specifies the desired width of the table, as a pixel length or a percentage of available space.
 void restoreState(FacesContext facesContext, java.lang.Object state)
          Invoked in the "restore view" phase, this initialises this object's members from the values saved previously into the provided state object.
 java.lang.Object saveState(FacesContext facesContext)
          Invoked after the render phase has completed, this method returns an object which can be passed to the restoreState of some other instance of UIComponentBase to reset that object's state to the same values as this object currently has.
 void setBgcolor(java.lang.String bgcolor)
          Sets The background color of this element.
 void setBorder(int border)
          Sets Specifies the width of the border of this element, in pixels.
 void setCaptionClass(java.lang.String captionClass)
          Sets A comma separated list of CSS class names to apply to all captions.
 void setCaptionStyle(java.lang.String captionStyle)
          Sets The CSS class to be applied to the Caption.
 void setCellpadding(java.lang.String cellpadding)
          Sets Specifies the amount of empty space between the cell border and its contents.
 void setCellspacing(java.lang.String cellspacing)
          Sets Specifies the amount of space between the cells of the table.
 void setColumnClasses(java.lang.String columnClasses)
          Sets A comma separated list of CSS class names to apply to td elements in each column.
 void setDir(java.lang.String dir)
          Sets The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
 void setFooterClass(java.lang.String footerClass)
          Sets The CSS class to be applied to footer cells.
 void setFrame(java.lang.String frame)
          Sets Controls what part of the frame that surrounds a table is visible.
 void setHeaderClass(java.lang.String headerClass)
          Sets The CSS class to be applied to header cells.
 void setLang(java.lang.String lang)
          Sets The base language of this document.
 void setOnclick(java.lang.String onclick)
          Sets Script to be invoked when the element is clicked.
 void setOndblclick(java.lang.String ondblclick)
          Sets Script to be invoked when the element is double-clicked.
 void setOnkeydown(java.lang.String onkeydown)
          Sets Script to be invoked when a key is pressed down over this element.
 void setOnkeypress(java.lang.String onkeypress)
          Sets Script to be invoked when a key is pressed over this element.
 void setOnkeyup(java.lang.String onkeyup)
          Sets Script to be invoked when a key is released over this element.
 void setOnmousedown(java.lang.String onmousedown)
          Sets Script to be invoked when the pointing device is pressed over this element.
 void setOnmousemove(java.lang.String onmousemove)
          Sets Script to be invoked when the pointing device is moved while it is in this element.
 void setOnmouseout(java.lang.String onmouseout)
          Sets Script to be invoked when the pointing device is moves out of this element.
 void setOnmouseover(java.lang.String onmouseover)
          Sets Script to be invoked when the pointing device is moved into this element.
 void setOnmouseup(java.lang.String onmouseup)
          Sets Script to be invoked when the pointing device is released over this element.
 void setRowClasses(java.lang.String rowClasses)
          Sets A comma separated list of CSS class names to apply to td elements in each row.
 void setRules(java.lang.String rules)
          Sets Controls how rules are rendered between cells.
 void setStyle(java.lang.String style)
          Sets CSS styling instructions.
 void setStyleClass(java.lang.String styleClass)
          Sets The CSS class for this element.
 void setSummary(java.lang.String summary)
          Sets Provides a summary of the contents of the table, for accessibility purposes.
 void setTitle(java.lang.String title)
          Sets An advisory title for this element.
 void setWidth(java.lang.String width)
          Sets Specifies the desired width of the table, as a pixel length or a percentage of available space.
 
Methods inherited from class javax.faces.component.UIData
broadcast, encodeBegin, encodeEnd, getClientId, getDataModel, getFirst, getFooter, getHeader, getRowCount, getRowData, getRowIndex, getRows, getValue, getVar, invokeOnComponent, isRowAvailable, processDecodes, processUpdates, processValidators, queueEvent, setDataModel, setFirst, setFooter, setHeader, setRowIndex, setRows, setValue, setValueExpression, setVar
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, decode, encodeChildren, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId, getValueExpression
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values
Constructor Detail

HtmlDataTable

public HtmlDataTable()
Construct an instance of the HtmlDataTable.

Method Detail

getColumnClasses

public java.lang.String getColumnClasses()
Gets A comma separated list of CSS class names to apply to td elements in each column. More than one class can be applied to a column by separing the classes with a space. I there are less classes than the number of columns, apply the same sequence of classes to the remaining columns. If there are more classes specified than the number of columns, ignore the last classes

Returns:
the new columnClasses value

setColumnClasses

public void setColumnClasses(java.lang.String columnClasses)
Sets A comma separated list of CSS class names to apply to td elements in each column. More than one class can be applied to a column by separing the classes with a space. I there are less classes than the number of columns, apply the same sequence of classes to the remaining columns. If there are more classes specified than the number of columns, ignore the last classes

Parameters:
columnClasses - the new columnClasses value

getFooterClass

public java.lang.String getFooterClass()
Gets The CSS class to be applied to footer cells.

Returns:
the new footerClass value

setFooterClass

public void setFooterClass(java.lang.String footerClass)
Sets The CSS class to be applied to footer cells.

Parameters:
footerClass - the new footerClass value

getHeaderClass

public java.lang.String getHeaderClass()
Gets The CSS class to be applied to header cells.

Returns:
the new headerClass value

setHeaderClass

public void setHeaderClass(java.lang.String headerClass)
Sets The CSS class to be applied to header cells.

Parameters:
headerClass - the new headerClass value

getRowClasses

public java.lang.String getRowClasses()
Gets A comma separated list of CSS class names to apply to td elements in each row. If tere are less classes than the number of rows, apply the same sequence of classes to the remaining rows, so the pattern is repeated. More than one class can be applied to a row by separing the classes with a space.

Returns:
the new rowClasses value

setRowClasses

public void setRowClasses(java.lang.String rowClasses)
Sets A comma separated list of CSS class names to apply to td elements in each row. If tere are less classes than the number of rows, apply the same sequence of classes to the remaining rows, so the pattern is repeated. More than one class can be applied to a row by separing the classes with a space.

Parameters:
rowClasses - the new rowClasses value

getCaptionClass

public java.lang.String getCaptionClass()
Gets A comma separated list of CSS class names to apply to all captions. If tere are less classes than the number of rows, apply the same sequence of classes to the remaining captions, so the pattern is repeated. More than one class can be applied to a row by separing the classes with a space.

Returns:
the new captionClass value

setCaptionClass

public void setCaptionClass(java.lang.String captionClass)
Sets A comma separated list of CSS class names to apply to all captions. If tere are less classes than the number of rows, apply the same sequence of classes to the remaining captions, so the pattern is repeated. More than one class can be applied to a row by separing the classes with a space.

Parameters:
captionClass - the new captionClass value

getCaptionStyle

public java.lang.String getCaptionStyle()
Gets The CSS class to be applied to the Caption.

Returns:
the new captionStyle value

setCaptionStyle

public void setCaptionStyle(java.lang.String captionStyle)
Sets The CSS class to be applied to the Caption.

Parameters:
captionStyle - the new captionStyle value

getStyle

public java.lang.String getStyle()
Gets CSS styling instructions.

Returns:
the new style value

setStyle

public void setStyle(java.lang.String style)
Sets CSS styling instructions.

Parameters:
style - the new style value

getStyleClass

public java.lang.String getStyleClass()
Gets The CSS class for this element. Corresponds to the HTML 'class' attribute.

Returns:
the new styleClass value

setStyleClass

public void setStyleClass(java.lang.String styleClass)
Sets The CSS class for this element. Corresponds to the HTML 'class' attribute.

Parameters:
styleClass - the new styleClass value

getDir

public java.lang.String getDir()
Gets The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).

Returns:
the new dir value

setDir

public void setDir(java.lang.String dir)
Sets The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).

Parameters:
dir - the new dir value

getLang

public java.lang.String getLang()
Gets The base language of this document.

Returns:
the new lang value

setLang

public void setLang(java.lang.String lang)
Sets The base language of this document.

Parameters:
lang - the new lang value

getTitle

public java.lang.String getTitle()
Gets An advisory title for this element. Often used by the user agent as a tooltip.

Returns:
the new title value

setTitle

public void setTitle(java.lang.String title)
Sets An advisory title for this element. Often used by the user agent as a tooltip.

Parameters:
title - the new title value

getOnclick

public java.lang.String getOnclick()
Gets Script to be invoked when the element is clicked.

Returns:
the new onclick value

setOnclick

public void setOnclick(java.lang.String onclick)
Sets Script to be invoked when the element is clicked.

Parameters:
onclick - the new onclick value

getOndblclick

public java.lang.String getOndblclick()
Gets Script to be invoked when the element is double-clicked.

Returns:
the new ondblclick value

setOndblclick

public void setOndblclick(java.lang.String ondblclick)
Sets Script to be invoked when the element is double-clicked.

Parameters:
ondblclick - the new ondblclick value

getOnmousedown

public java.lang.String getOnmousedown()
Gets Script to be invoked when the pointing device is pressed over this element.

Returns:
the new onmousedown value

setOnmousedown

public void setOnmousedown(java.lang.String onmousedown)
Sets Script to be invoked when the pointing device is pressed over this element.

Parameters:
onmousedown - the new onmousedown value

getOnmouseup

public java.lang.String getOnmouseup()
Gets Script to be invoked when the pointing device is released over this element.

Returns:
the new onmouseup value

setOnmouseup

public void setOnmouseup(java.lang.String onmouseup)
Sets Script to be invoked when the pointing device is released over this element.

Parameters:
onmouseup - the new onmouseup value

getOnmouseover

public java.lang.String getOnmouseover()
Gets Script to be invoked when the pointing device is moved into this element.

Returns:
the new onmouseover value

setOnmouseover

public void setOnmouseover(java.lang.String onmouseover)
Sets Script to be invoked when the pointing device is moved into this element.

Parameters:
onmouseover - the new onmouseover value

getOnmousemove

public java.lang.String getOnmousemove()
Gets Script to be invoked when the pointing device is moved while it is in this element.

Returns:
the new onmousemove value

setOnmousemove

public void setOnmousemove(java.lang.String onmousemove)
Sets Script to be invoked when the pointing device is moved while it is in this element.

Parameters:
onmousemove - the new onmousemove value

getOnmouseout

public java.lang.String getOnmouseout()
Gets Script to be invoked when the pointing device is moves out of this element.

Returns:
the new onmouseout value

setOnmouseout

public void setOnmouseout(java.lang.String onmouseout)
Sets Script to be invoked when the pointing device is moves out of this element.

Parameters:
onmouseout - the new onmouseout value

getOnkeypress

public java.lang.String getOnkeypress()
Gets Script to be invoked when a key is pressed over this element.

Returns:
the new onkeypress value

setOnkeypress

public void setOnkeypress(java.lang.String onkeypress)
Sets Script to be invoked when a key is pressed over this element.

Parameters:
onkeypress - the new onkeypress value

getOnkeydown

public java.lang.String getOnkeydown()
Gets Script to be invoked when a key is pressed down over this element.

Returns:
the new onkeydown value

setOnkeydown

public void setOnkeydown(java.lang.String onkeydown)
Sets Script to be invoked when a key is pressed down over this element.

Parameters:
onkeydown - the new onkeydown value

getOnkeyup

public java.lang.String getOnkeyup()
Gets Script to be invoked when a key is released over this element.

Returns:
the new onkeyup value

setOnkeyup

public void setOnkeyup(java.lang.String onkeyup)
Sets Script to be invoked when a key is released over this element.

Parameters:
onkeyup - the new onkeyup value

getBorder

public int getBorder()
Gets Specifies the width of the border of this element, in pixels. Deprecated in HTML 4.01.

Returns:
the new border value

setBorder

public void setBorder(int border)
Sets Specifies the width of the border of this element, in pixels. Deprecated in HTML 4.01.

Parameters:
border - the new border value

getBgcolor

public java.lang.String getBgcolor()
Gets The background color of this element.

Returns:
the new bgcolor value

setBgcolor

public void setBgcolor(java.lang.String bgcolor)
Sets The background color of this element.

Parameters:
bgcolor - the new bgcolor value

getCellpadding

public java.lang.String getCellpadding()
Gets Specifies the amount of empty space between the cell border and its contents. It can be either a pixel length or a percentage.

Returns:
the new cellpadding value

setCellpadding

public void setCellpadding(java.lang.String cellpadding)
Sets Specifies the amount of empty space between the cell border and its contents. It can be either a pixel length or a percentage.

Parameters:
cellpadding - the new cellpadding value

getCellspacing

public java.lang.String getCellspacing()
Gets Specifies the amount of space between the cells of the table. It can be either a pixel length or a percentage of available space.

Returns:
the new cellspacing value

setCellspacing

public void setCellspacing(java.lang.String cellspacing)
Sets Specifies the amount of space between the cells of the table. It can be either a pixel length or a percentage of available space.

Parameters:
cellspacing - the new cellspacing value

getFrame

public java.lang.String getFrame()
Gets Controls what part of the frame that surrounds a table is visible. Values include: void, above, below, hsides, lhs, rhs, vsides, box, and border.

Returns:
the new frame value

setFrame

public void setFrame(java.lang.String frame)
Sets Controls what part of the frame that surrounds a table is visible. Values include: void, above, below, hsides, lhs, rhs, vsides, box, and border.

Parameters:
frame - the new frame value

getRules

public java.lang.String getRules()
Gets Controls how rules are rendered between cells. Values include: none, groups, rows, cols, and all.

Returns:
the new rules value

setRules

public void setRules(java.lang.String rules)
Sets Controls how rules are rendered between cells. Values include: none, groups, rows, cols, and all.

Parameters:
rules - the new rules value

getSummary

public java.lang.String getSummary()
Gets Provides a summary of the contents of the table, for accessibility purposes.

Returns:
the new summary value

setSummary

public void setSummary(java.lang.String summary)
Sets Provides a summary of the contents of the table, for accessibility purposes.

Parameters:
summary - the new summary value

getWidth

public java.lang.String getWidth()
Gets Specifies the desired width of the table, as a pixel length or a percentage of available space.

Returns:
the new width value

setWidth

public void setWidth(java.lang.String width)
Sets Specifies the desired width of the table, as a pixel length or a percentage of available space.

Parameters:
width - the new width value

saveState

public java.lang.Object saveState(FacesContext facesContext)
Description copied from class: UIComponentBase
Invoked after the render phase has completed, this method returns an object which can be passed to the restoreState of some other instance of UIComponentBase to reset that object's state to the same values as this object currently has.

Specified by:
saveState in interface StateHolder
Overrides:
saveState in class UIData

restoreState

public void restoreState(FacesContext facesContext,
                         java.lang.Object state)
Description copied from class: UIComponentBase
Invoked in the "restore view" phase, this initialises this object's members from the values saved previously into the provided state object.

Specified by:
restoreState in interface StateHolder
Overrides:
restoreState in class UIData
state - is an object previously returned by the saveState method of this class.

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class UIData


Copyright © 2011 Apache Software Foundation. All Rights Reserved.