javax.faces.component
Class UIViewParameter

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by javax.faces.component.UIInput
                  extended by javax.faces.component.UIViewParameter
All Implemented Interfaces:
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: 1393568 $ $Date: 2012-10-03 10:52:53 -0500 (Wed, 03 Oct 2012) $
Author:
Simon Lessard (latest modification by $Author: lu4242 $)

Nested Class Summary
static class UIViewParameter.Reference
           
 
Field Summary
static String COMPONENT_FAMILY
           
static 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  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)
           
 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(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, 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 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

getSubmittedValue

public 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(String name)

updateModel

public void updateModel(FacesContext context)
Overrides:
updateModel 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:

Overrides:
getConvertedValue in class UIInput

getFacesContext

protected FacesContext getFacesContext()
Overrides:
getFacesContext in class UIComponentBase


Copyright © 2014 The Apache Software Foundation. All Rights Reserved.