Winter Cardinal UI - v0.457.0 / EShapeButtonRuntimeActionToggle

Class: EShapeButtonRuntimeActionToggle

A base class of action runtimes.

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new EShapeButtonRuntimeActionToggle(runtime): EShapeButtonRuntimeActionToggle

Parameters

Name Type
runtime EShapeRuntime

Returns

EShapeButtonRuntimeActionToggle

Overrides

EShapeActionRuntimeBase.constructor

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:47

Properties

_fillAlpha

• Protected Readonly _fillAlpha: number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:21

_fillAlphaDisabled

• Protected Readonly _fillAlphaDisabled: number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:22

_fillColor

• Protected Readonly _fillColor: number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:17

_fillColorActive

• Protected Readonly _fillColorActive: number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:14

_fillColorActiveHovered

• Protected Readonly _fillColorActiveHovered: number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:16

_fillColorActivePressed

• Protected Readonly _fillColorActivePressed: number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:15

_fillColorHovered

• Protected Readonly _fillColorHovered: number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:19

_fillColorPressed

• Protected Readonly _fillColorPressed: number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:18

_strokeAlpha

• Protected Readonly _strokeAlpha: number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:31

_strokeAlphaDisabled

• Protected Readonly _strokeAlphaDisabled: number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:32

_strokeColor

• Protected Readonly _strokeColor: number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:27

_strokeColorActive

• Protected Readonly _strokeColorActive: number

Defined in

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

_strokeColorActiveHovered

• Protected Readonly _strokeColorActiveHovered: number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:26

_strokeColorActivePressed

• Protected Readonly _strokeColorActivePressed: number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:25

_strokeColorGrayscaleHovered

• Protected Readonly _strokeColorGrayscaleHovered: number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:29

_strokeColorPressed

• Protected Readonly _strokeColorPressed: number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:28

_textAlpha

• Protected Readonly _textAlpha: number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:38

_textAlphaDisabled

• Protected Readonly _textAlphaDisabled: number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:39

_textColor

• Protected Readonly _textColor: number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:35

_textColorActive

• Protected Readonly _textColorActive: number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:34

_textColorDisabled

• Protected Readonly _textColorDisabled: number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:36

_textOutlineAlpha

• Protected Readonly _textOutlineAlpha: number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:44

_textOutlineAlphaDisabled

• Protected Readonly _textOutlineAlphaDisabled: number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:45

_textOutlineColor

• Protected Readonly _textOutlineColor: number

Defined in

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

_textOutlineColorDisabled

• Protected Readonly _textOutlineColorDisabled: number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:42

reset

• Readonly reset: number

Inherited from

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

Overrides

EShapeActionRuntimeBase.execute

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:128

getCursor

▸ getCursor(state): string

Parameters

Name Type
state EShapeStateSet

Returns

string

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:236

getFillAlpha

▸ getFillAlpha(state): number

Parameters

Name Type
state EShapeStateSet

Returns

number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:164

getFillColor

▸ getFillColor(state): number

Parameters

Name Type
state EShapeStateSet

Returns

number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:142

getStrokeAlpha

▸ getStrokeAlpha(state): number

Parameters

Name Type
state EShapeStateSet

Returns

number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:194

getStrokeColor

▸ getStrokeColor(state): number

Parameters

Name Type
state EShapeStateSet

Returns

number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:172

getTextAlpha

▸ getTextAlpha(state): number

Parameters

Name Type
state EShapeStateSet

Returns

number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:212

getTextColor

▸ getTextColor(state): number

Parameters

Name Type
state EShapeStateSet

Returns

number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:202

getTextOutlineAlpha

▸ getTextOutlineAlpha(state): number

Parameters

Name Type
state EShapeStateSet

Returns

number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:228

getTextOutlineColor

▸ getTextOutlineColor(state): number

Parameters

Name Type
state EShapeStateSet

Returns

number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:220

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

EShapeActionRuntimeBase.onUpOutside

Defined in

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

toOnHovered

▸ toOnHovered(color): number

Parameters

Name Type
color number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/shape/variant/e-shape-button-runtime-action-toggle.ts:117

Edit this page.