Abstract Class: AbstractFmcPage<P>
Defined in: src/sdk/fmc/AbstractFmcPage.ts:33
Base abstract class for FMC pages
Type Parameters
Type Parameter | Default type |
---|---|
P extends object | null | any |
Constructors
Constructor
protected
new AbstractFmcPage<P
>(bus
,screen
,props
):AbstractFmcPage
<P
>
Defined in: src/sdk/fmc/AbstractFmcPage.ts:79
Ctor
Parameters
Parameter | Type | Description |
---|---|---|
bus | EventBus | the event bus |
screen | FmcScreen <any , any > | the FMC screen instance |
props | P | the initial props for this page |
Returns
AbstractFmcPage
<P
>
Properties
bus
readonly
bus:EventBus
Defined in: src/sdk/fmc/AbstractFmcPage.ts:79
the event bus
clockConsumer
protected
clockConsumer:Consumer
<number
>
Defined in: src/sdk/fmc/AbstractFmcPage.ts:70
isInitialized
isInitialized:
boolean
=false
Defined in: src/sdk/fmc/AbstractFmcPage.ts:98
memorizedComponents
readonly
memorizedComponents: [null
|FmcComponent
<FmcComponentOptions
>,null
|FmcComponent
<FmcComponentOptions
>,null
|FmcComponent
<FmcComponentOptions
>][] =[]
Defined in: src/sdk/fmc/AbstractFmcPage.ts:45
params
readonly
params:Map
<any
,any
>
Defined in: src/sdk/fmc/AbstractFmcPage.ts:51
screen
readonly
screen:FmcScreen
<any
,any
>
Defined in: src/sdk/fmc/AbstractFmcPage.ts:79
the FMC screen instance
lifecyclePolicy
static
lifecyclePolicy:FmcPageLifecyclePolicy
=FmcPageLifecyclePolicy.Singleton
Defined in: src/sdk/fmc/AbstractFmcPage.ts:37
Configures the FmcPageLifecyclePolicy for this page
Accessors
props
Get Signature
get props():
P
Defined in: src/sdk/fmc/AbstractFmcPage.ts:62
Obtains the current value of the page's props
Throws
if the props have not yet been initialised
Returns
P
the props value
Methods
acceptPageExtension()
acceptPageExtension(
extension
):void
Defined in: src/sdk/fmc/AbstractFmcPage.ts:316
Accepts a page extension
Parameters
Parameter | Type | Description |
---|---|---|
extension | FmcPageExtension <AbstractFmcPage <P >> | the page extension |
Returns
void
addBinding()
addBinding(
binding
):void
Defined in: src/sdk/fmc/AbstractFmcPage.ts:361
Registers a subscription or a ConsumerSubject on the page. This enables the page to manage the lifecycle of all subscriptions that are used within it, for example by pausing them whenever the page is out of view, or destroying them when the page is destroyed.
Parameters
Parameter | Type | Description |
---|---|---|
binding | Subscription | ConsumerSubject <any > | a subscription |
Returns
void
clockHandler()
protected
clockHandler(d
):void
Defined in: src/sdk/fmc/AbstractFmcPage.ts:90
Handles when update/refresh of the FMCPage based on clock input
Parameters
Parameter | Type | Description |
---|---|---|
d | number | is the Clock Value from the Event Bus |
Returns
void
destroy()
destroy():
void
Defined in: src/sdk/fmc/AbstractFmcPage.ts:194
Destroys the page and calls appropriate event handlers
Returns
void
handleLineSelectKey()
handleLineSelectKey(
event
):Promise
<string
|boolean
>
Defined in: src/sdk/fmc/AbstractFmcPage.ts:372
Handles a line select key received by the FMC, before passing it on to components
Parameters
Parameter | Type | Description |
---|---|---|
event | LineSelectKeyEvent | the LSK event |
Returns
Promise
<string
| boolean
>
a Promise that resolves to a boolean or string
handleScrolling()
handleScrolling(
event
):Promise
<string
|boolean
>
Defined in: src/sdk/fmc/AbstractFmcPage.ts:412
Handles a scrolling event received by the FMC, before passing it on to components
Parameters
Parameter | Type | Description |
---|---|---|
event | "pageLeft" | "pageRight" | "pageUp" | "pageDown" | the scrolling event |
Returns
Promise
<string
| boolean
>
a Promise that resolves to a boolean or string
init()
init():
void
Defined in: src/sdk/fmc/AbstractFmcPage.ts:105
Initializes the page.
Use this for setting up subscriptions and such.
Returns
void
initialRender()
initialRender():
void
Defined in: src/sdk/fmc/AbstractFmcPage.ts:231
Initial render function
Returns
void
Throws
If a PositionedFmcColumn
attempts to return an FmcRenderTemplate
from its render function (only string
s are allowed).
invalidate()
invalidate():
void
Defined in: src/sdk/fmc/AbstractFmcPage.ts:223
Invalidates the render and sets the component into the dirty state
Returns
void
onDestroy()
protected
onDestroy():void
Defined in: src/sdk/fmc/AbstractFmcPage.ts:216
Destroy lifecycle hook
Returns
void
onHandleScrolling()
protected
onHandleScrolling(event
):Promise
<string
|boolean
>
Defined in: src/sdk/fmc/AbstractFmcPage.ts:431
Handles a scrolling event received by the FMC, before passing it on to components
Parameters
Parameter | Type | Description |
---|---|---|
event | "pageLeft" | "pageRight" | "pageUp" | "pageDown" | the scrolling event |
Returns
Promise
<string
| boolean
>
a Promise that resolves to a boolean or string
onHandleSelectKey()
protected
onHandleSelectKey(event
):Promise
<string
|boolean
>
Defined in: src/sdk/fmc/AbstractFmcPage.ts:401
Handles a line select key received by the FMC, before passing it on to components
Parameters
Parameter | Type | Description |
---|---|---|
event | LineSelectKeyEvent | the LSK event |
Returns
Promise
<string
| boolean
>
a Promise that resolves to a boolean or string
onInit()
protected
onInit():void
Defined in: src/sdk/fmc/AbstractFmcPage.ts:118
Init lifecycle hook
Returns
void
onPageButtonPressed()
onPageButtonPressed():
void
Defined in: src/sdk/fmc/AbstractFmcPage.ts:187
Is called when the page button for the current page is pressed while already on that page.
Returns
void
onPause()
protected
onPause():void
Defined in: src/sdk/fmc/AbstractFmcPage.ts:147
Pause lifecycle hook
Returns
void
onResume()
protected
onResume():void
Defined in: src/sdk/fmc/AbstractFmcPage.ts:182
Resume lifecycle hook
Returns
void
pause()
pause():
void
Defined in: src/sdk/fmc/AbstractFmcPage.ts:125
Pauses the page and calls appropriate event handlers
Returns
void
render()
abstract
render():FmcRenderTemplate
[]
Defined in: src/sdk/fmc/AbstractFmcPage.ts:350
Returns
resume()
resume(
props?
):void
Defined in: src/sdk/fmc/AbstractFmcPage.ts:156
Resumes the page and calls appropriate event handlers
Parameters
Parameter | Type | Description |
---|---|---|
props? | P | the props to pass in to the page, if applicable |
Returns
void
isPositionedFmcColumn()
static
isPositionedFmcColumn(column
):column is PositionedFmcColumn
Defined in: src/sdk/fmc/AbstractFmcPage.ts:325
Tests whether an FmcRenderTemplateColumn
is a PositionedFmcColumn
.
Parameters
Parameter | Type | Description |
---|---|---|
column | FmcRenderTemplateColumn | The FmcRenderTemplateColumn to test. |
Returns
column is PositionedFmcColumn
Whether the column is a PositionedFmcColumn
.
isRenderedPositionedFmcColumn()
static
isRenderedPositionedFmcColumn(column
):column is RenderedPositionedFmcColumn
Defined in: src/sdk/fmc/AbstractFmcPage.ts:346
Tests whether the input is a RenderedPositionedFmcColumn
.
Parameters
Parameter | Type | Description |
---|---|---|
column | any | The input to test. |
Returns
column is RenderedPositionedFmcColumn
Whether the column is a RenderedPositionedFmcColumn
.