Skip to main content

Class: G1000UiControl<P>

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:24

A component that forms the base of the G1000 UI control system.

Extends

Extended by

Type Parameters

Type ParameterDefault type
P extends G1000UiControlPropsG1000UiControlProps

Implements

Constructors

Constructor

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

Defined in: sdk/components/controls/HardwareUiControl.tsx:155

Creates an instance of a HardwareUiControl.

Parameters

ParameterTypeDescription
propsPThe props for this component.

Returns

G1000UiControl<P>

Inherited from

HardwareUiControl<FmsUiControlEvents, P>.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

HardwareUiControl.context


contextType?

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from

HardwareUiControl.contextType


focusedIndex

protected focusedIndex: number = -1

Defined in: sdk/components/controls/HardwareUiControl.tsx:139

Inherited from

HardwareUiControl.focusedIndex


props

props: P & ComponentProps

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

The properties of the component.

Inherited from

HardwareUiControl.props


registeredControls

protected registeredControls: undefined | HardwareUiControl<FmsUiControlEvents, HardwareUiControlProps>[]

Defined in: sdk/components/controls/HardwareUiControl.tsx:137

Inherited from

HardwareUiControl.registeredControls

Accessors

isDisabled

Get Signature

get isDisabled(): boolean

Defined in: sdk/components/controls/HardwareUiControl.tsx:177

Gets whether or not the control is currently disabled.

Returns

boolean

True if disabled, false otherwise.

Inherited from

HardwareUiControl.isDisabled


isFocused

Get Signature

get isFocused(): boolean

Defined in: sdk/components/controls/HardwareUiControl.tsx:185

Gets whether or not the control is currently focused.

Returns

boolean

True if disabled, false otherwise.

Inherited from

HardwareUiControl.isFocused


isIsolated

Get Signature

get isIsolated(): boolean

Defined in: sdk/components/controls/HardwareUiControl.tsx:193

Gets whether or not the control is currently in scroll isolation.

Returns

boolean

True if currently in scroll isolation, false otherwise.

Inherited from

HardwareUiControl.isIsolated


length

Get Signature

get length(): number

Defined in: sdk/components/controls/HardwareUiControl.tsx:165

Gets the current number of registered child controls.

Returns

number

The current number of registered child controls.

Inherited from

HardwareUiControl.length

Methods

blur()

blur(): void

Defined in: sdk/components/controls/HardwareUiControl.tsx:593

Blurs, or removes focus, from the component.

Returns

void

Inherited from

HardwareUiControl.blur


clearRegistered()

clearRegistered(): void

Defined in: sdk/components/controls/HardwareUiControl.tsx:793

Clears the list of registered components.

Returns

void

Inherited from

HardwareUiControl.clearRegistered


consolidateKeyboardHEvent()

consolidateKeyboardHEvent(source, evt): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:677

Consolidates all key events and allows sub classes to override and implement specific keyboard input behaviors.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.
evtFmsHEventFmsHEvent of the keyboard event.

Returns

boolean

always false for the top level version of the method.


destroy()

destroy(): void

Defined in: sdk/components/controls/HardwareUiControl.tsx:923

Returns

void

Inherit Doc

Inherited from

HardwareUiControl.destroy


focus()

focus(focusPosition): boolean

Defined in: sdk/components/controls/HardwareUiControl.tsx:410

Brings focus to the control. Focusing the control will also blur the currently focused control, if any.

Parameters

ParameterTypeDescription
focusPositionFocusPositionThe focus position to activate for descendents of this control.

Returns

boolean

Whether this control was successfully focused.

Inherited from

HardwareUiControl.focus


getChild()

getChild(index): undefined | HardwareUiControl<FmsUiControlEvents, HardwareUiControlProps>

Defined in: sdk/components/controls/HardwareUiControl.tsx:859

Gets a child control at the specified index.

Parameters

ParameterTypeDescription
indexnumberThe index of the child control to get.

Returns

undefined | HardwareUiControl<FmsUiControlEvents, HardwareUiControlProps>

The specified child control.

Inherited from

HardwareUiControl.getChild


getContext()

protected getContext(context): never

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

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

HardwareUiControl.getContext


getFocusedIndex()

getFocusedIndex(): number

Defined in: sdk/components/controls/HardwareUiControl.tsx:824

Gets the current focused index in the registered controls collection.

Returns

number

The index of the focused control in the collection of registered controls.

Inherited from

HardwareUiControl.getFocusedIndex


getFocusPositionOnScroll()

protected getFocusPositionOnScroll(direction): FocusPosition

Defined in: sdk/components/controls/HardwareUiControl.tsx:250

Gets the focus position to apply when this control is focused from a scroll.

Parameters

ParameterTypeDescription
directionScrollDirectionThe direction of the scroll.

Returns

FocusPosition

The focus position to apply when this control is focused from a scroll.

Inherited from

HardwareUiControl.getFocusPositionOnScroll


getMostRecentFocusedIndex()

getMostRecentFocusedIndex(): number

Defined in: sdk/components/controls/HardwareUiControl.tsx:833

Gets the most recent focused index (including the current focused index, if one exists) in the registered controls collection.

Returns

number

The index of the most recently focused control in the collection of registered controls.

Inherited from

HardwareUiControl.getMostRecentFocusedIndex


indexOf()

indexOf(child): number

Defined in: sdk/components/controls/HardwareUiControl.tsx:873

Gets the index of a specified child control within the registered child controls collection.

Parameters

ParameterTypeDescription
childHardwareUiControl<FmsUiControlEvents>The child to get the index of.

Returns

number

The index of the child, or -1 if not found.

Inherited from

HardwareUiControl.indexOf


on0()

on0(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:514

Handles the 0 key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.on0


on1()

on1(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:523

Handles the 1 key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.on1


on2()

on2(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:532

Handles the 2 key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.on2


on3()

on3(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:541

Handles the 3 key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.on3


on4()

on4(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:550

Handles the 4 key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.on4


on5()

on5(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:559

Handles the 5 key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.on5


on6()

on6(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:568

Handles the 6 key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.on6


on7()

on7(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:577

Handles the 7 key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.on7


on8()

on8(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:586

Handles the 8 key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.on8


on9()

on9(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:595

Handles the 9 key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.on9


onA()

onA(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:271

Handles the A key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onA


onAfterRender()

onAfterRender(thisNode): void

Defined in: sdk/components/controls/HardwareUiControl.tsx:900

Parameters

ParameterType
thisNodeVNode

Returns

void

Inherit Doc

Inherited from

HardwareUiControl.onAfterRender


onAfterScroll()

protected onAfterScroll(control, index): void

Defined in: sdk/components/controls/HardwareUiControl.tsx:284

An event called when a scroll operation has completed.

Parameters

ParameterTypeDescription
controlHardwareUiControl<FmsUiControlEvents>The control that was scrolled to.
indexnumberThe index of the control in the collection of registered controls.

Returns

void

Inherited from

HardwareUiControl.onAfterScroll


onB()

onB(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:280

Handles the B key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onB


onBeforeRender()

onBeforeRender(): void

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

A callback that is called before the component is rendered.

Returns

void

Inherited from

HardwareUiControl.onBeforeRender


onBKSP()

onBKSP(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:613

Handles the BKSP key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onBKSP


onBlurred()

protected onBlurred(source): void

Defined in: sdk/components/controls/HardwareUiControl.tsx:209

An event called when the control is blurred.

Parameters

ParameterTypeDescription
sourceHardwareUiControl<FmsUiControlEvents>The control that emitted this event.

Returns

void

Inherited from

HardwareUiControl.onBlurred


onC()

onC(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:289

Handles the C key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onC


onClr()

onClr(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:163

Handles CLR button press events.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onClr


onClrLong()

onClrLong(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:172

Handles CLR button long press events.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onClrLong


onCom()

onCom(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:640

Handles the COM key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onCom


onCrs()

onCrs(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:667

Handles the CRS key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onCrs


onD()

onD(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:298

Handles the D key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onD


onDirectTo()

onDirectTo(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:181

Handles DRCT button press events.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onDirectTo


onDisabled()

protected onDisabled(source): void

Defined in: sdk/components/controls/HardwareUiControl.tsx:225

An event called when the control is disabled.

Parameters

ParameterTypeDescription
sourceHardwareUiControl<FmsUiControlEvents>The control that emitted this event.

Returns

void

Inherited from

HardwareUiControl.onDisabled


onDot()

onDot(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:604

Handles the Dot key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onDot


onE()

onE(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:307

Handles the E key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onE


onEnabled()

protected onEnabled(source): void

Defined in: sdk/components/controls/HardwareUiControl.tsx:217

An event called when the control is enabled.

Parameters

ParameterTypeDescription
sourceHardwareUiControl<FmsUiControlEvents>The control that emitted this event.

Returns

void

Inherited from

HardwareUiControl.onEnabled


onEnter()

onEnter(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:154

Handles ENTER button press events.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onEnter


onF()

onF(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:316

Handles the F key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onF


onFocused()

protected onFocused(source): void

Defined in: sdk/components/controls/HardwareUiControl.tsx:201

An event called when the control receives focus.

Parameters

ParameterTypeDescription
sourceHardwareUiControl<FmsUiControlEvents>The control that emitted this event.

Returns

void

Inherited from

HardwareUiControl.onFocused


onFPL()

onFPL(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:190

Handles FPL button press events.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onFPL


onG()

onG(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:325

Handles the G key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onG


onH()

onH(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:334

Handles the H key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onH


onHome()

onHome(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:631

Handles the Home key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onHome


onI()

onI(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:343

Handles the I key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onI


onInnerControlKnobDec()

onInnerControlKnobDec(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:100

Handles Inner Control Knob decrease events.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onInnerControlKnobDec


onInnerControlKnobInc()

onInnerControlKnobInc(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:109

Handles Inner Control Knob increase events.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onInnerControlKnobInc


onInnerControlKnobPush()

onInnerControlKnobPush(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:118

Handles Inner Control Knob push events.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onInnerControlKnobPush


onInteractionEvent()

onInteractionEvent(evt): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:29

Parameters

ParameterType
evtFmsHEvent

Returns

boolean

Inherit Doc

Overrides

HardwareUiControl.onInteractionEvent


onJ()

onJ(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:352

Handles the J key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onJ


onJoystickDown()

onJoystickDown(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:262

Handles range joystick down deflection events.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onJoystickDown


onJoystickLeft()

onJoystickLeft(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:235

Handles range joystick left deflection events.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onJoystickLeft


onJoystickPush()

onJoystickPush(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:226

Handles range joystick push events.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onJoystickPush


onJoystickRight()

onJoystickRight(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:253

Handles range joystick right deflection events.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onJoystickRight


onJoystickUp()

onJoystickUp(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:244

Handles range joystick up deflection events.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onJoystickUp


onK()

onK(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:361

Handles the K key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onK


onL()

onL(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:370

Handles the L key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onL


onLowerKnobDec()

onLowerKnobDec(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:82

Handles FMS lower knob decrease events.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onLowerKnobDec


onLowerKnobInc()

onLowerKnobInc(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:73

Handles FMS lower knob increase events.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onLowerKnobInc


onM()

onM(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:379

Handles the M key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onM


onMenu()

onMenu(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:145

Handles MENU button press events.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onMenu


onN()

onN(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:388

Handles the N key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onN


onNav()

onNav(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:649

Handles the NAV key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onNav


onO()

onO(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:397

Handles the O key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onO


onOuterControlKnobDec()

onOuterControlKnobDec(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:127

Handles Outer Control Knob decrease events.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onOuterControlKnobDec


onOuterControlKnobInc()

onOuterControlKnobInc(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:136

Handles Outer Control Knob increase events.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onOuterControlKnobInc


onP()

onP(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:406

Handles the P key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onP


onPlusMinus()

onPlusMinus(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:622

Handles the +/- key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onPlusMinus


onProc()

onProc(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:199

Handles PROC button press events.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onProc


onQ()

onQ(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:415

Handles the Q key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onQ


onR()

onR(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:424

Handles the R key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onR


onRangeDec()

onRangeDec(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:217

Handles range joystick decrease events.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onRangeDec


onRangeInc()

onRangeInc(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:208

Handles range joystick increase events.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onRangeInc


onRegistered()

protected onRegistered(source): void

Defined in: sdk/components/controls/HardwareUiControl.tsx:233

An event called when a control is registered with this control.

Parameters

ParameterTypeDescription
sourceHardwareUiControl<FmsUiControlEvents>The control that emitted this event.

Returns

void

Inherited from

HardwareUiControl.onRegistered


onS()

onS(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:433

Handles the S key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onS


onScroll()

protected onScroll(direction): boolean

Defined in: sdk/components/controls/HardwareUiControl.tsx:263

An event called when the control is scrolled.

Parameters

ParameterTypeDescription
directionScrollDirectionThe direction that is being requested to scroll.

Returns

boolean

True if this control handled this event, false otherwise.

Inherited from

HardwareUiControl.onScroll


onSPC()

onSPC(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:505

Handles the key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onSPC


onT()

onT(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:442

Handles the T key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onT


onU()

onU(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:451

Handles the U key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onU


onUnregistered()

protected onUnregistered(source): void

Defined in: sdk/components/controls/HardwareUiControl.tsx:241

An event called when a control is unregistered from this control.

Parameters

ParameterTypeDescription
sourceHardwareUiControl<FmsUiControlEvents>The control that emitted this event.

Returns

void

Inherited from

HardwareUiControl.onUnregistered


onUpperKnobDec()

onUpperKnobDec(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:64

Handles FMS upper knob decrease events.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onUpperKnobDec


onUpperKnobInc()

onUpperKnobInc(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:55

Handles FMS upper knob increase events.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onUpperKnobInc


onUpperKnobPush()

onUpperKnobPush(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:91

Handles FMS upper knob push events.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onUpperKnobPush


onV()

onV(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:460

Handles the V key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onV


onW()

onW(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:469

Handles the W key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onW


onX()

onX(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:478

Handles the X key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onX


onXpdr()

onXpdr(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:658

Handles the XPDR key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onXpdr


onY()

onY(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:487

Handles the Y key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onY


onZ()

onZ(source): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:496

Handles the Z key.

Parameters

ParameterTypeDescription
sourceG1000UiControlThe source of the event.

Returns

boolean

Whether the event was handled.

Implementation of

UiControlEventHandlers.onZ


reconcileChildBlur()

protected reconcileChildBlur(index, child): number | BlurReconciliation

Defined in: sdk/components/controls/HardwareUiControl.tsx:688

Reconciles the focus state of this control's children when this control is focused with no focused children after a child has been blurred.

Parameters

ParameterTypeDescription
indexnumberThe index of the child control that was blurred. If the child is no longer registered, then this is the index of the child prior to being unregistered.
childHardwareUiControl<FmsUiControlEvents>The child control that was blurred.

Returns

number | BlurReconciliation

The index of the child control to focus.

Inherited from

HardwareUiControl.reconcileChildBlur


register()

register(control, index?): void

Defined in: sdk/components/controls/HardwareUiControl.tsx:722

Registers a child control with this control.

Parameters

ParameterTypeDescription
controlHardwareUiControl<FmsUiControlEvents>The control to register.
index?numberThe index at which to register the control. If none is provided, the control will be registered at the end of the collection of child controls.

Returns

void

Inherited from

HardwareUiControl.register


render()

render(): VNode

Defined in: sdk/components/controls/HardwareUiControl.tsx:916

Renders the control.

Returns

VNode

The component VNode.

Inherited from

HardwareUiControl.render


scroll()

scroll(direction): boolean

Defined in: sdk/components/controls/HardwareUiControl.tsx:293

Scrolls the currently focused control in the supplied direction.

Parameters

ParameterTypeDescription
directionScrollDirectionThe direction that is being requested to scroll.

Returns

boolean

True if propagation should be stopped, false otherwise.

Inherited from

HardwareUiControl.scroll


setDisabled()

setDisabled(isDisabled): void

Defined in: sdk/components/controls/HardwareUiControl.tsx:705

Sets the component to be disabled, removing the ability for the component to scroll. Setting a component to disabled will also blur the component and its children, if necessary.

Parameters

ParameterTypeDescription
isDisabledbooleanWhether or not the component is disabled.

Returns

void

Inherited from

HardwareUiControl.setDisabled


setFocusedIndex()

setFocusedIndex(index, focusPosition): void

Defined in: sdk/components/controls/HardwareUiControl.tsx:843

Sets the current most recently focused child control index. If this control is focused and has children that have focus, this will also switch child focus to the new index.

Parameters

ParameterTypeDefault valueDescription
indexnumberundefinedThe index of the child control to set most recent focus for.
focusPositionFocusPositionFocusPosition.MostRecentThe focus position to focus the child for, if required.

Returns

void

Inherited from

HardwareUiControl.setFocusedIndex


setIsolated()

setIsolated(isolated): void

Defined in: sdk/components/controls/HardwareUiControl.tsx:895

Sets whether or not this control is in scroll isolation. While scroll isolation is enabled, scroll events will not propagate to the control's parent when the control has focus.

Parameters

ParameterTypeDescription
isolatedbooleanWhether or not the control is isolated.

Returns

void

Inherited from

HardwareUiControl.setIsolated


setParent()

setParent(parent): void

Defined in: sdk/components/controls/HardwareUiControl.tsx:885

Sets the parent of this control.

Parameters

ParameterTypeDescription
parentHardwareUiControl<FmsUiControlEvents>The parent to set.

Returns

void

Inherited from

HardwareUiControl.setParent


triggerEvent()

triggerEvent(event, source, ...args): boolean

Defined in: sdk/components/controls/HardwareUiControl.tsx:348

Triggers an event on this control. The event will first be routed to the deepest focused descendent of this control and will propagate up the control tree until it is handled or there are no more controls to which to propagate.

Parameters

ParameterTypeDescription
eventFmsHEventThe event to trigger.
sourceHardwareUiControlThe source of the event. Defaults to this if not supplied.
...argsany[]Additional arguments to pass to the event handler.

Returns

boolean

True if the event was handled, false otherwise.

Inherited from

HardwareUiControl.triggerEvent


unregister()

unregister(item): void

Defined in: sdk/components/controls/HardwareUiControl.tsx:748

Unregisters a child control with this control.

Parameters

ParameterTypeDescription
itemnumber | HardwareUiControl<FmsUiControlEvents, HardwareUiControlProps>The child control or index of a child control to unregister. If a child control is provided, it will attempt to be located in the control's child registry and then removed. If an index is provided, the child control at that registered index will be removed.

Returns

void

Inherited from

HardwareUiControl.unregister