Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Overview

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

...

Image Added

Attributes

NameRequiredTypeDefaultDescription
className

...

trueStringnullThe class name of the value of the component

columnClasses

falseStringui-grid-col-12

Comma separated list of column style classes of the gird layout that will be used to display the component.

Note

...

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".


completeMethodtrueBooleanfalseThe name of the client side method to provide suggestions.
columnsfalseInteger1Number of columns of the gird layout that will be used to display the component.
displayValuefalseStringnull

The displayed value of the component in view mode.

Note

At least one of the attributes displayValue or itemLabel must be specified.


dropdownfalseBooleanfalseEnables dropdown mode when set true.

...

...

forceSelectionfalseBooleantrueWhen enabled, autoComplete only accepts input from the selection list.
icon

...

trueStringnull

...

Icon of the button.

Note

Use font awesome icon class supported by version 4.7.0.


id

...

trueStringnullUnique identifier of the component.
itemLabelfalseStringnull

Label of the suggestion item.

Note

At least one of the attributes displayValue or itemLabel must be specified.


labelKeyfalseStringnull

...

A valid key

...

defined in translation properties file

...

. Its translation through the glossary will be used as the presentable name of the component.

managedBean

...

trueStringnullThe name of the Java managed bean

...

class that will be used for retrieving the component values.
maxResultsfalseInteger20Maximum number of results to be displayed.
minQueryLengthfalseInteger1Number of characters to be typed before starting to query.
modefalseStringThe mode of the managed bean.

The mode of the component. 

Note

Allowed values are VIEW and EDIT.


multiplefalseBooleanfalse

Flag indicating that multiple selection is enabled or not.

 


onChangeFunctionfalseStringnull

...

Defines the function call triggered when input element loses focus and its value has been modified since gaining focus.

parametersfalseStringnull

...

Defines the parameter that will be used from the onChangeFunction function call.
placeholderfalseStringkey_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.

processfalseString@this and the value of the refresh attributeComponent(s) to process in partial request.
readonlyfalseBooleanfalseFlag indicating that this component will prevent changes by the user.
refreshfalseString@thisComponent(s) to update with ajax.
tipfalseStringnull

...

A valid key

...

defined in translation properties file

...

. Its translation through the glossary will be used as an

...

advisory tooltip information.
value

...

 JSF Page

 

 

 

 

 

 

Managed Bean

 

 

...

trueObjectnullThe value of the component.
visiblefalseBooleantrueControls the visibility of the component.

...


Getting Started

The following example shows an autocomplete with icon component.