com.sun.webui.jsf.component
Class TablePanels

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by com.sun.webui.jsf.component.TablePanels
All Implemented Interfaces:
javax.faces.component.NamingContainer, javax.faces.component.StateHolder

public class TablePanels
extends javax.faces.component.UIComponentBase
implements javax.faces.component.NamingContainer

Component that represents an embedded panel.

Note: Column headers and footers are rendered by TableRowGroupRenderer. Table column footers are rendered by TableRenderer.

Note: To see the messages logged by this class, set the following global defaults in your JDK's "jre/lib/logging.properties" file.

 java.util.logging.ConsoleHandler.level = FINE
 com.sun.webui.jsf.component.TablePanels.level = FINE
 


Field Summary
static java.lang.String FILTER_PANEL_ID
          The facet name for the filter panel.
static java.lang.String PREFERENCES_PANEL_ID
          The facet name for the preferences panel.
static java.lang.String PRIMARY_SORT_COLUMN_MENU_FACET
          The facet name for the primary sort column menu.
static java.lang.String PRIMARY_SORT_COLUMN_MENU_ID
          The component id for the primary sort column menu.
static java.lang.String PRIMARY_SORT_COLUMN_MENU_LABEL_FACET
          The facet name for the primary sort column menu label.
static java.lang.String PRIMARY_SORT_COLUMN_MENU_LABEL_ID
          The component id for the primary sort column menu label.
static java.lang.String PRIMARY_SORT_ORDER_MENU_FACET
          The facet name for the primary sort order menu.
static java.lang.String PRIMARY_SORT_ORDER_MENU_ID
          The component id for the primary sort order menu.
static java.lang.String SECONDARY_SORT_COLUMN_MENU_FACET
          The facet name for the secondary sort column menu.
static java.lang.String SECONDARY_SORT_COLUMN_MENU_ID
          The component id for the secondary sort column menu.
static java.lang.String SECONDARY_SORT_COLUMN_MENU_LABEL_FACET
          The facet name for the secondary sort column menu label.
static java.lang.String SECONDARY_SORT_COLUMN_MENU_LABEL_ID
          The component id for the secondary sort column menu label.
static java.lang.String SECONDARY_SORT_ORDER_MENU_FACET
          The facet name for the secondary sort order menu.
static java.lang.String SECONDARY_SORT_ORDER_MENU_ID
          The component id for the secondary sort order menu.
static java.lang.String SORT_PANEL_CANCEL_BUTTON_FACET
          The facet name for the sort panel cancel button.
static java.lang.String SORT_PANEL_CANCEL_BUTTON_ID
          The component id for the sort panel cancel button.
static java.lang.String SORT_PANEL_ID
          The facet name for the sort panel.
static java.lang.String SORT_PANEL_SUBMIT_BUTTON_FACET
          The facet name for the sort panel submit button.
static java.lang.String SORT_PANEL_SUBMIT_BUTTON_ID
          The component id for the sort panel submit button.
static java.lang.String TERTIARY_SORT_COLUMN_MENU_FACET
          The facet name for the tertiary sort column menu.
static java.lang.String TERTIARY_SORT_COLUMN_MENU_ID
          The component id for the tertiary sort column menu.
static java.lang.String TERTIARY_SORT_COLUMN_MENU_LABEL_FACET
          The facet name for the tertiary sort column menu label.
static java.lang.String TERTIARY_SORT_COLUMN_MENU_LABEL_ID
          The component id for the tertiary sort column menu label.
static java.lang.String TERTIARY_SORT_ORDER_MENU_FACET
          The facet name for the tertiary sort order menu.
static java.lang.String TERTIARY_SORT_ORDER_MENU_ID
          The component id for the tertiary sort order menu.
 
Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
 
Constructor Summary
TablePanels()
          Default constructor
 
Method Summary
 void encodeBegin(javax.faces.context.FacesContext context)
          If the rendered property is true, render the begining of the current state of this UIComponent to the response contained in the specified FacesContext.
 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.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 getExtraHtml()
          Extra HTML to be appended to the tag output by this renderer.
 java.lang.String getFamily()
          Return the family for this component.
 java.lang.String getHeaders()
          The HEADERS attribute specifies the header cells that apply to the TD.
 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.
 javax.faces.component.UIComponent getPrimarySortColumnMenu()
          Get primary sort column menu used in the sort panel.
 javax.faces.component.UIComponent getPrimarySortColumnMenuLabel()
          Get primary sort column menu label used in the sort panel.
 javax.faces.component.UIComponent getPrimarySortOrderMenu()
          Get primary sort order menu used in the sort panel.
 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.
 javax.faces.component.UIComponent getSecondarySortColumnMenu()
          Get secondary sort column menu used in the sort panel.
 javax.faces.component.UIComponent getSecondarySortColumnMenuLabel()
          Get secondary sort column menu label used in the sort panel.
 javax.faces.component.UIComponent getSecondarySortOrderMenu()
          Get secondary sort order menu used in the sort panel.
 javax.faces.component.UIComponent getSortPanelCancelButton()
          Get sort panel cancel button.
 javax.faces.component.UIComponent getSortPanelSubmitButton()
          Get sort panel submit button.
 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.
 Table getTableAncestor()
          Get the closest Table ancestor that encloses this component.
 javax.faces.component.UIComponent getTertiarySortColumnMenu()
          Get tertiary sort column menu used in the sort panel.
 javax.faces.component.UIComponent getTertiarySortColumnMenuLabel()
          Get tertiary sort column menu label used in the sort panel.
 javax.faces.component.UIComponent getTertiarySortOrderMenu()
          Get tertiary sort order menu used in the sort panel.
 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 isFilterPanel()
          Flag indicating this component should also render a filter panel, in addition to the sort and preferences panels.
 boolean isNoWrap()
          Use the noWrap attribute to disable word wrapping of this column's cells in visual browsers.
 boolean isPreferencesPanel()
          Flag indicating this component should also render a preferences panel, in addition to the sort and filter panels.
 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 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 setExtraHtml(java.lang.String extraHtml)
          Extra HTML to be appended to the tag output by this renderer.
 void setFilterPanel(boolean filterPanel)
          Flag indicating this component should also render a filter panel, in addition to the sort and preferences panels.
 void setHeaders(java.lang.String headers)
          The HEADERS attribute specifies the header cells that apply to the TD.
 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 setPreferencesPanel(boolean preferencesPanel)
          Flag indicating this component should also render a preferences panel, in addition to the sort and filter panels.
 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 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 javax.faces.component.UIComponentBase
broadcast, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

FILTER_PANEL_ID

public static final java.lang.String FILTER_PANEL_ID
The facet name for the filter panel.

See Also:
Constant Field Values

PREFERENCES_PANEL_ID

public static final java.lang.String PREFERENCES_PANEL_ID
The facet name for the preferences panel.

See Also:
Constant Field Values

PRIMARY_SORT_COLUMN_MENU_ID

public static final java.lang.String PRIMARY_SORT_COLUMN_MENU_ID
The component id for the primary sort column menu.

See Also:
Constant Field Values

PRIMARY_SORT_COLUMN_MENU_FACET

public static final java.lang.String PRIMARY_SORT_COLUMN_MENU_FACET
The facet name for the primary sort column menu.

See Also:
Constant Field Values

PRIMARY_SORT_COLUMN_MENU_LABEL_ID

public static final java.lang.String PRIMARY_SORT_COLUMN_MENU_LABEL_ID
The component id for the primary sort column menu label.

See Also:
Constant Field Values

PRIMARY_SORT_COLUMN_MENU_LABEL_FACET

public static final java.lang.String PRIMARY_SORT_COLUMN_MENU_LABEL_FACET
The facet name for the primary sort column menu label.

See Also:
Constant Field Values

PRIMARY_SORT_ORDER_MENU_ID

public static final java.lang.String PRIMARY_SORT_ORDER_MENU_ID
The component id for the primary sort order menu.

See Also:
Constant Field Values

PRIMARY_SORT_ORDER_MENU_FACET

public static final java.lang.String PRIMARY_SORT_ORDER_MENU_FACET
The facet name for the primary sort order menu.

See Also:
Constant Field Values

SECONDARY_SORT_COLUMN_MENU_ID

public static final java.lang.String SECONDARY_SORT_COLUMN_MENU_ID
The component id for the secondary sort column menu.

See Also:
Constant Field Values

SECONDARY_SORT_COLUMN_MENU_FACET

public static final java.lang.String SECONDARY_SORT_COLUMN_MENU_FACET
The facet name for the secondary sort column menu.

See Also:
Constant Field Values

SECONDARY_SORT_COLUMN_MENU_LABEL_ID

public static final java.lang.String SECONDARY_SORT_COLUMN_MENU_LABEL_ID
The component id for the secondary sort column menu label.

See Also:
Constant Field Values

SECONDARY_SORT_COLUMN_MENU_LABEL_FACET

public static final java.lang.String SECONDARY_SORT_COLUMN_MENU_LABEL_FACET
The facet name for the secondary sort column menu label.

See Also:
Constant Field Values

SECONDARY_SORT_ORDER_MENU_ID

public static final java.lang.String SECONDARY_SORT_ORDER_MENU_ID
The component id for the secondary sort order menu.

See Also:
Constant Field Values

SECONDARY_SORT_ORDER_MENU_FACET

public static final java.lang.String SECONDARY_SORT_ORDER_MENU_FACET
The facet name for the secondary sort order menu.

See Also:
Constant Field Values

SORT_PANEL_ID

public static final java.lang.String SORT_PANEL_ID
The facet name for the sort panel.

See Also:
Constant Field Values

SORT_PANEL_CANCEL_BUTTON_ID

public static final java.lang.String SORT_PANEL_CANCEL_BUTTON_ID
The component id for the sort panel cancel button.

See Also:
Constant Field Values

SORT_PANEL_CANCEL_BUTTON_FACET

public static final java.lang.String SORT_PANEL_CANCEL_BUTTON_FACET
The facet name for the sort panel cancel button.

See Also:
Constant Field Values

SORT_PANEL_SUBMIT_BUTTON_ID

public static final java.lang.String SORT_PANEL_SUBMIT_BUTTON_ID
The component id for the sort panel submit button.

See Also:
Constant Field Values

SORT_PANEL_SUBMIT_BUTTON_FACET

public static final java.lang.String SORT_PANEL_SUBMIT_BUTTON_FACET
The facet name for the sort panel submit button.

See Also:
Constant Field Values

TERTIARY_SORT_COLUMN_MENU_ID

public static final java.lang.String TERTIARY_SORT_COLUMN_MENU_ID
The component id for the tertiary sort column menu.

See Also:
Constant Field Values

TERTIARY_SORT_COLUMN_MENU_FACET

public static final java.lang.String TERTIARY_SORT_COLUMN_MENU_FACET
The facet name for the tertiary sort column menu.

See Also:
Constant Field Values

TERTIARY_SORT_COLUMN_MENU_LABEL_ID

public static final java.lang.String TERTIARY_SORT_COLUMN_MENU_LABEL_ID
The component id for the tertiary sort column menu label.

See Also:
Constant Field Values

TERTIARY_SORT_COLUMN_MENU_LABEL_FACET

public static final java.lang.String TERTIARY_SORT_COLUMN_MENU_LABEL_FACET
The facet name for the tertiary sort column menu label.

See Also:
Constant Field Values

TERTIARY_SORT_ORDER_MENU_ID

public static final java.lang.String TERTIARY_SORT_ORDER_MENU_ID
The component id for the tertiary sort order menu.

See Also:
Constant Field Values

TERTIARY_SORT_ORDER_MENU_FACET

public static final java.lang.String TERTIARY_SORT_ORDER_MENU_FACET
The facet name for the tertiary sort order menu.

See Also:
Constant Field Values
Constructor Detail

TablePanels

public TablePanels()
Default constructor

Method Detail

getFamily

public java.lang.String getFamily()
Return the family for this component.

Specified by:
getFamily in class javax.faces.component.UIComponent

getTableAncestor

public Table getTableAncestor()
Get the closest Table ancestor that encloses this component.

Returns:
The Table ancestor.

getPrimarySortColumnMenu

public javax.faces.component.UIComponent getPrimarySortColumnMenu()
Get primary sort column menu used in the sort panel.

Returns:
The primary sort column menu.

getPrimarySortColumnMenuLabel

public javax.faces.component.UIComponent getPrimarySortColumnMenuLabel()
Get primary sort column menu label used in the sort panel.

Returns:
The primary sort column menu label.

getPrimarySortOrderMenu

public javax.faces.component.UIComponent getPrimarySortOrderMenu()
Get primary sort order menu used in the sort panel.

Returns:
The primary sort order menu.

getSecondarySortColumnMenu

public javax.faces.component.UIComponent getSecondarySortColumnMenu()
Get secondary sort column menu used in the sort panel.

Returns:
The secondary sort column menu.

getSecondarySortColumnMenuLabel

public javax.faces.component.UIComponent getSecondarySortColumnMenuLabel()
Get secondary sort column menu label used in the sort panel.

Returns:
The secondary sort column menu label.

getSecondarySortOrderMenu

public javax.faces.component.UIComponent getSecondarySortOrderMenu()
Get secondary sort order menu used in the sort panel.

Returns:
The secondary sort order menu.

getSortPanelCancelButton

public javax.faces.component.UIComponent getSortPanelCancelButton()
Get sort panel cancel button.

Returns:
The sort panel cancel button.

getSortPanelSubmitButton

public javax.faces.component.UIComponent getSortPanelSubmitButton()
Get sort panel submit button.

Returns:
The sort panel submit button.

getTertiarySortColumnMenu

public javax.faces.component.UIComponent getTertiarySortColumnMenu()
Get tertiary sort column menu used in the sort panel.

Returns:
The tertiary sort column menu.

getTertiarySortColumnMenuLabel

public javax.faces.component.UIComponent getTertiarySortColumnMenuLabel()
Get tertiary sort column menu label used in the sort panel.

Returns:
The tertiary sort column menu label.

getTertiarySortOrderMenu

public javax.faces.component.UIComponent getTertiarySortOrderMenu()
Get tertiary sort order menu used in the sort panel.

Returns:
The tertiary sort order menu.

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext context)
                 throws java.io.IOException
If the rendered property is true, render the begining of the current state of this UIComponent to the response contained in the specified FacesContext. If a Renderer is associated with this UIComponent, the actual encoding will be delegated to Renderer.encodeBegin(FacesContext, UIComponent).

Overrides:
encodeBegin in class javax.faces.component.UIComponentBase
Parameters:
context - FacesContext for the current request.
Throws:
java.io.IOException - if an input/output error occurs while rendering.
java.lang.NullPointerException - if FacesContext is null.

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.


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.


getExtraHtml

public java.lang.String getExtraHtml()
Extra HTML to be appended to the tag output by this renderer.


setExtraHtml

public void setExtraHtml(java.lang.String extraHtml)
Extra HTML to be appended to the tag output by this renderer.


isFilterPanel

public boolean isFilterPanel()
Flag indicating this component should also render a filter panel, in addition to the sort and preferences panels. The default renders a sort panel.


setFilterPanel

public void setFilterPanel(boolean filterPanel)
Flag indicating this component should also render a filter panel, in addition to the sort and preferences panels. The default renders a sort panel.


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.


isPreferencesPanel

public boolean isPreferencesPanel()
Flag indicating this component should also render a preferences panel, in addition to the sort and filter panels. The default renders a sort panel.


setPreferencesPanel

public void setPreferencesPanel(boolean preferencesPanel)
Flag indicating this component should also render a preferences panel, in addition to the sort and filter panels. The default renders a sort panel.


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


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.


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.


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.