1681-engine / ui / Stack

Class: Stack

Defined in: src/ui/Stack.ts:9

Lays its children one after another, down or across, with a gap and padding, and takes the size they need. Call layout() after changing a child's size; adding or removing through the stack lays out for you.

Extends

• Widget

Constructors

Constructor

new Stack(options?): Stack;

Defined in: src/ui/Stack.ts:10

Parameters

Parameter	Type
options	StackOptions

Returns

Stack

Overrides

Widget.constructor

Properties

boxH

protected boxH: number = 0;

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

Inherited from

Widget.boxH

---

boxW

protected boxW: number = 0;

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

Inherited from

Widget.boxW

---

focusable

focusable: boolean = false;

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

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

Inherited from

Widget.focusable

Accessors

boxHeight

Get Signature

get boxHeight(): number;

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

Returns

number

Inherited from

Widget.boxHeight

---

boxWidth

Get Signature

get boxWidth(): number;

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

Returns

number

Inherited from

Widget.boxWidth

---

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

Widget.enabled

---

focused

Get Signature

get focused(): boolean;

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

Returns

boolean

Inherited from

Widget.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

Widget.host

Methods

activate()

activate(): void;

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

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

Returns

void

Inherited from

Widget.activate

---

add()

add(...children): this;

Defined in: src/ui/Stack.ts:14

Parameters

Parameter	Type
...children	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

Widget.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

Widget.childResized

---

layout()

layout(): this;

Defined in: src/ui/Stack.ts:29

Returns

this

---

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

Widget.makeInteractive

---

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

Widget.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

Widget.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

Widget.place

---

redraw()

protected redraw(): void;

Defined in: src/ui/Stack.ts:44

Draws the current size and state.

Returns

void

Overrides

Widget.redraw

---

remove()

remove(child, destroy?): this;

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

Parameters

Parameter	Type	Default value
child	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

Widget.resize

---

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

Widget.setFocused