Winter Cardinal UI - v0.457.0 / UtilKeyboardEvent

Class: UtilKeyboardEvent

Table of contents

Constructors

• constructor

Methods

• getFocusDirection
• isActivateKey
• isArrowDownKey
• isArrowLeftKey
• isArrowRightKey
• isArrowUpKey
• isCancelKey
• isDeleteKey
• isFocusKey
• isOkKey
• isRedoKey
• isSaveAsKey
• isSaveKey
• isSelectAllKey
• isUndoKey
• moveFocus
• moveFocusHorizontally
• moveFocusVertically
• on
• toShortcut
• toString

Constructors

constructor

• new UtilKeyboardEvent(): UtilKeyboardEvent

Returns

UtilKeyboardEvent

Methods

getFocusDirection

▸ getFocusDirection(e): boolean

Parameters

Name	Type
e	KeyboardEvent

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/util/util-keyboard-event.ts:234

---

isActivateKey

▸ isActivateKey(e): boolean

Parameters

Name	Type
e	KeyboardEvent

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/util/util-keyboard-event.ts:178

---

isArrowDownKey

▸ isArrowDownKey(e): boolean

Parameters

Name	Type
e	KeyboardEvent

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/util/util-keyboard-event.ts:186

---

isArrowLeftKey

▸ isArrowLeftKey(e): boolean

Parameters

Name	Type
e	KeyboardEvent

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/util/util-keyboard-event.ts:190

---

isArrowRightKey

▸ isArrowRightKey(e): boolean

Parameters

Name	Type
e	KeyboardEvent

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/util/util-keyboard-event.ts:194

---

isArrowUpKey

▸ isArrowUpKey(e): boolean

Parameters

Name	Type
e	KeyboardEvent

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/util/util-keyboard-event.ts:182

---

isCancelKey

▸ isCancelKey(e): boolean

Parameters

Name	Type
e	KeyboardEvent

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/util/util-keyboard-event.ts:198

---

isDeleteKey

▸ isDeleteKey(e): boolean

Parameters

Name	Type
e	KeyboardEvent

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/util/util-keyboard-event.ts:222

---

isFocusKey

▸ isFocusKey(e): boolean

Parameters

Name	Type
e	KeyboardEvent

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/util/util-keyboard-event.ts:202

---

isOkKey

▸ isOkKey(e): boolean

Parameters

Name	Type
e	KeyboardEvent

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/util/util-keyboard-event.ts:230

---

isRedoKey

▸ isRedoKey(e): boolean

Parameters

Name	Type
e	KeyboardEvent

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/util/util-keyboard-event.ts:210

---

isSaveAsKey

▸ isSaveAsKey(e): boolean

Parameters

Name	Type
e	KeyboardEvent

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/util/util-keyboard-event.ts:218

---

isSaveKey

▸ isSaveKey(e): boolean

Parameters

Name	Type
e	KeyboardEvent

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/util/util-keyboard-event.ts:214

---

isSelectAllKey

▸ isSelectAllKey(e): boolean

Parameters

Name	Type
e	KeyboardEvent

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/util/util-keyboard-event.ts:226

---

isUndoKey

▸ isUndoKey(e): boolean

Parameters

Name	Type
e	KeyboardEvent

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/util/util-keyboard-event.ts:206

---

moveFocus

▸ moveFocus(direction, target, picker?): boolean

Parameters

Name	Type
direction	boolean
target	DBase<DThemeBase, DBaseOptions<DThemeBase, any>>
picker?	UtilKeyboardEventLayerPicker

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/util/util-keyboard-event.ts:367

---

moveFocusHorizontally

▸ moveFocusHorizontally(e, target, picker?): boolean

Parameters

Name	Type
e	KeyboardEvent
target	DBase<DThemeBase, DBaseOptions<DThemeBase, any>>
picker?	UtilKeyboardEventLayerPicker

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/util/util-keyboard-event.ts:352

---

moveFocusVertically

▸ moveFocusVertically(e, target, picker?): boolean

Parameters

Name	Type
e	KeyboardEvent
target	DBase<DThemeBase, DBaseOptions<DThemeBase, any>>
picker?	UtilKeyboardEventLayerPicker

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/util/util-keyboard-event.ts:337

---

on

▸ on(target, expressionOrShortcut, handler?): void

Parameters

Name	Type
target	UtilKeyboardEventShortcutTarget
expressionOrShortcut	string | UtilKeyboardEventShortcut
handler?	(e: KeyboardEvent) => void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/util/util-keyboard-event.ts:312

---

toShortcut

▸ toShortcut(expressionOrShortcut): UtilKeyboardEventShortcut

Parameters

Name	Type
expressionOrShortcut	string | UtilKeyboardEventShortcut

Returns

UtilKeyboardEventShortcut

Defined in

src/main/typescript/wcardinal/ui/util/util-keyboard-event.ts:238

---

toString

▸ toString(shortcut): string

Parameters

Name	Type
shortcut	UtilKeyboardEventShortcut

Returns

string

Defined in

src/main/typescript/wcardinal/ui/util/util-keyboard-event.ts:297

Edit this page.