| Info | Value |
|---|---|
| Component Type | org.primefaces.component.PickList |
| Handler Class | None |
| Renderer Type | org.primefaces.component.PickListRenderer |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
id | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer. |
rendered | false | javax.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. |
binding | false | javax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| An el expression referring to a server side UIComponent instance in a backing bean. |
value | false | javax.el.ValueExpression
(must evaluate to java.lang.Object)
| Value of the component. |
converter | false | javax.el.ValueExpression
(must evaluate to java.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. |
immediate | false | javax.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. |
required | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Marks component as required. |
validator | false | javax.el.ValueExpression
(must evaluate to javax.faces.validator.Validator)
| A method expression referring to a method validationg the input. |
valueChangeListener | false | javax.el.ValueExpression
(must evaluate to javax.faces.event.ValueChangeListener)
| A method binding expression referring to a method for handling a valuchangeevent. |
requiredMessage | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when required field validation fails. |
converterMessage | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when conversion fails. |
validatorMessage | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when validation fails. |
widgetVar | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the client side widget. |
var | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the iterator. |
itemLabel | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Label of an item. |
itemValue | false | javax.el.ValueExpression
(must evaluate to java.lang.Object)
| Value of an item. |
style | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Style of the main container. |
styleClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the main container. |
disabled | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Disables the component. |
effect | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the animation to display. Default is fade. |
effectSpeed | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Speed of the animation. Default is fast. |
escape | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if labels of the component are escaped or not. |
addLabel | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Text of add button. Default is "Add". |
addAllLabel | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Text of add all button. Default is "Add All". |
removeLabel | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Text of remove button. Default is "Remove". |
removeAllLabel | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Text of remove all button. Default is "Remove All". |
moveUpLabel | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Text of move up button. Default is "Move Up". |
moveTopLabel | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Text of move top button. Default is "Move Top". |
moveDownLabel | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Text of move down button. Default is "Move Down". |
moveBottomLabel | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Text of move bottom button. Default is "Move Down". |
showSourceControls | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Specifies visibility of reorder buttons of sourcelist. Default is false. |
showTargetControls | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Specifies visibility of reorder buttons of target list. Default is false. |
onTransfer | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when an item is transferred from one list to another. |
label | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| A localized user presentable name. |
itemDisabled | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Specifies if an item can be picked or not. |
showSourceFilter | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Displays an input filter for source list. |
showTargetFilter | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Displays an input filter for target list. |
filterMatchMode | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Match mode for filtering, valid values are startsWith (default), contains, endsWith and custom. |
filterFunction | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side function to use in custom filterMatchMode. |
showCheckbox | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When true, a checkbox is displayed next to each item. |
labelDisplay | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Defines how the button labels displayed, valid values are "tooltip" (default) and "inline". |
orientation | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Displays lists horizontally, valid values are "horizontal" (default) and "vertical". |
responsive | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| In responsive mode, component adjusts itself based on screen width. |
tabindex | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Position of the element in the tabbing order. |
filterEvent | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side event to invoke picklist filtering for input fields. Default is keyup. |
filterDelay | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Delay to wait in milliseconds before sending each filter query. Default is 300. |
escapeValue | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines if values of the component are escaped or not. |
Output generated by Vdldoc View Declaration Language Documentation Generator.