Winter Cardinal UI - v0.442.0 / DSelectEvents

Interface: DSelectEvents<VALUE, EMITTER>

DSelect events.

Type parameters

Name
VALUE
EMITTER

Hierarchy

Table of contents

Methods

Methods

active

▸ active(emitter): void

Triggered when the button is activated.

Parameters

Name Type Description
emitter EMITTER an emitter

Returns

void

Inherited from

DDropdownBaseEvents.active

Defined in

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

added

▸ added(container): void

Triggered when added to a container.

Parameters

Name Type Description
container Container a container added to

Returns

void

Inherited from

DDropdownBaseEvents.added

Defined in

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

change

▸ change(newValue, oldValue, item, emitter): void

Triggered when a selection is changed.

Parameters

Name Type Description
newValue null | VALUE a newly-selected value
oldValue null | VALUE a previously-selected value
item null | DMenuItem<VALUE, DThemeMenuItem, DMenuItemOptions<VALUE, DThemeMenuItem>> a newly-selected item
emitter EMITTER an emitter

Returns

void

Defined in

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

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

DDropdownBaseEvents.click

Defined in

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

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

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

DDropdownBaseEvents.down

Defined in

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

inactive

▸ inactive(emitter): void

Triggered when the button is inactivated.

Parameters

Name Type Description
emitter EMITTER an emitter

Returns

void

Inherited from

DDropdownBaseEvents.inactive

Defined in

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

init

▸ init(emitter): void

Triggered when an initialization is finished.

Parameters

Name Type Description
emitter EMITTER an emitter

Returns

void

Inherited from

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

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

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

DDropdownBaseEvents.move

Defined in

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

open

▸ open(menu, emitter): void

Triggered when a menu is opened.

Parameters

Name Type
menu DMenu<VALUE, DThemeMenu, DMenuOptions<VALUE, DThemeMenu>>
emitter EMITTER

Returns

void

Inherited from

DDropdownBaseEvents.open

Defined in

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

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

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

DDropdownBaseEvents.over

Defined in

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

press

▸ press(emitter): void

Triggered when the button is pressed.

Parameters

Name Type Description
emitter EMITTER an emitter

Returns

void

Inherited from

DDropdownBaseEvents.press

Defined in

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

removed

▸ removed(container): void

Triggered when removed from a container.

Parameters

Name Type Description
container Container a container removed from

Returns

void

Inherited from

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

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

DDropdownBaseEvents.scale

Defined in

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

select

▸ select(value, item, emitter): void

Triggered when a menu item is selected.

Parameters

Name Type Description
value VALUE a value of a selected menu item
item DMenuItem<VALUE, DThemeMenuItem, DMenuItemOptions<VALUE, DThemeMenuItem>> a selected menu item
emitter EMITTER an emitter

Returns

void

Inherited from

DDropdownBaseEvents.select

Defined in

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

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

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

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

DDropdownBaseEvents.statechange

Defined in

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

unpress

▸ unpress(emitter): void

Triggered when the button is released.

Parameters

Name Type Description
emitter EMITTER an emitter

Returns

void

Inherited from

DDropdownBaseEvents.unpress

Defined in

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

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

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

DDropdownBaseEvents.wheel

Defined in

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

Edit this page.