Toolbar Filters Version 2.0.0.0Print this Page
Table Filters Pattern Set
 
Description Return to Top

A toolbar filter enables the user to filter the rows in a table. A table can have multiple toolbar filters.

Filters are labeled with the name of the attribute on which the filter is based. For example, a choice list that supports filtering based on status should be labeled Status, not Filter.

A filter is typically a choice list but may be another standard web widget. A toolbar filter may also be a set of standard web widgets that comprise a search field (see the Search and Query Usage guideline), including a prompt, conditions choice list, and value field.

In the majority of cases, a manual refresh toolbar button to the right of the filters is required and is always allowed. Clear or Reset filters commands are also recommended.

 
Pattern Set Decision Table Return to Top
  Toolbar Filters QBE
Must the filter attribute always correspond to a table column? No Yes
Must the filter always be visible? Yes No
Is the user typically an expert? No Yes
 
Pattern Samples Return to Top
Single Toolbar Filter

If only one filter is on a table's toolbar, place it on the primary toolbar after (to the right of) all menus and command buttons. If you use ADF Panel Collection, the Query by Example, Freeze Column, and Detach buttons will appear after a separator in the right-most postiion on the toolbar, if enabled.

Single Filter Without Manual Refresh

When the filter widget does not support manual data entry, the table updates as soon as the user selects a new value. No explicit refresh command is needed. Standard web widgets that do not require manual refresh include:

  • Check box
  • Single-select choice list
Single Filter without Manual Refresh
Figure 1. Single toolbar filter without manual refresh commands
Single Filter with Manual Refresh

When the filter widget does support manual data entry, a Search toolbar button (with a Search tool tip) must be placed after the filter widget and a redundant Refresh command is placed at the end of the View menu. Clicking the Search toolbar button, pressing the Enter key when the filter widget has the focus, or selecting View, Refresh runs the query. Components that require manual Search buttons include:

  • Text box
  • Spin box
  • Date picker
  • LOV
Single Filter with Manual Refresh
Figure 2. Single toolbar filter with manual refresh commands
Do not use the following components for toolbar filters:
  • Links (reserved for Column Groups)
  • Radio buttons
  • Any multiline control, such as a list box or text area

Search Field Filter

A toolbar filter may be a set of standard web widgets that comprise a search field (see the Search and Query Usage guideline) , including a prompt, conditions choice list, and value field. When a search field filter appears on a table toolbar, it must be the only filter on the toolbar.

Search Field Filter
Figure 3. Search field toolbar filter, including search condition choice list and value fields
Required Screen Elements
Component Type Required Components Customizable or Extendable Components
Table Toolbar Filter widgets The filter widget can be any single-line standard web widget except links or radio buttons.
Table Toolbar Search button The Search button is not required if the table refreshes automatically on the selected filter value and QBE is disabled.
View Menu Refresh command The Refresh command is not required if the table refreshes automatically on the selected filter value and QBE is disabled.
Table Toolbar Clear button Recommended when controls that support data entry are used.
Table Toolbar View, Clear Filters menu item Recommended when controls that support data entry are used.

Multiple Toolbar Filters

Removing Filter Criteria

A Reset (to default) or Clear (filters) button is recommended whenever a toolbar filter comprises multiple fields or widgets. That is, whenever there is more than one toolbar filter or a search field filter is used, include Reset or Clear controls. When these buttons are used, place a Reset Filters or Clear Filters command in the View menu.

Clear (filters) removes all filter criteria from the toolbar filters and QBE bar, if enabled. Note that the Clear button on the QBE bar does not affect toolbar filters. Reset (flters) resets filter criteria to the default filter criteria that are applied on page load.

Multiple Filters on a Single Toolbar

When there is more than one toolbar filter, the user selects values for any or all filters and then clicks the Search button to run the query. A Search button for manual refresh is needed whether the filters are dependent or not.

Multiple filters on the primary toolbar
Figure 4. Multiple toolbar filters on the primary toolbar

Multiple Filters on a Secondary Toolbar

The user selects values for any or all filters and then clicks the Search button or selects the View, Refresh command to filter the rows.

Multiple filters on a secondary toolbar
Figure 5. Multiple toolbar filters on a secondary toolbar
Required Screen Elements
Component Type Required Components Customizable or Extendable Components
Table Toolbar Filter widget The filter widget can be any standard web widget
Table Toolbar Search button NA
Table Toolbar Clear button Use a Refresh button instead of Clear if there are default filter criteria.
View Menu Refresh command NA
View Menu Clear Filters command Use a Refresh Filters command instead of Clear if there are default filter criteria.

Toolbar Filters and QBE

When a toolbar filter is applied to a table column, QBE should be disabled for that column. See the QBE Table Filter design pattern, the Table Elements Usage guideline for more details about QBE usage, appearance, and behavior.

Toolbar Filters and QBE
Figure 6. Disable QBE for columns where a toolbar filter is applied

Toolbar Filters and Search

When both toolbar filters and a search region are in a single table, criteria defined by toolbar filters are ANDed with the search criteria. For example, a search criterion of Supplier="Oracle" plus the toolbar filter Status="On Time" yields the query Supplier="Oracle" AND Status="On Time".

Toolbar filters should interact with a search region the same way that QBE filters native to ADF Table do (see the QBE design pattern). That is:

  • Editing search fields does not affect any toolbar filters.
  • Editing toolbar filters does not affect any search fields.
  • Saving the search saves all search criteria whether entered in search fields or toolbar filters.
  • Selecting a saved search will populate search fields and toolbar filters as they appeared when the search was saved.
Toolbar Filter with Search Region
Figure 7. Toolbar filters on a search results table
 
Related Patterns Return to Top
Transactional Search Pattern set used to select a user interface (UI) for search limited to one business object
Saved Searches Pattern set used to select different saved searches by using the View menu, tab equivalents, or a choice list.
 
Related Guidelines Return to Top
Search and Query Usage guideline Usage and behavior of ADF Query and Quick Query
Table Usage guidelines: Table Elements Detailed descriptions of the elements that can be used in each region of a table
 
About Oracle | Legal Notices | Terms of Use | Your Privacy Rights