MACROMEDIA FLASH MX, Reference

Page: 358 / 1104

358 Chapter 2: ActionScript Language Reference
Key.isToggled()
Availability
Flash Player 5.
Usage
Key.isToggled( keycode:Number ) : Boolean
Parameters
keycode
The key code for the Caps Lock key (20) or the Num Lock key (144).
Returns
A Boolean value.
Description
Method: returns
true
if the Caps Lock or Num Lock key is activated (toggled to an active state);
false
otherwise. Although the term toggled usually means that something is switched between
two options, the method Key.isToggled() will only return
true
if the key is toggled to an active
state. On the Macintosh, the key code values for the Caps Lock and Num Lock keys are identical.
Example
The following example calls the
isToggled()
method any time a key is pressed and executes a
trace statement any time the Caps Lock key is toggled to an active state. The example creates a
listener object named
keyListener
and defines a function that responds to the
onKeyDown
event
by calling
Key.isToggled()
. For more information, see “Using event listeners” in Using
ActionScript in Flash . The
keyListener
object is then registered to the
Key
object, which
broadcasts the
onKeyDown
message whenever a key is pressed while the SWF file plays.
var keyListener:Object = new Object();
keyListener.onKeyDown = function() {
if (Key.isDown(Key.CAPSLOCK)) {
trace("you pressed the Caps Lock key.");
trace("\tCaps Lock == "+Key.isToggled(Key.CAPSLOCK));
}
};
Key.addListener(keyListener);
Information displays in the Output panel when you press the Caps Lock key. The Output panel
displays either
true
or
false
, depending on whether the Caps Lock is activated using the
isToggled method.
The following example creates two text fields that update when the Caps Lock and Num Lock
keys are toggled. Each text field displays true when the key is activated, and false when the key is
deactivated.
this.createTextField("capsLock_txt", this.getNextHighestDepth(), 0, 0, 100,
22);
capsLock_txt.autoSize = true;
capsLock_txt.html = true;
this.createTextField("numLock_txt", this.getNextHighestDepth(), 0, 22, 100,
22);