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 Summary
Fields Modifier and Type Field Description static String
COMPONENT_FAMILY
static String
COMPONENT_TYPE
-
Fields inherited from class jakarta.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
-
-
Constructor Summary
Constructors Constructor Description UIOutput()
Construct an instance of the UIOutput.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clearInitialState()
Converter
getConverter()
An expression that specifies the Converter for this component.String
getFamily()
Object
getLocalValue()
Object
getValue()
Gets The initial value of this component.void
markInitialState()
void
resetValue()
void
restoreState(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.Object
saveState(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.void
setConverter(Converter converter)
void
setValue(Object value)
The initial value of this component.-
Methods inherited from class jakarta.faces.component.UIComponentBase
addClientBehavior, 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.UIComponent
getClientId, 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_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
-
-
Method Detail
-
getFamily
public String getFamily()
- Specified by:
getFamily
in classUIComponent
-
getLocalValue
public Object getLocalValue()
- Specified by:
getLocalValue
in interfaceValueHolder
-
getValue
@JSFProperty public Object getValue()
Gets The initial value of this component.- Specified by:
getValue
in interfaceValueHolder
- Returns:
- the new value value
-
setValue
public void setValue(Object value)
The initial value of this component.- Specified by:
setValue
in interfaceValueHolder
-
resetValue
public 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:
getConverter
in interfaceValueHolder
-
setConverter
public void setConverter(Converter converter)
- Specified by:
setConverter
in interfaceValueHolder
-
markInitialState
public void markInitialState()
- Specified by:
markInitialState
in interfacePartialStateHolder
- Overrides:
markInitialState
in classUIComponentBase
-
clearInitialState
public void clearInitialState()
Description copied from class:UIComponent
- Specified by:
clearInitialState
in interfacePartialStateHolder
- Overrides:
clearInitialState
in classUIComponentBase
-
saveState
public Object saveState(FacesContext facesContext)
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 interfaceStateHolder
- Overrides:
saveState
in classUIComponentBase
-
restoreState
public void restoreState(FacesContext facesContext, 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 interfaceStateHolder
- Overrides:
restoreState
in classUIComponentBase
state
- is an object previously returned by the saveState method of this class.
-
-