Top Description Fields Constructors Methods
jakarta.faces.event

public Class PreRenderViewEvent

extends ComponentSystemEvent
Class Inheritance
Imports
jakarta.faces.component.UIViewRoot, jakarta.faces.context.FacesContext

When an instance of this event is passed to SystemEventListener#processEvent or ComponentSystemEventListener#processEvent, 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 jakarta.faces.context.FacesContext, but the listener must ensure that the new UIViewRoot was created with a call to jakarta.faces.application.ViewHandler#createView, and that the view is fully populated with the children to be traversed during render. The listener implementation may call jakarta.faces.view.ViewDeclarationLanguage#buildView to populate the UIViewRoot.

Since
2.0

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Hides jakarta.faces.event.ComponentSystemEvent.serialVersionUID.

Constructor Summary

AccessConstructor and Description
public
PreRenderViewEvent(UIViewRoot
the UIViewRoot that is about to be rendered.
root)

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

public
PreRenderViewEvent(FacesContext
the Faces context.
facesContext, UIViewRoot
the UIViewRoot that is about to be rendered.
root)

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

Method Summary

Inherited from jakarta.faces.event.ComponentSystemEvent:
getComponentisAppropriateListenerprocessListener

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides jakarta.faces.event.ComponentSystemEvent.serialVersionUID.

Constructor Detail

PreRenderViewEventback to summary
public PreRenderViewEvent(UIViewRoot root)

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

Parameters
root:UIViewRoot

the UIViewRoot that is about to be rendered.

Exceptions
IllegalArgumentException:
if the argument is null.
PreRenderViewEventback to summary
public PreRenderViewEvent(FacesContext facesContext, UIViewRoot root)

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

Parameters
facesContext:FacesContext

the Faces context.

root:UIViewRoot

the UIViewRoot that is about to be rendered.

Exceptions
IllegalArgumentException:
if the argument is null.