Interface: TextInputFieldOptions<T, V>

Defined in: src/sdk/fmc/components/TextInputField.ts:9

Input field options

Extends

• EditableFieldOptions<T>

Type Parameters

Type Parameter
T
V

Properties

clearScratchpadOnSelectedHandled?

optional clearScratchpadOnSelectedHandled: boolean

Defined in: src/sdk/fmc/components/FmcComponent.ts:31

Whether to clear the s-pad when onSelected returns a string or true. Defaults to true.

Inherited from

EditableFieldOptions.clearScratchpadOnSelectedHandled

---

clearScratchpadOnValueAccepted?

optional clearScratchpadOnValueAccepted: boolean

Defined in: src/sdk/fmc/components/TextInputField.ts:23

Whether the scratchpad is cleared when a new value is accepted. true by default.

---

deleteAllowed?

optional deleteAllowed: boolean

Defined in: src/sdk/fmc/components/TextInputField.ts:18

Whether CLR DEL lsk events push a null value

---

disabled?

optional disabled: boolean | () => boolean

Defined in: src/sdk/fmc/components/FmcComponent.ts:10

Disables this component, not handling any lsk events.

Inherited from

EditableFieldOptions.disabled

---

formatter

formatter: FmcFormatter<T> & Validator<V>

Defined in: src/sdk/fmc/components/TextInputField.ts:13

Validator object

Overrides

EditableFieldOptions.formatter

---

onDelete()?

optional onDelete: () => Promise<string | boolean>

Defined in: src/sdk/fmc/components/FmcComponent.ts:41

Handler for an LSK pressed in DELETE mode

If the return value is:

• true -> the handler is considered to have handled the call, and no further handlers will be called
• false -> the handler is not considered to have handled the call, and the next handlers will be called
• string -> the value is shown in the scratchpad, and the handler is considered to have handled the call

Returns

Promise<string | boolean>

Inherited from

EditableFieldOptions.onDelete

---

onModified()?

optional onModified: (newValue) => Promise<string | boolean>

Defined in: src/sdk/fmc/components/TextInputField.ts:39

Optional callback fired when the value is about to be modified. This is only called when a value is successfully validated.

This should be used when there is no appropriate way of using a modifiable data source to accept modifications from this input field.

An example of this is a complex process like inserting a flight plan leg, or something calling a distant modification process with a very indirect relationship to the input data.

If the return value is:

• true -> the handler is considered to have handled the call, and any bound data is not modified.
• false -> the handler is not considered to have handled the call itself, and any bound data is modified.
• string -> the value is shown in the scratchpad, and the handler is considered to have handled the call.
• error -> the error is thrown and handled by FmcScreen::handleLineSelectKey

Parameters

Parameter	Type
newValue	V

Returns

Promise<string | boolean>

---

onSelected()?

optional onSelected: (scratchpadContents) => Promise<string | boolean>

Defined in: src/sdk/fmc/components/FmcComponent.ts:26

Handler for an LSK pressed where the component is. This is the second priority in terms of handling, after the FmcPage and before the component class onLsk function.

This should be used in either of those two cases:

• the component does not take user input but has LSK interactivity
• the component takes user input, but it is not validated (instead of using an InputField)

If the return value is:

• true -> the handler is considered to have handled the call, and no further handlers will be called
• false -> the handler is not considered to have handled the call, and the next handlers will be called
• string -> the value is shown in the scratchpad, and the handler is considered to have handled the call

Parameters

Parameter	Type
scratchpadContents	string

Returns

Promise<string | boolean>

Inherited from

EditableFieldOptions.onSelected

---

prefix?

optional prefix: string

Defined in: src/sdk/fmc/components/DisplayField.ts:17

Text shown before the value (can be used for start indentation)

Inherited from

EditableFieldOptions.prefix

---

style?

optional style: string | (value) => string

Defined in: src/sdk/fmc/components/DisplayField.ts:23

The style to apply to the value. MUST BE WRAPPED IN SQUARE BRACKETS.

Inherited from

EditableFieldOptions.style

---

suffix?

optional suffix: string

Defined in: src/sdk/fmc/components/DisplayField.ts:20

Text shown after the value (can be used for end indentation)

Inherited from

EditableFieldOptions.suffix