Class: G1000UiControlWrapper
Wraps a G1000UiControl component to allow it to function in an original UiControl tree. If the wrapper has multiple G1000UiControl descendants, all will be rendered, but only the last one (in tree order) will be functional.
Hierarchy
↳
G1000UiControlWrapper
Constructors
constructor
• new G1000UiControlWrapper(props
): G1000UiControlWrapper
Parameters
Name | Type |
---|---|
props | UiControlGroupProps |
Returns
Inherit Doc
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:36
Properties
context
• Optional
context: [] = undefined
The context on this component, if any.
Inherited from
Defined in
sdk/components/FSComponent.ts:64
contextType
• Optional
Readonly
contextType: readonly [] = undefined
The type of context for this component, if any.
Inherited from
Defined in
sdk/components/FSComponent.ts:67
focusSubject
• Protected
focusSubject: Subject
<boolean
>
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:33
props
• props: UiControlGroupProps
& ComponentProps
The properties of the component.
Inherited from
Defined in
sdk/components/FSComponent.ts:61
scrollController
• Protected
scrollController: ScrollController
Inherited from
UiControlGroup.scrollController
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:32
Methods
blur
▸ blur(): void
Method to unfocus this control group
Returns
void
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:71
destroy
▸ destroy(): void
Destroys this component.
Returns
void
Inherited from
Defined in
sdk/components/FSComponent.ts:98
focus
▸ focus(dir?
): void
Method to focus this control group
Parameters
Name | Type | Default value | Description |
---|---|---|---|
dir | EntryDirection | 'top' | The direction of entry. |
Returns
void
Overrides
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/G1000UiControlWrapper.tsx:32
getContext
▸ getContext(context
): never
Gets a context data subscription from the context collection.
Parameters
Name | 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
Defined in
sdk/components/FSComponent.ts:106
getHighlightElement
▸ getHighlightElement(): null
| Element
This is just a dummy that exists here to be compatible with the union type of ScrollableControl
Returns
null
| Element
null
Inherited from
UiControlGroup.getHighlightElement
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:125
getIsFocusable
▸ getIsFocusable(): boolean
Gets a boolean indicating if this control is able to be focused.
Returns
boolean
true
Overrides
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/G1000UiControlWrapper.tsx:27
getIsFocused
▸ getIsFocused(): boolean
Method to check if this UiControlGroup is in focus
Returns
boolean
true if the control group is in focus, false otherwise
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:80
onAfterRender
▸ onAfterRender(thisNode
): void
A callback that is called after the component is rendered.
Parameters
Name | Type | Description |
---|---|---|
thisNode | VNode | The component's VNode. |
Returns
void
Overrides
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/G1000UiControlWrapper.tsx:15
onBeforeRender
▸ onBeforeRender(): void
Returns
void
Inherit Doc
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:51
onBlurred
▸ onBlurred(): void
A callback which is called when this control group is blurred.
Returns
void
Overrides
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/G1000UiControlWrapper.tsx:39
onFocused
▸ onFocused(): void
A callback which is called when this control group is focused.
Returns
void
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:237
onInteractionEvent
▸ onInteractionEvent(evt
): boolean
Handler for interaction events to be handled by the view.
Parameters
Name | Type | Description |
---|---|---|
evt | FmsHEvent | The HEvenet. |
Returns
boolean
true if the event was handled in this group
Inherited from
UiControlGroup.onInteractionEvent
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:217
onScrollToggled
▸ onScrollToggled(enabled
): void
A method called when the control group scroll is toggled.
Parameters
Name | Type | Description |
---|---|---|
enabled | boolean | if the scroll is enabled. |
Returns
void
Inherited from
UiControlGroup.onScrollToggled
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:97
processHEvent
▸ processHEvent(evt
): boolean
Handles HEvents and routes them to the subdialog when existant.
Parameters
Name | Type | Description |
---|---|---|
evt | FmsHEvent | The received event. |
Returns
boolean
true if the event was handled in this control group, false otherwise.
Overrides
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/G1000UiControlWrapper.tsx:44
processScrollEvent
▸ processScrollEvent(evt
): boolean
Attempts to handle scroll events.
Parameters
Name | Type | Description |
---|---|---|
evt | FmsHEvent | The received event. |
Returns
boolean
whether the event was handled.
Inherited from
UiControlGroup.processScrollEvent
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:196
register
▸ register(ctrl
, unregister?
): void
Register/Unregisters a UiControl with the scroll controller.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
ctrl | ScrollableControl | undefined | The UiControl to register. |
unregister | boolean | false | Indicates if the UiControl should be unregistered. |
Returns
void
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:226
render
▸ render(): VNode
Renders the component.
Returns
VNode
A JSX element to be rendered.
Overrides
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/G1000UiControlWrapper.tsx:53
routeEventToControl
▸ routeEventToControl(evt
, control
): boolean
Routes an interaction event to a UiControl.
Parameters
Name | Type | Description |
---|---|---|
evt | FmsHEvent | An interaction event. |
control | UiControl <UiControlProps > | The UiControl to which to route the event. |
Returns
boolean
Whether the event was handled by the UiControl.
Inherited from
UiControlGroup.routeEventToControl
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:176
setScrollEnabled
▸ setScrollEnabled(enabled
): void
Sets the scroll enabled state
Parameters
Name | Type | Description |
---|---|---|
enabled | boolean | indicating if scrolling should be enabled |
Returns
void
Inherited from
UiControlGroup.setScrollEnabled
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:113
toggleScroll
▸ toggleScroll(): void
Toggles the scroll highlighting
Returns
void
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:104