jakarta.faces.component

Class UISelectMany

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

jakarta.faces.component.UIOutput

jakarta.faces.component.UIInput

jakarta.faces.component.UISelectMany

All Implemented Interfaces:

EditableValueHolder, PartialStateHolder, StateHolder, TransientStateHolder, ValueHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder, EventListener

Direct Known Subclasses:

HtmlSelectManyCheckbox, HtmlSelectManyListbox, HtmlSelectManyMenu

@JSFComponent(defaultRendererType="jakarta.faces.Listbox")
 @JSFJspProperty(name="hideNoSelectionOption",returnType="boolean") @JSFJspProperty(name="collectionType",returnType="java.lang.String")
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

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static String	INVALID_MESSAGE_ID

Fields inherited from class jakarta.faces.component.UIInput

ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE, CONVERSION_MESSAGE_ID, EMPTY_STRING_AS_NULL_PARAM_NAME, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME

Fields inherited from class jakarta.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
UISelectMany()

Method Summary

Modifier and Type	Method and Description
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
jakarta.el.ValueExpression	getValueExpression(String name)
void	setSelectedValues(Object[] selectedValues)
void	setValueBinding(String name, ValueBinding binding) Deprecated. Use setValueExpression instead
void	setValueExpression(String name, jakarta.el.ValueExpression binding)
protected void	validateValue(FacesContext context, Object convertedValue)

Methods inherited from class jakarta.faces.component.UIInput

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

Methods inherited from class jakarta.faces.component.UIOutput

getConverter, getLocalValue, setConverter

Methods inherited from class jakarta.faces.component.UIComponentBase

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

Methods inherited from class jakarta.faces.component.UIComponent

getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.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

@Deprecated
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

@Deprecated
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 jakarta.el.ValueExpression getValueExpression(String name)

Overrides:

getValueExpression in class UIComponent

setValueExpression

public void setValueExpression(String name,
                               jakarta.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

getConvertedValue

protected Object getConvertedValue(FacesContext context,
                                   Object submittedValue)
                            throws ConverterException

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

Throws:

ConverterException