+Show TOC
×Hide TOC

DispatchableInterface

Kind of class:	interface
Inherits from:	CoreInterface
Implemented by:	DispatchableMovieClip DispatchableTextField DispatchableXml EventDispatcher EventSound
Version:	02/06/07
Author:	Aaron Clinger
Classpath:	org.casaframework.event.DispatchableInterface
File last modified:	Sunday, 19 August 2007, 13:43:27

► View source

▼ Hide source

/*
    CASA Framework for ActionScript 2.0
    Copyright (C) 2007  CASA Framework
    http://casaframework.org
    
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.
    
    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.
    
    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*/

import org.casaframework.core.CoreInterface;

/**
    Event interface which all objects that use {@link EventDispatcher} should adhere to.

    @author Aaron Clinger
    @version 02/06/07
*/

interface org.casaframework.event.DispatchableInterface extends CoreInterface {
    
    /**
        Reports event to all subscribed objects.
        
        @param eventName: Event name.
        @param param(s): <strong>[optional]</strong> Parameters passed to the function specified by "eventName". Multiple parameters are allowed and should be separated by commas: param1,param2, ...,paramN
        @return Returns <code>true</code> if observer(s) listening to specifed event were found; otherwise <code>false</code>.
    */
    public function dispatchEvent(eventName:String):Boolean;
    
    /**
        Registers a function to receive notification when a event handler is invoked.
        
        @param scope: The target or object in which to subscribe.
        @param eventName: Event name to subscribe to.
        @param eventHandler: <strong>[optional]</strong> Name of function to recieve the event. If undefined class assumes <code>eventHandler</code> matches <code>eventName</code>.
        @return Returns <code>true</code> if the observer was established successfully; otherwise <code>false</code>.
    */
    public function addEventObserver(scope:Object, eventName:String, eventHandler:String):Boolean;
    
    /**
        Removes specific observer for event.
        
        @param scope: The target or object in which subscribed.
        @param eventName: Event name to unsubscribe to.
        @param eventHandler: <strong>[optional]</strong> Name of function that recieved the event. If undefined class assumes <code>eventHandler</code> matched <code>eventName</code>.
        @return Returns <code>true</code> if the observer was successfully found and removed; otherwise <code>false</code>.
    */
    public function removeEventObserver(scope:Object, eventName:String, eventHandler:String):Boolean;
    
    /**
        Removes all observers for a specified event.
        
        @param eventName: Event name to unsubscribe to.
        @return Returns <code>true</code> if observers were successfully found for specified <code>eventName</code> and removed; otherwise <code>false</code>.
    */
    public function removeEventObserversForEvent(eventName:String):Boolean;
    
    /**
        Removes all observers in a specified scope.
        
        @param scope: The target or object in which to unsubscribe.
        @return Returns <code>true</code> if observers were successfully found in <code>scope</code> and removed; otherwise <code>false</code>.
    */
    public function removeEventObserversForScope(scope:Object):Boolean;
    
    /**
        Removes all observers regardless of scope or event.
        
        @return Returns <code>true</code> if observers were successfully removed; otherwise <code>false</code>.
    */
    public function removeAllEventObservers():Boolean;
}

Event interface which all objects that use EventDispatcher should adhere to.

Summary

Instance methods

dispatchEvent
addEventObserver
removeEventObserver
removeEventObserversForEvent
removeEventObserversForScope
removeAllEventObservers

Instance methods inherited from CoreInterface

destroy toString

Instance methods

addEventObserver

function addEventObserver (scope:Object, eventName:String, eventHandler:String) : Boolean

Registers a function to receive notification when a event handler is invoked.

Parameters:

scope :

The target or object in which to subscribe.

eventName :

Event name to subscribe to.

eventHandler:

[optional] Name of function to recieve the event. If undefined class assumes eventHandler matches eventName.

Returns:

Returns true if the observer was established successfully; otherwise false.

dispatchEvent

function dispatchEvent (eventName:String) : Boolean

Reports event to all subscribed objects.

Parameters:

eventName:

Event name.

param(s) :

[optional] Parameters passed to the function specified by "eventName". Multiple parameters are allowed and should be separated by commas: param1,param2, ...,paramN

Returns:

Returns true if observer(s) listening to specifed event were found; otherwise false.

removeAllEventObservers

function removeAllEventObservers () : Boolean

Removes all observers regardless of scope or event.

Returns:

Returns true if observers were successfully removed; otherwise false.

removeEventObserver

function removeEventObserver (scope:Object, eventName:String, eventHandler:String) : Boolean

Removes specific observer for event.

Parameters:

scope :

The target or object in which subscribed.

eventName :

Event name to unsubscribe to.

eventHandler:

[optional] Name of function that recieved the event. If undefined class assumes eventHandler matched eventName.

Returns:

Returns true if the observer was successfully found and removed; otherwise false.

removeEventObserversForEvent

function removeEventObserversForEvent (eventName:String) : Boolean

Removes all observers for a specified event.

Parameters:

eventName:

Event name to unsubscribe to.

Returns:

Returns true if observers were successfully found for specified eventName and removed; otherwise false.

removeEventObserversForScope

function removeEventObserversForScope (scope:Object) : Boolean

Removes all observers in a specified scope.

Parameters:

scope:

The target or object in which to unsubscribe.

Returns:

Returns true if observers were successfully found in scope and removed; otherwise false.