JSF Implementations
UI-Component Sets
Add-ons and Extensions
Documentation
Project Documentation
Foundation

Summary

Tag name: <t:selectManyPicklist>
UIComponent class: org.apache.myfaces.custom.picklist.HtmlSelectManyPicklist
Tag class: org.apache.myfaces.custom.picklist.HtmlSelectManyPicklistTag
Component type: org.apache.myfaces.HtmlSelectManyPicklist
Component family: javax.faces.SelectMany
Renderer type: org.apache.myfaces.PicklistRenderer
Renderer class: org.apache.myfaces.custom.picklist.HtmlPicklistRenderer

A picklist component that allows to select items from one list to another

In other words, is a selection component where a set of items can be selected from a list that contains all the available items to a list that contains the selected items.

The component is based on the t:selectManyListbox component, so it contains the same attributes. Soon, more specific attributes will be added.

Usage

<t:selectManyPicklist [ Standard selectManyListbox attributes ] />

Instructions

see picklist.jsf for an example.

Supported Listeners

Name Listener Event Phases Required Description
$listener.isRequired()

Attributes

Name Type Supports EL? Description
accesskey String Yes HTML: Sets the access key for this element.
addAllButtonStyle String Yes CSS style to be applied to the add all button
addAllButtonStyleClass String Yes CSS styleClass to be applied to the add all button
addAllButtonText String Yes Define the text that goes inside the add all button
addButtonStyle String Yes CSS style to be applied to the add button
addButtonStyleClass String Yes CSS styleClass to be applied to the add button
addButtonText String Yes Define the text that goes inside the add button
binding org.apache.myfaces.custom.picklist.HtmlSelectManyPicklist Only EL Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind " + "to this component instance. This value must be an EL expression.
collectionType String Yes
converter javax.faces.convert.Converter Yes An expression that specifies the Converter for this component.

The value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface.

converterMessage String Yes Text to be displayed to the user as an error message when conversion of a submitted value to the target type fails.

datafld String Yes Reserved for future use.
dataformatas String Yes Reserved for future use.
datasrc String Yes Reserved for future use.
dir String Yes HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
disabled boolean Yes HTML: When true, this element cannot receive focus.
disabledClass String Yes The CSS class assigned to the label element for enabled choices.
displayValueOnly Boolean Yes If true, renders only the value of the component, but no input widget. Default is false.
displayValueOnlyStyle String Yes Style used when displayValueOnly is true.
displayValueOnlyStyleClass String Yes Style class used when displayValueOnly is true.
enabledClass String Yes The CSS class assigned to the label element for enabled choices.
enabledOnUserRole String Yes If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.
escape boolean Yes Indicates whether rendered markup should be escaped. Default: true
forceId boolean No If true, this component will force the use of the specified id when rendering.
forceIdIndex boolean No If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)
hideNoSelectionOption boolean Yes
id String Yes Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view.
immediate boolean Yes A boolean value that identifies the phase during which action events should fire.

During normal event processing, action methods and action listener methods are fired during the "invoke application" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase.

label String Yes A display name for this component.
lang String Yes HTML: The base language of this document.
onblur String Yes HTML: Specifies a script to be invoked when the element loses focus.
onchange String Yes HTML: Specifies a script to be invoked when the element is modified.
onclick String Yes HTML: Script to be invoked when the element is clicked.
ondblclick String Yes HTML: Script to be invoked when the element is double-clicked.
onfocus String Yes HTML: Specifies a script to be invoked when the element receives focus.
onkeydown String Yes HTML: Script to be invoked when a key is pressed down over this element.
onkeypress String Yes HTML: Script to be invoked when a key is pressed over this element.
onkeyup String Yes HTML: Script to be invoked when a key is released over this element.
onmousedown String Yes HTML: Script to be invoked when the pointing device is pressed over this element.
onmousemove String Yes HTML: Script to be invoked when the pointing device is moved while it is in this element.
onmouseout String Yes HTML: Script to be invoked when the pointing device is moves out of this element.
onmouseover String Yes HTML: Script to be invoked when the pointing device is moved into this element.
onmouseup String Yes HTML: Script to be invoked when the pointing device is released over this element.
onselect String Yes HTML: Specifies a script to be invoked when the element is selected.
readonly boolean Yes HTML: When true, indicates that this component cannot be modified by the user. The element may receive focus unless it has also been disabled.
removeAllButtonStyle String Yes CSS style to be applied to the remove all button
removeAllButtonStyleClass String Yes CSS styleClass to be applied to the remove all button
removeAllButtonText String Yes Define the text that goes inside the remove all button
removeButtonStyle String Yes CSS style to be applied to the remove button
removeButtonStyleClass String Yes CSS styleClass to be applied to the remove button
removeButtonText String Yes Define the text that goes inside the remove button
rendered boolean Yes A boolean value that indicates whether this component should be rendered. Default value: true.
required boolean Yes A boolean value that indicates whether an input value is required.

If this value is true and no input value is provided by a postback operation, then the "requiredMessage" text is registered as a FacesMessage for the request, and validation fails.

Default value: false.

requiredMessage String Yes Text to be displayed to the user as an error message when this component is marked as "required" but no input data is present during a postback (ie the user left the required field blank).
size int Yes see JSF Spec.
style String Yes HTML: CSS styling instructions.
styleClass String Yes The CSS class for this element. Corresponds to the HTML 'class' attribute.
tabindex String Yes HTML: Specifies the position of this element within the tab order of the document.
title String Yes HTML: An advisory title for this element. Often used by the user agent as a tooltip.
validator javax.faces.el.MethodBinding Only EL A method-binding EL expression which is invoked during the validation phase for this component.

The invoked method is expected to check the submitted value for this component, and if not acceptable then report a validation error for the component.

The method is expected to have the prototype

public void aMethod(FacesContext, UIComponent,Object)
validatorMessage String Yes Text which will be shown if validation fails.
value Object Yes Gets The initial value of this component.
valueChangeListener javax.faces.el.MethodBinding Only EL A method which is invoked during postback processing for the current view if the submitted value for this component is not equal to the value which the "value" expression for this component returns.

The phase in which this method is invoked can be controlled via the immediate attribute.

valueType String Yes Specifies the value type of the selectable items. This attribute is similar to the collectionType attribute introduced in JSF 2.0. It can be used to declare the type of the selectable items when using a Collection to store the values in the managed bean, because it is not possible in Java to get the value type of a type-safe Collection (in contrast to arrays where this is possible).
visibleOnUserRole String Yes If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.