Whether autocompletion search is initially active.
ID of the container to which the suggestion box is appended.
Defines which position on the target element to align the positioned element against.
Highlights the first suggested item automatically.
Defines if auto selection of items that are equal to the typed input is enabled. If
true, an item that is equal to the typed input is selected.
A map with all behaviors that were defined for this widget. The key is the name of the behavior, the value is the callback function that is invoked when the behavior is called.
When enabled autocomplete caches the searched result list.
Timeout in milliseconds value for cached results.
REST endpoint for fetching autocomplete suggestions. Takes precedence over the
bean command specified via completeMethod on the component.
The delay in milliseconds before an autocomplete search is triggered.
Specifies the behavior of the dropdown button.
Defines if dynamic loading is enabled for the element's panel. If the value is true,
the overlay is not rendered on page load to improve performance.
Text to display when there is no data to display.
Whether the text of the suggestion items is escaped for HTML.
Whether one of the available suggestion items is forced to be preselected.
ID of the form to use for AJAX requests.
Whether suggestion items are grouped.
Whether a footer facet is present.
The client-side ID of the widget, with all parent naming containers, such as
myForm:myWidget. This is also the ID of the container HTML element for this widget. In case the widget needs
multiple container elements (such as Paginator), this may also be an array if IDs.
Whether a tooltip is shown for the suggestion items.
Position of item corner relative to item tip.
Position of itemtip corner relative to item.
Minimum length before an autocomplete search is triggered.
The text shown in the panel when the number of suggestions is greater than maxResults.
When true, enables multiple selection.
Defines which position on the element being positioned to align with the target element.
Client side callback to invoke when value changes.
An optional callback that is invoked
after this widget was created successfully, at the end of the init method. This is
usually specified via the widgetPostConstruct attribute on the JSF component. Note that this is also called
during a refresh (AJAX update).
An optional callback that is invoked after
this widget was refreshed after an AJAX update, at the end of the refresh method.
This is usually specified via the widgetPostRefresh attribute on the JSF component.
An optional callback that is invoked before
this widget is about to be destroyed, e.g. when the component was removed at the end of an AJAX update. This is
called at the beginning of the destroy method. This is usually specified via the
widgetPreDestroy attribute on the JSF component.
Event to initiate the the autocomplete search.
Specifies query mode, whether autocomplete contacts the server.
Hint text for screen readers to provide information about the search results.
Height of the container with the suggestion items.
Limits the number of simultaneously selected items. Default is unlimited.
Ensures uniqueness of the selected items.
The name of the widget variables of this widget. The widget variable can be used to
access a widget instance by calling PF("myWidgetVar").
Generated using TypeDoc
The configuration for the AutoComplete widget. You can access this configuration via BaseWidget.cfg. Please note that this configuration is usually meant to be read-only and should not be modified.