goog.ui.SyntheticKeyboardEvent

Provided By	`goog.ui.SyntheticKeyboardEvent`
Extends	`goog.events.Event`

Synthetic keyboard event that can be handled by KeyboardShortcutHandler.

Prefer using the available createKeyUp, createKeyDown, createKeyPress helpers over using this constructor.

new SyntheticKeyboardEvent( `type`, `keyCode`, `shiftKey`, `altKey`, `ctrlKey`, `metaKey`, `target`, `preventDefaultFn`, `stopPropagationFn` )

Parameters

`type`	`goog.ui.SyntheticKeyboardEvent.Type`

`keyCode`	`number`

`shiftKey`	`boolean`

`altKey`	`boolean`

`ctrlKey`	`boolean`

`metaKey`	`boolean`

`target`	`Node`

`preventDefaultFn`	`function(): undefined`

`stopPropagationFn`	`function(): undefined`

VIEW SOURCE

Instance Methods

Parameters

None.

Returns

goog.ui.KeyboardEventData

VIEW SOURCE

Defined by

goog.events.Event

Parameters

None.

Returns

boolean

true iff internal propagation has been stopped.

VIEW SOURCE

Prevents the default action, for example a link redirecting to a url.

VIEW SOURCE

Stops event propagation.

VIEW SOURCE

Instance Properties

Object that had the listener attached.

VIEW SOURCE

Whether the default action has been prevented. This is a property to match the W3C specification at #events-event-type-defaultPrevented. Must be treated as read-only outside the class.

VIEW SOURCE

No information.

VIEW SOURCE

No information.

VIEW SOURCE

TODO(tbreisacher): The type should probably be EventTarget|goog.events.EventTarget.

Target of the event.

VIEW SOURCE

Event type.

VIEW SOURCE

Static Functions

Creates a synthetic keydown event.

Parameters

`keyCode`	`number`

`shiftKey`	`boolean`

`altKey`	`boolean`

`ctrlKey`	`boolean`

`metaKey`	`boolean`

`target`	`Node`

`preventDefaultFn`	`function(): undefined`

`stopPropagationFn`	`function(): undefined`

Returns

goog.ui.SyntheticKeyboardEvent

VIEW SOURCE

Creates a synthetic keypress event.

Parameters

`keyCode`	`number`

`shiftKey`	`boolean`

`altKey`	`boolean`

`ctrlKey`	`boolean`

`metaKey`	`boolean`

`target`	`Node`

`preventDefaultFn`	`function(): undefined`

`stopPropagationFn`	`function(): undefined`

Returns

goog.ui.SyntheticKeyboardEvent

VIEW SOURCE

Creates a synthetic keyup event.

Parameters

`keyCode`	`number`

`shiftKey`	`boolean`

`altKey`	`boolean`

`ctrlKey`	`boolean`

`metaKey`	`boolean`

`target`	`Node`

`preventDefaultFn`	`function(): undefined`

`stopPropagationFn`	`function(): undefined`

Returns

goog.ui.SyntheticKeyboardEvent

VIEW SOURCE

Enumerations

SyntheticKeyboardEvent.Type

goog.ui.SyntheticKeyboardEvent

new SyntheticKeyboardEvent( `type`, `keyCode`, `shiftKey`, `altKey`, `ctrlKey`, `metaKey`, `target`, `preventDefaultFn`, `stopPropagationFn` )

Instance Methods

`this.`getData() `→` `goog.ui.KeyboardEventData`

`this.`hasPropagationStopped() `→` `boolean`

`this.`preventDefault() `→` `void`

`this.`stopPropagation() `→` `void`

Instance Properties

`this.`currentTarget `→` `(Object|null|undefined)`

`this.`defaultPrevented `→` `boolean`

`this.`row `→` `?`

`this.`rowNode `→` `(Element|null|undefined)`

`this.`target `→` `(Object|null|undefined)`

`this.`type `→` `string`

Static Functions

SyntheticKeyboardEvent.createKeyDown( `keyCode`, `shiftKey`, `altKey`, `ctrlKey`, `metaKey`, `target`, `preventDefaultFn`, `stopPropagationFn` ) `→` `goog.ui.SyntheticKeyboardEvent`

SyntheticKeyboardEvent.createKeyPress( `keyCode`, `shiftKey`, `altKey`, `ctrlKey`, `metaKey`, `target`, `preventDefaultFn`, `stopPropagationFn` ) `→` `goog.ui.SyntheticKeyboardEvent`

SyntheticKeyboardEvent.createKeyUp( `keyCode`, `shiftKey`, `altKey`, `ctrlKey`, `metaKey`, `target`, `preventDefaultFn`, `stopPropagationFn` ) `→` `goog.ui.SyntheticKeyboardEvent`

Enumerations

goog.ui.SyntheticKeyboardEvent

new SyntheticKeyboardEvent( type, keyCode, shiftKey, altKey, ctrlKey, metaKey, target, preventDefaultFn, stopPropagationFn )

Instance Methods

this.getData() → goog.ui.KeyboardEventData

this.hasPropagationStopped() → boolean

this.preventDefault() → void

this.stopPropagation() → void

Instance Properties

this.currentTarget → (Object|null|undefined)

this.defaultPrevented → boolean

this.row → ?

this.rowNode → (Element|null|undefined)

this.target → (Object|null|undefined)

this.type → string

Static Functions

SyntheticKeyboardEvent.createKeyDown( keyCode, shiftKey, altKey, ctrlKey, metaKey, target, preventDefaultFn, stopPropagationFn ) → goog.ui.SyntheticKeyboardEvent

SyntheticKeyboardEvent.createKeyPress( keyCode, shiftKey, altKey, ctrlKey, metaKey, target, preventDefaultFn, stopPropagationFn ) → goog.ui.SyntheticKeyboardEvent

SyntheticKeyboardEvent.createKeyUp( keyCode, shiftKey, altKey, ctrlKey, metaKey, target, preventDefaultFn, stopPropagationFn ) → goog.ui.SyntheticKeyboardEvent

Enumerations

new SyntheticKeyboardEvent( `type`, `keyCode`, `shiftKey`, `altKey`, `ctrlKey`, `metaKey`, `target`, `preventDefaultFn`, `stopPropagationFn` )

`this.`getData() `→` `goog.ui.KeyboardEventData`

`this.`hasPropagationStopped() `→` `boolean`

`this.`preventDefault() `→` `void`

`this.`stopPropagation() `→` `void`

`this.`currentTarget `→` `(Object|null|undefined)`

`this.`defaultPrevented `→` `boolean`

`this.`row `→` `?`

`this.`rowNode `→` `(Element|null|undefined)`

`this.`target `→` `(Object|null|undefined)`

`this.`type `→` `string`

SyntheticKeyboardEvent.createKeyDown( `keyCode`, `shiftKey`, `altKey`, `ctrlKey`, `metaKey`, `target`, `preventDefaultFn`, `stopPropagationFn` ) `→` `goog.ui.SyntheticKeyboardEvent`

SyntheticKeyboardEvent.createKeyPress( `keyCode`, `shiftKey`, `altKey`, `ctrlKey`, `metaKey`, `target`, `preventDefaultFn`, `stopPropagationFn` ) `→` `goog.ui.SyntheticKeyboardEvent`

SyntheticKeyboardEvent.createKeyUp( `keyCode`, `shiftKey`, `altKey`, `ctrlKey`, `metaKey`, `target`, `preventDefaultFn`, `stopPropagationFn` ) `→` `goog.ui.SyntheticKeyboardEvent`