|Toolbar Filters||Version 220.127.116.11|
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|
|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|
|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:
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:
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.
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 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.
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 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:
|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.|
|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|