Winter Cardinal UI - v0.457.0 / EShapeActionRuntimeBase

Class: EShapeActionRuntimeBase

A base class of action runtimes.

Hierarchy

• EShapeActionRuntimeBase

  ↳ EShapeActionRuntimeConditional

  ↳ EShapeButtonRuntimeActionToggle

  ↳ EShapeButtonRuntimeAction

Implements

• EShapeActionRuntime

Table of contents

Constructors

• constructor

Properties

• reset

Methods

• execute
• initialize
• onBlur
• onClick
• onDblClick
• onDown
• onDowning
• onFocus
• onKeyDown
• onKeyUp
• onMove
• onOut
• onOver
• onPressed
• onRender
• onResize
• onRightClick
• onRightDown
• onRightDowning
• onRightPressed
• onRightUnpressed
• onRightUp
• onRightUpOutside
• onUnpressed
• onUp
• onUpOutside

Constructors

constructor

• new EShapeActionRuntimeBase(reset?): EShapeActionRuntimeBase

Parameters

Name	Type
reset?	number

Returns

EShapeActionRuntimeBase

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-base.ts:18

Properties

reset

• Readonly reset: number

Implementation of

EShapeActionRuntime.reset

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-base.ts:16

Methods

execute

▸ execute(shape, runtime, time): void

Called to execute this action for the given shape.

Parameters

Name	Type	Description
shape	EShape	a shape
runtime	EShapeRuntime	a runtime
time	number	a current time

Returns

void

Implementation of

EShapeActionRuntime.execute

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-base.ts:26

---

initialize

▸ initialize(shape, runtime): void

Called to initialize this action runtime for the given shape.

Parameters

Name	Type	Description
shape	EShape	a shape
runtime	EShapeRuntime	a runtime

Returns

void

Implementation of

EShapeActionRuntime.initialize

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-base.ts:22

---

onBlur

▸ onBlur(shape, runtime): void

Called when a shape losees a focuse.

Parameters

Name	Type	Description
shape	EShape	a shape
runtime	EShapeRuntime	a runtime

Returns

void

Implementation of

EShapeActionRuntime.onBlur

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-base.ts:38

---

onClick

▸ onClick(shape, runtime, e): void

Called when a shape is clicked.

Parameters

Name	Type	Description
shape	EShape	a shape
runtime	EShapeRuntime	a runtime
e	KeyboardEvent | InteractionEvent	an event object

Returns

void

Implementation of

EShapeActionRuntime.onClick

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-base.ts:42

---

onDblClick

▸ onDblClick(shape, runtime, e, manager): void

Called when a shape is double clicked.

Parameters

Name	Type	Description
shape	EShape	a shape
runtime	EShapeRuntime	a runtime
e	MouseEvent | TouchEvent	an event object
manager	InteractionManager	the interaction manager

Returns

void

Implementation of

EShapeActionRuntime.onDblClick

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-base.ts:46

---

onDown

▸ onDown(shape, runtime, e): void

Called when a pointer or a key get pressed on a shape.

Parameters

Name	Type	Description
shape	EShape	a shape
runtime	EShapeRuntime	a runtime
e	KeyboardEvent | InteractionEvent	an event object

Returns

void

Implementation of

EShapeActionRuntime.onDown

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-base.ts:59

---

onDowning

▸ onDowning(shape, runtime, e): void

Called when a pointer or a key are about to be pressed on a shape.

Parameters

Name	Type	Description
shape	EShape	a shape
runtime	EShapeRuntime	a runtime
e	KeyboardEvent | InteractionEvent	an event object

Returns

void

Implementation of

EShapeActionRuntime.onDowning

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-base.ts:55

---

onFocus

▸ onFocus(shape, runtime): void

Called when a shape get focused.

Parameters

Name	Type	Description
shape	EShape	a shape
runtime	EShapeRuntime	a runtime

Returns

void

Implementation of

EShapeActionRuntime.onFocus

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-base.ts:34

---

onKeyDown

▸ onKeyDown(shape, runtime, e): void

Called when a key is pressed on a shape.

Parameters

Name	Type	Description
shape	EShape	a shape
runtime	EShapeRuntime	a runtime
e	KeyboardEvent	an event object

Returns

void

Implementation of

EShapeActionRuntime.onKeyDown

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-base.ts:91

---

onKeyUp

▸ onKeyUp(shape, runtime, e): void

Called when a key is released on a shape.

Parameters

Name	Type	Description
shape	EShape	a shape
runtime	EShapeRuntime	a runtime
e	KeyboardEvent	an event object

Returns

void

Implementation of

EShapeActionRuntime.onKeyUp

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-base.ts:95

---

onMove

▸ onMove(shape, runtime, e): void

Called when a pointer is moved on a shape.

Parameters

Name	Type	Description
shape	EShape	a shape
runtime	EShapeRuntime	a runtime
e	InteractionEvent	an event object

Returns

void

Implementation of

EShapeActionRuntime.onMove

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-base.ts:63

---

onOut

▸ onOut(shape, runtime, e): void

Called when a pointer gets out of a shape.

Parameters

Name	Type	Description
shape	EShape	a shape
runtime	EShapeRuntime	a runtime
e	InteractionEvent	an event object

Returns

void

Implementation of

EShapeActionRuntime.onOut

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-base.ts:71

---

onOver

▸ onOver(shape, runtime, e): void

Called when a pointer gets on a shape.

Parameters

Name	Type	Description
shape	EShape	a shape
runtime	EShapeRuntime	a runtime
e	InteractionEvent	an event object

Returns

void

Implementation of

EShapeActionRuntime.onOver

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-base.ts:67

---

onPressed

▸ onPressed(shape, runtime, e): void

Called when a shape is pressed.

Parameters

Name	Type	Description
shape	EShape	a shape
runtime	EShapeRuntime	a runtime
e	KeyboardEvent | InteractionEvent	an event object

Returns

void

Implementation of

EShapeActionRuntime.onPressed

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-base.ts:83

---

onRender

▸ onRender(shape, runtime, time, renderer): void

Called when a shape get rendered.

Parameters

Name	Type	Description
shape	EShape	a shape
runtime	EShapeRuntime	a runtime
time	number	-
renderer	Renderer	-

Returns

void

Implementation of

EShapeActionRuntime.onRender

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-base.ts:127

---

onResize

▸ onResize(shape, runtime): void

Called when the shape size is changed.

Parameters

Name	Type	Description
shape	EShape	a shape
runtime	EShapeRuntime	a runtime

Returns

void

Implementation of

EShapeActionRuntime.onResize

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-base.ts:30

---

onRightClick

▸ onRightClick(shape, runtime, e): void

Called when a shape is right-clicked.

Parameters

Name	Type	Description
shape	EShape	a shape
runtime	EShapeRuntime	a runtime
e	InteractionEvent	an event object

Returns

void

Implementation of

EShapeActionRuntime.onRightClick

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-base.ts:99

---

onRightDown

▸ onRightDown(shape, runtime, e): void

Called when a secondary button gets pressed on a shape.

Parameters

Name	Type	Description
shape	EShape	a shape
runtime	EShapeRuntime	a runtime
e	InteractionEvent	an event object

Returns

void

Implementation of

EShapeActionRuntime.onRightDown

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-base.ts:107

---

onRightDowning

▸ onRightDowning(shape, runtime, e): void

Called when a secondary button is about to be pressed on a shape.

Parameters

Name	Type	Description
shape	EShape	a shape
runtime	EShapeRuntime	a runtime
e	InteractionEvent	an event object

Returns

void

Implementation of

EShapeActionRuntime.onRightDowning

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-base.ts:103

---

onRightPressed

▸ onRightPressed(shape, runtime, e): void

Called when a secondary button is pressed on a shape.

Parameters

Name	Type	Description
shape	EShape	a shape
runtime	EShapeRuntime	a runtime
e	InteractionEvent	an event object

Returns

void

Implementation of

EShapeActionRuntime.onRightPressed

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-base.ts:119

---

onRightUnpressed

▸ onRightUnpressed(shape, runtime, e): void

Called when a secondary button is released on a shape.

Parameters

Name	Type	Description
shape	EShape	a shape
runtime	EShapeRuntime	a runtime
e	InteractionEvent	an event object

Returns

void

Implementation of

EShapeActionRuntime.onRightUnpressed

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-base.ts:123

---

onRightUp

▸ onRightUp(shape, runtime, e): void

Called when a secondary button gets released on a shape.

Parameters

Name	Type	Description
shape	EShape	a shape
runtime	EShapeRuntime	a runtime
e	InteractionEvent	an event object

Returns

void

Implementation of

EShapeActionRuntime.onRightUp

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-base.ts:111

---

onRightUpOutside

▸ onRightUpOutside(shape, runtime, e): void

Called when a secondary button get released outside of a shape.

Parameters

Name	Type	Description
shape	EShape	a shape
runtime	EShapeRuntime	a runtime
e	InteractionEvent	an event object

Returns

void

Implementation of

EShapeActionRuntime.onRightUpOutside

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-base.ts:115

---

onUnpressed

▸ onUnpressed(shape, runtime, e): void

Called when a shape is released.

Parameters

Name	Type	Description
shape	EShape	a shape
runtime	EShapeRuntime	a runtime
e	KeyboardEvent | InteractionEvent	an event object

Returns

void

Implementation of

EShapeActionRuntime.onUnpressed

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-base.ts:87

---

onUp

▸ onUp(shape, runtime, e): void

Called when a pointer or a key get released on a shape.

Parameters

Name	Type	Description
shape	EShape	a shape
runtime	EShapeRuntime	a runtime
e	KeyboardEvent | InteractionEvent	an event object

Returns

void

Implementation of

EShapeActionRuntime.onUp

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-base.ts:75

---

onUpOutside

▸ onUpOutside(shape, runtime, e): void

Called when a pointer or a key get released outside of a shape.

Parameters

Name	Type	Description
shape	EShape	a shape
runtime	EShapeRuntime	a runtime
e	KeyboardEvent | InteractionEvent	an event object

Returns

void

Implementation of

EShapeActionRuntime.onUpOutside

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-base.ts:79

Edit this page.