Class KeyboardEvent

The KeyboardEvent interface provides specific contextual information associated with keyboard devices.

Extends

UIEvent

Members Table

The following table lists the members exposed by the KeyboardEvent object.

Show inherited members (marked with *)

Show: Properties Methods Constants

Attribute Description Property Type Readonly Description $pseudoTarget * HTMLElement false Keeps the reference to pseudo element where event originated. altKey Boolean true Used to indicate whether the 'alt' key was depressed during the firing of the event. On some platforms this key may map to an alternative key name. bubbles * Boolean true Used to indicate whether or not an event is a bubbling event. cancelable * Boolean true Used to indicate whether or not an event can have its default action prevented. ctrlKey Boolean true Used to indicate whether the 'ctrl' key was depressed during the firing of the event. currentTarget * Node true Used to indicate the EventTarget whose EventListeners are currently being processed. This is particularly useful during capturing and bubbling. defaultPrevented * Boolean true Used to indicate whether preventDefault() has been called for this event. detail * Number false Specifies some detail information about the Event, depending on the type of event. eventPhase * Number true Used to indicate which phase of event flow is currently being evaluated. keyIdentifier String true Holds the identifier of the key. keyLocation Number true Contains an indication of the location of they key on the device. metaKey Boolean true Used to indicate whether the 'meta' key was depressed during the firing of the event. On some platforms this key may map to an alternative key name. namespaceURI * String true The namespace URI associated with this event at initialization time, or null if it is unspecified. shiftKey Boolean true Used to indicate whether the 'shift' key was depressed during the firing of the event. target * Node true Used to indicate the EventTarget to which the event was originally dispatched. timeStamp * TimeStamp true Used to specify the time (in milliseconds relative to the epoch) at which the event was created. type * String true The name of the event (case-insensitive). The name must be an XML name. view * Object false The view attribute identifies the AbstractView from which the event was generated. Method Returns Description getModifierState Boolean Queries the state of a modifier using a key identifier. Sytaxis: object.getModifierState(modifier) Arguments: Name Type O/R Description modifier String Required A modifier key identifier. Common modifier keys are "Alt", "AltGraph", "CapsLock", "Control", "Meta", "NumLock", "Scroll", or "Shift" initEvent * Void The initEvent method is used to initialize the value of an Event created through the DocumentEvent interface. Sytaxis: object.initEvent(type, canBubble, cancelable) Arguments: Name Type O/R Description type String Required Specifies the event type. canBubble Boolean Required Specifies whether or not the event can bubble. cancelable Boolean Required Specifies whether or not the event's default action can be prevented. initKeyboardEvent Void The initKeyboardEvent method is used to initialize the value of a KeyboardEvent object. Sytaxis: object.initKeyboardEvent(type, canBubble, cancelable, view, keyIdentifier, keyLocaltion, modifiersList) Arguments: Name Type O/R Description type String Required Specifies the event type. canBubble Boolean Required Specifies whether or not the event can bubble. cancelable Boolean Required Specifies whether or not the event's default action can be prevented. view Object Required Specifies view. This value may be null. keyIdentifier String Required Specifies key identifier. keyLocaltion Number Required Specifies key location. modifiersList String Required Specifies list of modifiers. initUIEvent * Void The initUIEvent method is used to initialize the value of a UIEvent object. Sytaxis: object.initUIEvent(type, canBubble, cancelable, view, detail) Arguments: Name Type O/R Description type String Required Specifies the event type. canBubble Boolean Required Specifies whether or not the event can bubble. cancelable Boolean Required Specifies whether or not the event's default action can be prevented. view Object Required Specifies view. This value may be null. detail Number Required Specifies detail. preventDefault * Void If an event is cancelable, the preventDefault method is used to signify that the event is to be canceled, meaning any default action normally taken by the implementation as a result of the event will not occur. Sytaxis: object.preventDefault() stopImmediatePropagation * Void Prevents other event listeners from being triggered and, unlike stopPropagation() its effect is immediate Sytaxis: object.stopImmediatePropagation() stopPropagation * Void The stopPropagation method is used prevent further propagation of an event during event flow. The event will complete dispatch to all listeners on the current EventTarget before event flow stops. This method may be used during any stage of event flow. Sytaxis: object.stopPropagation() Event B C Interface Description Pseudo-class Description Constant Value Description DOM_KEY_LOCATION_LEFT 1 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. DOM_KEY_LOCATION_NUMPAD 3 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. DOM_KEY_LOCATION_RIGHT 2 The key activation 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. DOM_KEY_LOCATION_STANDARD 0 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.

Remarks

Events of that type:

• keydown
• keyup
• keypress