javax.faces.component
Class UIViewParameter

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

All Implemented Interfaces:

java.util.EventListener, EditableValueHolder, PartialStateHolder, StateHolder, ValueHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder

@JSFComponent(name="f:viewParam",
              bodyContent="JSP",
              tagClass="org.apache.myfaces.taglib.core.ViewParamTag")
@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

Version:

$Revision: 955808 $ $Date: 2010-06-17 19:58:34 -0500 (Thu, 17 Jun 2010) $

Author:

Simon Lessard (latest modification by $Author: lu4242 $)

Nested Class Summary

static class

UIViewParameter.Reference

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIInput

CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME

Fields inherited from class javax.faces.component.UIComponent

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

Constructor Summary

UIViewParameter()

Method Summary

void	decode(FacesContext context) Check the submitted form parameters for data associated with this component.
void	encodeAll(FacesContext context)
protected java.lang.Object	getConvertedValue(FacesContext context, java.lang.Object submittedValue) Convert the provided object to the desired value.
java.lang.String	getFamily()
java.lang.String	getName()
java.lang.String	getStringValue(FacesContext context)
java.lang.String	getStringValueFromModel(FacesContext context)
java.lang.String	getSubmittedValue() Gets the current submitted value.
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(java.lang.String name)
void	updateModel(FacesContext context)

Methods inherited from class javax.faces.component.UIInput

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

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

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

Methods inherited from class javax.faces.component.UIComponent

getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, 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 javax.faces.component.ValueHolder

getConverter, getLocalValue, setConverter

Field Detail

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

UIViewParameter

public UIViewParameter()

Method Detail

getFamily

public java.lang.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 java.io.IOException

Overrides:

encodeAll in class UIComponent

Throws:

java.io.IOException

getName

public java.lang.String getName()

getStringValue

public java.lang.String getStringValue(FacesContext context)

getStringValueFromModel

public java.lang.String getStringValueFromModel(FacesContext context)
                                         throws ConverterException

Throws:

ConverterException

getSubmittedValue

public java.lang.String getSubmittedValue()

Description copied from class: UIInput

Gets the current submitted value. This value, if non-null, is set by the Renderer to store a possibly invalid value for later conversion or redisplay, and has not yet been converted into the proper type for this component instance. This method should only be used by the decode() and validate() method of this component, or its corresponding Renderer; however, user code may manually set it to null to erase any submitted value.

Specified by:

getSubmittedValue in interface EditableValueHolder

Overrides:

getSubmittedValue in class UIInput

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(java.lang.String name)

updateModel

public void updateModel(FacesContext context)

Overrides:

updateModel in class UIInput

getConvertedValue

protected java.lang.Object getConvertedValue(FacesContext context,
                                             java.lang.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