Uses of Class
jakarta.faces.component.UIComponent
Package
Description
Specialized user interface component classes for HTML.
-
Uses of UIComponent in jakarta.faces.application
Modifier and TypeMethodDescriptionApplication.createComponent
(ValueExpression componentExpression, FacesContext context, String componentType) Application.createComponent
(ValueExpression componentExpression, FacesContext context, String componentType, String rendererType) LikeApplication.createComponent(ValueExpression, FacesContext, String)
except theRenderer
for the component to be returned must be inspected for the annotations mentioned inApplication.createComponent(ValueExpression, FacesContext, String)
as specified in the documentation for that method.Application.createComponent
(FacesContext context, Resource componentResource) Application.createComponent
(FacesContext context, String componentType, String rendererType) LikeApplication.createComponent(String)
except theRenderer
for the component to be returned must be inspected for the annotations mentioned inApplication.createComponent(ValueExpression, FacesContext, String)
as specified in the documentation for that method.abstract UIComponent
Application.createComponent
(String componentType) Instantiate and return a newUIComponent
instance of the class specified by a previous call toaddComponent()
for the specified component type.ApplicationWrapper.createComponent
(ValueExpression componentExpression, FacesContext context, String componentType) The default behavior of this method is to callApplication.createComponent(jakarta.el.ValueExpression, jakarta.faces.context.FacesContext, String)
on the wrappedApplication
object.ApplicationWrapper.createComponent
(ValueExpression componentExpression, FacesContext context, String componentType, String rendererType) The default behavior of this method is to callApplication.createComponent(jakarta.el.ValueExpression, jakarta.faces.context.FacesContext, String, String)
on the wrappedApplication
object.ApplicationWrapper.createComponent
(FacesContext context, Resource componentResource) The default behavior of this method is to callApplication.createComponent(jakarta.faces.context.FacesContext, Resource)
on the wrappedApplication
object.ApplicationWrapper.createComponent
(FacesContext context, String componentType, String rendererType) The default behavior of this method is to callApplication.createComponent(jakarta.faces.context.FacesContext, String, String)
on the wrappedApplication
object.ApplicationWrapper.createComponent
(String componentType) The default behavior of this method is to callApplication.createComponent(String)
on the wrappedApplication
object. -
Uses of UIComponent in jakarta.faces.component
Modifier and TypeClassDescriptionclass
UIColumn is aUIComponent
that represents a single column of data within a parentUIData
component.class
UICommand is aUIComponent
that represents a user interface component which, when activated by the user, triggers an application specific "command" or "action".class
UIComponentBase is a convenience base class that implements the default concrete behavior of all methods defined byUIComponent
.class
UIData is aUIComponent
that supports data binding to a collection of data objects represented by aDataModel
instance, which is the current value of this component itself (typically established via aValueExpression
).class
UIForm is aUIComponent
that represents an input form to be presented to the user, and whose child components represent (among other things) the input fields to be included when the form is submitted.class
UIGraphic is aUIComponent
that displays a graphical image to the user.class
class
UIInput is aUIComponent
that represents a component that both displays output to the user (likeUIOutput
components do) and processes request parameters on the subsequent request that need to be decoded.class
This component is responsible for displaying messages for a specificUIComponent
, identified by aclientId
or component id relative to the closest ancestorNamingContainer
.class
The renderer for this component is responsible for obtaining the messages from theFacesContext
and displaying them to the user.class
UINamingContainer is a convenience base class for components that wish to implementNamingContainer
functionality.class
This component is paired with thejakarta.faces.Button
orjakarta.faces.Link
renderers and encapsulates properties relating to the rendering of outcomes directly to the response.class
UIOutput is aUIComponent
that has a value, optionally retrieved from a model tier bean via a value expression, that is displayed to the user.class
UIPanel is aUIComponent
that manages the layout of its child components.class
UIParameter is aUIComponent
that represents an optionally named configuration parameter for a parent component.class
class
UISelectItem is a component that may be nested inside aUISelectMany
orUISelectOne
component, and causes the addition of aSelectItem
instance to the list of available options for the parent component.class
UISelectItemGroup is a component that may be nested inside aUISelectMany
orUISelectOne
component, and causes the addition of oneSelectItemGroup
of one or moreSelectItem
instances to the list of available options in the parent component.class
UISelectItemGroups is a component that may be nested inside aUISelectMany
orUISelectOne
component, and causes the addition of one or moreSelectItemGroup
of one or moreSelectItem
instances to the list of available options in the parent component.class
UISelectItems is a component that may be nested inside aUISelectMany
orUISelectOne
component, and causes the addition of one or moreSelectItem
instances to the list of available options in the parent component.class
UISelectMany is aUIComponent
that represents the user's choice of a zero or more items from among a discrete set of available options.class
UISelectOne is aUIComponent
that represents the user's choice of zero or one items from among a discrete set of available options.class
UIViewAction represents a method invocation that occurs during the request processing lifecycle, usually in response to an initial request, as opposed to a postback.class
UIViewParameter represents a binding between a request parameter and a model property orUIViewRoot
property.class
UIViewRoot is the UIComponent that represents the root of the UIComponent tree.class
The<f:websocket>
tag opens an one-way (server to client) websocket based push connection in client side which can be reached from server side viaPushContext
interface injected in any CDI/container managed artifact via@
Push
annotation.Modifier and TypeMethodDescriptionabstract UIComponent
UIComponent.findComponent
(String expr) Search for and return theUIComponent
with anid
that matches the specified search expression (if any), according to the algorithm described below.UIComponentBase.findComponent
(String expression) static UIComponent
UIComponent.getCompositeComponentParent
(UIComponent component) Finds the nearest composite component parent of the specified component.static UIComponent
UIComponent.getCurrentComponent
(FacesContext context) Return theUIComponent
instance that is currently processing.static UIComponent
UIComponent.getCurrentCompositeComponent
(FacesContext context) Return the closest ancestor component, relative to the component returned fromgetCurrentComponent(jakarta.faces.context.FacesContext)
, that is a composite component, ornull
if no such component exists.abstract UIComponent
Convenience method to return the named facet, if it exists, ornull
otherwise.UIColumn.getFooter()
Return the footer facet of the column (if any).UIData.getFooter()
Return the footer facet of this component (if any).UIColumn.getHeader()
Return the header facet of the column (if any).UIData.getHeader()
Return the header facet of this component (if any).UIComponent.getNamingContainer()
Starting with "this", return the closest component in the ancestry that is aNamingContainer
ornull
if none can be found.abstract UIComponent
UIComponent.getParent()
Return the parentUIComponent
of thisUIComponent
, if any.UIComponentBase.getParent()
Modifier and TypeMethodDescriptionabstract List
<UIComponent> UIComponent.getChildren()
UIComponentBase.getChildren()
UIViewRoot.getComponentResources
(FacesContext context) Return an unmodifiable orderedList
of allUIComponent
resources of all supported targets.UIViewRoot.getComponentResources
(FacesContext context, String target) abstract Map
<String, UIComponent> UIComponent.getFacets()
Return a mutableMap
representing the facetUIComponent
s associated with thisUIComponent
, keyed by facet name (which must be a String).UIComponentBase.getFacets()
abstract Iterator
<UIComponent> UIComponent.getFacetsAndChildren()
UIComponentBase.getFacetsAndChildren()
Modifier and TypeMethodDescriptionvoid
UIViewRoot.addComponentResource
(FacesContext context, UIComponent componentResource) Add argumentcomponent
, which is assumed to represent a resource instance, as a resource to this view.void
UIViewRoot.addComponentResource
(FacesContext context, UIComponent componentResource, String target) Add argumentcomponent
, which is assumed to represent a resource instance, as a resource to this view.static UIComponent
UIComponent.getCompositeComponentParent
(UIComponent component) Finds the nearest composite component parent of the specified component.void
ContextCallback.invokeContextCallback
(FacesContext context, UIComponent target) This method will be called by an implementation ofinvokeOnComponent(jakarta.faces.context.FacesContext, java.lang.String, jakarta.faces.component.ContextCallback)
and must be passed the component with theclientId
given as an argument toinvokeOnComponent
.static boolean
UIComponent.isCompositeComponent
(UIComponent component) Returntrue
ifcomponent
is a composite component, otherwisefalse
.void
UIComponent.pushComponentToEL
(FacesContext context, UIComponent component) Push the currentUIComponent
this
to theFacesContext
attribute map saving the previousUIComponent
for a subsequent call topopComponentFromEL(jakarta.faces.context.FacesContext)
.void
UIViewRoot.removeComponentResource
(FacesContext context, UIComponent componentResource) Remove argumentcomponent
, which is assumed to represent a resource instance, as a resource to this view.void
UIViewRoot.removeComponentResource
(FacesContext context, UIComponent componentResource, String target) Remove argumentcomponent
, which is assumed to represent a resource instance, as a resource to this view.void
UIColumn.setFooter
(UIComponent footer) Set the footer facet of the column.void
UIData.setFooter
(UIComponent footer) Set the footer facet of this component.void
UIColumn.setHeader
(UIComponent header) Set the header facet of the column.void
UIData.setHeader
(UIComponent header) Set the header facet of this component.abstract void
UIComponent.setParent
(UIComponent parent) Set the parentUIComponent
of thisUIComponent
.void
UIComponentBase.setParent
(UIComponent parent) -
Uses of UIComponent in jakarta.faces.component.behavior
Modifier and TypeMethodDescriptionabstract UIComponent
ClientBehaviorContext.getComponent()
Returns theUIComponent
that is requesting theClientBehavior
script.Modifier and TypeMethodDescriptionstatic ClientBehaviorContext
ClientBehaviorContext.createClientBehaviorContext
(FacesContext context, UIComponent component, String eventName, String sourceId, Collection<ClientBehaviorContext.Parameter> parameters) Creates a ClientBehaviorContext instance.void
ClientBehavior.decode
(FacesContext context, UIComponent component) Decode any new state of thisClientBehavior
from the request contained in the specifiedFacesContext
.void
ClientBehaviorBase.decode
(FacesContext context, UIComponent component) Default implementation of ofClientBehavior.decode(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent)
. -
Uses of UIComponent in jakarta.faces.component.html
Modifier and TypeClassDescriptionclass
NONEclass
Represents a column that will be rendered in an HTMLtable
element.class
Represents an HTMLinput
element for a button of typesubmit
orreset
.class
Represents an HTMLa
element for a hyperlink that acts like a submit button.class
Represents an HTMLscript
element for a function that acts like an ajax form submit.class
Represents a set of repeating data (segregated into columns by child UIColumn components) that will be rendered in an HTMLtable
element.class
NONEclass
Represents an HTMLform
element.class
Represents an HTMLimg
element, used to retrieve and render a graphical image.class
NONEclass
Represents an HTMLinput
element of typefile
.class
Represents an HTMLinput
element of typehidden
.class
Represents an HTMLinput
element of typepassword
.class
Represents an HTMLinput
element of typetext
.class
Represents an HTMLtextarea
element.class
By default, therendererType
property must be set to "jakarta.faces.Message
".class
By default, therendererType
property must be set to "jakarta.faces.Messages
".class
Represents an HTMLinput
element of type "button" or image that may be used to link to a URL handled by the Faces Servlet resolved preemptively using the logical outcome defined by theoutcome
property.class
Represents an HTMLa
(hyperlink) element that may be used to link to a URL handled by the Faces Servlet resolved preemptively using the logical outcome defined by theoutcome
property.class
Represents a component that looks up a localized message in a resource bundle, optionally uses it as aMessageFormat
pattern string and substitutes in parameter values from nested UIParameter components, and renders the result.class
Represents an HTMLlabel
element, used to define an accessible label for a corresponding input element.class
Represents an HTMLa
(hyperlink) element that may be used to link to an arbitrary URL defined by thevalue
property.class
Renders the component value as text, optionally wrapping in aspan
element if I18N attributes, CSS styles or style classes are specified.class
Renders child components in a table, starting a new row after the specified number of columns.class
Causes all child components of this component to be rendered.class
Represents an HTMLinput
element of typecheckbox
.class
Represents a multiple-selection component that is rendered as a set of HTMLinput
elements of typecheckbox
.class
Represents a multiple-selection component that is rendered as an HTMLselect
element, showing either all available options or the specified number of options.class
Represents a multiple-selection component that is rendered as an HTMLselect
element, showing a single available option at a time.class
Represents a single-selection component that is rendered as an HTMLselect
element, showing either all available options or the specified number of options.class
Represents a single-selection component that is rendered as an HTMLselect
element, showing a single available option at a time.class
Represents a single-selection component that is rendered as a set of HTMLinput
elements of typeradio
. -
Uses of UIComponent in jakarta.faces.component.search
Modifier and TypeMethodDescriptionabstract UIComponent
SearchExpressionContext.getSource()
Returns the source / base component from which we will start to perform our search.Modifier and TypeMethodDescriptionstatic SearchExpressionContext
SearchExpressionContext.createSearchExpressionContext
(FacesContext context, UIComponent source) Creates aSearchExpressionContext
instance for use with theSearchExpressionHandler
.static SearchExpressionContext
SearchExpressionContext.createSearchExpressionContext
(FacesContext context, UIComponent source, Set<SearchExpressionHint> expressionHints, Set<VisitHint> visitHints) Creates aSearchExpressionContext
instance for use with theSearchExpressionHandler
.abstract SearchExpressionContext
SearchExpressionContextFactory.getSearchExpressionContext
(FacesContext context, UIComponent source, Set<SearchExpressionHint> expressionHints, Set<VisitHint> visitHints) Creates aSearchExpressionContext
instance for use with theSearchExpressionHandler
.void
SearchKeywordContext.invokeContextCallback
(UIComponent target) This method will be called by an implementation ofSearchKeywordResolver.resolve(jakarta.faces.component.search.SearchKeywordContext, jakarta.faces.component.UIComponent, java.lang.String)
with the resolved component for the keyword.abstract void
SearchExpressionHandler.invokeOnComponent
(SearchExpressionContext searchExpressionContext, UIComponent previous, String expression, ContextCallback callback) Resolves multipleUIComponent
s for the given expression.void
SearchExpressionHandlerWrapper.invokeOnComponent
(SearchExpressionContext searchExpressionContext, UIComponent previous, String expression, ContextCallback callback) abstract void
SearchKeywordResolver.resolve
(SearchKeywordContext searchKeywordContext, UIComponent current, String keyword) Try to resolve one or multipleUIComponent
s based on the keyword and callsSearchKeywordContext.invokeContextCallback(jakarta.faces.component.UIComponent)
for each resolved component. -
Uses of UIComponent in jakarta.faces.component.visit
Modifier and TypeMethodDescriptionabstract Collection
<String> VisitContext.getSubtreeIdsToVisit
(UIComponent component) Given aNamingContainer
component, returns the client ids of any components underneath the NamingContainer that should be visited.VisitContextWrapper.getSubtreeIdsToVisit
(UIComponent component) abstract VisitResult
VisitContext.invokeVisitCallback
(UIComponent component, VisitCallback callback) Called byUIComponent.visitTree()
to visit a single component.VisitContextWrapper.invokeVisitCallback
(UIComponent component, VisitCallback callback) VisitCallback.visit
(VisitContext context, UIComponent target) This method is called during component tree visits byVisitContext.invokeVisitCallback()
to visit the specified component. -
Uses of UIComponent in jakarta.faces.context
Modifier and TypeMethodDescriptionabstract void
ResponseWriter.startElement
(String name, UIComponent component) Write the start of an element, up to and including the element name.void
ResponseWriterWrapper.startElement
(String name, UIComponent component) The default behavior of this method is to callResponseWriter.startElement(String, jakarta.faces.component.UIComponent)
on the wrappedResponseWriter
object.void
ResponseWriter.writeText
(Object text, UIComponent component, String property) Write an object, after converting it to a String (if necessary), and after performing any escaping appropriate for the markup language being rendered.void
ResponseWriterWrapper.writeText
(Object text, UIComponent component, String property) The default behavior of this method is to callResponseWriter.writeText(Object, UIComponent, String)
on the wrappedResponseWriter
object. -
Uses of UIComponent in jakarta.faces.convert
Modifier and TypeMethodDescriptionBigDecimalConverter.getAsObject
(FacesContext context, UIComponent component, String value) BigIntegerConverter.getAsObject
(FacesContext context, UIComponent component, String value) BooleanConverter.getAsObject
(FacesContext context, UIComponent component, String value) ByteConverter.getAsObject
(FacesContext context, UIComponent component, String value) CharacterConverter.getAsObject
(FacesContext context, UIComponent component, String value) Converter.getAsObject
(FacesContext context, UIComponent component, String value) Convert the specified string value, which is associated with the specifiedUIComponent
, into a model data object that is appropriate for being stored during the Process Validations phase of the request processing lifecycle.DateTimeConverter.getAsObject
(FacesContext context, UIComponent component, String value) DoubleConverter.getAsObject
(FacesContext context, UIComponent component, String value) EnumConverter.getAsObject
(FacesContext context, UIComponent component, String value) Convert thevalue
argument to one of the enum constants of the class provided in our constructor.FloatConverter.getAsObject
(FacesContext context, UIComponent component, String value) IntegerConverter.getAsObject
(FacesContext context, UIComponent component, String value) LongConverter.getAsObject
(FacesContext context, UIComponent component, String value) NumberConverter.getAsObject
(FacesContext context, UIComponent component, String value) ShortConverter.getAsObject
(FacesContext context, UIComponent component, String value) UUIDConverter.getAsObject
(FacesContext context, UIComponent component, String value) BigDecimalConverter.getAsString
(FacesContext context, UIComponent component, Object value) BigIntegerConverter.getAsString
(FacesContext context, UIComponent component, Object value) BooleanConverter.getAsString
(FacesContext context, UIComponent component, Object value) ByteConverter.getAsString
(FacesContext context, UIComponent component, Object value) CharacterConverter.getAsString
(FacesContext context, UIComponent component, Object value) Converter.getAsString
(FacesContext context, UIComponent component, T value) Convert the specified model object value, which is associated with the specifiedUIComponent
, into a String that is suitable for being included in the response generated during the Render Response phase of the request processing lifeycle.DateTimeConverter.getAsString
(FacesContext context, UIComponent component, Object value) DoubleConverter.getAsString
(FacesContext context, UIComponent component, Object value) EnumConverter.getAsString
(FacesContext context, UIComponent component, Object value) Convert the enum constant given by thevalue
argument into a String.FloatConverter.getAsString
(FacesContext context, UIComponent component, Object value) IntegerConverter.getAsString
(FacesContext context, UIComponent component, Object value) LongConverter.getAsString
(FacesContext context, UIComponent component, Object value) NumberConverter.getAsString
(FacesContext context, UIComponent component, Object value) ShortConverter.getAsString
(FacesContext context, UIComponent component, Object value) UUIDConverter.getAsString
(FacesContext context, UIComponent component, UUID value) -
Uses of UIComponent in jakarta.faces.event
Modifier and TypeMethodDescriptionComponentSystemEvent.getComponent()
the sourceUIComponent
that sent this event.ExceptionQueuedEventContext.getComponent()
Return theUIComponent
which was being processed when the exception was thrown.FacesEvent.getComponent()
Return the sourceUIComponent
that sent this event.Modifier and TypeMethodDescriptionvoid
PostRestoreStateEvent.setComponent
(UIComponent newComponent) ModifierConstructorDescriptionActionEvent
(UIComponent component) Construct a new event object from the specified source component and action command.ActionEvent
(FacesContext facesContext, UIComponent component) Construct a new event object from the Faces context, specified source component and action command.AjaxBehaviorEvent
(UIComponent component, Behavior behavior) Construct a new event object from the specified source component and Ajax behavior.AjaxBehaviorEvent
(FacesContext facesContext, UIComponent component, Behavior behavior) Construct a new event object from the Faces context, specified source component and Ajax behavior.BehaviorEvent
(UIComponent component, Behavior behavior) Construct a new event object from the specified source component andbehavior
.BehaviorEvent
(FacesContext facesContext, UIComponent component, Behavior behavior) Construct a new event object from the Faces context, specified source component and behavior.ComponentSystemEvent
(UIComponent component) Pass the argumentcomponent
to the superclass constructor.ComponentSystemEvent
(FacesContext facesContext, UIComponent component) Pass the argumentcomponent
to the superclass constructor.ExceptionQueuedEventContext
(FacesContext context, Throwable thrown, UIComponent component) Instantiate a newExceptionQueuedEventContext
that indicates the argumentThrowable
just occurred, relevant to the argumentcomponent
.ExceptionQueuedEventContext
(FacesContext context, Throwable thrown, UIComponent component, PhaseId phaseId) Instantiate a newExceptionQueuedEventContext
that indicates the argumentThrowable
just occurred, relevant to the argumentcomponent
, during the lifecycle phasephaseId
.FacesEvent
(UIComponent component) Construct a new event object from the specified source component.FacesEvent
(FacesContext facesContext, UIComponent component) Construct a new event object from the Faces context and specified source component.PostAddToViewEvent
(UIComponent component) Instantiate a newPostAddToViewEvent
that indicates the argumentcomponent
was just added to the view.PostAddToViewEvent
(FacesContext facesContext, UIComponent component) Instantiate a newPostAddToViewEvent
that indicates the argumentcomponent
was just added to the view.PostRestoreStateEvent
(UIComponent component) Instantiate a newPostRestoreStateEvent
that indicates the argumentcomponent
just had its state restored.PostRestoreStateEvent
(FacesContext facesContext, UIComponent component) Instantiate a newPostRestoreStateEvent
that indicates the argumentcomponent
just had its state restored.PostValidateEvent
(UIComponent component) ConstructorPostValidateEvent
(FacesContext facesContext, UIComponent component) ConstructorPreRemoveFromViewEvent
(UIComponent component) Instantiate a newBeforeRemoveFromView
that indicates the argumentcomponent
is about to be removed from the view.PreRemoveFromViewEvent
(FacesContext facesContext, UIComponent component) Instantiate a newBeforeRemoveFromView
that indicates the argumentcomponent
is about to be removed from the view.PreRenderComponentEvent
(UIComponent component) Instantiate a newPreRenderComponentEvent
that indicates the argumentcomponent
is about to be rendered.PreRenderComponentEvent
(FacesContext facesContext, UIComponent component) Instantiate a newPreRenderComponentEvent
that indicates the argumentcomponent
is about to be rendered.PreValidateEvent
(UIComponent component) ConstructorPreValidateEvent
(FacesContext facesContext, UIComponent component) ConstructorValueChangeEvent
(UIComponent component, Object oldValue, Object newValue) Construct a new event object from the specified source component, old value, and new value.ValueChangeEvent
(FacesContext facesContext, UIComponent component, Object oldValue, Object newValue) Construct a new event object from the Faces context, specified source component, old value and new value. -
Uses of UIComponent in jakarta.faces.render
Modifier and TypeClassDescriptionclass
Renderer<T extends UIComponent>
A Renderer converts the internal representation ofUIComponent
s into the output stream (or writer) associated with the response we are creating for a particular request.Modifier and TypeMethodDescriptionvoid
ClientBehaviorRenderer.decode
(FacesContext context, UIComponent component, ClientBehavior behavior) Decode any new state of thisClientBehavior
from the request contained in the specifiedFacesContext
.void
RendererWrapper.decode
(FacesContext context, UIComponent component) void
RendererWrapper.encodeBegin
(FacesContext context, UIComponent component) void
RendererWrapper.encodeChildren
(FacesContext context, UIComponent component) void
RendererWrapper.encodeEnd
(FacesContext context, UIComponent component) RendererWrapper.getConvertedValue
(FacesContext context, UIComponent component, Object submittedValue) -
Uses of UIComponent in jakarta.faces.validator
Modifier and TypeMethodDescriptionvoid
BeanValidator.validate
(FacesContext context, UIComponent component, Object value) Verify that the value is valid according to the Bean Validation constraints.void
DoubleRangeValidator.validate
(FacesContext context, UIComponent component, Object value) void
LengthValidator.validate
(FacesContext context, UIComponent component, Object value) void
LongRangeValidator.validate
(FacesContext context, UIComponent component, Object value) void
MethodExpressionValidator.validate
(FacesContext context, UIComponent component, Object value) void
RegexValidator.validate
(FacesContext context, UIComponent component, Object value) Validate a String against a regular expression pattern.void
RequiredValidator.validate
(FacesContext context, UIComponent component, Object value) Verify that the converted object value is not null.void
Validator.validate
(FacesContext context, UIComponent component, T value) -
Uses of UIComponent in jakarta.faces.view
Modifier and TypeMethodDescriptionViewDeclarationLanguage.createComponent
(FacesContext context, String taglibURI, String tagName, Map<String, Object> attributes) Create a component given aViewDeclarationLanguage
specific tag library URI and tag name.ViewDeclarationLanguageWrapper.createComponent
(FacesContext context, String taglibURI, String tagName, Map<String, Object> attributes) Modifier and TypeMethodDescriptionAttachedObjectTarget.getTargets
(UIComponent topLevelComponent) Returns theList<UIComponent>
that thisAttachedObjectTarget
exposes.Modifier and TypeMethodDescriptionvoid
AttachedObjectHandler.applyAttachedObject
(FacesContext context, UIComponent parent) Take the argumentparent
and apply this attached object to it.AttachedObjectTarget.getTargets
(UIComponent topLevelComponent) Returns theList<UIComponent>
that thisAttachedObjectTarget
exposes.void
ViewDeclarationLanguage.retargetAttachedObjects
(FacesContext context, UIComponent topLevelComponent, List<AttachedObjectHandler> handlers) Assuming the component metadata for argumenttopLevelComponent
has been made available by an earlier call toViewDeclarationLanguage.getComponentMetadata(jakarta.faces.context.FacesContext, jakarta.faces.application.Resource)
, leverage the component metadata for the purpose of re-targeting attached objects from the top level composite component to the individualAttachedObjectTarget
instances inside the composite component.void
ViewDeclarationLanguageWrapper.retargetAttachedObjects
(FacesContext context, UIComponent topLevelComponent, List<AttachedObjectHandler> handlers) void
ViewDeclarationLanguage.retargetMethodExpressions
(FacesContext context, UIComponent topLevelComponent) Assuming the component metadata for argumenttopLevelComponent
has been made available by an earlier call toViewDeclarationLanguage.getComponentMetadata(jakarta.faces.context.FacesContext, jakarta.faces.application.Resource)
, leverage the component metadata for the purpose of re-targeting any method expressions from the top level component to the appropriate inner component.void
ViewDeclarationLanguageWrapper.retargetMethodExpressions
(FacesContext context, UIComponent topLevelComponent) -
Uses of UIComponent in jakarta.faces.view.facelets
Modifier and TypeMethodDescriptionComponentHandler.createComponent
(FaceletContext ctx) Subclasses that wish to take over the task of instantiating theUIComponent
instance corresponding to this tag handler my override this method to do so.Modifier and TypeMethodDescriptionvoid
CompositeFaceletHandler.apply
(FaceletContext ctx, UIComponent parent) Calls apply on any child handlers.void
DelegatingMetaTagHandler.apply
(FaceletContext ctx, UIComponent parent) The default implementation simply calls through toTagHandlerDelegate.apply(jakarta.faces.view.facelets.FaceletContext, jakarta.faces.component.UIComponent)
.abstract void
Facelet.apply
(FacesContext facesContext, UIComponent parent) The passed UIComponent parent will be populated/restored in accordance with the section 10.2.1 "Specification of the ViewDeclarationLanguage Implementation for Facelets for Jakarta Faces" in the Jakarta Faces Specification Document.void
FaceletHandler.apply
(FaceletContext ctx, UIComponent parent) Process changes on a particular UIComponentabstract void
TagHandlerDelegate.apply
(FaceletContext ctx, UIComponent comp) final void
FaceletsAttachedObjectHandler.applyAttachedObject
(FacesContext ctx, UIComponent parent) Take the necessary actions to apply the attached object represented by the tag for the concrete subclass of this class to the argumentparent
.void
Facelet.applyMetadata
(FacesContext facesContext, UIComponent parent) The passed UIComponent parent will be populated/restored in accordance with the section 10.2.1 "Specification of the ViewDeclarationLanguage Implementation for Facelets for Jakarta Faces" in the Jakarta Faces Specification Document with only the meta data as per thef:metadata
tag.void
DelegatingMetaTagHandler.applyNextHandler
(FaceletContext ctx, UIComponent c) Invoke theapply()
method on this instance'sTagHandler.nextHandler
.abstract void
FaceletContext.includeFacelet
(UIComponent parent, String relativePath) Include another Facelet defined at some path, relative to the executing context, not the current Facelet (same as include directive in Jakarta Server Pages)abstract void
FaceletContext.includeFacelet
(UIComponent parent, URL absolutePath) Include another Facelet defined at some path, absolute to this ClassLoader/OSstatic boolean
ComponentHandler.isNew
(UIComponent component) Determine if the passed component is not null and if it's new to the tree.void
ComponentHandler.onComponentCreated
(FaceletContext ctx, UIComponent c, UIComponent parent) This method is guaranteed to be called after the component has been created but before it has been populated with children.void
ComponentHandler.onComponentPopulated
(FaceletContext ctx, UIComponent c, UIComponent parent) This method is guaranteed to be called after the component has been populated with children.