Interface: FmcComponentOptions

Base options for initializing an FmcComponent

Hierarchy

• FmcComponentOptions

  ↳ DisplayFieldOptions

Properties

clearScratchpadOnSelectedHandled

• Optional clearScratchpadOnSelectedHandled: boolean

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

Defined in

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

---

disabled

• Optional disabled: boolean | () => boolean

Disables this component, not handling any lsk events.

Defined in

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

---

onDelete

• Optional onDelete: () => Promise<string | boolean>

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

Type declaration

▸ (): Promise<string | boolean>

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>

Defined in

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

---

onSelected

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

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

Type declaration

▸ (scratchpadContents): Promise<string | boolean>

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

Name	Type
scratchpadContents	string

Returns

Promise<string | boolean>

Defined in

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