- java.lang.Object
-
- java.util.EventObject
-
- javax.faces.event.SystemEvent
-
- javax.faces.event.ComponentSystemEvent
-
- javax.faces.event.PostAddToViewEvent
-
- All Implemented Interfaces:
- Serializable
public class PostAddToViewEvent extends ComponentSystemEvent
When an instance of this event is passed to
SystemEventListener.processEvent(javax.faces.event.SystemEvent)
orComponentSystemEventListener.processEvent(javax.faces.event.ComponentSystemEvent)
, the listener implementation may assume that thesource
of this event instance is aUIComponent
instance and that either that instance or an ancestor of that instance was just added to the view. Therefore, the implementation may assume it is safe to callUIComponent.getParent()
,UIComponent.getClientId()
, and other methods that depend upon the component instance being added into the view.The implementation must guarantee that
Application.publishEvent(javax.faces.context.FacesContext, java.lang.Class<? extends javax.faces.event.SystemEvent>, java.lang.Object)
is called, immediately after anyUIComponent
instance is added to the view hierarchy except in the case whereResponseStateManager.isPostback(javax.faces.context.FacesContext)
returnstrue
at the same time asFacesContext.getCurrentPhaseId()
returnsPhaseId.RESTORE_VIEW
. When both of those conditions are met,Application.publishEvent(javax.faces.context.FacesContext, java.lang.Class<? extends javax.faces.event.SystemEvent>, java.lang.Object)
must not be called.The implementation must guarantee that
Application.publishEvent(javax.faces.context.FacesContext, java.lang.Class<? extends javax.faces.event.SystemEvent>, java.lang.Object)
is called in the following cases.Upon the initial construction of the view, when each instance is added to the view.
On a non-initial rendering of the view, if a component is added to the view by the View Declaration Language implememtation as a result of changes in evaluation result of EL expressions referenced by VDL tags such as
c:if
,ui:include
, and other tags that dynamically influence the assembly of the view.If a component is programmatically added to the view using the Java API directly. For example, user code manually adds children using
comp.getChildren().add()
, wherecomp
is aUIComponent
.
- Since:
- 2.0
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class java.util.EventObject
source
-
-
Constructor Summary
Constructors Constructor and Description PostAddToViewEvent(UIComponent component)
Instantiate a new
PostAddToViewEvent
that indicates the argumentcomponent
was just added to the view.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description boolean
isAppropriateListener(FacesListener listener)
Returns
true
if and only if the argumentlistener
is an instance ofSystemEventListener
.-
Methods inherited from class javax.faces.event.ComponentSystemEvent
getComponent, processListener
-
-
-
-
Constructor Detail
-
PostAddToViewEvent
public PostAddToViewEvent(UIComponent component)
Instantiate a new
PostAddToViewEvent
that indicates the argumentcomponent
was just added to the view.- Parameters:
component
- theUIComponent
that has just been added to the view.- Throws:
- if the argument isIllegalArgumentException
null
.
-
-
Method Detail
-
isAppropriateListener
public boolean isAppropriateListener(FacesListener listener)
Returns
true
if and only if the argumentlistener
is an instance ofSystemEventListener
.- Overrides:
isAppropriateListener
in classComponentSystemEvent
- Parameters:
listener
-
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/faces/event/PostAddToViewEvent.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.