|
DRAFT | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIOutput
javax.faces.component.UIInput
javax.faces.component.UIViewParameter
public class UIViewParameter
UIViewParameter represents a
binding between a request parameter and a model property or UIViewRoot
property. This is a bi-directional binding.
The ViewDeclarationLanguage
implementation must cause an instance of this component to appear in
the view for each occurrence of an <f:viewParam />
element placed inside of an <f:metadata />
element. The user must place this facet within the
UIViewRoot.
Because this class extends UIInput any actions that
one would normally take on a UIInput instance are valid
for instances of this class. Instances of this class participate in
the regular JSF lifecycle, including on Ajax requests.
| Nested Class Summary | |
|---|---|
static class |
UIViewParameter.Reference
Inner class to encapsulate a
|
| Field Summary | |
|---|---|
static java.lang.String |
COMPONENT_FAMILY
The standard component family for this component. |
static java.lang.String |
COMPONENT_TYPE
The standard component type for this component. |
| 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()
Create a new UIViewParameter instance with default
property values. |
|
| Method Summary | |
|---|---|
void |
decode(FacesContext context)
Override behavior from superclass to
pull a value from the incoming request parameter map under the
name given by |
void |
encodeAll(FacesContext context)
Called specially by |
protected java.lang.Object |
getConvertedValue(FacesContext context,
java.lang.Object submittedValue)
Because this class has no |
java.lang.String |
getFamily()
Return the identifier of the component family to which this component belongs. |
java.lang.String |
getName()
Return the request parameter name from which the value is retrieved. |
java.lang.String |
getStringValue(FacesContext context)
If the value of this parameter comes
from a |
java.lang.String |
getStringValueFromModel(FacesContext context)
Manually perform standard conversion steps to get a string value from the value expression. |
java.lang.String |
getSubmittedValue()
Assume that the submitted value is always a string. |
boolean |
isImmediate()
Return |
void |
processValidators(FacesContext context)
Specialize superclass behavior to treat
|
void |
setName(java.lang.String name)
Set the request parameter name from which the value is retrieved. |
void |
setSubmittedValue(java.lang.Object submittedValue)
PENDING (docs) Interesting that submitted value isn't saved by the parent |
void |
updateModel(FacesContext context)
Call through to superclass |
| Methods inherited from class javax.faces.component.UIOutput |
|---|
getConverter, getLocalValue, getValue, setConverter |
| 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, getValue, setConverter |
| Field Detail |
|---|
public static final java.lang.String COMPONENT_TYPE
The standard component type for this component.
public static final java.lang.String COMPONENT_FAMILY
The standard component family for this component.
| Constructor Detail |
|---|
public UIViewParameter()
Create a new UIViewParameter instance with default
property values.
| Method Detail |
|---|
public java.lang.String getFamily()
UIComponentReturn the identifier of the component family to which this
component belongs. This identifier, in conjunction with the value
of the rendererType property, may be used to select
the appropriate Renderer for this component instance.
getFamily in class UIInputpublic java.lang.String getName()
Return the request parameter name from which the value is retrieved.
public void setName(java.lang.String name)
Set the request parameter name from which the value is retrieved.
name - The new request parameter name.public boolean isImmediate()
Return false. The
immediate setting is not relevant for view parameters and must be
assumed to be false.
isImmediate in interface EditableValueHolderisImmediate in class UIInputpublic java.lang.String getSubmittedValue()
Assume that the submitted value is always a string.
getSubmittedValue in interface EditableValueHoldergetSubmittedValue in class UIInputpublic void setSubmittedValue(java.lang.Object submittedValue)
setSubmittedValue in interface EditableValueHoldersetSubmittedValue in class UIInputsubmittedValue - The new submitted valuepublic void decode(FacesContext context)
Override behavior from superclass to
pull a value from the incoming request parameter map under the
name given by getName() and store it with a call to UIInput#setSubmittedValue.
decode in class UIInputcontext - FacesContext for the request we are processingpublic void processValidators(FacesContext context)
Specialize superclass behavior to treat
null differently. In this class, a null value
along with the "required" flag being set to true will
cause a validation failure.
processValidators in class UIInputcontext - public void updateModel(FacesContext context)
Call through to superclass UIInput#updateModel then take the additional action of pushing
the value into request scope if and only if the value is not a
value expression, is valid, and the local value was set on this
lifecycle execution.
updateModel in class UIInputcontext - FacesContext for the request we are processing
public void encodeAll(FacesContext context)
throws java.io.IOException
Called specially by UIViewRoot#encodeEnd, this method simply sets the submitted
value to be the return from getStringValue(javax.faces.context.FacesContext).
encodeAll in class UIComponentjava.io.IOException - if an input/output error occurs while renderingpublic java.lang.String getStringValue(FacesContext context)
If the value of this parameter comes
from a ValueExpression return the value of the
expression, otherwise, return the local value.
public java.lang.String getStringValueFromModel(FacesContext context)
throws ConverterException
Manually perform standard conversion steps to get a string value from the value expression.
ConverterException
protected java.lang.Object getConvertedValue(FacesContext context,
java.lang.Object submittedValue)
throws ConverterException
Because this class has no Renderer, leverage the one from the standard HTML_BASIC RenderKit with component-family: javax.faces.Input
and renderer-type: javax.faces.Text and call its
Renderer#getConvertedValue method.
getConvertedValue in class UIInputConverterException
|
DRAFT | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright © 2009 Sun Microsystems, Inc. All Rights Reserved. Use is subject to license terms.
Generated on 24-November-2009 03:24