public class UIOutput extends UIComponentBase implements ValueHolder
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
COMPONENT_FAMILY
The standard component family for this component.
|
static String |
COMPONENT_TYPE
The standard component type for this component.
|
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY| Constructor and Description |
|---|
UIOutput()
Create a new
UIOutput instance with default property
values. |
| Modifier and Type | Method and Description |
|---|---|
void |
clearInitialState()
For each of the attached objects on
this instance that implement |
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()
Return the value property. |
void |
markInitialState()
In addition to the actions taken in
UIComponentBase
when PartialStateHolder.markInitialState() is called,
check if the installed Converter is a PartialStateHolder and
if it is, call PartialStateHolder.markInitialState()
on it. |
void |
resetValue()
Convenience method to reset this component's value to the un-initialized state. |
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). |
addClientBehavior, addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEventencodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTreepublic 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.
public UIOutput()
Create a new UIOutput instance with default property
values.
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.
Note this method should NOT return null
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()
Return the value property.
getValue in interface ValueHolderpublic void setValue(Object value)
ValueHolderSet the value of this UIComponent (if any).
setValue in interface ValueHoldervalue - The new local valuepublic void resetValue()
Convenience method to reset this component's value to the un-initialized state.
public void markInitialState()
In addition to the actions taken in UIComponentBase
when PartialStateHolder.markInitialState() is called,
check if the installed Converter is a PartialStateHolder and
if it is, call PartialStateHolder.markInitialState()
on it.
markInitialState in interface PartialStateHoldermarkInitialState in class UIComponentBasepublic void clearInitialState()
UIComponentBaseFor each of the attached objects on
this instance that implement PartialStateHolder, call
PartialStateHolder.clearInitialState() on the attached object.
clearInitialState in interface PartialStateHolderclearInitialState in class UIComponentBasepublic 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 UIComponentBasecontext - the Faces context.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.
If the state
argument is null, take no action and return.
restoreState in interface StateHolderrestoreState in class UIComponentBasecontext - the Faces context.state - the state.Copyright © 1996-2017, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.