Class: KeyEvent

Hierarchy

• UIEvent

  ↳ KeyEvent

Implements

• IKeyEvent

Table of contents

Constructors

• constructor

Properties

• origin
• type
• phase
• isStopDefault
• isStop
• isStopNow
• BEFORE_DOWN
• BEFORE_UP
• DOWN
• HOLD
• UP
• code
• key
• x
• y
• path
• throughPath
• altKey
• ctrlKey
• shiftKey
• metaKey
• buttons
• target
• current
• bubbles

Accessors

• spaceKey
• left
• right
• middle

Methods

• stopDefault
• stopNow
• stop
• isHoldKeys
• getBoxPoint
• getInnerPoint
• getLocalPoint
• getPagePoint
• getInner
• getLocal
• getPage
• changeName

Constructors

constructor

• new KeyEvent(params): KeyEvent

Parameters

Name	Type
params	IUIEvent

Returns

KeyEvent

Inherited from

UIEvent.constructor

Defined in

src/ui/packages/event/src/UIEvent.ts:31

Properties

origin

• Readonly origin: IObject

Implementation of

IKeyEvent.origin

Inherited from

UIEvent.origin

Defined in

src/leafer/packages/event/src/Event.ts:7

---

type

• Readonly type: string

Implementation of

IKeyEvent.type

Inherited from

UIEvent.type

Defined in

src/leafer/packages/event/src/Event.ts:9

---

phase

• Readonly phase: number

Implementation of

IKeyEvent.phase

Inherited from

UIEvent.phase

Defined in

src/leafer/packages/event/src/Event.ts:14

---

isStopDefault

• isStopDefault: boolean

Implementation of

IKeyEvent.isStopDefault

Inherited from

UIEvent.isStopDefault

Defined in

src/leafer/packages/event/src/Event.ts:16

---

isStop

• isStop: boolean

Implementation of

IKeyEvent.isStop

Inherited from

UIEvent.isStop

Defined in

src/leafer/packages/event/src/Event.ts:17

---

isStopNow

• isStopNow: boolean

Implementation of

IKeyEvent.isStopNow

Inherited from

UIEvent.isStopNow

Defined in

src/leafer/packages/event/src/Event.ts:18

---

BEFORE_DOWN

▪ Static BEFORE_DOWN: string = 'key.before_down'

Defined in

src/ui/packages/event/src/KeyEvent.ts:10

---

BEFORE_UP

▪ Static BEFORE_UP: string = 'key.before_up'

Defined in

src/ui/packages/event/src/KeyEvent.ts:11

---

DOWN

▪ Static DOWN: string = 'key.down'

Defined in

src/ui/packages/event/src/KeyEvent.ts:13

---

HOLD

▪ Static HOLD: string = 'key.hold'

Defined in

src/ui/packages/event/src/KeyEvent.ts:14

---

UP

▪ Static UP: string = 'key.up'

Defined in

src/ui/packages/event/src/KeyEvent.ts:15

---

code

• Readonly code: IKeyCodes

Implementation of

IKeyEvent.code

Defined in

src/ui/packages/event/src/KeyEvent.ts:17

---

key

• Readonly key: string

Implementation of

IKeyEvent.key

Defined in

src/ui/packages/event/src/KeyEvent.ts:18

---

x

• Readonly x: number

Implementation of

IKeyEvent.x

Inherited from

UIEvent.x

Defined in

src/ui/packages/event/src/UIEvent.ts:10

---

y

• Readonly y: number

Implementation of

IKeyEvent.y

Inherited from

UIEvent.y

Defined in

src/ui/packages/event/src/UIEvent.ts:11

---

path

• Readonly path: ILeafList

Implementation of

IKeyEvent.path

Inherited from

UIEvent.path

Defined in

src/ui/packages/event/src/UIEvent.ts:13

---

throughPath

• Optional Readonly throughPath: ILeafList

Implementation of

IKeyEvent.throughPath

Inherited from

UIEvent.throughPath

Defined in

src/ui/packages/event/src/UIEvent.ts:14

---

altKey

• Readonly altKey: boolean

Implementation of

IKeyEvent.altKey

Inherited from

UIEvent.altKey

Defined in

src/ui/packages/event/src/UIEvent.ts:16

---

ctrlKey

• Readonly ctrlKey: boolean

Implementation of

IKeyEvent.ctrlKey

Inherited from

UIEvent.ctrlKey

Defined in

src/ui/packages/event/src/UIEvent.ts:17

---

shiftKey

• Readonly shiftKey: boolean

Implementation of

IKeyEvent.shiftKey

Inherited from

UIEvent.shiftKey

Defined in

src/ui/packages/event/src/UIEvent.ts:18

---

metaKey

• Readonly metaKey: boolean

Implementation of

IKeyEvent.metaKey

Inherited from

UIEvent.metaKey

Defined in

src/ui/packages/event/src/UIEvent.ts:19

---

buttons

• Readonly buttons: number

Implementation of

IKeyEvent.buttons

Inherited from

UIEvent.buttons

Defined in

src/ui/packages/event/src/UIEvent.ts:25

---

target

• Readonly target: ILeaf

Implementation of

IKeyEvent.target

Inherited from

UIEvent.target

Defined in

src/ui/packages/event/src/UIEvent.ts:27

---

current

• Readonly current: ILeaf

Implementation of

IKeyEvent.current

Inherited from

UIEvent.current

Defined in

src/ui/packages/event/src/UIEvent.ts:28

---

bubbles

• Readonly bubbles: boolean = true

Implementation of

IKeyEvent.bubbles

Inherited from

UIEvent.bubbles

Defined in

src/ui/packages/event/src/UIEvent.ts:29

Accessors

spaceKey

• get spaceKey(): boolean

Returns

boolean

Implementation of

IKeyEvent.spaceKey

Inherited from

UIEvent.spaceKey

Defined in

src/ui/packages/event/src/UIEvent.ts:20

---

left

• get left(): boolean

Returns

boolean

Implementation of

IKeyEvent.left

Inherited from

UIEvent.left

Defined in

src/ui/packages/event/src/UIEvent.ts:22

---

right

• get right(): boolean

Returns

boolean

Implementation of

IKeyEvent.right

Inherited from

UIEvent.right

Defined in

src/ui/packages/event/src/UIEvent.ts:23

---

middle

• get middle(): boolean

Returns

boolean

Implementation of

IKeyEvent.middle

Inherited from

UIEvent.middle

Defined in

src/ui/packages/event/src/UIEvent.ts:24

Methods

stopDefault

▸ stopDefault(): void

Returns

void

Implementation of

IKeyEvent.stopDefault

Inherited from

UIEvent.stopDefault

Defined in

src/leafer/packages/event/src/Event.ts:25

---

stopNow

▸ stopNow(): void

Returns

void

Implementation of

IKeyEvent.stopNow

Inherited from

UIEvent.stopNow

Defined in

src/leafer/packages/event/src/Event.ts:30

---

stop

▸ stop(): void

Returns

void

Implementation of

IKeyEvent.stop

Inherited from

UIEvent.stop

Defined in

src/leafer/packages/event/src/Event.ts:36

---

isHoldKeys

▸ isHoldKeys(shortcutKeys?): boolean

Parameters

Name	Type
shortcutKeys?	IShortcutKeysCheck | IShortcutKeys

Returns

boolean

Implementation of

IKeyEvent.isHoldKeys

Inherited from

UIEvent.isHoldKeys

Defined in

src/ui/packages/event/src/UIEvent.ts:37

---

getBoxPoint

▸ getBoxPoint(relative?): IPointData

Parameters

Name	Type
relative?	ILeaf

Returns

IPointData

Implementation of

IKeyEvent.getBoxPoint

Inherited from

UIEvent.getBoxPoint

Defined in

src/ui/packages/event/src/UIEvent.ts:41

---

getInnerPoint

▸ getInnerPoint(relative?): IPointData

Parameters

Name	Type
relative?	ILeaf

Returns

IPointData

Implementation of

IKeyEvent.getInnerPoint

Inherited from

UIEvent.getInnerPoint

Defined in

src/ui/packages/event/src/UIEvent.ts:45

---

getLocalPoint

▸ getLocalPoint(relative?): IPointData

Parameters

Name	Type
relative?	ILeaf

Returns

IPointData

Implementation of

IKeyEvent.getLocalPoint

Inherited from

UIEvent.getLocalPoint

Defined in

src/ui/packages/event/src/UIEvent.ts:49

---

getPagePoint

▸ getPagePoint(): IPointData

Returns

IPointData

Implementation of

IKeyEvent.getPagePoint

Inherited from

UIEvent.getPagePoint

Defined in

src/ui/packages/event/src/UIEvent.ts:53

---

getInner

▸ getInner(relative?): IPointData

Parameters

Name	Type
relative?	ILeaf

Returns

IPointData

Implementation of

IKeyEvent.getInner

Inherited from

UIEvent.getInner

Defined in

src/ui/packages/event/src/UIEvent.ts:58

---

getLocal

▸ getLocal(relative?): IPointData

Parameters

Name	Type
relative?	ILeaf

Returns

IPointData

Implementation of

IKeyEvent.getLocal

Inherited from

UIEvent.getLocal

Defined in

src/ui/packages/event/src/UIEvent.ts:59

---

getPage

▸ getPage(): IPointData

Returns

IPointData

Implementation of

IKeyEvent.getPage

Inherited from

UIEvent.getPage

Defined in

src/ui/packages/event/src/UIEvent.ts:60

---

changeName

▸ changeName(oldName, newName): void

Parameters

Name	Type
oldName	string
newName	string

Returns

void

Inherited from

UIEvent.changeName

Defined in

src/ui/packages/event/src/UIEvent.ts:63