Class/Object

org.scalajs.dom.raw

KeyboardEvent

Related Docs: object KeyboardEvent | package raw

Permalink

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
@RawJSType() @native()
Linear Supertypes
ModifierKeyEvent, UIEvent, Event, Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. KeyboardEvent
  2. ModifierKeyEvent
  3. UIEvent
  4. Event
  5. Object
  6. Any
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new KeyboardEvent()

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def altKey: Boolean

    Permalink

    The altKey property indicates if the alt key was pressed (true) or not (false) when the event occured.

    The altKey property indicates if the alt key was pressed (true) or not (false) when the event occured.

    MDN

    Definition Classes
    ModifierKeyEvent
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def bubbles: Boolean

    Permalink

    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
  7. def cancelBubble: Boolean

    Permalink

    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
  8. def cancelable: Boolean

    Permalink

    A boolean indicating whether the event is cancelable.

    A boolean indicating whether the event is cancelable.

    MDN

    Definition Classes
    Event
  9. def charCode: Int

    Permalink

    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

  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def ctrlKey: Boolean

    Permalink

    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
  12. def currentTarget: EventTarget

    Permalink

    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
  13. def defaultPrevented: Boolean

    Permalink

    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
  14. def detail: Int

    Permalink

    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
  15. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  17. def eventPhase: Int

    Permalink

    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
  18. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  20. def getModifierState(keyArg: String): Boolean

    Permalink

    Returns the current state of the specified modifier key.

  21. def hasOwnProperty(v: String): Boolean

    Permalink
    Definition Classes
    Object
  22. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  23. def initEvent(eventTypeArg: String, canBubbleArg: Boolean, cancelableArg: Boolean): Unit

    Permalink

    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
  24. def initKeyboardEvent(typeArg: String, canBubbleArg: Boolean, cancelableArg: Boolean, viewArg: Window, keyArg: String, locationArg: Int, modifiersListArg: String, repeat: Boolean, locale: String): Unit

    Permalink
  25. def initUIEvent(typeArg: String, canBubbleArg: Boolean, cancelableArg: Boolean, viewArg: Window, detailArg: Int): Unit

    Permalink
    Definition Classes
    UIEvent
  26. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  27. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object
  28. def isTrusted: Boolean

    Permalink

    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
  29. def key: String

    Permalink

    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

  30. def keyCode: Int

    Permalink

    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.

  31. def locale: String

    Permalink

    A locale string indicating the locale the keyboard is configured for.

    A locale string indicating the locale the keyboard is configured for. This may be the empty string if the browser or device doesn't know the keyboard's locale.

    Note: This does not describe the locale of the data being entered. A user may be using one keyboard layout while typing text in a different language.

    MDN

  32. def location: Int

    Permalink

    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

  33. def metaKey: Boolean

    Permalink

    The metaKey property indicates if the meta key was pressed (true) or not (false) when the event occured.

    The metaKey property indicates if the meta key was pressed (true) or not (false) when the event occured.

    MDN

    Definition Classes
    ModifierKeyEvent
  34. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  35. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  36. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  37. def preventDefault(): Unit

    Permalink

    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
  38. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  39. def repeat: Boolean

    Permalink

    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

  40. def shiftKey: Boolean

    Permalink

    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
  41. def srcElement: Element

    Permalink
    Definition Classes
    Event
  42. def stopImmediatePropagation(): Unit

    Permalink

    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
  43. def stopPropagation(): Unit

    Permalink

    Stops the propagation of events further along in the DOM.

    Stops the propagation of events further along in the DOM.

    MDN

    Definition Classes
    Event
  44. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  45. def target: EventTarget

    Permalink

    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
  46. def timeStamp: Double

    Permalink

    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
  47. def toLocaleString(): String

    Permalink
    Definition Classes
    Object
  48. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  49. def type: String

    Permalink
    Definition Classes
    Event
  50. def valueOf(): Any

    Permalink
    Definition Classes
    Object
  51. def view: Window

    Permalink

    A view which generated the event.

    A view which generated the event. Read only.

    MDN

    Definition Classes
    UIEvent
  52. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  53. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  54. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ModifierKeyEvent

Inherited from UIEvent

Inherited from Event

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped