A text input control with an auto-complete popup menu. The Autocomplete Text Input control's behavior is equivalent to other single-select controls, such as a Dropdown. Selection options are defined by specifying javax.faces.SelectItem or javax.faces.SelectItems as children of this control. For more information, see the control documentation for the standard JSF controls Option and Option Group.
If the 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, filtering the list of auto-complete values is done on the server by the provider, using the provider's filter attribute to sort and select from the collection of items returned by its getSelectItemContentProviders() method. The default ISelectItemGroupProvider, which is com.webmethods.caf.faces.data.object.DefaultSelectItemContentProvider, implements the IFilterableSelectItemGroupProvider. However, the default returns false for the isFilterable()method.
If the control is not bound to a provider that implements IFilterableSelectItemGroupProvider, then auto-completion is done only on the client, using the standard common search keyword rules such as * = wildcard, space = and, quotes = exact phrase.
You can set the default filter for this control using the filter attribute.
You can only use this control in a Form control.
Children
javax.faces.SelectItem (JSF Option control) and javax.faces.SelectItems (JSF Option Group control).
| Info | Value |
|---|---|
| Component Type | com.webmethods.caf.faces.select.AutocompleteTextInput |
| Handler Class | None |
| Renderer Type | com.webmethods.caf.faces.select.AutocompleteTextInput |
| Description | Text input that also supplies user with list of dynamic autocomplete options |
| Palette Location | CAF Html/Control/Input/Autocomplete Text Input |
| Client-Side Model | CAF.Select.Combobox.Model |
| Name | Required | Type | Description |
|---|---|---|---|
accesskey | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Keyboard shortcut letter |
converter | false | javax.el.ValueExpression
(must evaluate to javax.faces.convert.Converter)
| A value binding expression for a method that returns a converter instance. |
converterMessage | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Will be used as the text of the converter message, replacing any message that comes from the converter. |
dir | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
|
Specifies the directionality of the flow of the content for the current element
Valid values are:
|
disabled | false | javax.el.ValueExpression
(must evaluate to boolean)
|
True if control is grayed-out and un-modifiable
If not specified, the default value is "false". |
filter | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Filter value |
id | false | java.lang.String | Control identifier |
immediate | false | javax.el.ValueExpression
(must evaluate to boolean)
|
True to process value change listeners in the Apply Request Values phase; false to process in the Process Validations phase
If not specified, the default value is "false". |
label | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| A localized user presentable name for this component. |
lang | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Specifies the language of the enclosed content |
other | false | javax.el.ValueExpression
(must evaluate to boolean)
| Show Other... option |
readonly | false | javax.el.ValueExpression
(must evaluate to boolean)
|
True if control is un-modifiable
If not specified, the default value is "false". |
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". |
required | false | javax.el.ValueExpression
(must evaluate to boolean)
|
True if user must specify a value for control
If not specified, the default value is "false". |
requiredMessage | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Will be used as the text of the validation message for the "required" facility, if the "required" facility is used. |
sortByLabel | false | javax.el.ValueExpression
(must evaluate to boolean)
|
True to sort options alphabetically by their label text
If not specified, the default value is "false". |
style | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| HTML "style" attribute value |
styleClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
|
HTML "class" attribute value
Valid values are:
|
tabindex | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Order in tab (key) sequence, from 1 to n. Zero adds control to tab sequence, negative integer removes control. |
title | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| HTML "title" attribute value (often displayed as a tooltip) |
useClientSideValidation | false | javax.el.ValueExpression
(must evaluate to boolean)
|
True if client side validation should be attempted (if available) for the control
If not specified, the default value is "true". Valid values are:
|
validator | false | javax.el.MethodExpression
(signature must match void validate(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object))
| A method binding expression for a method that validates the component local value. |
validatorMessage | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Will be used as the text of the validator message, replacing any message that comes from the validator. |
value | false | javax.el.ValueExpression
(must evaluate to java.lang.Object)
| Control value |
valueChangeListener | false | javax.el.MethodExpression
(signature must match void valueChange(javax.faces.event.ValueChangeEvent))
| Value change listener method binding |
width | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
|
Pre-defined input width
Valid values are:
|
Output generated by Vdldoc View Declaration Language Documentation Generator.