+Show TOC
×Hide TOC

StatedMovieClip

Kind of class:	class
Inherits from:	CoreMovieClip < MovieClip
Known subclasses:	LockingMovieClip
Version:	05/13/07
Author:	Toby Boudreaux, David Nelson, Aaron Clinger
Classpath:	org.casaframework.movieclip.StatedMovieClip
File last modified:	Sunday, 19 August 2007, 13:43:28

► 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.CoreMovieClip;
import org.casaframework.state.MovieClipEventHandlerState;
import org.casaframework.util.MovieClipUtil;

/**
    Provides state-switching mechanism for MovieClip event handlers and properties.

    @author Toby Boudreaux
    @author David Nelson
    @author Aaron Clinger
    @version 05/13/07
    @example
        <code>
            import org.casaframework.util.MovieClipUtil;
            
            MovieClipUtil.attachMovieRegisterClass(org.casaframework.movieclip.StatedMovieClip, this, "linkageMovieClip", "stated_mc");
            
            this.stated_mc.onRelease = function():Void {
                trace("onRelease on " + this._name + " was called. Example one.");
            }
            
            this.stated_mc.createState("exampleButtonOne");
            
            this.stated_mc.onRelease = function():Void {
                trace("onRelease on " + this._name + " was called. Example two.");
            }
            
            this.stated_mc.createState("exampleButtonTwo");
        </code>
    
        Now you can switch between the states, example:
        <code>this.stated_mc.switchState("exampleButtonOne");</code> or <code>this.stated_mc.switchState("exampleButtonTwo");</code>
    
        To return to the default creation state call:
        <code>this.stated_mc.switchState("default");</code>
        
        To remove all event handlers call:
        <code>this.stated_mc.switchState("blank");</code>
    @usageNote Class creates <code>"default"</code> and <code>"blank"</code> states during MovieClip instance creation.
*/

class org.casaframework.movieclip.StatedMovieClip extends CoreMovieClip {
    private var $states:Object;
    private var $currentState:String;
    
    
    /**
        Creates an empty instance of the StatedMovieClip 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 myStated_mc:StatedMovieClip = StatedMovieClip.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):StatedMovieClip {
        return StatedMovieClip(MovieClipUtil.createMovieRegisterClass('org.casaframework.movieclip.StatedMovieClip', target, instanceName, depth, initObject));
    }
    
    
    private function StatedMovieClip() {
        super();
        
        this.$states = new Object();
        this.createState('blank', new Array());
        this.createState('default');
        
        this.$setClassDescription('org.casaframework.movieclip.StatedMovieClip');
    }
    
    /**
        Returns the current state of MovieClip. If no state has been created {@link #getState} will return <code>"default"</code>.
    
        @return The name of current MovieClip state.
        @usageNote {@link #getState} will always return last created or switched to state.
    */
    public function getState():String {
        return this.$currentState;
    }
    
    /**
        Switches MovieClip's current state to a precreated state.
    
        @param stateName: Name of precreated MovieClip state.
        @param inclusionList: <strong>[optional]</strong> List of event handlers and properties to include/switch state of. Defaults to all MovieClip event handlers.
        @return Returns <code>true</code> if the precreated state was found and the MovieClip's state was successfully changed; otherwise <code>false</code>.
        @example <code>this.stated_mc.switchState("uniqueStateName", new Array("onEnterFrame", "onRelease"));</code>
        @see {@link #createState}
    */
    public function switchState(stateName:String, inclusionList:Array):Boolean {
        if (stateName == undefined || this.$states[stateName] == undefined)
            return false;
        
        this.$currentState = stateName;
        
        var keyList:Array = (inclusionList == undefined) ? this.$states[stateName].getValueKeys() : inclusionList;
        var key:String;
        
        for (var i:String in keyList) {
            key = keyList[i];
            this[key] = this.$states[stateName].getValueForKey(key);
        }
        
        return true;
    }
    
    /**
        Creates a new state and records event handlers.
        
        @param stateName: Unique name for MovieClip state.
        @param inclusionList: <strong>[optional]</strong> List of event handlers and properties to include. Defaults to all MovieClip event handlers.
        @usageNote If parameter <code>stateName</code> is identical to previously created state, {@link #createState} will overwrite it.
        @example <code>this.stated_mc.createState("uniqueStateName", new Array("onRollOver", "onRollOut", "onRelease"));</code>
        @see {@link MovieClipEventHandlerState}
    */
    public function createState(stateName:String, inclusionList:Array):Void {
        if (stateName == undefined)
            return;
        
        this.$currentState = stateName;
        this.$states[stateName] = new MovieClipEventHandlerState();
        
        var keyList:Array = (inclusionList == undefined) ? this.$states[stateName].getValueKeys() : inclusionList;
        var key:String;
        
        for (var i:String in keyList) {
            key = keyList[i];
            this.$states[stateName].setValueForKey(key, this[key]);
        }
    }
    
    /**
        Registers single value to a MovieClip property for a given state.
    
        @param stateName: Name of precreated MovieClip state, or new state.
        @param keyName: Name of any MovieClip property or event handler.
        @param value: Value of MovieClip property or event handler specified by parameter <code>keyName</code>.
        @example 
            <code>
                var anonymousFunction:Function = function():Void {
                    trace("onRollOver");
                } 
            
                this.stated_mc.setKeyValueForState("stateName", "onRollOver", anonymousFunction);
            </code>
            
            You can define any MovieClip properties, not just event handlers. Such as <code>_alpha</code>, <code>_x</code>, <code>_yscale</code> etc...:
            <code>this.stated_mc.setKeyValueForState("stateName", "_alpha", 25);</code>
    */
    public function setKeyValueForState(stateName:String, keyName:String, value:Object):Void {
        if (this.$states[stateName] == undefined)
            this.$states[stateName] = new MovieClipEventHandlerState();
        
        this.$states[stateName].setValueForKey(keyName, value);
    }
    
    /**
        Removes/unregisters value from MovieClip property for a given state.
        
        @param stateName: Name of precreated MovieClip state.
        @param keyName: Name of any MovieClip property or event handler.
        @return Returns <code>true</code> if the key was successfully found and removed from event handler state; otherwise <code>false</code>.
    */
    public function removeKeyValueForState(stateName:String, keyName:String):Boolean {
        if (this.$states[stateName] == undefined)
            return false;
        
        return this.$states[stateName].removeValueForKey(keyName);
    }
    
    /**
        Deletes precreated MovieClip state.
        
        @param stateName: Name of precreated MovieClip state.
        @return Returns <code>true</code> if the state was successfully found and removed; otherwise <code>false</code>.
    */
    public function removeState(stateName:String):Boolean {
        if (stateName == undefined || this.$states[stateName] == undefined)
            return false;
        
        delete this.$states[stateName];
        
        return true;
    }
    
    public function destroy():Void {
        delete this.$states;
        delete this.$currentState;
        
        super.destroy();
    }
}

Provides state-switching mechanism for MovieClip event handlers and properties.

Example:

import org.casaframework.util.MovieClipUtil;

MovieClipUtil.attachMovieRegisterClass(org.casaframework.movieclip.StatedMovieClip, this, "linkageMovieClip", "stated_mc");

this.stated_mc.onRelease = function():Void {
    trace("onRelease on " + this._name + " was called. Example one.");
}

this.stated_mc.createState("exampleButtonOne");

this.stated_mc.onRelease = function():Void {
    trace("onRelease on " + this._name + " was called. Example two.");
}

this.stated_mc.createState("exampleButtonTwo");

Now you can switch between the states, example:
this.stated_mc.switchState("exampleButtonOne"); or this.stated_mc.switchState("exampleButtonTwo");

To return to the default creation state call:
this.stated_mc.switchState("default");

To remove all event handlers call:
this.stated_mc.switchState("blank");

Usage note:

Class creates "default" and "blank" states during MovieClip instance creation.

Summary

Instance properties

Instance properties inherited from CoreMovieClip

$instanceDescription

Class methods

create

Class methods inherited from CoreMovieClip

create

Instance methods

getState
switchState
createState
setKeyValueForState
removeKeyValueForState
removeState
destroy

Instance methods inherited from CoreMovieClip

$setClassDescription destroy removeMovieClip toString

Class methods

create

static function create (target:MovieClip, instanceName:String, depth:Number, initObject:Object) : StatedMovieClip

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

createState

function createState (stateName:String, inclusionList:Array) : Void

Creates a new state and records event handlers.

Parameters:

stateName :

Unique name for MovieClip state.

inclusionList:

[optional] List of event handlers and properties to include. Defaults to all MovieClip event handlers.

Usage note:

If parameter stateName is identical to previously created state, createState will overwrite it.

Example:

this.stated_mc.createState("uniqueStateName", new Array("onRollOver", "onRollOut", "onRelease"));

destroy

function destroy () : Void

Overrides:

CoreMovieClip.destroy

getState

function getState () : String

Returns the current state of MovieClip. If no state has been created getState will return "default".

Returns:

The name of current MovieClip state.

Usage note:

getState will always return last created or switched to state.

removeKeyValueForState

function removeKeyValueForState (stateName:String, keyName:String) : Boolean

Removes/unregisters value from MovieClip property for a given state.

Parameters:

stateName:

Name of precreated MovieClip state.

keyName :

Name of any MovieClip property or event handler.

Returns:

Returns true if the key was successfully found and removed from event handler state; otherwise false.

removeState

function removeState (stateName:String) : Boolean

Deletes precreated MovieClip state.

Parameters:

stateName:

Name of precreated MovieClip state.

Returns:

Returns true if the state was successfully found and removed; otherwise false.

setKeyValueForState

function setKeyValueForState (stateName:String, keyName:String, value:Object) : Void

Registers single value to a MovieClip property for a given state.

Parameters:

stateName:

Name of precreated MovieClip state, or new state.

keyName :

Name of any MovieClip property or event handler.

value :

Value of MovieClip property or event handler specified by parameter keyName.

Example:

var anonymousFunction:Function = function():Void {;
    trace("onRollOver");
} 

this.stated_mc.setKeyValueForState("stateName", "onRollOver", anonymousFunction);

You can define any MovieClip properties, not just event handlers. Such as _alpha, _x, _yscale etc...:
this.stated_mc.setKeyValueForState("stateName", "_alpha", 25);

switchState

function switchState (stateName:String, inclusionList:Array) : Boolean

Switches MovieClip's current state to a precreated state.

Parameters:

stateName :

Name of precreated MovieClip state.

inclusionList:

[optional] List of event handlers and properties to include/switch state of. Defaults to all MovieClip event handlers.

Returns:

Returns true if the precreated state was found and the MovieClip's state was successfully changed; otherwise false.

Example:

this.stated_mc.switchState("uniqueStateName", new Array("onEnterFrame", "onRelease"));