Abstract Class: FPLHeader<P>
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/FPL/FPLHeader.tsx:24
A header for an FPL section.
Extends
Extended by
Type Parameters
Type Parameter | Default type |
---|---|
P extends FPLHeaderProps | FPLHeaderProps |
Constructors
Constructor
new FPLHeader<
P
>(props
):FPLHeader
<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
FPLHeader
<P
>
Inherited from
Properties
_isCollapsed
protected
_isCollapsed:boolean
=false
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/FPL/FPLHeader.tsx:29
context?
optional
context: [] =undefined
Defined in: sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
contextType?
readonly
optional
contextType: readonly [] =undefined
Defined in: sdk/components/FSComponent.ts:67
The type of context for this component, if any.
Inherited from
focusedIndex
protected
focusedIndex:number
=-1
Defined in: sdk/components/controls/HardwareUiControl.tsx:139
Inherited from
isInit
protected
isInit:boolean
=false
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/FPL/FPLHeader.tsx:36
props
props:
P
&ComponentProps
Defined in: sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
registeredControls
protected
registeredControls:undefined
|HardwareUiControl
<FmsUiControlEvents
,HardwareUiControlProps
>[]
Defined in: sdk/components/controls/HardwareUiControl.tsx:137
Inherited from
G1000UiControl
.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
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
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
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
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
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
Methods
blur()
blur():
void
Defined in: sdk/components/controls/HardwareUiControl.tsx:593
Blurs, or removes focus, from the component.
Returns
void
Inherited from
clearRegistered()
clearRegistered():
void
Defined in: sdk/components/controls/HardwareUiControl.tsx:793
Clears the list of registered components.
Returns
void
Inherited from
G1000UiControl
.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
G1000UiControl
.consolidateKeyboardHEvent
destroy()
destroy():
void
Defined in: sdk/components/controls/HardwareUiControl.tsx:923
Returns
void
Inherit Doc
Inherited from
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
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
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
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
G1000UiControl
.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
G1000UiControl
.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
G1000UiControl
.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
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
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
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
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
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
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
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
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
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
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
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
onAfterRender()
onAfterRender(
node
):void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/FPL/FPLHeader.tsx:39
Parameters
Parameter | Type |
---|---|
node | VNode |
Returns
void
Inherit Doc
Overrides
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
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
onBeforeRender()
onBeforeRender():
void
Defined in: sdk/components/FSComponent.ts:80
A callback that is called before the component is rendered.
Returns
void
Inherited from
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
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
Overrides
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Overrides
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
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
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
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
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
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
G1000UiControl
.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
G1000UiControl
.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
G1000UiControl
.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
G1000UiControl
.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
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
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
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
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
G1000UiControl
.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
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
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
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
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
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
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
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
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
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
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
G1000UiControl
.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
G1000UiControl
.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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
G1000UiControl
.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
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
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
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
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
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
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
G1000UiControl
.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
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.
Overrides
renderName()
abstract
protected
renderName():VNode
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/FPL/FPLHeader.tsx:134
Renders this header's name text.
Returns
VNode
This header's name text, as a VNode.
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
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
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
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
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
G1000UiControl
.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
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
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
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
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
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
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
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