Class Widget

A class that represents a user interface widget.

Hierarchy (View Summary)

GUIElement
- Widget

Index

Constructors

Properties

listeners ref view

Methods

_init addClass destroy getRef off on onClick removeClass setContent setText trigger

Constructors

constructor

new Widget(elementType?: string): Widget
Create a new widget and initialize it.
Parameters
- OptionalelementType: string = 'div'
  The HTML element type.
Returns Widget
Overrides GUIElement.constructor
- Defined in widgets/Widget.ts:16

Properties

listeners

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

ref

ref: HTMLElement

view

view: View

Methods

_init

_init(): void
Do the necessary initialization.

Returns void
Inherited from GUIElement._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 GUIElement.addClass
- Defined in widgets/GUIElement.ts:28

destroy

destroy(): void
Destroy the element

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

getRef

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

off

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

on

on(event: string, callback: EventCallback): void
Parameters
- event: string
- callback: EventCallback
Returns void
Inherited from GUIElement.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
- 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 GUIElement.removeClass
- Defined in widgets/GUIElement.ts:38

setContent

setContent(value: string): this
Set the content of the widget.
Parameters
- value: string
  The value to set the content to.
Returns this
- Defined in widgets/Widget.ts:29

setText

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

trigger

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