1681-engine / ui / List

Class: List

Defined in: src/ui/List.ts:16

A vertical list of rows in a scroll view: rows stacked with a gap, clipped, scrolled, followed by the focus.

Extends

• ScrollView

Constructors

Constructor

new List(listOptions): List;

Defined in: src/ui/List.ts:19

Parameters

Parameter	Type
listOptions	ListOptions

Returns

List

Overrides

ScrollView.constructor

Properties

boxH

protected boxH: number = 0;

Defined in: src/ui/Widget.ts:23

Inherited from

ScrollView.boxH

---

boxW

protected boxW: number = 0;

Defined in: src/ui/Widget.ts:22

Inherited from

ScrollView.boxW

---

content

readonly content: Container<ContainerChild>;

Defined in: src/ui/ScrollView.ts:23

Inherited from

ScrollView.content

---

focusable

focusable: boolean = false;

Defined in: src/ui/Widget.ts:21

Whether the focus manager may land on it (buttons, sliders, toggles).

Inherited from

ScrollView.focusable

---

suppressesTaps

suppressesTaps: boolean = false;

Defined in: src/ui/ScrollView.ts:25

True from the moment a press became a drag until the next press: buttons inside ignore that tap.

Inherited from

ScrollView.suppressesTaps

Accessors

boxHeight

Get Signature

get boxHeight(): number;

Defined in: src/ui/Widget.ts:31

Returns

number

Inherited from

ScrollView.boxHeight

---

boxWidth

Get Signature

get boxWidth(): number;

Defined in: src/ui/Widget.ts:27

Returns

number

Inherited from

ScrollView.boxWidth

---

contentHeight

Get Signature

get contentHeight(): number;

Defined in: src/ui/ScrollView.ts:67

Returns

number

Inherited from

ScrollView.contentHeight

---

enabled

Get Signature

get enabled(): boolean;

Defined in: src/ui/Widget.ts:35

Returns

boolean

Set Signature

set enabled(v): void;

Defined in: src/ui/Widget.ts:39

Parameters

Parameter	Type
v	boolean

Returns

void

Inherited from

ScrollView.enabled

---

focused

Get Signature

get focused(): boolean;

Defined in: src/ui/Widget.ts:47

Returns

boolean

Inherited from

ScrollView.focused

---

host

Get Signature

get protected host(): UiHost | null;

Defined in: src/ui/Widget.ts:90

The root it sits under, looked up when needed: a widget may be built before it is added.

Returns

UiHost | null

Inherited from

ScrollView.host

---

items

Get Signature

get items(): readonly Container<ContainerChild>[];

Defined in: src/ui/List.ts:23

Returns

readonly Container<ContainerChild>[]

---

scrollY

Get Signature

get scrollY(): number;

Defined in: src/ui/ScrollView.ts:63

Returns

number

Inherited from

ScrollView.scrollY

Methods

activate()

activate(): void;

Defined in: src/ui/Widget.ts:82

Accept pressed while focused (Enter, the pad's A).

Returns

void

Inherited from

ScrollView.activate

---

add()

add(...rows): this;

Defined in: src/ui/List.ts:27

Parameters

Parameter	Type
...rows	Container<ContainerChild>[]

Returns

this

---

canFocus()

canFocus(): boolean;

Defined in: src/ui/Widget.ts:75

Focusable now: enabled, shown, and every parent shown.

Returns

boolean

Inherited from

ScrollView.canFocus

---

childResized()

protected childResized(_child): void;

Defined in: src/ui/Widget.ts:108

A child widget's box changed size by itself (a Label given a longer text). A widget that places a child by its size (a Button centring its content) lays it out again here; the default does nothing, so a Stack still waits for its layout() and a change does not ripple up through every container.

Parameters

Parameter	Type
_child	Widget

Returns

void

Inherited from

ScrollView.childResized

---

clear()

clear(destroy?): this;

Defined in: src/ui/List.ts:43

Parameters

Parameter	Type	Default value
destroy	boolean	true

Returns

this

---

destroy()

destroy(): void;

Defined in: src/ui/ScrollView.ts:115

Removes all internal references and listeners as well as removes children from the display list. Do not use a Container after calling destroy.

Returns

void

Example

container.destroy();
container.destroy(true);
container.destroy({ children: true });
container.destroy({ children: true, texture: true, textureSource: true });

Inherited from

ScrollView.destroy

---

makeInteractive()

protected makeInteractive(): void;

Defined in: src/ui/Widget.ts:98

Hit-tested by Pixi, and every press on it is kept from the world. A widget whose drawing has gaps (a scroll view, an empty panel) also sets a hitArea over its box, so a press between its pieces is not the world's.

Returns

void

Inherited from

ScrollView.makeInteractive

---

measure()

measure(): this;

Defined in: src/ui/ScrollView.ts:80

Measures the content's drawn height; call after filling it.

Returns

this

Inherited from

ScrollView.measure

---

navigate()

navigate(_dir): boolean;

Defined in: src/ui/Widget.ts:85

A direction pressed while focused; true when the widget used it (a slider stepping) so focus stays.

Parameters

Parameter	Type
_dir	NavDirection

Returns

boolean

Inherited from

ScrollView.navigate

---

notifyResized()

protected notifyResized(): void;

Defined in: src/ui/Widget.ts:111

Tells the parent widget this one's box changed size by itself.

Returns

void

Inherited from

ScrollView.notifyResized

---

place()

place(x, y): this;

Defined in: src/ui/Widget.ts:68

Moves it, on whole pixels under a pixel-perfect root.

Parameters

Parameter	Type
x	number
y	number

Returns

this

Inherited from

ScrollView.place

---

redraw()

protected redraw(): void;

Defined in: src/ui/ScrollView.ts:160

Draws the current size and state.

Returns

void

Inherited from

ScrollView.redraw

---

relayout()

relayout(): this;

Defined in: src/ui/List.ts:52

Lays the rows out again (after a row changed size).

Returns

this

---

remove()

remove(row, destroy?): this;

Defined in: src/ui/List.ts:35

Parameters

Parameter	Type	Default value
row	Container	undefined
destroy	boolean	false

Returns

this

---

resize()

resize(width, height): this;

Defined in: src/ui/Widget.ts:59

Resizes the layout box (whole pixels under a pixel-perfect root) and redraws.

Parameters

Parameter	Type
width	number
height	number

Returns

this

Inherited from

ScrollView.resize

---

reveal()

reveal(child): void;

Defined in: src/ui/ScrollView.ts:100

Brings a child into view (the focus manager calls it when a widget inside is focused).

Parameters

Parameter	Type
child	Container

Returns

void

Inherited from

ScrollView.reveal

---

scrollTo()

scrollTo(y): boolean;

Defined in: src/ui/ScrollView.ts:91

Scrolls to y, kept in range; true when it moved.

Parameters

Parameter	Type
y	number

Returns

boolean

Inherited from

ScrollView.scrollTo

---

setContentHeight()

setContentHeight(h): this;

Defined in: src/ui/ScrollView.ts:72

Sets how tall the content is (default: measured from it by measure).

Parameters

Parameter	Type
h	number

Returns

this

Inherited from

ScrollView.setContentHeight

---

setFocused()

setFocused(v): void;

Defined in: src/ui/Widget.ts:52

Called by the focus manager.

Parameters

Parameter	Type
v	boolean

Returns

void

Inherited from

ScrollView.setFocused

---

tick()

tick(dtMs): boolean;

Defined in: src/ui/ScrollView.ts:107

Parameters

Parameter	Type
dtMs	number

Returns

boolean

Inherited from

ScrollView.tick