akasha

Class KeyboardEvent

java.lang.Object

akasha.Event

akasha.UIEvent

akasha.KeyboardEvent

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="KeyboardEvent")
public class KeyboardEvent
extends UIEvent

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.

See Also:

KeyboardEvent - MDN, KeyboardEvent - UI Events

Field Summary

Fields

Modifier and Type	Field and Description
static int	DOM_KEY_LOCATION_LEFT
static int	DOM_KEY_LOCATION_NUMPAD
static int	DOM_KEY_LOCATION_RIGHT
static int	DOM_KEY_LOCATION_STANDARD

Fields inherited from class akasha.Event

AT_TARGET, BUBBLING_PHASE, cancelBubble, CAPTURING_PHASE, NONE, returnValue

Constructor Summary

Constructors

Constructor and Description
KeyboardEvent(java.lang.String type) The KeyboardEvent() constructor creates a new KeyboardEvent.
KeyboardEvent(java.lang.String type, KeyboardEventInit eventInitDict) The KeyboardEvent() constructor creates a new KeyboardEvent.

Method Summary

Modifier and Type	Method and Description
boolean	altKey() The KeyboardEvent.altKey read-only property is a Boolean that indicates if the alt key (Option or ⌥ on OS X) was pressed (true) or not (false) when the event occured.
int	charCode() The charCode read-only property of the KeyboardEvent interface returns the Unicode value of a character key pressed during a keypress event.
java.lang.String	code() The KeyboardEvent.code property represents a physical key on the keyboard (as opposed to the character generated by pressing the key).
boolean	ctrlKey() The KeyboardEvent.ctrlKey read-only property returns a Boolean that indicates if the control key was pressed (true) or not (false) when the event occured.
boolean	getModifierState(java.lang.String keyArg) The KeyboardEvent.getModifierState() method returns the current state of the specified modifier key: true if the modifier is active (that is the modifier key is pressed or locked), otherwise, false.
boolean	isComposing() The KeyboardEvent.isComposing read-only property returns a Boolean value indicating if the event is fired within a composition session, i.e.
java.lang.String	key() The KeyboardEvent interface's key read-only property returns the value of the key pressed by the user, taking into consideration the state of modifier keys such as Shift as well as the keyboard locale and layout.
int	keyCode() The deprecated KeyboardEvent.keyCode read-only property represents a system and implementation dependent numerical code identifying the unmodified value of the pressed key.
int	location() The KeyboardEvent.location read-only property returns an unsigned long representing the location of the key on the keyboard or other input device.
boolean	metaKey() The KeyboardEvent.metaKey read-only property returning a Boolean that indicates if the Meta key was pressed (true) or not (false) when the event occurred.
boolean	repeat() The repeat read-only property of the KeyboardEvent interface returns a Boolean that is true if the given key is being held down such that it is automatically repeating.
boolean	shiftKey() The KeyboardEvent.shiftKey read-only property is a Boolean that indicates if the shift key was pressed (true) or not (false) when the event occurred.

Methods inherited from class akasha.UIEvent

detail, view, which

Methods inherited from class akasha.Event

bubbles, cancelable, composed, composedPath, currentTarget, defaultPrevented, eventPhase, initEvent, initEvent, initEvent, isTrusted, preventDefault, srcElement, stopImmediatePropagation, stopPropagation, target, timeStamp, type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DOM_KEY_LOCATION_LEFT

@JsOverlay
public static final int DOM_KEY_LOCATION_LEFT

See Also:

Constant Field Values

DOM_KEY_LOCATION_NUMPAD

@JsOverlay
public static final int DOM_KEY_LOCATION_NUMPAD

See Also:

Constant Field Values

DOM_KEY_LOCATION_RIGHT

@JsOverlay
public static final int DOM_KEY_LOCATION_RIGHT

See Also:

Constant Field Values

DOM_KEY_LOCATION_STANDARD

@JsOverlay
public static final int DOM_KEY_LOCATION_STANDARD

See Also:

Constant Field Values

Constructor Detail

KeyboardEvent

public KeyboardEvent(@Nonnull
                     java.lang.String type,
                     @Nonnull
                     KeyboardEventInit eventInitDict)

The KeyboardEvent() constructor creates a new KeyboardEvent.

See Also:

KeyboardEvent.KeyboardEvent - MDN, KeyboardEvent() - UI Events, KeyboardEvent() - Document Object Model (DOM) Level 3 Events Specification

KeyboardEvent

public KeyboardEvent(@Nonnull
                     java.lang.String type)

The KeyboardEvent() constructor creates a new KeyboardEvent.

See Also:

KeyboardEvent.KeyboardEvent - MDN, KeyboardEvent() - UI Events, KeyboardEvent() - Document Object Model (DOM) Level 3 Events Specification

Method Detail

altKey

@JsProperty(name="altKey")
public boolean altKey()

The KeyboardEvent.altKey read-only property is a Boolean that indicates if the alt key (Option or ⌥ on OS X) was pressed (true) or not (false) when the event occured.

See Also:

KeyboardEvent.altKey - MDN, KeyboardEvent.altkey - Document Object Model (DOM) Level 3 Events Specification

charCode

@JsProperty(name="charCode")
public int charCode()

The charCode read-only property of the KeyboardEvent interface returns the Unicode value of a character key pressed during a keypress event.

See Also:

KeyboardEvent.charCode - MDN, KeyboardEvent.charCode - Document Object Model (DOM) Level 3 Events Specification

code

@JsProperty(name="code")
 @Nonnull
public java.lang.String code()

The KeyboardEvent.code property represents a physical key on the keyboard (as opposed to the character generated by pressing the key). In other words, this property returns a value that isn't altered by keyboard layout or the state of the modifier keys.

See Also:

KeyboardEvent.code - MDN

ctrlKey

@JsProperty(name="ctrlKey")
public boolean ctrlKey()

The KeyboardEvent.ctrlKey read-only property returns a Boolean that indicates if the control key was pressed (true) or not (false) when the event occured.

See Also:

KeyboardEvent.ctrlKey - MDN, KeyboardEvent.ctrlKey - Document Object Model (DOM) Level 3 Events Specification

isComposing

@JsProperty(name="isComposing")
public boolean isComposing()

The KeyboardEvent.isComposing read-only property returns a Boolean value indicating if the event is fired within a composition session, i.e. after compositionstart and before compositionend.

See Also:

KeyboardEvent.isComposing - MDN, KeyboardEvent.prototype.isComposing - UI Events, KeyboardEvent.prototype.isComposing - Document Object Model (DOM) Level 3 Events Specification

key

@JsProperty(name="key")
 @Nonnull
public java.lang.String key()

The KeyboardEvent interface's key read-only property returns the value of the key pressed by the user, taking into consideration the state of modifier keys such as Shift as well as the keyboard locale and layout.

See Also:

KeyboardEvent.key - MDN

keyCode

@JsProperty(name="keyCode")
public int keyCode()

The deprecated KeyboardEvent.keyCode read-only property represents a system and implementation dependent numerical code identifying the unmodified value of the pressed key.

See Also:

KeyboardEvent.keyCode - MDN, KeyboardEvent.keyCode - Document Object Model (DOM) Level 3 Events Specification

location

@JsProperty(name="location")
 @KeyboardEventLocation
public int location()

The KeyboardEvent.location read-only property returns an unsigned long representing the location of the key on the keyboard or other input device.

See Also:

KeyboardEvent.location - MDN, KeyboardEvent.location - Document Object Model (DOM) Level 3 Events Specification

metaKey

@JsProperty(name="metaKey")
public boolean metaKey()

The KeyboardEvent.metaKey read-only property returning a Boolean that indicates if the Meta key was pressed (true) or not (false) when the event occurred. Some operating systems may intercept the key so it is never detected.

See Also:

KeyboardEvent.metaKey - MDN, KeyboardEvent.metaKey - Document Object Model (DOM) Level 3 Events Specification

repeat

@JsProperty(name="repeat")
public boolean repeat()

The repeat read-only property of the KeyboardEvent interface returns a Boolean that is true if the given key is being held down such that it is automatically repeating.

See Also:

KeyboardEvent.repeat - MDN, KeyboardEvent.repeat - Document Object Model (DOM) Level 3 Events Specification

shiftKey

@JsProperty(name="shiftKey")
public boolean shiftKey()

The KeyboardEvent.shiftKey read-only property is a Boolean that indicates if the shift key was pressed (true) or not (false) when the event occurred.

See Also:

KeyboardEvent.shiftKey - MDN, KeyboardEvent.shiftKey - Document Object Model (DOM) Level 3 Events Specification

getModifierState

public boolean getModifierState(@Nonnull
                                java.lang.String keyArg)

The KeyboardEvent.getModifierState() method returns the current state of the specified modifier key: true if the modifier is active (that is the modifier key is pressed or locked), otherwise, false.

See Also:

KeyboardEvent.getModifierState - MDN, getModifierState() - Document Object Model (DOM) Level 3 Events Specification