Class Hierarchy All Classes All Fields and Methods

 

Class javax.faces.component.UIOutput

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

public class UIOutput
implements ValueHolder
extends UIComponentBase

UIOutput is a UIComponent that has a value, optionally retrieved from a model tier bean via a value binding 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.

Field Index

Field	Description
COMPONENT_FAMILY	The standard component family for this component.
COMPONENT_TYPE	The standard component type for this component.

Constructor Index

Constructor	Description
UIOutput()	Create a new UIOutput instance with default property values.

Method Index

Method	Description
Converter getConverter()
String getFamily()
Object getLocalValue()
Object getValue()
void restoreState(FacesContext, Object)
Object saveState(FacesContext)
void setConverter(Converter)
void setValue(Object)

 

Fields

 

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

The standard component family for this component.

 

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

The standard component type for this component.

 

Constructors

 

UIOutput

public UIOutput() 

Create a new UIOutput instance with default property values.

 

Methods

 

getConverter

public Converter getConverter() 

 

getFamily

public String getFamily() 

 

getLocalValue

public Object getLocalValue() 

 

getValue

public Object getValue() 

 

restoreState

public void restoreState(FacesContext context,
                         Object state) 

 

saveState

public Object saveState(FacesContext context) 

 

setConverter

public void setConverter(Converter converter) 

 

setValue

public void setValue(Object value) 

Class Hierarchy All Classes All Fields and Methods