Interface: FmcComponentOptions
Defined in: src/sdk/fmc/components/FmcComponent.ts:8
Base options for initializing an FmcComponent
Extended by
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
.
disabled?
optional
disabled:boolean
| () =>boolean
Defined in: src/sdk/fmc/components/FmcComponent.ts:10
Disables this component, not handling any lsk events.
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 calledfalse
-> the handler is not considered to have handled the call, and the next handlers will be calledstring
-> the value is shown in the scratchpad, and the handler is considered to have handled the call
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 calledfalse
-> the handler is not considered to have handled the call, and the next handlers will be calledstring
-> 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
>