autoComplete (Liferay Faces Alloy View Description Language Documentation (VDLDoc))

Description:

AutoComplete is a UIInput component that renders an <input> element and a popup list. Suggestions (list items) can be added by specifying f:selectItem or f:selectItems tags as children. Since it extends HtmlInputText, it supports all the features of h:inputText.

Since:

2.0.0

Example usage of this component can be found at:

http://www.liferayfaces.org/web/guest/alloy-showcase/-/alloy-tag/alloy/autocomplete/general

Component Information
Info	Value
Component Type	`com.liferay.faces.alloy.component.autocomplete.AutoComplete`
Handler Class	`com.liferay.faces.alloy.component.autocomplete.internal.AutoCompleteHandler`
Renderer Type	`com.liferay.faces.alloy.component.autocomplete.AutoCompleteRenderer`
Description	None

Attributes
Name	Required	Type	Description
`accesskey`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying a hot key character for the element.
`activateFirstItem`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	When true, the first item in the list will be activated so that users can press TAB or ENTER to select it. The default value is `true`.
`alt`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying alternative information about the rendered HTML element.
`autocomplete`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying whether autocomplete is turned on or off for the rendered HTML element. Valid values include `off` (default) and `on`.
`autoScroll`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	When true, if the active option of the autoComplete is not in view, the view will be scrolled to ensure that the active option is displayed to the user.
`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.
`circular`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	When true, the autoComplete list will wrap around allowing users to use keyboard navigation to move from the top of the list to the bottom and vice versa. The default value is `true`.
`clientCustomFilter`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A callback which filters the client-side results. The callback must be a function which takes `query` and `source` arguments and returns an array of `String`s as a result. The `source` argument recieved by this callback is an `Array` of `Object`s which contain three properties: `display`, `raw`, and `text`. Note: This attribute will be ignored if the `serverCustomFilter` or `serverFilterType` attributes are used.
`clientFilterType`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Specifies the type of filter that will be used for the autoComplete results. Valid values include: charMatch charMatchCase phraseMatch phraseMatchCase startsWith startsWithCase subWordMatch subWordMatchCase wordMatch wordMatchCase Note: This attribute will be ignored if the `serverCustomFilter`, `serverFilterType`, or `clientCustomFilter` attributes are used.
`clientKey`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The key name that can be used to reference the component on the client.
`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.
`delay`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Integer`)	The delay in milliseconds before a request for filtering occurs. After the `autoComplete` receives input, it waits the specified number of milliseconds before sending a request for filtering it's source. If input occurs before the specified number of milliseconds has elapsed, the timer is reset.
`delimiter`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The string which delimits the part of the text that will have completion. For example, if `delimiter=" "`, then only the text after the final space will have completion. Note: if `listItemRequired="true"`, this attribute is ignored.
`dir`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying the reading direction for the element For example, right to left (RTL), or left to right (LTR).
`disabled`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	When this flag is true, the component will be disabled, and the user will be unable to interact with the component. The default value is `false`.
`height`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The the height (in pixels) of the rendered autoComplete list.
`highlighterType`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Specifies the type of highlighter that will be used for the autoComplete results. Valid values include: charMatch charMatchCase phraseMatch phraseMatchCase startsWith startsWithCase subWordMatch subWordMatchCase wordMatch wordMatchCase
`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.
`label`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A localized label for this component that is typically only rendered in a FacesMessage when validation fails.
`lang`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying the language code used in the element.
`listItemRequired`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	When true, the component will perform server-side validation to ensure that the value entered is on the list of completion items. The default value is `false`.
`maxItems`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Integer`)	The maximum amount of autoComplete results.
`maxlength`	`false`	`javax.el.ValueExpression` (must evaluate to `int`)	HTML passthrough attribute specifying the maximum length of characters allowed in the element.
`minChars`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Integer`)	The minimum length of input required to trigger a query.
`onblur`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute after this component loses focus.
`onchange`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute after this component's value has changed, and then it loses focus.
`onclick`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when this component is clicked.
`ondblclick`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when a double click event occurs.
`onfocus`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when this component gets focus.
`onkeydown`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when a keydown event occurs.
`onkeypress`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when a keypress event occurs.
`onkeyup`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when a keyup event occurs.
`onmousedown`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when a mousedown event occurs.
`onmousemove`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when a mousemove event occurs.
`onmouseout`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when a mouseout event occurs.
`onmouseover`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when a mouseover event occurs.
`onmouseup`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when a mouseup event occurs.
`onselect`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript to execute when the user selects this component.
`readonly`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	When true, this causes an attribute to be rendered as readonly="readonly", and prevents the user from changing the value of this component.
`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.
`role`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying the various WAI-ARIA roles that the element is used for. Since: JSF 2.2
`serverCustomFilter`	`false`	`javax.el.MethodExpression` (signature must match `java.util.List<java.lang.String> filterResults(java.lang.String, java.util.List<java.lang.String>)`)	A method that is executed when a query occurs. The method must be `public`, return a `java.util.List<java.lang.String>`, and takes a `java.lang.String` and a `java.util.List<java.lang.String>` as a arguments. The `String` passed to the method is the current query. The `List<String>` is an immutable list of unfiltered results. The method must return a `List<String>` which contains the filtered results.
`serverFilterType`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Specifies the type of filter that will be used for the autoComplete results. Valid values include: charMatch charMatchCase phraseMatch phraseMatchCase startsWith startsWithCase subWordMatch subWordMatchCase wordMatch wordMatchCase Note: This attribute will be ignored if the `serverCustomFilter` attribute is used.
`size`	`false`	`javax.el.ValueExpression` (must evaluate to `int`)	HTML passthrough attribute specifying the visual length of the element.
`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.
`tabindex`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying where the element is located in the tabbing progression.
`tabSelect`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	When `true`, pressing TAB selects the active autoComplete option. The default value is `true`.
`title`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying the title of the element.
`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`.
`width`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The the width (in pixels) of the rendered autoComplete list.

alloy

Tag autoComplete