Interface: SelectControl2Props<T>
The properties for the SelectControl component.
Type parameters
Name |
---|
T |
Hierarchy
↳
SelectControl2Props
Properties
children
• Optional
children: DisplayChildren
[]
The children of the display component.
Inherited from
Defined in
sdk/components/FSComponent.ts:122
class
• Optional
class: string
CSS class(es) to apply to the root of the control.
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/SelectControl.tsx:74
data
• data: SubscribableArray
<T
>
The underlying data for this selection
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/SelectControl.tsx:40
dialogPosition
• Optional
dialogPosition: ContextMenuPosition
Defines the position where the context menu will appear. (Default: 'center')
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/SelectControl.tsx:46
dialogScrollStartIndex
• Optional
dialogScrollStartIndex: Subscribable
<number
>
A subscribable which provides the index of the item to which to scroll when the selection dialog is opened. If not defined, the index of the currently selected item is used instead, or 0 if there is no selected item.
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/SelectControl.tsx:58
getFocusPositionOnScroll
• Optional
getFocusPositionOnScroll: (direction
: ScrollDirection
) => FocusPosition
A function which returns how the control should focus its children when it is focused from a scroll.
Type declaration
▸ (direction
): FocusPosition
A function which returns how the control should focus its children when it is focused from a scroll.
Parameters
Name | Type |
---|---|
direction | ScrollDirection |
Returns
FocusPosition
Inherited from
G1000UiControlProps.getFocusPositionOnScroll
Defined in
sdk/components/controls/HardwareUiControl.tsx:56
innerKnobScroll
• Optional
innerKnobScroll: boolean
Whether or not the inner FMS knob scrolls also by default.
Inherited from
G1000UiControlProps.innerKnobScroll
Defined in
sdk/components/controls/HardwareUiControl.tsx:32
isolateScroll
• Optional
isolateScroll: boolean
When enabled, scroll commands will not propagate from this control to its parent while the control is focused.
Inherited from
G1000UiControlProps.isolateScroll
Defined in
sdk/components/controls/HardwareUiControl.tsx:38
nullSelectionText
• Optional
nullSelectionText: Subscribable
<string
>
A subscribable which provides text to display in the selected value area when there is no selected value. If not
defined, NONE
will be displayed.
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/SelectControl.tsx:52
on0
• on0: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
on1
• on1: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
on2
• on2: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
on3
• on3: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
on4
• on4: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
on5
• on5: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
on6
• on6: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
on7
• on7: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
on8
• on8: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
on9
• on9: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onA
• onA: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onAfterScroll
• Optional
onAfterScroll: (control
: HardwareUiControl
<Record
<string
, any
>, HardwareUiControlProps
>, index
: number
) => void
An event called when the scroll operation has completed.
Type declaration
▸ (control
, index
): void
An event called when the scroll operation has completed.
Parameters
Name | Type |
---|---|
control | HardwareUiControl <Record <string , any >, HardwareUiControlProps > |
index | number |
Returns
void
Inherited from
G1000UiControlProps.onAfterScroll
Defined in
sdk/components/controls/HardwareUiControl.tsx:62
onB
• onB: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onBKSP
• onBKSP: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onBlurred
• Optional
onBlurred: (source
: HardwareUiControl
<Record
<string
, any
>, HardwareUiControlProps
>) => void
An event called when the control loses focus.
Type declaration
▸ (source
): void
An event called when the control loses focus.
Parameters
Name | Type |
---|---|
source | HardwareUiControl <Record <string , any >, HardwareUiControlProps > |
Returns
void
Inherited from
Defined in
sdk/components/controls/HardwareUiControl.tsx:47
onC
• onC: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onClr
• onClr: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onClrLong
• onClrLong: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onCom
• onCom: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onCrs
• onCrs: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onD
• onD: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onDestroyed
• Optional
onDestroyed: (source
: HardwareUiControl
<Record
<string
, any
>, HardwareUiControlProps
>) => void
An event called when the control is destroyed.
Type declaration
▸ (source
): void
An event called when the control is destroyed.
Parameters
Name | Type |
---|---|
source | HardwareUiControl <Record <string , any >, HardwareUiControlProps > |
Returns
void
Inherited from
G1000UiControlProps.onDestroyed
Defined in
sdk/components/controls/HardwareUiControl.tsx:71
onDirectTo
• onDirectTo: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onDirectTo
onDisabled
• Optional
onDisabled: (source
: HardwareUiControl
<Record
<string
, any
>, HardwareUiControlProps
>) => void
An event called when the control is disabled.
Type declaration
▸ (source
): void
An event called when the control is disabled.
Parameters
Name | Type |
---|---|
source | HardwareUiControl <Record <string , any >, HardwareUiControlProps > |
Returns
void
Inherited from
G1000UiControlProps.onDisabled
Defined in
sdk/components/controls/HardwareUiControl.tsx:50
onDot
• onDot: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onE
• onE: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onEnabled
• Optional
onEnabled: (source
: HardwareUiControl
<Record
<string
, any
>, HardwareUiControlProps
>) => void
An event called when the control is enabled.
Type declaration
▸ (source
): void
An event called when the control is enabled.
Parameters
Name | Type |
---|---|
source | HardwareUiControl <Record <string , any >, HardwareUiControlProps > |
Returns
void
Inherited from
Defined in
sdk/components/controls/HardwareUiControl.tsx:53
onEnter
• onEnter: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onF
• onF: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onFPL
• onFPL: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onFocused
• Optional
onFocused: (source
: HardwareUiControl
<Record
<string
, any
>, HardwareUiControlProps
>) => void
An event called when the control is focused.
Type declaration
▸ (source
): void
An event called when the control is focused.
Parameters
Name | Type |
---|---|
source | HardwareUiControl <Record <string , any >, HardwareUiControlProps > |
Returns
void
Inherited from
Defined in
sdk/components/controls/HardwareUiControl.tsx:44
onG
• onG: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onH
• onH: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onHome
• onHome: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onI
• onI: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onInnerControlKnobDec
• onInnerControlKnobDec: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onInnerControlKnobDec
onInnerControlKnobInc
• onInnerControlKnobInc: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onInnerControlKnobInc
onInnerControlKnobPush
• onInnerControlKnobPush: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onInnerControlKnobPush
onJ
• onJ: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onJoystickDown
• onJoystickDown: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onJoystickDown
onJoystickLeft
• onJoystickLeft: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onJoystickLeft
onJoystickPush
• onJoystickPush: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onJoystickPush
onJoystickRight
• onJoystickRight: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onJoystickRight
onJoystickUp
• onJoystickUp: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onJoystickUp
onK
• onK: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onL
• onL: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onLowerKnobDec
• onLowerKnobDec: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onLowerKnobDec
onLowerKnobInc
• onLowerKnobInc: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onLowerKnobInc
onM
• onM: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onMenu
• onMenu: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onN
• onN: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onNav
• onNav: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onO
• onO: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onOuterControlKnobDec
• onOuterControlKnobDec: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onOuterControlKnobDec
onOuterControlKnobInc
• onOuterControlKnobInc: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onOuterControlKnobInc
onP
• onP: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onPlusMinus
• onPlusMinus: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onPlusMinus
onProc
• onProc: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onQ
• onQ: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onR
• onR: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onRangeDec
• onRangeDec: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onRangeDec
onRangeInc
• onRangeInc: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onRangeInc
onRegistered
• Optional
onRegistered: (source
: HardwareUiControl
<Record
<string
, any
>, HardwareUiControlProps
>) => void
An event called when a control is registered with this control.
Type declaration
▸ (source
): void
An event called when a control is registered with this control.
Parameters
Name | Type |
---|---|
source | HardwareUiControl <Record <string , any >, HardwareUiControlProps > |
Returns
void
Inherited from
G1000UiControlProps.onRegistered
Defined in
sdk/components/controls/HardwareUiControl.tsx:65
onS
• onS: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onSPC
• onSPC: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onScroll
• Optional
onScroll: (direction
: ScrollDirection
) => boolean
An event called when the control is scrolled.
Type declaration
▸ (direction
): boolean
An event called when the control is scrolled.
Parameters
Name | Type |
---|---|
direction | ScrollDirection |
Returns
boolean
Inherited from
Defined in
sdk/components/controls/HardwareUiControl.tsx:59
onSelectionDialogClosed
• Optional
onSelectionDialogClosed: (source
: SelectControl2
<T
>, selectionMade
: boolean
) => void
A function to be called when the selection dialog is closed.
Param
The SelectControl controlling the dialog that was closed.
Param
Whether a selection was made.
Type declaration
▸ (source
, selectionMade
): void
A function to be called when the selection dialog is closed.
Parameters
Name | Type | Description |
---|---|---|
source | SelectControl2 <T > | The SelectControl controlling the dialog that was closed. |
selectionMade | boolean | Whether a selection was made. |
Returns
void
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/SelectControl.tsx:71
onSelectionDialogOpened
• Optional
onSelectionDialogOpened: (source
: SelectControl2
<T
>) => void
A function to be called when the selection dialog is opened.
Param
The SelectControl controlling the dialog that was opened.
Type declaration
▸ (source
): void
A function to be called when the selection dialog is opened.
Parameters
Name | Type | Description |
---|---|---|
source | SelectControl2 <T > | The SelectControl controlling the dialog that was opened. |
Returns
void
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/SelectControl.tsx:64
onT
• onT: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onU
• onU: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onUnregistered
• Optional
onUnregistered: (source
: HardwareUiControl
<Record
<string
, any
>, HardwareUiControlProps
>) => void
An event called when a control is unregistered with this control.
Type declaration
▸ (source
): void
An event called when a control is unregistered with this control.
Parameters
Name | Type |
---|---|
source | HardwareUiControl <Record <string , any >, HardwareUiControlProps > |
Returns
void
Inherited from
G1000UiControlProps.onUnregistered
Defined in
sdk/components/controls/HardwareUiControl.tsx:68
onUpperKnobDec
• onUpperKnobDec: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onUpperKnobDec
onUpperKnobInc
• onUpperKnobInc: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onUpperKnobInc
onUpperKnobPush
• onUpperKnobPush: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onUpperKnobPush
onV
• onV: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onW
• onW: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onX
• onX: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onXpdr
• onXpdr: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onY
• onY: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onZ
• onZ: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
outerContainer
• outerContainer: NodeReference
<HTMLElement
>
The outer dialog container this control is in
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/SelectControl.tsx:43
reconcileChildBlur
• Optional
reconcileChildBlur: (index
: number
, child
: HardwareUiControl
<Record
<string
, any
>, HardwareUiControlProps
>) => number
| BlurReconciliation
A function which reconciles the focus state of the control's children when the control is focused with no focused children after a child has been blurred.
Param
The index of the child control that was blurred.
Param
The child control that was blurred.
Type declaration
▸ (index
, child
): number
| BlurReconciliation
A function which reconciles the focus state of the control's children when the control is focused with no focused children after a child has been blurred.
Parameters
Name | Type | Description |
---|---|---|
index | number | The index of the child control that was blurred. |
child | HardwareUiControl <Record <string , any >, HardwareUiControlProps > | The child control that was blurred. |
Returns
number
| BlurReconciliation
The index of the child to focus, or a blur reconciliation strategy.
Inherited from
G1000UiControlProps.reconcileChildBlur
Defined in
sdk/components/controls/HardwareUiControl.tsx:80
ref
• Optional
ref: NodeReference
<any
>
A reference to the display component.
Inherited from
Defined in
sdk/components/FSComponent.ts:125
requireChildFocus
• Optional
requireChildFocus: boolean
Whether the control requires one of its child controls to be focused for itself to be focused.
Inherited from
G1000UiControlProps.requireChildFocus
Defined in
sdk/components/controls/HardwareUiControl.tsx:41
viewService
• viewService: ViewService
The view service to use to open the selection dialog.
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/SelectControl.tsx:12
Methods
buildMenuItem
▸ buildMenuItem(item
, index
): ContextMenuItemDefinition
A function which provides menu item definitions for items.
Parameters
Name | Type | Description |
---|---|---|
item | T | An item. |
index | number | The index of the item. |
Returns
a menu item definition for the item.
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/SelectControl.tsx:28
onItemSelected
▸ onItemSelected(index
, item
, isRefresh
): void
A function to be called when an item is selected.
Parameters
Name | Type | Description |
---|---|---|
index | number | The index of the selected item. |
item | undefined | T | The item which was selected. |
isRefresh | boolean | Whether the item was selected as part of a refresh. |
Returns
void
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/SelectControl.tsx:20
renderSelectedItem
▸ renderSelectedItem(item
, index
): VNode
A function which renders items for display in the selected item area. If not defined, the item's menu item definition will be used to render the item instead.
Parameters
Name | Type | Description |
---|---|---|
item | T | An item. |
index | number | The index of the item. |
Returns
VNode
the rendered item, as a VNode.
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/SelectControl.tsx:37