A standard input control for filtering a specified select or table control. You can only use this control in a Form control.

Select Filtering

The following select controls are filterable:

• Autocomplete Text Input
• Combobox
• Extended Select-Many Listbox
• Extended Select-One Listbox
• Swapbox

Because the Combobox and the Auto-complete Text Input controls enable users to type in an auto-completed value, you should not use these controls with a Filter Input control. However, you could use an IFilterableSelectItemGroupProvider provider with these controls.

If a select control has a single Option Group bound to a provider that implements com.webmethods.caf.faces.data.IFilterableSelectItemGroupProvider, and the provider's isFilterable() method returns a value of true, then the filtering is done on the server, by the provider, using the provider's filter property value to filter the collection of items returned by its getSelectItemContentProviders() method.

The default ISelectItemGroupProvider, which is com.webmethods.caf.faces.data.object.DefaultSelectItemContentProvider, implements IFilterableSelectItemGroupProvider, but by default returns a value of false for the isFilterable()method.

If a select control is not bound to a provider that implements IFilterableSelectItemGroupProvider, the filtering is done on the client, using the standard common search keyword rules such as * = wildcard, space = and, quotes = exact phrase.

Table Filtering

If a table control is bound to com.webmethods.caf.faces.data.IFilterableTableContentProvider, and the provider's isFilterable() method returns a value of true, the filtering is done on the server, by the provider, using the provider's filter property value to filter the rows over which the provider can iterate.

With the default IFilterableTableContentProvider implementations (com.webmethods.caf.faces.data.object.FilterableListTableContentProvider and com.webmethods.caf.faces.data.object.FilterableSelectableListTableContentProvider), you must initialize the provider with a binding expression to use to calculate the value to filter on for each row. For example, you might use a filter value binding of #{row.title} #{row.description} to filter on the title and description fields of each row.

If a table control is not bound to an IFilterableTableContentProvider that is filterable, then filtering is done on the client, over the entire textual content of the row, using the standard common search keyword rules such as * = wildcard, space = and, quotes = exact phrase.

Select and Table Filtering

You can set the default filter for a table or select control by means of the select control's filter property value.

Children

javax.faces.SelectItem (JSF Option control) and javax.faces.SelectItems (JSF Option Group control).