Skip to main content

Class: WT21FmcPage<T>

WT21 FMC page

Type parameters

NameType
Textends object | null = null

Hierarchy

Constructors

constructor

new WT21FmcPage<T>(bus, screen, props, fms, baseInstrument, renderCallback): WT21FmcPage<T>

Ctor

Type parameters

NameType
Textends null | object = null

Parameters

NameTypeDescription
busEventBusthe event bus
screenWT21FmcScreenthe FMC screen instance
propsTthe props to create the page with
fmsWT21Fmsthe fms to use
baseInstrumentWT21_FMC_Instrumentthe base FMC instrument
renderCallbackFmcRenderCallbackthe render callback

Returns

WT21FmcPage<T>

Overrides

AbstractFmcPage\<T\>.constructor

Defined in

workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/WT21FmcPage.ts:21

Properties

PagingFormat

Protected Readonly PagingFormat: Formatter<readonly [number, number], string>

Defined in

workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/WT21FmcPage.ts:35


PagingIndicator

Readonly PagingIndicator: DisplayField<readonly [number, number]>

Defined in

workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/WT21FmcPage.ts:44


baseInstrument

Readonly baseInstrument: WT21_FMC_Instrument

Deprecated

Defined in

workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/WT21FmcPage.ts:27


bus

Readonly bus: EventBus

the event bus

Inherited from

AbstractFmcPage.bus

Defined in

workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/WT21FmcPage.ts:22


clockConsumer

Protected clockConsumer: Consumer<number>

Inherited from

AbstractFmcPage.clockConsumer

Defined in

sdk/fmc/AbstractFmcPage.ts:70


fms

Readonly fms: WT21Fms

the fms to use

Defined in

workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/WT21FmcPage.ts:25


isInitialized

isInitialized: boolean = false

Inherited from

AbstractFmcPage.isInitialized

Defined in

sdk/fmc/AbstractFmcPage.ts:98


memorizedComponents

Readonly memorizedComponents: [null | FmcComponent<FmcComponentOptions>, null | FmcComponent<FmcComponentOptions>, null | FmcComponent<FmcComponentOptions>][] = []

Inherited from

AbstractFmcPage.memorizedComponents

Defined in

sdk/fmc/AbstractFmcPage.ts:45


params

Readonly params: Map<any, any>

Inherited from

AbstractFmcPage.params

Defined in

sdk/fmc/AbstractFmcPage.ts:51


renderCallback

Readonly renderCallback: FmcRenderCallback

the render callback

Inherited from

AbstractFmcPage.renderCallback

Defined in

workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/WT21FmcPage.ts:28


screen

Readonly screen: WT21FmcScreen

the FMC screen instance

Inherited from

AbstractFmcPage.screen

Defined in

workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/WT21FmcPage.ts:23


lifecyclePolicy

Static lifecyclePolicy: FmcPageLifecyclePolicy = FmcPageLifecyclePolicy.Singleton

Configures the FmcPageLifecyclePolicy for this page

Inherited from

AbstractFmcPage.lifecyclePolicy

Defined in

sdk/fmc/AbstractFmcPage.ts:37

Accessors

props

get props(): P

Obtains the current value of the page's props

Returns

P

the props value

Throws

if the props have not yet been initialised

Inherited from

AbstractFmcPage.props

Defined in

sdk/fmc/AbstractFmcPage.ts:62

Methods

acceptPageExtension

acceptPageExtension(extension): void

Accepts a page extension

Parameters

NameTypeDescription
extensionFmcPageExtension<WT21FmcPage<T>>the page extension

Returns

void

Inherited from

AbstractFmcPage.acceptPageExtension

Defined in

sdk/fmc/AbstractFmcPage.ts:316


addBinding

addBinding(binding): void

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

NameTypeDescription
bindingSubscription | ConsumerSubject<any>a subscription

Returns

void

Inherited from

AbstractFmcPage.addBinding

Defined in

sdk/fmc/AbstractFmcPage.ts:361


clockHandler

clockHandler(d): void

Handles when update/refresh of the FMCPage based on clock input

Parameters

NameTypeDescription
dnumberis the Clock Value from the Event Bus

Returns

void

Inherited from

AbstractFmcPage.clockHandler

Defined in

sdk/fmc/AbstractFmcPage.ts:90


destroy

destroy(): void

Destroys the page and calls appropriate event handlers

Returns

void

Inherited from

AbstractFmcPage.destroy

Defined in

sdk/fmc/AbstractFmcPage.ts:194


handleLineSelectKey

handleLineSelectKey(event): Promise<string | boolean>

Handles a line select key received by the FMC, before passing it on to components

Parameters

NameTypeDescription
eventLineSelectKeyEventthe LSK event

Returns

Promise<string | boolean>

a Promise that resolves to a boolean or string

Inherited from

AbstractFmcPage.handleLineSelectKey

Defined in

sdk/fmc/AbstractFmcPage.ts:372


handleScrolling

handleScrolling(event): Promise<string | boolean>

Handles a scrolling event received by the FMC, before passing it on to components

Parameters

NameTypeDescription
event"pageLeft" | "pageRight" | "pageUp" | "pageDown"the scrolling event

Returns

Promise<string | boolean>

a Promise that resolves to a boolean or string

Inherited from

AbstractFmcPage.handleScrolling

Defined in

sdk/fmc/AbstractFmcPage.ts:412


init

init(): void

Initializes the page.

Use this for setting up subscriptions and such.

Returns

void

Inherited from

AbstractFmcPage.init

Defined in

sdk/fmc/AbstractFmcPage.ts:105


initialRender

initialRender(): void

Initial render function

Returns

void

Throws

If a PositionedFmcColumn attempts to return an FmcRenderTemplate from its render function (only strings are allowed).

Inherited from

AbstractFmcPage.initialRender

Defined in

sdk/fmc/AbstractFmcPage.ts:231


invalidate

invalidate(): void

Invalidates the render and sets the component into the dirty state

Returns

void

Inherited from

AbstractFmcPage.invalidate

Defined in

sdk/fmc/AbstractFmcPage.ts:223


onDestroy

onDestroy(): void

Destroy lifecycle hook

Returns

void

Inherited from

AbstractFmcPage.onDestroy

Defined in

sdk/fmc/AbstractFmcPage.ts:216


onHandleScrolling

onHandleScrolling(event): Promise<string | boolean>

Handles a scrolling event received by the FMC, before passing it on to components

Parameters

NameTypeDescription
event"pageLeft" | "pageRight" | "pageUp" | "pageDown"the scrolling event

Returns

Promise<string | boolean>

a Promise that resolves to a boolean or string

Inherited from

AbstractFmcPage.onHandleScrolling

Defined in

sdk/fmc/AbstractFmcPage.ts:431


onHandleSelectKey

onHandleSelectKey(event): Promise<string | boolean>

Handles a line select key received by the FMC, before passing it on to components

Parameters

NameTypeDescription
eventLineSelectKeyEventthe LSK event

Returns

Promise<string | boolean>

a Promise that resolves to a boolean or string

Inherited from

AbstractFmcPage.onHandleSelectKey

Defined in

sdk/fmc/AbstractFmcPage.ts:401


onInit

onInit(): void

Init lifecycle hook

Returns

void

Inherited from

AbstractFmcPage.onInit

Defined in

sdk/fmc/AbstractFmcPage.ts:118


onPageButtonPressed

onPageButtonPressed(): void

Is called when the page button for the current page is pressed while already on that page.

Returns

void

Inherited from

AbstractFmcPage.onPageButtonPressed

Defined in

sdk/fmc/AbstractFmcPage.ts:187


onPause

onPause(): void

Pause lifecycle hook

Returns

void

Inherited from

AbstractFmcPage.onPause

Defined in

sdk/fmc/AbstractFmcPage.ts:147


onResume

onResume(): void

Resume lifecycle hook

Returns

void

Inherited from

AbstractFmcPage.onResume

Defined in

sdk/fmc/AbstractFmcPage.ts:182


pause

pause(): void

Pauses the page and calls appropriate event handlers

Returns

void

Inherited from

AbstractFmcPage.pause

Defined in

sdk/fmc/AbstractFmcPage.ts:125


render

render(): FmcRenderTemplate[]

Returns

FmcRenderTemplate[]

Inherit Doc

Overrides

AbstractFmcPage.render

Defined in

workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/WT21FmcPage.ts:49


resume

resume(props?): void

Resumes the page and calls appropriate event handlers

Parameters

NameTypeDescription
props?Tthe props to pass in to the page, if applicable

Returns

void

Inherited from

AbstractFmcPage.resume

Defined in

sdk/fmc/AbstractFmcPage.ts:156


isPositionedFmcColumn

isPositionedFmcColumn(column): column is PositionedFmcColumn

Tests whether an FmcRenderTemplateColumn is a PositionedFmcColumn.

Parameters

NameTypeDescription
columnFmcRenderTemplateColumnThe FmcRenderTemplateColumn to test.

Returns

column is PositionedFmcColumn

Whether the column is a PositionedFmcColumn.

Inherited from

AbstractFmcPage.isPositionedFmcColumn

Defined in

sdk/fmc/AbstractFmcPage.ts:325


isRenderedPositionedFmcColumn

isRenderedPositionedFmcColumn(column): column is RenderedPositionedFmcColumn

Tests whether the input is a RenderedPositionedFmcColumn.

Parameters

NameTypeDescription
columnanyThe input to test.

Returns

column is RenderedPositionedFmcColumn

Whether the column is a RenderedPositionedFmcColumn.

Inherited from

AbstractFmcPage.isRenderedPositionedFmcColumn

Defined in

sdk/fmc/AbstractFmcPage.ts:346