+Show TOC
×Hide TOC

DispatchableMovieClip

Kind of class:	class
Inherits from:	CoreMovieClip < MovieClip
Implements:	DispatchableInterface
Known subclasses:	EventMovieClip
Version:	05/13/07
Author:	Aaron Clinger
Classpath:	org.casalib.movieclip.DispatchableMovieClip
File last modified:	Monday, 01 December 2008, 13:34:40

► View source

▼ Hide source

/*
    CASA Lib for ActionScript 2.0
    Copyright (c) 2008, Aaron Clinger & Contributors of CASA Lib
    All rights reserved.
    
    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are met:
    
    - Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.
    
    - Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
    
    - Neither the name of the CASA Lib nor the names of its contributors
      may be used to endorse or promote products derived from this software
      without specific prior written permission.
    
    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE.
*/

import org.casalib.movieclip.CoreMovieClip;
import org.casalib.event.DispatchableInterface;
import org.casalib.event.EventDispatcher;
import org.casalib.util.MovieClipUtil;

/**
    Base MovieClip that includes {@link EventDispatcher} and extends {@link CoreMovieClip}.
    
    @author Aaron Clinger
    @version 05/13/07
*/

class org.casalib.movieclip.DispatchableMovieClip extends CoreMovieClip implements DispatchableInterface {
    private var $eventDispatcher:EventDispatcher;
    
    
    /**
        Creates an empty instance of the DispatchableMovieClip class. Use this instead of a traditional <code>new</code> constructor statement due to limitations of ActionScript 2.0.
        
        @param target: Location where the MovieClip should be attached.
        @param instanceName: A unique instance name for the MovieClip.
        @param depth: <strong>[optional]</strong> The depth level where the MovieClip is placed; defaults to next highest open depth.
        @param initObject: <strong>[optional]</strong> An object that contains properties with which to populate the newly attached MovieClip.
        @return Returns a reference to the created instance.
        @example <code>var myDispatch_mc:DispatchableMovieClip = DispatchableMovieClip.create(this, "example_mc");</code>
        @usageNote If you want to extend a non empty MovieClip you can either define the ActionScript 2.0 class in the Flash IDE library or use {@link MovieClipUtil#attachMovieRegisterClass}.
        @since Flash Player 7
    */
    public static function create(target:MovieClip, instanceName:String, depth:Number, initObject:Object):DispatchableMovieClip {
        return DispatchableMovieClip(MovieClipUtil.createMovieRegisterClass('org.casalib.movieclip.DispatchableMovieClip', target, instanceName, depth, initObject));
    }
    
    
    private function DispatchableMovieClip() {
        super();
        
        this.$eventDispatcher = new EventDispatcher();
        
        this.$setClassDescription('org.casalib.movieclip.DispatchableMovieClip');
    }
    
    public function addEventObserver(scope:Object, eventName:String, eventHandler:String):Boolean {
        return this.$eventDispatcher.addEventObserver(scope, eventName, eventHandler);
    }
    
    public function removeEventObserver(scope:Object, eventName:String, eventHandler:String):Boolean {
        return this.$eventDispatcher.removeEventObserver(scope, eventName, eventHandler);
    }
    
    public function removeEventObserversForEvent(eventName:String):Boolean {
        return this.$eventDispatcher.removeEventObserversForEvent(eventName);
    }
    
    public function removeEventObserversForScope(scope:Object):Boolean {
        return this.$eventDispatcher.removeEventObserversForScope(scope);
    }
    
    public function removeAllEventObservers():Boolean {
        return this.$eventDispatcher.removeAllEventObservers();
    }
    
    /**
        {@inheritDoc}
        
        @param eventName: {@inheritDoc}
        @param param(s): {@inheritDoc}
        @return {@inheritDoc}
    */
    public function dispatchEvent(eventName:String):Boolean {
        return this.$eventDispatcher.dispatchEvent.apply(this.$eventDispatcher, arguments);
    }
    
    public function destroy():Void {
        this.$eventDispatcher.destroy();
        delete this.$eventDispatcher;
        
        super.destroy();
    }
}

Base MovieClip that includes org.casalib.event.EventDispatcher and extends CoreMovieClip.

Summary

Class methods

create (target:MovieClip, instanceName:String, depth:Number, initObject:Object) : DispatchableMovieClip
- Creates an empty instance of the DispatchableMovieClip class.

Class methods inherited from CoreMovieClip

create

Instance methods

addEventObserver (scope:Object, eventName:String, eventHandler:String) : Boolean
- Registers a function to receive notification when a event handler is invoked.
removeEventObserver (scope:Object, eventName:String, eventHandler:String) : Boolean
- Removes specific observer for event.
removeEventObserversForEvent (eventName:String) : Boolean
- Removes all observers for a specified event.
removeEventObserversForScope (scope:Object) : Boolean
- Removes all observers in a specified scope.
removeAllEventObservers : Boolean
- Removes all observers regardless of scope or event.
dispatchEvent (eventName:String) : Boolean
- Reports event to all subscribed objects.
destroy : Void
- Removes any internal variables, intervals, enter frames, internal MovieClips and event observers to allow the object to be garbage collected.

Instance methods inherited from CoreMovieClip

$setClassDescription destroy removeMovieClip toString

Class methods

create

static function create (

target:MovieClip, instanceName:String, depth:Number, initObject:Object) : DispatchableMovieClip

Creates an empty instance of the DispatchableMovieClip class. Use this instead of a traditional new constructor statement due to limitations of ActionScript 2.0.

Parameters:

target :

Location where the MovieClip should be attached.

instanceName:

A unique instance name for the MovieClip.

depth :

[optional] The depth level where the MovieClip is placed; defaults to next highest open depth.

initObject :

[optional] An object that contains properties with which to populate the newly attached MovieClip.

Returns:

Returns a reference to the created instance.

Example:

var myDispatch_mc:DispatchableMovieClip = DispatchableMovieClip.create(this, "example_mc");

Usage note:

If you want to extend a non empty MovieClip you can either define the ActionScript 2.0 class in the Flash IDE library or use org.casalib.util.MovieClipUtil.attachMovieRegisterClass.

Since:

Flash Player 7

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 {VISDOC_CODE_BLOCK_2} matches {VISDOC_CODE_BLOCK_3}.

Returns:

Returns {VISDOC_CODE_BLOCK_4} if the observer was established successfully; otherwise {VISDOC_CODE_BLOCK_5}.
#

Specified by:

org.casalib.event.DispatchableInterface.addEventObserver

destroy

function destroy (

) : Void

Removes any internal variables, intervals, enter frames, internal MovieClips and event observers to allow the object to be garbage collected.

Always call new before deleting last object pointer.

Overrides:

CoreMovieClip.destroy

Specified by:

org.casalib.core.CoreInterface.destroy

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 new if observer(s) listening to specifed event were found; otherwise var myDispatch_mc:DispatchableMovieClip = DispatchableMovieClip.create(this, "example_mc");.
#

Specified by:

org.casalib.event.DispatchableInterface.dispatchEvent

removeAllEventObservers

function removeAllEventObservers (

) : Boolean

Removes all observers regardless of scope or event.

Returns:

Returns {VISDOC_CODE_BLOCK_16} if observers were successfully removed; otherwise {VISDOC_CODE_BLOCK_17}.
#

Specified by:

org.casalib.event.DispatchableInterface.removeAllEventObservers

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 {VISDOC_CODE_BLOCK_6} matched {VISDOC_CODE_BLOCK_7}.

Returns:

Returns {VISDOC_CODE_BLOCK_8} if the observer was successfully found and removed; otherwise {VISDOC_CODE_BLOCK_9}.
#

Specified by:

org.casalib.event.DispatchableInterface.removeEventObserver

removeEventObserversForEvent

function removeEventObserversForEvent (

eventName:String) : Boolean

Removes all observers for a specified event.

Parameters:

eventName:

Event name to unsubscribe to.

Returns:

Returns {VISDOC_CODE_BLOCK_10} if observers were successfully found for specified {VISDOC_CODE_BLOCK_11} and removed; otherwise {VISDOC_CODE_BLOCK_12}.
#

Specified by:

org.casalib.event.DispatchableInterface.removeEventObserversForEvent

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 {VISDOC_CODE_BLOCK_13} if observers were successfully found in {VISDOC_CODE_BLOCK_14} and removed; otherwise {VISDOC_CODE_BLOCK_15}.
#

Specified by:

org.casalib.event.DispatchableInterface.removeEventObserversForScope