InputBase<T>

Defined in: js-api/src/widgets/inputs-base.ts:21

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

Extended by

• JsInputBase
• DateInput
• ChoiceInput
• MultiChoiceInput
• TypeAhead
• CodeInput

Type Parameters

Type Parameter	Default type
T	any

Constructors

Constructor

new InputBase<T>(dart, onChanged?): InputBase<T>

Defined in: js-api/src/widgets/inputs-base.ts:24

Parameters

Parameter	Type	Default value
dart	any	undefined
onChanged	any	null

Returns

InputBase<T>

Properties

Property	Type	Defined in
dart	any	js-api/src/widgets/inputs-base.ts:22

Accessors

caption

Get Signature

get caption(): string

Defined in: js-api/src/widgets/inputs-base.ts:56

Returns

string

Set Signature

set caption(s): void

Defined in: js-api/src/widgets/inputs-base.ts:59

Parameters

Parameter	Type
s	string

Returns

void

---

captionLabel

Get Signature

get captionLabel(): HTMLElement

Defined in: js-api/src/widgets/inputs-base.ts:69

Returns

HTMLElement

---

classList

Get Signature

get classList(): DOMTokenList

Defined in: js-api/src/widgets/inputs-base.ts:177

Returns

DOMTokenList

---

dataType

Get Signature

get dataType(): string

Defined in: js-api/src/widgets/inputs-base.ts:51

Data type this input can edit. See Type.

Returns

string

---

enabled

Get Signature

get enabled(): boolean

Defined in: js-api/src/widgets/inputs-base.ts:95

Whether the input is enabled

Returns

boolean

Set Signature

set enabled(v): void

Defined in: js-api/src/widgets/inputs-base.ts:96

Parameters

Parameter	Type
v	boolean

Returns

void

---

format

Get Signature

get format(): string

Defined in: js-api/src/widgets/inputs-base.ts:66

Value format.

Returns

string

Set Signature

set format(s): void

Defined in: js-api/src/widgets/inputs-base.ts:67

Parameters

Parameter	Type
s	string

Returns

void

---

input

Get Signature

get input(): HTMLElement

Defined in: js-api/src/widgets/inputs-base.ts:72

Returns the actual input

Returns

HTMLElement

---

inputType

Get Signature

get inputType(): string

Defined in: js-api/src/widgets/inputs-base.ts:46

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

Returns

string

---

notify

Get Signature

get notify(): boolean

Defined in: js-api/src/widgets/inputs-base.ts:79

Whether events are thrown on value set

Returns

boolean

Set Signature

set notify(v): void

Defined in: js-api/src/widgets/inputs-base.ts:80

Parameters

Parameter	Type
v	boolean

Returns

void

---

nullable

Get Signature

get nullable(): boolean

Defined in: js-api/src/widgets/inputs-base.ts:75

Whether empty values are allowed

Returns

boolean

Set Signature

set nullable(v): void

Defined in: js-api/src/widgets/inputs-base.ts:76

Parameters

Parameter	Type
v	boolean

Returns

void

---

onChanged

Get Signature

get onChanged(): Observable<T>

Defined in: js-api/src/widgets/inputs-base.ts:103

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

Returns

Observable<T>

---

onInput

Get Signature

get onInput(): Observable<Event>

Defined in: js-api/src/widgets/inputs-base.ts:106

Occurs when [value] is changed by user.

Returns

Observable<Event>

---

onValidated

Get Signature

get onValidated(): Observable<string[]>

Defined in: js-api/src/widgets/inputs-base.ts:118

Occurs after each validation run, with the resulting messages.

Returns

Observable<string[]>

---

property

Get Signature

get property(): any

Defined in: js-api/src/widgets/inputs-base.ts:62

Property if associated with

Returns

any

Set Signature

set property(p): void

Defined in: js-api/src/widgets/inputs-base.ts:63

Parameters

Parameter	Type
p	Property

Returns

void

---

readOnly

Get Signature

get readOnly(): boolean

Defined in: js-api/src/widgets/inputs-base.ts:91

Whether the input is readonly

Returns

boolean

Set Signature

set readOnly(v): void

Defined in: js-api/src/widgets/inputs-base.ts:92

Parameters

Parameter	Type
v	boolean

Returns

void

---

root

Get Signature

get root(): HTMLElement

Defined in: js-api/src/widgets/inputs-base.ts:54

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

Returns

HTMLElement

---

stringValue

Get Signature

get stringValue(): string

Defined in: js-api/src/widgets/inputs-base.ts:87

String representation of the value

Returns

string

Set Signature

set stringValue(s): void

Defined in: js-api/src/widgets/inputs-base.ts:88

Parameters

Parameter	Type
s	string

Returns

void

---

validationResults

Get Signature

get validationResults(): string[]

Defined in: js-api/src/widgets/inputs-base.ts:109

Messages of the current validation results (empty when the input is valid).

Returns

string[]

---

validity

Get Signature

get validity(): string | null

Defined in: js-api/src/widgets/inputs-base.ts:112

Current validation message(s), or null when the input is valid.

Returns

string | null

---

value

Get Signature

get value(): T

Defined in: js-api/src/widgets/inputs-base.ts:83

Input value

Returns

T

Set Signature

set value(x): void

Defined in: js-api/src/widgets/inputs-base.ts:84

Parameters

Parameter	Type
x	T

Returns

void

---

visible

Get Signature

get visible(): boolean

Defined in: js-api/src/widgets/inputs-base.ts:99

Whether the input is visible. When set, also updates the visibility of its category header.

Returns

boolean

Set Signature

set visible(v): void

Defined in: js-api/src/widgets/inputs-base.ts:100

Parameters

Parameter	Type
v	boolean

Returns

void

Methods

addCaption()

addCaption(caption): InputBase<T>

Defined in: js-api/src/widgets/inputs-base.ts:143

Adds the specified caption

Parameters

Parameter	Type
caption	string

Returns

InputBase<T>

---

addOptions()

addOptions(options): InputBase<T>

Defined in: js-api/src/widgets/inputs-base.ts:155

Adds the specified options

Parameters

Parameter	Type
options	HTMLElement

Returns

InputBase<T>

---

addPatternMenu()

addPatternMenu(pattern): void

Defined in: js-api/src/widgets/inputs-base.ts:161

Adds a usage example to the input's hamburger menu

Parameters

Parameter	Type
pattern	any

Returns

void

---

addPostfix()

addPostfix(postfix): InputBase<T>

Defined in: js-api/src/widgets/inputs-base.ts:149

Adds the specified postfix

Parameters

Parameter	Type
postfix	string

Returns

InputBase<T>

---

addValidator()

addValidator(validator): void

Defined in: js-api/src/widgets/inputs-base.ts:167

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) => string | null

Returns

void

---

fireChanged()

fireChanged(): any

Defined in: js-api/src/widgets/inputs-base.ts:133

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

Returns

any

---

fireInput()

fireInput(): any

Defined in: js-api/src/widgets/inputs-base.ts:138

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

Returns

any

---

init()

init(): any

Defined in: js-api/src/widgets/inputs-base.ts:128

Returns

any

---

load()

load(s): any

Defined in: js-api/src/widgets/inputs-base.ts:126

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

Parameters

Parameter	Type
s	any

Returns

any

---

save()

save(): any

Defined in: js-api/src/widgets/inputs-base.ts:121

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

Returns

any

---

setTooltip()

setTooltip(msg, tooltipCheck?): InputBase<T>

Defined in: js-api/src/widgets/inputs-base.ts:172

Sets the tooltip

Parameters

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

Returns

InputBase<T>

---

validate()

validate(): boolean

Defined in: js-api/src/widgets/inputs-base.ts:183

Performs immediate validation of the input and returns the result.

Returns

boolean

True if the input is valid; otherwise, false.

---

forColumn()

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

Defined in: js-api/src/widgets/inputs-base.ts:41

Creates input for the specified column

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type
column	Column<T>

Returns

InputBase<T | null>

---

forInputType()

static forInputType(inputType): InputBase

Defined in: js-api/src/widgets/inputs-base.ts:36

Creates input for the specified input type

Parameters

Parameter	Type
inputType	string | InputType

Returns

InputBase

---

forProperty()

static forProperty(property, source?): InputBase

Defined in: js-api/src/widgets/inputs-base.ts:31

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