+Show TOC
×Hide TOC

IEventDispatcher

Kind of class:	interface
Inherits from:	none
Implemented by:	EventBroadcaster
Known subinterfaces:	IEventBroadcasterOwner
Version:	1.0
Author:	Francis Bourre
Classpath:	com.bourre.events.IEventDispatcher
File last modified:	Wednesday, 31 October 2007, 07:35:29

► View source

▼ Hide source

/*
 * Copyright the original author or authors.
 * 
 * Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.mozilla.org/MPL/MPL-1.1.html
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
/**
 * {@code IEventDispatcher} must be implements by all event broadcasters.
 * 
 * <p>Defines basic methods for event broadcaster managment.
 * 
 * <ul>
 *   <li>{@link #addEventListener}</li>
 *   <li>{@link #removeEventListener}</li>
 *   <li>{@link #dispatchEvent}</li>
 *   <li>{@link #broadcastEvent}</li>
 * </ul>
 * 
 * <p>See {@link EventBroadcaster} class for concrete implementation.
 * 
 * @author Francis Bourre
 * @version 1.0 
 */
 
import com.bourre.events.IEvent;

interface com.bourre.events.IEventDispatcher
{
    /**
     * Adds passed-in {@code oL} listener for receiving passed-in {@code t} event type.
     * 
     * <p>Take a look at example below to see all possible method call.
     * 
     * <p>Example
     * <code>
     *   var oEB : IEventDispatcher = new EventBroadcaster(this);
     *   oEB.addEventListener( myClass.onSometingEVENT, myFirstObject);
     *   oEB.addEventListener( myClass.onSometingElseEVENT, this, __onSomethingElse);
     *   oEB.addEventListener( myClass.onSometingElseEVENT, this, Delegate.create(this, __onSomething) );
     * </code>
     * 
     * @param t Name of the Event.
     * @param oL Listener object.
     */
    public function addEventListener(t:String, oL) : Void;
    
    /**
     * Removes passed-in {@code oL} listener that suscribed for passed-in {@code t} event.
     * 
     * <p>Example
     * <code>
     *   var oEB : IEventDispatcher = new EventBroadcaster(this);
     *   oEB.removeEventListener( myClass.onSometingEVENT, myFirstObject);
     *   oEB.removeEventListener( myClass.onSometingElseEVENT, this);
     * </code>
     * 
     * @param t Name of the Event.
     * @param oL Listener object.
     */
    public function removeEventListener(t:String, oL) : Void;

    /**
     * Wrapper for Macromedia {@code EventDispatcher} polymorphism.
     * 
     * <p>Example
     * <code>
     *   var oEB : IEventDispatcher = new EventBroadcaster(this);
     *   oEB.dispatchEvent( {type:'onSomething', target:this, param:12} );
     * </code>
     * 
     * @param o Event object.
     */
    public function dispatchEvent(o:Object) : Void;
    
    /**
     * Broadcasts event to suscribed listeners.
     * 
     * <p>Example using full Pixlib API
     * <code>
     *   var oEB : IEventDispatcher = new EventBroadcaster(this);
     *   var e : IEvent = new BasicEvent( myClass.onSomeThing, this);
     *   
     *   oEB.addEventListener( myClass.onSomeThing, this);
     *   oEB.broadcastEvent( e );
     * </code>
     * 
     * @param e an {@link IEvent} instance
     */
    public function broadcastEvent(e:IEvent) : Void;
}

IEventDispatcher must be implements by all event broadcasters.

Defines basic methods for event broadcaster managment.

See EventBroadcaster class for concrete implementation.

Summary

Instance methods

addEventListener
removeEventListener
dispatchEvent
broadcastEvent

Instance methods

addEventListener

function addEventListener (

t:String) : Void

Adds passed-in oL listener for receiving passed-in t event type.

Take a look at example below to see all possible method call.

Example

var oEB : IEventDispatcher = new EventBroadcaster(this);
oEB.addEventListener( myClass.onSometingEVENT, myFirstObject);
oEB.addEventListener( myClass.onSometingElseEVENT, this, __onSomethingElse);
oEB.addEventListener( myClass.onSometingElseEVENT, this, Delegate.create(this, __onSomething) );

Parameters:

t :

Name of the Event.

oL:

Listener object.

broadcastEvent

function broadcastEvent (

e:IEvent) : Void

Broadcasts event to suscribed listeners.

Example using full Pixlib API

var oEB : IEventDispatcher = new EventBroadcaster(this);
var e : IEvent = new BasicEvent( myClass.onSomeThing, this);

oEB.addEventListener( myClass.onSomeThing, this);
oEB.broadcastEvent( e );

Parameters:

an IEvent instance

dispatchEvent

function dispatchEvent (

o:Object) : Void

Wrapper for Macromedia EventDispatcher polymorphism.

Example

var oEB : IEventDispatcher = new EventBroadcaster(this);
oEB.dispatchEvent( {type:'onSomething', target:this, param:12} );

Parameters:

Event object.

removeEventListener

function removeEventListener (

t:String) : Void

Removes passed-in oL listener that suscribed for passed-in t event.

Example

var oEB : IEventDispatcher = new EventBroadcaster(this);
oEB.removeEventListener( myClass.onSometingEVENT, myFirstObject);
oEB.removeEventListener( myClass.onSometingElseEVENT, this);

Parameters:

t :

Name of the Event.

oL:

Listener object.