Winter Cardinal UI - v0.442.0 / DDialogSelectEvents

Interface: DDialogSelectEvents<VALUE, EMITTER>

DDialogSelect events.

Type parameters

Name
VALUE
EMITTER

Hierarchy

Table of contents

Methods

Methods

added

added(container): void

Triggered when added to a container.

Parameters

Name Type Description
container Container a container added to

Returns

void

Inherited from

DDialogLayeredEvents.added

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:100


cancel

cancel(reason, emitter): void

Triggered when a dialog is canceled.

Parameters

Name Type Description
reason any a reason why canceled
emitter EMITTER an emitter

Returns

void

Inherited from

DDialogLayeredEvents.cancel

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:33


click

click(e, emitter): void

Triggered when an emitter is clicked.

Parameters

Name Type Description
e InteractionEvent an interaction event
emitter EMITTER an emitter

Returns

void

Inherited from

DDialogLayeredEvents.click

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:232


close

close(emitter): void

Triggered when a dialog is closed.

Parameters

Name Type Description
emitter EMITTER this

Returns

void

Inherited from

DDialogLayeredEvents.close

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:47


dblclick

dblclick(e, interactionManager, emitter): void

Triggered when an emitter is double clicked.

Parameters

Name Type Description
e MouseEvent | TouchEvent an event
interactionManager InteractionManager an interaction manager
emitter EMITTER an emitter

Returns

void

Inherited from

DDialogLayeredEvents.dblclick

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:241


down

down(e, emitter): void

Triggered when a pointer gets down on an emitter.

Parameters

Name Type Description
e InteractionEvent an interaction event.
emitter EMITTER an emitter

Returns

void

Inherited from

DDialogLayeredEvents.down

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:216


init

init(emitter): void

Triggered when an initialization is finished.

Parameters

Name Type Description
emitter EMITTER an emitter

Returns

void

Inherited from

DDialogLayeredEvents.init

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:93


keydown

keydown(e, emitter): void

Triggered when a key gets down.

Parameters

Name Type Description
e KeyboardEvent a keyboard event
emitter EMITTER an emitter

Returns

void

Inherited from

DDialogLayeredEvents.keydown

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:184


keyup

keyup(e, emitter): void

Triggered when a key gets up.

Parameters

Name Type Description
e KeyboardEvent a keyboard event
emitter EMITTER an emitter

Returns

void

Inherited from

DDialogLayeredEvents.keyup

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:192


move

move(newX, newY, oldX, oldY, emitter): void

Triggered when moved.

Parameters

Name Type Description
newX number a new x
newY number a new y
oldX number an old x
oldY number an old y
emitter EMITTER an emitter

Returns

void

Inherited from

DDialogLayeredEvents.move

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:118


ok

ok(value, emitter): void

Triggered when a dialog is successfully finished.

Parameters

Name Type Description
value VALUE a value
emitter EMITTER an emitter

Returns

void

Inherited from

DDialogLayeredEvents.ok

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:25


open

open(emitter): void

Triggered when a dialog is opened.

Parameters

Name Type Description
emitter EMITTER this

Returns

void

Inherited from

DDialogLayeredEvents.open

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:40


out

out(e, emitter): void

Triggered when a pointer gets out of an emitter.

Parameters

Name Type Description
e InteractionEvent an interaction event
emitter EMITTER an emitter

Returns

void

Inherited from

DDialogLayeredEvents.out

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:208


over

over(e, emitter): void

Triggered when a pointer gets on an emitter.

Parameters

Name Type Description
e InteractionEvent an interaction event.
emitter EMITTER an emitter

Returns

void

Inherited from

DDialogLayeredEvents.over

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:200


removed

removed(container): void

Triggered when removed from a container.

Parameters

Name Type Description
container Container a container removed from

Returns

void

Inherited from

DDialogLayeredEvents.removed

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:107


resize

resize(newWidth, newHeight, oldWidth, oldHeight, emitter): void

Triggered when resized.

Parameters

Name Type Description
newWidth number a new width
newHeight number a new height
oldWidth number an old width
oldHeight number an old height
emitter EMITTER an emitter

Returns

void

Inherited from

DDialogLayeredEvents.resize

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:129


scale

scale(newX, newY, oldX, oldY, emitter): void

Triggered when scaled.

Parameters

Name Type Description
newX number a new x
newY number a new y
oldX number an old x
oldY number an old y
emitter EMITTER an emitter

Returns

void

Inherited from

DDialogLayeredEvents.scale

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:146


select

select(value, self): void

Parameters

Name Type
value VALUE
self EMITTER

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:63


shortcut

shortcut(e, emitter): void

Triggered when a shortcut is pressed.

Parameters

Name Type Description
e KeyboardEvent an event
emitter EMITTER an emitter

Returns

void

Inherited from

DDialogLayeredEvents.shortcut

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:253


skew

skew(newX, newY, oldX, oldY, emitter): void

Triggered when skewed.

Parameters

Name Type Description
newX number a new x
newY number a new y
oldX number an old x
oldY number an old y
emitter EMITTER an emitter

Returns

void

Inherited from

DDialogLayeredEvents.skew

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:157


statechange

statechange(newState, oldState, emitter): void

Triggered when a state is changed.

Parameters

Name Type Description
newState DBaseStateSet a new state
oldState DBaseStateSet an old state
emitter EMITTER an emitter

Returns

void

Inherited from

DDialogLayeredEvents.statechange

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:166


up

up(e, emitter): void

Triggered when a pointer gets up on an emitter.

Parameters

Name Type Description
e InteractionEvent an interaction event
emitter EMITTER an emitter

Returns

void

Inherited from

DDialogLayeredEvents.up

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:224


wheel

wheel(e, deltas, global, emitter): void

Triggered when a wheel moves.

Parameters

Name Type Description
e WheelEvent a wheel event
deltas UtilWheelEventDeltas wheel move amounts
global Point a point wheel moved
emitter EMITTER an emitter

Returns

void

Inherited from

DDialogLayeredEvents.wheel

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:176