Top Description Inners Fields Constructors Methods
jakarta.faces.component

public Class UIOutput

extends UIComponentBase
implements ValueHolder
Class Inheritance
All Implemented Interfaces
jakarta.faces.component.ValueHolder
Known Direct Subclasses
jakarta.faces.component.UIInput, jakarta.faces.component.html.HtmlOutputLink, jakarta.faces.component.html.HtmlHead, jakarta.faces.component.html.HtmlBody, jakarta.faces.component.html.HtmlDoctype, jakarta.faces.component.html.HtmlOutputLabel, jakarta.faces.component.html.HtmlOutputFormat, jakarta.faces.component.html.HtmlOutputText, jakarta.faces.component.UIOutcomeTarget
Imports
jakarta.faces.context.FacesContext, jakarta.faces.convert.Converter

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:

By default, the rendererType property must be set to "jakarta.faces.Text". This value can be changed by calling the setRendererType() method.

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static enum
UIOutput.PropertyKeys

Field Summary

Modifier and TypeField and Description
public static final String
COMPONENT_FAMILY

The standard component family for this component.

public static final String
COMPONENT_TYPE

The standard component type for this component.

private Converter<?>
converter

private static final String
FORCE_FULL_CONVERTER_STATE

Constructor Summary

AccessConstructor and Description
public
UIOutput()

Create a new UIOutput instance with default property values.

Method Summary

Modifier and TypeMethod and Description
public void
clearInitialState()

Overrides jakarta.faces.component.UIComponentBase.clearInitialState.

Implements jakarta.faces.component.PartialStateHolder.clearInitialState.

For each of the attached objects on this instance that implement PartialStateHolder, call PartialStateHolder#clearInitialState on the attached object.

public Converter<T>
getConverter()

Implements jakarta.faces.component.ValueHolder.getConverter.

Return the Converter (if any) that is registered for this UIComponent.

public String
getFamily()

Implements abstract jakarta.faces.component.UIComponent.getFamily.

Return the identifier of the component family to which this component belongs.

public Object
getLocalValue()

Implements jakarta.faces.component.ValueHolder.getLocalValue.

Return the local value of this UIComponent (if any), without evaluating any associated ValueExpression.

public Object
getValue()

Implements jakarta.faces.component.ValueHolder.getValue.

Return the value property.

public void
markInitialState()

Overrides jakarta.faces.component.UIComponentBase.markInitialState.

Implements jakarta.faces.component.PartialStateHolder.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 jakarta.faces.component.PartialStateHolder#markInitialState() on it.

public void
resetValue()

Convenience method to reset this component's value to the un-initialized state.

public void
restoreState(FacesContext
the Faces context.
context, Object
the state.
state)

Overrides jakarta.faces.component.UIComponentBase.restoreState.

Implements jakarta.faces.component.StateHolder.restoreState.

Perform any processing required to restore the state from the entries in the state Object.

public Object
saveState(FacesContext
the Faces context.
context)

Overrides jakarta.faces.component.UIComponentBase.saveState.

Implements jakarta.faces.component.StateHolder.saveState.

Gets the state of the instance as a Serializable Object.

public void
setConverter(Converter<T>
New Converter (or null)
converter)

Implements jakarta.faces.component.ValueHolder.setConverter.

Set the Converter (if any) that is registered for this UIComponent.

public void
setValue(Object
The new local value
value)

Implements jakarta.faces.component.ValueHolder.setValue.

Set the value of this UIComponent (if any).

Inherited from jakarta.faces.component.UIComponentBase:
addClientBehavioraddFacesListenerbroadcastdecodeencodeBeginencodeChildrenencodeEndfindComponentgetAttributesgetChildCountgetChildrengetClientBehaviorsgetClientIdgetDefaultEventNamegetDescriptorMapgetEventNamesgetFacesContextgetFacesListenersgetFacetgetFacetCountgetFacetsgetFacetsAndChildrengetIdgetListenersForEventClassgetParentgetPassThroughAttributesgetRenderergetRendererTypegetRendersChildreninvokeOnComponentisRenderedisTransientprocessDecodesprocessRestoreStateprocessSaveStateprocessUpdatesprocessValidatorsqueueEventremoveFacesListenerrestoreAttachedStatesaveAttachedStatesetIdsetParentsetRenderedsetRendererTypesetTransientsubscribeToEventunsubscribeFromEvent

Field Detail

COMPONENT_FAMILYback to summary
public static final String COMPONENT_FAMILY

The standard component family for this component.

COMPONENT_TYPEback to summary
public static final String COMPONENT_TYPE

The standard component type for this component.

converterback to summary
private Converter<?> converter
FORCE_FULL_CONVERTER_STATEback to summary
private static final String FORCE_FULL_CONVERTER_STATE

Constructor Detail

UIOutputback to summary
public UIOutput()

Create a new UIOutput instance with default property values.

Method Detail

clearInitialStateback to summary
public void clearInitialState()

Overrides jakarta.faces.component.UIComponentBase.clearInitialState.

Implements jakarta.faces.component.PartialStateHolder.clearInitialState.

Doc from jakarta.faces.component.UIComponentBase.clearInitialState.

For each of the attached objects on this instance that implement PartialStateHolder, call PartialStateHolder#clearInitialState on the attached object.

Annotations
@Override
getConverterback to summary
public Converter<T> getConverter()

Implements jakarta.faces.component.ValueHolder.getConverter.

Doc from jakarta.faces.component.ValueHolder.getConverter.

Return the Converter (if any) that is registered for this UIComponent.

Returns:Converter<T>

the converter.

Annotations
@Override
getFamilyback to summary
public String getFamily()

Implements abstract jakarta.faces.component.UIComponent.getFamily.

Doc from jakarta.faces.component.UIComponent.getFamily.

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. Note this method should NOT return null

Returns:String

the component family (not null).

Annotations
@Override
getLocalValueback to summary
public Object getLocalValue()

Implements jakarta.faces.component.ValueHolder.getLocalValue.

Doc from jakarta.faces.component.ValueHolder.getLocalValue.

Return the local value of this UIComponent (if any), without evaluating any associated ValueExpression.

Returns:Object

the local value.

Annotations
@Override
getValueback to summary
public Object getValue()

Implements jakarta.faces.component.ValueHolder.getValue.

Return the value property.

Returns:Object

Doc from jakarta.faces.component.ValueHolder.getValue.

the value.

Annotations
@Override
Since
2.2
markInitialStateback to summary
public void markInitialState()

Overrides jakarta.faces.component.UIComponentBase.markInitialState.

Implements jakarta.faces.component.PartialStateHolder.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 jakarta.faces.component.PartialStateHolder#markInitialState() on it.

Annotations
@Override
resetValueback to summary
public void resetValue()

Convenience method to reset this component's value to the un-initialized state.

Since
2.2
restoreStateback to summary
public void restoreState(FacesContext context, Object state)

Overrides jakarta.faces.component.UIComponentBase.restoreState.

Implements jakarta.faces.component.StateHolder.restoreState.

Doc from jakarta.faces.component.StateHolder.restoreState.

Perform any processing required to restore the state from the entries in the state Object.

If the class that implements this interface has references to instances that also implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the restoreState method on all those instances as well.

If the state argument is null, take no action and return.

Parameters
context:FacesContext

the Faces context.

state:Object

the state.

Annotations
@Override
saveStateback to summary
public Object saveState(FacesContext context)

Overrides jakarta.faces.component.UIComponentBase.saveState.

Implements jakarta.faces.component.StateHolder.saveState.

Doc from jakarta.faces.component.StateHolder.saveState.

Gets the state of the instance as a Serializable Object.

If the class that implements this interface has references to instances that implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the saveState method on all those instances as well. This method must not save the state of children and facets. That is done via the jakarta.faces.application.StateManager

This method must not alter the state of the implementing object. In other words, after executing this code: 


Object state = component.saveState(facesContext);

component should be the same as before executing it.

The return from this method must be Serializable

Parameters
context:FacesContext

the Faces context.

Returns:Object

the saved state.

Annotations
@Override
setConverterback to summary
public void setConverter(Converter<T> converter)

Implements jakarta.faces.component.ValueHolder.setConverter.

Doc from jakarta.faces.component.ValueHolder.setConverter.

Set the Converter (if any) that is registered for this UIComponent.

Parameters
converter:Converter<T>

New Converter (or null)

Annotations
@Override
setValueback to summary
public void setValue(Object value)

Implements jakarta.faces.component.ValueHolder.setValue.

Doc from jakarta.faces.component.ValueHolder.setValue.

Set the value of this UIComponent (if any).

Parameters
value:Object

The new local value

Annotations
@Override
jakarta.faces.component back to summary

pack-priv final Enum UIOutput.PropertyKeys

extends Enum<UIOutput.PropertyKeys>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final UIOutput.PropertyKeys
converter

public static final UIOutput.PropertyKeys
value

Constructor Summary

AccessConstructor and Description
private
PropertyKeys()

Method Summary

Modifier and TypeMethod and Description
public static UIOutput.PropertyKeys
valueOf(String name)

public static UIOutput.PropertyKeys[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

converterback to summary
public static final UIOutput.PropertyKeys converter
valueback to summary
public static final UIOutput.PropertyKeys value

Constructor Detail

PropertyKeysback to summary
private PropertyKeys()

Method Detail

valueOfback to summary
public static UIOutput.PropertyKeys valueOf(String name)
valuesback to summary
public static UIOutput.PropertyKeys[] values()