Skip to main content

Abstract Class: MFDUiPage<T>

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/UI/MFDUiPage.tsx:21

An MFD page.

Extends

Extended by

Type Parameters

Type ParameterDefault type
T extends MFDUiPagePropsMFDUiPageProps

Constructors

Constructor

new MFDUiPage<T>(props): MFDUiPage<T>

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiPage.tsx:28

Parameters

ParameterType
propsT

Returns

MFDUiPage<T>

Inherit Doc

Inherited from

UiPage.constructor

Properties

_title

protected readonly _title: Subject<string>

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiPage.tsx:18

Inherited from

UiPage._title


context?

optional context: [] = undefined

Defined in: sdk/components/FSComponent.ts:64

The context on this component, if any.

Inherited from

UiPage.context


contextType?

readonly optional contextType: readonly [] = undefined

Defined in: sdk/components/FSComponent.ts:67

The type of context for this component, if any.

Inherited from

UiPage.contextType


focusSubject

protected focusSubject: Subject<boolean>

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:33

Inherited from

UiPage.focusSubject


inputData

inputData: Subject<any>

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:36

Inherited from

UiPage.inputData


isPaused

protected isPaused: boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiPage.tsx:25

Inherited from

UiPage.isPaused


isSoftkeyMenuHidden

protected isSoftkeyMenuHidden: boolean = false

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/UI/MFDUiPage.tsx:22


onAccept

onAccept: SubEventInterface<MFDUiPage<T>, any>

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:40

Inherited from

UiPage.onAccept


onClose

onClose: SubEventInterface<MFDUiPage<T>, void>

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:39

Inherited from

UiPage.onClose


onOpen

onOpen: SubEventInterface<MFDUiPage<T>, void>

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:38

Inherited from

UiPage.onOpen


props

props: T & UiViewProps & ComponentProps

Defined in: sdk/components/FSComponent.ts:61

The properties of the component.

Inherited from

UiPage.props


scrollController

protected scrollController: ScrollController

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:32

Inherited from

UiPage.scrollController


viewContainerRef

protected readonly viewContainerRef: NodeReference<HTMLDivElement>

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:32

Inherited from

UiPage.viewContainerRef


viewResult

viewResult: any

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:34

Inherited from

UiPage.viewResult

Accessors

title

Get Signature

get title(): Subscribable<string>

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiPage.tsx:21

The title of this page.

Returns

Subscribable<string>

Inherited from

UiPage.title

Methods

accept()

accept(result?, closeView?): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:108

Confirms the view result and closes the view.

Parameters

ParameterTypeDefault valueDescription
result?anyundefinedProvide the view result if not already set.
closeView?booleantrueIndicates if the view should be closed after confirming the result.

Returns

void

Inherited from

UiPage.accept


blur()

blur(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:71

Method to unfocus this control group

Returns

void

Inherited from

UiPage.blur


close()

close(quickclose): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:65

Closes the view.

Parameters

ParameterTypeDefault valueDescription
quickclosebooleanfalsebool stating whether to quickclose the child.

Returns

void

Inherited from

UiPage.close


destroy()

destroy(): void

Defined in: sdk/components/FSComponent.ts:98

Destroys this component.

Returns

void

Inherited from

UiPage.destroy


focus()

focus(dir): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:61

Method to focus this control group

Parameters

ParameterTypeDefault valueDescription
dirEntryDirection'top'The direction of entry.

Returns

void

Inherited from

UiPage.focus


getContext()

protected getContext(context): never

Defined in: sdk/components/FSComponent.ts:106

Gets a context data subscription from the context collection.

Parameters

ParameterTypeDescription
contextneverThe context to get the subscription for.

Returns

never

The requested context.

Throws

An error if no data for the specified context type could be found.

Inherited from

UiPage.getContext


getHighlightElement()

getHighlightElement(): null | Element

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:125

This is just a dummy that exists here to be compatible with the union type of ScrollableControl

Returns

null | Element

null

Inherited from

UiPage.getHighlightElement


getIsFocusable()

getIsFocusable(): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:88

Gets a boolean indicating if this control is able to be focused.

Returns

boolean

true

Inherited from

UiPage.getIsFocusable


getIsFocused()

getIsFocused(): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:80

Method to check if this UiControlGroup is in focus

Returns

boolean

true if the control group is in focus, false otherwise

Inherited from

UiPage.getIsFocused


notifyViewOpened()

protected notifyViewOpened(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:131

Notifies subscribers that the view has been opened.

Returns

void

Inherited from

UiPage.notifyViewOpened


onAfterRender()

onAfterRender(thisNode): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/UI/MFDUiPage.tsx:25

A callback that is called after the component is rendered.

Parameters

ParameterTypeDescription
thisNodeVNodeThe component's VNode.

Returns

void

Overrides

UiPage.onAfterRender


onBeforeRender()

onBeforeRender(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:51

Returns

void

Inherit Doc

Inherited from

UiPage.onBeforeRender


onBlurred()

protected onBlurred(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:244

A callback which is called when this control group is blurred.

Returns

void

Inherited from

UiPage.onBlurred


onDirectToPressed()

protected onDirectToPressed(): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/UI/MFDUiPage.tsx:90

This method is called when a PROC button event occurs.

Returns

boolean

whether the event was handled.


onFocused()

protected onFocused(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:237

A callback which is called when this control group is focused.

Returns

void

Inherited from

UiPage.onFocused


onFPLPressed()

protected onFPLPressed(): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/UI/MFDUiPage.tsx:99

This method is called when a FPL button event occurs.

Returns

boolean

whether the event was handled.


onHomePressed()

protected onHomePressed(): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/UI/MFDUiPage.tsx:81

This method is called when a HOME button event occurs.

Returns

boolean

whether the event was handled.


onInputDataSet()

protected onInputDataSet(input): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:194

Method to be overridden by view inheriting UiView to do something when the input data is set.

Parameters

ParameterTypeDescription
inputanyThe data that was set.

Returns

void

Inherited from

UiPage.onInputDataSet


onInteractionEvent()

onInteractionEvent(evt): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/UI/MFDUiPage.tsx:44

Handler for interaction events to be handled by the view.

Parameters

ParameterTypeDescription
evtFmsHEventThe HEvenet.

Returns

boolean

true if the event was handled in this group

Overrides

UiPage.onInteractionEvent


onMenuPressed()

protected onMenuPressed(): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/UI/MFDUiPage.tsx:73

This method is called when a MENU button event occurs.

Returns

boolean

whether the event was handled.


onPROCPressed()

protected onPROCPressed(): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/UI/MFDUiPage.tsx:108

This method is called when a PROC button event occurs.

Returns

boolean

whether the event was handled.


onScrollToggled()

protected onScrollToggled(enabled): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:97

A method called when the control group scroll is toggled.

Parameters

ParameterTypeDescription
enabledbooleanif the scroll is enabled.

Returns

void

Inherited from

UiPage.onScrollToggled


onViewClosed()

protected onViewClosed(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/UI/MFDUiPage.tsx:114

Method to be overridden by view inheriting UiView to do something when the dialog opens.

Returns

void

Overrides

UiPage.onViewClosed


onViewOpened()

protected onViewOpened(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:169

Method to be overridden by view inheriting UiView to do something when the view opens.

Returns

void

Inherited from

UiPage.onViewOpened


onViewPaused()

protected onViewPaused(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiPage.tsx:67

Method to be overridden by view inheriting UiView to do something when the dialog opens.

Returns

void

Inherited from

UiPage.onViewPaused


onViewResumed()

protected onViewResumed(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiPage.tsx:62

Method to be overridden by view inheriting UiView to do something when the dialog opens.

Returns

void

Inherited from

UiPage.onViewResumed


open()

open(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiPage.tsx:40

Opens the page.

Returns

void

Inherited from

UiPage.open


pause()

pause(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:201

Pauses the view (usually only called by ViewService).

Returns

void

Inherited from

UiPage.pause


processHEvent()

processHEvent(evt): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:134

Handles HEvents and routes them to the subdialog when existant.

Parameters

ParameterTypeDescription
evtFmsHEventThe received event.

Returns

boolean

true if the event was handled in this control group, false otherwise.

Inherited from

UiPage.processHEvent


processScrollEvent()

protected processScrollEvent(evt): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiPage.tsx:52

Attempts to handle scroll events.

Parameters

ParameterTypeDescription
evtFmsHEventThe received event.

Returns

boolean

whether the event was handled.

Inherited from

UiPage.processScrollEvent


register()

protected register(ctrl, unregister): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:226

Register/Unregisters a UiControl with the scroll controller.

Parameters

ParameterTypeDefault valueDescription
ctrlScrollableControlundefinedThe UiControl to register.
unregisterbooleanfalseIndicates if the UiControl should be unregistered.

Returns

void

Inherited from

UiPage.register


render()

abstract render(): null | VNode

Defined in: sdk/components/FSComponent.ts:93

Renders the component.

Returns

null | VNode

A JSX element to be rendered.

Inherited from

UiPage.render


resume()

resume(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:208

Resumes the view (usually only called by ViewService).

Returns

void

Inherited from

UiPage.resume


routeEventToControl()

protected routeEventToControl(evt, control): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:176

Routes an interaction event to a UiControl.

Parameters

ParameterTypeDescription
evtFmsHEventAn interaction event.
controlUiControlThe UiControl to which to route the event.

Returns

boolean

Whether the event was handled by the UiControl.

Inherited from

UiPage.routeEventToControl


setInput()

setInput(input): this

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:97

Set data on this view.

Parameters

ParameterTypeDescription
inputanyThe input data.

Returns

this

This view instance for chain commands.

Inherited from

UiPage.setInput


setScrollEnabled()

setScrollEnabled(enabled): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:113

Sets the scroll enabled state

Parameters

ParameterTypeDescription
enabledbooleanindicating if scrolling should be enabled

Returns

void

Inherited from

UiPage.setScrollEnabled


setSoftkeyMenuHidden()

protected setSoftkeyMenuHidden(hide): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/UI/MFDUiPage.tsx:125

Sets whether the softkey menu is hidden.

Parameters

ParameterTypeDescription
hidebooleanWhether to hide the softkey menu.

Returns

void


setZIndex()

setZIndex(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiPage.tsx:47

This method has no effect.

Returns

void

Inherited from

UiPage.setZIndex


toggleScroll()

toggleScroll(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:104

Toggles the scroll highlighting

Returns

void

Inherited from

UiPage.toggleScroll