Class PostRestoreStateEvent

java.lang.Object

java.util.EventObject

jakarta.faces.event.SystemEvent

jakarta.faces.event.ComponentSystemEvent

jakarta.faces.event.PostRestoreStateEvent

All Implemented Interfaces:

Serializable

public class PostRestoreStateEvent
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 in a tree that has just had its state restored.

Since:

2.0

See Also:

• Serialized Form

Field Summary

Fields inherited from class EventObject

source

Constructor Summary

Constructors

Constructor	Description
PostRestoreStateEvent(UIComponent component)	Instantiate a new PostRestoreStateEvent that indicates the argument component just had its state restored.
PostRestoreStateEvent(FacesContext facesContext, UIComponent component)	Instantiate a new PostRestoreStateEvent that indicates the argument component just had its state restored.

Method Summary

Modifier and Type	Method	Description
void	setComponent(UIComponent newComponent)

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

PostRestoreStateEvent

public PostRestoreStateEvent(UIComponent component)

Instantiate a new PostRestoreStateEvent that indicates the argument component just had its state restored.

Parameters:

component - the UIComponent whose state was just restored.

Throws:

IllegalArgumentException - if the argument is null.

PostRestoreStateEvent

public PostRestoreStateEvent(FacesContext facesContext,
 UIComponent component)

Instantiate a new PostRestoreStateEvent that indicates the argument component just had its state restored.

Parameters:

facesContext - the Faces context.

component - the UIComponent whose state was just restored.

Throws:

IllegalArgumentException - if the argument is null.

Method Details

setComponent

public void setComponent(UIComponent newComponent)