Abstract Class: FPLStringHeader<P>

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/FPL/FPLStringHeader.tsx:8

An FPL section header which displays simple strings.

Extends

• FPLHeader<P>

Extended by

• FPLHeaderArrival
• FPLHeaderDeparture
• FPLHeaderDestination
• FPLHeaderEnroute

Type Parameters

Type Parameter	Default type
P extends FPLHeaderProps	FPLHeaderProps

Constructors

Constructor

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

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

Creates an instance of a HardwareUiControl.

Parameters

Parameter	Type	Description
props	P	The props for this component.

Returns

FPLStringHeader<P>

Inherited from

FPLHeader.constructor

Properties

_isCollapsed

protected _isCollapsed: boolean = false

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

Inherited from

FPLHeader._isCollapsed

---

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

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

FPLHeader.contextType

---

focusedIndex

protected focusedIndex: number = -1

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

Inherited from

FPLHeader.focusedIndex

---

isInit

protected isInit: boolean = false

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/FPL/FPLHeader.tsx:36

Inherited from

FPLHeader.isInit

---

props

props: P & ComponentProps

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

The properties of the component.

Inherited from

FPLHeader.props

---

registeredControls

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

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

Inherited from

FPLHeader.registeredControls

---

rootRef

protected readonly rootRef: NodeReference<HTMLDivElement>

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/FPL/FPLHeader.tsx:25

Inherited from

FPLHeader.rootRef

---

textSub

protected readonly textSub: Subject<string>

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/FPL/FPLStringHeader.tsx:11

Accessors

isCollapsed

Get Signature

get isCollapsed(): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/FPL/FPLHeader.tsx:32

Whether this header is collapsed.

Returns

boolean

Inherited from

FPLHeader.isCollapsed

---

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

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

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

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

FPLHeader.length

Methods

blur()

blur(): void

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

Blurs, or removes focus, from the component.

Returns

void

Inherited from

FPLHeader.blur

---

clearRegistered()

clearRegistered(): void

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

Clears the list of registered components.

Returns

void

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.
evt	FmsHEvent	FmsHEvent of the keyboard event.

Returns

boolean

always false for the top level version of the method.

Inherited from

FPLHeader.consolidateKeyboardHEvent

---

destroy()

destroy(): void

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

Returns

void

Inherit Doc

Inherited from

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

Parameter	Type	Description
focusPosition	FocusPosition	The focus position to activate for descendents of this control.

Returns

boolean

Whether this control was successfully focused.

Inherited from

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

Parameter	Type	Description
index	number	The index of the child control to get.

Returns

undefined | HardwareUiControl<FmsUiControlEvents, HardwareUiControlProps>

The specified child control.

Inherited from

FPLHeader.getChild

---

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

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

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

Parameter	Type	Description
direction	ScrollDirection	The direction of the scroll.

Returns

FocusPosition

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

Inherited from

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

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

Parameter	Type	Description
child	HardwareUiControl<FmsUiControlEvents>	The child to get the index of.

Returns

number

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

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onA

---

onAfterRender()

onAfterRender(node): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/FPL/FPLStringHeader.tsx:16

Parameters

Parameter	Type
node	VNode

Returns

void

Inherit Doc

Overrides

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

Parameter	Type	Description
control	HardwareUiControl<FmsUiControlEvents>	The control that was scrolled to.
index	number	The index of the control in the collection of registered controls.

Returns

void

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onBKSP

---

onBlurred()

protected onBlurred(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/FPL/FPLHeader.tsx:117

An event called when the control is blurred.

Returns

void

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onDirectTo

---

onDisabled()

protected onDisabled(source): void

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

An event called when the control is disabled.

Parameters

Parameter	Type	Description
source	HardwareUiControl<FmsUiControlEvents>	The control that emitted this event.

Returns

void

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onE

---

onEnabled()

protected onEnabled(source): void

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

An event called when the control is enabled.

Parameters

Parameter	Type	Description
source	HardwareUiControl<FmsUiControlEvents>	The control that emitted this event.

Returns

void

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onF

---

onFocused()

protected onFocused(source): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/FPL/FPLHeader.tsx:107

An event called when the control receives focus.

Parameters

Parameter	Type	Description
source	G1000UiControl	The control that emitted this event.

Returns

void

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onInnerControlKnobPush

---

onInteractionEvent()

onInteractionEvent(evt): boolean

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

Parameters

Parameter	Type
evt	FmsHEvent

Returns

boolean

Inherit Doc

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	HardwareUiControl<FmsUiControlEvents>	The control that emitted this event.

Returns

void

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onS

---

onScroll()

protected onScroll(direction): boolean

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

An event called when the control is scrolled.

Parameters

Parameter	Type	Description
direction	ScrollDirection	The direction that is being requested to scroll.

Returns

boolean

True if this control handled this event, false otherwise.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	HardwareUiControl<FmsUiControlEvents>	The control that emitted this event.

Returns

void

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
source	G1000UiControl	The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

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

Parameter	Type	Description
index	number	The 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.
child	HardwareUiControl<FmsUiControlEvents>	The child control that was blurred.

Returns

number | BlurReconciliation

The index of the child control to focus.

Inherited from

FPLHeader.reconcileChildBlur

---

register()

register(control, index?): void

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

Registers a child control with this control.

Parameters

Parameter	Type	Description
control	HardwareUiControl<FmsUiControlEvents>	The control to register.
index?	number	The 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

FPLHeader.register

---

render()

render(): VNode

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/FPL/FPLHeader.tsx:122

Renders the control.

Returns

VNode

The component VNode.

Inherited from

FPLHeader.render

---

renderName()

protected renderName(): VNode

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/FPL/FPLStringHeader.tsx:23

Renders this header's name text.

Returns

VNode

This header's name text, as a VNode.

Overrides

FPLHeader.renderName

---

scroll()

scroll(direction): boolean

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

Scrolls the currently focused control in the supplied direction.

Parameters

Parameter	Type	Description
direction	ScrollDirection	The direction that is being requested to scroll.

Returns

boolean

True if propagation should be stopped, false otherwise.

Inherited from

FPLHeader.scroll

---

setCollapsed()

abstract setCollapsed(setCollapsed): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/FPL/FPLHeader.tsx:49

Method to collapse this section and display the header correctly.

Parameters

Parameter	Type	Description
setCollapsed	boolean	boolean to set collapsed

Returns

void

Inherited from

FPLHeader.setCollapsed

---

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

Parameter	Type	Description
isDisabled	boolean	Whether or not the component is disabled.

Returns

void

Inherited from

FPLHeader.setDisabled

---

setEstimatedNameWidth()

protected setEstimatedNameWidth(width): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/FPL/FPLHeader.tsx:69

Sets the estimated width of this header's name text.

Parameters

Parameter	Type	Description
width	number	The new estimated width, in pixels.

Returns

void

Inherited from

FPLHeader.setEstimatedNameWidth

---

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

Parameter	Type	Default value	Description
index	number	undefined	The index of the child control to set most recent focus for.
focusPosition	FocusPosition	FocusPosition.MostRecent	The focus position to focus the child for, if required.

Returns

void

Inherited from

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

Parameter	Type	Description
isolated	boolean	Whether or not the control is isolated.

Returns

void

Inherited from

FPLHeader.setIsolated

---

setIsVisible()

protected setIsVisible(isVisible): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/FPL/FPLHeader.tsx:96

Sets if the header should be visible.

Parameters

Parameter	Type	Description
isVisible	boolean	Whether or not the header is visible.

Returns

void

Inherited from

FPLHeader.setIsVisible

---

setParent()

setParent(parent): void

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

Sets the parent of this control.

Parameters

Parameter	Type	Description
parent	HardwareUiControl<FmsUiControlEvents>	The parent to set.

Returns

void

Inherited from

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

Parameter	Type	Description
event	FmsHEvent	The event to trigger.
source	HardwareUiControl	The source of the event. Defaults to this if not supplied.
...args	any[]	Additional arguments to pass to the event handler.

Returns

boolean

True if the event was handled, false otherwise.

Inherited from

FPLHeader.triggerEvent

---

unregister()

unregister(item): void

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

Unregisters a child control with this control.

Parameters

Parameter	Type	Description
item	number | 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

FPLHeader.unregister

---

update()

update(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/FPL/FPLHeader.tsx:52

Updates this header

Returns

void

Inherited from

FPLHeader.update

---

updateName()

abstract protected updateName(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/FPL/FPLHeader.tsx:63

Updates this header's name text.

Returns

void

Inherited from

FPLHeader.updateName

---

updateNameFontSize()

protected updateNameFontSize(): void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/FPL/FPLHeader.tsx:81

Updates the font size for this header's name text to ensure the text fits within this header's width.

Returns

void

Inherited from

FPLHeader.updateNameFontSize