Class: FmcComponent<O>
A class for defining FMC components
LSK events
This class hierarchy deals with LSK presses in the following order:
- handleSelectKey - this is called by the page when it receives an LSk associated with the component
- IF the DELETE flag is set - call FmcComponentOptions.onDelete if it's present + apply return value logic - otherwise continue
- ELSE - call FmcComponentOptions.onSelected if it's present and apply return value logic - continue otherwise
- call onHandleSelectKey - overridden by a subclass
Type parameters
| Name | Type |
|---|---|
O | extends FmcComponentOptions = FmcComponentOptions |
Hierarchy
FmcComponent
Constructors
constructor
• new FmcComponent<O>(page, options): FmcComponent<O>
Type parameters
| Name | Type |
|---|---|
O | extends FmcComponentOptions = FmcComponentOptions |
Parameters
| Name | Type |
|---|---|
page | AbstractFmcPage<any> |
options | O |
Returns
FmcComponent<O>
Inherit Doc
Defined in
src/sdk/fmc/components/FmcComponent.ts:60
Properties
isDisabled
• isDisabled: () => boolean
Type declaration
▸ (): boolean
Returns
boolean
Defined in
src/sdk/fmc/components/FmcComponent.ts:57
options
• Protected Readonly options: O
Defined in
src/sdk/fmc/components/FmcComponent.ts:62
page
• Protected Readonly page: AbstractFmcPage<any>
Defined in
src/sdk/fmc/components/FmcComponent.ts:61
Methods
getOptions
▸ getOptions(): O
Returns the component's options
Returns
O
The options.
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
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
Defined in
src/sdk/fmc/components/FmcComponent.ts:69
onHandleSelectKey
▸ onHandleSelectKey(event): Promise<string | boolean>
Parameters
| Name | Type |
|---|---|
event | LineSelectKeyEvent |
Returns
Promise<string | boolean>
Defined in
src/sdk/fmc/components/FmcComponent.ts:118
render
▸ render(): string | FmcRenderTemplate
Renders the FMC component into an FmcRenderTemplateRow
Returns
string | FmcRenderTemplate
Defined in
src/sdk/fmc/components/FmcComponent.ts:76