Abstract Class: FmcComponent<O>
Defined in: src/sdk/fmc/components/FmcComponent.ts:56
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
Extended by
Type Parameters
Type Parameter | Default type |
---|---|
O extends FmcComponentOptions | FmcComponentOptions |
Constructors
Constructor
protected
new FmcComponent<O
>(page
,options
):FmcComponent
<O
>
Defined in: src/sdk/fmc/components/FmcComponent.ts:60
Parameters
Parameter | Type |
---|---|
page | AbstractFmcPage |
options | O |
Returns
FmcComponent
<O
>
Inherit Doc
Properties
isDisabled()
isDisabled: () =>
boolean
Defined in: src/sdk/fmc/components/FmcComponent.ts:57
Returns
boolean
options
protected
readonly
options:O
Defined in: src/sdk/fmc/components/FmcComponent.ts:62
page
protected
readonly
page:AbstractFmcPage
Defined in: src/sdk/fmc/components/FmcComponent.ts:61
Methods
getOptions()
getOptions():
O
Defined in: src/sdk/fmc/components/FmcComponent.ts:124
Returns the component's options
Returns
O
The options.
handleSelectKey()
handleSelectKey(
event
):Promise
<string
|boolean
>
Defined in: src/sdk/fmc/components/FmcComponent.ts:80
Parameters
Parameter | Type |
---|---|
event | LineSelectKeyEvent |
Returns
Promise
<string
| boolean
>
Inherit Doc
invalidate()
protected
invalidate():void
Defined in: src/sdk/fmc/components/FmcComponent.ts:69
Invalidates the component and queues a re-render if one is not already queued
Returns
void
onHandleSelectKey()
abstract
protected
onHandleSelectKey(event
):Promise
<string
|boolean
>
Defined in: src/sdk/fmc/components/FmcComponent.ts:118
Parameters
Parameter | Type |
---|---|
event | LineSelectKeyEvent |
Returns
Promise
<string
| boolean
>
render()
abstract
render():string
|FmcRenderTemplate
Defined in: src/sdk/fmc/components/FmcComponent.ts:76
Renders the FMC component into an FmcRenderTemplateRow
Returns
string
| FmcRenderTemplate