+Show TOC
×Hide TOC

CoreMovieClip

Kind of class:	class
Inherits from:	MovieClip
Implements:	CoreInterface
Known subclasses:	CoreTextField DispatchableMovieClip ReversibleMovieClip StatedMovieClip
Version:	04/09/07
Author:	Aaron Clinger@auther Mike Creighton
Classpath:	org.casaframework.movieclip.CoreMovieClip
File last modified:	Monday, 09 April 2007, 11:08:29

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

/**
    A core MovieClip to inherent from which extends Flash's built-in MovieClip class. All MovieClip classes should extend from here.
    
    @author Aaron Clinger
    @auther Mike Creighton
    @version 04/09/07
*/

class org.casaframework.movieclip.CoreMovieClip extends MovieClip implements CoreInterface {
    private var $instanceDescription:String;
    
    
    /**
        Creates an empty instance of the CoreMovieClip 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 myCore_mc:CoreMovieClip = CoreMovieClip.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):CoreMovieClip {
        return CoreMovieClip(MovieClipUtil.createMovieRegisterClass('org.casaframework.movieclip.CoreMovieClip', target, instanceName, depth, initObject));
    }
    
    
    private function CoreMovieClip() {
        this.$setClassDescription('org.casaframework.movieclip.CoreMovieClip');
    }
    
    public function toString():String {
        return '[' + this.$instanceDescription + ']';
    }
    
    /**
        Removes the MovieClip after automatically calling {@link #destroy}.
        
        @usageNote <code>removeMovieClip</code> and {@link #destroy} work identically; you can call either method to destory and remove the MovieClip.
    */
    public function removeMovieClip():Void {
        this.destroy();
    }
    
    public function destroy():Void {
        delete this.$instanceDescription;
        
        super.removeMovieClip();
    }
    
    private function $setClassDescription(description:String):Void {
        this.$instanceDescription = description;
    }
}

A core MovieClip to inherent from which extends Flash's built-in MovieClip class. All MovieClip classes should extend from here.

Summary

Class methods

create

Instance methods

toString
removeMovieClip
destroy

Class methods

create

static function create (

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

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

Instance methods

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.

Specified by:

org.casaframework.core.CoreInterface.destroy

removeMovieClip

function removeMovieClip (

) : Void

Removes the MovieClip after automatically calling destroy.

Usage note:

removeMovieClip and destroy work identically; you can call either method to destory and remove the MovieClip.

toString

function toString (

) : String

Returns class description name.

Returns:

Returns class path.

Specified by:

org.casaframework.core.CoreInterface.toString