Winter Cardinal UI - v0.457.0 / DButtonGroup

Class: DButtonGroup<BUTTON, OPTIONS>

Type parameters

Name	Type
BUTTON	extends DButtonBase<any, any, any> = DButtonBase<any, any, any>
OPTIONS	extends DButtonGroupOptions<BUTTON> = DButtonGroupOptions<BUTTON>

Hierarchy

• EventEmitter

  ↳ DButtonGroup

Table of contents

Constructors

• constructor

Properties

• _active
• _buttons
• _isEnabled
• _onActiveBound

Accessors

• active

Methods

• add
• addListener
• clear
• contains
• destroy
• disable
• each
• emit
• enable
• eventNames
• listenerCount
• listeners
• off
• on
• once
• remove
• removeAllListeners
• removeListener
• size

Constructors

constructor

• new DButtonGroup<BUTTON, OPTIONS>(options?): DButtonGroup<BUTTON, OPTIONS>

Type parameters

Name	Type
BUTTON	extends DButtonBase<any, any, any> = DButtonBase<any, any, any>
OPTIONS	extends DButtonGroupOptions<BUTTON, any> = DButtonGroupOptions<BUTTON, any>

Parameters

Name	Type
options?	OPTIONS

Returns

DButtonGroup<BUTTON, OPTIONS>

Overrides

utils.EventEmitter.constructor

Defined in

src/main/typescript/wcardinal/ui/d-button-group.ts:45

Properties

_active

• Protected _active: null | BUTTON

Defined in

src/main/typescript/wcardinal/ui/d-button-group.ts:41

---

_buttons

• Protected _buttons: BUTTON[]

Defined in

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

---

_isEnabled

• Protected Optional _isEnabled: boolean

Defined in

src/main/typescript/wcardinal/ui/d-button-group.ts:43

---

_onActiveBound

• Protected _onActiveBound: (button: BUTTON) => void

Type declaration

▸ (button): void

Parameters

Name	Type
button	BUTTON

Returns

void

Defined in

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

Accessors

active

• get active(): null | BUTTON

Returns

null | BUTTON

Defined in

src/main/typescript/wcardinal/ui/d-button-group.ts:86

• set active(newActive): void

Parameters

Name	Type
newActive	null | BUTTON

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-button-group.ts:90

Methods

add

▸ add(button): void

Parameters

Name	Type
button	BUTTON

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-button-group.ts:69

---

addListener

▸ addListener(event, fn, context?): this

Alias method for on

Parameters

Name	Type
event	string | symbol
fn	Function
context?	any

Returns

this

Inherited from

utils.EventEmitter.addListener

Defined in

node_modules/pixi.js/pixi.js.d.ts:25495

---

clear

▸ clear(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-button-group.ts:124

---

contains

▸ contains(button): boolean

Parameters

Name	Type
button	BUTTON

Returns

boolean

Defined in

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

---

destroy

▸ destroy(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-button-group.ts:163

---

disable

▸ disable(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-button-group.ts:147

---

each

▸ each(iteratee): void

Parameters

Name	Type
iteratee	(button: BUTTON) => boolean | void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-button-group.ts:137

---

emit

▸ emit(event, ...args): boolean

Calls each of the listeners registered for a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.
...args	any[]	Arguments that are passed to registered listeners

Returns

boolean

true if the event had listeners, else false.

Inherited from

utils.EventEmitter.emit

Defined in

node_modules/pixi.js/pixi.js.d.ts:25441

---

enable

▸ enable(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-button-group.ts:155

---

eventNames

▸ eventNames(): (string | symbol)[]

Return an array listing the events for which the emitter has registered listeners.

Returns

(string | symbol)[]

Inherited from

utils.EventEmitter.eventNames

Defined in

node_modules/pixi.js/pixi.js.d.ts:25415

---

listenerCount

▸ listenerCount(event): number

Return the number of listeners listening to a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.

Returns

number

Inherited from

utils.EventEmitter.listenerCount

Defined in

node_modules/pixi.js/pixi.js.d.ts:25432

---

listeners

▸ listeners(event): Function[]

Return the listeners registered for a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.

Returns

Function[]

Inherited from

utils.EventEmitter.listeners

Defined in

node_modules/pixi.js/pixi.js.d.ts:25424

---

off

▸ off(event, fn?, context?, once?): this

Alias method for removeListener

Parameters

Name	Type
event	string | symbol
fn?	Function
context?	any
once?	boolean

Returns

this

Inherited from

utils.EventEmitter.off

Defined in

node_modules/pixi.js/pixi.js.d.ts:25489

---

on

▸ on(event, fn, context?): this

Add a listener for a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.
fn	Function	The listener function.
context?	any	The context to invoke the listener with.

Returns

this

this.

Inherited from

utils.EventEmitter.on

Defined in

node_modules/pixi.js/pixi.js.d.ts:25452

---

once

▸ once(event, fn, context?): this

Add a one-time listener for a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.
fn	Function	The listener function.
context?	any	The context to invoke the listener with.

Returns

this

this.

Inherited from

utils.EventEmitter.once

Defined in

node_modules/pixi.js/pixi.js.d.ts:25463

---

remove

▸ remove(button): void

Parameters

Name	Type
button	BUTTON

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-button-group.ts:105

---

removeAllListeners

▸ removeAllListeners(event?): this

Remove all listeners, or those of the specified event.

Parameters

Name	Type	Description
event?	string | symbol	The event name.

Returns

this

this.

Inherited from

utils.EventEmitter.removeAllListeners

Defined in

node_modules/pixi.js/pixi.js.d.ts:25483

---

removeListener

▸ removeListener(event, fn?, context?, once?): this

Remove the listeners of a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.
fn?	Function	Only remove the listeners that match this function.
context?	any	Only remove the listeners that have this context.
once?	boolean	Only remove one-time listeners.

Returns

this

this.

Inherited from

utils.EventEmitter.removeListener

Defined in

node_modules/pixi.js/pixi.js.d.ts:25475

---

size

▸ size(): number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-button-group.ts:133

Edit this page.