javax.faces.component
Class UISelectMany

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              javax.faces.component.UIInput
                  javax.faces.component.UISelectMany

All Implemented Interfaces:

EditableValueHolder, StateHolder, ValueHolder

@JSFComponent(defaultRendererType="javax.faces.Listbox")
public class UISelectMany
extends UIInput

Base class for the various component classes that allow a user to select zero or more options from a set.

This is not an abstract class; java code can create an instance of this, configure its rendererType appropriately, and add it to a view. However there is no tag class for this component, ie it cannot be added directly to a page when using JSP (and other presentation technologies are expected to behave similarly). Instead, there is a family of subclasses that extend this base functionality, and they do have tag classes.

See the javadoc for this class in the JSF Specification for further details.

Field Summary

static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static String	INVALID_MESSAGE_ID

Fields inherited from class javax.faces.component.UIInput

CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID

Fields inherited from class javax.faces.component.UIComponent

bindings

Constructor Summary

UISelectMany()

Method Summary

protected boolean	compareValues(Object previous, Object value)
protected Object	getConvertedValue(FacesContext context, Object submittedValue) Convert the provided object to the desired value.
String	getFamily()
Object[]	getSelectedValues()
ValueBinding	getValueBinding(String name) Deprecated. Use getValueExpression instead
javax.el.ValueExpression	getValueExpression(String name)
void	setSelectedValues(Object[] selectedValues)
void	setValueBinding(String name, ValueBinding binding) Deprecated. Use setValueExpression instead
void	setValueExpression(String name, javax.el.ValueExpression binding)
void	validate(FacesContext context) First part is identical to super.validate except the empty condition.
protected void	validateValue(FacesContext context, Object convertedValue)

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, broadcast, decode, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, restoreState, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, setConverter

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

INVALID_MESSAGE_ID

public static final String INVALID_MESSAGE_ID

See Also:

Constant Field Values

Constructor Detail

UISelectMany

public UISelectMany()

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class UIInput

getSelectedValues

public Object[] getSelectedValues()

setSelectedValues

public void setSelectedValues(Object[] selectedValues)

getValueBinding

public ValueBinding getValueBinding(String name)

Deprecated. Use getValueExpression instead

Description copied from class: UIComponentBase

Get the named value-binding associated with this component.

Value-bindings are stored in a map associated with the component, though there is commonly a property (setter/getter methods) of the same name defined on the component itself which evaluates the value-binding when called.

Overrides:

getValueBinding in class UIComponentBase

setValueBinding

public void setValueBinding(String name,
                            ValueBinding binding)

Deprecated. Use setValueExpression instead

Description copied from class: UIComponentBase

Put the provided value-binding into a map of value-bindings associated with this component.

Overrides:

setValueBinding in class UIComponentBase

getValueExpression

public javax.el.ValueExpression getValueExpression(String name)

Overrides:

getValueExpression in class UIComponent

setValueExpression

public void setValueExpression(String name,
                               javax.el.ValueExpression binding)

Overrides:

setValueExpression in class UIComponent

compareValues

protected boolean compareValues(Object previous,
                                Object value)

Overrides:

compareValues in class UIInput

Returns:

true if Objects are different (!)

validateValue

protected void validateValue(FacesContext context,
                             Object convertedValue)

Overrides:

validateValue in class UIInput

validate

public void validate(FacesContext context)

First part is identical to super.validate except the empty condition. Second part: iterate through UISelectItem and UISelectItems and check current values against these items

Overrides:

validate in class UIInput

getConvertedValue

protected Object getConvertedValue(FacesContext context,
                                   Object submittedValue)

Description copied from class: UIInput

Convert the provided object to the desired value.

If there is a renderer for this component, then call the renderer's getConvertedValue method. While this can of course be implemented in any way the renderer desires, it typically performs exactly the same processing that this method would have done anyway (ie that described below for the no-renderer case).

Otherwise:

• If the submittedValue is not a String then just return the submittedValue unconverted.
• If there is no "value" value-binding then just return the submittedValue unconverted.
• Use introspection to determine the type of the target property specified by the value-binding, and then use Application.createConverter to find a converter that can map from String to the required type. Apply the converter to the submittedValue and return the result.

Overrides:

getConvertedValue in class UIInput