Skip to main content

Abstract Class: MFDMapSettingsGroup<P>

Defined in: workingtitle-instruments-g1000/html_ui/MFD/Components/UI/MapSettings/MFDMapSettingsGroup.tsx:27

A component which displays a group of controls to adjust map settings.

Extends​

Extended by​

Type Parameters​

Type Parameter
P extends MFDMapSettingsGroupProps

Constructors​

Constructor​

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

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:36

Parameters​

ParameterType
propsP

Returns​

MFDMapSettingsGroup<P>

Inherit Doc​

Inherited from​

UiControlGroup.constructor

Properties​

context?​

optional context: [] = undefined

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

The context on this component, if any.

Inherited from​

UiControlGroup.context


contextType?​

readonly optional contextType: readonly [] = undefined

Defined in: sdk/components/FSComponent.ts:70

The type of context for this component, if any.

Inherited from​

UiControlGroup.contextType


focusSubject​

protected focusSubject: Subject<boolean>

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:33

Inherited from​

UiControlGroup.focusSubject


props​

props: P & ComponentProps

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

The properties of the component.

Inherited from​

UiControlGroup.props


scrollController​

protected scrollController: ScrollController

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:32

Inherited from​

UiControlGroup.scrollController

Methods​

blur()​

blur(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:71

Method to unfocus this control group

Returns​

void

Inherited from​

UiControlGroup.blur


destroy()​

destroy(): void

Defined in: sdk/components/FSComponent.ts:101

Destroys this component.

Returns​

void

Inherited from​

UiControlGroup.destroy


focus()​

focus(dir): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:61

Method to focus this control group

Parameters​

ParameterTypeDefault valueDescription
dirEntryDirection'top'The direction of entry.

Returns​

void

Inherited from​

UiControlGroup.focus


getContext()​

protected getContext(context): never

Defined in: sdk/components/FSComponent.ts:109

Gets a context data subscription from the context collection.

Parameters​

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

Inherited from​

UiControlGroup.getContext


getHighlightElement()​

getHighlightElement(): Element | null

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:125

This is just a dummy that exists here to be compatible with the union type of ScrollableControl

Returns​

Element | null

null

Inherited from​

UiControlGroup.getHighlightElement


getIsFocusable()​

getIsFocusable(): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:88

Gets a boolean indicating if this control is able to be focused.

Returns​

boolean

true

Inherited from​

UiControlGroup.getIsFocusable


getIsFocused()​

getIsFocused(): boolean

Defined in: workingtitle-instruments-g1000/html_ui/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​

UiControlGroup.getIsFocused


getSettingRows()​

abstract protected getSettingRows(containerRef): VNode[]

Defined in: workingtitle-instruments-g1000/html_ui/MFD/Components/UI/MapSettings/MFDMapSettingsGroup.tsx:58

Gets an array of setting rows to render for this group.

Parameters​

ParameterTypeDescription
containerRefNodeReference<HTMLElement>A node reference to this group's root container.

Returns​

VNode[]


hide()​

hide(): void

Defined in: workingtitle-instruments-g1000/html_ui/MFD/Components/UI/MapSettings/MFDMapSettingsGroup.tsx:40

Hides this group.

Returns​

void


onAfterRender()​

onAfterRender(node): void

Defined in: sdk/components/FSComponent.ts:90

A callback that is called after the component is rendered.

Parameters​

ParameterTypeDescription
nodeVNodeThe component's VNode.

Returns​

void

Inherited from​

UiControlGroup.onAfterRender


onBeforeRender()​

onBeforeRender(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:51

A callback that is called before the component is rendered.

Returns​

void

Inherited from​

UiControlGroup.onBeforeRender


onBlurred()​

protected onBlurred(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:244

A callback which is called when this control group is blurred.

Returns​

void

Inherited from​

UiControlGroup.onBlurred


onFocused()​

protected onFocused(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:237

A callback which is called when this control group is focused.

Returns​

void

Inherited from​

UiControlGroup.onFocused


onInteractionEvent()​

onInteractionEvent(evt): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:217

Handler for interaction events to be handled by the view.

Parameters​

ParameterTypeDescription
evtFmsHEventThe 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/Shared/UI/UiControlGroup.tsx:97

A method called when the control group scroll is toggled.

Parameters​

ParameterTypeDescription
enabledbooleanif the scroll is enabled.

Returns​

void

Inherited from​

UiControlGroup.onScrollToggled


processHEvent()​

processHEvent(evt): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:134

Handles HEvents and routes them to the subdialog when existant.

Parameters​

ParameterTypeDescription
evtFmsHEventThe received event.

Returns​

boolean

true if the event was handled in this control group, false otherwise.

Inherited from​

UiControlGroup.processHEvent


processScrollEvent()​

protected processScrollEvent(evt): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:196

Attempts to handle scroll events.

Parameters​

ParameterTypeDescription
evtFmsHEventThe 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/Shared/UI/UiControlGroup.tsx:226

Register/Unregisters a UiControl with the scroll controller.

Parameters​

ParameterTypeDefault valueDescription
ctrlScrollableControlundefinedThe UiControl to register.
unregisterbooleanfalseIndicates if the UiControl should be unregistered.

Returns​

void

Inherited from​

UiControlGroup.register


render()​

render(): VNode

Defined in: workingtitle-instruments-g1000/html_ui/MFD/Components/UI/MapSettings/MFDMapSettingsGroup.tsx:45

Renders the component.

Returns​

VNode

A JSX element to be rendered.

Overrides​

UiControlGroup.render


routeEventToControl()​

protected routeEventToControl(evt, control): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:176

Routes an interaction event to a UiControl.

Parameters​

ParameterTypeDescription
evtFmsHEventAn interaction event.
controlUiControlThe 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/Shared/UI/UiControlGroup.tsx:113

Sets the scroll enabled state

Parameters​

ParameterTypeDescription
enabledbooleanindicating if scrolling should be enabled

Returns​

void

Inherited from​

UiControlGroup.setScrollEnabled


show()​

show(): void

Defined in: workingtitle-instruments-g1000/html_ui/MFD/Components/UI/MapSettings/MFDMapSettingsGroup.tsx:33

Shows this group.

Returns​

void


toggleScroll()​

toggleScroll(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:104

Toggles the scroll highlighting

Returns​

void

Inherited from​

UiControlGroup.toggleScroll