| Info | Value |
|---|---|
| Component Type | org.primefaces.component.PickList |
| Handler Class | None |
| Renderer Type | org.primefaces.component.PickListRenderer |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
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. |
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. |
disabled | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Disables the component. |
effect | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the animation to display. Default is fade. |
effectSpeed | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Speed of the animation. Default is fast. |
escape | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if labels of the component are escaped or not. |
escapeValue | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if values of the component are escaped or not. |
filterDelay | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Delay to wait in milliseconds before sending each filter query. Default is 300. |
filterEvent | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side event to invoke filtering. If "enter" it will only filter after ENTER key is pressed. Default is keyup. |
filterFunction | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side function to use in custom filterMatchMode. |
filterMatchMode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Match mode for filtering, valid values are startsWith (default), contains, endsWith and custom. |
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. |
itemDisabled | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Specifies if an item can be picked or not. |
itemLabel | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Label of an item. |
itemValue | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Value of an item. |
label | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| A localized user presentable name. |
labelDisplay | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines how the button labels displayed, valid values are "tooltip" (default) and "inline". |
onTransfer | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when an item is transferred from one list to another. |
orientation | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Displays lists horizontally, valid values are "horizontal" (default) and "vertical". |
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. |
responsive | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| In responsive mode, component adjusts itself based on screen width. |
showCheckbox | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When true, a checkbox is displayed next to each item. |
showSourceControls | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Specifies visibility of reorder buttons of sourcelist. Default is false. |
showSourceFilter | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Displays an input filter for source list. |
showTargetControls | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Specifies visibility of reorder buttons of target list. Default is false. |
showTargetFilter | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Displays an input filter for target list. |
sourceFilterPlaceholder | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Placeholder for the source filter input element. |
style | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style of the main container. |
styleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the main container. |
tabindex | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Position of the element in the tabbing order. |
targetFilterPlaceholder | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Placeholder for the target filter input element. |
transferOnCheckboxClick | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if items should be transfered, instead of selected, on checkbox click. This only works in combination with showCheckbox=true. Default is false. |
transferOnDblclick | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if items should be transfered on dblclick. Default is true. |
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 variable that references each element in the data set. |
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.