inputSearch (Liferay Faces Portal View Description Language Documentation (VDLDoc))

Description:

InputSearch is a UIInput component that renders a text field and optional button for submitting search criteria.

Since:

2.0.0

Example usage of this component can be found at:

http://www.liferayfaces.org/web/guest/portal-showcase/-/portal-tag/portal/inputsearch/general

Component Information
Info	Value
Component Type	`com.liferay.faces.portal.component.inputsearch.InputSearch`
Handler Class	`com.liferay.faces.portal.component.inputsearch.internal.InputSearchHandler`
Renderer Type	`com.liferay.faces.portal.component.inputsearch.InputSearchRenderer`
Description	None

Attributes
Name	Required	Type	Description
`action`	`false`	`javax.el.MethodExpression` (signature must match `java.lang.Object action()`)	A method that is executed when this component is clicked. The method must be `public`, return an `Object`, and take no arguments. The `toString()` method of the returned object is used to determine where to navigate (if at all) after the action has been performed.
`actionListener`	`false`	`javax.el.MethodExpression` (signature must match `void actionListener(javax.faces.event.ActionEvent)`)	A method that is executed when this component is clicked. The method must be `public`, return `void`, and take either no arguments or one `ActionEvent` argument.
`autoFocus`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	Sets whether the search field gets focus by default. The default value is `false`.
`binding`	`false`	`javax.el.ValueExpression` (must evaluate to `javax.faces.component.UIComponent`)	An EL expression that binds the Java reference to this component in the component tree to a bean property.
`buttonLabel`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Sets the text value for the search button's label. The default value is `Search`.
`converter`	`false`	`javax.el.ValueExpression` (must evaluate to `javax.faces.convert.Converter`)	The class name of the converter instance that is to be used by this component.
`converterMessage`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	This message or the result of the specified expression, will be used as the text of the converter message instead of any message that comes from the registered converter for this component.
`id`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A unique identifier for this component.
`immediate`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	When this flag is true, this component's value must be converted and validated (immediately) during the Apply Request Values phase, instead of (later) during the PROCESS_VALIDATIONS phase.
`placeholder`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Sets the placeholder text for the search field. The default value is the value of the `buttonLabel` attribute.
`rendered`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	When this flag is true, this component will be rendered to there response. When false, it will not be rendered to the response. The default value is `true`.
`required`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	When this flag is true, and a value has not been specified for this component, then the PROCESS_VALIDATIONS phase will fail and a FacesMessage will be added to the FacesContext for this component.
`requiredMessage`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	This message or the result of the specified expression, will be used as the text of the validation error message instead of any message that comes from the resulting validation error for this component when required="true" and no value is selected by the user.
`showButton`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	Sets whether to show the search button. The default value is `true`.
`style`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying the css style of the element.
`styleClass`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	List of CSS class names (separated by spaces) that are to be rendered within the class attribute.
`title`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Sets the search box's title.
`validator`	`false`	`javax.el.MethodExpression` (signature must match `void validate(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)`)	A method that is executed in the PROCESS_VALIDATIONS phase of the lifecycle. The method must be `public`, return `void`, and take three arguments of `FacesContext`, `UIComponent`, and `Object`.
`validatorMessage`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	This message or the result of the specified expression, will be used as the text of the validation error message instead of any message that comes from the resulting validation error for this component.
`value`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Object`)	The value of this component, which is typically bound via EL to a model bean property.
`valueChangeListener`	`false`	`javax.el.MethodExpression` (signature must match `void valueChange(javax.faces.event.ValueChangeEvent)`)	A method that is executed when the value of this component changes. The method must be `public`, return `void`, and take no arguments or one argument of `ValueChangeEvent`.

portal

Tag inputSearch