The <r:pickList> is a component for pick items in a list (client-side).
@author Brian Leathem| Info | Value |
|---|---|
| Component Type | org.richfaces.select.PickList |
| Display Name | None |
| Handler Class | None |
| Renderer Type | org.richfaces.select.PickListRenderer |
| Description | The <r:pickList> is a component for pick items in a list (client-side). @author Brian Leathem |
| Name | Required | Type | Description |
|---|---|---|---|
addAllText |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The text to display in the add-all button |
addText |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The text to display in the add button |
binding |
false
| javax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| The value binding expression used to wire up this component to a component property of a JavaBean class |
caption |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The text placed above the list of items |
collectionType |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Optional attribute that is a literal string that is the fully qualified class name of a concrete class that implements java.util.Collection, or an EL expression that evaluates to either 1. such a String, or 2. the Class object itself. |
columnClasses |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| columnClasses specifies a comma-delimited list of CSS style classes to apply to each column. A space separated list of classes may be specified for an individual column. If the number of classes in this list is less than the number of column children, then no class will be applied to the columns greater than the number of classes. If however the final class in the list is the `*` character, the classes will instead be applied in a repeating manner every n-fold column, where n is the order the class in this list. If there are more class names than columns, the overflow ones are ignored. |
converter |
false
| javax.el.ValueExpression
(must evaluate to javax.faces.convert.Converter)
| Converter instance registered with this component. |
converterMessage |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| A ValueExpression enabled attribute that, if present, will be used as the text of the converter message, replacing any message that comes from the converter. |
disabled |
false
| javax.el.ValueExpression
(must evaluate to boolean)
| Flag indicating that this element must never receive focus or be included in a subsequent submit. |
downBottomText |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The text to display in the move-to-bottom button |
downText |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The text to display in the move-down button |
id |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The component identifier for this component. This value must be unique within the closest parent component that is a naming container. |
immediate |
false
| javax.el.ValueExpression
(must evaluate to boolean)
| Flag indicating that this component's value must be converted and validated immediately (that is, during Apply Request Values phase), rather than waiting until Process Validations phase. |
listHeight |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The height of the list element (in pixels) |
maxListHeight |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The maximum height of the item list (in pixels). |
minListHeight |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The minimum height of the item list (in pixels). |
onadditems |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when items are removed from the source list, and added to the target list |
onblur |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when this element loses focus. |
onchange |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when the list element loses focus and its value has been modified since gaining focus. |
onclick |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is clicked over this element. |
ondblclick |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is double clicked over this element. |
onfocus |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when this element receives focus |
onkeydown |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a key is pressed down over this element. |
onkeypress |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a key is pressed and released over this element. |
onkeyup |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a key is released over this element. |
onmousedown |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is pressed down over this element. |
onmousemove |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is moved within this element. |
onmouseout |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is moved away from this element. |
onmouseover |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is moved onto this element. |
onmouseup |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is released over this element. |
onremoveitems |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when items are removed from the target list, and added to the source list |
orderable |
false
| javax.el.ValueExpression
(must evaluate to boolean)
| If "true", then the target list is orderable, and the ordering controls are displayed Default is "true" |
removeAllText |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The text to display in the remove-all button |
removeText |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The text to display in the remove button |
rendered |
false
| javax.el.ValueExpression
(must evaluate to boolean)
| Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value for this property is true. |
required |
false
| javax.el.ValueExpression
(must evaluate to boolean)
| Flag indicating that the user is required to provide a submitted value for this input component. |
requiredMessage |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| A ValueExpression enabled attribute that, if present, will be used as the text of the validation message for the "required" facility, if the "required" facility is used. |
sourceCaption |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The text placed above the source list of items |
style |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| CSS style(s) to be applied when this component is rendered. |
styleClass |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup. |
switchByClick |
false
| javax.el.ValueExpression
(must evaluate to boolean)
| if "true", then clicking an item moves it from one list to another Default is "false" |
switchByDblClick |
false
| javax.el.ValueExpression
(must evaluate to boolean)
| if "true", then double-clicking an item moves it from one list to another Default is "true" |
targetCaption |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The text placed above the target list of items |
upText |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The text to display in the move-up button |
upTopText |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The text to display in the move-to-top button |
validator |
false
| javax.el.ValueExpression
(must evaluate to javax.faces.el.MethodBinding)
| MethodExpression representing a validator method that will be called during Process Validations to perform correctness checks on the value of this component. The expression must evaluate to a public method that takes FacesContext, UIComponent, and Object parameters, with a return type of void. |
validatorMessage |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| A ValueExpression enabled attribute that, if present, will be used as the text of the validator message, replacing any message that comes from the validator. |
value |
false
| javax.el.ValueExpression
(must evaluate to java.lang.Object)
| The current value of this component. |
valueChangeListener |
false
| javax.el.ValueExpression
(must evaluate to javax.faces.el.MethodBinding)
| MethodExpression representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a |
var |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Expose the value from the value attribute under this request scoped key so that it may be referred to in EL for the value of other attributes. |
Output generated by Vdldoc View Declaration Language Documentation Generator.