|
||||||||||
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.TableRowGroupBase
public abstract class TableRowGroupBase
Base class for table row group components.
Field Summary |
---|
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
TableRowGroupBase()
|
Method Summary | |
---|---|
void |
addSort(com.sun.data.provider.SortCriteria criteria)
Add a SortCriteria object to sort. |
void |
broadcast(javax.faces.event.FacesEvent event)
Override the default UIComponentBase.broadcast() processing to unwrap any wrapped FacesEvent and reset the current RowKey, before the event is actually broadcast. |
void |
clear()
Clear cached properties. |
void |
clearFilter()
Clear FilterCriteria objects from the TableDataFilter instance used by this component. |
void |
clearSort()
Clear SortCriteria objects from the TableDataSorter instance used by this component. |
void |
encodeBegin(javax.faces.context.FacesContext context)
In addition to the default behavior, ensure that any saved per-row state for our child input components is discarded unless it is needed to rerender the current page with errors. |
java.lang.String |
getAlign()
Use the align attribute to specify the horizontal alignment for
the content of each cell in the row. |
java.lang.String |
getBgColor()
The deprecated BGCOLOR attribute suggests a background color for the row. |
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. |
java.lang.String |
getClientId(javax.faces.context.FacesContext context)
Return a client identifier for this component that includes the current value of the RowKey property, if it is not set to null. |
java.lang.String |
getEmptyDataMsg()
The text to be displayed when the table does not contain data. |
com.sun.data.provider.FieldKey |
getFieldKey(java.lang.String fieldId)
Get the FieldKey from the underlying TableDataProvider. |
com.sun.data.provider.RowKey[] |
getFilteredRowKeys()
Get an array containing filtered RowKey objects. |
int |
getFirst()
Get the zero-relative row number of the first row to be displayed for a paginated table. |
java.lang.String |
getHeaderText()
The text to be displayed in the group header. |
com.sun.data.provider.RowKey[] |
getHiddenRowKeys()
Get an array of hidden RowKey objects from the underlying TableDataProvider taking filtering, sorting, and pagination into account. |
com.sun.data.provider.RowKey[] |
getHiddenSelectedRowKeys()
Get an array of RowKey objects from the underlying data provider where the selected property of this component is set to true and the row is currently hidden from view. |
int |
getHiddenSelectedRowsCount()
Get the number of objects from the underlying data provider where the selected property of this component is set to true and the row is currently hidden from view. |
int |
getLast()
Get the zero-relative row number of the last page to be displayed. |
java.lang.String |
getOnClick()
Scripting code executed when a mouse click occurs over this component. |
java.lang.String |
getOnDblClick()
Scripting code executed when a mouse double click occurs over this component. |
java.lang.String |
getOnKeyDown()
Scripting code executed when the user presses down on a key while the component has focus. |
java.lang.String |
getOnKeyPress()
Scripting code executed when the user presses and releases a key while the component has focus. |
java.lang.String |
getOnKeyUp()
Scripting code executed when the user releases a key while the component has focus. |
java.lang.String |
getOnMouseDown()
Scripting code executed when the user presses a mouse button while the mouse pointer is on the component. |
java.lang.String |
getOnMouseMove()
Scripting code executed when the user moves the mouse pointer while over the component. |
java.lang.String |
getOnMouseOut()
Scripting code executed when a mouse out movement occurs over this component. |
java.lang.String |
getOnMouseOver()
Scripting code executed when the user moves the mouse pointer into the boundary of this component. |
java.lang.String |
getOnMouseUp()
Scripting code executed when the user releases a mouse button while the mouse pointer is on the component. |
int |
getPage()
Get current page number to be displayed. |
int |
getPages()
Get total number of pages to be displayed. |
com.sun.data.provider.RowKey[] |
getRenderedRowKeys()
Get an array of rendered RowKey objects from the underlying TableDataProvider taking filtering, sorting, and pagination into account. |
com.sun.data.provider.RowKey[] |
getRenderedSelectedRowKeys()
Get an array of RowKey objects from the underlying data provider where the selected property of this component is set to true and the row is rendered. |
int |
getRenderedSelectedRowsCount()
Get the number of objects from the underlying data provider where the selected property of this component is set to true and the row is rendered. |
int |
getRowCount()
Get the number of rows in the underlying TableDataProvider. |
com.sun.data.provider.RowKey |
getRowKey()
Get the RowKey associated with the current row. |
com.sun.data.provider.RowKey[] |
getRowKeys()
Get all RowKey objects for the underlying TableDataProvider. |
int |
getRows()
Get the number of rows to be displayed for a paginated table. |
com.sun.data.provider.RowKey[] |
getSelectedRowKeys()
Get an array of RowKey objects from the underlying data provider where the selected property of this component is set to true. |
int |
getSelectedRowsCount()
Get the number of selected rows from the underlying data provider where the selected property of this component is set to true. |
int |
getSortCount()
Get the number of SortCriteria objects to sort. |
com.sun.data.provider.RowKey[] |
getSortedRowKeys()
Get an array containing sorted RowKey objects. |
int |
getSortLevel(com.sun.data.provider.SortCriteria criteria)
Get the level of the given SortCriteria object to sort. |
java.lang.Object |
getSourceData()
The sourceData attribute is used to specify the data source to
populate the table. |
java.lang.String |
getSourceVar()
Use the sourceVar attribute to specify the name of the
request-scope attribute under which model data for the current row will be
exposed when iterating. |
java.lang.String |
getStyleClasses()
Use the styleClasses attribute to specify a list of CSS style
classes to apply to the rows of the group. |
java.util.Iterator |
getTableColumnChildren()
Get an Iterator over the TableColumnBase children found for this component. |
com.sun.data.provider.TableDataFilter |
getTableDataFilter()
Get the TableDataFilter object used to filter rows. |
com.sun.data.provider.TableDataSorter |
getTableDataSorter()
Get the TableDataSorter object used to sort rows. |
java.lang.String |
getToolTip()
Sets the value of the title attribute for the HTML element. |
java.lang.Class |
getType(com.sun.data.provider.FieldKey fieldKey)
Get the data type of the data element referenced by the given FieldKey. |
java.lang.String |
getValign()
Use the valign attribute to specify the vertical alignment for the
content of each cell in the column. |
boolean |
invokeOnComponent(javax.faces.context.FacesContext context,
java.lang.String clientId,
javax.faces.component.ContextCallback callback)
Override behavior from UIComponentBase to provide special care for positioning the data properly before finding the component and invoking the callback on it. |
boolean |
isCollapsed()
Use the collapsed attribute to initially render the group as collapsed, so that the data rows are hidden and only the header row is visible. |
boolean |
isDescendingSort(com.sun.data.provider.SortCriteria criteria)
Test if given SortCriteria object is a descending sort. |
boolean |
isGroupToggleButton()
Use the groupToggleButton attribute to display a button in the
group header to allow users to collapse and expand the group of rows. |
boolean |
isRowAvailable()
Get the flag indicating whether there is row data available for the current RowKey. |
boolean |
isSelected()
Flag indicating that the current row is selected. |
boolean |
isSelectMultipleToggleButton()
Use the selectMultipleToggleButton attribute to display a button
in the group header to allow users to select all rows of the group at once. |
boolean |
isVisible()
Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. |
void |
processDecodes(javax.faces.context.FacesContext context)
Override the default UIComponentBase.processDecodes() processing to perform the following steps. |
void |
processUpdates(javax.faces.context.FacesContext context)
Override the default UIComponentBase.processUpdates() processing to perform the following steps. |
void |
processValidators(javax.faces.context.FacesContext context)
Override the default UIComponentBase.processValidators() processing to perform the following steps. |
void |
queueEvent(javax.faces.event.FacesEvent event)
Override the default UIComponentBase.queueEvent() processing to wrap any queued events in a wrapper so that we can reset the current RowKey in broadcast(). |
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)
Use the align attribute to specify the horizontal alignment for
the content of each cell in the row. |
void |
setBgColor(java.lang.String bgColor)
The deprecated BGCOLOR attribute suggests a background color for the row. |
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 |
setCollapsed(boolean collapsed)
Use the collapsed attribute to initially render the group as collapsed, so that the data rows are hidden and only the header row is visible. |
void |
setEmptyDataMsg(java.lang.String emptyDataMsg)
The text to be displayed when the table does not contain data. |
void |
setFilterCriteria(com.sun.data.provider.FilterCriteria[] filterCriteria)
Set FilterCriteria objects for the TableDataFilter instance used by this component. |
void |
setFirst(int first)
Set the zero-relative row number of the first row to be displayed for a paginated table. |
void |
setGroupToggleButton(boolean groupToggleButton)
Use the groupToggleButton attribute to display a button in the
group header to allow users to collapse and expand the group of rows. |
void |
setHeaderText(java.lang.String headerText)
The text to be displayed in the group header. |
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 |
setPage(int page)
A convenience method to set the current page to be displayed. |
void |
setRowKey(com.sun.data.provider.RowKey rowKey)
Set the RowKey associated with the current row or null for no current row association. |
void |
setRows(int rows)
Set the number of rows to be displayed for a paginated table. |
void |
setSelected(boolean selected)
Flag indicating that the current row is selected. |
void |
setSelectMultipleToggleButton(boolean selectMultipleToggleButton)
Use the selectMultipleToggleButton attribute to display a button
in the group header to allow users to select all rows of the group at once. |
void |
setSortCriteria(com.sun.data.provider.SortCriteria[] sortCriteria)
Set SortCriteria objects for the TableDataSorter instance used by this component. |
void |
setSourceData(java.lang.Object sourceData)
Set the source data of the TableRowGroupBase. |
void |
setSourceVar(java.lang.String sourceVar)
Use the sourceVar attribute to specify the name of the
request-scope attribute under which model data for the current row will be
exposed when iterating. |
void |
setStyleClasses(java.lang.String styleClasses)
Use the styleClasses attribute to specify a list of CSS style
classes to apply to the rows of the group. |
void |
setTableDataFilter(com.sun.data.provider.TableDataFilter filter)
Set the TableDataFilter object used to filter rows. |
void |
setTableDataSorter(com.sun.data.provider.TableDataSorter sorter)
Set the TableDataSorter object used to sort rows. |
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 |
setValueExpression(java.lang.String name,
javax.el.ValueExpression valueExpression)
Set the ValueExpression used to calculate the value for the specified attribute or property name, if any. |
void |
setVisible(boolean visible)
Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. |
Methods inherited from class com.sun.webui.jsf.component.WebuiComponent |
---|
setId, setRendered |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRendererType, getRendersChildren, getValueBinding, getValueExpression, isRendered, isTransient, processRestoreState, processSaveState, restoreAttachedState, saveAttachedState, setParent, setRendererType, setTransient, setValueBinding |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getContainerClientId, getFamily |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TableRowGroupBase()
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). This cannot always be done via encodeBegin because the component's parent may need to obtain updated properties before this component is rendered.
public java.util.Iterator getTableColumnChildren()
public void clearFilter()
Note: This method clears the cached filter and sort, then resets pagination to the first page per UI guidelines.
public com.sun.data.provider.RowKey[] getFilteredRowKeys()
Note: This filter depends on the FilterCriteria objects provided to the TableDataFilter instance used by this component. Due to filtering, the size of the returned array may be less than the total number of RowKey objects for the underlying TableDataProvider.
Note: The returned RowKey objects are cached. If the TableDataFilter instance used by this component is modified directly, invoke the clearFilter method to clear the previous filter.
public com.sun.data.provider.TableDataFilter getTableDataFilter()
public void setFilterCriteria(com.sun.data.provider.FilterCriteria[] filterCriteria)
Note: This method clears the cached filter and sort, then resets pagination to the first page per UI guidelines.
filterCriteria
- An array of FilterCriteria objects defining the
filter order on this TableDataFilter.public void setTableDataFilter(com.sun.data.provider.TableDataFilter filter)
filter
- The TableDataFilter object used to filter rows.public int getFirst()
Note: If rows have been removed from the underlying DataProvider, there is a chance that the first row could be greater than the total number of rows. In this case, the zero-relative row number of the last page to be displayed is returned.
public void setFirst(int first)
Note: This method is used to set the current, first, next, prev, and last pages. For example, you could use setFirst(0) to display the first page and setFirst(getLast()) to display the last page. This method is particularly useful when a subset of data is displayed in scroll mode or when overriding pagination. As a convenience, the setPage(int) method is provided.
Note: When ever a new DataProvider is used, UI Guidelines recommend that pagination should be reset (e.g., remaining on the 4th page of a new set of data makes no sense).
Warning: When the end user is navigating the web application, use the saveState and restoreState() methods to maintain state. There is much more to state than just the first row (e.g., sorting, filtering, etc.).
first
- The first row number.
java.lang.IllegalArgumentException
- for negative values.public int getLast()
public int getPage()
Note: The default is 1 when the table is not paginated.
public int getPages()
Note: The page count depends on the FilterCriteria objects provided to the TableDataFilter instance used by this component. Further, the filter used to obtain the page count is cached. If the TableDataFilter instance used by this component is to be modified directly, invoke the clearFilter method to clear the previous filter.
public void setPage(int page)
Note: You can also set the current, first, next, prev, and last pages by invoking the setFirst(int) method directly. For example, you could use setFirst(0) to display the first page and setFirst(getLast()) to display the last page. The setFirst(int) method is particularly useful when a subset of data is displayed in scroll mode or when overriding pagination.
Note: When ever a new DataProvider is used, UI Guiedlines recommend that pagination should be reset (e.g., remaining on the 4th page of a new set of data makes no sense).
page
- The current page.public int getRows()
Note: UI guidelines recommend a default value of 25 rows per page.
public void setRows(int rows)
rows
- The number of rows to be displayed for a paginated table.
java.lang.IllegalArgumentException
- for negative values.public boolean isRowAvailable()
public com.sun.data.provider.RowKey[] getHiddenRowKeys()
Note: The returned RowKey objects depend on the FilterCriteria and SortCriteria objects provided to the TableDataFilter and TableDataSorter instances used by this component. If TableDataFilter and TableDataSorter are modified directly, invoke the clearSort and clearFilter method to clear the previous sort and filter.
public com.sun.data.provider.FieldKey getFieldKey(java.lang.String fieldId)
WARNING for ObjectArrayDataProvider: Until you call setArray() or setObjectType with a non-null parameter, or use a constructor variant that accepts an non-null array, no information about field keys will be available. Therefore, any attempt to reference a FieldKey or field identifier in a method call will throw IllegalArgumentException.
WARNING for ObjectListDataProvider: Until you call setList() or setObjectType with a non-null parameter, or use a constructor variant that accepts an non-null non-empty list, no information about field keys will be available. Therefore, any attempt to reference a FieldKey or field identifier in a method call will throw IllegalArgumentException.
fieldId
- The id of the requested FieldKey.
IllegalArgumentExeption
- If object type is not set for
ObjectArrayDataProvider or ObjectListDataProvider.public int getRowCount()
Note: This row count depends on the FilterCriteria objects provided to the TableDataFilter instance used by this component. Further, the filter used to obtain the row count is cached. If the TableDataFilter instance used by this component is modified directly, invoke the clearFilter method to clear the previous filter.
public com.sun.data.provider.RowKey getRowKey()
public com.sun.data.provider.RowKey[] getRowKeys()
public java.lang.Class getType(com.sun.data.provider.FieldKey fieldKey)
fieldKey
- The FieldKey identifying the data element whose type is
to be returned.
public com.sun.data.provider.RowKey[] getRenderedRowKeys()
Note: The returned RowKey objects depend on the FilterCriteria and SortCriteria objects provided to the TableDataFilter and TableDataSorter instances used by this component. If TableDataFilter and TableDataSorter are modified directly, invoke the clearSort and clearFilter method to clear the previous sort and filter.
public void setRowKey(com.sun.data.provider.RowKey rowKey)
Note: It is possible to set the RowKey at a value for which the underlying TableDataProvider does not contain any row data. Therefore, callers may use the isRowAvailable() method to detect whether row data will be available.
To save current state information for all descendant components, TableRowGroupBase must maintain per-row information for each descendant as follows:
To restore current state information for all descendant components, TableRowGroupBase must reference its previously stored information for the current RowKey and call setters for each descendant as follows:
rowKey
- The RowKey associated with the current row or
null for no association.public void setSourceData(java.lang.Object sourceData)
Note: When ever the underlying DataProvider has changed, UI Guiedlines recommend that pagination should be reset (e.g., remaining on the 4th page of a new set of data makes no sense). However, properties such as the sort and filter criteria should not automatically be cleared (e.g., there may be situations where one or both should be left as specified by the user). In this scenario, pagination is set to the first page.
sourceData
- The source data of the TableRowGroupBase.public int getHiddenSelectedRowsCount()
Note: UI guidelines recomend that rows should be unselected when no longer in view. For example, when a user selects rows of the table and navigates to another page. Or, when a user applies a filter or sort that may hide previously selected rows from view. If a user invokes an action to delete the currently selected rows, they may inadvertently remove rows not displayed on the current page. That said, there are cases when maintaining state across table pages is necessary. When maintaining state and there are currently no hidden selections, UI guidelines recomend that the number zero should be shown.
Note: This count depends on the FilterCriteria and SortCriteria objects provided to the TableDataFilter and TableDataSorter instances used by this component. If TableDataFilter and TableFilterSorter are modified directly, invoke the clearFilter method to clear the previous filter and sort.
public com.sun.data.provider.RowKey[] getHiddenSelectedRowKeys()
Note: UI guidelines recomend that rows should be unselected when no longer in view. For example, when a user selects rows of the table and navigates to another page. Or, when a user applies a filter or sort that may hide previously selected rows from view. If a user invokes an action to delete the currently selected rows, they may inadvertently remove rows not displayed on the current page.
Note: The returned RowKey objects depend on the FilterCriteria and SortCriteria objects provided to the TableDataFilter and TableDataSorter instances used by this component. If TableDataFilter and TableDataSorter are modified directly, invoke the clearSort and clearFilter method to clear the previous sort and filter.
public int getSelectedRowsCount()
Note: This count depends on the FilterCriteria objects provided to the TableDataFilter instance used by this component. If TableDataFilter is modified directly, invoke the clearFilter method to clear the previous filter.
public com.sun.data.provider.RowKey[] getSelectedRowKeys()
Note: The returned RowKey objects depend on the FilterCriteria objects provided to the TableDataFilter instance used by this component. If TableDataFilter is modified directly, invoke the clearFilter method to clear the previous filter.
public int getRenderedSelectedRowsCount()
Note: UI guidelines recomend that rows should be unselected when no longer in view. For example, when a user selects rows of the table and navigates to another page. Or, when a user applies a filter or sort that may hide previously selected rows from view. If a user invokes an action to delete the currently selected rows, they may inadvertently remove rows not displayed on the current page.
Note: This count depends on the FilterCriteria and SortCriteria objects provided to the TableDataFilter and TableDataSorter instances used by this component. If TableDataFilter and TableFilterSorter are modified directly, invoke the clearFilter method to clear the previous filter and sort.
public com.sun.data.provider.RowKey[] getRenderedSelectedRowKeys()
Note: UI guidelines recomend that rows should be unselected when no longer in view. For example, when a user selects rows of the table and navigates to another page. Or, when a user applies a filter or sort that may hide previously selected rows from view. If a user invokes an action to delete the currently selected rows, they may inadvertently remove rows not displayed on the current page.
Note: The returned RowKey objects depend on the FilterCriteria and SortCriteria objects provided to the TableDataFilter and TableDataSorter instances used by this component. If TableDataFilter and TableDataSorter are modified directly, invoke the clearSort and clearFilter method to clear the previous sort and filter.
public void addSort(com.sun.data.provider.SortCriteria criteria)
Note: Objects are sorted in the reverse order they were added. For example, the first object added, will be the last sort applied as the primary sort. The second object added, will be the second to last sort applied as the secondary sort. The third object added, will be the third to last sort applied as the tertiary sort and so on. If an existing SortCriteria object is found with the same FieldKey, the sort order is replaced with the new value. Note that sorts are not actually applied until the getSortedRowKeys() method is invoked, which happens automatically by the renderer.
Note: This method also resets pagination to the first page per UI guidelines (primary sorts only).
criteria
- The SortCriteria object to sort.public void clearSort()
Note: This method clears the cached sort, then resets pagination to the first page per UI guidelines.
public int getSortCount()
public int getSortLevel(com.sun.data.provider.SortCriteria criteria)
Note: The primary sort is level 1, the secondary sort is level 2, the tertiary sort is level 3, and so on. If the SortCriteria object was not previously added using the addSort method, the level will be returned as -1.
criteria
- The SortCriteria object to sort.
public boolean isDescendingSort(com.sun.data.provider.SortCriteria criteria)
criteria
- The SortCriteria object to sort.
public com.sun.data.provider.RowKey[] getSortedRowKeys()
Note: This sort depends on the SortCriteria objects provided to the TableDataSorter instance used by this component. For better performance, this sort also depends on the FilterCriteria objects provided to the TableDataFilter instance used by this component. Due to filtering, the size of the returned array may be less than the total number of RowKey objects for the underlying TableDataProvider.
Note: The returned RowKey objects are cached. If the TableDataSorter and TableDataFilter instances used by this component are modified directly, invoke the clearSort and clearFilter methods to clear the previous sort and filter.
public com.sun.data.provider.TableDataSorter getTableDataSorter()
public void setTableDataSorter(com.sun.data.provider.TableDataSorter sorter)
sorter
- The TableDataSorter object used to sort rows.public void setSortCriteria(com.sun.data.provider.SortCriteria[] sortCriteria)
Note: This method clears the cached sort, then resets pagination to the first page per UI guidelines.
sortCriteria
- An array of SortCriteria objects defining the sort
order on this TableDataSorter.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
public boolean invokeOnComponent(javax.faces.context.FacesContext context, java.lang.String clientId, javax.faces.component.ContextCallback callback) throws javax.faces.FacesException
clientId
is equal to
this.getClientId()
simply invoke the contextCallback
, passing the context
argument and this as
arguments, and return true.
Otherwise, attempt to extract a
rowId from the clientId
. For example, if the argument
clientId
was form:data:3:customerHeader
the rowId
would be 3
. Let this value be called newRowId
.
The current rowId of this instance must be saved aside and restored
before returning in all cases, regardless of the outcome of the search
or if any exceptions are thrown in the process.
The implementation of this method must never return
true
if setting the rowId of this instance to be
equal to newRowId
causes this instance to return
false
from the isRowAvailable method.
invokeOnComponent
in class javax.faces.component.UIComponentBase
java.lang.NullPointerException
javax.faces.FacesException
- Also throws
FacesException
if any exception is thrown when deriving
the rowd from the argument clientId
.public void setValueExpression(java.lang.String name, javax.el.ValueExpression valueExpression)
Note: When ever the underlying DataProvider has changed, UI Guiedlines recommend that pagination should be reset (e.g., remaining on the 4th page of a new set of data makes no sense). However, properties such as the sort and filter criteria should not automatically be cleared (e.g., there may be situations where one or both should be left as specified by the user). In this scenario, pagination is set to the first page.
setValueExpression
in class javax.faces.component.UIComponentBase
name
- Name of the attribute or property for which to set a
ValueExpression.valueExpression
- The ValueExpression to set, or null to remove any currently
set ValueExpression.
java.lang.IllegalArgumentException
- If name is one of sourceVar.
java.lang.NullPointerException
- If name is null.public java.lang.String getClientId(javax.faces.context.FacesContext context)
getClientId
in class javax.faces.component.UIComponentBase
java.lang.NullPointerException
- if FacesContext is null.public void queueEvent(javax.faces.event.FacesEvent event)
queueEvent
in class javax.faces.component.UIComponentBase
event
- FacesEvent to be queued.
java.lang.IllegalStateException
- If this component is not a descendant
of a UIViewRoot.
java.lang.NullPointerException
- If FacesEvent is null.public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
broadcast
in class javax.faces.component.UIComponentBase
event
- The FacesEvent to be broadcast.
javax.faces.event.AbortProcessingException
- Signal the JavaServer Faces
implementation that no further processing on the current event
should be performed.
java.lang.IllegalArgumentException
- if the implementation class
of this FacesEvent is not supported by this component.
java.lang.NullPointerException
- if FacesEvent is null.public void encodeBegin(javax.faces.context.FacesContext context) throws java.io.IOException
encodeBegin
in class javax.faces.component.UIComponentBase
context
- FacesContext for the current request.
java.io.IOException
- if an input/output error occurs while rendering.
java.lang.NullPointerException
- if FacesContext is null.public void processDecodes(javax.faces.context.FacesContext context)
processDecodes
in class WebuiComponent
context
- FacesContext for the current request.
java.lang.NullPointerException
- if FacesContext is null.public void processValidators(javax.faces.context.FacesContext context)
processValidators
in class WebuiComponent
context
- FacesContext for the current request.
java.lang.NullPointerException
- if FacesContext is null.public void processUpdates(javax.faces.context.FacesContext context)
processUpdates
in class WebuiComponent
context
- FacesContext for the current request.
java.lang.NullPointerException
- if FacesContext is null.public java.lang.String getAlign()
align
attribute to specify the horizontal alignment for
the content of each cell in the row. 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=":"
public void setAlign(java.lang.String align)
align
attribute to specify the horizontal alignment for
the content of each cell in the row. 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=":"
public java.lang.String getBgColor()
public void setBgColor(java.lang.String bgColor)
public java.lang.String getChar()
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.
public void setChar(java.lang.String _char)
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.
public java.lang.String getCharOff()
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.
public void setCharOff(java.lang.String charOff)
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.
public boolean isCollapsed()
public void setCollapsed(boolean collapsed)
public java.lang.String getEmptyDataMsg()
emptyDataMsg
text might be something similar to "No
items found." If users can add items to the table, the message might include
instructions, such as "This table contains no files. To add a file to monitor,
click the New button."
public void setEmptyDataMsg(java.lang.String emptyDataMsg)
emptyDataMsg
text might be something similar to "No
items found." If users can add items to the table, the message might include
instructions, such as "This table contains no files. To add a file to monitor,
click the New button."
public boolean isGroupToggleButton()
groupToggleButton
attribute to display a button in the
group header to allow users to collapse and expand the group of rows.
public void setGroupToggleButton(boolean groupToggleButton)
groupToggleButton
attribute to display a button in the
group header to allow users to collapse and expand the group of rows.
public java.lang.String getHeaderText()
public void setHeaderText(java.lang.String headerText)
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 isSelectMultipleToggleButton()
selectMultipleToggleButton
attribute to display a button
in the group header to allow users to select all rows of the group at once.
The button toggles a column of checkboxes using the id that is given to the
selectId
attribute of the webuijsf:tableColumn
and webuijsf:table2Column
tags.
public void setSelectMultipleToggleButton(boolean selectMultipleToggleButton)
selectMultipleToggleButton
attribute to display a button
in the group header to allow users to select all rows of the group at once.
The button toggles a column of checkboxes using the id that is given to the
selectId
attribute of the webuijsf:tableColumn
and webuijsf:table2Column
tags.
public boolean isSelected()
public void setSelected(boolean selected)
public java.lang.Object getSourceData()
sourceData
attribute is used to specify the data source to
populate the table. The value of the sourceData
attribute may be
a JavaServer Faces EL expression that resolves to a backing bean of type
com.sun.data.provider.TableDataProvider
.
public java.lang.String getSourceVar()
sourceVar
attribute to specify the name of the
request-scope attribute under which model data for the current row will be
exposed when iterating. During iterative processing over the rows of data in
the data provider, the TableDataProvider for the current row is exposed as a
request attribute under the key specified by this property. Note: This
value must be unique for each table in the JSP page.
public void setSourceVar(java.lang.String sourceVar)
sourceVar
attribute to specify the name of the
request-scope attribute under which model data for the current row will be
exposed when iterating. During iterative processing over the rows of data in
the data provider, the TableDataProvider for the current row is exposed as a
request attribute under the key specified by this property. Note: This
value must be unique for each table in the JSP page.
public java.lang.String getStyleClasses()
styleClasses
attribute to specify a list of CSS style
classes to apply to the rows of the group. You can apply all the styles in the
list to each row by separating the class names with commas. Each row looks the
same when commas are used to delimit the styles. You can apply alternating
styles to individual rows by separating the style class names with spaces. You
can create a pattern of shading alternate rows, for example, to improve
readability of the table. For example, if the list has two elements, the first
style class in the list is applied to the first row, the second class to the
second row, the first class to the third row, the second class to the fourth
row, etc. The tableRowGroup component iterates through the list of styles and
repeats from the beginning until a style is applied to each row.
public void setStyleClasses(java.lang.String styleClasses)
styleClasses
attribute to specify a list of CSS style
classes to apply to the rows of the group. You can apply all the styles in the
list to each row by separating the class names with commas. Each row looks the
same when commas are used to delimit the styles. You can apply alternating
styles to individual rows by separating the style class names with spaces. You
can create a pattern of shading alternate rows, for example, to improve
readability of the table. For example, if the list has two elements, the first
style class in the list is applied to the first row, the second class to the
second row, the first class to the third row, the second class to the fourth
row, etc. The tableRowGroup component iterates through the list of styles and
repeats from the beginning until a style is applied to each row.
public java.lang.String getToolTip()
public void setToolTip(java.lang.String toolTip)
public java.lang.String getValign()
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.
public void setValign(java.lang.String valign)
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.
public boolean isVisible()
public void setVisible(boolean visible)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |