Abstract Class: AbstractUiView<P>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/AbstractUiView.ts:12
An abstract implementation of UiView.
Extends
DisplayComponent
<P
>
Extended by
Gdu460PfdInstrumentsView
PfdMapView
RadioVolumeShortcutPopup
AbstractUiNumberDialog
UiListDialog
UiMessageDialog
MfdFplPageDataFieldSelectDialog
MfdFplOptionsPopup
MfdMapOptionsPopup
MfdMapSetupPopup
MfdTrafficOptionsPopup
MfdWaypointMapPopup
MfdMainView
MfdNrstAirportOptionsPopup
MfdNrstView
AfcsControlsView
ApproachDialog
AudioPopup
AudioRadiosPopup
BacklightIntensityPopup
DataBarFieldEditView
DataBarFieldSelectDialog
DataBarSetupView
DirectToView
DisplaySetupView
MainMenuView
MfdRadioVolumePopup
NoOptionsPopup
MfdPageSelectDialog
PfdOptionsView
PfdSetupView
SelectRadioDialog
SetupView
SoundSetupView
StartupView
TimeSetupView
TransponderView
UnitsSetupView
DuplicateWaypointDialog
WaypointDialog
WaypointInfoPopup
GenericUiView
UserTimerView
Type Parameters
Type Parameter | Default type |
---|---|
P extends UiViewProps | UiViewProps |
Implements
UiView
<P
>
Constructors
Constructor
new AbstractUiView<
P
>(props
):AbstractUiView
<P
>
Defined in: src/sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | P | The propertis of the component. |
Returns
AbstractUiView
<P
>
Inherited from
DisplayComponent<P>.constructor
Properties
_knobLabelState
protected
readonly
_knobLabelState:FilteredMapSubject
<UiKnobId
,string
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/AbstractUiView.ts:13
context?
optional
context: [] =undefined
Defined in: src/sdk/components/FSComponent.ts:64
The context on this component, if any.
Implementation of
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.
Implementation of
Inherited from
DisplayComponent.contextType
focusController
protected
readonly
focusController:UiFocusController
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/AbstractUiView.ts:17
knobLabelState
readonly
knobLabelState:SubscribableMap
<UiKnobId
,string
> &Subscribable
<UiKnobRequestedLabelState
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/AbstractUiView.ts:15
The bezel rotary knob label state requested by this view.
Implementation of
props
props:
P
&ComponentProps
Defined in: src/sdk/components/FSComponent.ts:61
The properties of the component.
Implementation of
Inherited from
DisplayComponent.props
Methods
createFocusController()
protected
createFocusController():UiFocusController
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/AbstractUiView.ts:23
Creates a new focus controller for this view.
Returns
A new focus controller.
destroy()
destroy():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/AbstractUiView.ts:72
Destroys this component.
Returns
void
Implementation of
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.
Implementation of
Inherited from
DisplayComponent.getContext
onAfterRender()
onAfterRender(
node
):void
Defined in: src/sdk/components/FSComponent.ts:87
A callback that is called after the component is rendered.
Parameters
Parameter | Type | Description |
---|---|---|
node | VNode | The component's VNode. |
Returns
void
Implementation of
Inherited from
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
Implementation of
Inherited from
DisplayComponent.onBeforeRender
onClose()
onClose():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/AbstractUiView.ts:34
Responds to when this view is closed.
Returns
void
Implementation of
onOcclusionChange()
onOcclusionChange(
occlusionType
):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/AbstractUiView.ts:56
Responds to when the occlusion type applied to this view changes while this view is open.
Parameters
Parameter | Type | Description |
---|---|---|
occlusionType | UiViewOcclusionType | The new occlusion type applied to this view. |
Returns
void
Implementation of
onOpen()
onOpen(
sizeMode
,dimensions
):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/AbstractUiView.ts:29
Responds to when this view is opened.
Parameters
Parameter | Type | Description |
---|---|---|
sizeMode | UiViewSizeMode | The new size mode of this view's container. |
dimensions | ReadonlyFloat64Array | The new dimensions of this view's container, as [width, height] in pixels. |
Returns
void
Implementation of
onPause()
onPause():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/AbstractUiView.ts:44
Responds to when this view is paused.
Returns
void
Implementation of
onResize()
onResize(
sizeMode
,dimensions
):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/AbstractUiView.ts:50
Responds when this view's container is resized while it is open.
Parameters
Parameter | Type | Description |
---|---|---|
sizeMode | UiViewSizeMode | The new size mode of this view's container. |
dimensions | ReadonlyFloat64Array | The new dimensions of this view's container, as [width, height] in pixels. |
Returns
void
Implementation of
onResume()
onResume():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/AbstractUiView.ts:39
Responds to when this view is resumed.
Returns
void
Implementation of
onUiInteractionEvent()
onUiInteractionEvent(
event
):boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/AbstractUiView.ts:67
Handles a UiInteractionEvent.
Parameters
Parameter | Type | Description |
---|---|---|
event | UiInteractionEvent | The event to handle. |
Returns
boolean
Whether the event was handled.
Implementation of
onUpdate()
onUpdate(
time
):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/AbstractUiView.ts:62
Called every update cycle.
Parameters
Parameter | Type | Description |
---|---|---|
time | number | The current real (operating system) time, as a Javascript timestamp. |
Returns
void
Implementation of
render()
abstract
render():null
|VNode
Defined in: src/sdk/components/FSComponent.ts:93
Renders the component.
Returns
null
| VNode
A JSX element to be rendered.
Implementation of
Inherited from
DisplayComponent.render