class KeyboardEvent extends UIEvent with ModifierKeyEvent
KeyboardEvent objects describe a user interaction with the keyboard. Each event describes a key; the event type (keydown, keypress, or keyup) identifies what kind of activity was performed.
Note: The KeyboardEvent indicates just what's happening on a key. When you need to handle text input, use HTML5 input event instead. For example, if user inputs text from hand-writing system like tablet PC, key events may not be fired.
MDN
Warning: keypress event is to be deprecated in favor of beforeinput event eventually
W3C
- Annotations
- @JSType() @native() @JSGlobal()
- Alphabetic
- By Inheritance
- KeyboardEvent
- ModifierKeyEvent
- UIEvent
- Event
- Object
- Any
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new KeyboardEvent(typeArg: String)
- new KeyboardEvent(typeArg: String, init: UndefOr[KeyboardEventInit])
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def altKey: Boolean
The altKey property indicates if the alt key was pressed (true) or not (false) when the event occurred.
The altKey property indicates if the alt key was pressed (true) or not (false) when the event occurred.
MDN
- Definition Classes
- ModifierKeyEvent
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def bubbles: Boolean
A boolean indicating whether the event bubbles up through the DOM or not.
A boolean indicating whether the event bubbles up through the DOM or not.
MDN
- Definition Classes
- Event
- def cancelBubble: Boolean
A boolean indicating whether the bubbling of the event has been canceled or not.
A boolean indicating whether the bubbling of the event has been canceled or not.
MDN
- Definition Classes
- Event
- def cancelable: Boolean
A boolean indicating whether the event is cancelable.
A boolean indicating whether the event is cancelable.
MDN
- Definition Classes
- Event
- def charCode: Int
Returns the Unicode value of a character key pressed during a keypress event.
Returns the Unicode value of a character key pressed during a keypress event.
Note: Required especially in Gecko based browsers
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def ctrlKey: Boolean
A Boolean value indicating whether or not the control key was down when the touch event was fired.
A Boolean value indicating whether or not the control key was down when the touch event was fired. Read only.
MDN
- Definition Classes
- ModifierKeyEvent
- def currentTarget: EventTarget
Identifies the current target for the event, as the event traverses the DOM.
Identifies the current target for the event, as the event traverses the DOM. It always refers to the element the event handler has been attached to as opposed to event.target which identifies the element on which the event occurred.
MDN
- Definition Classes
- Event
- def defaultPrevented: Boolean
Returns a boolean indicating whether or not event.preventDefault() was called on the event.
Returns a boolean indicating whether or not event.preventDefault() was called on the event.
MDN
- Definition Classes
- Event
- def detail: Int
Detail about the event, depending on the type of event.
Detail about the event, depending on the type of event. Read only.
MDN
- Definition Classes
- UIEvent
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def eventPhase: Int
Indicates which phase of the event flow is currently being evaluated.
Indicates which phase of the event flow is currently being evaluated.
MDN
- Definition Classes
- Event
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getModifierState(keyArg: String): Boolean
Returns the current state of the specified modifier key.
- def hasOwnProperty(v: String): Boolean
- Definition Classes
- Object
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isPrototypeOf(v: Object): Boolean
- Definition Classes
- Object
- def isTrusted: Boolean
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)
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)
MDN
- Definition Classes
- Event
- def key: String
The key value of the key represented by the event.
The key value of the key represented by the event. If the value has a printed representation, this attribute's value is the same as the char attribute. Otherwise, it's one of the key value strings specified in Key values. If the key can't be identified, this is the string "Unidentified". See key names for the detail.
MDN
- def keyCode: Int
A system and implementation dependent numerical code identifying the unmodified value of the pressed key.
A system and implementation dependent numerical code identifying the unmodified value of the pressed key. This is usually the decimal ASCII (RFC 20) or Windows 1252 code corresponding to the key; see Virtual key codes for a list of Gecko's keyCode values. If the key can't be identified, this value is 0. Read only.
- def location: Int
The location of the key on the keyboard or other input device.
The location of the key on the keyboard or other input device. See the constants in the KeyboardEvent object.
MDN
- def metaKey: Boolean
The metaKey property indicates if the meta key was pressed (true) or not (false) when the event occurred.
The metaKey property indicates if the meta key was pressed (true) or not (false) when the event occurred.
MDN
- Definition Classes
- ModifierKeyEvent
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def preventDefault(): Unit
Cancels the event if it is cancelable, without stopping further propagation of the event.
Cancels the event if it is cancelable, without stopping further propagation of the event.
MDN
- Definition Classes
- Event
- def propertyIsEnumerable(v: String): Boolean
- Definition Classes
- Object
- def repeat: Boolean
true if the key is being held down such that it is automatically repeating
true if the key is being held down such that it is automatically repeating
MDN
- def shiftKey: Boolean
A Boolean value indicating whether or not the shift key was down when the touch event was fired.
A Boolean value indicating whether or not the shift key was down when the touch event was fired. Read only.
MDN
- Definition Classes
- ModifierKeyEvent
- def stopImmediatePropagation(): Unit
For this particular event, no other listener will be called.
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)
MDN
- Definition Classes
- Event
- def stopPropagation(): Unit
Stops the propagation of events further along in the DOM.
Stops the propagation of events further along in the DOM.
MDN
- Definition Classes
- Event
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def target: EventTarget
This property of event objects is the object the event was dispatched on.
This property of event objects is the object the event was dispatched on. It is different than event.currentTarget when the event handler is called in bubbling or capturing phase of the event.
MDN
- Definition Classes
- Event
- def timeStamp: Double
Returns the time (in milliseconds since the epoch) at which the event was created.
Returns the time (in milliseconds since the epoch) at which the event was created.
MDN
- Definition Classes
- Event
- def toLocaleString(): String
- Definition Classes
- Object
- def toString(): String
- Definition Classes
- AnyRef → Any
- def type: String
- Definition Classes
- Event
- def valueOf(): Any
- Definition Classes
- Object
- def view: Window
A view which generated the event.
A view which generated the event. Read only.
MDN
- Definition Classes
- UIEvent
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def initEvent(eventTypeArg: String, canBubbleArg: Boolean, cancelableArg: Boolean): Unit
The initEvent method is used to initialize the value of an event created using document.createEvent.
The initEvent method is used to initialize the value of an event created using document.createEvent.
MDN
- Definition Classes
- Event
- Annotations
- @deprecated
- Deprecated
(Since version forever) Non-standard
- def initKeyboardEvent(typeArg: String, canBubbleArg: Boolean, cancelableArg: Boolean, viewArg: Window, keyArg: String, locationArg: Int, modifiersListArg: String, repeat: Boolean, locale: String): Unit
- Annotations
- @deprecated
- Deprecated
(Since version forever) Non-standard
- def initUIEvent(typeArg: String, canBubbleArg: Boolean, cancelableArg: Boolean, viewArg: Window, detailArg: Int): Unit
- Definition Classes
- UIEvent
- Annotations
- @deprecated
- Deprecated
(Since version 0.9.8) Instead use constructor to initialize
- def srcElement: Element
- Definition Classes
- Event
- Annotations
- @deprecated
- Deprecated
(Since version forever) Non standard.