Package jakarta.faces.event

Class PreRenderViewEvent

java.lang.Object

java.util.EventObject

jakarta.faces.event.SystemEvent

jakarta.faces.event.ComponentSystemEvent

jakarta.faces.event.PreRenderViewEvent

All Implemented Interfaces:

Serializable

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.

Since:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
PreRenderViewEvent(UIViewRoot root)	Instantiate a new PreRenderViewEvent that indicates the argument root is about to be rendered.
PreRenderViewEvent(FacesContext facesContext, UIViewRoot root)	Instantiate a new PreRenderViewEvent that indicates the argument root is about to be rendered.

Method Summary

Methods inherited from class jakarta.faces.event.ComponentSystemEvent

getComponent, isAppropriateListener, processListener

Methods inherited from class jakarta.faces.event.SystemEvent

getFacesContext

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PreRenderViewEvent

public PreRenderViewEvent(UIViewRoot root)

Instantiate a new PreRenderViewEvent that indicates the argument root is about to be rendered.

Parameters:

root - the UIViewRoot that is about to be rendered.

Throws:

IllegalArgumentException - if the argument is null.

PreRenderViewEvent

public PreRenderViewEvent(FacesContext facesContext,
                          UIViewRoot root)

Instantiate a new PreRenderViewEvent that indicates the argument root is about to be rendered.

Parameters:

facesContext - the Faces context.

root - the UIViewRoot that is about to be rendered.

Throws:

IllegalArgumentException - if the argument is null.