|
Java EE 5 SDK | ||||||||
| 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
public class UIOutput
UIOutput is a UIComponent that has a
value, optionally retrieved from a model tier bean via a value
expression, that is displayed to the user. The user cannot directly
modify the rendered value; it is for display purposes only.
During the Render Response phase of the request processing lifecycle, the current value of this component must be converted to a String (if it is not already), according to the following rules:
null, and is not already
a String, locate a Converter (if any) to use
for the conversion, as follows:
null and a Converter
was located, call its getAsString() method to perform
the conversion.null but no Converter
was located, call toString() on the current value to perform
the conversion.By default, the rendererType property must be set to
"javax.faces.Text". This value can be changed by calling the
setRendererType() method.
| Field Summary | |
|---|---|
static String |
COMPONENT_FAMILY
The standard component family for this component. |
static String |
COMPONENT_TYPE
The standard component type for this component. |
| Fields inherited from class javax.faces.component.UIComponent |
|---|
bindings |
| Constructor Summary | |
|---|---|
UIOutput()
Create a new UIOutput instance with default property
values. |
|
| Method Summary | |
|---|---|
Converter |
getConverter()
Return the Converter (if any)
that is registered for this UIComponent. |
String |
getFamily()
Return the identifier of the component family to which this component belongs. |
Object |
getLocalValue()
Return the local value of this UIComponent (if any),
without evaluating any associated ValueExpression. |
Object |
getValue()
Gets the value of this UIComponent. |
void |
restoreState(FacesContext context,
Object state)
Perform any processing required to restore the state from the entries in the state Object. |
Object |
saveState(FacesContext context)
Gets the state of the instance as a Serializable Object. |
void |
setConverter(Converter converter)
Set the Converter (if any)
that is registered for this UIComponent. |
void |
setValue(Object value)
Set the value of this UIComponent (if any). |
| Methods inherited from class javax.faces.component.UIComponent |
|---|
encodeAll, getContainerClientId |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final String COMPONENT_TYPE
The standard component type for this component.
public static final String COMPONENT_FAMILY
The standard component family for this component.
| Constructor Detail |
|---|
public UIOutput()
Create a new UIOutput instance with default property
values.
| Method Detail |
|---|
public 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 UIComponentpublic Converter getConverter()
ValueHolderReturn the Converter (if any)
that is registered for this UIComponent.
getConverter in interface ValueHolderpublic void setConverter(Converter converter)
ValueHolderSet the Converter (if any)
that is registered for this UIComponent.
setConverter in interface ValueHolderconverter - New Converter (or null)public Object getLocalValue()
ValueHolderReturn the local value of this UIComponent (if any),
without evaluating any associated ValueExpression.
getLocalValue in interface ValueHolderpublic Object getValue()
ValueHolderGets the value of this UIComponent. First, consult
the local value property of this component. If
non-null return it. If null, see if we have a
ValueExpression for the value property. If
so, return the result of evaluating the property, otherwise
return null. Note that because the specification for UIComponent.setValueBinding(java.lang.String, javax.faces.el.ValueBinding) requires a
call through to UIComponent.setValueExpression(java.lang.String, javax.el.ValueExpression), legacy
tags will continue to work.
getValue in interface ValueHolderpublic void setValue(Object value)
ValueHolderSet the value of this UIComponent (if any).
setValue in interface ValueHoldervalue - The new local valuepublic Object saveState(FacesContext context)
StateHolder Gets the state of the instance as a
Serializable Object.
If the class that implements this interface has references to
instances that implement StateHolder (such as a
UIComponent with event handlers, validators, etc.)
this method must call the StateHolder.saveState(javax.faces.context.FacesContext) method on all those
instances as well. This method must not save the state
of children and facets. That is done via the StateManager
This method must not alter the state of the implementing object. In other words, after executing this code:
Object state = component.saveState(facesContext);
component should be the same as before executing
it.
The return from this method must be Serializable
saveState in interface StateHoldersaveState in class UIComponentBase
public void restoreState(FacesContext context,
Object state)
StateHolderPerform any processing required to restore the state from the entries in the state Object.
If the class that implements this interface has references to
instances that also implement StateHolder (such as a
UIComponent with event handlers, validators, etc.)
this method must call the StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object) method on all those
instances as well.
restoreState in interface StateHolderrestoreState in class UIComponentBase
|
Java EE 5 SDK | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 2006 Sun Microsystems, Inc. All rights reserved.