| 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)
| When enabled, component is active.Default is true. |
alt | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Alternate textual description of the input field. |
appendTo | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Search expression to append the panel to.Default is @(body). |
ariaDescribedBy | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Identifies the element(s) that describe the object, enhancing accessibility. |
at | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Position of the panel relative to the target.Default is left bottom. |
autocomplete | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Controls browser autocomplete behavior. Possible values are 'on', 'off', and 'new-password'. |
autoHighlight | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When enabled, automatically highlights first suggestion.Default is true. |
autoSelection | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When enabled, automatically selects highlighted suggestion.Default is true. |
binding | false | jakarta.el.ValueExpression
(must evaluate to jakarta.faces.component.UIComponent)
| An EL expression referring to a server side UIComponent instance in a backing bean.Default is generated. |
cache | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When enabled, caches suggestions on client side.Default is false. |
cacheTimeout | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Timeout in milliseconds for cached suggestions.Default is 300000. |
completeEndpoint | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Endpoint URL for REST-based autocomplete. |
completeMethod | false | jakarta.el.ValueExpression
(must evaluate to jakarta.el.MethodExpression)
| MethodExpression to provide suggestions for autocomplete functionality. |
converter | false | jakarta.el.ValueExpression
(must evaluate to jakarta.faces.convert.Converter)
| EL expression resolves to a converter instance or literal converter ID defining a component converter. |
converterMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Custom 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.Default is ltr. |
disabled | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Specifies that an element should be disabled.Default is false. |
dropdown | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When enabled, shows dropdown button.Default is false. |
dropdownMode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Dropdown mode. Options: 'current', 'blank'. |
dropdownTabindex | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Tabindex for the dropdown button. |
dynamic | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When enabled, loads suggestions dynamically.Default is false. |
emptyMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when no suggestions are available. |
escape | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When enabled, escapes HTML in suggestions.Default is true. |
forceSelection | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When enabled, forces selection from suggestions.Default is false. |
groupBy | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Property to group suggestions by. |
groupByTooltip | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Tooltip text for group headers. |
highlightSelector | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| CSS selector for highlighting matched text. |
id | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer.Default is generated. |
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)
| Specifies the type of data expected in the input, aiding virtual keyboards. |
inputStyle | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style for the input element. |
inputStyleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| CSS class for the input element. |
itemLabel | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Property to use for displaying items. |
itemStyleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| CSS class for each item. |
itemtipAtPosition | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Position of the item tooltip relative to the target. |
itemtipMyPosition | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Position of the item tooltip relative to the item. |
itemValue | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Property to use for item value. |
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)
| Specifies the language of the element's content. |
lazyField | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Field name for lazy model filtering. |
lazyModel | false | jakarta.el.ValueExpression
(must evaluate to org.primefaces.model.LazyDataModel)
| LazyDataModel for lazy loading suggestions. |
maxlength | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Defines the maximum number of characters allowed in the input.Default is Integer.MIN_VALUE. |
maxResults | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Maximum number of results to display.Default is 2147483647. |
minQueryLength | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Minimum number of characters to trigger autocomplete query.Default is 1. |
moreText | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Text to display when there are more results.Default is .... |
multiple | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When enabled, allows multiple selections.Default is false. |
my | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Position of the panel relative to the input.Default is left top. |
onblur | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Fires when an element loses focus. |
onchange | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Fires when the value of an element has been changed. |
onclick | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Fires when a mouse click on the element. |
oncontextmenu | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute when the context menu is triggered. |
oncopy | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute when content is copied from the element. |
oncut | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute when content is cut from the element. |
ondblclick | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Fires when a mouse double-click on the element. |
ondrag | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute when an element is dragged. |
ondragend | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute at the end of a drag operation. |
ondragenter | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute when a dragged element enters a valid drop target. |
ondragleave | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute when a dragged element leaves a valid drop target. |
ondragover | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute when a dragged element is over a valid drop target. |
ondragstart | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute at the start of a drag operation. |
ondrop | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute when a dragged element is dropped. |
onfocus | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Fires when an element gets focus. |
oninput | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute when the element receives user input. |
oninvalid | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute when the element's value is invalid. |
onkeydown | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Fires when a user is pressing a key. |
onkeypress | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Fires when a user presses a key. |
onkeyup | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Fires when a user releases a key. |
onmousedown | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Fires when a mouse button is pressed down on an element. |
onmousemove | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Fires when the mouse pointer is moving while it is over an element. |
onmouseout | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Fires when the mouse pointer moves out of an element. |
onmouseover | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Fires when the mouse pointer moves onto an element. |
onmouseup | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Fires when a mouse button is released over an element. |
onpaste | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute when content is pasted into the element. |
onreset | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute when the form is reset. |
onscroll | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute when the element is scrolled. |
onsearch | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute when a search is performed. |
onselect | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute when text is selected. |
onwheel | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Script to execute when the mouse wheel is used. |
panelStyle | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style for the suggestions panel. |
panelStyleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| CSS class for the suggestions panel. |
placeholder | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Specifies a short hint describing the expected value of the input. |
queryDelay | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Delay in milliseconds before triggering autocomplete query.Default is 300. |
queryEvent | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Event to trigger autocomplete query. |
queryMode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Query mode. Options: 'server', 'client', 'hybrid'.Default is server. |
readonly | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Specifies that an input field is read-only.Default is false. |
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.Default is true. |
required | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Marks component as required.Default is false. |
requiredMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Custom message to display when the required validation fails. |
role | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines the role of the element for accessibility purposes. |
scrollHeight | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Maximum height in pixels before scrolling is enabled.Default is 2147483647. |
selectLimit | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Maximum number of items that can be selected.Default is 2147483647. |
showEmptyMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When enabled, shows empty message when no suggestions.Default is true. |
size | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Number of characters used to determine the width of the input element.Default is Integer.MIN_VALUE. |
style | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Specifies an inline CSS style for an element. |
styleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Specifies one or more CSS class names for an element. |
tabindex | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Specifies the tab order of an element. |
title | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Specifies extra information about an element (displayed as a tooltip). |
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)
| When enabled, prevents duplicate selections.Default is false. |
validator | false | jakarta.el.ValueExpression
(must evaluate to jakarta.faces.validator.Validator)
| A method expression referring to a method validating the input. |
validatorMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Custom 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 jakarta.faces.event.ValueChangeListener)
| A method binding expression referring to a method for handling a valuchangeevent. |
var | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the iterator variable used in itemLabel and itemValue. |
widgetVar | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the client side widget.Default is generated ('widget_' + componentClientId). |
Output generated by Vdldoc View Declaration Language Documentation Generator.