com.sun.webui.jsf.component
Class TableColumnBase

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by com.sun.webui.jsf.component.WebuiComponent
              extended by com.sun.webui.jsf.component.TableColumnBase
All Implemented Interfaces:
javax.faces.component.NamingContainer, javax.faces.component.StateHolder
Direct Known Subclasses:
TableColumn

public abstract class TableColumnBase
extends WebuiComponent
implements javax.faces.component.NamingContainer

Base class for table column components.


Field Summary
 
Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
 
Constructor Summary
TableColumnBase()
           
 
Method Summary
 void clear()
          Clear cached properties.
 java.lang.String getAbbr()
          ABBR gives an abbreviated version of the cell's content.
 java.lang.String getAlign()
          Use the align attribute to specify the horizontal alignment for the content of each cell in the column.
 java.lang.Object getAlignKey()
          Use the alignKey attribute to specify the FieldKey id or FieldKey to be used as an identifier for a specific data element on which to align the table cell data in the column.
 java.lang.String getAxis()
          The AXIS attribute provides a method of categorizing cells.
 java.lang.String getBgColor()
          The BGCOLOR attribute suggests a background color for the cell.
 java.lang.String getChar()
          Use the char attribute to specify a character to use for horizontal alignment in each cell in the row.
 java.lang.String getCharOff()
          Use the charOff attribute to specify the offset of the first occurrence of the alignment character that is specified with the char attribute.
 int getColSpan()
          The COLSPAN attribute of TD specifies the number of columns that are spanned by the cell.
 java.lang.String getFooterText()
          The text to be displayed in the column footer.
 java.lang.String getHeaders()
          The HEADERS attribute specifies the header cells that apply to the TD.
 java.lang.String getHeaderText()
          The text to be displayed in the column header.
 java.lang.String getHeight()
          The number of pixels for the cell's height.
 java.lang.String getOnClick()
          Scripting code executed when a mouse click occurs over this component.
 java.lang.String getOnDblClick()
          Scripting code executed when a mouse double click occurs over this component.
 java.lang.String getOnKeyDown()
          Scripting code executed when the user presses down on a key while the component has focus.
 java.lang.String getOnKeyPress()
          Scripting code executed when the user presses and releases a key while the component has focus.
 java.lang.String getOnKeyUp()
          Scripting code executed when the user releases a key while the component has focus.
 java.lang.String getOnMouseDown()
          Scripting code executed when the user presses a mouse button while the mouse pointer is on the component.
 java.lang.String getOnMouseMove()
          Scripting code executed when the user moves the mouse pointer while over the component.
 java.lang.String getOnMouseOut()
          Scripting code executed when a mouse out movement occurs over this component.
 java.lang.String getOnMouseOver()
          Scripting code executed when the user moves the mouse pointer into the boundary of this component.
 java.lang.String getOnMouseUp()
          Scripting code executed when the user releases a mouse button while the mouse pointer is on the component.
 int getRowSpan()
          The ROWSPAN attribute of TD specifies the number of rows that are spanned by the cell.
 java.lang.String getScope()
          Use the scope attribute to specify that the data cells of the column are also acting as headers for rows or other columns of the table.
 java.lang.String getSelectId()
          Use the selectId attribute in select columns, which contain checkboxes or radio buttons for selecting table rows.
 java.lang.String getSeverity()
          Use the severity attribute when including the webuijsf:alarm component in a column, to match the severity of the alarm.
 java.lang.Object getSort()
          Use the sort attribute to specify a FieldKey id or SortCriteria that defines the criteria to use for sorting the contents of a TableDataProvider.
 java.lang.String getSortIcon()
          The theme identifier to use for the sort button that is displayed in the column header.
 java.lang.String getSortImageURL()
          Absolute or relative URL to the image used for the sort button that is displayed in the column header.
 java.lang.String getStyle()
          CSS style(s) to be applied to the outermost HTML element when this component is rendered.
 java.lang.String getStyleClass()
          CSS style class(es) to be applied to the outermost HTML element when this component is rendered.
 java.util.Iterator getTableColumnChildren()
          Get an Iterator over the TableColumn children found for this component.
 java.lang.String getToolTip()
          Sets the value of the title attribute for the HTML element.
 java.lang.String getValign()
          Use the valign attribute to specify the vertical alignment for the content of each cell in the column.
 java.lang.String getWidth()
          Use the width attribute to specify the width of the cells of the column.
 boolean isDescending()
          Use the descending attribute to specify that the first user-applied sort is descending.
 boolean isEmbeddedActions()
          Set the embeddedActions attribute to true when the column includes more than one embedded action.
 boolean isEmptyCell()
          Use the emptyCell attribute to cause a theme-specific image to be displayed when the content of a table cell is not applicable or is unexpectedly empty.
 boolean isNoWrap()
          Use the noWrap attribute to disable word wrapping of this column's cells in visual browsers.
 boolean isRowHeader()
          Use the rowHeader attribute to specify that the cells of the column are acting as row headers.
 boolean isSpacerColumn()
          Use the spacerColumn attribute to use the column as a blank column to enhance spacing in two or three column tables.
 boolean isVisible()
          Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page.
 void restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
          Restore the state of this component.
 java.lang.Object saveState(javax.faces.context.FacesContext _context)
          Save the state of this component.
 void setAbbr(java.lang.String abbr)
          ABBR gives an abbreviated version of the cell's content.
 void setAlign(java.lang.String align)
          Use the align attribute to specify the horizontal alignment for the content of each cell in the column.
 void setAlignKey(java.lang.Object alignKey)
          Use the alignKey attribute to specify the FieldKey id or FieldKey to be used as an identifier for a specific data element on which to align the table cell data in the column.
 void setAxis(java.lang.String axis)
          The AXIS attribute provides a method of categorizing cells.
 void setBgColor(java.lang.String bgColor)
          The BGCOLOR attribute suggests a background color for the cell.
 void setChar(java.lang.String _char)
          Use the char attribute to specify a character to use for horizontal alignment in each cell in the row.
 void setCharOff(java.lang.String charOff)
          Use the charOff attribute to specify the offset of the first occurrence of the alignment character that is specified with the char attribute.
 void setColSpan(int colSpan)
          The COLSPAN attribute of TD specifies the number of columns that are spanned by the cell.
 void setDescending(boolean descending)
          Use the descending attribute to specify that the first user-applied sort is descending.
 void setEmbeddedActions(boolean embeddedActions)
          Set the embeddedActions attribute to true when the column includes more than one embedded action.
 void setEmptyCell(boolean emptyCell)
          Use the emptyCell attribute to cause a theme-specific image to be displayed when the content of a table cell is not applicable or is unexpectedly empty.
 void setFooterText(java.lang.String footerText)
          The text to be displayed in the column footer.
 void setHeaders(java.lang.String headers)
          The HEADERS attribute specifies the header cells that apply to the TD.
 void setHeaderText(java.lang.String headerText)
          The text to be displayed in the column header.
 void setHeight(java.lang.String height)
          The number of pixels for the cell's height.
 void setNoWrap(boolean noWrap)
          Use the noWrap attribute to disable word wrapping of this column's cells in visual browsers.
 void setOnClick(java.lang.String onClick)
          Scripting code executed when a mouse click occurs over this component.
 void setOnDblClick(java.lang.String onDblClick)
          Scripting code executed when a mouse double click occurs over this component.
 void setOnKeyDown(java.lang.String onKeyDown)
          Scripting code executed when the user presses down on a key while the component has focus.
 void setOnKeyPress(java.lang.String onKeyPress)
          Scripting code executed when the user presses and releases a key while the component has focus.
 void setOnKeyUp(java.lang.String onKeyUp)
          Scripting code executed when the user releases a key while the component has focus.
 void setOnMouseDown(java.lang.String onMouseDown)
          Scripting code executed when the user presses a mouse button while the mouse pointer is on the component.
 void setOnMouseMove(java.lang.String onMouseMove)
          Scripting code executed when the user moves the mouse pointer while over the component.
 void setOnMouseOut(java.lang.String onMouseOut)
          Scripting code executed when a mouse out movement occurs over this component.
 void setOnMouseOver(java.lang.String onMouseOver)
          Scripting code executed when the user moves the mouse pointer into the boundary of this component.
 void setOnMouseUp(java.lang.String onMouseUp)
          Scripting code executed when the user releases a mouse button while the mouse pointer is on the component.
 void setRowHeader(boolean rowHeader)
          Use the rowHeader attribute to specify that the cells of the column are acting as row headers.
 void setRowSpan(int rowSpan)
          The ROWSPAN attribute of TD specifies the number of rows that are spanned by the cell.
 void setScope(java.lang.String scope)
          Use the scope attribute to specify that the data cells of the column are also acting as headers for rows or other columns of the table.
 void setSelectId(java.lang.String selectId)
          Use the selectId attribute in select columns, which contain checkboxes or radio buttons for selecting table rows.
 void setSeverity(java.lang.String severity)
          Use the severity attribute when including the webuijsf:alarm component in a column, to match the severity of the alarm.
 void setSort(java.lang.Object sort)
          Use the sort attribute to specify a FieldKey id or SortCriteria that defines the criteria to use for sorting the contents of a TableDataProvider.
 void setSortIcon(java.lang.String sortIcon)
          The theme identifier to use for the sort button that is displayed in the column header.
 void setSortImageURL(java.lang.String sortImageURL)
          Absolute or relative URL to the image used for the sort button that is displayed in the column header.
 void setSpacerColumn(boolean spacerColumn)
          Use the spacerColumn attribute to use the column as a blank column to enhance spacing in two or three column tables.
 void setStyle(java.lang.String style)
          CSS style(s) to be applied to the outermost HTML element when this component is rendered.
 void setStyleClass(java.lang.String styleClass)
          CSS style class(es) to be applied to the outermost HTML element when this component is rendered.
 void setToolTip(java.lang.String toolTip)
          Sets the value of the title attribute for the HTML element.
 void setValign(java.lang.String valign)
          Use the valign attribute to specify the vertical alignment for the content of each cell in the column.
 void setVisible(boolean visible)
          Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page.
 void setWidth(java.lang.String width)
          Use the width attribute to specify the width of the cells of the column.
 
Methods inherited from class com.sun.webui.jsf.component.WebuiComponent
processDecodes, processUpdates, processValidators, setId, setRendered
 
Methods inherited from class javax.faces.component.UIComponentBase
broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, restoreAttachedState, saveAttachedState, setParent, setRendererType, setTransient, setValueBinding, setValueExpression
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId, getFamily
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TableColumnBase

public TableColumnBase()
Method Detail

clear

public void clear()
Clear cached properties.

Note: Properties may have been cached via the apply request values, validate, and update phases and must be re-evaluated during the render response phase (e.g., the underlying DataProvider may have changed). This cannot always be done via encodeBegin because the component's parent may need to obtain updated properties before this component is rendered.


getTableColumnChildren

public java.util.Iterator getTableColumnChildren()
Get an Iterator over the TableColumn children found for this component.

Returns:
An Iterator over the TableColumn children.

getAbbr

public java.lang.String getAbbr()
ABBR gives an abbreviated version of the cell's content. This allows visual browsers to use the short form if space is limited, and non-visual browsers can give a cell's header information in an abbreviated form before rendering each cell.


setAbbr

public void setAbbr(java.lang.String abbr)
ABBR gives an abbreviated version of the cell's content. This allows visual browsers to use the short form if space is limited, and non-visual browsers can give a cell's header information in an abbreviated form before rendering each cell.


getAlign

public java.lang.String getAlign()
Use the align attribute to specify the horizontal alignment for the content of each cell in the column. Valid values are left, center, right, justify, and char. The default alignment is left. Setting the align attribute to char causes the cell's contents to be aligned on the character that you specify with the char attribute. For example, to align cell contents on colons, set align="char" and char=":" Some browsers do not support aligning on the character.


setAlign

public void setAlign(java.lang.String align)
Use the align attribute to specify the horizontal alignment for the content of each cell in the column. Valid values are left, center, right, justify, and char. The default alignment is left. Setting the align attribute to char causes the cell's contents to be aligned on the character that you specify with the char attribute. For example, to align cell contents on colons, set align="char" and char=":" Some browsers do not support aligning on the character.


getAlignKey

public java.lang.Object getAlignKey()
Use the alignKey attribute to specify the FieldKey id or FieldKey to be used as an identifier for a specific data element on which to align the table cell data in the column. If alignKey specifies a FieldKey, the FieldKey is used as is; otherwise, a FieldKey is created using the alignKey value that you specify. Alignment is based on the object type of the data element. For example, Date and Number objects are aligned "right", Character and String objects are aligned "left", and Boolean objects are aligned "center". All columns, including select columns, are aligned "left" by default. Note that the align property overrides this value.


setAlignKey

public void setAlignKey(java.lang.Object alignKey)
Use the alignKey attribute to specify the FieldKey id or FieldKey to be used as an identifier for a specific data element on which to align the table cell data in the column. If alignKey specifies a FieldKey, the FieldKey is used as is; otherwise, a FieldKey is created using the alignKey value that you specify. Alignment is based on the object type of the data element. For example, Date and Number objects are aligned "right", Character and String objects are aligned "left", and Boolean objects are aligned "center". All columns, including select columns, are aligned "left" by default. Note that the align property overrides this value.


getAxis

public java.lang.String getAxis()
The AXIS attribute provides a method of categorizing cells. The attribute's value is a comma-separated list of category names. See the HTML 4.0 Recommendation's section on categorizing cells for an application of AXIS.


setAxis

public void setAxis(java.lang.String axis)
The AXIS attribute provides a method of categorizing cells. The attribute's value is a comma-separated list of category names. See the HTML 4.0 Recommendation's section on categorizing cells for an application of AXIS.


getBgColor

public java.lang.String getBgColor()
The BGCOLOR attribute suggests a background color for the cell. The combination of this attribute with can leave invisible or unreadable text on Netscape Navigator 2.x, which does not support BGCOLOR on table elements. BGCOLOR is dangerous even on supporting browsers, since most fail to override it when overriding other author-specified colors. Style sheets provide a safer, more flexible method of specifying a table's background color. This attribute is deprecated (in HTML 4.0) in favor of style sheets.


setBgColor

public void setBgColor(java.lang.String bgColor)
The BGCOLOR attribute suggests a background color for the cell. The combination of this attribute with can leave invisible or unreadable text on Netscape Navigator 2.x, which does not support BGCOLOR on table elements. BGCOLOR is dangerous even on supporting browsers, since most fail to override it when overriding other author-specified colors. Style sheets provide a safer, more flexible method of specifying a table's background color. This attribute is deprecated (in HTML 4.0) in favor of style sheets.


getChar

public java.lang.String getChar()
Use the char attribute to specify a character to use for horizontal alignment in each cell in the row. You must also set the align attribute to char to enable character alignment to be used. The default value for the char attribute is the decimal point of the current language, such as a period in English. The char HTML property is not supported by all browsers.


setChar

public void setChar(java.lang.String _char)
Use the char attribute to specify a character to use for horizontal alignment in each cell in the row. You must also set the align attribute to char to enable character alignment to be used. The default value for the char attribute is the decimal point of the current language, such as a period in English. The char HTML property is not supported by all browsers.


getCharOff

public java.lang.String getCharOff()
Use the charOff attribute to specify the offset of the first occurrence of the alignment character that is specified with the char attribute. The offset is the distance from the left cell border, in locales that read from left to right. The charOff attribute's value can be a number of pixels or a percentage of the cell's width. For example, charOff="50%" centers the alignment character horizontally in a cell. If charOff="25%", the first instance of the alignment character is placed at one fourth of the width of the cell.


setCharOff

public void setCharOff(java.lang.String charOff)
Use the charOff attribute to specify the offset of the first occurrence of the alignment character that is specified with the char attribute. The offset is the distance from the left cell border, in locales that read from left to right. The charOff attribute's value can be a number of pixels or a percentage of the cell's width. For example, charOff="50%" centers the alignment character horizontally in a cell. If charOff="25%", the first instance of the alignment character is placed at one fourth of the width of the cell.


getColSpan

public int getColSpan()
The COLSPAN attribute of TD specifies the number of columns that are spanned by the cell. The default value is 1. The special value 0 indicates that the cell spans all columns to the end of the table. The value 0 is ignored by most browsers, so authors may wish to calculate the exact number of rows or columns spanned and use that value.


setColSpan

public void setColSpan(int colSpan)
The COLSPAN attribute of TD specifies the number of columns that are spanned by the cell. The default value is 1. The special value 0 indicates that the cell spans all columns to the end of the table. The value 0 is ignored by most browsers, so authors may wish to calculate the exact number of rows or columns spanned and use that value.


isDescending

public boolean isDescending()
Use the descending attribute to specify that the first user-applied sort is descending. By default, the first time a user clicks a column's sort button or column header, the sort is ascending. Note that this not an initial sort. The data is initially displayed unsorted.


setDescending

public void setDescending(boolean descending)
Use the descending attribute to specify that the first user-applied sort is descending. By default, the first time a user clicks a column's sort button or column header, the sort is ascending. Note that this not an initial sort. The data is initially displayed unsorted.


isEmbeddedActions

public boolean isEmbeddedActions()
Set the embeddedActions attribute to true when the column includes more than one embedded action. This attribute causes a separator image to be displayed between the action links. This attribute is overridden by the emptyCell attribute.


setEmbeddedActions

public void setEmbeddedActions(boolean embeddedActions)
Set the embeddedActions attribute to true when the column includes more than one embedded action. This attribute causes a separator image to be displayed between the action links. This attribute is overridden by the emptyCell attribute.


isEmptyCell

public boolean isEmptyCell()
Use the emptyCell attribute to cause a theme-specific image to be displayed when the content of a table cell is not applicable or is unexpectedly empty. You should not use this attribute for a value that is truly null, such as an empty alarm cell or a comment field that is blank. In addition, the image should not be used for cells that contain user interface elements such as checkboxes or drop-down lists when these elements are not applicable. Instead, the elements should simply not be displayed so the cell is left empty.


setEmptyCell

public void setEmptyCell(boolean emptyCell)
Use the emptyCell attribute to cause a theme-specific image to be displayed when the content of a table cell is not applicable or is unexpectedly empty. You should not use this attribute for a value that is truly null, such as an empty alarm cell or a comment field that is blank. In addition, the image should not be used for cells that contain user interface elements such as checkboxes or drop-down lists when these elements are not applicable. Instead, the elements should simply not be displayed so the cell is left empty.


getFooterText

public java.lang.String getFooterText()
The text to be displayed in the column footer.


setFooterText

public void setFooterText(java.lang.String footerText)
The text to be displayed in the column footer.


getHeaderText

public java.lang.String getHeaderText()
The text to be displayed in the column header.


setHeaderText

public void setHeaderText(java.lang.String headerText)
The text to be displayed in the column header.


getHeaders

public java.lang.String getHeaders()
The HEADERS attribute specifies the header cells that apply to the TD. The value is a space-separated list of the header cells' ID attribute values. The HEADERS attribute allows non-visual browsers to render the header information for a given cell.


setHeaders

public void setHeaders(java.lang.String headers)
The HEADERS attribute specifies the header cells that apply to the TD. The value is a space-separated list of the header cells' ID attribute values. The HEADERS attribute allows non-visual browsers to render the header information for a given cell.


getHeight

public java.lang.String getHeight()
The number of pixels for the cell's height. Styles should be used to specify cell height when possible because the height attribute is deprecated in HTML 4.0.


setHeight

public void setHeight(java.lang.String height)
The number of pixels for the cell's height. Styles should be used to specify cell height when possible because the height attribute is deprecated in HTML 4.0.


isNoWrap

public boolean isNoWrap()
Use the noWrap attribute to disable word wrapping of this column's cells in visual browsers. Word wrap can cause unnecessary horizontal scrolling when the browser window is small in relation to the font size. Styles should be used to disable word wrap when possible because the nowrap attribute is deprecated in HTML 4.0.


setNoWrap

public void setNoWrap(boolean noWrap)
Use the noWrap attribute to disable word wrapping of this column's cells in visual browsers. Word wrap can cause unnecessary horizontal scrolling when the browser window is small in relation to the font size. Styles should be used to disable word wrap when possible because the nowrap attribute is deprecated in HTML 4.0.


getOnClick

public java.lang.String getOnClick()
Scripting code executed when a mouse click occurs over this component.


setOnClick

public void setOnClick(java.lang.String onClick)
Scripting code executed when a mouse click occurs over this component.


getOnDblClick

public java.lang.String getOnDblClick()
Scripting code executed when a mouse double click occurs over this component.


setOnDblClick

public void setOnDblClick(java.lang.String onDblClick)
Scripting code executed when a mouse double click occurs over this component.


getOnKeyDown

public java.lang.String getOnKeyDown()
Scripting code executed when the user presses down on a key while the component has focus.


setOnKeyDown

public void setOnKeyDown(java.lang.String onKeyDown)
Scripting code executed when the user presses down on a key while the component has focus.


getOnKeyPress

public java.lang.String getOnKeyPress()
Scripting code executed when the user presses and releases a key while the component has focus.


setOnKeyPress

public void setOnKeyPress(java.lang.String onKeyPress)
Scripting code executed when the user presses and releases a key while the component has focus.


getOnKeyUp

public java.lang.String getOnKeyUp()
Scripting code executed when the user releases a key while the component has focus.


setOnKeyUp

public void setOnKeyUp(java.lang.String onKeyUp)
Scripting code executed when the user releases a key while the component has focus.


getOnMouseDown

public java.lang.String getOnMouseDown()
Scripting code executed when the user presses a mouse button while the mouse pointer is on the component.


setOnMouseDown

public void setOnMouseDown(java.lang.String onMouseDown)
Scripting code executed when the user presses a mouse button while the mouse pointer is on the component.


getOnMouseMove

public java.lang.String getOnMouseMove()
Scripting code executed when the user moves the mouse pointer while over the component.


setOnMouseMove

public void setOnMouseMove(java.lang.String onMouseMove)
Scripting code executed when the user moves the mouse pointer while over the component.


getOnMouseOut

public java.lang.String getOnMouseOut()
Scripting code executed when a mouse out movement occurs over this component.


setOnMouseOut

public void setOnMouseOut(java.lang.String onMouseOut)
Scripting code executed when a mouse out movement occurs over this component.


getOnMouseOver

public java.lang.String getOnMouseOver()
Scripting code executed when the user moves the mouse pointer into the boundary of this component.


setOnMouseOver

public void setOnMouseOver(java.lang.String onMouseOver)
Scripting code executed when the user moves the mouse pointer into the boundary of this component.


getOnMouseUp

public java.lang.String getOnMouseUp()
Scripting code executed when the user releases a mouse button while the mouse pointer is on the component.


setOnMouseUp

public void setOnMouseUp(java.lang.String onMouseUp)
Scripting code executed when the user releases a mouse button while the mouse pointer is on the component.


isRowHeader

public boolean isRowHeader()

Use the rowHeader attribute to specify that the cells of the column are acting as row headers. Row headers are cells that "label" the row. For example, consider a table where the first column contains checkboxes, and the second column contains user names. The third and subsequent columns contain attributes of those users. The content of the cells in the user name column are acting as row headers. The webuijsf:tableColumn tag for the user name column should set the rowHeader attribute to true. If a table contains, for example, a system log with time stamp and log entry columns, neither column is acting as a row header, so the rowHeader attribute should not be set.

By default, most column cells are rendered by the table component with HTML <td scope="col"> elements. The exceptions are columns that contain checkboxes or radio buttons and spacer columns, all of which are rendered as <td> elements without a scope property.

When you set the rowHeader attribute, the column cells are rendered as <th scope="row"> elements, which enables adaptive technologies such as screen readers to properly read the table to indicate that the contents of these cells are headers for the rows.


setRowHeader

public void setRowHeader(boolean rowHeader)

Use the rowHeader attribute to specify that the cells of the column are acting as row headers. Row headers are cells that "label" the row. For example, consider a table where the first column contains checkboxes, and the second column contains user names. The third and subsequent columns contain attributes of those users. The content of the cells in the user name column are acting as row headers. The webuijsf:tableColumn tag for the user name column should set the rowHeader attribute to true. If a table contains, for example, a system log with time stamp and log entry columns, neither column is acting as a row header, so the rowHeader attribute should not be set.

By default, most column cells are rendered by the table component with HTML <td scope="col"> elements. The exceptions are columns that contain checkboxes or radio buttons and spacer columns, all of which are rendered as <td> elements without a scope property.

When you set the rowHeader attribute, the column cells are rendered as <th scope="row"> elements, which enables adaptive technologies such as screen readers to properly read the table to indicate that the contents of these cells are headers for the rows.


getRowSpan

public int getRowSpan()
The ROWSPAN attribute of TD specifies the number of rows that are spanned by the cell. The default value is 1. The special value 0 indicates that the cell spans all rows to the end of the table. The value 0 is ignored by most browsers, so authors may wish to calculate the exact number of rows or columns spanned and use that value.


setRowSpan

public void setRowSpan(int rowSpan)
The ROWSPAN attribute of TD specifies the number of rows that are spanned by the cell. The default value is 1. The special value 0 indicates that the cell spans all rows to the end of the table. The value 0 is ignored by most browsers, so authors may wish to calculate the exact number of rows or columns spanned and use that value.


getScope

public java.lang.String getScope()
Use the scope attribute to specify that the data cells of the column are also acting as headers for rows or other columns of the table. This attribute supports assistive technologies by enabling them to determine the order in which to read the cells. Valid values include:
  • row, when the cells provide header information for the row
  • col, when the cells provide header information for the column
  • rowgroup, when the cells provide header information for the row group
  • colgroup, when the cells provide header information for the column group


setScope

public void setScope(java.lang.String scope)
Use the scope attribute to specify that the data cells of the column are also acting as headers for rows or other columns of the table. This attribute supports assistive technologies by enabling them to determine the order in which to read the cells. Valid values include:
  • row, when the cells provide header information for the row
  • col, when the cells provide header information for the column
  • rowgroup, when the cells provide header information for the row group
  • colgroup, when the cells provide header information for the column group


getSelectId

public java.lang.String getSelectId()
Use the selectId attribute in select columns, which contain checkboxes or radio buttons for selecting table rows. The value of selectId must match the id attribute of the checkbox or radioButton component that is a child of the tableColumn component. A fully qualified ID based on the tableColumn component ID and the selectId for the current row will be dynamically created for the <input> element that is rendered for the checkbox or radio button. The selectId is required for functionality that supports the toggle buttons for selecting rows. The selectId also identifies the column as a select column, for which the table component uses different CSS styles.


setSelectId

public void setSelectId(java.lang.String selectId)
Use the selectId attribute in select columns, which contain checkboxes or radio buttons for selecting table rows. The value of selectId must match the id attribute of the checkbox or radioButton component that is a child of the tableColumn component. A fully qualified ID based on the tableColumn component ID and the selectId for the current row will be dynamically created for the <input> element that is rendered for the checkbox or radio button. The selectId is required for functionality that supports the toggle buttons for selecting rows. The selectId also identifies the column as a select column, for which the table component uses different CSS styles.


getSeverity

public java.lang.String getSeverity()
Use the severity attribute when including the webuijsf:alarm component in a column, to match the severity of the alarm. Valid values are described in the webuijsf:alarm documentation. When the severity attribute is set in the tableColumn, the table component renders sort tool tips to indicate that the column will be sorted least/most severe first, and the table cell appears hightlighted according to the level of severity. This functionality is overridden by the emptyCell attribute.


setSeverity

public void setSeverity(java.lang.String severity)
Use the severity attribute when including the webuijsf:alarm component in a column, to match the severity of the alarm. Valid values are described in the webuijsf:alarm documentation. When the severity attribute is set in the tableColumn, the table component renders sort tool tips to indicate that the column will be sorted least/most severe first, and the table cell appears hightlighted according to the level of severity. This functionality is overridden by the emptyCell attribute.


getSort

public java.lang.Object getSort()
Use the sort attribute to specify a FieldKey id or SortCriteria that defines the criteria to use for sorting the contents of a TableDataProvider. If SortCriteria is provided, the object is used for sorting as is. If an id is provided, a FieldIdSortCriteria is created for sorting. In addition, a value binding can also be used to sort on an object that is external to TableDataProvider, such as the selected state of a checkbox or radiobutton. When a value binding is used, a ValueBindingSortCriteria object is created for sorting. All sorting is based on the object type associated with the data element (for example, Boolean, Character, Comparator, Date, Number, and String). If the object type cannot be determined, the object is compared as a String. The sort attribute is required for a column to be shown as sortable.


setSort

public void setSort(java.lang.Object sort)
Use the sort attribute to specify a FieldKey id or SortCriteria that defines the criteria to use for sorting the contents of a TableDataProvider. If SortCriteria is provided, the object is used for sorting as is. If an id is provided, a FieldIdSortCriteria is created for sorting. In addition, a value binding can also be used to sort on an object that is external to TableDataProvider, such as the selected state of a checkbox or radiobutton. When a value binding is used, a ValueBindingSortCriteria object is created for sorting. All sorting is based on the object type associated with the data element (for example, Boolean, Character, Comparator, Date, Number, and String). If the object type cannot be determined, the object is compared as a String. The sort attribute is required for a column to be shown as sortable.


getSortIcon

public java.lang.String getSortIcon()
The theme identifier to use for the sort button that is displayed in the column header. Use this attribute to override the default image.


setSortIcon

public void setSortIcon(java.lang.String sortIcon)
The theme identifier to use for the sort button that is displayed in the column header. Use this attribute to override the default image.


getSortImageURL

public java.lang.String getSortImageURL()
Absolute or relative URL to the image used for the sort button that is displayed in the column header.


setSortImageURL

public void setSortImageURL(java.lang.String sortImageURL)
Absolute or relative URL to the image used for the sort button that is displayed in the column header.


isSpacerColumn

public boolean isSpacerColumn()
Use the spacerColumn attribute to use the column as a blank column to enhance spacing in two or three column tables. When the spacerColumn attribute is true, the CSS styles applied to the column make it appear as if the columns are justified. If a column header and footer are required, provide an empty string for the headerText and footerText attributes. Set the width attribute to justify columns accordingly.


setSpacerColumn

public void setSpacerColumn(boolean spacerColumn)
Use the spacerColumn attribute to use the column as a blank column to enhance spacing in two or three column tables. When the spacerColumn attribute is true, the CSS styles applied to the column make it appear as if the columns are justified. If a column header and footer are required, provide an empty string for the headerText and footerText attributes. Set the width attribute to justify columns accordingly.


getStyle

public java.lang.String getStyle()
CSS style(s) to be applied to the outermost HTML element when this component is rendered.


setStyle

public void setStyle(java.lang.String style)
CSS style(s) to be applied to the outermost HTML element when this component is rendered.


getStyleClass

public java.lang.String getStyleClass()
CSS style class(es) to be applied to the outermost HTML element when this component is rendered.


setStyleClass

public void setStyleClass(java.lang.String styleClass)
CSS style class(es) to be applied to the outermost HTML element when this component is rendered.


getToolTip

public java.lang.String getToolTip()
Sets the value of the title attribute for the HTML element. The specified text will display as a tooltip if the mouse cursor hovers over the HTML element.


setToolTip

public void setToolTip(java.lang.String toolTip)
Sets the value of the title attribute for the HTML element. The specified text will display as a tooltip if the mouse cursor hovers over the HTML element.


getValign

public java.lang.String getValign()
Use the valign attribute to specify the vertical alignment for the content of each cell in the column. Valid values are top, middle, bottom, and baseline. The default vertical alignment is middle. Setting the valign attribute to baseline causes the first line of each cell's content to be aligned on the text baseline, the invisible line on which text characters rest.


setValign

public void setValign(java.lang.String valign)
Use the valign attribute to specify the vertical alignment for the content of each cell in the column. Valid values are top, middle, bottom, and baseline. The default vertical alignment is middle. Setting the valign attribute to baseline causes the first line of each cell's content to be aligned on the text baseline, the invisible line on which text characters rest.


isVisible

public boolean isVisible()
Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. If set to false, the HTML code for the component is present in the page, but the component is hidden with style attributes. By default, visible is set to true, so HTML for the component HTML is included and visible to the user. If the component is not visible, it can still be processed on subsequent form submissions because the HTML is present.


setVisible

public void setVisible(boolean visible)
Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. If set to false, the HTML code for the component is present in the page, but the component is hidden with style attributes. By default, visible is set to true, so HTML for the component HTML is included and visible to the user. If the component is not visible, it can still be processed on subsequent form submissions because the HTML is present.


getWidth

public java.lang.String getWidth()
Use the width attribute to specify the width of the cells of the column. The width can be specified as the number of pixels or the percentage of the table width, and is especially useful for spacer columns. This attribute is deprecated in HTML 4.0 in favor of style sheets.


setWidth

public void setWidth(java.lang.String width)
Use the width attribute to specify the width of the cells of the column. The width can be specified as the number of pixels or the percentage of the table width, and is especially useful for spacer columns. This attribute is deprecated in HTML 4.0 in favor of style sheets.


restoreState

public void restoreState(javax.faces.context.FacesContext _context,
                         java.lang.Object _state)
Restore the state of this component.

Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class javax.faces.component.UIComponentBase

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext _context)
Save the state of this component.

Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class javax.faces.component.UIComponentBase


Copyright © 2008 Sun Microsystems, Inc. All Rights Reserved.