A panel that provides the user with a search query builder.
Although this control can be used in any generic JSF application, it is typically used in the Search Bar portlet of a Search Bar/Search Results portlet pair. You can create an integrated Search Bar portlet with the New Portlet wizard, selecting the Search Bar Portlet option on the first
page of the wizard. The two portlets are connected by wiring; the lastSearchState
property of the Search Bar portlet is wired to the queryString
property of the Search Results portlet.
Info | Value |
---|---|
Component Type | com.webmethods.caf.faces.search.SearchBar |
Handler Class | com.webmethods.caf.faces.component.search.SearchBarHandler |
Renderer Type | com.webmethods.caf.faces.search.SearchBar |
Description | Search Query Builder |
Palette Location | CAF Html/Control/Search/Search Bar |
Client-Side Model | CAF.Output.Model |
Name | Description |
---|---|
refinePanel | Panel for the search refine fields (if any) |
Name | Required | Type | Description |
---|---|---|---|
advancedSearchAvailable | false | javax.el.ValueExpression
(must evaluate to boolean )
|
If true, the 'Advanced' tab is visible to the end user
If not specified, the default value is "true". |
asyncGoRefresh | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Specifies the control to refresh when using an 'Async Go button' |
buildQueryStringAction | false | javax.el.MethodExpression
(signature must match java.lang.String action() )
| The action handler for the 'Go' button |
buildQueryStringActionExpression | false | javax.el.MethodExpression
(signature must match java.lang.String action() )
| The action handler for the 'Go' button |
cancelSearchOptionsAction | false | javax.el.MethodExpression
(signature must match java.lang.String action() )
|
WARNING: This property has been deprecated. Use cancelSearchOptionsActionExpression property instead The action handler for the 'Cancel' button on the 'Options' tab |
cancelSearchOptionsActionExpression | false | javax.el.MethodExpression
(signature must match java.lang.String action() )
| The action handler for the 'Cancel' button on the 'Options' tab |
changeActiveSavedSearchAction | false | javax.el.MethodExpression
(signature must match java.lang.String action() )
|
WARNING: This property has been deprecated. Use changeActiveSavedSearchActionExpression property instead The action handler for changing the active saved search |
changeActiveSavedSearchActionExpression | false | javax.el.MethodExpression
(signature must match java.lang.String action() )
| The action handler for changing the active saved search |
clearFormAction | false | javax.el.MethodExpression
(signature must match java.lang.String action() )
| The action handler for the 'Clear' button |
clearFormActionExpression | false | javax.el.MethodExpression
(signature must match java.lang.String action() )
| The action handler for the 'Clear' button |
clearFormButtonAvailable | false | javax.el.ValueExpression
(must evaluate to boolean )
|
If true, the 'Clear' button is visible for Search/Advanced/Saved tabs
If not specified, the default value is "true". |
deleteSavedAction | false | javax.el.MethodExpression
(signature must match java.lang.String action() )
|
WARNING: This property has been deprecated. Use deleteSavedActionExpression property instead The action handler for the saved search 'Delete' button |
deleteSavedActionExpression | false | javax.el.MethodExpression
(signature must match java.lang.String action() )
| The action handler for the saved search 'Delete' button |
id | false | java.lang.String | Control identifier |
keywordsFieldAvailable | false | javax.el.ValueExpression
(must evaluate to boolean )
|
If true, the 'Keywords' controls are visible for Search/Advanced/Saved tabs
If not specified, the default value is "true". |
maxResultsFieldAvailable | false | javax.el.ValueExpression
(must evaluate to boolean )
|
If true, the 'Max Results' controls are visible on the 'Options' tab
If not specified, the default value is "true". |
maxResultsMaxValue | false | javax.el.ValueExpression
(must evaluate to long )
|
Set the maximum number that user can specify for the 'Max Results' value
If not specified, the default value is "2000". |
persistSearchOptionsAction | false | javax.el.MethodExpression
(signature must match java.lang.String action() )
|
WARNING: This property has been deprecated. Use persistSearchOptionsActionExpression property instead The action handler for the 'Save' button on the 'Options' tab |
persistSearchOptionsActionExpression | false | javax.el.MethodExpression
(signature must match java.lang.String action() )
| The action handler for the 'Save' button on the 'Options' tab |
refineSearchButtonAvailable | false | javax.el.ValueExpression
(must evaluate to boolean )
|
If true, the 'Refine' button on the 'Search' tab is visible to the end user
If not specified, the default value is "true". |
rendered | false | javax.el.ValueExpression
(must evaluate to boolean )
|
True to render control; false to ignore it
If not specified, the default value is "true". |
savedSearchProvider | false | javax.el.ValueExpression
(must evaluate to com.webmethods.caf.faces.search.saved.ISavedSearchProvider )
| Value binding that specifies the saved search provider |
saveQueryAction | false | javax.el.MethodExpression
(signature must match java.lang.String action() )
|
WARNING: This property has been deprecated. Use saveQueryActionExpression property instead The action handler adding a new saved search |
saveQueryActionExpression | false | javax.el.MethodExpression
(signature must match java.lang.String action() )
| The action handler adding a new saved search |
saveSearchAvailable | false | javax.el.ValueExpression
(must evaluate to boolean )
|
If true, the 'Saved' tab is visible to the end user
If not specified, the default value is "true". |
searchOptionsManager | false | javax.el.ValueExpression
(must evaluate to com.webmethods.caf.faces.search.options.ISearchOptionsManager )
| Value binding that specifies the search options manager |
searchQueryFactory | false | javax.el.ValueExpression
(must evaluate to com.webmethods.caf.faces.search.query.ISearchQueryFactory )
| Value binding that specifies a factory for search query objects |
simpleSearchAvailable | false | javax.el.ValueExpression
(must evaluate to boolean )
|
If true, the 'Search' tab is visible to the end user
If not specified, the default value is "true". |
updateSavedQueryAction | false | javax.el.MethodExpression
(signature must match java.lang.String action() )
|
WARNING: This property has been deprecated. Use updateSavedQueryActionExpression property instead The action handler for the updating an existing saved search |
updateSavedQueryActionExpression | false | javax.el.MethodExpression
(signature must match java.lang.String action() )
| The action handler for the updating an existing saved search |
useAsyncGoButton | false | javax.el.ValueExpression
(must evaluate to boolean )
|
If true, the 'Go' button will use an 'Async Command Button'
If not specified, the default value is "false". |
useOrConditionAvailable | false | javax.el.ValueExpression
(must evaluate to boolean )
|
If true, the 'Match Any/All' dropdown is visible
If not specified, the default value is "true". |
userSearchOptionsAvailable | false | javax.el.ValueExpression
(must evaluate to boolean )
|
If true, the 'Options' tab is visible to the end user
If not specified, the default value is "true". |
Output generated by Vdldoc View Declaration Language Documentation Generator.