KeyboardEvent objects describe a user interaction with the keyboard; each event describes a single interaction between the user and a key (or combination of a key with modifier keys) on the keyboard.
Documentation KeyboardEvent by Mozilla Contributors, licensed under CC-BY-SA 2.5.
See also:
Static variables
Constructor
Variables
Returns a Boolean that is true if the Alt ( Option or ⌥ on OS X) key was active when the key event was generated.
Returns a Number representing the Unicode reference number of the key; this attribute is used only by the keypress event. For keys whose char attribute contains multiple characters, this is the Unicode value of the first character in that attribute. In Firefox 26 this returns codes for printable characters.
Warning: This attribute is deprecated; you should use KeyboardEvent.key instead, if available.
Returns a DOMString with the code value of the key represented by the event.
Returns a Boolean that is true if the Ctrl key was active when the key event was generated.
Returns a Boolean that is true if the event is fired between after compositionstart and before compositionend.
Returns a DOMString representing the key value of the key represented by the event.
Returns a Number representing a system and implementation dependent numerical code identifying the unmodified value of the pressed key.
Warning: This attribute is deprecated; you should use KeyboardEvent.key instead, if available.
Returns a Number representing the location of the key on the keyboard or other input device.
Returns a Boolean that is true if the Meta key (on Mac keyboards, the ⌘ Command key; on Windows keyboards, the Windows key (⊞)) was active when the key event was generated.
Returns a Boolean that is true if the key is being held down such that it is automatically repeating.
Returns a Boolean that is true if the Shift key was active when the key event was generated.
Methods
Returns a Boolean indicating if a modifier key such as Alt, Shift, Ctrl, or Meta, was pressed when the event was created.
@:value({ charCode : 0, keyCode : 0, metaKey : false, shiftKey : false, altKey : false, ctrlKey : false, cancelable : false, canBubble : false })initKeyEvent(type:String, canBubble:Bool = false, cancelable:Bool = false, ?view:Window, ctrlKey:Bool = false, altKey:Bool = false, shiftKey:Bool = false, metaKey:Bool = false, keyCode:Int = 0, charCode:Int = 0):Void
@:value({ metaKey : false, shiftKey : false, altKey : false, ctrlKey : false, locationArg : 0, keyArg : "", cancelableArg : false, bubblesArg : false })initKeyboardEvent(typeArg:String, bubblesArg:Bool = false, cancelableArg:Bool = false, ?viewArg:Window, keyArg:String = "", locationArg:Int = 0, ctrlKey:Bool = false, altKey:Bool = false, shiftKey:Bool = false, metaKey:Bool = false):Void
Inherited Variables
Returns a long with details about the event, depending on the event type.
Returns the horizontal coordinate of the event relative to the current layer.
Returns the vertical coordinate of the event relative to the current layer.
Returns the horizontal coordinate of the event relative to the whole document.
Returns the vertical coordinate of the event relative to the whole document.
Returns a WindowProxy that contains the view that generated the event.
Returns the numeric keyCode of the key pressed, or the character code (charCode) for an alphanumeric key pressed.
Defined by Event
A Boolean indicating whether the event bubbles up through the DOM or not.
A historical alias to Event.stopPropagation(). Setting its value to true before returning from an event handler prevents propagation of the event.
A Boolean indicating whether the event is cancelable.
A Boolean value indicating whether or not the event can bubble across the boundary between the shadow DOM and the regular DOM.
A reference to the currently registered target for the event. This is the object to which the event is currently slated to be sent; it's possible this has been changed along the way through retargeting.
Indicates whether or not event.preventDefault() has been called on the event.
Indicates which phase of the event flow is being processed.
The explicit original target of the event (Mozilla-specific).
Indicates whether or not the event was initiated by the browser (after a user click for instance) or by a script (using an event creation method, like event.initEvent).
The original target of the event, before any retargetings (Mozilla-specific).
A historical property introduced by Internet Explorer and eventually adopted into the DOM specification in order to ensure existing sites continue to work. Ideally, you should try to use Event.preventDefault() and Event.defaultPrevented instead, but you can use returnValue if you choose to do so.
A reference to the target to which the event was originally dispatched.
The time at which the event was created (in milliseconds). By specification, this value is time since epoch, but in reality browsers' definitions vary; in addition, work is underway to change this to be a DOMHighResTimeStamp instead.
The name of the event (case-insensitive).
Inherited Methods
@:value({ aDetail : 0, aCancelable : false, aCanBubble : false })initUIEvent(aType:String, aCanBubble:Bool = false, aCancelable:Bool = false, ?aView:Window, aDetail:Int = 0):Void
Initializes a UIEvent object. If the event has already being dispatched, this method does nothing.
Defined by Event
Returns the event’s path (objects on which listeners will be invoked). This does not include nodes in shadow trees if the shadow root was created with its ShadowRoot.mode closed.
@:value({ cancelable : false, bubbles : false })initEvent(type:String, bubbles:Bool = false, cancelable:Bool = false):Void
Initializes the value of an Event created. If the event has already being dispatched, this method does nothing.
Cancels the event (if it is cancelable).
For this particular event, no other listener will be called. Neither those attached on the same element, nor those attached on elements which will be traversed later (in capture phase, for instance)
Stops the propagation of events further along in the DOM.