Winter Cardinal UI - v0.442.0 / EShapeActionRuntimeOpenDialogBoolean

Class: EShapeActionRuntimeOpenDialogBoolean

A base class of action runtimes.

Hierarchy

• EShapeActionRuntimeOpenDialog<boolean>

  ↳ EShapeActionRuntimeOpenDialogBoolean

Table of contents

Constructors

• constructor

Properties

• condition
• initial
• isOpened
• max
• min
• onInputAction
• reset
• step
• target
• DIALOG

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
• open

Constructors

constructor

• new EShapeActionRuntimeOpenDialogBoolean(value): EShapeActionRuntimeOpenDialogBoolean

Parameters

Name	Type
value	EShapeActionValueOpenDialog

Returns

EShapeActionRuntimeOpenDialogBoolean

Overrides

EShapeActionRuntimeOpenDialog.constructor

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-open-dialog-boolean.ts:17

Properties

condition

• Protected Readonly condition: EShapeActionExpression<boolean>

Inherited from

EShapeActionRuntimeOpenDialog.condition

Defined in

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

---

initial

• Protected initial: EShapeActionExpression<boolean>

Overrides

EShapeActionRuntimeOpenDialog.initial

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-open-dialog-boolean.ts:15

---

isOpened

• Protected isOpened: boolean

Inherited from

EShapeActionRuntimeOpenDialog.isOpened

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-open-dialog.ts:23

---

max

• Protected max: EShapeActionExpression<null | number>

Inherited from

EShapeActionRuntimeOpenDialog.max

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-open-dialog.ts:27

---

min

• Protected min: EShapeActionExpression<null | number>

Inherited from

EShapeActionRuntimeOpenDialog.min

Defined in

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

---

onInputAction

• Protected onInputAction: EShapeActionValueOnInputAction

Inherited from

EShapeActionRuntimeOpenDialog.onInputAction

Defined in

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

---

reset

• Readonly reset: number

Inherited from

EShapeActionRuntimeOpenDialog.reset

Defined in

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

---

step

• Protected step: EShapeActionExpression<null | number>

Inherited from

EShapeActionRuntimeOpenDialog.step

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-open-dialog.ts:25

---

target

• Protected Readonly target: EShapeActionExpression<null | string>

Inherited from

EShapeActionRuntimeOpenDialog.target

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-open-dialog.ts:21

---

DIALOG

▪ Static Protected Optional DIALOG: DDialogInputBoolean<DThemeDialogInputBoolean, DDialogInputBooleanOptions<DThemeDialogInputBoolean>>

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-open-dialog-boolean.ts:14

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

Inherited from

EShapeActionRuntimeOpenDialog.execute

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-open-dialog.ts:39

---

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

Inherited from

EShapeActionRuntimeOpenDialog.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

Inherited from

EShapeActionRuntimeOpenDialog.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

Inherited from

EShapeActionRuntimeOpenDialog.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

Inherited from

EShapeActionRuntimeOpenDialog.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

Inherited from

EShapeActionRuntimeOpenDialog.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

Inherited from

EShapeActionRuntimeOpenDialog.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

Inherited from

EShapeActionRuntimeOpenDialog.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

Inherited from

EShapeActionRuntimeOpenDialog.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

Inherited from

EShapeActionRuntimeOpenDialog.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

Inherited from

EShapeActionRuntimeOpenDialog.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

Inherited from

EShapeActionRuntimeOpenDialog.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

Inherited from

EShapeActionRuntimeOpenDialog.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

Inherited from

EShapeActionRuntimeOpenDialog.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

Inherited from

EShapeActionRuntimeOpenDialog.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

Inherited from

EShapeActionRuntimeOpenDialog.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

Inherited from

EShapeActionRuntimeOpenDialog.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

Inherited from

EShapeActionRuntimeOpenDialog.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

Inherited from

EShapeActionRuntimeOpenDialog.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

Inherited from

EShapeActionRuntimeOpenDialog.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

Inherited from

EShapeActionRuntimeOpenDialog.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

Inherited from

EShapeActionRuntimeOpenDialog.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

Inherited from

EShapeActionRuntimeOpenDialog.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

Inherited from

EShapeActionRuntimeOpenDialog.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

Inherited from

EShapeActionRuntimeOpenDialog.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

Inherited from

EShapeActionRuntimeOpenDialog.onUpOutside

Defined in

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

---

open

▸ open(shape, target, initial, step, min, max): Promise<boolean>

Parameters

Name	Type
shape	EShape
target	string
initial	boolean
step	null | number
min	null | number
max	null | number

Returns

Promise<boolean>

Overrides

EShapeActionRuntimeOpenDialog.open

Defined in

src/main/typescript/wcardinal/ui/shape/action/e-shape-action-runtime-open-dialog-boolean.ts:22

Edit this page.