Winter Cardinal UI - v0.442.0 / DListItemUpdater

Class: DListItemUpdater<VALUE>

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

Hierarchy

• DItemUpdater<VALUE, DListData<VALUE>, DListDataMapped<VALUE>, DListItem<VALUE>, DListItemUpdaterOptions<VALUE>>

  ↳ DListItemUpdater

  ↳↳ DDialogSelectListItemUpdater

Table of contents

Constructors

• constructor

Properties

• _container
• _content
• _data
• _initItem
• _isUpdateItemsCalled
• _isUpdateItemsCalledForcibly
• _itemHeight
• _itemIndexEnd
• _itemIndexStart
• _itemWidth
• _multiplicity
• _newItem
• _updateItemsCount
• _workItems

Accessors

• multiplicity

Methods

• initItem
• initItemNoStriping
• lock
• moveFocus
• newItem
• reset
• set
• toInitItem
• toMapped
• toNewItem
• unlock
• unset
• update

Constructors

constructor

• new DListItemUpdater<VALUE>(data, content, container, options?): DListItemUpdater<VALUE>

Type parameters

Name	Type
VALUE	unknown

Parameters

Name	Type
data	DListData<VALUE>
content	DBase<DThemeBase, DBaseOptions<DThemeBase, any>>
container	DBase<DThemeBase, DBaseOptions<DThemeBase, any>>
options?	DListItemUpdaterOptions<VALUE>

Returns

DListItemUpdater<VALUE>

Inherited from

DItemUpdater.constructor

Defined in

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

Properties

_container

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

Inherited from

DItemUpdater._container

Defined in

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

---

_content

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

Inherited from

DItemUpdater._content

Defined in

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

---

_data

• Protected _data: DListData<VALUE>

Inherited from

DItemUpdater._data

Defined in

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

---

_initItem

• Protected _initItem: DItemUpdaterInitItem<DListData<VALUE>, DListItem<VALUE, DThemeListItem, DListItemOptions<VALUE, DThemeListItem, any>>>

Inherited from

DItemUpdater._initItem

Defined in

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

---

_isUpdateItemsCalled

• Protected _isUpdateItemsCalled: boolean

Inherited from

DItemUpdater._isUpdateItemsCalled

Defined in

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

---

_isUpdateItemsCalledForcibly

• Protected _isUpdateItemsCalledForcibly: boolean

Inherited from

DItemUpdater._isUpdateItemsCalledForcibly

Defined in

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

---

_itemHeight

• Protected _itemHeight: number

Inherited from

DItemUpdater._itemHeight

Defined in

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

---

_itemIndexEnd

• Protected _itemIndexEnd: number

Inherited from

DItemUpdater._itemIndexEnd

Defined in

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

---

_itemIndexStart

• Protected _itemIndexStart: number

Inherited from

DItemUpdater._itemIndexStart

Defined in

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

---

_itemWidth

• Protected _itemWidth: number

Inherited from

DItemUpdater._itemWidth

Defined in

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

---

_multiplicity

• Protected _multiplicity: number

Inherited from

DItemUpdater._multiplicity

Defined in

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

---

_newItem

• Protected _newItem: DItemUpdaterNewItem<DListData<VALUE>, DListItem<VALUE, DThemeListItem, DListItemOptions<VALUE, DThemeListItem, any>>>

Inherited from

DItemUpdater._newItem

Defined in

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

---

_updateItemsCount

• Protected _updateItemsCount: number

Inherited from

DItemUpdater._updateItemsCount

Defined in

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

---

_workItems

• Protected _workItems: DListItem<VALUE, DThemeListItem, DListItemOptions<VALUE, DThemeListItem, any>>[]

Inherited from

DItemUpdater._workItems

Defined in

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

Accessors

multiplicity

• get multiplicity(): number

Returns

number

Inherited from

DItemUpdater.multiplicity

Defined in

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

Methods

initItem

▸ initItem(this, item, index, data): DListItem<VALUE, DThemeListItem, DListItemOptions<VALUE, DThemeListItem, any>>

Parameters

Name	Type
this	undefined
item	DListItem<VALUE, DThemeListItem, DListItemOptions<VALUE, DThemeListItem, any>>
index	number
data	DListData<VALUE>

Returns

DListItem<VALUE, DThemeListItem, DListItemOptions<VALUE, DThemeListItem, any>>

Inherited from

DItemUpdater.initItem

Defined in

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

---

initItemNoStriping

▸ initItemNoStriping(this, item, index, data): DListItem<VALUE, DThemeListItem, DListItemOptions<VALUE, DThemeListItem, any>>

Parameters

Name	Type
this	undefined
item	DListItem<VALUE, DThemeListItem, DListItemOptions<VALUE, DThemeListItem, any>>
index	number
data	DListData<VALUE>

Returns

DListItem<VALUE, DThemeListItem, DListItemOptions<VALUE, DThemeListItem, any>>

Inherited from

DItemUpdater.initItemNoStriping

Defined in

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

---

lock

▸ lock(): void

Returns

void

Inherited from

DItemUpdater.lock

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

Inherited from

DItemUpdater.moveFocus

Defined in

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

---

newItem

▸ newItem(this, data): DListItem<VALUE, DThemeListItem, DListItemOptions<VALUE, DThemeListItem, any>>

Parameters

Name	Type
this	undefined
data	DListData<VALUE>

Returns

DListItem<VALUE, DThemeListItem, DListItemOptions<VALUE, DThemeListItem, any>>

Overrides

DItemUpdater.newItem

Defined in

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

---

reset

▸ reset(item): DListItem<VALUE, DThemeListItem, DListItemOptions<VALUE, DThemeListItem, any>>

Parameters

Name	Type
item	DListItem<VALUE, DThemeListItem, DListItemOptions<VALUE, DThemeListItem, any>>

Returns

DListItem<VALUE, DThemeListItem, DListItemOptions<VALUE, DThemeListItem, any>>

Inherited from

DItemUpdater.reset

Defined in

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

---

set

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

Parameters

Name	Type
item	DListItem<VALUE, DThemeListItem, DListItemOptions<VALUE, DThemeListItem, any>>
value	VALUE
index	number
forcibly?	boolean

Returns

void

Inherited from

DItemUpdater.set

Defined in

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

---

toInitItem

▸ toInitItem(options?): DItemUpdaterInitItem<DListData<VALUE>, DListItem<VALUE, DThemeListItem, DListItemOptions<VALUE, DThemeListItem, any>>>

Parameters

Name	Type
options?	DItemUpdaterOptions<VALUE, DListData<VALUE>, DListItem<VALUE, DThemeListItem, DListItemOptions<VALUE, DThemeListItem, any>>>

Returns

DItemUpdaterInitItem<DListData<VALUE>, DListItem<VALUE, DThemeListItem, DListItemOptions<VALUE, DThemeListItem, any>>>

Inherited from

DItemUpdater.toInitItem

Defined in

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

---

toMapped

▸ toMapped(data): DListDataMapped<VALUE>

Parameters

Name	Type
data	DListData<VALUE>

Returns

DListDataMapped<VALUE>

Overrides

DItemUpdater.toMapped

Defined in

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

---

toNewItem

▸ toNewItem(options?): DItemUpdaterNewItem<DListData<VALUE>, DListItem<VALUE, DThemeListItem, DListItemOptions<VALUE, DThemeListItem, any>>>

Parameters

Name	Type
options?	DItemUpdaterOptions<VALUE, DListData<VALUE>, DListItem<VALUE, DThemeListItem, DListItemOptions<VALUE, DThemeListItem, any>>>

Returns

DItemUpdaterNewItem<DListData<VALUE>, DListItem<VALUE, DThemeListItem, DListItemOptions<VALUE, DThemeListItem, any>>>

Inherited from

DItemUpdater.toNewItem

Defined in

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

---

unlock

▸ unlock(callIfNeeded): void

Parameters

Name	Type
callIfNeeded	boolean

Returns

void

Inherited from

DItemUpdater.unlock

Defined in

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

---

unset

▸ unset(item): void

Parameters

Name	Type
item	DListItem<VALUE, DThemeListItem, DListItemOptions<VALUE, DThemeListItem, any>>

Returns

void

Inherited from

DItemUpdater.unset

Defined in

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

---

update

▸ update(forcibly?): void

Parameters

Name	Type
forcibly?	boolean

Returns

void

Inherited from

DItemUpdater.update

Defined in

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

Edit this page.