Package jakarta.faces.component

Class UIViewParameter

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

jakarta.faces.component.UIOutput

jakarta.faces.component.UIInput

jakarta.faces.component.UIViewParameter

All Implemented Interfaces:

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

@JSFComponent(name="f:viewParam")
@JSFJspProperty(name="maxlength",
                returnType="int",
                longDesc="The max number or characters allowed for this param")
public class UIViewParameter
extends UIInput

TODO: documentation on jsp and pld are not the same. It appear two params: maxlength and for, but no property getter and setter founded here. If maxlength is used, we can put something like this: JSFJspProperty(name = "maxlength", returnType = "java.lang.String")

Since:

2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UIViewParameter.Reference

Field Summary

Fields

Modifier and Type	Field	Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE

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, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor	Description
UIViewParameter()

Method Summary

Modifier and Type	Method	Description
void	decode(FacesContext context)	Check the submitted form parameters for data associated with this component.
void	encodeAll(FacesContext context)
protected Object	getConvertedValue(FacesContext context, Object submittedValue)	Convert the provided object to the desired value.
protected FacesContext	getFacesContext()
String	getFamily()
String	getName()
String	getStringValue(FacesContext context)
String	getStringValueFromModel(FacesContext context)
boolean	isImmediate()	A boolean value that identifies the phase during which action events should fire.
boolean	isRendered()	A boolean value that indicates whether this component should be rendered.
void	processValidators(FacesContext context)
void	setName(String name)
void	updateModel(FacesContext context)

Methods inherited from class jakarta.faces.component.UIInput

addValidator, addValueChangeListener, broadcast, clearInitialState, compareValues, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidatorMessage, getValidators, getValue, getValueChangeListeners, isEmpty, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, removeValidator, removeValueChangeListener, resetValue, restoreState, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidatorMessage, setValue, validate, validateValue

Methods inherited from class jakarta.faces.component.UIOutput

getConverter, getLocalValue, setConverter

Methods inherited from class jakarta.faces.component.UIComponentBase

addClientBehavior, addFacesListener, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, 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, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, 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_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

UIViewParameter

public UIViewParameter()

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class UIInput

decode

public void decode(FacesContext context)

Description copied from class: UIComponentBase

Check the submitted form parameters for data associated with this component. This default implementation delegates to this component's renderer if there is one, and otherwise ignores the call.

Overrides:

decode in class UIInput

encodeAll

public void encodeAll(FacesContext context)
               throws IOException

Overrides:

encodeAll in class UIComponentBase

Throws:

IOException

getName

public String getName()

getStringValue

public String getStringValue(FacesContext context)

getStringValueFromModel

public String getStringValueFromModel(FacesContext context)
                               throws ConverterException

Throws:

ConverterException

isImmediate

@JSFProperty(tagExcluded=true)
public boolean isImmediate()

Description copied from class: UIInput

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.

Specified by:

isImmediate in interface EditableValueHolder

Overrides:

isImmediate in class UIInput

isRendered

@JSFProperty(tagExcluded=true)
public boolean isRendered()

Description copied from class: UIComponentBase

A boolean value that indicates whether this component should be rendered. Default value: true.

Overrides:

isRendered in class UIComponentBase

processValidators

public void processValidators(FacesContext context)

Overrides:

processValidators in class UIInput

setName

public void setName(String name)

updateModel

public void updateModel(FacesContext context)

Overrides:

updateModel 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

getFacesContext

protected FacesContext getFacesContext()

Overrides:

getFacesContext in class UIComponentBase