KeyboardEvent: initKeyboardEvent() method
Deprecated
Avoid using this feature in new projects. This feature may be a candidate for removal from web standards or browsers.
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 Firefox bug 999645).
Web applications should use constructor instead of this if it's available.
Syntax
initKeyboardEvent(type, canBubble, cancelable,
view, key, location, ctrlKey,
altKey, shiftKey, metaKey)
Parameters
type-
The type of keyboard event; browsers always set it to one of
keydown,keypress, orkeyup. canBubbleOptional-
Indicates whether or not the event can bubble. Defaults to
false. cancelableOptional-
Indicates whether or not the event can be canceled. Defaults to
false. viewOptional-
The WindowProxy it is associated to. Defaults to
null. keyOptional-
The value of the key attribute. Defaults to
"". locationOptional-
The value of the location attribute. Defaults to
0. ctrlKeyOptional-
Indicates whether the control key modifier is active. Defaults to
false. altKeyOptional-
Indicates whether the alt key modifier is active. Defaults to
false. shiftKeyOptional-
Indicates whether the shift key modifier is active. Defaults to
false. metaKeyOptional-
Indicates whether the meta key modifier is active. Defaults to
false.
Return value
None (undefined).
Specifications
| Specification |
|---|
| UI Events # dom-keyboardevent-initkeyboardevent |
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().