|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
com.sun.webui.jsf.component.WebuiComponent
com.sun.webui.jsf.component.TableBase
public abstract class TableBase
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 |
---|
public static final java.lang.String ACTIONS_TOP_FACET
Constructor Detail |
---|
public TableBase()
Method Detail |
---|
public void clear()
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).
public java.util.Iterator getTableRowGroupChildren()
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.
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.
public boolean isAugmentTitle()
itemsText
and filterText
are overridden.
public void setAugmentTitle(boolean augmentTitle)
itemsText
and filterText
are overridden.
public java.lang.String getBgColor()
public void setBgColor(java.lang.String bgColor)
public int getBorder()
public void setBorder(int border)
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"
.
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"
.
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"
.
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"
.
public boolean isClearSortButton()
public void setClearSortButton(boolean clearSortButton)
public boolean isDeselectMultipleButton()
webuijsf:tableColumn
and webuijsf:table2Column
tags.
public void setDeselectMultipleButton(boolean deselectMultipleButton)
webuijsf:tableColumn
and webuijsf:table2Column
tags.
public java.lang.String getDeselectMultipleButtonOnClick()
setTimeout()
function to
invoke the script to ensure that checkboxes are deselected immediately, instead
of waiting for the script to complete.
public void setDeselectMultipleButtonOnClick(java.lang.String deselectMultipleButtonOnClick)
setTimeout()
function to
invoke the script to ensure that checkboxes are deselected immediately, instead
of waiting for the script to complete.
public boolean isDeselectSingleButton()
webuijsf:tableColumn
and webuijsf:table2Column
tags.
public void setDeselectSingleButton(boolean deselectSingleButton)
webuijsf:tableColumn
and webuijsf:table2Column
tags.
public java.lang.String getDeselectSingleButtonOnClick()
setTimeout()
function to invoke the
script to ensure that the radio button is deselected immediately, instead of
waiting for the script to complete.
public void setDeselectSingleButtonOnClick(java.lang.String deselectSingleButtonOnClick)
setTimeout()
function to invoke the
script to ensure that the radio button is deselected immediately, instead of
waiting for the script to complete.
public java.lang.String getFilterId()
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.
public void setFilterId(java.lang.String filterId)
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.
public java.lang.String getFilterPanelFocusId()
public void setFilterPanelFocusId(java.lang.String filterPanelFocusId)
public java.lang.String getFilterText()
public void setFilterText(java.lang.String filterText)
public java.lang.String getFrame()
public void setFrame(java.lang.String frame)
public boolean isHiddenSelectedRows()
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.
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.
public java.lang.String getItemsText()
public void setItemsText(java.lang.String itemsText)
public boolean isLite()
public void setLite(boolean lite)
public java.lang.String getOnClick()
public void setOnClick(java.lang.String onClick)
public java.lang.String getOnDblClick()
public void setOnDblClick(java.lang.String onDblClick)
public java.lang.String getOnKeyDown()
public void setOnKeyDown(java.lang.String onKeyDown)
public java.lang.String getOnKeyPress()
public void setOnKeyPress(java.lang.String onKeyPress)
public java.lang.String getOnKeyUp()
public void setOnKeyUp(java.lang.String onKeyUp)
public java.lang.String getOnMouseDown()
public void setOnMouseDown(java.lang.String onMouseDown)
public java.lang.String getOnMouseMove()
public void setOnMouseMove(java.lang.String onMouseMove)
public java.lang.String getOnMouseOut()
public void setOnMouseOut(java.lang.String onMouseOut)
public java.lang.String getOnMouseOver()
public void setOnMouseOver(java.lang.String onMouseOver)
public java.lang.String getOnMouseUp()
public void setOnMouseUp(java.lang.String onMouseUp)
public boolean isPaginateButton()
public void setPaginateButton(boolean paginateButton)
public java.lang.String getPreferencesPanelFocusId()
public void setPreferencesPanelFocusId(java.lang.String preferencesPanelFocusId)
public java.lang.String getRules()
public void setRules(java.lang.String rules)
public boolean isSelectMultipleButton()
webuijsf:tableColumn
and webuijsf:table2Column
tags.
public void setSelectMultipleButton(boolean selectMultipleButton)
webuijsf:tableColumn
and webuijsf:table2Column
tags.
public java.lang.String getSelectMultipleButtonOnClick()
public void setSelectMultipleButtonOnClick(java.lang.String selectMultipleButtonOnClick)
public java.lang.String getSortPanelFocusId()
public void setSortPanelFocusId(java.lang.String sortPanelFocusId)
public boolean isSortPanelToggleButton()
public void setSortPanelToggleButton(boolean sortPanelToggleButton)
public java.lang.String getStyle()
public void setStyle(java.lang.String style)
public java.lang.String getStyleClass()
public void setStyleClass(java.lang.String styleClass)
public java.lang.String getSummary()
public void setSummary(java.lang.String summary)
public int getTabIndex()
public void setTabIndex(int tabIndex)
public java.lang.String getTitle()
public void setTitle(java.lang.String title)
public java.lang.String getToolTip()
public void setToolTip(java.lang.String toolTip)
public boolean isVisible()
public void setVisible(boolean visible)
public java.lang.String getWidth()
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.
public void setWidth(java.lang.String width)
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.
public void restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class javax.faces.component.UIComponentBase
public java.lang.Object saveState(javax.faces.context.FacesContext _context)
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.UIComponentBase
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |