+Show TOC
×Hide TOC

EventMovieClip

Kind of class:	class
Inherits from:	DispatchableMovieClip < CoreMovieClip < MovieClip
Version:	05/13/07
Author:	Aaron Clinger
Classpath:	org.casalib.movieclip.EventMovieClip
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.DispatchableMovieClip;
import org.casalib.util.MovieClipUtil;

/**
    Dispatches MovieClip event handler notification using {@link EventDispatcher}.
    
    @author Aaron Clinger
    @version 05/13/07
    @example
        <code>
            import org.casalib.movieclip.EventMovieClip;
            import org.casalib.util.MovieClipUtil;
            
            function movieClipLoad(sender_mc:MovieClip):Void {
                trace(sender_mc + " has loaded.");
            }
            
            function movieClipPress(sender_mc:MovieClip):Void {
                trace(sender_mc + " was pressed.");
            }
            
            MovieClipUtil.attachMovieRegisterClass(org.casalib.movieclip.EventMovieClip, this, "linkageMovieClip", "event_mc");
            
            this.event_mc.addEventObserver(this, EventMovieClip.EVENT_LOAD, "movieClipLoad");
            this.event_mc.addEventObserver(this, EventMovieClip.EVENT_PRESS, "movieClipPress");
        </code>
*/

class org.casalib.movieclip.EventMovieClip extends DispatchableMovieClip {
    public static var EVENT_DATA:String            = 'onData';
    public static var EVENT_DRAG_OUT:String        = 'onDragOut';
    public static var EVENT_DRAG_OVER:String       = 'onDragOver';
    public static var EVENT_ENTER_FRAME:String     = 'onEnterFrame';
    public static var EVENT_KEY_DOWN:String        = 'onKeyDown';
    public static var EVENT_KEY_UP:String          = 'onKeyUp';
    public static var EVENT_KILL_FOCUS:String      = 'onKillFocus';
    public static var EVENT_LOAD:String            = 'onLoad';
    public static var EVENT_MOUSE_DOWN:String      = 'onMouseDown';
    public static var EVENT_MOUSE_MOVE:String      = 'onMouseMove';
    public static var EVENT_MOUSE_UP:String        = 'onMouseUp';
    public static var EVENT_PRESS:String           = 'onPress';
    public static var EVENT_RELEASE:String         = 'onRelease';
    public static var EVENT_RELEASE_OUTSIDE:String = 'onReleaseOutside';
    public static var EVENT_ROLL_OUT:String        = 'onRollOut';
    public static var EVENT_ROLL_OVER:String       = 'onRollOver';
    public static var EVENT_SET_FOCUS:String       = 'onSetFocus';
    public static var EVENT_UNLOAD:String          = 'onUnload';
    
    
    /**
        Creates an empty instance of the EventMovieClip 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 myEvent_mc:EventMovieClip = EventMovieClip.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):EventMovieClip {
        return EventMovieClip(MovieClipUtil.createMovieRegisterClass('org.casalib.movieclip.EventMovieClip', target, instanceName, depth, initObject));
    }
    
    
    private function EventMovieClip() {
        super();
        
        this.$setClassDescription('org.casalib.movieclip.EventMovieClip');
    }
    
    /**
        @exclude
        @sends onData = function(sender_mc:MovieClip) {}
    */
    public function onData():Void {
        this.dispatchEvent(EventMovieClip.EVENT_DATA, this);
    }
    
    /**
        @exclude
        @sends onDragOut = function(sender_mc:MovieClip) {}
    */
    public function onDragOut():Void {
        this.dispatchEvent(EventMovieClip.EVENT_DRAG_OUT, this);
    }
    
    /**
        @exclude
        @sends onDragOver = function(sender_mc:MovieClip) {}
    */
    public function onDragOver():Void {
        this.dispatchEvent(EventMovieClip.EVENT_DRAG_OVER, this);
    }
    
    /**
        @exclude
        @sends onEnterFrame = function(sender_mc:MovieClip) {}
    */
    public function onEnterFrame():Void {
        this.dispatchEvent(EventMovieClip.EVENT_ENTER_FRAME, this);
    }
    
    /**
        @exclude
        @sends onKeyDown = function(sender_mc:MovieClip) {}
    */
    public function onKeyDown():Void {
        this.dispatchEvent(EventMovieClip.EVENT_KEY_DOWN, this);
    }
    
    /**
        @exclude
        @sends onKeyUp = function(sender_mc:MovieClip) {}
    */
    public function onKeyUp():Void {
        this.dispatchEvent(EventMovieClip.EVENT_KEY_UP, this);
    }
    
    /**
        @exclude
        @sends onKillFocus = function(sender_mc:MovieClip, newFocus:Object) {}
    */
    public function onKillFocus(newFocus:Object):Void {
        this.dispatchEvent(EventMovieClip.EVENT_KILL_FOCUS, this, newFocus);
    }
    
    /**
        @exclude
        @sends onLoad = function(sender_mc:MovieClip) {}
    */
    public function onLoad():Void {
        this.dispatchEvent(EventMovieClip.EVENT_LOAD, this);
    }
    
    /**
        @exclude
        @sends onMouseDown = function(sender_mc:MovieClip) {}
    */
    public function onMouseDown():Void {
        this.dispatchEvent(EventMovieClip.EVENT_MOUSE_DOWN, this);
    }
    
    /**
        @exclude
        @sends onMouseMove = function(sender_mc:MovieClip) {}
    */
    public function onMouseMove():Void {
        this.dispatchEvent(EventMovieClip.EVENT_MOUSE_MOVE, this);
    }
    
    /**
        @exclude
        @sends onMouseUp = function(sender_mc:MovieClip) {}
    */
    public function onMouseUp():Void {
        this.dispatchEvent(EventMovieClip.EVENT_MOUSE_UP, this);
    }
    
    /**
        @exclude
        @sends onPress = function(sender_mc:MovieClip) {}
    */
    public function onPress():Void {
        this.dispatchEvent(EventMovieClip.EVENT_PRESS, this);
    }
    
    /**
        @exclude
        @sends onRelease = function(sender_mc:MovieClip) {}
    */
    public function onRelease():Void {
        this.dispatchEvent(EventMovieClip.EVENT_RELEASE, this);
    }
    
    /**
        @exclude
        @sends onReleaseOutside = function(sender_mc:MovieClip) {}
    */
    public function onReleaseOutside():Void {
        this.dispatchEvent(EventMovieClip.EVENT_RELEASE_OUTSIDE, this);
    }
    
    /**
        @exclude
        @sends onRollOut = function(sender_mc:MovieClip) {}
    */
    public function onRollOut():Void {
        this.dispatchEvent(EventMovieClip.EVENT_ROLL_OUT, this);
    }
    
    /**
        @exclude
        @sends onRollOver = function(sender_mc:MovieClip) {}
    */
    public function onRollOver():Void {
        this.dispatchEvent(EventMovieClip.EVENT_ROLL_OVER, this);
    }
    
    /**
        @exclude
        @sends onSetFocus = function(sender_mc:MovieClip, oldFocus:Object) {}
    */
    public function onSetFocus(oldFocus:Object):Void {
        this.dispatchEvent(EventMovieClip.EVENT_SET_FOCUS, this, oldFocus);
    }
    
    /**
        @exclude
        @sends onUnload = function(sender_mc:MovieClip) {}
    */
    public function onUnload():Void {
        this.dispatchEvent(EventMovieClip.EVENT_UNLOAD, this);
    }
}

Dispatches MovieClip event handler notification using org.casalib.event.EventDispatcher.

Example:

import org.casalib.movieclip.EventMovieClip;
import org.casalib.util.MovieClipUtil;

function movieClipLoad(sender_mc:MovieClip):Void {
    trace(sender_mc + " has loaded.");
}

function movieClipPress(sender_mc:MovieClip):Void {
    trace(sender_mc + " was pressed.");
}

MovieClipUtil.attachMovieRegisterClass(org.casalib.movieclip.EventMovieClip, this, "linkageMovieClip", "event_mc");

this.event_mc.addEventObserver(this, EventMovieClip.EVENT_LOAD, "movieClipLoad");
this.event_mc.addEventObserver(this, EventMovieClip.EVENT_PRESS, "movieClipPress");

Events broadcasted to listeners:

onData = function (sender_mc:MovieClip) {}
onDragOut = function (sender_mc:MovieClip) {}
onDragOver = function (sender_mc:MovieClip) {}
onEnterFrame = function (sender_mc:MovieClip) {}
onKeyDown = function (sender_mc:MovieClip) {}
onKeyUp = function (sender_mc:MovieClip) {}
onKillFocus = function (sender_mc:MovieClip, newFocus:Object) {}
onLoad = function (sender_mc:MovieClip) {}
onMouseDown = function (sender_mc:MovieClip) {}
onMouseMove = function (sender_mc:MovieClip) {}
onMouseUp = function (sender_mc:MovieClip) {}
onPress = function (sender_mc:MovieClip) {}
onRelease = function (sender_mc:MovieClip) {}
onReleaseOutside = function (sender_mc:MovieClip) {}
onRollOut = function (sender_mc:MovieClip) {}
onRollOver = function (sender_mc:MovieClip) {}
onSetFocus = function (sender_mc:MovieClip, oldFocus:Object) {}
onUnload = function (sender_mc:MovieClip) {}

Summary

Class properties

EVENT_DATA : String
EVENT_DRAG_OUT : String
EVENT_DRAG_OVER : String
EVENT_ENTER_FRAME : String
EVENT_KEY_DOWN : String
EVENT_KEY_UP : String
EVENT_KILL_FOCUS : String
EVENT_LOAD : String
EVENT_MOUSE_DOWN : String
EVENT_MOUSE_MOVE : String
EVENT_MOUSE_UP : String
EVENT_PRESS : String
EVENT_RELEASE : String
EVENT_RELEASE_OUTSIDE : String
EVENT_ROLL_OUT : String
EVENT_ROLL_OVER : String
EVENT_SET_FOCUS : String
EVENT_UNLOAD : String

Class methods

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

Class methods inherited from DispatchableMovieClip

create

Class methods inherited from CoreMovieClip

create

Instance methods

Instance methods inherited from DispatchableMovieClip

addEventObserver destroy dispatchEvent removeAllEventObservers removeEventObserver removeEventObserversForEvent removeEventObserversForScope

Instance methods inherited from CoreMovieClip

$setClassDescription destroy removeMovieClip toString

Class properties

EVENT_DATA

static EVENT_DATA:String = 'onData'

(read,write)

EVENT_DRAG_OUT

static EVENT_DRAG_OUT:String = 'onDragOut'

(read,write)

EVENT_DRAG_OVER

static EVENT_DRAG_OVER:String = 'onDragOver'

(read,write)

EVENT_ENTER_FRAME

static EVENT_ENTER_FRAME:String = 'onEnterFrame'

(read,write)

EVENT_KEY_DOWN

static EVENT_KEY_DOWN:String = 'onKeyDown'

(read,write)

EVENT_KEY_UP

static EVENT_KEY_UP:String = 'onKeyUp'

(read,write)

EVENT_KILL_FOCUS

static EVENT_KILL_FOCUS:String = 'onKillFocus'

(read,write)

EVENT_LOAD

static EVENT_LOAD:String = 'onLoad'

(read,write)

EVENT_MOUSE_DOWN

static EVENT_MOUSE_DOWN:String = 'onMouseDown'

(read,write)

EVENT_MOUSE_MOVE

static EVENT_MOUSE_MOVE:String = 'onMouseMove'

(read,write)

EVENT_MOUSE_UP

static EVENT_MOUSE_UP:String = 'onMouseUp'

(read,write)

EVENT_PRESS

static EVENT_PRESS:String = 'onPress'

(read,write)

EVENT_RELEASE

static EVENT_RELEASE:String = 'onRelease'

(read,write)

EVENT_RELEASE_OUTSIDE

static EVENT_RELEASE_OUTSIDE:String = 'onReleaseOutside'

(read,write)

EVENT_ROLL_OUT

static EVENT_ROLL_OUT:String = 'onRollOut'

(read,write)

EVENT_ROLL_OVER

static EVENT_ROLL_OVER:String = 'onRollOver'

(read,write)

EVENT_SET_FOCUS

static EVENT_SET_FOCUS:String = 'onSetFocus'

(read,write)

EVENT_UNLOAD

static EVENT_UNLOAD:String = 'onUnload'

(read,write)

Class methods

create

static function create (

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

Creates an empty instance of the EventMovieClip 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 myEvent_mc:EventMovieClip = EventMovieClip.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