class DOM.KeyboardEvent |
|
|
Introduced in DOM Level 3 DOM.KeyboardEvent The KeyboardEvent interface provides specific contextual information associated with keyboard devices. Each keyboard event references a key using an identifier. Keyboard events are commonly directed at the element that has the focus. The KeyboardEvent interface provides convenient attributes for some common modifiers keys: KeyboardEvent.ctrlKey, KeyboardEvent.shiftKey, KeyboardEvent.altKey, KeyboardEvent.metaKey. These attributes are equivalent to use the method KeyboardEvent.getModifierState(keyIdentifierArg) with "Control", "Shift", "Alt", or "Meta" respectively. To create an instance of the KeyboardEvent interface, use the DocumentEvent.createEvent("KeyboardEvent") method call. |
|
|
|
|
altKey of type boolean, readonly true if the alt (Alt) key modifier is activated. |
|
ctrlKey of type boolean, readonly true if the control (Ctrl) key modifier is activated. |
|
getModifierState This methods queries the state of a modifier using a key identifier Parameters: keyIdentifierArg of type DOMString A modifier key identifier. Supported modifier keys are "Alt", "Control", "Meta", "Shift". Return Value boolean true if it is modifier key and the modifier is activated, false otherwise. |
|
initKeyboardEvent The initKeyboardEvent method is used to initialize the value of a KeyboardEvent object and has the same behavior as UIEvent.initUIEvent(). The value of UIEvent.detail remains undefined. Parameters: typeArg of type DOMString Specifies the event type. canBubbleArg of type boolean Specifies whether or not the event can bubble. cancelableArg of type boolean Specifies whether or not the event's default action can be prevent. viewArg of type views.AbstractView Specifies the TextEvent's AbstractView. keyIdentifierArg of type DOMString Specifies KeyboardEvent.keyIdentifier. keyLocationArg of type unsigned long Specifies KeyboardEvent.keyLocation. modifiersList of type DOMString A white space separated list of modifier key identifiers to be activated on this object. |
|
keyIdentifier of type DOMString, readonly keyIdentifier holds the identifier of the key. The key identifiers are defined in Appendix A.2 "Key identifiers set" #KeySet-Set) |
|
keyLocation of type unsigned long, readonly The keyLocation attribute contains an indication of the location of they key on the device. See the KeyLocation enum for possible values |
|
metaKey of type boolean, readonly true if the meta (Meta) key modifier is activated. |
|
shiftKey of type boolean, readonly true if the shift (Shift) key modifier is activated. |
DOM_KEY_LOCATION_STANDARD | - | The key activation is not distinguished as the left or right version of the key, and did not originate from the numeric keypad (or did not originate with a virtual key corresponding to the numeric keypad). Example: the 'Q' key on a PC 101 Key US keyboard. | |
DOM_KEY_LOCATION_LEFT | - | The key activated is in the left key location (there is more than one possible location for this key). Example: the left Shift key on a PC 101 Key US keyboard. /p> p> Note: KHTML currently always considers modifier keys to be on the left | |
DOM_KEY_LOCATION_RIGHT | - | The key activated is in the right key location (there is more than one possible location for this key). Example: the right Shift key on a PC 101 Key US keyboard. /p> p> Note: KHTML currently always considers modifier keys to be on the left | |
DOM_KEY_LOCATION_NUMPAD | - | The key activation originated on the numeric keypad or with a virtual key corresponding to the numeric keypad. Example: the '1' key on a PC 101 Key US keyboard located on the numeric pad. |