public abstract class PagePhaseListenerManager
extends java.lang.Object
Constructor and Description |
---|
PagePhaseListenerManager() |
Modifier and Type | Method and Description |
---|---|
abstract void |
addPagePhaseListener(PagePhaseListener listener,
java.lang.String listenerId,
java.util.Set<java.lang.String> beforeIdSet,
java.util.Set<java.lang.String> afterIdSet)
Register a listener at a specific position in the list of listeners
to determine which listener will be call first for a particular event.
|
abstract PagePhaseListener |
getPagePhaseListener(java.lang.String listenerId)
Returns the phase listener given a listener id.
|
abstract java.util.List<java.lang.String> |
getPagePhaseListenerIds()
Returns the list of listener id for all registered listeners in the order
in which they will be executed.
|
abstract boolean |
removePagePhaseListener(java.lang.String listenerId)
Un-register a listener using its id
Return true is the listenerId existed and has been removed successfully.
|
public abstract void addPagePhaseListener(PagePhaseListener listener, java.lang.String listenerId, java.util.Set<java.lang.String> beforeIdSet, java.util.Set<java.lang.String> afterIdSet)
listener
- the instance of the listener to registerlistenerId
- the id of the listener to registerbeforeIdSet
- the set of listeners the new listener should be placed beforeafterIdSet
- the set of listeners the new listener should be placed afterpublic abstract boolean removePagePhaseListener(java.lang.String listenerId)
listenerId
- the id of the listener to removepublic abstract java.util.List<java.lang.String> getPagePhaseListenerIds()
public abstract PagePhaseListener getPagePhaseListener(java.lang.String listenerId)
listenerId
- the id of the listener to retrieve