| Info | Value |
|---|---|
| Component Type | org.primefaces.component.AutoComplete |
| Handler Class | org.primefaces.component.autocomplete.AutoCompleteHandler |
| Renderer Type | org.primefaces.component.AutoCompleteRenderer |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
accesskey | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Access key to transfer focus to the input element. |
active | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if autocomplete functionality is enabled. Default is true and a false value simply turns the component into a simple inputtext. |
alt | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Alternate textual description of the input element. |
appendTo | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Appends the overlay to the element defined by search expression. Defaults to document body. |
at | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Position of input with respect to panel Default is "left bottom". |
autocomplete | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Controls browser autocomplete behavior. |
autoHighlight | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Highlights the first suggested item automatically. Default is true. |
autoSelection | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| 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. Default is true. |
binding | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| An el expression referring to a server side UIComponent instance in a backing bean. |
cache | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When enabled autocomplete caches the searched result list. |
cacheTimeout | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Timeout value for cached results. |
completeEndpoint | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| REST-endpoint for fetching autocomplete-suggestions (instead of completeMethod). |
completeMethod | false | jakarta.el.ValueExpression
(must evaluate to javax.el.MethodExpression)
| Method providing suggestions. |
converter | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.convert.Converter)
| An el expression or a literal text that defines a converter for the component. When it's an EL expression, it's resolved to a converter instance. In case it's a static text, it must refer to a converter id. |
converterMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when conversion fails. |
dir | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Direction indication for text that does not inherit directionality. |
disabled | false | jakarta.el.ValueExpression
(must evaluate to boolean)
| Disables the input element, default is false. |
dropdown | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| No Description |
dropdownMode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Specifies the behavior dropdown button. Default "blank" mode sends an empty string and "current" mode sends the input value. |
dropdownTabindex | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Position of the dropdown button in the tabbing order. |
dynamic | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| 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. Default is false. |
effect | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Animation effect to use when showing and hiding suggestions. |
effectDuration | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Duration of the animation effect in milliseconds. |
escape | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if autocomplete results are escaped or not. Default is true. |
forceSelection | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When enabled, autoComplete only accepts input from the selection list. Default is false. |
groupBy | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Value to group items in categories. |
groupByTooltip | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Tooltip to display on group headers. |
highlightSelector | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| jQuery selector specifies what content to identify for highlighting in search results. By default, it targets "" elements. |
id | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer. |
immediate | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When set true, process validations logic is executed at apply request values phase for this component. Default is false. |
inputmode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| HTML5 inputmode attribute for hinting at the type of data this control has for touch devices to display appropriate virtual keyboard. |
inputStyle | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style of the input element. |
inputStyleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the input element. |
itemLabel | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Label of the item. |
itemStyleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| A string to be rendered onto the class tag of the selected items (tokens rendered inside the input container). |
itemtipAtPosition | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Position of item with respect to item. Default is "right bottom". |
itemtipMyPosition | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Position of itemtip with respect to item. Default is "left top". |
itemValue | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Value of the item. |
label | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| A localized user presentable name. |
lang | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Code describing the language used in the generated markup. |
lazyField | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Field of lazyModel to apply query to using `MatchMode.CONTAINS` |
lazyModel | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| LazyDataModel for fetching autocomplete-suggestions (instead of completeMethod). |
maxlength | false | jakarta.el.ValueExpression
(must evaluate to int)
| Maximum number of characters that may be entered in this field. |
maxResults | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Maximum number of results to be displayed. Default is unlimited. |
minQueryLength | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Number of characters to be typed before starting to query. Default is 1. |
moreText | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| The text shown in panel when the suggested list is greater than maxResults. |
multiple | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| No Description |
my | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Position of panel with respect to input Default is "left top". |
onblur | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when input element loses focus. |
onchange | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when input element loses focus and its value has been modified since gaining focus. |
onclick | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when input element is clicked. |
oncontextmenu | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a context menu is triggered. |
oncopy | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when the user cuts the content of an element. |
oncut | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when the user copies the content of an element. |
ondblclick | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when input element is double clicked. |
ondrag | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when an element is dragged. |
ondragend | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute at the end of a drag operation. |
ondragenter | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when an element has been dragged to a valid drop target. |
ondragleave | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when an element leaves a valid drop target. |
ondragover | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when an element is being dragged over a valid drop target. |
ondragstart | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute at the start of a drag operation. |
ondrop | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when dragged element is being dropped. |
onfocus | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when input element receives focus. |
oninput | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when an element gets user input. |
oninvalid | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when an element is invalid. |
onkeydown | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a key is pressed down over input element. |
onkeypress | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a key is pressed and released over input element. |
onkeyup | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a key is released over input element. |
onmousedown | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer input element is pressed down over input element. |
onmousemove | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer input element is moved within input element. |
onmouseout | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer input element is moved away from input element. |
onmouseover | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer input element is moved onto input element. |
onmouseup | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer input element is released over input element. |
onpaste | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when the user pastes some content in an element. |
onreset | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when the Reset button in a form is clicked. |
onscroll | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when an element's scrollbar is being scrolled. |
onsearch | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when the user writes something in a search field. |
onselect | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when text within input element is selected by user. |
onwheel | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when the mouse wheel rolls up or down over an element. |
panelStyle | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style of the dropdown panel container element. |
panelStyleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the dropdown panel container element. |
placeholder | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| The placeholder attribute specifies a short hint that describes the expected value of an input field. |
queryDelay | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Delay to wait in milliseconds before sending each query to the server. Default is 300. |
queryEvent | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Event to initiate the query, valid values are "keyup" and "enter". |
queryMode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Specifies query mode, valid values are "server" (default), "client" and "hybrid". |
readonly | false | jakarta.el.ValueExpression
(must evaluate to boolean)
| Flag indicating that this input element will prevent changes by the user. |
rendered | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Boolean value to specify the rendering of the component, when set to false component will not be rendered. |
required | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Marks component as required. |
requiredMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when required field validation fails. |
scrollHeight | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Defines the height of the viewport for autocomplete suggestions. |
selectLimit | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Limits the selection. Default is unlimited. |
showEmptyMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Should the empty message be displayed when no items are found? Default is true. |
size | false | jakarta.el.ValueExpression
(must evaluate to int)
| Number of characters used to determine the width of the input element. |
style | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style of the component. |
styleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the component. |
tabindex | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Position of the element in the tabbing order. |
title | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Advisory tooltip information. |
type | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Input field type. Default is text. |
unique | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Ensures uniqueness of selected items. |
validator | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.validator.Validator)
| A method expression referring to a method validating the input. |
validatorMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when validation fails. |
value | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Value of the component. |
valueChangeListener | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.event.ValueChangeListener)
| A method binding expression referring to a method for handling a valuchangeevent. |
var | false | java.lang.String | Name of the iterator used in pojo based suggestion. |
widgetVar | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the client side widget. |
Output generated by Vdldoc View Declaration Language Documentation Generator.