Class: MfdPageContainer

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/MfdPageContainer.tsx:63

A container for MFD pages.

Extends

• DisplayComponent<MfdPageContainerProps>

Implements

• UiInteractionHandler

Constructors

Constructor

new MfdPageContainer(props): MfdPageContainer

Defined in: src/sdk/components/FSComponent.ts:73

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	MfdPageContainerProps	The propertis of the component.

Returns

MfdPageContainer

Inherited from

DisplayComponent<MfdPageContainerProps>.constructor

Properties

activePageEntry

readonly activePageEntry: Subscribable<null | MfdPageEntry>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/MfdPageContainer.tsx:85

This container's current active page, or null if there is no active page.

---

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

DisplayComponent.context

---

contextType?

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from

DisplayComponent.contextType

---

props

props: MfdPageContainerProps & ComponentProps

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

The properties of the component.

Inherited from

DisplayComponent.props

---

stagedPageEntry

readonly stagedPageEntry: Subscribable<null | MfdPageEntry>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/MfdPageContainer.tsx:81

This container's current staged page, or null if there is no staged page.

Methods

destroy()

destroy(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/MfdPageContainer.tsx:507

Returns

void

Inherit Doc

Overrides

DisplayComponent.destroy

---

getContext()

protected getContext(context): never

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

Gets a context data subscription from the context collection.

Parameters

Parameter	Type	Description
context	never	The 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

DisplayComponent.getContext

---

isAwake()

isAwake(): boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/MfdPageContainer.tsx:122

Checks whether this container is awake.

Returns

boolean

Whether this container is awake.

---

isResumed()

isResumed(): boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/MfdPageContainer.tsx:130

Checks whether this container is resumed.

Returns

boolean

Whether this container is resumed.

---

onAfterRender()

onAfterRender(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/MfdPageContainer.tsx:107

Returns

void

Inherit Doc

Overrides

DisplayComponent.onAfterRender

---

onBeforeRender()

onBeforeRender(): void

Defined in: src/sdk/components/FSComponent.ts:80

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayComponent.onBeforeRender

---

onUiInteractionEvent()

onUiInteractionEvent(event): boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/MfdPageContainer.tsx:354

Handles a UiInteractionEvent.

Parameters

Parameter	Type	Description
event	UiInteractionEvent	The event to handle.

Returns

boolean

Whether the event was handled.

Implementation of

UiInteractionHandler.onUiInteractionEvent

---

pause()

pause(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/MfdPageContainer.tsx:203

Pauses this container. This will pause the active page (if one exists). Has no effect if this container is asleep.

Returns

void

Throws

Error if this container has been destroyed.

---

render()

render(): VNode

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/MfdPageContainer.tsx:491

Returns

VNode

Inherit Doc

Overrides

DisplayComponent.render

---

resume()

resume(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/MfdPageContainer.tsx:180

Resumes this container. This will resume the active page (if one exists). Has no effect if this container is asleep.

Returns

void

Throws

Error if this container has been destroyed.

---

setOcclusion()

setOcclusion(occlusionType): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/MfdPageContainer.tsx:251

Sets the type of occlusion applied to this container's parent UI view.

Parameters

Parameter	Type	Description
occlusionType	UiViewOcclusionType	The type of occlusion to set.

Returns

void

Throws

Error if this container has been destroyed.

---

setSize()

setSize(sizeMode, dimensions): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/MfdPageContainer.tsx:226

Sets the size of this container.

Parameters

Parameter	Type	Description
sizeMode	MfdPageSizeMode	The new size mode.
dimensions	ReadonlyFloat64Array	The new dimensions, as [width, height] in pixels.

Returns

void

Throws

Error if this container has been destroyed.

---

sleep()

sleep(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/MfdPageContainer.tsx:156

Puts this container to sleep. This will pause and close the active page (if one exists).

Returns

void

Throws

Error if this container has been destroyed.

---

update()

update(time): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/MfdPageContainer.tsx:266

Updates this container.

Parameters

Parameter	Type	Description
time	number	The current real (operating system) time, as a Javascript timestamp in milliseconds.

Returns

void

Throws

Error if this container has been destroyed.

---

wake()

wake(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/MfdPageContainer.tsx:138

Wakes this container. This will open the active page (if one exists).

Returns

void

Throws

Error if this container has been destroyed.