Module jakarta.faces
Package jakarta.faces.component

Class UIOutput

java.lang.Object
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
jakarta.faces.component.UIOutput
All Implemented Interfaces:
PartialStateHolder, StateHolder, TransientStateHolder, ValueHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder, EventListener
Direct Known Subclasses:
HtmlBody, HtmlDoctype, HtmlHead, HtmlOutputFormat, HtmlOutputLabel, HtmlOutputLink, HtmlOutputText, UIInput, UIOutcomeTarget
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:

  • 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 "jakarta.faces.Text". This value can be changed by calling the setRendererType() method.