KeyCombo

Kind of class:public class
Package:org.casalib.ui
Inherits from:none
Version:10/27/08
Author:Aaron Clinger
Classpath:org.casalib.ui.KeyCombo
File last modified:Thursday, 19 February 2009, 11:33:36
Class for storing keyboard key code combinations.

Summary


Constructor
  • KeyCombo (keyCodes:Array)
    • Creates and defines a KeyCombo.
Instance properties
  • keyCodes : Array
    • The key codes that compose this KeyCombo.
Instance methods
  • equals (keyCombo:KeyCombo) : Boolean
    • Determines if the KeyCombo specified in the keyCombo parameter is equal to this KeyCombo.

Constructor

KeyCombo

public 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 type uint or if the Array contains less than 2 values.

Instance properties

keyCodes

public keyCodes:Array
(read)

The key codes that compose this KeyCombo.

Instance methods

equals

public 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; otherwise false.