Class BoxWidget

Just a container where you can put child elements. They will not differ in any way from the ones outside. Can be used as a column in a row.

Hierarchy (View Summary)

Widget
- BoxWidget
  - RowWidget

Index

Constructors

Properties

listeners ref view

Methods

_init addClass append destroy getRef off on onClick removeClass setContent setText trigger

Constructors

constructor

new BoxWidget(): BoxWidget
Returns BoxWidget
Overrides Widget.constructor
- Defined in widgets/BoxWidget.ts:11

Properties

listeners

listeners: { [key: string]: EventCallback[] }

ref

ref: HTMLElement

view

view: View

Methods

_init

_init(): void
Do the necessary initialization.

Returns void
Inherited from Widget._init
- Defined in widgets/GUIElement.ts:19

addClass

addClass(...classes: string[]): this
Add one or more classes to an element.
Parameters
- ...classes: string[]
Returns this
Inherited from Widget.addClass
- Defined in widgets/GUIElement.ts:28

append

append(widget: Widget): this
Add a child widget to the container.
Parameters
- widget: Widget
Returns this
- Defined in widgets/BoxWidget.ts:31

destroy

destroy(): void
Destroy the element

Returns void
Inherited from Widget.destroy
- Defined in widgets/GUIElement.ts:53

getRef

getRef(): HTMLElement | null
Returns HTMLElement | null
Inherited from Widget.getRef
- Defined in widgets/GUIElement.ts:46

off

off(event: string, callback: EventCallback): void
Parameters
- event: string
- callback: EventCallback
Returns void
Inherited from Widget.off
- Defined in EventSupport.ts:18

on

on(event: string, callback: EventCallback): void
Parameters
- event: string
- callback: EventCallback
Returns void
Inherited from Widget.on
- Defined in EventSupport.ts:13

onClick

onClick(f: () => void): this
Add a click event listener to the widget.
Parameters
- f: () => void
  The function to call when the widget is clicked.
Returns this
Inherited from Widget.onClick
- Defined in widgets/Widget.ts:49

removeClass

removeClass(...classes: string[]): this
Remove one or more classes from an element.
Parameters
- ...classes: string[]
Returns this
Inherited from Widget.removeClass
- Defined in widgets/GUIElement.ts:38

setContent

setContent(html: string): this
Set the content of the container.
Parameters
- html: string
Returns this
Overrides Widget.setContent
- Defined in widgets/BoxWidget.ts:21

setText

setText(value: string): this
Set the text of the widget.
Parameters
- value: string
  The value to set the text to.
Returns this
Inherited from Widget.setText
- Defined in widgets/Widget.ts:39

trigger

trigger(event: string, ...args: any[]): void
Parameters
- event: string
- ...args: any[]
Returns void
Inherited from Widget.trigger
- Defined in EventSupport.ts:24