Skip to main content

Class: AbstractUiView<P>

An abstract implementation of UiView.

Type parameters

NameType
Pextends UiViewProps = UiViewProps

Hierarchy

Implements

Constructors

constructor

new AbstractUiView<P>(props): AbstractUiView<P>

Creates an instance of a DisplayComponent.

Type parameters

NameType
Pextends UiViewProps = UiViewProps

Parameters

NameTypeDescription
propsPThe propertis of the component.

Returns

AbstractUiView<P>

Inherited from

DisplayComponent<P>.constructor

Defined in

src/sdk/components/FSComponent.ts:73

Properties

_knobLabelState

Protected Readonly _knobLabelState: FilteredMapSubject<UiKnobId, string>

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/AbstractUiView.ts:13


context

Optional context: [] = undefined

The context on this component, if any.

Implementation of

UiView.context

Inherited from

DisplayComponent.context

Defined in

src/sdk/components/FSComponent.ts:64


contextType

Optional Readonly contextType: readonly [] = undefined

The type of context for this component, if any.

Implementation of

UiView.contextType

Inherited from

DisplayComponent.contextType

Defined in

src/sdk/components/FSComponent.ts:67


focusController

Protected Readonly focusController: UiFocusController

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/AbstractUiView.ts:17


knobLabelState

Readonly knobLabelState: SubscribableMap<UiKnobId, string> & Subscribable<UiKnobRequestedLabelState>

The bezel rotary knob label state requested by this view.

Implementation of

UiView.knobLabelState

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/AbstractUiView.ts:15


props

props: P & ComponentProps

The properties of the component.

Implementation of

UiView.props

Inherited from

DisplayComponent.props

Defined in

src/sdk/components/FSComponent.ts:61

Methods

createFocusController

createFocusController(): UiFocusController

Creates a new focus controller for this view.

Returns

UiFocusController

A new focus controller.

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/AbstractUiView.ts:23


destroy

destroy(): void

Destroys this component.

Returns

void

Implementation of

UiView.destroy

Overrides

DisplayComponent.destroy

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/AbstractUiView.ts:72


getContext

getContext(context): never

Gets a context data subscription from the context collection.

Parameters

NameTypeDescription
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.

Implementation of

UiView.getContext

Inherited from

DisplayComponent.getContext

Defined in

src/sdk/components/FSComponent.ts:106


onAfterRender

onAfterRender(node): void

A callback that is called after the component is rendered.

Parameters

NameTypeDescription
nodeVNodeThe component's VNode.

Returns

void

Implementation of

UiView.onAfterRender

Inherited from

DisplayComponent.onAfterRender

Defined in

src/sdk/components/FSComponent.ts:87


onBeforeRender

onBeforeRender(): void

A callback that is called before the component is rendered.

Returns

void

Implementation of

UiView.onBeforeRender

Inherited from

DisplayComponent.onBeforeRender

Defined in

src/sdk/components/FSComponent.ts:80


onClose

onClose(): void

Responds to when this view is closed.

Returns

void

Implementation of

UiView.onClose

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/AbstractUiView.ts:34


onOcclusionChange

onOcclusionChange(occlusionType): void

Responds to when the occlusion type applied to this view changes while this view is open.

Parameters

NameTypeDescription
occlusionTypeUiViewOcclusionTypeThe new occlusion type applied to this view.

Returns

void

Implementation of

UiView.onOcclusionChange

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/AbstractUiView.ts:56


onOpen

onOpen(sizeMode, dimensions): void

Responds to when this view is opened.

Parameters

NameTypeDescription
sizeModeUiViewSizeModeThe new size mode of this view's container.
dimensionsReadonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>The new dimensions of this view's container, as [width, height] in pixels.

Returns

void

Implementation of

UiView.onOpen

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/AbstractUiView.ts:29


onPause

onPause(): void

Responds to when this view is paused.

Returns

void

Implementation of

UiView.onPause

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/AbstractUiView.ts:44


onResize

onResize(sizeMode, dimensions): void

Responds when this view's container is resized while it is open.

Parameters

NameTypeDescription
sizeModeUiViewSizeModeThe new size mode of this view's container.
dimensionsReadonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>The new dimensions of this view's container, as [width, height] in pixels.

Returns

void

Implementation of

UiView.onResize

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/AbstractUiView.ts:50


onResume

onResume(): void

Responds to when this view is resumed.

Returns

void

Implementation of

UiView.onResume

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/AbstractUiView.ts:39


onUiInteractionEvent

onUiInteractionEvent(event): boolean

Handles a UiInteractionEvent.

Parameters

NameTypeDescription
eventUiInteractionEventThe event to handle.

Returns

boolean

Whether the event was handled.

Implementation of

UiView.onUiInteractionEvent

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/AbstractUiView.ts:67


onUpdate

onUpdate(time): void

Called every update cycle.

Parameters

NameTypeDescription
timenumberThe current real (operating system) time, as a Javascript timestamp.

Returns

void

Implementation of

UiView.onUpdate

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/AbstractUiView.ts:62


render

render(): null | VNode

Renders the component.

Returns

null | VNode

A JSX element to be rendered.

Implementation of

UiView.render

Inherited from

DisplayComponent.render

Defined in

src/sdk/components/FSComponent.ts:93