Class: G1000UiControlWrapper
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/G1000UiControlWrapper.tsx:11
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.
Extends
Constructors
Constructor
new G1000UiControlWrapper(
props
):G1000UiControlWrapper
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:36
Parameters
Parameter | Type |
---|---|
props | UiControlGroupProps |
Returns
G1000UiControlWrapper
Inherit Doc
Inherited from
Properties
context?
optional
context: [] =undefined
Defined in: sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
contextType?
readonly
optional
contextType: readonly [] =undefined
Defined in: sdk/components/FSComponent.ts:67
The type of context for this component, if any.
Inherited from
focusSubject
protected
focusSubject:Subject
<boolean
>
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:33
Inherited from
props
props:
UiControlGroupProps
&ComponentProps
Defined in: sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
scrollController
protected
scrollController:ScrollController
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:32
Inherited from
UiControlGroup
.scrollController
Methods
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
destroy()
destroy():
void
Defined in: sdk/components/FSComponent.ts:98
Destroys this component.
Returns
void
Inherited from
focus()
focus(
dir
):void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/G1000UiControlWrapper.tsx:32
Method to focus this control group
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
dir | EntryDirection | 'top' | The direction of entry. |
Returns
void
Overrides
getContext()
protected
getContext(context
):never
Defined in: 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
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
UiControlGroup
.getHighlightElement
getIsFocusable()
getIsFocusable():
boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/G1000UiControlWrapper.tsx:27
Gets a boolean indicating if this control is able to be focused.
Returns
boolean
true
Overrides
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
onAfterRender()
onAfterRender(
thisNode
):void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/G1000UiControlWrapper.tsx:15
A callback that is called after the component is rendered.
Parameters
Parameter | Type | Description |
---|---|---|
thisNode | VNode | The component's VNode. |
Returns
void
Overrides
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
onBlurred()
protected
onBlurred():void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/G1000UiControlWrapper.tsx:39
A callback which is called when this control group is blurred.
Returns
void
Overrides
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
onInteractionEvent()
onInteractionEvent(
evt
):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:217
Handler for interaction events to be handled by the view.
Parameters
Parameter | Type | Description |
---|---|---|
evt | FmsHEvent | The HEvenet. |
Returns
boolean
true if the event was handled in this group
Inherited from
UiControlGroup
.onInteractionEvent
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
Parameter | Type | Description |
---|---|---|
enabled | boolean | if the scroll is enabled. |
Returns
void
Inherited from
UiControlGroup
.onScrollToggled
processHEvent()
processHEvent(
evt
):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/G1000UiControlWrapper.tsx:44
Handles HEvents and routes them to the subdialog when existant.
Parameters
Parameter | Type | Description |
---|---|---|
evt | FmsHEvent | The received event. |
Returns
boolean
true if the event was handled in this control group, false otherwise.
Overrides
processScrollEvent()
protected
processScrollEvent(evt
):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:196
Attempts to handle scroll events.
Parameters
Parameter | Type | Description |
---|---|---|
evt | FmsHEvent | The received event. |
Returns
boolean
whether the event was handled.
Inherited from
UiControlGroup
.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
Parameter | 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
render()
render():
VNode
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/G1000UiControlWrapper.tsx:53
Renders the component.
Returns
VNode
A JSX element to be rendered.
Overrides
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
Parameter | Type | Description |
---|---|---|
evt | FmsHEvent | An interaction event. |
control | UiControl | The UiControl to which to route the event. |
Returns
boolean
Whether the event was handled by the UiControl.
Inherited from
UiControlGroup
.routeEventToControl
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
Parameter | Type | Description |
---|---|---|
enabled | boolean | indicating if scrolling should be enabled |
Returns
void
Inherited from
UiControlGroup
.setScrollEnabled
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