Class: G1000ControlList<T>
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:690
A component that holds lists of G1000UiControls.
Extends
HardwareUiControlList<T,FmsUiControlEvents,GarminControlListProps<T>>
Type Parameters
| Type Parameter |
|---|
T |
Implements
UiControlEventHandlers<FmsUiControlEvents>
Constructors
Constructor
new G1000ControlList<
T>(props):G1000ControlList<T>
Defined in: sdk/components/controls/HardwareUiControlList.tsx:64
Creates an instance of a ControlList.
Parameters
| Parameter | Type | Description |
|---|---|---|
props | GarminControlListProps | The props on the ControlList component. |
Returns
G1000ControlList<T>
Inherited from
HardwareUiControlList<T, FmsUiControlEvents, GarminControlListProps<T>>.constructor
Properties
context?
optionalcontext: [] =undefined
Defined in: sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
HardwareUiControlList.context
contextType?
readonlyoptionalcontextType: readonly [] =undefined
Defined in: sdk/components/FSComponent.ts:67
The type of context for this component, if any.
Inherited from
HardwareUiControlList.contextType
focusedIndex
protectedfocusedIndex:number=-1
Defined in: sdk/components/controls/HardwareUiControl.tsx:139
Inherited from
HardwareUiControlList.focusedIndex
props
props:
GarminControlListProps<T> &ComponentProps
Defined in: sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
HardwareUiControlList.props
registeredControls
protectedregisteredControls:undefined|HardwareUiControl<FmsUiControlEvents,HardwareUiControlProps>[]
Defined in: sdk/components/controls/HardwareUiControl.tsx:137
Inherited from
HardwareUiControlList.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
HardwareUiControlList.isDisabled
isFocused
Get Signature
get isFocused():
boolean
Defined in: sdk/components/controls/HardwareUiControl.tsx:185
Gets whether or not the control is currently focused.
Returns
boolean
True if disabled, false otherwise.
Inherited from
HardwareUiControlList.isFocused
isIsolated
Get Signature
get isIsolated():
boolean
Defined in: sdk/components/controls/HardwareUiControl.tsx:193
Gets whether or not the control is currently in scroll isolation.
Returns
boolean
True if currently in scroll isolation, false otherwise.
Inherited from
HardwareUiControlList.isIsolated
length
Get Signature
get length():
number
Defined in: sdk/components/controls/HardwareUiControl.tsx:165
Gets the current number of registered child controls.
Returns
number
The current number of registered child controls.
Inherited from
HardwareUiControlList.length
Methods
blur()
blur():
void
Defined in: sdk/components/controls/HardwareUiControl.tsx:593
Blurs, or removes focus, from the component.
Returns
void
Inherited from
HardwareUiControlList.blur
clearRegistered()
clearRegistered():
void
Defined in: sdk/components/controls/HardwareUiControl.tsx:793
Clears the list of registered components.
Returns
void
Inherited from
HardwareUiControlList.clearRegistered
consolidateKeyboardHEvent()
consolidateKeyboardHEvent(
source,evt):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1343
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.
destroy()
destroy():
void
Defined in: sdk/components/controls/HardwareUiControl.tsx:923
Returns
void
Inherit Doc
Inherited from
HardwareUiControlList.destroy
ensureIndexInView()
ensureIndexInView(
index,pinDirection):void
Defined in: sdk/components/controls/HardwareUiControlList.tsx:385
Ensures an indexed list item is in view.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
index | number | undefined | The index of the list item. |
pinDirection | "top" | "none" | "bottom" | 'none' | The end of the container which the element should be pinned to. |
Returns
void
Inherited from
HardwareUiControlList.ensureIndexInView
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
HardwareUiControlList.focus
getChild()
getChild(
index):undefined|HardwareUiControl<FmsUiControlEvents,HardwareUiControlProps>
Defined in: sdk/components/controls/HardwareUiControl.tsx:859
Gets a child control at the specified index.
Parameters
| Parameter | Type | Description |
|---|---|---|
index | number | The index of the child control to get. |
Returns
undefined | HardwareUiControl<FmsUiControlEvents, HardwareUiControlProps>
The specified child control.
Inherited from
HardwareUiControlList.getChild
getChildInstance()
getChildInstance<
TControl>(index):null|TControl
Defined in: sdk/components/controls/HardwareUiControlList.tsx:446
Gets the instance of the node at the specified index.
Type Parameters
| Type Parameter |
|---|
TControl extends HardwareUiControl<FmsUiControlEvents, HardwareUiControlProps> |
Parameters
| Parameter | Type | Description |
|---|---|---|
index | number | The index to get the instance for. |
Returns
null | TControl
The node instance of specified type.
Inherited from
HardwareUiControlList.getChildInstance
getContext()
protectedgetContext(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
HardwareUiControlList.getContext
getData()
getData(
index):null|T
Defined in: sdk/components/controls/HardwareUiControlList.tsx:407
Gets the data object related to the selected DOM element.
Parameters
| Parameter | Type | Description |
|---|---|---|
index | number | The index of the data to get. |
Returns
null | T
The selected item, if found.
Inherited from
HardwareUiControlList.getData
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
HardwareUiControlList.getFocusedIndex
getFocusPositionOnScroll()
protectedgetFocusPositionOnScroll(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
HardwareUiControlList.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
HardwareUiControlList.getMostRecentFocusedIndex
getSelectedElement()
getSelectedElement():
null|HTMLElement
Defined in: sdk/components/controls/HardwareUiControlList.tsx:425
Get the selected HTMLElement.
Returns
null | HTMLElement
The selected element, if found.
Inherited from
HardwareUiControlList.getSelectedElement
getSelectedIndex()
getSelectedIndex():
number
Defined in: sdk/components/controls/HardwareUiControlList.tsx:433
Gets the index of the currently selected element.
Returns
number
Selected element index. Returns -1 if nothing found.
Inherited from
HardwareUiControlList.getSelectedIndex
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
HardwareUiControlList.indexOf
on0()
on0(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1180
Handles the 0 key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.on0
on1()
on1(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1189
Handles the 1 key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.on1
on2()
on2(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1198
Handles the 2 key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.on2
on3()
on3(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1207
Handles the 3 key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.on3
on4()
on4(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1216
Handles the 4 key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.on4
on5()
on5(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1225
Handles the 5 key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.on5
on6()
on6(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1234
Handles the 6 key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.on6
on7()
on7(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1243
Handles the 7 key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.on7
on8()
on8(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1252
Handles the 8 key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.on8
on9()
on9(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1261
Handles the 9 key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.on9
onA()
onA(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:937
Handles the A key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onA
onAfterRender()
onAfterRender(
node):void
Defined in: sdk/components/controls/HardwareUiControlList.tsx:76
Parameters
| Parameter | Type |
|---|---|
node | VNode |
Returns
void
Inherit Doc
Inherited from
HardwareUiControlList.onAfterRender
onAfterScroll()
protectedonAfterScroll(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
HardwareUiControlList.onAfterScroll
onB()
onB(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:946
Handles the B key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onB
onBeforeRender()
onBeforeRender():
void
Defined in: sdk/components/FSComponent.ts:80
A callback that is called before the component is rendered.
Returns
void
Inherited from
HardwareUiControlList.onBeforeRender
onBKSP()
onBKSP(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1279
Handles the BKSP key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onBKSP
onBlurred()
protectedonBlurred(source):void
Defined in: sdk/components/controls/HardwareUiControlList.tsx:456
Parameters
| Parameter | Type |
|---|---|
source | HardwareUiControl<FmsUiControlEvents, GarminControlListProps<T>> |
Returns
void
Inherit Doc
Inherited from
HardwareUiControlList.onBlurred
onC()
onC(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:955
Handles the C key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onC
onClr()
onClr(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:829
Handles CLR button press events.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onClr
onClrLong()
onClrLong(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:838
Handles CLR button long press events.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onClrLong
onCom()
onCom(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1306
Handles the COM key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onCom
onCrs()
onCrs(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1333
Handles the CRS key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onCrs
onD()
onD(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:964
Handles the D key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onD
onDirectTo()
onDirectTo(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:847
Handles DRCT button press events.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onDirectTo
onDisabled()
protectedonDisabled(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
HardwareUiControlList.onDisabled
onDot()
onDot(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1270
Handles the Dot key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onDot
onE()
onE(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:973
Handles the E key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onE
onEnabled()
protectedonEnabled(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
HardwareUiControlList.onEnabled
onEnter()
onEnter(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:820
Handles ENTER button press events.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onEnter
onF()
onF(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:982
Handles the F key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onF
onFocused()
protectedonFocused(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
HardwareUiControlList.onFocused
onFPL()
onFPL(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:856
Handles FPL button press events.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onFPL
onG()
onG(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:991
Handles the G key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onG
onH()
onH(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1000
Handles the H key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onH
onHome()
onHome(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1297
Handles the Home key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onHome
onI()
onI(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1009
Handles the I key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onI
onInnerControlKnobDec()
onInnerControlKnobDec(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:766
Handles Inner Control Knob decrease events.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onInnerControlKnobDec
onInnerControlKnobInc()
onInnerControlKnobInc(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:775
Handles Inner Control Knob increase events.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onInnerControlKnobInc
onInnerControlKnobPush()
onInnerControlKnobPush(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:784
Handles Inner Control Knob push events.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onInnerControlKnobPush
onInteractionEvent()
onInteractionEvent(
evt):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:695
Parameters
| Parameter | Type |
|---|---|
evt | FmsHEvent |
Returns
boolean
Inherit Doc
Overrides
HardwareUiControlList.onInteractionEvent
onJ()
onJ(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1018
Handles the J key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onJ
onJoystickDown()
onJoystickDown(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:928
Handles range joystick down deflection events.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onJoystickDown
onJoystickLeft()
onJoystickLeft(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:901
Handles range joystick left deflection events.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onJoystickLeft
onJoystickPush()
onJoystickPush(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:892
Handles range joystick push events.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onJoystickPush
onJoystickRight()
onJoystickRight(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:919
Handles range joystick right deflection events.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onJoystickRight
onJoystickUp()
onJoystickUp(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:910
Handles range joystick up deflection events.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onJoystickUp
onK()
onK(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1027
Handles the K key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onK
onL()
onL(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1036
Handles the L key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onL
onLowerKnobDec()
onLowerKnobDec(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:748
Handles FMS lower knob decrease events.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onLowerKnobDec
onLowerKnobInc()
onLowerKnobInc(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:739
Handles FMS lower knob increase events.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onLowerKnobInc
onM()
onM(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1045
Handles the M key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onM
onMenu()
onMenu(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:811
Handles MENU button press events.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onMenu
onN()
onN(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1054
Handles the N key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onN
onNav()
onNav(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1315
Handles the NAV key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onNav
onO()
onO(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1063
Handles the O key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onO
onOuterControlKnobDec()
onOuterControlKnobDec(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:793
Handles Outer Control Knob decrease events.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onOuterControlKnobDec
onOuterControlKnobInc()
onOuterControlKnobInc(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:802
Handles Outer Control Knob increase events.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onOuterControlKnobInc
onP()
onP(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1072
Handles the P key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onP
onPlusMinus()
onPlusMinus(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1288
Handles the +/- key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onPlusMinus
onProc()
onProc(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:865
Handles PROC button press events.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onProc
onQ()
onQ(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1081
Handles the Q key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onQ
onR()
onR(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1090
Handles the R key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onR
onRangeDec()
onRangeDec(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:883
Handles range joystick decrease events.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onRangeDec
onRangeInc()
onRangeInc(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:874
Handles range joystick increase events.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onRangeInc
onRegistered()
protectedonRegistered(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
HardwareUiControlList.onRegistered
onS()
onS(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1099
Handles the S key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onS
onScroll()
protectedonScroll(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
HardwareUiControlList.onScroll
onSPC()
onSPC(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1171
Handles the key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onSPC
onT()
onT(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1108
Handles the T key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onT
onU()
onU(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1117
Handles the U key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onU
onUnregistered()
protectedonUnregistered(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
HardwareUiControlList.onUnregistered
onUpperKnobDec()
onUpperKnobDec(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:730
Handles FMS upper knob decrease events.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onUpperKnobDec
onUpperKnobInc()
onUpperKnobInc(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:721
Handles FMS upper knob increase events.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onUpperKnobInc
onUpperKnobPush()
onUpperKnobPush(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:757
Handles FMS upper knob push events.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onUpperKnobPush
onV()
onV(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1126
Handles the V key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onV
onW()
onW(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1135
Handles the W key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onW
onX()
onX(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1144
Handles the X key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onX
onXpdr()
onXpdr(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1324
Handles the XPDR key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onXpdr
onY()
onY(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1153
Handles the Y key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onY
onZ()
onZ(
source):boolean
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1162
Handles the Z key.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | G1000UiControl | The source of the event. |
Returns
boolean
Whether the event was handled.
Implementation of
UiControlEventHandlers.onZ
reconcileChildBlur()
protectedreconcileChildBlur(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
HardwareUiControlList.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
HardwareUiControlList.register
render()
render():
VNode
Defined in: sdk/components/controls/HardwareUiControlList.tsx:499
Returns
VNode
Inherit Doc
Inherited from
HardwareUiControlList.render
renderScrollbar()
protectedrenderScrollbar():VNode
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:1348
Returns
VNode
Inherit Doc
Overrides
HardwareUiControlList.renderScrollbar
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
HardwareUiControlList.scroll
scrollToIndex()
scrollToIndex(
index,focusPosition):void
Defined in: sdk/components/controls/HardwareUiControlList.tsx:373
Scrolls to an item.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
index | number | undefined | is the index of the list item to scroll to. |
focusPosition | FocusPosition | FocusPosition.First | The focus position to apply to children of the item being scrolled to. |
Returns
void
Inherited from
HardwareUiControlList.scrollToIndex
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
HardwareUiControlList.setDisabled
setFocusedIndex()
setFocusedIndex(
index,focusPosition):void
Defined in: sdk/components/controls/HardwareUiControl.tsx:843
Sets the current most recently focused child control index. If this control is focused and has children that have focus, this will also switch child focus to the new index.
Parameters
| 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
HardwareUiControlList.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
HardwareUiControlList.setIsolated
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
HardwareUiControlList.setParent
triggerEvent()
triggerEvent(
event,source, ...args):boolean
Defined in: sdk/components/controls/HardwareUiControl.tsx:348
Triggers an event on this control. The event will first be routed to the deepest focused descendent of this control and will propagate up the control tree until it is handled or there are no more controls to which to propagate.
Parameters
| Parameter | Type | Description |
|---|---|---|
event | FmsHEvent | The event to trigger. |
source | HardwareUiControl | The source of the event. Defaults to this if not supplied. |
...args | any[] | Additional arguments to pass to the event handler. |
Returns
boolean
True if the event was handled, false otherwise.
Inherited from
HardwareUiControlList.triggerEvent
unregister()
unregister(
item):void
Defined in: sdk/components/controls/HardwareUiControl.tsx:748
Unregisters a child control with this control.
Parameters
| Parameter | Type | Description |
|---|---|---|
item | number | HardwareUiControl<FmsUiControlEvents, HardwareUiControlProps> | The child control or index of a child control to unregister. If a child control is provided, it will attempt to be located in the control's child registry and then removed. If an index is provided, the child control at that registered index will be removed. |
Returns
void
Inherited from
HardwareUiControlList.unregister
updateOrder()
updateOrder():
void
Defined in: sdk/components/controls/HardwareUiControlList.tsx:276
Updates the order of data items in the list by the props supplied comparison function, if one exists.
Returns
void
Inherited from
HardwareUiControlList.updateOrder