com.sun.webui.jsf.component
Class TableBase

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.TableBase
All Implemented Interfaces:
javax.faces.component.NamingContainer, javax.faces.component.StateHolder
Direct Known Subclasses:
Table

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

Base class for table components.


Field Summary
static java.lang.String ACTIONS_TOP_FACET
          The facet name for top actions area.
 
Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
 
Constructor Summary
TableBase()
           
 
Method Summary
 void clear()
          Clear cached properties.
 java.lang.String getAlign()
          The deprecated ALIGN attribute suggests the horizontal alignment of the table on visual browsers.
 java.lang.String getBgColor()
          The deprecated BGCOLOR attribute suggests a background color for the table.
 int getBorder()
          The BORDER attribute specifies the width in pixels of the border around a table.
 java.lang.String getCellPadding()
          The amount of whitespace that should be placed between the cell contents and the cell borders, on all four sides of the cell.
 java.lang.String getCellSpacing()
          The amount of whitespace that should be placed between cells, and between the edges of the table content area and the sides of the table.
 java.lang.String getDeselectMultipleButtonOnClick()
          Scripting code that is executed when the user clicks the deselect multiple button.
 java.lang.String getDeselectSingleButtonOnClick()
          Scripting code that is executed when the user clicks the deselect single button.
 java.lang.String getFilterId()
          The element id to be applied to the outermost HTML element that is rendered for the dropDown component used to display filter options.
 java.lang.String getFilterPanelFocusId()
          The element id used to set focus when the filter panel is open.
 java.lang.String getFilterText()
          Text to be inserted into the table title bar when a filter is applied.
 java.lang.String getFrame()
          The BORDER attribute specifies the width in pixels of the border around a table.
 java.lang.String getItemsText()
          Text to add to the title of an unpaginated table.
 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.
 java.lang.String getPreferencesPanelFocusId()
          The element id used to set focus when the preferences panel is open.
 java.lang.String getRules()
          The RULES attribute, poorly supported by browsers, specifies the borders between table cells.
 java.lang.String getSelectMultipleButtonOnClick()
          Scripting code executed when the user clicks the mouse on the select multiple button.
 java.lang.String getSortPanelFocusId()
          The element id used to set focus when the sort panel is open.
 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.lang.String getSummary()
          Text that describes this table's purpose and structure, for user agents rendering to non-visual media such as speech and Braille.
 int getTabIndex()
          Position of this element in the tabbing order of the current document.
 java.util.Iterator getTableRowGroupChildren()
          Get an Iterator over the TableRowGroupBase children found for this component.
 java.lang.String getTitle()
          The text displayed for the table title.
 java.lang.String getToolTip()
          Sets the value of the title attribute for the HTML element.
 java.lang.String getWidth()
          Use the width attribute to specify the width of the table.
 boolean isAugmentTitle()
          Flag indicating that the table title should be augmented with the range of items currently displayed and the total number of items in the table.
 boolean isClearSortButton()
          In the View-Changing Controls area of the Action Bar, display a button that clears any sorting of the table.
 boolean isDeselectMultipleButton()
          In the Action Bar, display a deselect button for tables in which multiple rows can be selected, to allow users to deselect all table rows that are currently displayed.
 boolean isDeselectSingleButton()
          In the Action Bar, display a deselect button for tables in which only a single table row can be selected at a time.
 boolean isHiddenSelectedRows()
          Flag indicating that selected rows might be currently hidden from view.
 boolean isLite()
          Renders the table in a style that makes the table look lighter weight, generally by omitting the shading around the table and in the title bar.
 boolean isPaginateButton()
          Show table paginate button to allow users to switch between viewing all data on a single page (unpaginated) or to see data in multiple pages (paginated).
 boolean isSelectMultipleButton()
          Show the button that is used for selecting multiple rows.
 boolean isSortPanelToggleButton()
          Show the button that is used to open and close the sort panel.
 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 setAlign(java.lang.String align)
          The deprecated ALIGN attribute suggests the horizontal alignment of the table on visual browsers.
 void setAugmentTitle(boolean augmentTitle)
          Flag indicating that the table title should be augmented with the range of items currently displayed and the total number of items in the table.
 void setBgColor(java.lang.String bgColor)
          The deprecated BGCOLOR attribute suggests a background color for the table.
 void setBorder(int border)
          The BORDER attribute specifies the width in pixels of the border around a table.
 void setCellPadding(java.lang.String cellPadding)
          The amount of whitespace that should be placed between the cell contents and the cell borders, on all four sides of the cell.
 void setCellSpacing(java.lang.String cellSpacing)
          The amount of whitespace that should be placed between cells, and between the edges of the table content area and the sides of the table.
 void setClearSortButton(boolean clearSortButton)
          In the View-Changing Controls area of the Action Bar, display a button that clears any sorting of the table.
 void setDeselectMultipleButton(boolean deselectMultipleButton)
          In the Action Bar, display a deselect button for tables in which multiple rows can be selected, to allow users to deselect all table rows that are currently displayed.
 void setDeselectMultipleButtonOnClick(java.lang.String deselectMultipleButtonOnClick)
          Scripting code that is executed when the user clicks the deselect multiple button.
 void setDeselectSingleButton(boolean deselectSingleButton)
          In the Action Bar, display a deselect button for tables in which only a single table row can be selected at a time.
 void setDeselectSingleButtonOnClick(java.lang.String deselectSingleButtonOnClick)
          Scripting code that is executed when the user clicks the deselect single button.
 void setFilterId(java.lang.String filterId)
          The element id to be applied to the outermost HTML element that is rendered for the dropDown component used to display filter options.
 void setFilterPanelFocusId(java.lang.String filterPanelFocusId)
          The element id used to set focus when the filter panel is open.
 void setFilterText(java.lang.String filterText)
          Text to be inserted into the table title bar when a filter is applied.
 void setFrame(java.lang.String frame)
          The BORDER attribute specifies the width in pixels of the border around a table.
 void setHiddenSelectedRows(boolean hiddenSelectedRows)
          Flag indicating that selected rows might be currently hidden from view.
 void setItemsText(java.lang.String itemsText)
          Text to add to the title of an unpaginated table.
 void setLite(boolean lite)
          Renders the table in a style that makes the table look lighter weight, generally by omitting the shading around the table and in the title bar.
 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 setPaginateButton(boolean paginateButton)
          Show table paginate button to allow users to switch between viewing all data on a single page (unpaginated) or to see data in multiple pages (paginated).
 void setPreferencesPanelFocusId(java.lang.String preferencesPanelFocusId)
          The element id used to set focus when the preferences panel is open.
 void setRules(java.lang.String rules)
          The RULES attribute, poorly supported by browsers, specifies the borders between table cells.
 void setSelectMultipleButton(boolean selectMultipleButton)
          Show the button that is used for selecting multiple rows.
 void setSelectMultipleButtonOnClick(java.lang.String selectMultipleButtonOnClick)
          Scripting code executed when the user clicks the mouse on the select multiple button.
 void setSortPanelFocusId(java.lang.String sortPanelFocusId)
          The element id used to set focus when the sort panel is open.
 void setSortPanelToggleButton(boolean sortPanelToggleButton)
          Show the button that is used to open and close the sort panel.
 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 setSummary(java.lang.String summary)
          Text that describes this table's purpose and structure, for user agents rendering to non-visual media such as speech and Braille.
 void setTabIndex(int tabIndex)
          Position of this element in the tabbing order of the current document.
 void setTitle(java.lang.String title)
          The text displayed for the table title.
 void setToolTip(java.lang.String toolTip)
          Sets the value of the title attribute for the HTML element.
 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 table.
 
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
 

Field Detail

ACTIONS_TOP_FACET

public static final java.lang.String ACTIONS_TOP_FACET
The facet name for top actions area.

See Also:
Constant Field Values
Constructor Detail

TableBase

public TableBase()
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).


getTableRowGroupChildren

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

Returns:
An Iterator over the TableRowGroupBase children.

getAlign

public java.lang.String getAlign()

The deprecated ALIGN attribute suggests the horizontal alignment of the table on visual browsers. Possible values are left, right, and center. Browsers generally present left- or right-aligned tables as floating tables, with the content following the TABLE flowing around it. To prevent content from flowing around the table, use
after the end of the TABLE.

Since many browsers do not support ALIGN=center with TABLE, authors may wish to place the TABLE within a CENTER element.

Style sheets provide more flexibility in suggesting table alignment but with less browser support than the ALIGN attribute.


setAlign

public void setAlign(java.lang.String align)

The deprecated ALIGN attribute suggests the horizontal alignment of the table on visual browsers. Possible values are left, right, and center. Browsers generally present left- or right-aligned tables as floating tables, with the content following the TABLE flowing around it. To prevent content from flowing around the table, use
after the end of the TABLE.

Since many browsers do not support ALIGN=center with TABLE, authors may wish to place the TABLE within a CENTER element.

Style sheets provide more flexibility in suggesting table alignment but with less browser support than the ALIGN attribute.


isAugmentTitle

public boolean isAugmentTitle()
Flag indicating that the table title should be augmented with the range of items currently displayed and the total number of items in the table. For example, "(1 - 25 of 200)". If the table is not currently paginated, the title is augmented with the number of displayed items. For example, "(18)". When set to false, any values set for itemsText and filterText are overridden.


setAugmentTitle

public void setAugmentTitle(boolean augmentTitle)
Flag indicating that the table title should be augmented with the range of items currently displayed and the total number of items in the table. For example, "(1 - 25 of 200)". If the table is not currently paginated, the title is augmented with the number of displayed items. For example, "(18)". When set to false, any values set for itemsText and filterText are overridden.


getBgColor

public java.lang.String getBgColor()
The deprecated BGCOLOR attribute suggests a background color for the table. 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.


setBgColor

public void setBgColor(java.lang.String bgColor)
The deprecated BGCOLOR attribute suggests a background color for the table. 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.


getBorder

public int getBorder()
The BORDER attribute specifies the width in pixels of the border around a table.


setBorder

public void setBorder(int border)
The BORDER attribute specifies the width in pixels of the border around a table.


getCellPadding

public java.lang.String getCellPadding()

The amount of whitespace that should be placed between the cell contents and the cell borders, on all four sides of the cell. The default value is 0, which causes a default amount of space to be used.

All browsers support specifying the number of pixels to use for cell padding, so you should specify a number of pixels to achieve consistency across platforms. Some browsers also support specifying the cell padding as a percentage of the space available for padding, and the calculated space is split evenly between the sides. Most browsers that do not support percentages treat cellpadding="20%" as if it were cellpadding="20".


setCellPadding

public void setCellPadding(java.lang.String cellPadding)

The amount of whitespace that should be placed between the cell contents and the cell borders, on all four sides of the cell. The default value is 0, which causes a default amount of space to be used.

All browsers support specifying the number of pixels to use for cell padding, so you should specify a number of pixels to achieve consistency across platforms. Some browsers also support specifying the cell padding as a percentage of the space available for padding, and the calculated space is split evenly between the sides. Most browsers that do not support percentages treat cellpadding="20%" as if it were cellpadding="20".


getCellSpacing

public java.lang.String getCellSpacing()

The amount of whitespace that should be placed between cells, and between the edges of the table content area and the sides of the table. The default value is 0, which causes a default amount of space to be used.

All browsers support specifying the number of pixels to use for cell spacing, so you should specify a number of pixels to achieve consistency across platforms. Some browsers also support specifying the cell spacing as a percentage of the space available for spacing, and the calculated space is split evenly between the sides. Most browsers that do not support percentages treat cellspacing="20%" as if it were cellspacing="20".


setCellSpacing

public void setCellSpacing(java.lang.String cellSpacing)

The amount of whitespace that should be placed between cells, and between the edges of the table content area and the sides of the table. The default value is 0, which causes a default amount of space to be used.

All browsers support specifying the number of pixels to use for cell spacing, so you should specify a number of pixels to achieve consistency across platforms. Some browsers also support specifying the cell spacing as a percentage of the space available for spacing, and the calculated space is split evenly between the sides. Most browsers that do not support percentages treat cellspacing="20%" as if it were cellspacing="20".


isClearSortButton

public boolean isClearSortButton()
In the View-Changing Controls area of the Action Bar, display a button that clears any sorting of the table. When the button is clicked, the table items return to the order they were in when the page was initially rendered.


setClearSortButton

public void setClearSortButton(boolean clearSortButton)
In the View-Changing Controls area of the Action Bar, display a button that clears any sorting of the table. When the button is clicked, the table items return to the order they were in when the page was initially rendered.


isDeselectMultipleButton

public boolean isDeselectMultipleButton()
In the Action Bar, display a deselect button for tables in which multiple rows can be selected, to allow users to deselect all table rows that are currently displayed. This button is used to deselect a column of checkboxes using the id that was given to the selectId attribute of the webuijsf:tableColumn and webuijsf:table2Column tags.


setDeselectMultipleButton

public void setDeselectMultipleButton(boolean deselectMultipleButton)
In the Action Bar, display a deselect button for tables in which multiple rows can be selected, to allow users to deselect all table rows that are currently displayed. This button is used to deselect a column of checkboxes using the id that was given to the selectId attribute of the webuijsf:tableColumn and webuijsf:table2Column tags.


getDeselectMultipleButtonOnClick

public java.lang.String getDeselectMultipleButtonOnClick()
Scripting code that is executed when the user clicks the deselect multiple button. You should use the JavaScript setTimeout() function to invoke the script to ensure that checkboxes are deselected immediately, instead of waiting for the script to complete.


setDeselectMultipleButtonOnClick

public void setDeselectMultipleButtonOnClick(java.lang.String deselectMultipleButtonOnClick)
Scripting code that is executed when the user clicks the deselect multiple button. You should use the JavaScript setTimeout() function to invoke the script to ensure that checkboxes are deselected immediately, instead of waiting for the script to complete.


isDeselectSingleButton

public boolean isDeselectSingleButton()
In the Action Bar, display a deselect button for tables in which only a single table row can be selected at a time. This button is used to deselect a column of radio buttons using the id that was given to the selectId attribute of the webuijsf:tableColumn and webuijsf:table2Column tags.


setDeselectSingleButton

public void setDeselectSingleButton(boolean deselectSingleButton)
In the Action Bar, display a deselect button for tables in which only a single table row can be selected at a time. This button is used to deselect a column of radio buttons using the id that was given to the selectId attribute of the webuijsf:tableColumn and webuijsf:table2Column tags.


getDeselectSingleButtonOnClick

public java.lang.String getDeselectSingleButtonOnClick()
Scripting code that is executed when the user clicks the deselect single button. You should use the JavaScript setTimeout() function to invoke the script to ensure that the radio button is deselected immediately, instead of waiting for the script to complete.


setDeselectSingleButtonOnClick

public void setDeselectSingleButtonOnClick(java.lang.String deselectSingleButtonOnClick)
Scripting code that is executed when the user clicks the deselect single button. You should use the JavaScript setTimeout() function to invoke the script to ensure that the radio button is deselected immediately, instead of waiting for the script to complete.


getFilterId

public java.lang.String getFilterId()
The element id to be applied to the outermost HTML element that is rendered for the dropDown component used to display filter options. The id must be fully qualified. This id is required for JavaScript functions to set the dropDown styles when the embedded filter panel is opened, and to reset the default selected value when the panel is closed. Note that if you use the webuijsf:dropDown tag as the only component in the filter facet, the filterId is optional. If you use a custom component, or use the webuijsf:dropDown as a child component, you must specify a filterID.


setFilterId

public void setFilterId(java.lang.String filterId)
The element id to be applied to the outermost HTML element that is rendered for the dropDown component used to display filter options. The id must be fully qualified. This id is required for JavaScript functions to set the dropDown styles when the embedded filter panel is opened, and to reset the default selected value when the panel is closed. Note that if you use the webuijsf:dropDown tag as the only component in the filter facet, the filterId is optional. If you use a custom component, or use the webuijsf:dropDown as a child component, you must specify a filterID.


getFilterPanelFocusId

public java.lang.String getFilterPanelFocusId()
The element id used to set focus when the filter panel is open.


setFilterPanelFocusId

public void setFilterPanelFocusId(java.lang.String filterPanelFocusId)
The element id used to set focus when the filter panel is open.


getFilterText

public java.lang.String getFilterText()
Text to be inserted into the table title bar when a filter is applied. This text is expected to be the name of the filter that the user has selected. The attribute value should be a JavaServer Faces EL expression that resolves to a backing bean property whose value is set in your filter code. The value of the filterText attribute is inserted into the table title, as follows: Your Table's Title filterText Filter Applied.


setFilterText

public void setFilterText(java.lang.String filterText)
Text to be inserted into the table title bar when a filter is applied. This text is expected to be the name of the filter that the user has selected. The attribute value should be a JavaServer Faces EL expression that resolves to a backing bean property whose value is set in your filter code. The value of the filterText attribute is inserted into the table title, as follows: Your Table's Title filterText Filter Applied.


getFrame

public java.lang.String getFrame()
The BORDER attribute specifies the width in pixels of the border around a table.


setFrame

public void setFrame(java.lang.String frame)
The BORDER attribute specifies the width in pixels of the border around a table.


isHiddenSelectedRows

public boolean isHiddenSelectedRows()
Flag indicating that selected rows might be currently hidden from view. UI guidelines recommend that rows that are not in view are deselected. For example, when users select rows of the table and navigate to another page, the selected rows should be deselected automatically. Or, when a user applies a filter or sort that hides previously selected rows from view, those selected rows should be deselected. By deselecting hidden rows, you prevent the user from inadvertantly invoking an action on rows that are not displayed.

However, sometimes state must be maintained aross table pages. If your table must maintain state, you must set the hiddenSelectedRows attribute to true. The attribute causes text to be displayed in the table title and footer to indicate the number of selected rows that are currently hidden from view. This title and footer text is also displayed with a count of 0 when there are no hidden selections, to make the user aware of the possibility of hidden selections.

Note: When hiddenSelectedRows is false, the descending sort button for the select column is disabled when the table is paginated. Disabling this button prevents a sort from placing selected rows on a page other than the current page.


setHiddenSelectedRows

public void setHiddenSelectedRows(boolean hiddenSelectedRows)

Flag indicating that selected rows might be currently hidden from view. UI guidelines recommend that rows that are not in view are deselected. For example, when users select rows of the table and navigate to another page, the selected rows should be deselected automatically. Or, when a user applies a filter or sort that hides previously selected rows from view, those selected rows should be deselected. By deselecting hidden rows, you prevent the user from inadvertantly invoking an action on rows that are not displayed.

However, sometimes state must be maintained aross table pages. If your table must maintain state, you must set the hiddenSelectedRows attribute to true. The attribute causes text to be displayed in the table title and footer to indicate the number of selected rows that are currently hidden from view. This title and footer text is also displayed with a count of 0 when there are no hidden selections, to make the user aware of the possibility of hidden selections.

Note: When hiddenSelectedRows is false, the descending sort button for the select column is disabled when the table is paginated. Disabling this button prevents a sort from placing selected rows on a page other than the current page.


getItemsText

public java.lang.String getItemsText()
Text to add to the title of an unpaginated table. For example, if your table title is "Critical" and there are 20 items in the table, the default unpaginated table title would be Critical (20). If you specify itemsText="alerts", the title would be Critical (20 alerts).


setItemsText

public void setItemsText(java.lang.String itemsText)
Text to add to the title of an unpaginated table. For example, if your table title is "Critical" and there are 20 items in the table, the default unpaginated table title would be Critical (20). If you specify itemsText="alerts", the title would be Critical (20 alerts).


isLite

public boolean isLite()
Renders the table in a style that makes the table look lighter weight, generally by omitting the shading around the table and in the title bar.


setLite

public void setLite(boolean lite)
Renders the table in a style that makes the table look lighter weight, generally by omitting the shading around the table and in the title bar.


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.


isPaginateButton

public boolean isPaginateButton()
Show table paginate button to allow users to switch between viewing all data on a single page (unpaginated) or to see data in multiple pages (paginated).


setPaginateButton

public void setPaginateButton(boolean paginateButton)
Show table paginate button to allow users to switch between viewing all data on a single page (unpaginated) or to see data in multiple pages (paginated).


getPreferencesPanelFocusId

public java.lang.String getPreferencesPanelFocusId()
The element id used to set focus when the preferences panel is open.


setPreferencesPanelFocusId

public void setPreferencesPanelFocusId(java.lang.String preferencesPanelFocusId)
The element id used to set focus when the preferences panel is open.


getRules

public java.lang.String getRules()
The RULES attribute, poorly supported by browsers, specifies the borders between table cells. Possible values are none for no inner borders, groups for borders between row groups and column groups only, rows for borders between rows only, cols for borders between columns only, and all for borders between all cells. None is the default value if BORDER=0 is used or if no BORDER attribute is given. All is the default value for any other use of BORDER.


setRules

public void setRules(java.lang.String rules)
The RULES attribute, poorly supported by browsers, specifies the borders between table cells. Possible values are none for no inner borders, groups for borders between row groups and column groups only, rows for borders between rows only, cols for borders between columns only, and all for borders between all cells. None is the default value if BORDER=0 is used or if no BORDER attribute is given. All is the default value for any other use of BORDER.


isSelectMultipleButton

public boolean isSelectMultipleButton()
Show the button that is used for selecting multiple rows. The button is displayed in the Action Bar (top), and allows users to select all rows currently displayed. The button selects a column of checkboxes using the id specified in the selectId attribute of the webuijsf:tableColumn and webuijsf:table2Column tags.


setSelectMultipleButton

public void setSelectMultipleButton(boolean selectMultipleButton)
Show the button that is used for selecting multiple rows. The button is displayed in the Action Bar (top), and allows users to select all rows currently displayed. The button selects a column of checkboxes using the id specified in the selectId attribute of the webuijsf:tableColumn and webuijsf:table2Column tags.


getSelectMultipleButtonOnClick

public java.lang.String getSelectMultipleButtonOnClick()
Scripting code executed when the user clicks the mouse on the select multiple button.


setSelectMultipleButtonOnClick

public void setSelectMultipleButtonOnClick(java.lang.String selectMultipleButtonOnClick)
Scripting code executed when the user clicks the mouse on the select multiple button.


getSortPanelFocusId

public java.lang.String getSortPanelFocusId()
The element id used to set focus when the sort panel is open.


setSortPanelFocusId

public void setSortPanelFocusId(java.lang.String sortPanelFocusId)
The element id used to set focus when the sort panel is open.


isSortPanelToggleButton

public boolean isSortPanelToggleButton()
Show the button that is used to open and close the sort panel.


setSortPanelToggleButton

public void setSortPanelToggleButton(boolean sortPanelToggleButton)
Show the button that is used to open and close the sort panel.


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.


getSummary

public java.lang.String getSummary()
Text that describes this table's purpose and structure, for user agents rendering to non-visual media such as speech and Braille.


setSummary

public void setSummary(java.lang.String summary)
Text that describes this table's purpose and structure, for user agents rendering to non-visual media such as speech and Braille.


getTabIndex

public int getTabIndex()
Position of this element in the tabbing order of the current document. Tabbing order determines the sequence in which elements receive focus when the tab key is pressed. The value must be an integer between 0 and 32767.


setTabIndex

public void setTabIndex(int tabIndex)
Position of this element in the tabbing order of the current document. Tabbing order determines the sequence in which elements receive focus when the tab key is pressed. The value must be an integer between 0 and 32767.


getTitle

public java.lang.String getTitle()
The text displayed for the table title.


setTitle

public void setTitle(java.lang.String title)
The text displayed for the table title.


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.


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 table. The width can be specified as the number of pixels or the percentage of the page 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 table. The width can be specified as the number of pixels or the percentage of the page 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.