Class: TextInputField<T, V>

An FmcComponent for displaying and accepting new values according to a validator and formatter.

deleteAllowed

This class deals with LSK presses that have the DELETE flag active using a default implementation of FmcComponentOptions.onDelete, which checks options.deleteAllowed - if true or not set,the onValidLskInput subject is set to null - if false, the "INVALID DELETE" scratchpad message is returned and handled by FmcComponent.handleSelectKey.

onModified

This class also introduces another LSK handler, InputFieldOptions.onModified, which is run after a value has been validated (it is not called for invalid values) and applies return value logic. This runs after the flow described for FmcComponent.

Type parameters

Name	Type
T	string
V	T

Hierarchy

• EditableField<T, V>

  ↳ TextInputField

Constructors

constructor

• new TextInputField<T, V>(page, options): TextInputField<T, V>

Type parameters

Name	Type
T	string
V	T

Parameters

Name	Type
page	AbstractFmcPage<any>
options	TextInputFieldOptions<T, V>

Returns

TextInputField<T, V>

Inherit Doc

Overrides

EditableField.constructor

Defined in

src/sdk/fmc/components/TextInputField.ts:61

Properties

isDisabled

• isDisabled: () => boolean

Type declaration

▸ (): boolean

Returns

boolean

Inherited from

EditableField.isDisabled

Defined in

src/sdk/fmc/components/FmcComponent.ts:57

---

options

• Readonly options: TextInputFieldOptions<T, V>

Inherited from

EditableField.options

Defined in

src/sdk/fmc/components/TextInputField.ts:63

---

page

• Protected page: AbstractFmcPage<any>

Inherited from

EditableField.page

Defined in

src/sdk/fmc/components/EditableField.ts:36

---

value

• Protected value: null | T = null

Inherited from

EditableField.value

Defined in

src/sdk/fmc/components/DisplayField.ts:30

---

valueChanged

• Protected Readonly valueChanged: SubEvent<EditableField<T, V>, V>

Inherited from

EditableField.valueChanged

Defined in

src/sdk/fmc/components/EditableField.ts:32

Accessors

rawValue

• get rawValue(): null | T

Gets the raw value of this display field

Returns

null | T

the value

Inherited from

EditableField.rawValue

Defined in

src/sdk/fmc/components/DisplayField.ts:36

Methods

bind

▸ bind(subscribable): this

Binds the input field to a mutable subscribable.

Parameters

Name	Type	Description
subscribable	MutableSubscribable<T, V> | Subscribable<T>	the mutable subscribable

Returns

this

the instance of this EditableField

Inherited from

EditableField.bind

Defined in

src/sdk/fmc/components/EditableField.ts:47

---

bindConsumer

▸ bindConsumer(consumer, modifier): this

Binds the input field to a Consumer.

Parameters

Name	Type	Description
consumer	Consumer<T>	the consumer to bind to (get)
modifier	(value: V) => void	the modifier to use when the value is modified (set)

Returns

this

the instance of this EditableField

Inherited from

EditableField.bindConsumer

Defined in

src/sdk/fmc/components/EditableField.ts:63

---

bindSource

▸ bindSource(source): this

Binds the input field to a data interface.

Parameters

Name	Type	Description
source	DataInterface<T, V>	the data interface

Returns

this

the instance of this EditableField

Inherited from

EditableField.bindSource

Defined in

src/sdk/fmc/components/EditableField.ts:72

---

getOptions

▸ getOptions(): DisplayFieldOptions<T>

Returns the component's options

Returns

DisplayFieldOptions<T>

The options.

Inherited from

EditableField.getOptions

Defined in

src/sdk/fmc/components/FmcComponent.ts:124

---

handleSelectKey

▸ handleSelectKey(event): Promise<string | boolean>

Parameters

Name	Type
event	LineSelectKeyEvent

Returns

Promise<string | boolean>

Inherit Doc

Inherited from

EditableField.handleSelectKey

Defined in

src/sdk/fmc/components/FmcComponent.ts:80

---

invalidate

▸ invalidate(): void

Invalidates the component and queues a re-render if one is not already queued

Returns

void

Inherited from

EditableField.invalidate

Defined in

src/sdk/fmc/components/FmcComponent.ts:69

---

onHandleSelectKey

▸ onHandleSelectKey(event): Promise<string | boolean>

Parameters

Name	Type
event	LineSelectKeyEvent

Returns

Promise<string | boolean>

Inherit Doc

Overrides

EditableField.onHandleSelectKey

Defined in

src/sdk/fmc/components/TextInputField.ts:96

---

render

▸ render(): FmcFormatterOutput

Renders the FMC component into an FmcRenderTemplateRow

Returns

FmcFormatterOutput

Inherited from

EditableField.render

Defined in

src/sdk/fmc/components/DisplayField.ts:74

---

takeTextInput

▸ takeTextInput(input): Promise<string | boolean>

Allows text input to be programmatically sent to the field.

Parameters

Name	Type	Description
input	string	the text input

Returns

Promise<string | boolean>

a Promise that resolves to a boolean or string

Defined in

src/sdk/fmc/components/TextInputField.ts:91

---

takeValue

▸ takeValue(value, shouldInvalidate?): void

Takes an input value, displays it and stores it

Parameters

Name	Type	Default value	Description
value	null | T	undefined	the new input value
shouldInvalidate	boolean	false	whether or not to invalidate the page

Returns

void

Inherited from

EditableField.takeValue

Defined in

src/sdk/fmc/components/DisplayField.ts:60