Class TextControl

A user interface control for displaying and editing the value of a ParameterString.

Hierarchy (view full)

TextControlBase
- TextControl

Index

Constructors

Methods

disconnect getClassName getColumns getElement getParameter getValue observe setColumns setEnabled setValue toString toStringShort

Constructors

constructor

new TextControl(parameter, textField?): TextControl
Parameters
- parameter: ParameterString
  the ParameterString to display and edit
- Optional textField: HTMLInputElement
  the text field to use; if not provided, then a text field is created.
Returns TextControl
Overrides TextControlBase.constructor
- Defined in lab/controls/TextControl.ts:260

Methods

disconnect

disconnect(): void
Remove connections to other objects to facilitate garbage collection. For example, stops listening for user interface events.

Returns void
Overrides TextControlBase.disconnect
- Defined in lab/controls/TextControl.ts:275

getClassName

getClassName(): string
Returns name of class of this object.

Returns string
name of class of this object.
Overrides TextControlBase.getClassName
- Defined in lab/controls/TextControl.ts:281

getColumns

getColumns(): number
Returns width of the text input field (number of characters).

Returns number
the width of the text input field.
Inherited from TextControlBase.getColumns
- Defined in lab/controls/TextControl.ts:152

getElement

getElement(): HTMLElement
Returns the top level Element of this control. For example, this might be a label Element that encloses an input Element.

Returns HTMLElement
the top level Element of this control
Inherited from TextControlBase.getElement
- Defined in lab/controls/TextControl.ts:157

getParameter

getParameter(): null | Parameter
Returns the Parameter that this LabControl is connected to, if any.

Returns null | Parameter
the Parameter that this LabControl is connected to, or null
Overrides TextControlBase.getParameter
- Defined in lab/controls/TextControl.ts:286

getValue

getValue(): string
Returns the value of this control (which should match the target value if observe is being called).

Returns string
the value of this control
Inherited from TextControlBase.getValue
- Defined in lab/controls/TextControl.ts:170

observe

observe(_event): void
Notifies this Observer that a change has occurred in the Subject.
Parameters
- _event: SubjectEvent
  contains information about what has changed in the Subject: typically either a one-time GenericEvent, or a change to the value of a Parameter
Returns void
Inherited from TextControlBase.observe
- Defined in lab/controls/TextControl.ts:175

setColumns

setColumns(value): TextControlBase
Sets the width of the text input field (number of characters).
Parameters
- value: number
  the width of the text input field
Returns TextControlBase
this object for chaining setters
Inherited from TextControlBase.setColumns
- Defined in lab/controls/TextControl.ts:184

setEnabled

setEnabled(enabled): void
Enables or disables the control.
Parameters
- enabled: boolean
  whether to enable the control
Returns void
Inherited from TextControlBase.setEnabled
- Defined in lab/controls/TextControl.ts:193

setValue

setValue(value): void
Changes the value shown by this control, and sets the target to this value.
Parameters
- value: string
  the new value
Returns void
Throws
if value is not a string
Inherited from TextControlBase.setValue
- Defined in lab/controls/TextControl.ts:201

toString

toString(): string
Returns string
Inherit Doc
Overrides TextControlBase.toString
- Defined in lab/controls/TextControl.ts:269

toStringShort

toStringShort(): string
Returns a minimal string representation of this object, usually giving just identity information like the class name and name of the object.

For an object whose main purpose is to represent another Printable object, it is recommended to include the result of calling toStringShort on that other object. For example, calling toStringShort() on a DisplayShape might return something like this:
```
DisplayShape{polygon:Polygon{'chain3'}}
```
Returns string
a minimal string representation of this object.
Inherited from TextControlBase.toStringShort
- Defined in lab/controls/TextControl.ts:105

Class TextControl

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Parameters

parameter: ParameterString

Optional textField: HTMLInputElement

Returns TextControl

Methods

disconnect

Returns void

getClassName

Returns string

getColumns

Returns number

getElement

Returns HTMLElement

getParameter

Returns null | Parameter

getValue

Returns string

observe

Parameters

_event: SubjectEvent

Returns void

setColumns

Parameters

value: number

Returns TextControlBase

setEnabled

Parameters

enabled: boolean

Returns void

setValue

Parameters

value: string

Returns void

Throws

toString

Returns string

Inherit Doc

toStringShort

Returns string

Settings

Member Visibility

Theme

On This Page

`Optional` textField: HTMLInputElement