Winter Cardinal UI - v0.457.0 / DListDataSelectionSingle

Class: DListDataSelectionSingle<ITEM>

Type parameters

Name
ITEM

Hierarchy

• EventEmitter

  ↳ DListDataSelectionSingle

Implements

• DListDataSelection<ITEM>

Table of contents

Constructors

• constructor

Properties

• _accessor
• _item
• _parent

Accessors

• first
• last
• type

Methods

• add
• addListener
• clear
• clearAndAdd
• clearAndAddAll
• contains
• each
• emit
• eventNames
• find
• findById
• get
• isEmpty
• listenerCount
• listeners
• off
• on
• onChange
• onItemChange
• once
• remove
• removeAllListeners
• removeListener
• size
• toArray
• toggle

Constructors

constructor

• new DListDataSelectionSingle<ITEM>(parent, accessor, options?): DListDataSelectionSingle<ITEM>

Type parameters

Name
ITEM

Parameters

Name	Type
parent	DListDataSelectionParent<ITEM>
accessor	DListItemAccessor<ITEM>
options?	DListDataSelectionOptions<ITEM, any>

Returns

DListDataSelectionSingle<ITEM>

Overrides

utils.EventEmitter.constructor

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection-single.ts:23

Properties

_accessor

• Protected _accessor: DListItemAccessor<ITEM>

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection-single.ts:20

---

_item

• Protected _item: null | ITEM

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection-single.ts:21

---

_parent

• Protected _parent: DListDataSelectionParent<ITEM>

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection-single.ts:19

Accessors

first

• get first(): null | ITEM

Returns

null | ITEM

Implementation of

DListDataSelection.first

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection-single.ts:50

---

last

• get last(): null | ITEM

Returns

null | ITEM

Implementation of

DListDataSelection.last

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection-single.ts:54

---

type

• get type(): DListDataSelectionType

Returns

DListDataSelectionType

Implementation of

DListDataSelection.type

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection-single.ts:46

Methods

add

▸ add(target): boolean

Adds the given item

Parameters

Name	Type	Description
target	ITEM	an item

Returns

boolean

true if succeeded.

Implementation of

DListDataSelection.add

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection-single.ts:65

---

addListener

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

Alias method for on

Parameters

Name	Type
event	string | symbol
fn	Function
context?	any

Returns

this

Implementation of

DListDataSelection.addListener

Inherited from

utils.EventEmitter.addListener

Defined in

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

---

clear

▸ clear(): void

Clears all the items.

Returns

void

Implementation of

DListDataSelection.clear

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection-single.ts:93

---

clearAndAdd

▸ clearAndAdd(target): boolean

Clears all the existing items and adds the given item.

Parameters

Name	Type	Description
target	ITEM	an item to be added

Returns

boolean

true if the selection is changed

Implementation of

DListDataSelection.clearAndAdd

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection-single.ts:100

---

clearAndAddAll

▸ clearAndAddAll(targets): boolean

Clears the existing items and add all the given items.

Parameters

Name	Type	Description
targets	ITEM[]	items to be added

Returns

boolean

true if the selection is changed

Implementation of

DListDataSelection.clearAndAddAll

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection-single.ts:109

---

contains

▸ contains(target): boolean

Returns true if the given item is selected.

Parameters

Name	Type	Description
target	ITEM	an item to be checked

Returns

boolean

true if the given item is selected

Implementation of

DListDataSelection.contains

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection-single.ts:128

---

each

▸ each(iteratee): void

Iterates over selected items.

Parameters

Name	Type	Description
iteratee	(item: ITEM) => boolean | void	an iteratee

Returns

void

Implementation of

DListDataSelection.each

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection-single.ts:140

---

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.

Implementation of

DListDataSelection.emit

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)[]

Implementation of

DListDataSelection.eventNames

Inherited from

utils.EventEmitter.eventNames

Defined in

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

---

find

▸ find(target, items): null | ITEM

Parameters

Name	Type
target	ITEM
items	ITEM[]

Returns

null | ITEM

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection-single.ts:171

---

findById

▸ findById(id, toId, items): null | ITEM

Parameters

Name	Type
id	unknown
toId	DListItemToId<ITEM>
items	ITEM[]

Returns

null | ITEM

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection-single.ts:160

---

get

▸ get(index): null | ITEM

Returns an item at the given index or null.

Parameters

Name	Type	Description
index	number	an index

Returns

null | ITEM

an item at the given index or null

Implementation of

DListDataSelection.get

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection-single.ts:58

---

isEmpty

▸ isEmpty(): boolean

Returns true if the selection is empty.

Returns

boolean

true if the selection is empty

Implementation of

DListDataSelection.isEmpty

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection-single.ts:136

---

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

Implementation of

DListDataSelection.listenerCount

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[]

Implementation of

DListDataSelection.listeners

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

Implementation of

DListDataSelection.off

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.

Implementation of

DListDataSelection.on

Inherited from

utils.EventEmitter.on

Defined in

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

---

onChange

▸ onChange(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection-single.ts:155

---

onItemChange

▸ onItemChange(before, items, after): void

Parameters

Name	Type
before	ITEM[]
items	ITEM[]
after	ITEM[]

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection-single.ts:181

---

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.

Implementation of

DListDataSelection.once

Inherited from

utils.EventEmitter.once

Defined in

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

---

remove

▸ remove(target): boolean

Removes the given item.

Parameters

Name	Type	Description
target	ITEM	an item

Returns

boolean

true if succeeded

Implementation of

DListDataSelection.remove

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection-single.ts:74

---

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.

Implementation of

DListDataSelection.removeAllListeners

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.

Implementation of

DListDataSelection.removeListener

Inherited from

utils.EventEmitter.removeListener

Defined in

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

---

size

▸ size(): number

Returns the number of selected items.

Returns

number

the number of selected items

Implementation of

DListDataSelection.size

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection-single.ts:132

---

toArray

▸ toArray(): ITEM[]

Returns an array of selected items.

Returns

ITEM[]

Implementation of

DListDataSelection.toArray

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection-single.ts:147

---

toggle

▸ toggle(target): boolean

Toggles the given item.

Parameters

Name	Type	Description
target	ITEM	an item

Returns

boolean

true if succeeded.

Implementation of

DListDataSelection.toggle

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection-single.ts:83

Edit this page.