Class: MFDFPL
Defined in: workingtitle-instruments-g1000/html_ui/MFD/Components/UI/FPL/MFDFPL.tsx:36
The FPL popup container encapsulates the actual popup logic.
Extendsβ
Constructorsβ
Constructorβ
new MFDFPL(
props
):MFDFPL
Defined in: sdk/components/controls/HardwareUiControl.tsx:155
Creates an instance of a HardwareUiControl.
Parametersβ
Parameter | Type | Description |
---|---|---|
props | MFDFPLProps | The props for this component. |
Returnsβ
MFDFPL
Inherited fromβ
Propertiesβ
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β
propsβ
props:
MFDFPLProps
&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
Accessorsβ
isDisabledβ
Get Signatureβ
get isDisabled():
boolean
Defined in: sdk/components/controls/HardwareUiControl.tsx:177
Gets whether or not the control is currently disabled.
Returnsβ
boolean
True if disabled, false otherwise.
Inherited fromβ
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/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
Destroys this component.
Returnsβ
void
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β
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/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/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/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/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/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/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/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/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/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/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/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(
thisNode
):void
Defined in: sdk/components/controls/HardwareUiControl.tsx:900
A callback that is called after the component is rendered.
Parametersβ
Parameter | Type | Description |
---|---|---|
thisNode | VNode | The component's VNode. |
Returnsβ
void
Inherited fromβ
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/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/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/MFD/Components/UI/FPL/MFDFPL.tsx:59
An event called when the control is blurred.
Returnsβ
void
Overridesβ
onC()β
onC(
source
):boolean
Defined in: workingtitle-instruments-g1000/html_ui/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/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/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/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/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/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/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/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/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/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/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: sdk/components/controls/HardwareUiControl.tsx:201
An event called when the control receives focus.
Parametersβ
Parameter | Type | Description |
---|---|---|
source | HardwareUiControl <FmsUiControlEvents > | The control that emitted this event. |
Returnsβ
void
Inherited fromβ
onFPL()β
onFPL(
source
):boolean
Defined in: workingtitle-instruments-g1000/html_ui/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/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/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/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/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/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/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/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/MFD/Components/UI/FPL/MFDFPL.tsx:72
A method which is called when this control receives an interaction event.
Parametersβ
Parameter | Type | Description |
---|---|---|
evt | FmsHEvent | The event. |
Returnsβ
boolean
True if the event was handled, false otherwise.
Overridesβ
G1000UiControl
.onInteractionEvent
onJ()β
onJ(
source
):boolean
Defined in: workingtitle-instruments-g1000/html_ui/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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β
onViewClosed()β
onViewClosed():
void
Defined in: workingtitle-instruments-g1000/html_ui/MFD/Components/UI/FPL/MFDFPL.tsx:54
Called when the view is closed.
Returnsβ
void
onViewOpened()β
onViewOpened():
void
Defined in: workingtitle-instruments-g1000/html_ui/MFD/Components/UI/FPL/MFDFPL.tsx:48
Called when the view is opened.
Returnsβ
void
onViewResumed()β
onViewResumed():
void
Defined in: workingtitle-instruments-g1000/html_ui/MFD/Components/UI/FPL/MFDFPL.tsx:43
Called when the view is resumed.
Returnsβ
void
onW()β
onW(
source
):boolean
Defined in: workingtitle-instruments-g1000/html_ui/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/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/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/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/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/MFD/Components/UI/FPL/MFDFPL.tsx:84
Renders the component.
Returnsβ
The component VNode.
Overridesβ
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β
scrollToActiveLeg()β
scrollToActiveLeg(
focusActiveLeg
):void
Defined in: workingtitle-instruments-g1000/html_ui/MFD/Components/UI/FPL/MFDFPL.tsx:67
Scrolls to the active leg in the flight plan.
Parametersβ
Parameter | Type | Description |
---|---|---|
focusActiveLeg | boolean | Whether to focus the active leg. |
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β
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β
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