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 UIInputTODO: 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 SummaryNested Classes Modifier and Type Class Description static classUIViewParameter.Reference
 - 
Field SummaryFields Modifier and Type Field Description static StringCOMPONENT_FAMILYstatic StringCOMPONENT_TYPE- 
Fields inherited from class jakarta.faces.component.UIInputALWAYS_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.UIComponentATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
 
- 
 - 
Constructor SummaryConstructors Constructor Description UIViewParameter()
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description voiddecode(FacesContext context)Check the submitted form parameters for data associated with this component.voidencodeAll(FacesContext context)protected ObjectgetConvertedValue(FacesContext context, Object submittedValue)Convert the provided object to the desired value.protected FacesContextgetFacesContext()StringgetFamily()StringgetName()StringgetStringValue(FacesContext context)StringgetStringValueFromModel(FacesContext context)booleanisImmediate()A boolean value that identifies the phase during which action events should fire.booleanisRendered()A boolean value that indicates whether this component should be rendered.voidprocessValidators(FacesContext context)voidsetName(String name)voidupdateModel(FacesContext context)- 
Methods inherited from class jakarta.faces.component.UIInputaddValidator, 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.UIOutputgetConverter, getLocalValue, setConverter
 - 
Methods inherited from class jakarta.faces.component.UIComponentBaseaddClientBehavior, 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.UIComponentgetClientId, 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.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 - 
Methods inherited from interface jakarta.faces.component.ValueHoldergetConverter, getLocalValue, setConverter
 
- 
 
- 
- 
- 
Field Detail- 
COMPONENT_FAMILYpublic static final String COMPONENT_FAMILY - See Also:
- Constant Field Values
 
 - 
COMPONENT_TYPEpublic static final String COMPONENT_TYPE - See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
decodepublic void decode(FacesContext context) Description copied from class:UIComponentBaseCheck 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.
 - 
encodeAllpublic void encodeAll(FacesContext context) throws IOException - Overrides:
- encodeAllin class- UIComponentBase
- Throws:
- IOException
 
 - 
getNamepublic String getName() 
 - 
getStringValuepublic String getStringValue(FacesContext context) 
 - 
getStringValueFromModelpublic String getStringValueFromModel(FacesContext context) throws ConverterException - Throws:
- ConverterException
 
 - 
isImmediate@JSFProperty(tagExcluded=true) public boolean isImmediate() Description copied from class:UIInputA 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:
- isImmediatein interface- EditableValueHolder
- Overrides:
- isImmediatein class- UIInput
 
 - 
isRendered@JSFProperty(tagExcluded=true) public boolean isRendered() Description copied from class:UIComponentBaseA boolean value that indicates whether this component should be rendered. Default value: true.- Overrides:
- isRenderedin class- UIComponentBase
 
 - 
processValidatorspublic void processValidators(FacesContext context) - Overrides:
- processValidatorsin class- UIInput
 
 - 
setNamepublic void setName(String name) 
 - 
updateModelpublic void updateModel(FacesContext context) - Overrides:
- updateModelin class- UIInput
 
 - 
getConvertedValueprotected Object getConvertedValue(FacesContext context, Object submittedValue) throws ConverterException Description copied from class:UIInputConvert 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:
- getConvertedValuein class- UIInput
- Throws:
- ConverterException
 
 - 
getFacesContextprotected FacesContext getFacesContext() - Overrides:
- getFacesContextin class- UIComponentBase
 
 
- 
 
-