Overview

The <crm:autocomplete> tag is used to display an input element on the page that provides the user prompt suggestions while the input is being typed into the input box.

Attributes

Name	Required	Type	Default	Description
className	true	String	null	The class name of the value of the component.
columnClasses	false	String	ui-grid-col-12	Comma separated list of column style classes of the gird layout that will be used to display the component. Column style class should be prefixed with ui-grid-col- and suffixed with the number of columns that content will take (out of 12). For example, for two columns with the same size the columnClasses should be "ui-grid-col-6,ui-grid-col-6".
completeMethod	true	Boolean	false	Defines the function call triggered to provide suggestions.
columns	false	Integer	1	Number of columns of the gird layout that will be used to display the component.
displayValue	false	String	null	The displayed value of the component in view mode. At least one of the attributes displayValue or itemLabel must be specified.
dropdown	false	Boolean	false	Enables dropdown mode when set true.
forceSelection	false	Boolean	true	When enabled, autoComplete only accepts input from the selection list.
id	true	String	null	Unique identifier of the component.
isRequired	false	Booelan	true if the data object property of the component is mandatory, otherwise false.	Marks component as required.
itemLabel	false	String	null	Label of the item. At least one of the attributes displayValue or itemLabel must be specified.
labelKey	false	String	null	A valid key defined in translation properties file. Its translation through the glossary will be used as the presentable name of the component.
managedBean	true	String	null	The name of the Java managed bean class that will be used for retrieving the component values.
maxResults	false	Integer	20	Maximum number of results to be displayed.
minQueryLength	false	Integer	1	Number of characters to be typed before starting to query.
mode	false	String	The mode of the managed bean.	The mode of the component. Allowed values are VIEW and EDIT.
multiple	false	Boolean	false	Flag indicating that multiple selection is enabled or not.
onChangeFunction	false	String	null	Defines the function call triggered when input element loses focus and its value has been modified since gaining focus.
onChangeFunctionParameters	false	String	null	Defines the parameter that will be used from the onChangeFunction function call.
parameters	false	String	null	Defines the parameter that will be used from the completeMethod function call.
placeholder	false	String	key_type_to_search	A valid key defined in translation properties file. Its translation through the glossary will be used as a short hint that describes the expected value of this input element.
process	false	String	@this and the value of the refresh attribute	Component(s) to process in partial request.
readonly	false	Boolean	false	Flag indicating that this component will prevent changes by the user.
refresh	false	String	@this	Component(s) to update with ajax.
tip	false	String	null	A valid key defined in translation properties file. Its translation through the glossary will be used as an advisory tooltip information.
value	true	Object	null	The value of the component.
visible	false	Boolean	true	Controls the visibility of the component.

Getting Started

The following example shows an autocomplete component.