javax.faces.component
Class UIOutput

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

All Implemented Interfaces:

StateHolder, ValueHolder

Direct Known Subclasses:

UIInput

public class UIOutput
extends UIComponentBase
implements ValueHolder

Displays a value to the user.

See the javadoc for this class in the JSF Specification for further details.

Version:

$Revision: 685669 $ $Date: 2008-08-13 15:25:49 -0500 (Wed, 13 Aug 2008) $

Author:

Manfred Geiler (latest modification by $Author: skitching $)

Field Summary

static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE

Constructor Summary

UIOutput()

Method Summary

Converter	getConverter() The value can either be a static value (ID) or an EL expression.
String	getFamily()
Object	getLocalValue()
Object	getValue() The initial value of this component.
void	restoreState(FacesContext context, Object state) Invoked in the "restore view" phase, this initialises this object's members from the values saved previously into the provided state object.
Object	saveState(FacesContext context) Invoked after the render phase has completed, this method returns an object which can be passed to the restoreState of some other instance of UIComponentBase to reset that object's state to the same values as this object currently has.
void	setConverter(Converter converter)
void	setValue(Object value)

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

UIOutput

public UIOutput()

Method Detail

getLocalValue

public Object getLocalValue()

Specified by:

getLocalValue in interface ValueHolder

getFamily

public String getFamily()

Specified by:

getFamily in class UIComponent

setConverter

public void setConverter(Converter converter)

Specified by:

setConverter in interface ValueHolder

getConverter

public Converter getConverter()

The value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface.

Specified by:

getConverter in interface ValueHolder

setValue

public void setValue(Object value)

Specified by:

setValue in interface ValueHolder

getValue

public Object getValue()

The initial value of this component. This value is generally set as a value-binding in the form #{myBean.myProperty}, where myProperty can be any data-type of Java (also user-defined data-types), if a converter for this data-type exists. Special cases: 1) f:selectItems - value needs to bind to a list (or an array) of javax.faces.model.SelectItem-instances 2) components implementing UISelectMany (e.g. h:selectManyCheckbox) - value needs to bind to a list (or an array) of values, where the values need to be of the same data-type as the choices of the associated f:selectItems-component 3) components implementing UIData (e.g. h:dataTable) - value needs to bind to a list (or an array) of values, which will be iterated over when the data-table is processed

Specified by:

getValue in interface ValueHolder

saveState

public Object saveState(FacesContext context)

Description copied from class: UIComponentBase

Invoked after the render phase has completed, this method returns an object which can be passed to the restoreState of some other instance of UIComponentBase to reset that object's state to the same values as this object currently has.

Specified by:

saveState in interface StateHolder

Overrides:

saveState in class UIComponentBase

restoreState

public void restoreState(FacesContext context,
                         Object state)

Description copied from class: UIComponentBase

Invoked in the "restore view" phase, this initialises this object's members from the values saved previously into the provided state object.

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class UIComponentBase

state - is an object previously returned by the saveState method of this class.