+Show TOC
×Hide TOC

ValueState

Kind of class:	class
Inherits from:	CoreObject
Implements:	StateableInterface
Known subclasses:	ButtonEventHandlerState
Version:	12/14/06
Author:	Toby Boudreaux, Aaron Clinger
Classpath:	org.casalib.state.ValueState
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.core.CoreObject;
import org.casalib.state.StateableInterface;

/**
    Class designed to store key value pairs.
    
    @author Toby Boudreaux
    @author Aaron Clinger
    @version 12/14/06
*/

class org.casalib.state.ValueState extends CoreObject implements StateableInterface {
    private var $values:Object;
    
    public function ValueState() {
        super();
        this.$values = new Object();
        this.$setClassDescription('org.casalib.state.ValueState');
    }
    
    public function setValueForKey(key:String, value:Object):Void {
        if (key == undefined)
            return;
        
        this.$values[key] = value;
    }
    
    public function getValueForKey(key:String):Object {
        return this.$values[key];
    }
    
    public function removeValueForKey(key:String):Boolean {
        if (this.$values[key] != undefined) {
            delete this.$values[key];
            return true;
        }
        
        return false;
    }
    
    public function getValueKeys(): /*String*/ Array {
        var r: /*String*/ Array = new Array();
        
        for (var i:String in this.$values)
            r.push(i);
        
        return r;
    }
    
    public function destroy():Void {
        delete this.$values;
        super.destroy();
    }
}

Class designed to store key value pairs.

Summary

Constructor

ValueState

Instance methods

setValueForKey (key:String, value:Object) : Void
- Stores a key value pair.
getValueForKey (key:String) : Object
- Gets the value of specified key.
removeValueForKey (key:String) : Boolean
- Removes a key value pair from being stored.
getValueKeys : Array
destroy : Void
- Removes any internal variables, intervals, enter frames, internal MovieClips and event observers to allow the object to be garbage collected.

Instance methods inherited from CoreObject

$setClassDescription destroy toString

Constructor

ValueState

function ValueState (

)

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 {VISDOC_CODE_BLOCK_0} before deleting last object pointer.

Overrides:

org.casalib.core.CoreObject.destroy

Specified by:

org.casalib.core.CoreInterface.destroy

getValueForKey

function getValueForKey (

key:String) : Object

Gets the value of specified key.

Parameters:

key:

Name of key.

Returns:

Value of key.
#

Specified by:

StateableInterface.getValueForKey

getValueKeys

function getValueKeys (

) : Array

Returns:

Returns an Array composed of all stored key names as strings.
#

Specified by:

StateableInterface.getValueKeys

removeValueForKey

function removeValueForKey (

key:String) : Boolean

Removes a key value pair from being stored.

Parameters:

key:

Name of key.

Returns:

Returns {VISDOC_CODE_BLOCK_0} if key value pair was found and removed; otherwise {VISDOC_CODE_BLOCK_1}.
#

Specified by:

StateableInterface.removeValueForKey

setValueForKey

function setValueForKey (

key:String, value:Object) : Void

Stores a key value pair.

Parameters:

key :

Name of key.

value:

Value of key.

Specified by:

StateableInterface.setValueForKey