+Show TOC
×Hide TOC

EventSound

Kind of class:	class
Inherits from:	Sound
Implements:	DispatchableInterface
Version:	02/06/07
Author:	Aaron Clinger
Classpath:	org.casalib.sound.EventSound
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.event.DispatchableInterface;
import org.casalib.event.EventDispatcher;

/**
    Base Sound object that includes {@link EventDispatcher} and implements {@link CoreInterface}. All Sound classes implementing EventDispatcher should inherent from this class.

    @author Aaron Clinger
    @version 02/06/07
    @example
        <code>
            function onSoundLoad(sender:EventSound, success:Boolean):Void {
                if (success) {
                    sender.start();
                }
            }

            function onSoundId3(sender:EventSound, id3:Object):Void {
                for (var i:String in id3) {
                    trace(i + ": " + id3[i]);
                }
            }

            var eventSound:EventSound = new EventSound(this);
            this.eventSound.addEventObserver(this, EventSound.EVENT_LOAD, "onSoundLoad");
            this.eventSound.addEventObserver(this, EventSound.EVENT_ID3, "onSoundId3");
            this.eventSound.loadSound("test.mp3");
        </code>
*/

class org.casalib.sound.EventSound extends Sound implements DispatchableInterface {
    public static var EVENT_ID3:String            = 'onID3';
    public static var EVENT_LOAD:String           = 'onLoad';
    public static var EVENT_SOUND_COMPLETE:String = 'onSoundComplete';
    private var $eventDispatcher:EventDispatcher;
    private var $instanceDescription:String;
    
    /**
        Creates an EventSound object.
        
        @param target_mc: The MovieClip instance on which the Sound object operates.
    */
    public function EventSound(target_mc:MovieClip) {
        super(target_mc);
        
        this.$eventDispatcher = new EventDispatcher();
        
        this.$setClassDescription('org.casalib.sound.EventSound');
    }
    
    /**
        @sends onID3 = function(sender:EventSound, id3:Object) {}
    */
    private function onID3():Void {
        this.dispatchEvent(EventSound.EVENT_ID3, this, this.id3);
    }
    
    /**
        @sends onLoad = function(sender:EventSound, success:Boolean) {}
    */
    private function onLoad(success:Boolean):Void {
        this.dispatchEvent(EventSound.EVENT_LOAD, this, success);
    }
    
    /**
        @sends onSoundComplete = function(sender:EventSound) {}
    */
    private function onSoundComplete():Void {
        this.dispatchEvent(EventSound.EVENT_SOUND_COMPLETE, this);
    }
    
    public function toString():String {
        return '[' + this.$instanceDescription + ']';
    }

    private function $setClassDescription(description:String):Void {
        this.$instanceDescription = description;
    }
    
    /**
        {@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 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();
    }
    
    public function destroy():Void {
        this.$eventDispatcher.destroy();
        delete this.$eventDispatcher;
        delete this.$instanceDescription;
    }
}

Base Sound object that includes org.casalib.event.EventDispatcher and implements org.casalib.core.CoreInterface. All Sound classes implementing EventDispatcher should inherent from this class.

Example:

function onSoundLoad(sender:EventSound, success:Boolean):Void {
    if (success) {
        sender.start();
    }
}

function onSoundId3(sender:EventSound, id3:Object):Void {
    for (var i:String in id3) {
        trace(i + ": " + id3[i]);
    }
}

var eventSound:EventSound = new EventSound(this);
this.eventSound.addEventObserver(this, EventSound.EVENT_LOAD, "onSoundLoad");
this.eventSound.addEventObserver(this, EventSound.EVENT_ID3, "onSoundId3");
this.eventSound.loadSound("test.mp3");

Events broadcasted to listeners:

onID3 = function (sender:EventSound, id3:Object) {}
onLoad = function (sender:EventSound, success:Boolean) {}
onSoundComplete = function (sender:EventSound) {}

Summary

Constructor

EventSound (target_mc:MovieClip)
- Creates an EventSound object.

Class properties

EVENT_ID3 : String
EVENT_LOAD : String
EVENT_SOUND_COMPLETE : String

Instance methods

toString : String
- Returns class description name.
dispatchEvent (eventName:String) : Boolean
- Reports event to all subscribed objects.
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.
destroy : Void
- Removes any internal variables, intervals, enter frames, internal MovieClips and event observers to allow the object to be garbage collected.

Constructor

EventSound

function EventSound (

target_mc:MovieClip)

Creates an EventSound object.

Parameters:

target_mc:

The MovieClip instance on which the Sound object operates.

Class properties

EVENT_ID3

static EVENT_ID3:String = 'onID3'

(read,write)

EVENT_LOAD

static EVENT_LOAD:String = 'onLoad'

(read,write)

EVENT_SOUND_COMPLETE

static EVENT_SOUND_COMPLETE:String = 'onSoundComplete'

(read,write)

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
function onSoundLoad(sender:EventSound, success:Boolean):Void { if (success) { sender.start(); } } function onSoundId3(sender:EventSound, id3:Object):Void { for (var i:String in id3) { trace(i + ": " + id3[i]); } } var eventSound:EventSound = new EventSound(this); this.eventSound.addEventObserver(this, EventSound.EVENT_LOAD, "onSoundLoad"); this.eventSound.addEventObserver(this, EventSound.EVENT_ID3, "onSoundId3"); this.eventSound.loadSound("test.mp3");
before deleting last object pointer.

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

function onSoundLoad(sender:EventSound, success:Boolean):Void {
    if (success) {
        sender.start();
    }
}

function onSoundId3(sender:EventSound, id3:Object):Void {
    for (var i:String in id3) {
        trace(i + ": " + id3[i]);
    }
}

var eventSound:EventSound = new EventSound(this);
this.eventSound.addEventObserver(this, EventSound.EVENT_LOAD, "onSoundLoad");
this.eventSound.addEventObserver(this, EventSound.EVENT_ID3, "onSoundId3");
this.eventSound.loadSound("test.mp3");

if observer(s) listening to specifed event were found; otherwise {VISDOC_CODE_BLOCK_1}.

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

toString

function toString (

) : String

Returns class description name.

Returns:

Returns class path.
#

Specified by:

org.casalib.core.CoreInterface.toString