public class PreRenderViewEvent extends ComponentSystemEvent
When an instance of this event is passed to SystemEventListener.processEvent(jakarta.faces.event.SystemEvent)
or
ComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent)
, the listener implementation may assume that the
source
of this event instance is the UIViewRoot
instance that is about to be rendered.
It is valid for a listener for this event to change the UIViewRoot
in the current
FacesContext
, but the listener must ensure that the new UIViewRoot
was
created with a call to ViewHandler.createView(jakarta.faces.context.FacesContext, java.lang.String)
, and that the view is fully populated
with the children to be traversed during render. The listener implementation may call
ViewDeclarationLanguage.buildView(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot)
to populate the UIViewRoot
.
Constructor and Description |
---|
PreRenderViewEvent(FacesContext facesContext,
UIViewRoot root)
Instantiate a new |
PreRenderViewEvent(UIViewRoot root)
Instantiate a new |
getComponent, isAppropriateListener, processListener
getFacesContext
public PreRenderViewEvent(UIViewRoot root)
Instantiate a new PreRenderViewEvent
that indicates the argument root
is about to be
rendered.
root
- the UIViewRoot
that is about to be rendered.java.lang.IllegalArgumentException
- if the argument is null
.public PreRenderViewEvent(FacesContext facesContext, UIViewRoot root)
Instantiate a new PreRenderViewEvent
that indicates the argument root
is about to be
rendered.
facesContext
- the Faces context.root
- the UIViewRoot
that is about to be rendered.java.lang.IllegalArgumentException
- if the argument is null
.