Package jakarta.faces.event

Class PreRemoveFromViewEvent

java.lang.Object

java.util.EventObject

jakarta.faces.event.SystemEvent

jakarta.faces.event.ComponentSystemEvent

jakarta.faces.event.PreRemoveFromViewEvent

All Implemented Interfaces:

Serializable

public class PreRemoveFromViewEvent
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 a UIComponent instance that is about to be removed from the view. Therefore, the implementation may assume it is safe to call UIComponent.getParent(), UIComponent.getClientId(), and other methods that depend upon the component instance being added into the view.

Since:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
PreRemoveFromViewEvent(UIComponent component)	Instantiate a new BeforeRemoveFromView that indicates the argument component is about to be removed from the view.
PreRemoveFromViewEvent(FacesContext facesContext, UIComponent component)	Instantiate a new BeforeRemoveFromView that indicates the argument component is about to be removed from the view.

Method Summary

Modifier and Type	Method	Description
boolean	isAppropriateListener(FacesListener listener)	Returns true if and only if the argument listener is an instance of SystemEventListener.

Methods inherited from class jakarta.faces.event.ComponentSystemEvent

getComponent, 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

PreRemoveFromViewEvent

public PreRemoveFromViewEvent(UIComponent component)

Instantiate a new BeforeRemoveFromView that indicates the argument component is about to be removed from the view.

Parameters:

component - the UIComponent that is about to be removed from the view.

Throws:

IllegalArgumentException - if component is null

PreRemoveFromViewEvent

public PreRemoveFromViewEvent(FacesContext facesContext,
                              UIComponent component)

Instantiate a new BeforeRemoveFromView that indicates the argument component is about to be removed from the view.

Parameters:

facesContext - the Faces context.

component - the UIComponent that is about to be removed from the view.

Throws:

IllegalArgumentException - if component is null

Method Detail

isAppropriateListener

public boolean isAppropriateListener(FacesListener listener)

Returns true if and only if the argument listener is an instance of SystemEventListener.

Overrides:

isAppropriateListener in class ComponentSystemEvent

Parameters:

listener - the faces listener.

Returns:

true if the listener is an appropriate one, false otherwise.