KeyboardEvent.initKeyboardEvent()

The KeyboardEvent.initKeyboardEvent() method initializes the attributes of a keyboard event object. This method was introduced in draft of DOM Level 3 Events, but deprecated in newer draft. Gecko won't support this feature since implementing this method as experimental broke existing web apps (see bug 999645). Web applications should use constructor instead of this if it's available.

Syntax

kbdEvent.initKeyboardEvent(typeArg, canBubbleArg, cancelableArg,
                           viewArg, charArg, keyArg,
                           locationArg, modifiersListArg, repeat)

Parameters

typeArg

The type of keyboard event; this will be one of keydown, keypress, or keyup.

canBubbleArg

Whether or not the event can bubble.

cancelableArg

Whether or not the event can be canceled.

viewArg

The WindowProxy it is associated to.

keyArg

The value of the key attribute.

locationArg

The value of the location attribute.

ctrlKey

Whether the Control key modifier is active.

altKey

Whether the Alt key modifier is active.

shiftKey

Whether the Shift key modifier is active.

metaKey

Whether the Meta key modifier is active.

Specifications

The KeyboardEvent interface specification went through numerous draft versions, first under DOM Events Level 2 where it was dropped as no consensus arose, then under DOM Events Level 3. This led to the implementation of non-standard initialization methods, the early DOM Events Level 2 version, KeyboardEvent.initKeyEvent() by Gecko browsers and the early DOM Events Level 3 version, KeyboardEvent.initKeyboardEvent() by others. Both have been superseded by the modern usage of a constructor: KeyboardEvent().

Browser compatibility