javax.faces.component: public class: UIOutput

javax.faces.component
public class: UIOutput [javadoc | source]

java.lang.Object
   javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
         javax.faces.component.UIOutput

All Implemented Interfaces:
ValueHolder, PartialStateHolder, ComponentSystemEventListener, SystemEventListenerHolder

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:

If the current value is not null, and is not already a String, locate a Converter (if any) to use for the conversion, as follows:
- If getConverter() returns a non-null Converter , use that one, otherwise
- If Application.createConverter(Class), passing the current value's class, returns a non-null Converter , use that one.
If the current value is not null and a Converter was located, call its getAsString() method to perform the conversion.
If the current value is not 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.

Nested Class Summary:
enum class	UIOutput.PropertyKeys

Field Summary
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.

Fields inherited from javax.faces.component.UIComponent:
CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, BEANINFO_KEY, FACETS_KEY, VIEW_LOCATION_KEY, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, attributesThatAreSet, stateHelper, compositeParent, bindings, initialState, listenersByEventClass

Constructor:
public UIOutput() { super(); setRendererType("javax.faces.Text"); } Create a new UIOutput instance with default property values.

Constructor:

 public UIOutput() {
        super();
        setRendererType("javax.faces.Text");
}

Create a new UIOutput instance with default property values.

Method from javax.faces.component.UIOutput Summary:
clearInitialState, getConverter, getFamily, getLocalValue, getValue, markInitialState, restoreState, saveState, setConverter, setValue

Methods from javax.faces.component.UIComponentBase:
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getDescriptorMap, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods from javax.faces.component.UIComponentBase:

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getDescriptorMap, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods from javax.faces.component.UIComponent:
addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getFamily, getId, getListenersForEventClass, getNamingContainer, getParent, getRenderer, getRendererType, getRendersChildren, getResourceBundleMap, getStateHelper, getStateHelper, getValueBinding, getValueExpression, initialStateMarked, invokeOnComponent, isCompositeComponent, isInView, isRendered, isVisitable, markInitialState, popComponentFromEL, processDecodes, processEvent, processRestoreState, processSaveState, processUpdates, processValidators, pushComponentToEL, queueEvent, removeFacesListener, setId, setInView, setParent, setRendered, setRendererType, setValueBinding, setValueExpression, subscribeToEvent, unsubscribeFromEvent, visitTree

Methods from javax.faces.component.UIComponent:

addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getFamily, getId, getListenersForEventClass, getNamingContainer, getParent, getRenderer, getRendererType, getRendersChildren, getResourceBundleMap, getStateHelper, getStateHelper, getValueBinding, getValueExpression, initialStateMarked, invokeOnComponent, isCompositeComponent, isInView, isRendered, isVisitable, markInitialState, popComponentFromEL, processDecodes, processEvent, processRestoreState, processSaveState, processUpdates, processValidators, pushComponentToEL, queueEvent, removeFacesListener, setId, setInView, setParent, setRendered, setRendererType, setValueBinding, setValueExpression, subscribeToEvent, unsubscribeFromEvent, visitTree

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.faces.component.UIOutput Detail:
public void clearInitialState() { if (initialStateMarked()) { super.clearInitialState(); Converter c = getConverter(); if (c != null && c instanceof PartialStateHolder) { ((PartialStateHolder) c).clearInitialState(); } } }
public Converter getConverter() { if (this.converter != null) { return (this.converter); } return (Converter) getStateHelper().eval(PropertyKeys.converter); }
public String getFamily() { return (COMPONENT_FAMILY); }
public Object getLocalValue() { return getStateHelper().get(PropertyKeys.value); }
public Object getValue() { return getStateHelper().eval(PropertyKeys.value); }
public void markInitialState() { super.markInitialState(); Converter c = getConverter(); if (c != null && c instanceof PartialStateHolder) { ((PartialStateHolder) c).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 javax.faces.component.PartialStateHolder#markInitialState() on it.
public void restoreState(FacesContext context, Object state) { if (context == null) { throw new NullPointerException(); } if (state == null) { return; } Object[] values = (Object[]) state; super.restoreState(context, values[0]); Object converterState = values[1]; if (converterState instanceof StateHolderSaver) { // this means full state was saved and as such // overwrite any existing converter with the saved // converter converter = (Converter) restoreAttachedState(context, converterState); } else { // apply any saved state to the existing converter if (converterState != null && converter instanceof StateHolder) { ((StateHolder) converter) .restoreState(context, converterState); } } }
public Object saveState(FacesContext context) { if (context == null) { throw new NullPointerException(); } Object[] values = (Object[]) super.saveState(context); Object converterState = null; if (converter != null) { if (!initialStateMarked()) { // we saving the full state converterState = saveAttachedState(context, converter); } else { if (converter instanceof StateHolder) { StateHolder sh = (StateHolder) converter; if (!sh.isTransient()) { converterState = ((StateHolder) converter).saveState(context); } } } } if (converterState != null \|\| values != null) { return new Object[] { values, converterState }; } return values; }
public void setConverter(Converter converter) { clearInitialState(); // we don't push the converter to the StateHelper // if it's been explicitly set (i.e. it's not a ValueExpression // reference this.converter = converter; }
public void setValue(Object value) { getStateHelper().put(PropertyKeys.value, value); }