Winter Cardinal UI - v0.442.0 / DButtonSelectOnOptions

Interface: DButtonSelectOnOptions<VALUE, EMITTER>

DButtonSelect “on” options.

Type parameters

Name
VALUE
EMITTER

Hierarchy

• Partial<DButtonSelectEvents<VALUE, EMITTER>>

• DOnOptions

  ↳ DButtonSelectOnOptions

Table of contents

Methods

• active
• added
• change
• click
• dblclick
• down
• inactive
• init
• keydown
• keyup
• move
• out
• over
• press
• removed
• resize
• scale
• shortcut
• skew
• statechange
• unpress
• up
• wheel

Methods

active

▸ active(emitter): void

Triggered when the button is activated.

Parameters

Name	Type	Description
emitter	EMITTER	an emitter

Returns

void

Inherited from

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

Partial.added

Defined in

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

---

change

▸ change(newValue, oldValue, 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
emitter	EMITTER	an emitter

Returns

void

Inherited from

Partial.change

Defined in

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

---

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

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

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

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

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

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

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

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

Partial.move

Defined in

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

---

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

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

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

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

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

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

Partial.scale

Defined in

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

---

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

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

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

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

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

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

Partial.wheel

Defined in

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

Edit this page.