Top Description Fields Constructors Methods
jakarta.faces.event

public Class PreRemoveFromViewEvent

extends ComponentSystemEvent
Class Inheritance
Imports
jakarta.faces.component.UIComponent, 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 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

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Hides jakarta.faces.event.ComponentSystemEvent.serialVersionUID.

Constructor Summary

AccessConstructor and Description
public
PreRemoveFromViewEvent(UIComponent
the UIComponent that is about to be removed from the view.
component)

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

public
PreRemoveFromViewEvent(FacesContext
the Faces context.
facesContext, UIComponent
the UIComponent that is about to be removed from the view.
component)

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

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if the listener is an appropriate one, false otherwise.
isAppropriateListener(FacesListener
the faces listener.
listener)

Overrides jakarta.faces.event.ComponentSystemEvent.isAppropriateListener.

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

Inherited from jakarta.faces.event.ComponentSystemEvent:
getComponentprocessListener

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides jakarta.faces.event.ComponentSystemEvent.serialVersionUID.

Constructor Detail

PreRemoveFromViewEventback to summary
public PreRemoveFromViewEvent(UIComponent component)

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

Parameters
component:UIComponent

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

Exceptions
IllegalArgumentException:
if component is null
PreRemoveFromViewEventback to summary
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:FacesContext

the Faces context.

component:UIComponent

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

Exceptions
IllegalArgumentException:
if component is null

Method Detail

isAppropriateListenerback to summary
public boolean isAppropriateListener(FacesListener listener)

Overrides jakarta.faces.event.ComponentSystemEvent.isAppropriateListener.

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

Parameters
listener:FacesListener

the faces listener.

Returns:boolean

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

Annotations
@Override