+Show TOC
×Hide TOC

LockableInterface

Kind of class:	interface
Inherits from:	CoreInterface
Implemented by:	LockingMovieClip
Version:	04/03/06
Author:	Aaron Clinger, Toby Boudreaux
Classpath:	org.casalib.state.LockableInterface
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.CoreInterface;

/**
    Interface for creating lockable items.

    @author Aaron Clinger
    @author Toby Boudreaux
    @version 04/03/06
*/

interface org.casalib.state.LockableInterface extends CoreInterface {
    
    /**
        Stores and removes event handlers to prevent them from triggering.
        
        @param inclusionList: <strong>[optional]</strong> List of event handlers and properties to lock. Defaults to all MovieClip event handlers.
    */
    public function lock(inclusionList:Array):Void;
    
    /**
        Restores "locked" event handlers.
    */
    public function unlock():Void;
    
    /**
        Switches the current state to the opposite state; between {@link #lock} and {@link #unlock}.
    */
    public function toggle():Void;
    
    /**
        @return Returns <code>true</code> if currently locked; otherwise <code>false</code>.
    */
    public function isLocked():Boolean;
}

Interface for creating lockable items.

Summary

Instance methods

lock (inclusionList:Array) : Void
- Stores and removes event handlers to prevent them from triggering.
unlock : Void
- Restores "locked" event handlers.
toggle : Void
- Switches the current state to the opposite state; between lock and unlock.
isLocked : Boolean

Instance methods inherited from CoreInterface

destroy toString

Instance methods

isLocked

function isLocked (

) : Boolean

Returns:

Returns true if currently locked; otherwise false.

lock

function lock (

inclusionList:Array) : Void

Stores and removes event handlers to prevent them from triggering.

Parameters:

inclusionList:

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

toggle

function toggle (

) : Void

Switches the current state to the opposite state; between lock and unlock.

unlock

function unlock (

) : Void

Restores "locked" event handlers.