scaffold.libs_as.org.osflash.signals.natives.INativeDispatcher.as Maven / Gradle / Ivy

Go to download
package org.osflash.signals.natives
{
	import org.osflash.signals.IPrioritySignal;

	import flash.events.Event;
	import flash.events.IEventDispatcher;

	/**
	 * Similar to IDispatcher but using strong types specific to Flash's native event system.
	 */
	public interface INativeDispatcher extends IPrioritySignal
	{
		/**
		 * The type of event permitted to be dispatched. Corresponds to flash.events.Event.type.
		 */
		function get eventType() : String;

		/**
		 * The class of event permitted to be dispatched. Will be flash.events.Event or a subclass.
		 */
		function get eventClass() : Class;

		/**
		 * The object considered the source of the dispatched events.
		 */
		function get target() : IEventDispatcher;

		function set target( value : IEventDispatcher ) : void;

		/**
		 * Dispatches an event to listeners.
		 * @param    event            An instance of a class that is or extends flash.events.Event.
		 * @throws    ArgumentError    ArgumentError: Event object is null.
		 * @throws    ArgumentError    ArgumentError:    Event object [event] is not an instance of [eventClass].
		 * @throws    ArgumentError    ArgumentError:    Event object has incorrect type. Expected [eventType] but was [event.type].
		 * @throws  ArgumentError   ArgumentError:  Target object cannot be null.
		 */
		function dispatchEvent( event : Event ) : Boolean;
	}
}