Java Doc for TableRowGroup.java in  » IDE-Netbeans » visualweb.api.designer » com » sun » rave » web » ui » component » Java Source Code / Java DocumentationJava Source Code and Java Documentation

The TableRowGroup component provides a layout mechanism for displaying rows of data. UI guidelines describe specific behavior that can applied to the rows and columns of data such as sorting, filtering, pagination, selection, and custom user actions. In addition, UI guidelines also define sections of the table that can be used for titles, row group headers, and placement of pre-defined and user defined actions.

The TableRowGroup component supports a data binding to a collection of data objects represented by a TableDataProvider instance, which is the current value of this component itself. 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 the var property.

Only children of type TableColumn should be processed by renderers associated with this component.

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

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

 java.util.logging.ConsoleHandler.level = FINE
 com.sun.rave.web.ui.component.TableRowGroup.level = FINE
 

See TLD docs for more information.

Note: Objects are sorted in the reverse order they were added.

Note: This filter depends on the FilterCriteria objects provided to the TableDataFilter instance used by this component.

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).

Note: If rows have been removed from the table, there is a chance that the first row could be greater than the total number of rows.

Note: The returned RowKey objects depend on the FilterCriteria and SortCriteria objects provided to the TableDataFilter and TableDataSorter instances used by this component.

Note: UI guidelines recomend that rows should be unselected when no longer in view.

Note: UI guidelines recomend that rows should be unselected when no longer in view.

Note: The returned RowKey objects depend on the FilterCriteria and SortCriteria objects provided to the TableDataFilter and TableDataSorter instances used by this component.

Note: UI guidelines recomend that rows should be unselected when no longer in view.

Note: UI guidelines recomend that rows should be unselected when no longer in view.

Note: The returned RowKey objects depend on the FilterCriteria objects provided to the TableDataFilter instance used by this component.

Note: This count depends on the FilterCriteria objects provided to the TableDataFilter instance used by this component.

Note: The primary sort is level 1, the secondary sort is level 2, the tertiary sort is level 3, and so on.

Note: This sort depends on the SortCriteria objects provided to the TableDataSorter instance used by this component.

• If the rendered property of this UIComponent is false, skip further processing.
• Set the current RowKey to null.
• Call the processDecodes() method of all facets of this TableRowGroup, in the order determined by a call to getFacets().keySet().iterator().
• Call the processDecodes() method of all facets of the TableColumn children of this TableRowGroup.
• Iterate over the set of rows that were included when this component was rendered (i.e.

• If the rendered property of this UIComponent is false, skip further processing.
• Set the current RowKey to null.
• Call the processUpdates() method of all facets of this TableRowGroup, in the order determined by a call to getFacets().keySet().iterator().
• Call the processUpdates() method of all facets of the TableColumn children of this TableRowGroup.
• Iterate over the set of rows that were included when this component was rendered (i.e.

• If the rendered property of this UIComponent is false, skip further processing.
• Set the current RowKey to null.
• Call the processValidators() method of all facets of this TableRowGroup, in the order determined by a call to getFacets().keySet().iterator().
• Call the processValidators() method of all facets of the TableColumn children of this TableRowGroup.
• Iterate over the set of rows that were included when this component was rendered (i.e.

Note: You can also set the current, first, next, prev, and last pages by invoking the setFirst(int) method directly.

Note: When pagination controls are used, a value of true allows both pagination controls and paginate buttons to be displayed.

Note: It is possible to set the RowKey at a value for which the underlying TableDataProvider does not contain any row data.

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).

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.

Note: This method clears the cached filter and sort, then resets pagination to the first page per UI guidelines.

Note: This method clears the cached sort, then resets pagination to the first page per UI guidelines.

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.

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).

Note: If rows have been removed from the table, 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.

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.

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.

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.

Note: The default is 1 when the table is not paginated.

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.

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.

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.

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.

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.

Note: UI guidelines recommend a default value of 25 rows per page.

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.

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.

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.

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.

Note: If the paginationControls property of the Table component is true, this property will be initialized as true.

• If the rendered property of this UIComponent is false, skip further processing.
• Set the current RowKey to null.
• Call the processDecodes() method of all facets of this TableRowGroup, in the order determined by a call to getFacets().keySet().iterator().
• Call the processDecodes() method of all facets of the TableColumn children of this TableRowGroup.
• Iterate over the set of rows that were included when this component was rendered (i.e. those defined by the first and rows properties), performing the following processing for each row:
• Set the current RowKey to the appropriate value for this row.
• If isRowAvailable() returns true, iterate over the children components of each TableColumn child of this TableRowGroup component, calling the processDecodes() method for each such child.
• Set the current RowKey to null.
• Call the decode() method of this component.
• If a RuntimeException is thrown during decode processing, call FacesContext.renderResponse() and re-throw the exception.

• If the rendered property of this UIComponent is false, skip further processing.
• Set the current RowKey to null.
• Call the processUpdates() method of all facets of this TableRowGroup, in the order determined by a call to getFacets().keySet().iterator().
• Call the processUpdates() method of all facets of the TableColumn children of this TableRowGroup.
• Iterate over the set of rows that were included when this component was rendered (i.e. those defined by the first and rows properties), performing the following processing for each row:
• Set the current RowKey to the appropriate value for this row.
• If isRowAvailable() returns true, iterate over the children components of each TableColumn child of this TableRowGroup component, calling the processUpdates() method for each such child.
• Set the current RowKey to null.

• If the rendered property of this UIComponent is false, skip further processing.
• Set the current RowKey to null.
• Call the processValidators() method of all facets of this TableRowGroup, in the order determined by a call to getFacets().keySet().iterator().
• Call the processValidators() method of all facets of the TableColumn children of this TableRowGroup.
• Iterate over the set of rows that were included when this component was rendered (i.e. those defined by the first and rows properties), performing the following processing for each row:
• Set the current RowKey to the appropriate value for this row.
• If isRowAvailable() returns true, iterate over the children components of each TableColumn child of this TableRowGroup component, calling the processValidators() method for each such child.
• Set the current RowKey to null.

Note: This method clears the cached filter and sort, then resets pagination to the first page per UI guidelines.

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).

Note: When pagination controls are used, a value of true allows both pagination controls and paginate buttons to be displayed. A value of false allows only paginate buttons to be displayed. However, when all data fits on one page, neither pagination controls or paginate buttons are displayed.

Note: To properly maintain the paginated state of the table per UI guidelines, the paginated property is cached. If the paginationControls property of the table component changes (e.g., in an application builder environment), use this method to set the paginated property accordingly.

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.

• Save current state information for all descendant components (as described below).
• Store the new RowKey, and pass it on to the TableDataProvider associated with this TableRowGroup instance.
• If the new RowKey value is null:
  • If the var property is not null, remove the corresponding request scope attribute (if any).
  • Reset the state information for all descendant components (as described below).
• If the new RowKey value is not null:
  • If the var property is not null, expose the data provider as a request scope attribute whose key is the var property value.
  • Reset the state information for all descendant components (as described below).

To save current state information for all descendant components, TableRowGroup must maintain per-row information for each descendant as follows:

• If the descendant is an instance of EditableValueHolder, save the state of its localValue property.
• If the descendant is an instance of EditableValueHolder, save the state of the localValueSet property.
• If the descendant is an instance of EditableValueHolder, save the state of the valid property.
• If the descendant is an instance of EditableValueHolder, save the state of the submittedValue property.

To restore current state information for all descendant components, TableRowGroup must reference its previously stored information for the current RowKey and call setters for each descendant as follows:

• If the descendant is an instance of EditableValueHolder, restore the value property.
• If the descendant is an instance of EditableValueHolder, restore the state of the localValueSet property.
• If the descendant is an instance of EditableValueHolder, restore the state of the valid property.
• If the descendant is an instance of EditableValueHolder, restore the state of the submittedValue property.

Note: This method clears the cached sort, then resets pagination to the first page per UI guidelines.

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). 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.