ChoiceInput<T>

Input control base. Could be used for editing Property values as well. The root is a div that consists of captionLabel and input.

Extends

• InputBase<T>

Type parameters

Type parameter
T

Constructors

new ChoiceInput()

new ChoiceInput<T>(dart, onChanged): ChoiceInput<T>

Parameters

Parameter	Type	Default value
dart	any	undefined
onChanged	any	null

Returns

ChoiceInput<T>

Overrides

InputBase . constructor

Source

src/widgets/inputs.ts:39

Properties

Property	Type	Overrides
dart	any	InputBase.dart

Accessors

caption

get caption(): string

set caption(s): void

Parameters

Parameter	Type
s	string

Returns

string

Source

src/widgets/inputs-base.ts:56

---

captionLabel

get captionLabel(): HTMLElement

Returns

HTMLElement

Source

src/widgets/inputs-base.ts:69

---

classList

get classList(): DOMTokenList

Returns

DOMTokenList

Source

src/widgets/inputs-base.ts:161

---

dataType

get dataType(): string

Data type this input can edit. See Type.

Returns

string

Source

src/widgets/inputs-base.ts:51

---

enabled

get enabled(): boolean

Whether the input is enabled

set enabled(v): void

Parameters

Parameter	Type
v	boolean

Returns

boolean

Source

src/widgets/inputs-base.ts:95

---

format

get format(): string

Value format.

set format(s): void

Parameters

Parameter	Type
s	string

Returns

string

Source

src/widgets/inputs-base.ts:66

---

input

get input(): HTMLElement

Returns the actual input

Returns

HTMLElement

Source

src/widgets/inputs-base.ts:72

---

inputType

get inputType(): string

Input type identifier (such as "Slider" for the slider input). See InputType.

Returns

string

Source

src/widgets/inputs-base.ts:46

---

items

get items(): T[]

set items(s): void

Parameters

Parameter	Type
s	T[]

Returns

T[]

Source

src/widgets/inputs.ts:43

---

notify

get notify(): boolean

Whether events are thrown on value set

set notify(v): void

Parameters

Parameter	Type
v	boolean

Returns

boolean

Source

src/widgets/inputs-base.ts:79

---

nullable

get nullable(): boolean

Whether empty values are allowed

set nullable(v): void

Parameters

Parameter	Type
v	boolean

Returns

boolean

Source

src/widgets/inputs-base.ts:75

---

onChanged

get onChanged(): Observable<T>

Occurs when [value] is changed, either by user or programmatically.

Returns

Observable<T>

Source

src/widgets/inputs-base.ts:99

---

onInput

get onInput(): Observable<Event>

Occurs when [value] is changed by user.

Returns

Observable<Event>

Source

src/widgets/inputs-base.ts:102

---

property

get property(): any

Property if associated with

set property(p): void

Parameters

Parameter	Type
p	Property

Returns

any

Source

src/widgets/inputs-base.ts:62

---

readOnly

get readOnly(): boolean

Whether the input is readonly

set readOnly(v): void

Parameters

Parameter	Type
v	boolean

Returns

boolean

Source

src/widgets/inputs-base.ts:91

---

root

get root(): HTMLElement

Visual root (typically a div element that contains caption and input)

Returns

HTMLElement

Source

src/widgets/inputs-base.ts:54

---

stringValue

get stringValue(): string

String representation of the value

set stringValue(s): void

Parameters

Parameter	Type
s	string

Returns

string

Source

src/widgets/inputs-base.ts:87

---

value

get value(): T

Input value

set value(x): void

Parameters

Parameter	Type
x	T

Returns

T

Source

src/widgets/inputs-base.ts:83

Methods

addCaption()

addCaption(caption): InputBase<T>

Adds the specified caption

Parameters

Parameter	Type
caption	string

Returns

InputBase<T>

Inherited from

InputBase . addCaption

Source

src/widgets/inputs-base.ts:127

---

addOptions()

addOptions(options): InputBase<T>

Adds the specified options

Parameters

Parameter	Type
options	HTMLElement

Returns

InputBase<T>

Inherited from

InputBase . addOptions

Source

src/widgets/inputs-base.ts:139

---

addPatternMenu()

addPatternMenu(pattern): void

Adds a usage example to the input's hamburger menu

Parameters

Parameter	Type
pattern	any

Returns

void

Inherited from

InputBase . addPatternMenu

Source

src/widgets/inputs-base.ts:145

---

addPostfix()

addPostfix(postfix): InputBase<T>

Adds the specified postfix

Parameters

Parameter	Type
postfix	string

Returns

InputBase<T>

Inherited from

InputBase . addPostfix

Source

src/widgets/inputs-base.ts:133

---

addValidator()

addValidator(validator): void

Adds a validator that accepts a string representation of the edited value and returns null if valid, or error message if invalid

Parameters

Parameter	Type
validator	(value) => null | string

Returns

void

Inherited from

InputBase . addValidator

Source

src/widgets/inputs-base.ts:151

---

fireChanged()

fireChanged(): any

Fires the 'changed' event (value has changed). See also fireInput

Returns

any

Inherited from

InputBase . fireChanged

Source

src/widgets/inputs-base.ts:117

---

fireInput()

fireInput(): any

Fires the 'input' event (user input). See also fireChanged

Returns

any

Inherited from

InputBase . fireInput

Source

src/widgets/inputs-base.ts:122

---

init()

init(): any

Returns

any

Inherited from

InputBase . init

Source

src/widgets/inputs-base.ts:112

---

load()

load(s): any

Loads the value. Used in dialog history. See also load

Parameters

Parameter	Type
s	any

Returns

any

Inherited from

InputBase . load

Source

src/widgets/inputs-base.ts:110

---

save()

save(): any

Saves the value. Used in dialog history. See also load

Returns

any

Inherited from

InputBase . save

Source

src/widgets/inputs-base.ts:105

---

setTooltip()

setTooltip(msg, tooltipCheck): InputBase<T>

Sets the tooltip

Parameters

Parameter	Type	Default value
msg	string	undefined
tooltipCheck	null | () => boolean	null

Returns

InputBase<T>

Inherited from

InputBase . setTooltip

Source

src/widgets/inputs-base.ts:156

---

validate()

validate(): boolean

Performs immediate validation of the input and returns the result.

Returns

boolean

True if the input is valid; otherwise, false.

Inherited from

InputBase . validate

Source

src/widgets/inputs-base.ts:168

---

forColumn()

static forColumn<T>(column): InputBase<null | T>

Creates input for the specified column

Type parameters

Type parameter	Value
T	any

Parameters

Parameter	Type
column	Column<T, T>

Returns

InputBase<null | T>

Inherited from

InputBase . forColumn

Source

src/widgets/inputs-base.ts:41

---

forInputType()

static forInputType(inputType): InputBase<any>

Creates input for the specified input type

Parameters

Parameter	Type
inputType	string | InputType

Returns

InputBase<any>

Inherited from

InputBase . forInputType

Source

src/widgets/inputs-base.ts:36

---

forProperty()

static forProperty(property, source): InputBase<any>

Creates input for the specified property, and optionally binds it to the specified object

Parameters

Parameter	Type	Default value
property	Property	undefined
source	any	null

Returns

InputBase<any>

Inherited from

InputBase . forProperty

Source

src/widgets/inputs-base.ts:31