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(SystemEvent) or ComponentSystemEventListener.processEvent(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(FacesContext, String), and that the view is fully populated with the children to be traversed during render. The listener implementation may call ViewDeclarationLanguage.buildView(FacesContext, UIViewRoot) to populate the UIViewRoot.

Since:

2.0

See Also:

• Serialized Form

Field Summary

Fields inherited from class 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 ComponentSystemEvent

getComponent, isAppropriateListener, processListener

Modifier and Type	Method	Description
UIComponent	getComponent()	the source UIComponent that sent this event.
boolean	isAppropriateListener(FacesListener listener)	Return true if the argument FacesListener is an instance of the appropriate listener class that this event supports.
void	processListener(FacesListener listener)	Broadcast this event instance to the specified FacesListener by calling the superclass's processListener() implementation.

Methods inherited from class SystemEvent

getFacesContext

Modifier and Type	Method	Description
FacesContext	getFacesContext()	Get the Faces context.

Methods inherited from class EventObject

getSource, toString

Methods inherited from class Object

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

Constructor Details

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.