Repository

Keyboard

Extends:

Component → Keyboard

Simple mapping from HTLM keyboard events toward Mobilizing.js. Not of a big interest for now...

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public

target: *

Private Members
private
private

Method Summary

Public Methods
public

Fast way to verify in an update loop if a specific key is currently down

public

off()

public

on()

public
public
Private Methods
private

onKeyDown(event: Object)

Forward the keydown event

private

Forward the keypress event

private

onKeyUp(event: Object)

Forward the keyup event

Inherited Summary

From class Component
public
public
public

events: *

public

id: *

public

name: *

private

_nexts: *[]

private
public
public

chain(component: Component)

Adds a component to this chained component array

public

Returns the array of attached children components

public

off()

Deactivate the component

public

on()

Activate the component A call to this method calls the setup method if it has not been run yet

public

Run code after the update of all components is run This empty method is usually overriden to perform post-update actions for the component It is called periodically by an internal Mobilizing mechanism

public

preLoad the component This empty method is usually overriden to perform setup actions for the component.

public

Run code before the update of all components is run This empty method is usually overriden to perform pre-update actions for the component It is called once per component by an internal Mobilizing mechanism

public

Set's up the component This empty method is usually overriden to perform setup actions for the component This is where all the initialization (such as adding event listeners)should be done It is called automatically by an internal Mobilizing mechanism and should thus not be called directly

public

Update the component This empty method is usually overriden to perform update actions for the component It is called periodically by an internal Mobilizing mechanism

Public Constructors

public constructor(params: Object) source

Override:

Component#constructor

Params:

NameTypeAttributeDescription
paramsObject

Parameters object, given by the constructor.

params.targetDOMElement

The DOM element that will be used to attach keyboard events on

Public Members

public target: * source

Private Members

private _isPressed: boolean source

private _keyDownCode: * source

Public Methods

public getKeyIsDown(key: Object): Boolean source

Fast way to verify in an update loop if a specific key is currently down

Params:

NameTypeAttributeDescription
keyObject

Return:

Boolean

is down or not

public off() source

Deactivate the component

Override:

Component#off

public on() source

Activate the component A call to this method calls the setup method if it has not been run yet

Override:

Component#on

public setup() source

Set's up the component This empty method is usually overriden to perform setup actions for the component This is where all the initialization (such as adding event listeners)should be done It is called automatically by an internal Mobilizing mechanism and should thus not be called directly

Override:

Component#setup

public update() source

Update the component This empty method is usually overriden to perform update actions for the component It is called periodically by an internal Mobilizing mechanism

Override:

Component#update

Private Methods

private onKeyDown(event: Object) source

Forward the keydown event

Params:

NameTypeAttributeDescription
eventObject

private onKeyPress(event: Object) source

Forward the keypress event

Params:

NameTypeAttributeDescription
eventObject

private onKeyUp(event: Object) source

Forward the keyup event

Params:

NameTypeAttributeDescription
eventObject