KeyMapper

Kind of class: public class
Package:
Inherits from:
  • none
Classpath: org.asaplibrary.util.KeyMapper
File last modified: Saturday, 14 May 2011, 16:05:11
Class for directly coupling Keyboard events to actions, without having to bother about event filtering
Usage
  • : 
    mKeyMapper = new KeyMapper(LocalController.globalStage);
mKeyMapper.setMapping(Keyboard.ENTER, submit, KeyboardEvent.KEY_UP);
mKeyMapper.setMapping(Keyboard.ESCAPE, cancel, KeyboardEvent.KEY_UP);
mKeyMapper.setMapping(Keyboard.KEY_UP, moveUp, null, true);    // event type defaults to KEY_DOWN when null; the function moveUp receives the KeyboardEvent event when called
    Make sure to clean up when you're done: mKeyMapper.die();

Summary

Constructor
Instance methods
  • setMapping (inKey:uint, inHandler:Function, inEventType:String, inSendEvent:Boolean = false) : void
    • Map a key to a handler function for a specific event (key up or down), optionally passing the event itself
  • die () : void
    • Cleanup objects and event handlers

Constructor

KeyMapper

function KeyMapper(inStage:Stage)

Constructor

Parameters
inStage:a valid Stage type object

Instance methods

die

function die() : void

Cleanup objects and event handlers

setMapping

function setMapping(inKey:uint, inHandler:Function, inEventType:String, inSendEvent:Boolean = false) : void

Map a key to a handler function for a specific event (key up or down), optionally passing the event itself

Parameters
inKey :see Keyboard class for possible values
inHandler :function to be called when the key is pressed or released; by default called without parameters
inEventType:specify KeyboardEvent.KEY_UP for key-up events (default), or KeyboardEvent.KEY_DOWN for key-down events
inSendEvent:when true, the KeyboardEvent event is passed to the handler function