JSF HTML tag library.
Tag selectManyListbox


Allow the user to select zero or more items from a set of available options. This is presented as a listbox which allows multiple rows in the list to be selected simultaneously.

The set of available options is defined by adding child f:selectItem or f:selectItems components to this component.

The list is rendered as an HTML select element. The "multiple" attribute is set on the element and the size attribute is set to the provided value, defaulting to the number of items in the list if no value is provided. If the size is set to 1, then a "drop-down" list (aka "combo-box") is presented, though if this is the intention then a selectManyMenu should be used instead.

The value attribute must be a value-binding expression to a property of type List, Object array or primitive array. That "collection" is expected to contain objects of the same type as SelectItem.getValue() returns for the child SelectItem objects. On rendering, any child whose value is in the list will be selected initially. During the update phase, the property is set to contain a "collection" of values for those child SelectItem objects that are currently selected.

Unless otherwise specified, all attributes accept static values or EL expressions.


Tag Information
Tag Classorg.apache.myfaces.taglib.html.HtmlSelectManyListboxTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
idfalsefalsejava.lang.StringThe developer-assigned ID of this component. The ID must be unique within the scope of the tag's enclosing naming container (e.g. h:form or f:subview). This value must be a static value.
bindingfalsefalsejava.lang.StringIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.
renderedfalsefalsejava.lang.StringA boolean value that indicates whether this component should be rendered. Default value: true.
valuefalsefalsejava.lang.StringThe initial value of this component. This value is generally set as a value-binding in the form #{myBean.myProperty}, where myProperty can be any data-type of Java (also user-defined data-types), if a converter for this data-type exists. Special cases: 1) f:selectItems - value needs to bind to a list (or an array) of javax.faces.model.SelectItem-instances 2) components implementing UISelectMany (e.g. h:selectManyCheckbox) - value needs to bind to a list (or an array) of values, where the values need to be of the same data-type as the choices of the associated f:selectItems-component 3) components implementing UIData (e.g. h:dataTable) - value needs to bind to a list (or an array) of values, which will be iterated over when the data-table is processed
converterfalsefalsejava.lang.StringAn expression that specifies the Converter for this component. If the value binding expression is a String, the String is used as an ID to look up a Converter. If the value binding expression is a Converter, uses that instance as the converter. The value can either be a static value (ID case only) or an EL expression.
immediatefalsefalsejava.lang.StringA boolean value that identifies the phase during which value change events should fire. During normal event processing, value change events are fired during the "process validations" 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.
requiredfalsefalsejava.lang.StringA boolean value that indicates whether an input value is required. If this value is true, and no input value is provided, the error message javax.faces.component.UIInput.REQUIRED is posted.
validatorfalsefalsejava.lang.StringA method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.
valueChangeListenerfalsefalsejava.lang.StringA method binding EL expression, accepting a ValueChangeEvent parameter and returning void. The specified method is invoked if this component is modified. The phase that this handler is fired in can be controlled via the immediate attribute.
dirfalsefalsejava.lang.StringHTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
langfalsefalsejava.lang.StringHTML: The base language of this document.
stylefalsefalsejava.lang.StringHTML: CSS styling instructions.
titlefalsefalsejava.lang.StringHTML: An advisory title for this element. Often used by the user agent as a tooltip.
styleClassfalsefalsejava.lang.StringThe CSS class for this element. Corresponds to the HTML 'class' attribute.
onclickfalsefalsejava.lang.StringHTML: Script to be invoked when the element is clicked.
ondblclickfalsefalsejava.lang.StringHTML: Script to be invoked when the element is double-clicked.
onmousedownfalsefalsejava.lang.StringHTML: Script to be invoked when the pointing device is pressed over this element.
onmouseupfalsefalsejava.lang.StringHTML: Script to be invoked when the pointing device is released over this element.
onmouseoverfalsefalsejava.lang.StringHTML: Script to be invoked when the pointing device is moved into this element.
onmousemovefalsefalsejava.lang.StringHTML: Script to be invoked when the pointing device is moved while it is in this element.
onmouseoutfalsefalsejava.lang.StringHTML: Script to be invoked when the pointing device is moves out of this element.
onkeypressfalsefalsejava.lang.StringHTML: Script to be invoked when a key is pressed over this element.
onkeydownfalsefalsejava.lang.StringHTML: Script to be invoked when a key is pressed down over this element.
onkeyupfalsefalsejava.lang.StringHTML: Script to be invoked when a key is released over this element.
accesskeyfalsefalsejava.lang.StringHTML: Sets the access key for this element.
onblurfalsefalsejava.lang.StringHTML: Specifies a script to be invoked when the element loses focus.
onfocusfalsefalsejava.lang.StringHTML: Specifies a script to be invoked when the element receives focus.
onchangefalsefalsejava.lang.StringHTML: Specifies a script to be invoked when the element is modified.
onselectfalsefalsejava.lang.StringHTML: Specifies a script to be invoked when the element is selected.
tabindexfalsefalsejava.lang.StringHTML: Specifies the position of this element within the tab order of the document.
readonlyfalsefalsejava.lang.StringHTML: When true, indicates that this component cannot be modified by the user. The element may receive focus unless it has also been disabled.
disabledfalsefalsejava.lang.StringHTML: When true, this element cannot receive focus.
datafldfalsefalsejava.lang.StringReserved for future use.
datasrcfalsefalsejava.lang.StringReserved for future use.
dataformatasfalsefalsejava.lang.StringReserved for future use.
sizefalsefalsejava.lang.Stringsee JSF Spec.
enabledClassfalsefalsejava.lang.StringNo Description
disabledClassfalsefalsejava.lang.StringNo Description

Variables
No Variables Defined.


Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.