h
Tag selectManyListbox

Render an HTML option list.

Decode Behavior

This section documents the decode behavior for all renderers that handle UISelectMany or UISelectOne components.

Decode Behavior forUISelectMany components

Obtain the Map from the "requestParameterValuesMap" property of theExternalContext. If the Map contains an entry for the "clientId" of the component, pass the value of the entry, cast to a String [], to thesetSubmittedValue() method of the component, which must be an EditableValueHolder. If theMap does not contain an entry, create an emptyString array and callsetSubmittedValue() with it.

Decode Behavior forUISelectOne components

Obtain the Map from the "requestParameterMap" property of the ExternalContext. If there is aMap entry for the "clientId" property of the component, pass it to the setSubmittedValue() method of the component.

Encode Behavior

Render an HTML "select" element. Render the clientId of the component as the value of the "name" attribute. If the "styleClass" attribute is specified, render its value as the value of the "class" attribute on the "select" element. If the component is a UISelectMany instance, render "multiple" as the value of the "multiple" attribute. If the "size" attribute is specified, render its value as the value of the "size" attribute. Otherwise use the number of items as the value of the "size" attribute.

Rendering the "option" elements

The only valid children of this component areUISelectItem or UISelectItems instances. Iterate over the children of this component, and accrue a list ofjavax.faces.model.SelectItem instances. If the current child is a UISelectItem create aSelectIteminstance from its itemValue, itemLabel and itemDescription properties, add it to the list. If the current child is aUISelectItems instance, call itsgetValue() method. If the result is aSelectItem bean, add it to the list. If the result is an array of SelectItem beans, add each one t othe list. If the result is a Collection ofSelectItem beans, add each one to the list. If the result isa Map, create a SelectItem bean for each entry in the Map using the key as the label, the value as the value, and null as the description. Iterate over the list of SelectItem beans. If the current element is a SelectItemGroup, render an "optgroup" element with a "label" attribute, the value of which is the "label" property from the current element, then callgetSelectItems() and render each element as below. If the current element is not a SelectItemGroup, render an "option" element. Follow the conversion rules in the spec to obtain a renderable String from the "value" property of the current element, render that as the value of the "value" atribute. Now it is time to see if the current element is the selected value. call itsgetSubmittedValue() method, casting the result to anObject [], otherwise the component must be aUISelectOne instance, call itsgetSubmittedValue() method and create an Object [] around the result. If the resultant array is non-null, we look in the array for a value that, when we pass the renderable value to its equals() method, it returnstrue, meaning the current element is selected. If the resultant array is null, if the component is aUISelectMany, call its getValue() method. If the result is a List obtain the values in the list as an array. Otherwise, the component must be aUISelectOne instance. Call itsgetValue() method, which must be an Object array. Look for an element in the resultant array that, 1. when we pass the renderable value to its equals() method, it returns true , or 2. if the renderable value is null, and there is a null element in the array, also conclude that the current element is selected. Otherwise the current element is not selected. Now, if the current value is selected, write out an HTML boolean property "selected". If the current SelectItem.isDisabled() returns true, render "disabled" as the value of the "disabled" attribute.