Top Description Fields Constructors Methods
javax.faces.event

public Class PostAddToViewEvent

extends ComponentSystemEvent
Class Inheritance
Imports
javax.faces.component.UIComponent, javax.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 and that either that instance or an ancestor of that instance was just added to 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.

The implementation must guarantee that javax.faces.application.Application#publishEvent is called, immediately after any UIComponent instance is added to the view hierarchy except in the case where javax.faces.render.ResponseStateManager#isPostback returns true at the same time as javax.faces.context.FacesContext#getCurrentPhaseId returns javax.faces.event.PhaseId#RESTORE_VIEW. When both of those conditions are met, javax.faces.application.Application#publishEvent must not be called.

The implementation must guarantee that javax.faces.application.Application#publishEvent is called in the following cases.

Since
2.0

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
public
PostAddToViewEvent(UIComponent
the UIComponent that has just been added to the view.
component
)

Instantiate a new PostAddToViewEvent that indicates the argument component was just added to the view.

public
PostAddToViewEvent(FacesContext
the Faces context.
facesContext
,
UIComponent
the UIComponent that has just been added to the view.
component
)

Instantiate a new PostAddToViewEvent that indicates the argument component was just added to the view.

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

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

Overrides javax.faces.event.ComponentSystemEvent.isAppropriateListener.

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

Inherited from javax.faces.event.ComponentSystemEvent:
getComponentprocessListener

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides javax.faces.event.ComponentSystemEvent.serialVersionUID.

Constructor Detail

PostAddToViewEventback to summary
public PostAddToViewEvent(UIComponent component)

Instantiate a new PostAddToViewEvent that indicates the argument component was just added to the view.

Parameters
component:UIComponent

the UIComponent that has just been added to the view.

Exceptions
IllegalArgumentException:
if the argument is null.
PostAddToViewEventback to summary
public PostAddToViewEvent(FacesContext facesContext, UIComponent component)

Instantiate a new PostAddToViewEvent that indicates the argument component was just added to the view.

Parameters
facesContext:FacesContext

the Faces context.

component:UIComponent

the UIComponent that has just been added to the view.

Exceptions
IllegalArgumentException:
if the argument is null.

Method Detail

isAppropriateListenerback to summary
public boolean isAppropriateListener(FacesListener listener)

Overrides javax.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 it is an appropriate listener, false otherwise.

Annotations
@Override