Winter Cardinal UI - v0.457.0 / DMenuSidedSelection

Class: DMenuSidedSelection<VALUE>

Type parameters

Name
VALUE

Hierarchy

• EventEmitter

  ↳ DMenuSidedSelection

Table of contents

Constructors

• constructor

Properties

• _content
• _filter
• _isDirty
• _item
• _type

Methods

• add
• addListener
• clear
• emit
• eventNames
• first
• get
• getFilterDefault
• getIndex
• hasMenu
• isEmpty
• listenerCount
• listeners
• off
• on
• once
• remove
• removeAllListeners
• removeListener
• set
• setState
• set_
• size
• toDirty
• update
• update_

Constructors

constructor

• new DMenuSidedSelection<VALUE>(content, options?): DMenuSidedSelection<VALUE>

Type parameters

Name
VALUE

Parameters

Name	Type
content	Container
options?	DMenuSidedSelectionOptions<any>

Returns

DMenuSidedSelection<VALUE>

Overrides

utils.EventEmitter.constructor

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided-selection.ts:70

Properties

_content

• Protected _content: Container

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided-selection.ts:64

---

_filter

• Protected _filter: (item: null | DMenuItemBase<VALUE, DThemeMenuItemBase, DMenuItemBaseOptions<VALUE, DThemeMenuItemBase>>) => boolean

Type declaration

▸ (item): boolean

Parameters

Name	Type
item	null | DMenuItemBase<VALUE, DThemeMenuItemBase, DMenuItemBaseOptions<VALUE, DThemeMenuItemBase>>

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided-selection.ts:68

---

_isDirty

• Protected _isDirty: boolean

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided-selection.ts:66

---

_item

• Protected _item: null | DMenuItemBase<VALUE, DThemeMenuItemBase, DMenuItemBaseOptions<VALUE, DThemeMenuItemBase>>

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided-selection.ts:65

---

_type

• Protected _type: DMenuSidedSelectionType

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided-selection.ts:67

Methods

add

▸ add(item): void

Parameters

Name	Type
item	DMenuItemBase<VALUE, DThemeMenuItemBase, DMenuItemBaseOptions<VALUE, DThemeMenuItemBase>>

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided-selection.ts:133

---

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-menu-sided-selection.ts:167

---

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

---

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

---

first

▸ first(): null | DMenuItemBase<VALUE, DThemeMenuItemBase, DMenuItemBaseOptions<VALUE, DThemeMenuItemBase>>

Returns

null | DMenuItemBase<VALUE, DThemeMenuItemBase, DMenuItemBaseOptions<VALUE, DThemeMenuItemBase>>

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided-selection.ts:94

---

get

▸ get(index): null | DMenuItemBase<VALUE, DThemeMenuItemBase, DMenuItemBaseOptions<VALUE, DThemeMenuItemBase>>

Parameters

Name	Type
index	number

Returns

null | DMenuItemBase<VALUE, DThemeMenuItemBase, DMenuItemBaseOptions<VALUE, DThemeMenuItemBase>>

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided-selection.ts:143

---

getFilterDefault

▸ getFilterDefault(): (item: null | DMenuItemBase<VALUE, DThemeMenuItemBase, DMenuItemBaseOptions<VALUE, DThemeMenuItemBase>>) => boolean

Returns

fn

▸ (item): boolean

Parameters

Name	Type
item	null | DMenuItemBase<VALUE, DThemeMenuItemBase, DMenuItemBaseOptions<VALUE, DThemeMenuItemBase>>

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided-selection.ts:172

---

getIndex

▸ getIndex(index): null | number

Parameters

Name	Type
index	number

Returns

null | number

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided-selection.ts:148

---

hasMenu

▸ hasMenu(child): child is Object

Parameters

Name	Type
child	any

Returns

child is Object

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided-selection.ts:109

---

isEmpty

▸ isEmpty(): boolean

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided-selection.ts:156

---

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(item): void

Parameters

Name	Type
item	DBase<DThemeBase, DBaseOptions<DThemeBase, any>>

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided-selection.ts:160

---

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

---

set

▸ set(item): void

Parameters

Name	Type
item	DMenuItemBase<VALUE, DThemeMenuItemBase, DMenuItemBaseOptions<VALUE, DThemeMenuItemBase>>

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided-selection.ts:138

---

setState

▸ setState(item, mode, isOn): void

Parameters

Name	Type
item	null | DBase<DThemeBase, DBaseOptions<DThemeBase, any>>
mode	DMenuSidedSelectionType
isOn	boolean

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided-selection.ts:189

---

set_

▸ set_(item, emit): void

Parameters

Name	Type
item	null | DMenuItemBase<VALUE, DThemeMenuItemBase, DMenuItemBaseOptions<VALUE, DThemeMenuItemBase>>
emit	boolean

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided-selection.ts:176

---

size

▸ size(): number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided-selection.ts:152

---

toDirty

▸ toDirty(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided-selection.ts:98

---

update

▸ update(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided-selection.ts:102

---

update_

▸ update_(root): void

Parameters

Name	Type
root	Container

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-menu-sided-selection.ts:113

Edit this page.