- java.lang.Object
-
- javax.faces.view.facelets.TagHandler
-
- javax.faces.view.facelets.MetaTagHandler
-
- javax.faces.view.facelets.DelegatingMetaTagHandler
-
- javax.faces.view.facelets.ComponentHandler
-
- All Implemented Interfaces:
- FaceletHandler
public class ComponentHandler extends DelegatingMetaTagHandler
Public base class for markup element instances that map to
UIComponentinstances in the view.Instances of this class are created and passed to
TagHandlerDelegateFactory.createComponentHandlerDelegate(javax.faces.view.facelets.ComponentHandler)when a tag corresponding to this particular component is encountered in a Facelet view. A custom tag handler for a component, converter, validator, or behavior must extend from this class. In this way, this instance acts as a delegate for the implementation private tag handler. Such a subclass may choose to override as many or as few methods from this base class as desired. If the subclass wants to completely override the action of the implementation specific tag for which this component is the delegate, it must override theapply()method and make it take the following actions, in this order. These actions must only happen the first time this facelet is applied for each user. Subsequent applications must take no action.The
UIComponentrepresented by this element is created with the appropriateApplication.createComponent()method.Each attribute specified in the markup is correctly applied to the component instance, as specified in the VDLDocs for this element.
If project stage is
ProjectStage.Development, Put theLocationfor this element into the component attributeMapunder the key given by the value of the symbolic constantUIComponent.VIEW_LOCATION_KEY.Set the id of the component. If the id is specified manually by the page author, that value must be set as the id. Otherwise, the closest ancestor component that is an instance of
UniqueIdVendormust be located and itsUniqueIdVendor.createUniqueId(javax.faces.context.FacesContext, java.lang.String)method must be called to derive the id. If no such instance can be found, callUIViewRoot.createUniqueId()to derive the id.The rendererType property of the component is set properly.
UIComponent.pushComponentToEL(javax.faces.context.FacesContext, javax.faces.component.UIComponent)is called on the newly created component.The next handler in the facelet chain is applied. This will cause the component to be populated with children.
The component is added to its parent in the view.
UIComponent.popComponentFromEL(javax.faces.context.FacesContext)is called on the newly created component.
A common use case for extending this class is to gain access to the process by which the Facelets runtime creates component instances corresponding to markup in a Facelets view. These three methods are useful in such cases.
To control the instantiation of the
UIComponentinstance, subclasses may overridecreateComponent(javax.faces.view.facelets.FaceletContext). If this method is not overridden, the tag handler for which this instance is the delegate will take the necessary action to instantiate theUIComponent.To be notified of creation of the
UIComponentinstance, subclasses may overrideonComponentCreated(javax.faces.view.facelets.FaceletContext, javax.faces.component.UIComponent, javax.faces.component.UIComponent).To be notified that the freshly created
UIComponentinstance has been populated with children as a result of execution of child tag handlers, subclasses may overrideonComponentPopulated(javax.faces.view.facelets.FaceletContext, javax.faces.component.UIComponent, javax.faces.component.UIComponent).
- Since:
- 2.0
-
-
Field Summary
-
Fields inherited from class javax.faces.view.facelets.DelegatingMetaTagHandler
delegateFactory
-
Fields inherited from class javax.faces.view.facelets.TagHandler
nextHandler, tag, tagId
-
-
Constructor Summary
Constructors Constructor and Description ComponentHandler(ComponentConfig config)Leverage the
TagHandlerDelegateFactoryprovided by the implementation to create an instance ofTagHandlerDelegatedesigned for use withComponentHandler.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description UIComponentcreateComponent(FaceletContext ctx)Subclasses that wish to take over the task of instantiating the
UIComponentinstance corresponding to this tag handler my override this method to do so.ComponentConfiggetComponentConfig()protected TagHandlerDelegategetTagHandlerDelegate()static booleanisNew(UIComponent component)Determine if the passed component is not null and if it's new to the tree.
voidonComponentCreated(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.
voidonComponentPopulated(FaceletContext ctx, UIComponent c, UIComponent parent)This method is guaranteed to be called after the component has been populated with children.
-
Methods inherited from class javax.faces.view.facelets.DelegatingMetaTagHandler
apply, applyNextHandler, createMetaRuleset, getBinding, getTag, getTagAttribute, getTagId, isDisabled, setAttributes
-
Methods inherited from class javax.faces.view.facelets.TagHandler
getAttribute, getRequiredAttribute, toString
-
-
-
-
Constructor Detail
-
ComponentHandler
public ComponentHandler(ComponentConfig config)
Leverage the
TagHandlerDelegateFactoryprovided by the implementation to create an instance ofTagHandlerDelegatedesigned for use withComponentHandler.- Since:
- 2.0
-
-
Method Detail
-
getTagHandlerDelegate
protected TagHandlerDelegate getTagHandlerDelegate()
- Specified by:
getTagHandlerDelegatein classDelegatingMetaTagHandler
-
getComponentConfig
public ComponentConfig getComponentConfig()
-
createComponent
public UIComponent createComponent(FaceletContext ctx)
Subclasses that wish to take over the task of instantiating the
UIComponentinstance corresponding to this tag handler my override this method to do so. Anullreturn from this method will cause theTagHandlerDelegatefor instance to create the component instead.- Since:
- 2.2
-
onComponentCreated
public void 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.
- Parameters:
ctx- theFaceletContextfor this view executionc- theUIComponentthat has just been created.parent- the parentUIComponentof the component represented by this element instance.- Since:
- 2.0
-
onComponentPopulated
public void onComponentPopulated(FaceletContext ctx, UIComponent c, UIComponent parent)
This method is guaranteed to be called after the component has been populated with children.
- Parameters:
ctx- theFaceletContextfor this view executionc- theUIComponentthat has just been populated with children.parent- the parentUIComponentof the component represented by this element instance.- Since:
- 2.0
-
isNew
public static boolean isNew(UIComponent component)
Determine if the passed component is not null and if it's new to the tree. This operation can be used for determining if attributes should be wired to the component.
- Parameters:
component- the component you wish to modify- Since:
- 2.0
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 18/08/2025 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-javaee-rf-javax/faces/view/facelets/ComponentHandler.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur van deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.