Winter Cardinal UI - v0.442.0 / EShapeActionRuntime

Interface: EShapeActionRuntime

An action runtime. Please note that all the action runtimes are shared across shapes.

Implemented by

• EShapeActionRuntimeBase

Table of contents

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

Properties

reset

• Readonly reset: number

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime.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

Defined in

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

---

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

Defined in

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

---

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

Defined in

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

---

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

Defined in

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

---

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

Defined in

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

---

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

Defined in

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

---

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

Defined in

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

---

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

Defined in

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

---

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

Defined in

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

---

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

Defined in

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

---

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

Defined in

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

---

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

Defined in

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

---

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

Defined in

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

---

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

Defined in

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

---

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

Defined in

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

---

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

Defined in

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

---

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

Defined in

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

---

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

Defined in

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

---

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

Defined in

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

---

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

Defined in

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

---

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

Defined in

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

---

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

Defined in

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

---

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

Defined in

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

---

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

Defined in

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

---

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

Defined in

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

---

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

Defined in

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

Edit this page.