Class NumberInputWidget

A class that represents an input field where only numbers can be entered.

@ extends Widget implements ValueWidget

Hierarchy (View Summary)

Widget
- NumberInputWidget

Implements

ValueWidget

Index

Constructors

Properties

inputRef labelRef listeners ref view

Methods

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

Constructors

constructor

new NumberInputWidget(
    label?: string,
    value?: number,
    callback?: ((value: number) => void) | null,
): NumberInputWidget
Create a new number input field and initialize it.
Parameters
- Optionallabel: string = ''
  The label text.
- Optionalvalue: number = 0
  The initial value.
- Optionalcallback: ((value: number) => void) | null = null
  The function to call when the input is changed.
Returns NumberInputWidget
Overrides Widget.constructor
- Defined in widgets/NumberInputWidget.ts:22

Properties

inputRef

inputRef: HTMLInputElement

labelRef

labelRef: HTMLDivElement

listeners

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

ref

ref: HTMLDivElement

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 an input field to an object property.
Parameters
- obj: any
  The object to bind the property to.
- prop: string
  The property to bind.
Returns this
- Defined in widgets/NumberInputWidget.ts:75

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(): number
Get the value of the input field.

Returns number
- The value of the input field.
Implementation of ValueWidget.getValue
- Defined in widgets/NumberInputWidget.ts:94

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(f: (value: number) => void): this
Add a change event listener to the input field.
Parameters
- f: (value: number) => void
  The function to call when the input is changed.
Returns this
- Defined in widgets/NumberInputWidget.ts:64

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

parse

parse(value: string): number
Parameters
- value: string
Returns number
- Defined in widgets/NumberInputWidget.ts:98

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 input field.
Parameters
- label: string
  The new label text.
Returns this
- Defined in widgets/NumberInputWidget.ts:54

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(value: string): this
Set the value of the input field.
Parameters
- value: string
Returns this
Implementation of ValueWidget.setValue
- Defined in widgets/NumberInputWidget.ts:85

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