Skip to main content

Class: FPLStringHeader<P>

An FPL section header which displays simple strings.

Type parameters

NameType
Pextends FPLHeaderProps = FPLHeaderProps

Hierarchy

Constructors

constructor

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

Creates an instance of a HardwareUiControl.

Type parameters

NameType
Pextends FPLHeaderProps = FPLHeaderProps

Parameters

NameTypeDescription
propsPThe props for this component.

Returns

FPLStringHeader<P>

Inherited from

FPLHeader.constructor

Defined in

sdk/components/controls/HardwareUiControl.tsx:155

Properties

_isCollapsed

Protected _isCollapsed: boolean = false

Inherited from

FPLHeader._isCollapsed

Defined in

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


context

Optional context: [] = undefined

The context on this component, if any.

Inherited from

FPLHeader.context

Defined in

sdk/components/FSComponent.ts:64


contextType

Optional Readonly contextType: readonly [] = undefined

The type of context for this component, if any.

Inherited from

FPLHeader.contextType

Defined in

sdk/components/FSComponent.ts:67


focusedIndex

Protected focusedIndex: number = -1

Inherited from

FPLHeader.focusedIndex

Defined in

sdk/components/controls/HardwareUiControl.tsx:139


isInit

Protected isInit: boolean = false

Inherited from

FPLHeader.isInit

Defined in

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


props

props: P & ComponentProps

The properties of the component.

Inherited from

FPLHeader.props

Defined in

sdk/components/FSComponent.ts:61


registeredControls

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

Inherited from

FPLHeader.registeredControls

Defined in

sdk/components/controls/HardwareUiControl.tsx:137


rootRef

Protected Readonly rootRef: NodeReference<HTMLDivElement>

Inherited from

FPLHeader.rootRef

Defined in

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


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 isCollapsed(): boolean

Whether this header is collapsed.

Returns

boolean

Inherited from

FPLHeader.isCollapsed

Defined in

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


isDisabled

get isDisabled(): boolean

Gets whether or not the control is currently disabled.

Returns

boolean

True if disabled, false otherwise.

Inherited from

FPLHeader.isDisabled

Defined in

sdk/components/controls/HardwareUiControl.tsx:177


isFocused

get isFocused(): boolean

Gets whether or not the control is currently focused.

Returns

boolean

True if disabled, false otherwise.

Inherited from

FPLHeader.isFocused

Defined in

sdk/components/controls/HardwareUiControl.tsx:185


isIsolated

get isIsolated(): boolean

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

Defined in

sdk/components/controls/HardwareUiControl.tsx:193


length

get length(): number

Gets the current number of registered child controls.

Returns

number

The current number of registered child controls.

Inherited from

FPLHeader.length

Defined in

sdk/components/controls/HardwareUiControl.tsx:165

Methods

blur

blur(): void

Blurs, or removes focus, from the component.

Returns

void

Inherited from

FPLHeader.blur

Defined in

sdk/components/controls/HardwareUiControl.tsx:593


clearRegistered

clearRegistered(): void

Clears the list of registered components.

Returns

void

Inherited from

FPLHeader.clearRegistered

Defined in

sdk/components/controls/HardwareUiControl.tsx:793


consolidateKeyboardHEvent

consolidateKeyboardHEvent(source, evt): boolean

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

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.
evtFmsHEventFmsHEvent of the keyboard event.

Returns

boolean

always false for the top level version of the method.

Inherited from

FPLHeader.consolidateKeyboardHEvent

Defined in

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


destroy

destroy(): void

Returns

void

Inherit Doc

Inherited from

FPLHeader.destroy

Defined in

sdk/components/controls/HardwareUiControl.tsx:923


focus

focus(focusPosition): boolean

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

Parameters

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

Returns

boolean

Whether this control was successfully focused.

Inherited from

FPLHeader.focus

Defined in

sdk/components/controls/HardwareUiControl.tsx:410


getChild

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

Gets a child control at the specified index.

Parameters

NameTypeDescription
indexnumberThe index of the child control to get.

Returns

undefined | HardwareUiControl<FmsUiControlEvents, HardwareUiControlProps>

The specified child control.

Inherited from

FPLHeader.getChild

Defined in

sdk/components/controls/HardwareUiControl.tsx:859


getContext

getContext(context): never

Gets a context data subscription from the context collection.

Parameters

NameTypeDescription
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

FPLHeader.getContext

Defined in

sdk/components/FSComponent.ts:106


getFocusPositionOnScroll

getFocusPositionOnScroll(direction): FocusPosition

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

Parameters

NameTypeDescription
directionScrollDirectionThe direction of the scroll.

Returns

FocusPosition

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

Inherited from

FPLHeader.getFocusPositionOnScroll

Defined in

sdk/components/controls/HardwareUiControl.tsx:250


getFocusedIndex

getFocusedIndex(): number

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

Defined in

sdk/components/controls/HardwareUiControl.tsx:824


getMostRecentFocusedIndex

getMostRecentFocusedIndex(): number

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

Defined in

sdk/components/controls/HardwareUiControl.tsx:833


indexOf

indexOf(child): number

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

Parameters

NameTypeDescription
childHardwareUiControl<FmsUiControlEvents, HardwareUiControlProps>The child to get the index of.

Returns

number

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

Inherited from

FPLHeader.indexOf

Defined in

sdk/components/controls/HardwareUiControl.tsx:873


on0

on0(source): boolean

Handles the 0 key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.on0

Defined in

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


on1

on1(source): boolean

Handles the 1 key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.on1

Defined in

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


on2

on2(source): boolean

Handles the 2 key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.on2

Defined in

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


on3

on3(source): boolean

Handles the 3 key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.on3

Defined in

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


on4

on4(source): boolean

Handles the 4 key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.on4

Defined in

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


on5

on5(source): boolean

Handles the 5 key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.on5

Defined in

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


on6

on6(source): boolean

Handles the 6 key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.on6

Defined in

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


on7

on7(source): boolean

Handles the 7 key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.on7

Defined in

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


on8

on8(source): boolean

Handles the 8 key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.on8

Defined in

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


on9

on9(source): boolean

Handles the 9 key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.on9

Defined in

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


onA

onA(source): boolean

Handles the A key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onA

Defined in

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


onAfterRender

onAfterRender(node): void

Parameters

NameType
nodeVNode

Returns

void

Inherit Doc

Overrides

FPLHeader.onAfterRender

Defined in

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


onAfterScroll

onAfterScroll(control, index): void

An event called when a scroll operation has completed.

Parameters

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

Returns

void

Inherited from

FPLHeader.onAfterScroll

Defined in

sdk/components/controls/HardwareUiControl.tsx:284


onB

onB(source): boolean

Handles the B key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onB

Defined in

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


onBKSP

onBKSP(source): boolean

Handles the BKSP key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onBKSP

Defined in

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


onBeforeRender

onBeforeRender(): void

A callback that is called before the component is rendered.

Returns

void

Inherited from

FPLHeader.onBeforeRender

Defined in

sdk/components/FSComponent.ts:80


onBlurred

onBlurred(): void

An event called when the control is blurred.

Returns

void

Inherited from

FPLHeader.onBlurred

Defined in

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


onC

onC(source): boolean

Handles the C key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onC

Defined in

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


onClr

onClr(source): boolean

Handles CLR button press events.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onClr

Defined in

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


onClrLong

onClrLong(source): boolean

Handles CLR button long press events.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onClrLong

Defined in

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


onCom

onCom(source): boolean

Handles the COM key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onCom

Defined in

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


onCrs

onCrs(source): boolean

Handles the CRS key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onCrs

Defined in

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


onD

onD(source): boolean

Handles the D key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onD

Defined in

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


onDirectTo

onDirectTo(source): boolean

Handles DRCT button press events.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onDirectTo

Defined in

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


onDisabled

onDisabled(source): void

An event called when the control is disabled.

Parameters

NameTypeDescription
sourceHardwareUiControl<FmsUiControlEvents, HardwareUiControlProps>The control that emitted this event.

Returns

void

Inherited from

FPLHeader.onDisabled

Defined in

sdk/components/controls/HardwareUiControl.tsx:225


onDot

onDot(source): boolean

Handles the Dot key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onDot

Defined in

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


onE

onE(source): boolean

Handles the E key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onE

Defined in

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


onEnabled

onEnabled(source): void

An event called when the control is enabled.

Parameters

NameTypeDescription
sourceHardwareUiControl<FmsUiControlEvents, HardwareUiControlProps>The control that emitted this event.

Returns

void

Inherited from

FPLHeader.onEnabled

Defined in

sdk/components/controls/HardwareUiControl.tsx:217


onEnter

onEnter(source): boolean

Handles ENTER button press events.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onEnter

Defined in

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


onF

onF(source): boolean

Handles the F key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onF

Defined in

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


onFPL

onFPL(source): boolean

Handles FPL button press events.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onFPL

Defined in

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


onFocused

onFocused(source): void

An event called when the control receives focus.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The control that emitted this event.

Returns

void

Inherited from

FPLHeader.onFocused

Defined in

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


onG

onG(source): boolean

Handles the G key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onG

Defined in

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


onH

onH(source): boolean

Handles the H key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onH

Defined in

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


onHome

onHome(source): boolean

Handles the Home key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onHome

Defined in

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


onI

onI(source): boolean

Handles the I key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onI

Defined in

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


onInnerControlKnobDec

onInnerControlKnobDec(source): boolean

Handles Inner Control Knob decrease events.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onInnerControlKnobDec

Defined in

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


onInnerControlKnobInc

onInnerControlKnobInc(source): boolean

Handles Inner Control Knob increase events.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onInnerControlKnobInc

Defined in

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


onInnerControlKnobPush

onInnerControlKnobPush(source): boolean

Handles Inner Control Knob push events.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onInnerControlKnobPush

Defined in

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


onInteractionEvent

onInteractionEvent(evt): boolean

Parameters

NameType
evtFmsHEvent

Returns

boolean

Inherit Doc

Inherited from

FPLHeader.onInteractionEvent

Defined in

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


onJ

onJ(source): boolean

Handles the J key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onJ

Defined in

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


onJoystickDown

onJoystickDown(source): boolean

Handles range joystick down deflection events.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onJoystickDown

Defined in

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


onJoystickLeft

onJoystickLeft(source): boolean

Handles range joystick left deflection events.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onJoystickLeft

Defined in

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


onJoystickPush

onJoystickPush(source): boolean

Handles range joystick push events.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onJoystickPush

Defined in

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


onJoystickRight

onJoystickRight(source): boolean

Handles range joystick right deflection events.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onJoystickRight

Defined in

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


onJoystickUp

onJoystickUp(source): boolean

Handles range joystick up deflection events.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onJoystickUp

Defined in

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


onK

onK(source): boolean

Handles the K key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onK

Defined in

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


onL

onL(source): boolean

Handles the L key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onL

Defined in

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


onLowerKnobDec

onLowerKnobDec(source): boolean

Handles FMS lower knob decrease events.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onLowerKnobDec

Defined in

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


onLowerKnobInc

onLowerKnobInc(source): boolean

Handles FMS lower knob increase events.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onLowerKnobInc

Defined in

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


onM

onM(source): boolean

Handles the M key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onM

Defined in

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


onMenu

onMenu(source): boolean

Handles MENU button press events.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onMenu

Defined in

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


onN

onN(source): boolean

Handles the N key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onN

Defined in

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


onNav

onNav(source): boolean

Handles the NAV key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onNav

Defined in

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


onO

onO(source): boolean

Handles the O key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onO

Defined in

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


onOuterControlKnobDec

onOuterControlKnobDec(source): boolean

Handles Outer Control Knob decrease events.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onOuterControlKnobDec

Defined in

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


onOuterControlKnobInc

onOuterControlKnobInc(source): boolean

Handles Outer Control Knob increase events.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onOuterControlKnobInc

Defined in

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


onP

onP(source): boolean

Handles the P key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onP

Defined in

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


onPlusMinus

onPlusMinus(source): boolean

Handles the +/- key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onPlusMinus

Defined in

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


onProc

onProc(source): boolean

Handles PROC button press events.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onProc

Defined in

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


onQ

onQ(source): boolean

Handles the Q key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onQ

Defined in

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


onR

onR(source): boolean

Handles the R key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onR

Defined in

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


onRangeDec

onRangeDec(source): boolean

Handles range joystick decrease events.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onRangeDec

Defined in

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


onRangeInc

onRangeInc(source): boolean

Handles range joystick increase events.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onRangeInc

Defined in

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


onRegistered

onRegistered(source): void

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

Parameters

NameTypeDescription
sourceHardwareUiControl<FmsUiControlEvents, HardwareUiControlProps>The control that emitted this event.

Returns

void

Inherited from

FPLHeader.onRegistered

Defined in

sdk/components/controls/HardwareUiControl.tsx:233


onS

onS(source): boolean

Handles the S key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onS

Defined in

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


onSPC

onSPC(source): boolean

Handles the key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onSPC

Defined in

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


onScroll

onScroll(direction): boolean

An event called when the control is scrolled.

Parameters

NameTypeDescription
directionScrollDirectionThe direction that is being requested to scroll.

Returns

boolean

True if this control handled this event, false otherwise.

Inherited from

FPLHeader.onScroll

Defined in

sdk/components/controls/HardwareUiControl.tsx:263


onT

onT(source): boolean

Handles the T key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onT

Defined in

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


onU

onU(source): boolean

Handles the U key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onU

Defined in

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


onUnregistered

onUnregistered(source): void

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

Parameters

NameTypeDescription
sourceHardwareUiControl<FmsUiControlEvents, HardwareUiControlProps>The control that emitted this event.

Returns

void

Inherited from

FPLHeader.onUnregistered

Defined in

sdk/components/controls/HardwareUiControl.tsx:241


onUpperKnobDec

onUpperKnobDec(source): boolean

Handles FMS upper knob decrease events.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onUpperKnobDec

Defined in

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


onUpperKnobInc

onUpperKnobInc(source): boolean

Handles FMS upper knob increase events.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onUpperKnobInc

Defined in

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


onUpperKnobPush

onUpperKnobPush(source): boolean

Handles FMS upper knob push events.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onUpperKnobPush

Defined in

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


onV

onV(source): boolean

Handles the V key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onV

Defined in

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


onW

onW(source): boolean

Handles the W key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onW

Defined in

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


onX

onX(source): boolean

Handles the X key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onX

Defined in

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


onXpdr

onXpdr(source): boolean

Handles the XPDR key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onXpdr

Defined in

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


onY

onY(source): boolean

Handles the Y key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onY

Defined in

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


onZ

onZ(source): boolean

Handles the Z key.

Parameters

NameTypeDescription
sourceG1000UiControl<G1000UiControlProps>The source of the event.

Returns

boolean

Whether the event was handled.

Inherited from

FPLHeader.onZ

Defined in

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


reconcileChildBlur

reconcileChildBlur(index, child): number | BlurReconciliation

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

NameTypeDescription
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, HardwareUiControlProps>The child control that was blurred.

Returns

number | BlurReconciliation

The index of the child control to focus.

Inherited from

FPLHeader.reconcileChildBlur

Defined in

sdk/components/controls/HardwareUiControl.tsx:688


register

register(control, index?): void

Registers a child control with this control.

Parameters

NameTypeDescription
controlHardwareUiControl<FmsUiControlEvents, HardwareUiControlProps>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

FPLHeader.register

Defined in

sdk/components/controls/HardwareUiControl.tsx:722


render

render(): VNode

Renders the control.

Returns

VNode

The component VNode.

Inherited from

FPLHeader.render

Defined in

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


renderName

renderName(): VNode

Renders this header's name text.

Returns

VNode

This header's name text, as a VNode.

Overrides

FPLHeader.renderName

Defined in

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


scroll

scroll(direction): boolean

Scrolls the currently focused control in the supplied direction.

Parameters

NameTypeDescription
directionScrollDirectionThe direction that is being requested to scroll.

Returns

boolean

True if propagation should be stopped, false otherwise.

Inherited from

FPLHeader.scroll

Defined in

sdk/components/controls/HardwareUiControl.tsx:293


setCollapsed

setCollapsed(setCollapsed): void

Method to collapse this section and display the header correctly.

Parameters

NameTypeDescription
setCollapsedbooleanboolean to set collapsed

Returns

void

Inherited from

FPLHeader.setCollapsed

Defined in

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


setDisabled

setDisabled(isDisabled): void

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

NameTypeDescription
isDisabledbooleanWhether or not the component is disabled.

Returns

void

Inherited from

FPLHeader.setDisabled

Defined in

sdk/components/controls/HardwareUiControl.tsx:705


setEstimatedNameWidth

setEstimatedNameWidth(width): void

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

Parameters

NameTypeDescription
widthnumberThe new estimated width, in pixels.

Returns

void

Inherited from

FPLHeader.setEstimatedNameWidth

Defined in

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


setFocusedIndex

setFocusedIndex(index, focusPosition?): void

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

NameTypeDefault 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

FPLHeader.setFocusedIndex

Defined in

sdk/components/controls/HardwareUiControl.tsx:843


setIsVisible

setIsVisible(isVisible): void

Sets if the header should be visible.

Parameters

NameTypeDescription
isVisiblebooleanWhether or not the header is visible.

Returns

void

Inherited from

FPLHeader.setIsVisible

Defined in

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


setIsolated

setIsolated(isolated): void

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

NameTypeDescription
isolatedbooleanWhether or not the control is isolated.

Returns

void

Inherited from

FPLHeader.setIsolated

Defined in

sdk/components/controls/HardwareUiControl.tsx:895


setParent

setParent(parent): void

Sets the parent of this control.

Parameters

NameTypeDescription
parentHardwareUiControl<FmsUiControlEvents, HardwareUiControlProps>The parent to set.

Returns

void

Inherited from

FPLHeader.setParent

Defined in

sdk/components/controls/HardwareUiControl.tsx:885


triggerEvent

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

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

NameTypeDescription
eventFmsHEventThe event to trigger.
sourceHardwareUiControl<Record<string, any>, HardwareUiControlProps>The 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

FPLHeader.triggerEvent

Defined in

sdk/components/controls/HardwareUiControl.tsx:348


unregister

unregister(item): void

Unregisters a child control with this control.

Parameters

NameTypeDescription
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

FPLHeader.unregister

Defined in

sdk/components/controls/HardwareUiControl.tsx:748


update

update(): void

Updates this header

Returns

void

Inherited from

FPLHeader.update

Defined in

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


updateName

updateName(): void

Updates this header's name text.

Returns

void

Inherited from

FPLHeader.updateName

Defined in

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


updateNameFontSize

updateNameFontSize(): void

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

Defined in

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