Abstract Class: UiControlGroup<T>

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

Ui control group

Extends

• DisplayComponent<T>

Extended by

• SelectApproach
• SelectDepArr
• TimeDistanceInput
• WaypointInput
• G1000UiControlWrapper
• List
• UiView
• MFDMapSettingsGroup
• MFDSelectProcedure
• NearestAirportItem

Type Parameters

Type Parameter	Default type
T extends UiControlGroupProps	UiControlGroupProps

Constructors

Constructor

new UiControlGroup<T>(props): UiControlGroup<T>

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

Parameters

Parameter	Type
props	T

Returns

UiControlGroup<T>

Inherit Doc

Overrides

DisplayComponent.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

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

DisplayComponent.contextType

---

focusSubject

protected focusSubject: Subject<boolean>

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

---

props

props: T & ComponentProps

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

The properties of the component.

Inherited from

DisplayComponent.props

---

scrollController

protected scrollController: ScrollController

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

Methods

blur()

blur(): void

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

Method to unfocus this control group

Returns

void

---

destroy()

destroy(): void

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

Destroys this component.

Returns

void

Inherited from

DisplayComponent.destroy

---

focus()

focus(dir): void

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

Method to focus this control group

Parameters

Parameter	Type	Default value	Description
dir	EntryDirection	'top'	The direction of entry.

Returns

void

---

getContext()

protected getContext(context): never

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

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

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

---

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

---

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

---

onAfterRender()

onAfterRender(node): void

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

A callback that is called after the component is rendered.

Parameters

Parameter	Type	Description
node	VNode	The component's VNode.

Returns

void

Inherited from

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

Overrides

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

---

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

---

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

Parameter	Type	Description
evt	FmsHEvent	The HEvenet.

Returns

boolean

true if the event was handled in this group

---

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

Parameter	Type	Description
enabled	boolean	if the scroll is enabled.

Returns

void

---

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

Parameter	Type	Description
evt	FmsHEvent	The received event.

Returns

boolean

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

---

processScrollEvent()

protected processScrollEvent(evt): boolean

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

---

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

Parameter	Type	Default value	Description
ctrl	ScrollableControl	undefined	The UiControl to register.
unregister	boolean	false	Indicates if the UiControl should be unregistered.

Returns

void

---

render()

abstract render(): VNode | null

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

Renders the component.

Returns

VNode | null

A JSX element to be rendered.

Inherited from

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

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.

---

setScrollEnabled()

setScrollEnabled(enabled): void

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

Sets the scroll enabled state

Parameters

Parameter	Type	Description
enabled	boolean	indicating if scrolling should be enabled

Returns

void

---

toggleScroll()

toggleScroll(): void

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

Toggles the scroll highlighting

Returns

void