DispatchableMovieClip

Kind of class:class
Inherits from:CoreMovieClip < MovieClip
Implements:
Known subclasses:
Version:05/13/07
Author:Aaron Clinger
Classpath:org.casaframework.movieclip.DispatchableMovieClip
File last modified:Sunday, 19 August 2007, 13:43:28
Base MovieClip that includes org.casaframework.event.EventDispatcher and extends CoreMovieClip.

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.casaframework.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 eventHandler matches eventName.
#
Returns:
Returns true if the observer was established successfully; otherwise false.
#

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 destroy() before deleting last object pointer.
#

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.
#