rich
Tag pickList


The <rich:pickList> is a component for selecting items from a list. Additionally, it allows for the selected items to be ordered (client-side). From the client side perspective, items are added/removed from the source list, and removed/added to the target list.

@author Brian Leathem


Tag Information
Component type org.richfaces.PickList
Tag Name rich:pickList
Renderer Type org.richfaces.PickListRenderer
Handler Class None

Attributes
Name Required Type Description
addAllText false java.lang.String The text to display in the add-all button
addText false java.lang.String The text to display in the add button
binding false javax.faces.component.UIComponent The value binding expression used to wire up this component to a component property of a JavaBean class
collectionType false 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 java.lang.String Space-separated list of CSS style class(es) to be applied to the columns of the list elements. This value must be passed through as the "class" attribute on generated markup.
converter false javax.faces.convert.Converter Converter instance registered with this component.
converterMessage false 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 boolean If "true", this component is disabled.
disabledClass false java.lang.String Space-separated list of CSS style class(es) to be applied to the list element when it is disabled. This value must be passed through as the "class" attribute on generated markup.
downBottomText false java.lang.String The text to display in the move-to-bottom button
downText false java.lang.String The text to display in the move-down button
headerClass false java.lang.String Space-separated list of CSS style class(es) to be applied to the header element. This value must be passed through as the "class" attribute on generated markup.
id false 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 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.
itemClass false java.lang.String Space-separated list of CSS style class(es) to be applied to the list items. This value must be passed through as the "class" attribute on generated markup.
listHeight false java.lang.String The height of the item list (in pixels).
listWidth false java.lang.String The width of the item list (in pixels).
maxListHeight false java.lang.String The maximum height of the item list (in pixels).
minListHeight false java.lang.String The minimum height of the item list (in pixels).
onadditems false java.lang.String Javascript code executed when items are removed from the source list, and added to the target list
onblur false java.lang.String Javascript code executed when this element loses focus.
onchange false java.lang.String Javascript code executed when the list element loses focus and its value has been modified since gaining focus.
onclick false java.lang.String Javascript code executed when a pointer button is clicked over this element.
ondblclick false java.lang.String Javascript code executed when a pointer button is double clicked over this element.
onfocus false java.lang.String Javascript code executed when this element receives focus
onkeydown false java.lang.String Javascript code executed when a key is pressed down over this element.
onkeypress false java.lang.String Javascript code executed when a key is pressed and released over this element.
onkeyup false java.lang.String Javascript code executed when a key is released over this element.
onmousedown false java.lang.String Javascript code executed when a pointer button is pressed down over this element.
onmousemove false java.lang.String Javascript code executed when a pointer button is moved within this element.
onmouseout false java.lang.String Javascript code executed when a pointer button is moved away from this element.
onmouseover false java.lang.String Javascript code executed when a pointer button is moved onto this element.
onmouseup false java.lang.String Javascript code executed when a pointer button is released over this element.
onremoveitems false java.lang.String Javascript code executed when items are removed from the target list, and added to the source list
onsourceblur false java.lang.String Javascript code executed when the source list element loses focus.
onsourceclick false java.lang.String Javascript code executed when a pointer button is clicked over the source list element .
onsourcedblclick false java.lang.String Javascript code executed when a pointer button is double clicked over the source list element .
onsourcefocus false java.lang.String Javascript code executed when the source list element receives focus.
onsourcekeydown false java.lang.String Javascript code executed when a key is pressed down over the source list element .
onsourcekeypress false java.lang.String Javascript code executed when a key is pressed and released over the source list element .
onsourcekeyup false java.lang.String Javascript code executed when a key is released over the source list element .
onsourcemousedown false java.lang.String Javascript code executed when a pointer button is pressed down over the source list element .
onsourcemousemove false java.lang.String Javascript code executed when a pointer button is moved within the source list element .
onsourcemouseout false java.lang.String Javascript code executed when a pointer button is moved away from the source list element .
onsourcemouseover false java.lang.String Javascript code executed when a pointer button is moved onto the source list element .
onsourcemouseup false java.lang.String Javascript code executed when a pointer button is released over the source list element .
ontargetblur false java.lang.String Javascript code executed when the target list element loses focus.
ontargetclick false java.lang.String Javascript code executed when a pointer button is clicked over the target list element .
ontargetdblclick false java.lang.String Javascript code executed when a pointer button is double clicked over the target list element .
ontargetfocus false java.lang.String Javascript code executed when the target list element receives focus.
ontargetkeydown false java.lang.String Javascript code executed when a key is pressed down over the target list element .
ontargetkeypress false java.lang.String Javascript code executed when a key is pressed and released over the target list element .
ontargetkeyup false java.lang.String Javascript code executed when a key is released over the target list element .
ontargetmousedown false java.lang.String Javascript code executed when a pointer button is pressed down over the target list element .
ontargetmousemove false java.lang.String Javascript code executed when a pointer button is moved within the target list element .
ontargetmouseout false java.lang.String Javascript code executed when a pointer button is moved away from the target list element .
ontargetmouseover false java.lang.String Javascript code executed when a pointer button is moved onto the target list element .
ontargetmouseup false java.lang.String Javascript code executed when a pointer button is released over the target list element .
orderable false boolean

If "true", then the target list is orderable, and the ordering controls are displayed

Default is "false"

removeAllText false java.lang.String The text to display in the remove-all button
removeText false java.lang.String The text to display in the remove button
rendered false 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 boolean Flag indicating that the user is required to provide a submitted value for this input component.
requiredMessage false 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.
selectItemClass false java.lang.String Space-separated list of CSS style class(es) to be applied to the selected list item. This value must be passed through as the "class" attribute on generated markup.
sourceCaption false java.lang.String The text placed above the source list of items
style false java.lang.String CSS style(s) to be applied when this component is rendered.
styleClass false java.lang.String Space-separated list of CSS style class(es) to be applied to this element. This value must be passed through as the "class" attribute on generated markup.
switchByClick false boolean

if "true", then clicking an item moves it from one list to another

Default is "false"

switchByDblClick false boolean

if "true", then double-clicking an item moves it from one list to another

Default is "true"

targetCaption false java.lang.String The text placed above the target list of items
upText false java.lang.String The text to display in the move-up button
upTopText false java.lang.String The text to display in the move-to-top button
validator false 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 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 java.lang.Object The current value of this component.
valueChangeListener false 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 ValueChangeEvent parameter, with a return type of void, or to a public method that takes no arguments with a return type of void. In the latter case, the method has no way of easily knowing what the new value is, but this can be useful in cases where a notification is needed that "this value changed".

var false 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 Tag Library Documentation Generator.