KeyCombo
Kind of class: | public class |
---|---|
Package: | |
Inherits from: |
|
Version: | 10/27/08 |
Author: | Aaron Clinger |
Classpath: | org.casalib.ui.KeyCombo |
File last modified: | Friday, 20 May 2011, 00:59:44 |
► View source▼ Hide source
/* CASA Lib for ActionScript 3.0 Copyright (c) 2011, 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. */ package org.casalib.ui { import org.casalib.errors.ArrayContentsError; import org.casalib.util.ArrayUtil; /** Class for storing keyboard key code combinations. @author Aaron Clinger @version 10/27/08 */ public class KeyCombo { protected var _keyCodes:Array; /** Creates and defines a KeyCombo. @param keyCodes: An Array ofuint
key codes that define a key combination. @throws ArrayContentsError ifkeyCodes
Array contains a value not of typeuint
or if the Array contains less than 2 values. */ public function KeyCombo(keyCodes:Array) { if (keyCodes.length < 2) throw new ArrayContentsError(); var l:uint = keyCodes.length; while (l--) if (!(keyCodes[l] is uint)) throw new ArrayContentsError(); this._keyCodes = keyCodes.concat(); } /** The key codes that compose this KeyCombo. */ public function get keyCodes():Array { return this._keyCodes.concat(); } /** Determines if the KeyCombo specified in thekeyCombo
parameter is equal to this KeyCombo. @param keyCombo: The KeyCombo class to compare to this class. @return Returnstrue
if the two KeyCombo classes contain the same key codes in the same order; otherwisefalse
. */ public function equals(keyCombo:KeyCombo):Boolean { if (keyCombo == this) return true; return ArrayUtil.equals(this.keyCodes, keyCombo.keyCodes); } } }
Class for storing keyboard key code combinations.
Summary
Constructor
KeyCombo
function KeyCombo(keyCodes:Array)
Creates and defines a KeyCombo.
Parameters
keyCodes:An Array of
uint
key codes that define a key combination.
Throws
-
ArrayContentsError if
keyCodes
Array contains a value not of typeuint
or if the Array contains less than 2 values.
Instance properties
keyCodes
keyCodes:Array(read)
The key codes that compose this KeyCombo.
Instance methods
equals
function equals(keyCombo:KeyCombo) : Boolean
Determines if the KeyCombo specified in the keyCombo
parameter is equal to this KeyCombo.
Parameters
keyCombo:The KeyCombo class to compare to this class.
Returns
-
Returns
true
if the two KeyCombo classes contain the same key codes in the same order; otherwisefalse
.