flash.events.IEventDispatcher Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flixel-gdx-core Show documentation
The newest version!
package flash.events;

/**
 * The IEventDispatcher interface defines methods for adding or removing event listeners, checks whether specific types of event listeners are registered, and dispatches events.
 * 
 * @author Ka Wing Chin
 * @author Thomas Weston
 */
public interface IEventDispatcher
{
	/**
	 * Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
	 * 
	 * @param	type				The type of event.
	 * @param	listener			The listener function that processes the event. This function must accept an event object as its only parameter and must return nothing.
	 * @param	useCapture			Determines whether the listener works in the capture phase or the target and bubbling phases.
	 * @param	priority			The priority level of the event listener.
	 * @param	useWeakReference	Determines whether the reference to the listener is strong or weak.
	 */
	public void addEventListener(String type, IEventListener listener, boolean useCapture, int priority, boolean useWeakReference);

	/**
	 * Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
	 * 
	 * @param	type				The type of event.
	 * @param	listener			The listener function that processes the event. This function must accept an event object as its only parameter and must return nothing.
	 * @param	useCapture			Determines whether the listener works in the capture phase or the target and bubbling phases.
	 * @param	priority			The priority level of the event listener.
	 */
	public void addEventListener(String type, IEventListener listener, boolean useCapture, int priority);

	/**
	 * Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
	 * 
	 * @param	type				The type of event.
	 * @param	listener			The listener function that processes the event. This function must accept an event object as its only parameter and must return nothing.
	 * @param	useCapture			Determines whether the listener works in the capture phase or the target and bubbling phases.
	 */
	public void addEventListener(String type, IEventListener listener, boolean useCapture);

	/**
	 * Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
	 * 
	 * @param	type				The type of event.
	 * @param	listener			The listener function that processes the event. This function must accept an event object as its only parameter and must return nothing.
	 */
	public void addEventListener(String type, IEventListener listener);

	/**
	 * Dispatches an event into the event flow.
	 * 
	 * @param	event		The event object that is dispatched into the event flow.
	 * @return	A value of true if the event was successfully dispatched.
	 */
	public boolean dispatchEvent(Event event);

	/**
	 * Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
	 * 
	 * @param	type		The type of event.
	 */
	public boolean hasEventListener(String type);

	/**
	 * Removes a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect.
	 * 
	 * @param	type		The type of event.
	 * @param	listener	The listener object to remove.
	 * @param	useCapture	Specifies whether the listener was registered for the capture phase or the target and bubbling phases.
	 */
	public void removeEventListener(String type, IEventListener listener, boolean useCapture);

	/**
	 * Removes a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect.
	 * 
	 * @param	type		The type of event.
	 */
	public void removeEventListener(String type, IEventListener listener);
}