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
 
 @JSFComponent(defaultRendererType="jakarta.faces.Text") public class UIOutput extends UIComponentBase implements ValueHolder Displays a value to the user.
- 
- 
Field SummaryFields Modifier and Type Field Description static StringCOMPONENT_FAMILYstatic StringCOMPONENT_TYPE- 
Fields inherited from class jakarta.faces.component.UIComponentATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
 
- 
 - 
Constructor SummaryConstructors Constructor Description UIOutput()Construct an instance of the UIOutput.
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclearInitialState()ConvertergetConverter()An expression that specifies the Converter for this component.StringgetFamily()ObjectgetLocalValue()ObjectgetValue()Gets The initial value of this component.voidmarkInitialState()voidresetValue()voidrestoreState(FacesContext facesContext, Object state)Invoked in the "restore view" phase, this initialises this object's members from the values saved previously into the provided state object.ObjectsaveState(FacesContext facesContext)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.voidsetConverter(Converter converter)voidsetValue(Object value)The initial value of this component.- 
Methods inherited from class jakarta.faces.component.UIComponentBaseaddClientBehavior, addFacesListener, broadcast, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, visitTree
 - 
Methods inherited from class jakarta.faces.component.UIComponentgetClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
 
- 
 
- 
- 
- 
Field Detail- 
COMPONENT_TYPEpublic static final String COMPONENT_TYPE - See Also:
- Constant Field Values
 
 - 
COMPONENT_FAMILYpublic static final String COMPONENT_FAMILY - See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
getFamilypublic String getFamily() - Specified by:
- getFamilyin class- UIComponent
 
 - 
getLocalValuepublic Object getLocalValue() - Specified by:
- getLocalValuein interface- ValueHolder
 
 - 
getValue@JSFProperty public Object getValue() Gets The initial value of this component.- Specified by:
- getValuein interface- ValueHolder
- Returns:
- the new value value
 
 - 
setValuepublic void setValue(Object value) The initial value of this component.- Specified by:
- setValuein interface- ValueHolder
 
 - 
resetValuepublic void resetValue() - Since:
- 2.2
 
 - 
getConverter@JSFProperty(partialStateHolder=true) public Converter getConverter() An expression that specifies the Converter for this component.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:
- getConverterin interface- ValueHolder
 
 - 
setConverterpublic void setConverter(Converter converter) - Specified by:
- setConverterin interface- ValueHolder
 
 - 
markInitialStatepublic void markInitialState() - Specified by:
- markInitialStatein interface- PartialStateHolder
- Overrides:
- markInitialStatein class- UIComponentBase
 
 - 
clearInitialStatepublic void clearInitialState() Description copied from class:UIComponent- Specified by:
- clearInitialStatein interface- PartialStateHolder
- Overrides:
- clearInitialStatein class- UIComponentBase
 
 - 
saveStatepublic Object saveState(FacesContext facesContext) Description copied from class:UIComponentBaseInvoked 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:
- saveStatein interface- StateHolder
- Overrides:
- saveStatein class- UIComponentBase
 
 - 
restoreStatepublic void restoreState(FacesContext facesContext, Object state) Description copied from class:UIComponentBaseInvoked in the "restore view" phase, this initialises this object's members from the values saved previously into the provided state object.- Specified by:
- restoreStatein interface- StateHolder
- Overrides:
- restoreStatein class- UIComponentBase
- state- is an object previously returned by the saveState method of this class.
 
 
- 
 
-