Class: UIEvent

Hierarchy

• Event

  ↳ UIEvent

  ↳↳ PointerEvent

  ↳↳ RotateEvent

  ↳↳ ZoomEvent

  ↳↳ KeyEvent

Implements

• IUIEvent

Table of contents

Constructors

• constructor

Properties

• origin
• type
• phase
• isStopDefault
• isStop
• isStopNow
• x
• y
• path
• throughPath
• altKey
• ctrlKey
• shiftKey
• metaKey
• buttons
• target
• current
• bubbles
• getInner
• getLocal
• getPage

Accessors

• spaceKey
• left
• right
• middle

Methods

• stopDefault
• stopNow
• stop
• getBoxPoint
• getInnerPoint
• getLocalPoint
• getPagePoint
• changeName

Constructors

constructor

• new UIEvent(params): UIEvent

Parameters

Name	Type
params	IUIEvent

Returns

UIEvent

Overrides

Event.constructor

Defined in

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

Properties

origin

• Readonly origin: IObject

Implementation of

IUIEvent.origin

Inherited from

Event.origin

Defined in

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

---

type

• Readonly type: string

Implementation of

IUIEvent.type

Inherited from

Event.type

Defined in

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

---

phase

• Readonly phase: number

Implementation of

IUIEvent.phase

Inherited from

Event.phase

Defined in

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

---

isStopDefault

• isStopDefault: boolean

Implementation of

IUIEvent.isStopDefault

Inherited from

Event.isStopDefault

Defined in

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

---

isStop

• isStop: boolean

Implementation of

IUIEvent.isStop

Inherited from

Event.isStop

Defined in

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

---

isStopNow

• isStopNow: boolean

Implementation of

IUIEvent.isStopNow

Inherited from

Event.isStopNow

Defined in

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

---

x

• Readonly x: number

Implementation of

IUIEvent.x

Defined in

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

---

y

• Readonly y: number

Implementation of

IUIEvent.y

Defined in

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

---

path

• Readonly path: ILeafList

Implementation of

IUIEvent.path

Defined in

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

---

throughPath

• Optional Readonly throughPath: ILeafList

Implementation of

IUIEvent.throughPath

Defined in

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

---

altKey

• Readonly altKey: boolean

Implementation of

IUIEvent.altKey

Defined in

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

---

ctrlKey

• Readonly ctrlKey: boolean

Implementation of

IUIEvent.ctrlKey

Defined in

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

---

shiftKey

• Readonly shiftKey: boolean

Implementation of

IUIEvent.shiftKey

Defined in

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

---

metaKey

• Readonly metaKey: boolean

Implementation of

IUIEvent.metaKey

Defined in

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

---

buttons

• Readonly buttons: number

Implementation of

IUIEvent.buttons

Defined in

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

---

target

• Readonly target: ILeaf

Implementation of

IUIEvent.target

Overrides

Event.target

Defined in

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

---

current

• Readonly current: ILeaf

Implementation of

IUIEvent.current

Overrides

Event.current

Defined in

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

---

bubbles

• Readonly bubbles: boolean = true

Implementation of

IUIEvent.bubbles

Overrides

Event.bubbles

Defined in

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

---

getInner

• getInner: (relative?: ILeaf) => IPointData

Type declaration

▸ (relative?): IPointData

Parameters

Name	Type
relative?	ILeaf

Returns

IPointData

Implementation of

IUIEvent.getInner

Defined in

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

---

getLocal

• getLocal: (relative?: ILeaf) => IPointData

Type declaration

▸ (relative?): IPointData

Parameters

Name	Type
relative?	ILeaf

Returns

IPointData

Implementation of

IUIEvent.getLocal

Defined in

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

---

getPage

• getPage: () => IPointData

Type declaration

▸ (): IPointData

Returns

IPointData

Implementation of

IUIEvent.getPage

Defined in

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

Accessors

spaceKey

• get spaceKey(): boolean

Returns

boolean

Implementation of

IUIEvent.spaceKey

Defined in

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

---

left

• get left(): boolean

Returns

boolean

Implementation of

IUIEvent.left

Defined in

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

---

right

• get right(): boolean

Returns

boolean

Implementation of

IUIEvent.right

Defined in

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

---

middle

• get middle(): boolean

Returns

boolean

Implementation of

IUIEvent.middle

Defined in

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

Methods

stopDefault

▸ stopDefault(): void

Returns

void

Implementation of

IUIEvent.stopDefault

Inherited from

Event.stopDefault

Defined in

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

---

stopNow

▸ stopNow(): void

Returns

void

Implementation of

IUIEvent.stopNow

Inherited from

Event.stopNow

Defined in

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

---

stop

▸ stop(): void

Returns

void

Implementation of

IUIEvent.stop

Inherited from

Event.stop

Defined in

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

---

getBoxPoint

▸ getBoxPoint(relative?): IPointData

Parameters

Name	Type
relative?	ILeaf

Returns

IPointData

Implementation of

IUIEvent.getBoxPoint

Defined in

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

---

getInnerPoint

▸ getInnerPoint(relative?): IPointData

Parameters

Name	Type
relative?	ILeaf

Returns

IPointData

Implementation of

IUIEvent.getInnerPoint

Defined in

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

---

getLocalPoint

▸ getLocalPoint(relative?): IPointData

Parameters

Name	Type
relative?	ILeaf

Returns

IPointData

Implementation of

IUIEvent.getLocalPoint

Defined in

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

---

getPagePoint

▸ getPagePoint(): IPointData

Returns

IPointData

Implementation of

IUIEvent.getPagePoint

Defined in

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

---

changeName

▸ changeName(oldName, newName): void

Parameters

Name	Type
oldName	string
newName	string

Returns

void

Defined in

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