Back to Trilium

Interface JQueryKeyEventObject

docs/Script API/interfaces/Frontend_Script_API._internal_.JQueryKeyEventObject.html

0.102.212.2 KB
Original Source

Interface JQueryKeyEventObject

Deprecated

​ Deprecated. Use JQuery.Event.

interface JQueryKeyEventObject {
altKey: boolean;
AT_TARGET: 2;
bubbles: boolean;
BUBBLING_PHASE: 3;
cancelable: boolean;
cancelBubble: boolean;
CAPTURING_PHASE: 1;
char: string;
charCode: number;
composed: boolean;
ctrlKey: boolean;
currentTarget: Element;
data: any;
defaultPrevented: boolean;
delegateTarget: Element;
eventPhase: number;
isTrusted: boolean;
key: string;
keyCode: number;
metaKey: boolean;
namespace: string;
NONE: 0;
originalEvent: Event;
pageX: number;
pageY: number;
relatedTarget: Element;
result: any;
returnValue: boolean;
shiftKey: boolean;
srcElement: null | EventTarget;
target: Element;
timeStamp: number;
type: string;
which: number;
composedPath(): EventTarget[];
initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void;
isDefaultPrevented(): boolean;
isImmediatePropagationStopped(): boolean;
isPropagationStopped(): boolean;
preventDefault(): any;
stopImmediatePropagation(): void;
stopPropagation(): void;
}

Hierarchy (View Summary)

Index

Properties

altKeyAT_TARGETbubblesBUBBLING_PHASEcancelablecancelBubbleCAPTURING_PHASEcharcharCodecomposedctrlKeycurrentTargetdatadefaultPreventeddelegateTargeteventPhaseisTrustedkeykeyCodemetaKeynamespaceNONEoriginalEventpageXpageYrelatedTargetresultreturnValueshiftKeysrcElementtargettimeStamptypewhich

Methods

composedPathinitEventisDefaultPreventedisImmediatePropagationStoppedisPropagationStoppedpreventDefaultstopImmediatePropagationstopPropagation

Properties

altKey

altKey: boolean

ReadonlyAT_TARGET

AT_TARGET: 2

Readonlybubbles

bubbles: boolean

Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.

MDN Reference

ReadonlyBUBBLING_PHASE

BUBBLING_PHASE: 3

Readonlycancelable

cancelable: boolean

Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.

MDN Reference

cancelBubble

cancelBubble: boolean

Deprecated

MDN Reference

ReadonlyCAPTURING_PHASE

CAPTURING_PHASE: 1

char

char: string

Deprecated

charCode

charCode: number

Deprecated

Readonlycomposed

composed: boolean

Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.

MDN Reference

ctrlKey

ctrlKey: boolean

currentTarget

currentTarget: Element

The current DOM element within the event bubbling phase.

See

<a href="https://api.jquery.com/event.currentTarget/">https://api.jquery.com/event.currentTarget/</a>

data

data: any

An optional object of data passed to an event method when the current executing handler is bound.

See

<a href="https://api.jquery.com/event.data/">https://api.jquery.com/event.data/</a>

ReadonlydefaultPrevented

defaultPrevented: boolean

Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.

MDN Reference

delegateTarget

delegateTarget: Element

The element where the currently-called jQuery event handler was attached.

See

<a href="https://api.jquery.com/event.delegateTarget/">https://api.jquery.com/event.delegateTarget/</a>

ReadonlyeventPhase

eventPhase: number

Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.

MDN Reference

ReadonlyisTrusted

isTrusted: boolean

Returns true if event was dispatched by the user agent, and false otherwise.

MDN Reference

key

key: string

keyCode

keyCode: number

Deprecated

metaKey

metaKey: boolean

Indicates whether the META key was pressed when the event fired.

See

<a href="https://api.jquery.com/event.metaKey/">https://api.jquery.com/event.metaKey/</a>

namespace

namespace: string

The namespace specified when the event was triggered.

See

<a href="https://api.jquery.com/event.namespace/">https://api.jquery.com/event.namespace/</a>

ReadonlyNONE

NONE: 0

originalEvent

originalEvent: Event

The browser's original Event object.

See

<a href="https://api.jquery.com/category/events/event-object/">https://api.jquery.com/category/events/event-object/</a>

pageX

pageX: number

The mouse position relative to the left edge of the document.

See

<a href="https://api.jquery.com/event.pageX/">https://api.jquery.com/event.pageX/</a>

pageY

pageY: number

The mouse position relative to the top edge of the document.

See

<a href="https://api.jquery.com/event.pageY/">https://api.jquery.com/event.pageY/</a>

relatedTarget

relatedTarget: Element

The other DOM element involved in the event, if any.

See

<a href="https://api.jquery.com/event.relatedTarget/">https://api.jquery.com/event.relatedTarget/</a>

result

result: any

The last value returned by an event handler that was triggered by this event, unless the value was undefined.

See

<a href="https://api.jquery.com/event.result/">https://api.jquery.com/event.result/</a>

returnValue

returnValue: boolean

Deprecated

MDN Reference

shiftKey

shiftKey: boolean

ReadonlysrcElement

srcElement: null | EventTarget

Deprecated

MDN Reference

target

target: Element

The DOM element that initiated the event.

See

<a href="https://api.jquery.com/event.target/">https://api.jquery.com/event.target/</a>

ReadonlytimeStamp

timeStamp: number

Returns the event's timestamp as the number of milliseconds measured relative to the time origin.

MDN Reference

Readonlytype

type: string

Returns the type of event, e.g. "click", "hashchange", or "submit".

MDN Reference

which

which: number

For key or mouse events, this property indicates the specific key or button that was pressed.

See

<a href="https://api.jquery.com/event.which/">https://api.jquery.com/event.which/</a>

Methods

composedPath

composedPath(): EventTarget[]

Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.

MDN Reference

Returns EventTarget[]

initEvent

initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void

Parameters

  • type: string
  • Optionalbubbles: boolean
  • Optionalcancelable: boolean

Returns void

Deprecated

MDN Reference

isDefaultPrevented

isDefaultPrevented(): boolean

Returns whether event.preventDefault() was ever called on this event object.

Returns boolean

See

<a href="https://api.jquery.com/event.isDefaultPrevented/">https://api.jquery.com/event.isDefaultPrevented/</a>

isImmediatePropagationStopped

isImmediatePropagationStopped(): boolean

Returns whether event.stopImmediatePropagation() was ever called on this event object.

Returns boolean

See

<a href="https://api.jquery.com/event.isImmediatePropagationStopped/">https://api.jquery.com/event.isImmediatePropagationStopped/</a>

isPropagationStopped

isPropagationStopped(): boolean

Returns whether event.stopPropagation() was ever called on this event object.

Returns boolean

See

<a href="https://api.jquery.com/event.isPropagationStopped/">https://api.jquery.com/event.isPropagationStopped/</a>

preventDefault

preventDefault(): any

If this method is called, the default action of the event will not be triggered.

Returns any

See

<a href="https://api.jquery.com/event.preventDefault/">https://api.jquery.com/event.preventDefault/</a>

stopImmediatePropagation

stopImmediatePropagation(): void

Keeps the rest of the handlers from being executed and prevents the event from bubbling up the DOM tree.

Returns void

See

<a href="https://api.jquery.com/event.stopImmediatePropagation/">https://api.jquery.com/event.stopImmediatePropagation/</a>

stopPropagation

stopPropagation(): void

Prevents the event from bubbling up the DOM tree, preventing any parent handlers from being notified of the event.

Returns void

See

<a href="https://api.jquery.com/event.stopPropagation/">https://api.jquery.com/event.stopPropagation/</a>

Settings

Member Visibility

  • Protected
  • Inherited
  • External

ThemeOSLightDark

On This Page

Properties altKeyAT_TARGETbubblesBUBBLING_PHASEcancelablecancelBubbleCAPTURING_PHASEcharcharCodecomposedctrlKeycurrentTargetdatadefaultPreventeddelegateTargeteventPhaseisTrustedkeykeyCodemetaKeynamespaceNONEoriginalEventpageXpageYrelatedTargetresultreturnValueshiftKeysrcElementtargettimeStamptypewhich Methods composedPathinitEventisDefaultPreventedisImmediatePropagationStoppedisPropagationStoppedpreventDefaultstopImmediatePropagationstopPropagation