Class ToggleWidget

A class that represents a toggle that can be turned on and off.

@ extends Widget implements ValueWidget

Hierarchy (View Summary)

Widget
- ToggleWidget

Implements

ValueWidget

Index

Constructors

Properties

id inputRef labelRef listeners ref sliderRef view

Methods

_init addClass bind destroy getRef getValue isChecked off on onChange onClick removeClass setContent setLabel setText setValue trigger

Constructors

constructor

new ToggleWidget(
    label?: string,
    checked?: boolean,
    callback?: ((value: boolean) => void) | null,
): ToggleWidget
Create a new toggle.
Parameters
- Optionallabel: string = ''
  The label text.
- Optionalchecked: boolean = false
  Whether the toggle is initially checked.
- Optionalcallback: ((value: boolean) => void) | null = null
  The callback function to call when the toggle is changed.
Returns ToggleWidget
Overrides Widget.constructor
- Defined in widgets/ToggleWidget.ts:23

Properties

id

id: string

inputRef

inputRef: HTMLInputElement

labelRef

labelRef: HTMLSpanElement

listeners

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

ref

ref: HTMLLabelElement

sliderRef

sliderRef: HTMLSpanElement

view

view: View

Methods

_init

_init(): void
Do the necessary initialization.

Returns void
Implementation of ValueWidget._init
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
Implementation of ValueWidget.addClass
Inherited from Widget.addClass
- Defined in widgets/GUIElement.ts:28

bind

bind(obj: any, prop: string): this
Bind a property to the toggle.
Parameters
- obj: any
  The object to bind the property to.
- prop: string
  The property to bind.
Returns this
- Defined in widgets/ToggleWidget.ts:74

destroy

destroy(): void
Destroy the element

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

getRef

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

getValue

getValue(): boolean
Get whether the toggle is checked.

Returns boolean
Implementation of ValueWidget.getValue
- Defined in widgets/ToggleWidget.ts:91

isChecked

isChecked(): boolean
Get whether the toggle is checked.

Returns boolean
- Defined in widgets/ToggleWidget.ts:83

off

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

on

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

onChange

onChange(func: (value: boolean) => void): this
Set the callback function to call when the toggle is changed.
Parameters
- func: (value: boolean) => void
  The callback function to call when the toggle is changed.
Returns this
- Defined in widgets/ToggleWidget.ts:63

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
Implementation of ValueWidget.onClick
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
Implementation of ValueWidget.removeClass
Inherited from Widget.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
Implementation of ValueWidget.setContent
Inherited from Widget.setContent
- Defined in widgets/Widget.ts:29

setLabel

setLabel(label: string): this
Set the label of the toggle.
Parameters
- label: string
Returns this
- Defined in widgets/ToggleWidget.ts:110

setText

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

setValue

setValue(val: boolean): this
Set whether the toggle is checked.
Parameters
- val: boolean
Returns this
Implementation of ValueWidget.setValue
- Defined in widgets/ToggleWidget.ts:100

trigger

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