Package com.webmethods.caf.faces.component.search

Class SearchBar

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIPanel

com.webmethods.caf.faces.component.panel.BaseHideablePanel

com.webmethods.caf.faces.component.AbstractCompositeViewControl

com.webmethods.caf.faces.component.search.SearchBar

All Implemented Interfaces:

IDynamicComponent, IHideablePanel, ILazyHideablePanel, IPostPageComponentPhaseListener, IScopedVariableComponent, ITableRowStateHolder, Serializable, EventListener, NamingContainer, PartialStateHolder, StateHolder, TransientStateHolder, ComponentSystemEventListener, FacesListener, PhaseListener, SystemEventListenerHolder

Direct Known Subclasses:

PeopleSearchBar

public class SearchBar
extends AbstractCompositeViewControl

Search Bar JSF Component for building a search query string

Since:

7.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.webmethods.caf.faces.component.AbstractCompositeViewControl

AbstractCompositeViewControl.BindingExpressionReWriter

Nested classes/interfaces inherited from class com.webmethods.caf.faces.component.panel.BaseHideablePanel

BaseHideablePanel.PropertyKeys

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	CONTROL_ID_CANCEL_SEARCH_OPTIONS_BUTTON
protected static final String	CONTROL_ID_CHANGE_ACTIVE_SEARCH_COMMAND
protected static final String	CONTROL_ID_CLEAR_SEARCH_FORM_BUTTON
protected static final String	CONTROL_ID_DELETE_SAVED_SEARCH_BUTTON
protected static final String	CONTROL_ID_REFINED_SEARCH_ASYNC_GO_BUTTON
protected static final String	CONTROL_ID_REFINED_SEARCH_GO_BUTTON
protected static final String	CONTROL_ID_SAVE_SEARCH_ASYNC_GO_BUTTON
protected static final String	CONTROL_ID_SAVE_SEARCH_GO_BUTTON
protected static final String	CONTROL_ID_SAVE_SEARCH_OPTIONS_BUTTON
protected static final String	CONTROL_ID_SAVE_SEARCH_QUERY_BUTTON
protected static final String	CONTROL_ID_SIMPLE_SEARCH_ASYNC_GO_BUTTON
protected static final String	CONTROL_ID_SIMPLE_SEARCH_GO_BUTTON
protected static final String	CONTROL_ID_UPDATE_SAVED_SEARCH_LINK
static final String	FACET_REFINE_PANEL	Id of the refine panel facet
protected static final String	SEARCHBAR_VIEW

Fields inherited from class com.webmethods.caf.faces.component.AbstractCompositeViewControl

_deferredPropertiesMap, ATTR__VIEW_LOADED, fInstanceNumber, fPrototypedPageBeanName, fViewResourcePath, PORTLET_VIEW_ID

Fields inherited from class com.webmethods.caf.faces.component.panel.BaseHideablePanel

ATTR_CENTER, ATTR_DEFAULT_COMMAND, ATTR_DEFAULT_FOCUS, ATTR_DISABLE_WHEN_HIDDEN, ATTR_HIDE_EFFECT, ATTR_HIDE_EFFECT_OPTIONS, ATTR_OPACITY, ATTR_PROGRESS_DELAY, ATTR_PROGRESS_FLASH_ON_COMPLETE, ATTR_PROGRESS_MSG, ATTR_PROGRESS_USE_HIDE_SHOW_EFFECT, ATTR_SHOW_EFFECT, ATTR_SHOW_EFFECT_OPTIONS, m_savedSuppressed, m_savedVisible, TYPE

Fields inherited from class javax.faces.component.UIPanel

COMPONENT_FAMILY, COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor	Description
SearchBar()

Method Summary

Modifier and Type	Method	Description
protected void	applyDeferredProperties()	Apply any changes in the deferred properties map to the underlying controls.
protected Serializable	createPageBean()
Map<String,Object>	getAttributes()
MethodBinding	getBuildQueryStringAction()	Deprecated. use getBuildQueryStringActionExpression() instead
MethodExpression	getBuildQueryStringActionExpression()
MethodBinding	getCancelSearchOptionsAction()	Deprecated. use getCancelSearchOptionsActionExpression() instead
MethodExpression	getCancelSearchOptionsActionExpression()
MethodBinding	getChangeActiveSavedSearchAction()	Deprecated. use getChangeActiveSavedSearchActionExpression() instead
MethodExpression	getChangeActiveSavedSearchActionExpression()
MethodBinding	getClearFormAction()	Deprecated. use getClearFormActionExpression() instead
MethodExpression	getClearFormActionExpression()
SearchBarControlBean	getControlBean()
String	getDefaultCommandId()	Return the ID for the default searchbar command
String	getDefaultFocusId()	Return the ID for the searchbar control that should have the initial focus
MethodBinding	getDeleteSavedAction()	Deprecated. use getDeleteSavedActionExpression() instead
MethodExpression	getDeleteSavedActionExpression()
UIComponent	getFacet(String name)
MethodBinding	getPersistSearchOptionsAction()	Deprecated. use getPersistSearchOptionsActionExpression() instead
MethodExpression	getPersistSearchOptionsActionExpression()
MethodBinding	getSaveQueryAction()	Deprecated. use getSaveQueryActionExpression() instead
MethodExpression	getSaveQueryActionExpression()
MethodBinding	getUpdateSavedQueryAction()	Deprecated. use getUpdateSavedQueryActionExpression() instead
MethodExpression	getUpdateSavedQueryActionExpression()
ValueExpression	getValueExpression(String name)
void	populateInitialComponents()	Override to take care of moving the refine panel control to the correct location.
void	setBuildQueryStringAction(MethodBinding buildQueryStringMB)	Deprecated. use setBuildQueryStringActionExpression(MethodExpression) instead
void	setBuildQueryStringActionExpression(MethodExpression buildQueryStringMB)
void	setCancelSearchOptionsAction(MethodBinding cancelSearchOptionsAction)	Deprecated. use setCancelSearchOptionsActionExpression(MethodExpression) instead
void	setCancelSearchOptionsActionExpression(MethodExpression cancelSearchOptionsAction)
void	setChangeActiveSavedSearchAction(MethodBinding changeActiveSavedSearchAction)	Deprecated. use setChangeActiveSavedSearchActionExpression(MethodExpression) instead
void	setChangeActiveSavedSearchActionExpression(MethodExpression changeActiveSavedSearchAction)
void	setClearFormAction(MethodBinding clearFormMB)	Deprecated. use setClearFormActionExpression(MethodExpression) instead
void	setClearFormActionExpression(MethodExpression clearFormMB)
void	setDeleteSavedAction(MethodBinding deleteSavedMB)	Deprecated. use setDeleteSavedActionExpression(MethodExpression) instead
void	setDeleteSavedActionExpression(MethodExpression deleteSavedMB)
void	setPersistSearchOptionsAction(MethodBinding persistSearchOptionsAction)	Deprecated. use setPersistSearchOptionsActionExpression(MethodExpression) instead
void	setPersistSearchOptionsActionExpression(MethodExpression persistSearchOptionsAction)
void	setSaveQueryAction(MethodBinding saveQueryMB)	Deprecated. use setSaveQueryActionExpression(MethodExpression) instead
void	setSaveQueryActionExpression(MethodExpression saveQueryMB)
void	setUpdateSavedQueryAction(MethodBinding updateSavedQueryAction)	Deprecated. use setUpdateSavedQueryActionExpression(MethodExpression) instead
void	setUpdateSavedQueryActionExpression(MethodExpression updateSavedQueryAction)
void	setValueExpression(String name, ValueExpression expression)

Methods inherited from class com.webmethods.caf.faces.component.AbstractCompositeViewControl

afterPhase, associateControlWithBean, associateControlWithBean, beforePhase, clearPageBean, encodeBegin, encodeChildren, encodeEnd, ensureEmbeddedViewIsLoaded, getDeferredPropertiesMap, getInternalPageBean, getInternalPageBean, getInternalPageBeanName, getPageNamesToReplaceInBindingExpressions, getPhaseId, getPostPagePhaseId, getScopedVariable, getScopedVariableName, importChildrenFromView, loadView, postPageAfterPhase, postPageBeforePhase, processDecodes, processEvent, processLoadView, processRestoreState, processSaveState, processUpdates, processValidators, restoreState, saveState, visitTree

Methods inherited from class com.webmethods.caf.faces.component.panel.BaseHideablePanel

decode, findSuppressed, getRendersChildren, getSuppressInputs, getTableRowState, isAncestorOrSelf, isDisableWhenHidden, isLazy, isRefreshOnShow, isTwoPass, isVisible, setDisableWhenHidden, setLazy, setRefreshOnShow, setSuppressInputs, setTableRowState, setTwoPass, setVisible

Methods inherited from class javax.faces.component.UIPanel

getFamily

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, findComponent, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInView

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

FACET_REFINE_PANEL

public static final String FACET_REFINE_PANEL

Id of the refine panel facet

See Also:

• Constant Field Values

SEARCHBAR_VIEW

protected static final String SEARCHBAR_VIEW

See Also:

• Constant Field Values

CONTROL_ID_SIMPLE_SEARCH_ASYNC_GO_BUTTON

protected static final String CONTROL_ID_SIMPLE_SEARCH_ASYNC_GO_BUTTON

See Also:

• Constant Field Values

CONTROL_ID_SIMPLE_SEARCH_GO_BUTTON

protected static final String CONTROL_ID_SIMPLE_SEARCH_GO_BUTTON

See Also:

• Constant Field Values

CONTROL_ID_REFINED_SEARCH_GO_BUTTON

protected static final String CONTROL_ID_REFINED_SEARCH_GO_BUTTON

See Also:

• Constant Field Values

CONTROL_ID_REFINED_SEARCH_ASYNC_GO_BUTTON

protected static final String CONTROL_ID_REFINED_SEARCH_ASYNC_GO_BUTTON

See Also:

• Constant Field Values

CONTROL_ID_SAVE_SEARCH_ASYNC_GO_BUTTON

protected static final String CONTROL_ID_SAVE_SEARCH_ASYNC_GO_BUTTON

See Also:

• Constant Field Values

CONTROL_ID_SAVE_SEARCH_GO_BUTTON

protected static final String CONTROL_ID_SAVE_SEARCH_GO_BUTTON

See Also:

• Constant Field Values

CONTROL_ID_SAVE_SEARCH_QUERY_BUTTON

protected static final String CONTROL_ID_SAVE_SEARCH_QUERY_BUTTON

See Also:

• Constant Field Values

CONTROL_ID_CLEAR_SEARCH_FORM_BUTTON

protected static final String CONTROL_ID_CLEAR_SEARCH_FORM_BUTTON

See Also:

• Constant Field Values

CONTROL_ID_CHANGE_ACTIVE_SEARCH_COMMAND

protected static final String CONTROL_ID_CHANGE_ACTIVE_SEARCH_COMMAND

See Also:

• Constant Field Values

CONTROL_ID_DELETE_SAVED_SEARCH_BUTTON

protected static final String CONTROL_ID_DELETE_SAVED_SEARCH_BUTTON

See Also:

• Constant Field Values

CONTROL_ID_UPDATE_SAVED_SEARCH_LINK

protected static final String CONTROL_ID_UPDATE_SAVED_SEARCH_LINK

See Also:

• Constant Field Values

CONTROL_ID_SAVE_SEARCH_OPTIONS_BUTTON

protected static final String CONTROL_ID_SAVE_SEARCH_OPTIONS_BUTTON

See Also:

• Constant Field Values

CONTROL_ID_CANCEL_SEARCH_OPTIONS_BUTTON

protected static final String CONTROL_ID_CANCEL_SEARCH_OPTIONS_BUTTON

See Also:

• Constant Field Values

Constructor Details

SearchBar

public SearchBar()

Method Details

getControlBean

public SearchBarControlBean getControlBean()

createPageBean

protected Serializable createPageBean()

Specified by:

createPageBean in class AbstractCompositeViewControl

getDefaultCommandId

public String getDefaultCommandId()

Return the ID for the default searchbar command

Returns:

the ID for the default searchbar command

getDefaultFocusId

public String getDefaultFocusId()

Return the ID for the searchbar control that should have the initial focus

Returns:

the ID for the searchbar control that should have the initial focus

getFacet

public UIComponent getFacet(String name)

Overrides:

getFacet in class UIComponentBase

setBuildQueryStringAction

@Deprecated
public void setBuildQueryStringAction(MethodBinding buildQueryStringMB)

Deprecated.

use setBuildQueryStringActionExpression(MethodExpression) instead

Parameters:

buildQueryStringMB - The buildQueryStringAction to set.

setBuildQueryStringActionExpression

public void setBuildQueryStringActionExpression(MethodExpression buildQueryStringMB)

Parameters:

buildQueryStringMB - The buildQueryStringAction to set.

getBuildQueryStringAction

@Deprecated
public MethodBinding getBuildQueryStringAction()

Deprecated.

use getBuildQueryStringActionExpression() instead

getBuildQueryStringActionExpression

public MethodExpression getBuildQueryStringActionExpression()

setSaveQueryAction

@Deprecated
public void setSaveQueryAction(MethodBinding saveQueryMB)

Deprecated.

use setSaveQueryActionExpression(MethodExpression) instead

Parameters:

saveQueryMB - The saveQueryMB to set.

setSaveQueryActionExpression

public void setSaveQueryActionExpression(MethodExpression saveQueryMB)

Parameters:

saveQueryMB - The saveQueryMB to set.

getSaveQueryAction

@Deprecated
public MethodBinding getSaveQueryAction()

Deprecated.

use getSaveQueryActionExpression() instead

getSaveQueryActionExpression

public MethodExpression getSaveQueryActionExpression()

setClearFormAction

@Deprecated
public void setClearFormAction(MethodBinding clearFormMB)

Deprecated.

use setClearFormActionExpression(MethodExpression) instead

Parameters:

clearFormMB - The clearFormMB to set.

setClearFormActionExpression

public void setClearFormActionExpression(MethodExpression clearFormMB)

Parameters:

clearFormMB - The clearFormMB to set.

getClearFormAction

@Deprecated
public MethodBinding getClearFormAction()

Deprecated.

use getClearFormActionExpression() instead

getClearFormActionExpression

public MethodExpression getClearFormActionExpression()

setChangeActiveSavedSearchAction

@Deprecated
public void setChangeActiveSavedSearchAction(MethodBinding changeActiveSavedSearchAction)

Deprecated.

use setChangeActiveSavedSearchActionExpression(MethodExpression) instead

Parameters:

changeActiveSavedSearchAction - The changeActiveSavedSearchAction to set.

setChangeActiveSavedSearchActionExpression

public void setChangeActiveSavedSearchActionExpression(MethodExpression changeActiveSavedSearchAction)

Parameters:

changeActiveSavedSearchAction - The changeActiveSavedSearchAction to set.

getChangeActiveSavedSearchAction

@Deprecated
public MethodBinding getChangeActiveSavedSearchAction()

Deprecated.

use getChangeActiveSavedSearchActionExpression() instead

getChangeActiveSavedSearchActionExpression

public MethodExpression getChangeActiveSavedSearchActionExpression()

setDeleteSavedAction

@Deprecated
public void setDeleteSavedAction(MethodBinding deleteSavedMB)

Deprecated.

use setDeleteSavedActionExpression(MethodExpression) instead

Parameters:

deleteSavedMB - The deleteSavedMB to set.

setDeleteSavedActionExpression

public void setDeleteSavedActionExpression(MethodExpression deleteSavedMB)

Parameters:

deleteSavedMB - The deleteSavedMB to set.

getDeleteSavedAction

@Deprecated
public MethodBinding getDeleteSavedAction()

Deprecated.

use getDeleteSavedActionExpression() instead

getDeleteSavedActionExpression

public MethodExpression getDeleteSavedActionExpression()

setUpdateSavedQueryAction

@Deprecated
public void setUpdateSavedQueryAction(MethodBinding updateSavedQueryAction)

Deprecated.

use setUpdateSavedQueryActionExpression(MethodExpression) instead

Parameters:

updateSavedQueryAction - The updateSavedQueryAction to set.

setUpdateSavedQueryActionExpression

public void setUpdateSavedQueryActionExpression(MethodExpression updateSavedQueryAction)

Parameters:

updateSavedQueryAction - The updateSavedQueryAction to set.

getUpdateSavedQueryAction

@Deprecated
public MethodBinding getUpdateSavedQueryAction()

Deprecated.

use getUpdateSavedQueryActionExpression() instead

getUpdateSavedQueryActionExpression

public MethodExpression getUpdateSavedQueryActionExpression()

setPersistSearchOptionsAction

@Deprecated
public void setPersistSearchOptionsAction(MethodBinding persistSearchOptionsAction)

Deprecated.

use setPersistSearchOptionsActionExpression(MethodExpression) instead

Parameters:

persistSearchOptionsAction - The persistSearchOptionsAction to set.

setPersistSearchOptionsActionExpression

public void setPersistSearchOptionsActionExpression(MethodExpression persistSearchOptionsAction)

Parameters:

persistSearchOptionsAction - The persistSearchOptionsAction to set.

getPersistSearchOptionsAction

@Deprecated
public MethodBinding getPersistSearchOptionsAction()

Deprecated.

use getPersistSearchOptionsActionExpression() instead

getPersistSearchOptionsActionExpression

public MethodExpression getPersistSearchOptionsActionExpression()

setCancelSearchOptionsAction

@Deprecated
public void setCancelSearchOptionsAction(MethodBinding cancelSearchOptionsAction)

Deprecated.

use setCancelSearchOptionsActionExpression(MethodExpression) instead

Parameters:

cancelSearchOptionsAction - The cancelSearchOptionsAction to set.

setCancelSearchOptionsActionExpression

public void setCancelSearchOptionsActionExpression(MethodExpression cancelSearchOptionsAction)

Parameters:

cancelSearchOptionsAction - The cancelSearchOptionsAction to set.

getCancelSearchOptionsAction

@Deprecated
public MethodBinding getCancelSearchOptionsAction()

Deprecated.

use getCancelSearchOptionsActionExpression() instead

getCancelSearchOptionsActionExpression

public MethodExpression getCancelSearchOptionsActionExpression()

populateInitialComponents

public void populateInitialComponents()

Override to take care of moving the refine panel control to the correct location.

Specified by:

populateInitialComponents in interface IDynamicComponent

Overrides:

populateInitialComponents in class AbstractCompositeViewControl

applyDeferredProperties

protected void applyDeferredProperties()

Apply any changes in the deferred properties map to the underlying controls.

Overrides:

applyDeferredProperties in class AbstractCompositeViewControl

getAttributes

public Map<String,Object> getAttributes()

Overrides:

getAttributes in class UIComponentBase

getValueExpression

public ValueExpression getValueExpression(String name)

Overrides:

getValueExpression in class UIComponent

setValueExpression

public void setValueExpression(String name,
 ValueExpression expression)

Overrides:

setValueExpression in class UIComponent