org.omnifaces.util

Class Events

java.lang.Object

org.omnifaces.util.Events

public final class Events
extends Object

Collection of utility methods for the JSF API with respect to working with Faces events.

Author:

Arjan Tijms

Method Summary

Methods

Modifier and Type	Method and Description
static void	addAfterPhaseListener(PhaseId phaseId, Callback.Void callback) Adds a phase listener to the current view that invokes the given callback everytime after given phase.
static void	addBeforePhaseListener(PhaseId phaseId, Callback.Void callback) Adds a phase listener to the current view that invokes the given callback everytime before given phase ID.
static void	addPhaseListener(PhaseListener phaseListener) Adds a phase listener to the current view root of the current faces context.
static void	removePhaseListener(PhaseListener phaseListener) Removes a phase listener from the current view root of the current faces context.
static void	subscribeToEvent(Class<? extends SystemEvent> type, SystemEventListener listener) Adds the given system event listener to the application that get invoked everytime when the given system event type is been published.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addPhaseListener

public static void addPhaseListener(PhaseListener phaseListener)

Adds a phase listener to the current view root of the current faces context.

Parameters:

phaseListener - The phase listener to be added to the current view root of the current faces context.

removePhaseListener

public static void removePhaseListener(PhaseListener phaseListener)

Removes a phase listener from the current view root of the current faces context.

Parameters:

phaseListener - The phase listener to be removed from the current view root of the current faces context.

addBeforePhaseListener

public static void addBeforePhaseListener(PhaseId phaseId,
                          Callback.Void callback)

Adds a phase listener to the current view that invokes the given callback everytime before given phase ID.

Parameters:

phaseId - The phase ID to invoke the given callback everytime before.

callback - The callback to be invoked everytime before the given phase ID of the current view.

addAfterPhaseListener

public static void addAfterPhaseListener(PhaseId phaseId,
                         Callback.Void callback)

Adds a phase listener to the current view that invokes the given callback everytime after given phase.

Parameters:

phaseId - The phase ID to invoke the given callback everytime after.

callback - The callback to be invoked everytime after the given phase ID of the current view.

subscribeToEvent

public static void subscribeToEvent(Class<? extends SystemEvent> type,
                    SystemEventListener listener)

Adds the given system event listener to the application that get invoked everytime when the given system event type is been published.

Parameters:

type - The system event type to listen on.

listener - The system event listener to be invoked.

Since:

1.1