+Show TOC
×Hide TOC

EventMovieClip

Kind of class:	class
Inherits from:	DispatchableMovieClip < CoreMovieClip < MovieClip
Version:	04/09/07
Author:	Aaron Clinger
Classpath:	org.casaframework.movieclip.EventMovieClip
File last modified:	Monday, 09 April 2007, 16:52:37

► 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.movieclip.DispatchableMovieClip;
import org.casaframework.util.MovieClipUtil;

/**
    Dispatches MovieClip event handler notification using {@link EventDispatcher}.
    
    @author Aaron Clinger
    @version 04/09/07
    @example
        <code>
            import org.casaframework.movieclip.EventMovieClip;
            import org.casaframework.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.casaframework.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.casaframework.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}.
    */
    public static function create(target:MovieClip, instanceName:String, depth:Number, initObject:Object):EventMovieClip {
        return EventMovieClip(MovieClipUtil.createMovieRegisterClass('org.casaframework.movieclip.EventMovieClip', target, instanceName, depth, initObject));
    }
    
    
    private function EventMovieClip() {
        super();
        
        this.$setClassDescription('org.casaframework.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.casaframework.event.EventDispatcher.

Example:

import org.casaframework.movieclip.EventMovieClip;
import org.casaframework.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.casaframework.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 broadcast 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
EVENT_DRAG_OUT
EVENT_DRAG_OVER
EVENT_ENTER_FRAME
EVENT_KEY_DOWN
EVENT_KEY_UP
EVENT_KILL_FOCUS
EVENT_LOAD
EVENT_MOUSE_DOWN
EVENT_MOUSE_MOVE
EVENT_MOUSE_UP
EVENT_PRESS
EVENT_RELEASE
EVENT_RELEASE_OUTSIDE
EVENT_ROLL_OUT
EVENT_ROLL_OVER
EVENT_SET_FOCUS
EVENT_UNLOAD

Instance properties

Instance properties inherited from DispatchableMovieClip

$eventDispatcher

Instance properties inherited from CoreMovieClip

$instanceDescription

Class methods

create

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.casaframework.util.MovieClipUtil.attachMovieRegisterClass.