Class UIComponent
- All Implemented Interfaces:
- PartialStateHolder,- StateHolder,- TransientStateHolder,- ComponentSystemEventListener,- FacesListener,- SystemEventListenerHolder,- EventListener
- Direct Known Subclasses:
- UIComponentBase
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final Stringstatic final StringConstant used in component attribute map to retrieve the BeanInfo of a composite component.Deprecated.static final StringConstant used in BeanInfo descriptor as a key for retrieve an alternate component type for create the composite base component.static final StringConstant used to define the facet inside this component that store the component hierarchy generated by a composite component implementation, and then rendered.static final StringThis constant has two usages.static final StringConstant used in component attribute map to store theLocationobject where the definition of this component is.
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionprotected abstract voidaddFacesListener(FacesListener listener) abstract voidbroadcast(FacesEvent event) voidabstract voiddecode(FacesContext context) voidencodeAll(FacesContext context) abstract voidencodeBegin(FacesContext context) abstract voidencodeChildren(FacesContext context) abstract voidencodeEnd(FacesContext context) abstract UIComponentfindComponent(String expr) abstract intabstract List<UIComponent>abstract StringgetClientId(FacesContext context) static UIComponentgetCompositeComponentParent(UIComponent component) search for the nearest parent composite component, if no parent is found it has to return null! if the component itself is null we have to return null as well!static UIComponentgetCurrentComponent(FacesContext context) static UIComponentgetCurrentCompositeComponent(FacesContext context) protected abstract FacesContextprotected abstract FacesListener[]getFacesListeners(Class clazz) abstract UIComponentintabstract Map<String,UIComponent> abstract Iterator<UIComponent>abstract Stringabstract StringgetId()getListenersForEventClass(Class<? extends SystemEvent> eventClass) abstract UIComponentReturns the parent of the component.getPassThroughAttributes(boolean create) protected abstract RenderergetRenderer(FacesContext context) abstract Stringabstract booleanprotected StateHelperprotected StateHelpergetStateHelper(boolean create) returns a delta state saving enabled state helper for the current componentgetTransientStateHelper(boolean create) jakarta.el.ValueExpressiongetValueExpression(String name) booleanbooleaninvokeOnComponent(FacesContext context, String clientId, ContextCallback callback) Invokes theinvokeContextCallbackmethod with the component, specified byclientId.static booleanisCompositeComponent(UIComponent component) booleanisInView()Indicate if this component is inside a view, or in other words is contained by an UIViewRoot instance (which represents the view).abstract booleanprotected booleanisVisitable(VisitContext context) This method indicates if a component is visitable according to the hints passed by the VisitContext parameter! This method internally is used by visitTree and if it returns false it short circuits the visitTree execution.voidvoidpopComponentFromEL(FacesContext context) abstract voidprocessDecodes(FacesContext context) voidprocessEvent(ComponentSystemEvent event) abstract voidprocessRestoreState(FacesContext context, Object state) abstract ObjectprocessSaveState(FacesContext context) abstract voidprocessUpdates(FacesContext context) abstract voidprocessValidators(FacesContext context) voidpushComponentToEL(FacesContext context, UIComponent component) abstract voidqueueEvent(FacesEvent event) protected abstract voidremoveFacesListener(FacesListener listener) voidrestoreTransientState(FacesContext context, Object state) Restore the "transient state" using the object passed as state.saveTransientState(FacesContext context) Return the object containing related "transient states".abstract voidvoidsetInView(boolean isInView) Define if the component is on the view or not.abstract voidsetParent(UIComponent parent) For Faces-framework internal use only.abstract voidsetRendered(boolean rendered) abstract voidsetRendererType(String rendererType) voidsetValueExpression(String name, jakarta.el.ValueExpression expression) voidsubscribeToEvent(Class<? extends SystemEvent> eventClass, ComponentSystemEventListener componentListener) voidunsubscribeFromEvent(Class<? extends SystemEvent> eventClass, ComponentSystemEventListener componentListener) booleanvisitTree(VisitContext context, VisitCallback callback) The visit tree method, visit tree walks over a subtree and processes the callback object to perform some operation on the subtreeMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface jakarta.faces.component.StateHolderisTransient, restoreState, saveState, setTransient
- 
Field Details- 
BEANINFO_KEYConstant used in component attribute map to retrieve the BeanInfo of a composite component.- See Also:
- 
- ViewDeclarationLanguage.getComponentMetadata(FacesContext, Resource)
- ViewDeclarationLanguage.retargetAttachedObjects(FacesContext, UIComponent, List)
- ViewDeclarationLanguage.retargetMethodExpressions(FacesContext, UIComponent)
- Application.createComponent(FacesContext, Resource)
- Constant Field Values
 
 
- 
COMPOSITE_COMPONENT_TYPE_KEYConstant used in BeanInfo descriptor as a key for retrieve an alternate component type for create the composite base component.
- 
COMPOSITE_FACET_NAMEConstant used to define the facet inside this component that store the component hierarchy generated by a composite component implementation, and then rendered. In other words, note that direct children of a component are not rendered, instead components inside this face are rendered.- See Also:
 
- 
FACETS_KEYThis constant has two usages. The first one is in component attribute map to identify the facet name under this component is child of its parent. The second one is on BeanInfo descriptor as a key for a Map<String, PropertyDescriptor> that contains metadata information defined by composite:facet tag and composite:implementation(because this one fills the facet referenced by COMPOSITE_FACET_NAME constant).- See Also:
 
- 
VIEW_LOCATION_KEYConstant used in component attribute map to store theLocationobject where the definition of this component is.- See Also:
 
- 
ATTRS_WITH_DECLARED_DEFAULT_VALUES- See Also:
 
- 
bindingsDeprecated.
 
- 
- 
Constructor Details- 
UIComponentpublic UIComponent()
 
- 
- 
Method Details- 
getAttributes
- 
getPassThroughAttributes- Returns:
- Since:
- 2.2
 
- 
getPassThroughAttributes- Parameters:
- create-
- Returns:
- A Mapinstance, ornull.
- Since:
- 2.2
 
- 
initialStateMarkedpublic boolean initialStateMarked()- Specified by:
- initialStateMarkedin interface- PartialStateHolder
- Since:
- 2.0
 
- 
invokeOnComponentpublic boolean invokeOnComponent(FacesContext context, String clientId, ContextCallback callback) throws FacesException Invokes theinvokeContextCallbackmethod with the component, specified byclientId.- Parameters:
- context-- FacesContextfor the current request
- clientId- the id of the desired- UIComponentclazz
- callback- Implementation of the- ContextCallbackto be called
- Returns:
- has component been found ?
- Throws:
- FacesException
 
- 
isCompositeComponent- Parameters:
- component-
- Returns:
- true if the component is a composite component otherwise false is returned
- Throws:
- NullPointerException- if the component is null
- Since:
- 2.0
 
- 
isInViewpublic boolean isInView()Indicate if this component is inside a view, or in other words is contained by an UIViewRoot instance (which represents the view). If this component is a UIViewRoot instance, the components "always" is on the view. By default it is false but for UIViewRoot instances is true.- Returns:
- Since:
- 2.0
 
- 
isRenderedpublic abstract boolean isRendered()
- 
markInitialStatepublic void markInitialState()- Specified by:
- markInitialStatein interface- PartialStateHolder
 
- 
isVisitableThis method indicates if a component is visitable according to the hints passed by the VisitContext parameter! This method internally is used by visitTree and if it returns false it short circuits the visitTree execution.- Parameters:
- context-
- Returns:
- Since:
- 2.0
 
- 
setValueExpression
- 
getClientId
- 
getClientId
- 
getCompositeComponentParentsearch for the nearest parent composite component, if no parent is found it has to return null! if the component itself is null we have to return null as well!- Parameters:
- component- the component to start from
- Returns:
- the parent composite component if found otherwise null
- Since:
- 2.0
 
- 
getContainerClientId- Since:
- 1.2
 
- 
getCurrentComponent- Parameters:
- context-
- Returns:
- Since:
- 2.0
 
- 
getCurrentCompositeComponent- Parameters:
- context-
- Returns:
- Since:
- 2.0
 
- 
getFamily
- 
getId
- 
getListenersForEventClass- Specified by:
- getListenersForEventClassin interface- SystemEventListenerHolder
 
- 
getNamingContainer- Returns:
- Since:
- 2.0
 
- 
setId
- 
setInViewpublic void setInView(boolean isInView) Define if the component is on the view or not.This value is set in the following conditions: - Component / Facet added: if the parent isInView = true, set it to true and all their children or facets, otherwise take no action
- Component / Facet removed: if the parent isInView = false, set it to false and all their children or facets, otherwise take no action
 - Parameters:
- isInView-
- Since:
- 2.0
 
- 
setParentFor Faces-framework internal use only. Don't call this method to add components to the component tree. Useparent.getChildren().add(child)instead.
- 
getParentReturns the parent of the component. Children can be added to or removed from a component even if this method returns null for the child.
- 
setRenderedpublic abstract void setRendered(boolean rendered) 
- 
getRendererType
- 
setRendererType
- 
getRendersChildrenpublic abstract boolean getRendersChildren()
- 
getResourceBundleMap
- 
getValueExpression
- 
getChildren
- 
getChildCountpublic abstract int getChildCount()
- 
findComponent
- 
getFacets
- 
getFacet
- 
getFacetsAndChildren
- 
broadcast- Throws:
- AbortProcessingException
 
- 
clearInitialStatepublic void clearInitialState()- Specified by:
- clearInitialStatein interface- PartialStateHolder
- Since:
- 2.0
 
- 
decode
- 
encodeBegin- Throws:
- IOException
 
- 
encodeChildren- Throws:
- IOException
 
- 
encodeEnd- Throws:
- IOException
 
- 
encodeAll- Throws:
- IOException
 
- 
addFacesListener
- 
getFacesListeners
- 
removeFacesListener
- 
queueEvent
- 
processRestoreState
- 
processDecodes
- 
processEvent- Specified by:
- processEventin interface- ComponentSystemEventListener
- Throws:
- AbortProcessingException
 
- 
processValidators
- 
processUpdates
- 
processSaveState
- 
subscribeToEventpublic void subscribeToEvent(Class<? extends SystemEvent> eventClass, ComponentSystemEventListener componentListener) 
- 
unsubscribeFromEventpublic void unsubscribeFromEvent(Class<? extends SystemEvent> eventClass, ComponentSystemEventListener componentListener) 
- 
visitTreeThe visit tree method, visit tree walks over a subtree and processes the callback object to perform some operation on the subtreethere are some details in the implementation which according to the spec have to be in place: a) before calling the callback and traversing into the subtree pushComponentToEL has to be called b) after the processing popComponentFromEL has to be performed to remove the component from the el The tree traversal optimizations are located in the visit context and can be replaced via the VisitContextFactory in the faces-config factory section - Parameters:
- context- the visit context which handles the processing details
- callback- the callback to be performed
- Returns:
- false if the processing is not done true if we can shortcut the visiting because we are done with everything
- Since:
- 2.0
 
- 
getFacesContext
- 
getRenderer
- 
getStateHelper
- 
getStateHelperreturns a delta state saving enabled state helper for the current component- Parameters:
- create- if true a state helper is created if not already existing
- Returns:
- an implementation of the StateHelper interface or null if none exists and create is set to false
 
- 
getTransientStateHelper
- 
getTransientStateHelper
- 
restoreTransientStateDescription copied from interface:TransientStateHolderRestore the "transient state" using the object passed as state. If the stateargument isnullclear any previous transient state if any and return.- Specified by:
- restoreTransientStatein interface- TransientStateHolder
- state- the object containing transient values
 
- 
saveTransientStateDescription copied from interface:TransientStateHolderReturn the object containing related "transient states". that could be used later to restore the "transient state". - Specified by:
- saveTransientStatein interface- TransientStateHolder
- Returns:
- object containing transient values
 
- 
popComponentFromEL
- 
pushComponentToEL
- 
getFacetCountpublic int getFacetCount()- Since:
- 1.2
 
 
-