+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.casaframework.state.LockableInterface
File last modified:	Sunday, 19 August 2007, 13:43:26

► 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;

/**
    Interface for creating lockable items.

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

interface org.casaframework.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
unlock
toggle
isLocked

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.