UIOutput (Java EE 5 SDK) - Java Platform, Enterprise Edition v5.0 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

Java EE 5 SDK

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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:: HtmlOutputFormat, HtmlOutputLabel, HtmlOutputLink, HtmlOutputText, UIInput

public class UIOutput
extends UIComponentBase
implements ValueHolder
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 "javax.faces.Text". This value can be changed by calling the setRendererType() method.

Field Summary

static String COMPONENT_FAMILY
          The standard component family for this component.

static String COMPONENT_TYPE
          The standard component type for this component.

Fields inherited from class javax.faces.component.UIComponent

bindings

Constructor Summary

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

Method Summary

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()
          Gets the value of this UIComponent.

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).

Methods inherited from class javax.faces.component.UIComponentBase

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

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId

Methods inherited from class java.lang.Object

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

Field Summary
`static String`	`COMPONENT_FAMILY` The standard component family for this component.
`static String`	`COMPONENT_TYPE` The standard component type for this component.

Fields inherited from class javax.faces.component.UIComponent
`bindings`

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

Method Summary
`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()` Gets the value of this `UIComponent`.
`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).

Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression

Methods inherited from class javax.faces.component.UIComponent
`encodeAll, getContainerClientId`

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

The standard component type for this component.

See Also:: Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

The standard component family for this component.

See Also:: Constant Field Values

Constructor Detail

UIOutput

public UIOutput()

Create a new UIOutput instance with default property values.

Method Detail

getFamily

public String getFamily()

Description copied from class: UIComponent

Return 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.

Specified by:: getFamily in class UIComponent