doodle.events.createKeyboardEvent

Description:

KeyboardEvent (type:string, bubbles:boolean, cancelable:boolean, view:HTMLElement, keyIdentifier:string, keyLocation:number, modifiersList:string, repeat:boolean) :KeyboardEvent

Inherits

  1. UIEvent
  2. Event
  3. Object

Parameters

  1. type:string – [optional]
  2. bubbles:boolean – [optional]
  3. cancelable:boolean – [optional]
  4. view:HTMLElement – [optional]
  5. keyIdentifier:string – [optional]
  6. keyLocation:number – [optional]
  7. modifiersList:string – [optional] White-space separated list of key modifiers.
  8. repeat:boolean – [optional]

Returns

  • KeyboardEvent –

Throws

  • TypeError –
  • SyntaxError –

Properties

altGraphKey :boolean

Returns

  • boolean – [read-only]
altKey :boolean

Returns

  • boolean – [read-only]
bubbles :boolean

Returns

  • boolean – [read-only]
cancelable :boolean

Returns

  • boolean – [read-only]
charCode :number

Returns

  • number – [read-only]
ctrlKey :boolean

Returns

  • boolean – [read-only]
currentTarget :Node

Returns

  • Node – [read-only]
detail :number

Returns

  • number – [read-only]
eventPhase :number

Returns

  • number – [read-only]
keyCode :number

Returns

  • number – [read-only]
keyIdentifier :string

Returns

  • string – [read-only]
keyLocation :number

Returns

  • number – [read-only]
layerX :number

Returns

  • number – [read-only]
layerY :number

Returns

  • number – [read-only]
metaKey :boolean

Returns

  • boolean – [read-only]
pageX :number

Returns

  • number – [read-only]
pageY :number

Returns

  • number – [read-only]
repeat :boolean

Returns

  • boolean – [read-only]
returnValue :*

Returns

  • * – [read-only]
shiftKey :boolean

Returns

  • boolean – [read-only]
srcElement :Emitter

Returns

  • Emitter – [read-only]
target :Node

Returns

  • Node – [read-only]
timeStamp :Date

Returns

  • Date – [read-only]
type :string

Returns

  • string – [read-only]
view :HTMLElement

Returns

  • HTMLElement – [read-only]
which :number

Returns

  • number – [read-only]

Methods

cancelBubble (cancelArg:boolean) :void

Parameters

  1. cancelArg:boolean –

Throws

  • TypeError –
id () :string

Returns

  • string –
initEvent (typeArg:string, canBubbleArg:boolean, cancelableArg:boolean) :Event

Parameters

  1. typeArg:string – [optional]
  2. canBubbleArg:boolean – [optional]
  3. cancelableArg:boolean – [optional]

Returns

  • Event –

Throws

  • TypeError –
initKeyboardEvent (typeArg:string, canBubbleArg:boolean, cancelableArg:boolean, viewArg:HTMLElement, keyIdentifierArg:string, keyLocationArg:number, modifiersListArg:string, repeatArg:boolean) :Event

Parameters

  1. typeArg:string –
  2. canBubbleArg:boolean –
  3. cancelableArg:boolean –
  4. viewArg:HTMLElement –
  5. keyIdentifierArg:string –
  6. keyLocationArg:number –
  7. modifiersListArg:string –
  8. repeatArg:boolean –

Returns

  • Event –

Throws

  • TypeError –
initUIEvent (typeArg:string, canBubbleArg:boolean, cancelableArg:boolean, viewArg:HTMLElement, detailArg:number) :UIEvent

Parameters

  1. typeArg:string –
  2. canBubbleArg:boolean –
  3. cancelableArg:boolean –
  4. viewArg:HTMLElement –
  5. detailArg:number –

Returns

  • UIEvent –

Throws

  • TypeError –
preventDefault () :void

stopImmediatePropagation () :void

Throws

  • Error – If called on event that can not be canceled.
stopPropagation () :void

Throws

  • Error – If called on event that can not be canceled.
toString () :string

Returns

  • string –
getModifierState (key:string) :boolean

Queries the state of a modifier using a key identifier.

Parameters

  1. key:string – A modifier key identifier

Returns

  • boolean – True if it is a modifier key and the modifier is activated, false otherwise.

Throws

  • TypeError –

Constants

KEY_DOWN :string

Returns

  • string – [read-only]
KEY_LOCATION_JOYSTICK :number

Returns

  • number – [read-only]
KEY_LOCATION_LEFT :number

Returns

  • number – [read-only]
KEY_LOCATION_MOBILE :number

Returns

  • number – [read-only]
KEY_LOCATION_NUMPAD :number

Returns

  • number – [read-only]
KEY_LOCATION_RIGHT :number

Returns

  • number – [read-only]
KEY_LOCATION_STANDARD :number

Returns

  • number – [read-only]
KEY_PRESS :string

Returns

  • string – [read-only]
KEY_UP :string

Returns

  • string – [read-only]

Class Functions

isKeyboardEvent (event:doodle.events.Event) :boolean

Test if an object is a keyboard event.

Parameters

  1. event:doodle.events.Event –

Returns

  • boolean –