Winter Cardinal UI - v0.442.0 / DItemUpdater

Class: DItemUpdater<VALUE, DATA, DATA_MAPPED, ITEM, OPTIONS>

The primary purpose of this class is to minimize the number of rendered items (e.g., DListItem) as low as possible and to update their positions and states. For this sake, the updater calculates the required number of items whenever their container size changes and creates items if needed.

Type parameters

Name Type
VALUE unknown
DATA extends DItemUpdaterData<VALUE> = DItemUpdaterData<VALUE>
DATA_MAPPED extends DItemUpdaterDataMapped<VALUE> = DItemUpdaterDataMapped<VALUE>
ITEM extends DItemUpdaterItem<VALUE> = DItemUpdaterItem<VALUE>
OPTIONS extends DItemUpdaterOptions<VALUE, DATA, ITEM> = DItemUpdaterOptions<VALUE, DATA, ITEM>

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new DItemUpdater<VALUE, DATA, DATA_MAPPED, ITEM, OPTIONS>(data, content, container, options?): DItemUpdater<VALUE, DATA, DATA_MAPPED, ITEM, OPTIONS>

Type parameters

Name Type
VALUE unknown
DATA extends DItemUpdaterData<VALUE> = DItemUpdaterData<VALUE>
DATA_MAPPED extends DItemUpdaterDataMapped<VALUE> = DItemUpdaterDataMapped<VALUE>
ITEM extends DItemUpdaterItem<VALUE> = DItemUpdaterItem<VALUE>
OPTIONS extends DItemUpdaterOptions<VALUE, DATA, ITEM> = DItemUpdaterOptions<VALUE, DATA, ITEM>

Parameters

Name Type
data DATA
content DBase<DThemeBase, DBaseOptions<DThemeBase, any>>
container DBase<DThemeBase, DBaseOptions<DThemeBase, any>>
options? OPTIONS

Returns

DItemUpdater<VALUE, DATA, DATA_MAPPED, ITEM, OPTIONS>

Defined in

src/main/typescript/wcardinal/ui/d-item-updater.ts:82

Properties

_container

Protected _container: DBase<DThemeBase, DBaseOptions<DThemeBase, any>>

Defined in

src/main/typescript/wcardinal/ui/d-item-updater.ts:78


_content

Protected _content: DBase<DThemeBase, DBaseOptions<DThemeBase, any>>

Defined in

src/main/typescript/wcardinal/ui/d-item-updater.ts:77


_data

Protected _data: DATA

Defined in

src/main/typescript/wcardinal/ui/d-item-updater.ts:76


_initItem

Protected _initItem: DItemUpdaterInitItem<DATA, ITEM>

Defined in

src/main/typescript/wcardinal/ui/d-item-updater.ts:80


_isUpdateItemsCalled

Protected _isUpdateItemsCalled: boolean

Defined in

src/main/typescript/wcardinal/ui/d-item-updater.ts:68


_isUpdateItemsCalledForcibly

Protected _isUpdateItemsCalledForcibly: boolean

Defined in

src/main/typescript/wcardinal/ui/d-item-updater.ts:69


_itemHeight

Protected _itemHeight: number

Defined in

src/main/typescript/wcardinal/ui/d-item-updater.ts:70


_itemIndexEnd

Protected _itemIndexEnd: number

Defined in

src/main/typescript/wcardinal/ui/d-item-updater.ts:74


_itemIndexStart

Protected _itemIndexStart: number

Defined in

src/main/typescript/wcardinal/ui/d-item-updater.ts:73


_itemWidth

Protected _itemWidth: number

Defined in

src/main/typescript/wcardinal/ui/d-item-updater.ts:71


_multiplicity

Protected _multiplicity: number

Defined in

src/main/typescript/wcardinal/ui/d-item-updater.ts:72


_newItem

Protected _newItem: DItemUpdaterNewItem<DATA, ITEM>

Defined in

src/main/typescript/wcardinal/ui/d-item-updater.ts:79


_updateItemsCount

Protected _updateItemsCount: number

Defined in

src/main/typescript/wcardinal/ui/d-item-updater.ts:67


_workItems

Protected _workItems: ITEM[]

Defined in

src/main/typescript/wcardinal/ui/d-item-updater.ts:75

Accessors

multiplicity

get multiplicity(): number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-item-updater.ts:132

Methods

initItem

initItem(this, item, index, data): ITEM

Parameters

Name Type
this undefined
item ITEM
index number
data DATA

Returns

ITEM

Defined in

src/main/typescript/wcardinal/ui/d-item-updater.ts:123


initItemNoStriping

initItemNoStriping(this, item, index, data): ITEM

Parameters

Name Type
this undefined
item ITEM
index number
data DATA

Returns

ITEM

Defined in

src/main/typescript/wcardinal/ui/d-item-updater.ts:128


lock

lock(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-item-updater.ts:136


moveFocus

moveFocus(e, target, moveVertically, moveHorizontally): boolean

Parameters

Name Type
e KeyboardEvent
target DBase<DThemeBase, DBaseOptions<DThemeBase, any>>
moveVertically boolean
moveHorizontally boolean

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/d-item-updater.ts:367


newItem

newItem(this, data): ITEM

Parameters

Name Type
this undefined
data DATA

Returns

ITEM

Defined in

src/main/typescript/wcardinal/ui/d-item-updater.ts:105


reset

reset(item): ITEM

Parameters

Name Type
item ITEM

Returns

ITEM

Defined in

src/main/typescript/wcardinal/ui/d-item-updater.ts:350


set

set(item, value, index, forcibly?): void

Parameters

Name Type
item ITEM
value VALUE
index number
forcibly? boolean

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-item-updater.ts:342


toInitItem

toInitItem(options?): DItemUpdaterInitItem<DATA, ITEM>

Parameters

Name Type
options? DItemUpdaterOptions<VALUE, DATA, ITEM>

Returns

DItemUpdaterInitItem<DATA, ITEM>

Defined in

src/main/typescript/wcardinal/ui/d-item-updater.ts:107


toMapped

toMapped(data): DATA_MAPPED

Parameters

Name Type
data DATA

Returns

DATA_MAPPED

Defined in

src/main/typescript/wcardinal/ui/d-item-updater.ts:340


toNewItem

toNewItem(options?): DItemUpdaterNewItem<DATA, ITEM>

Parameters

Name Type
options? DItemUpdaterOptions<VALUE, DATA, ITEM>

Returns

DItemUpdaterNewItem<DATA, ITEM>

Defined in

src/main/typescript/wcardinal/ui/d-item-updater.ts:99


unlock

unlock(callIfNeeded): void

Parameters

Name Type
callIfNeeded boolean

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-item-updater.ts:144


unset

unset(item): void

Parameters

Name Type
item ITEM

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-item-updater.ts:346


update

update(forcibly?): void

Parameters

Name Type
forcibly? boolean

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-item-updater.ts:155