MACROMEDIA FLEX-FLEX ACTIONSCRIPT LANGUAGE, Reference

Page: 306 / 830

306 Chapter 6: ActionScript Core Classes
Parameters
keycode
The key code value assigned to a specific key or a Key class property associated with a
specific key. To match the returned key code value with the key on a standard keyboard, see
Appendix B, “Keyboard Keys and Key Code Values,” on page 811 .
Returns
A Boolean value.
Description
Method: returns
true
if the key specified in
keycode
is pressed;
false
otherwise. On the
Macintosh, the key code values for the Caps Lock and Num Lock keys are identical.
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()
. 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);