Class: SoftKeyEnumUserSettingController<T, K>
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Menus/SoftKeyUserSettingControllers.ts:72
A controller which binds a value indicator softkey to a user setting. Once bound, each press of the softkey will cycle through possible user setting values.
Type Parameters
| Type Parameter |
|---|
T extends UserSettingRecord |
K extends keyof T & string |
Constructors
Constructor
new SoftKeyEnumUserSettingController<
T,K>(softkeyMenu,softkeyIndex,softkeyLabel,settingManager,settingName,textMap,nextFunc):SoftKeyEnumUserSettingController<T,K>
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Menus/SoftKeyUserSettingControllers.ts:93
Constructor.
Parameters
| Parameter | Type | Description |
|---|---|---|
softkeyMenu | SoftKeyMenu | The softkey menu to which this controller's bound softkey belongs. |
softkeyIndex | number | The index in the softkey menu at which this controller's bound softkey is located. |
softkeyLabel | string | The text label of this controller's bound softkey. |
settingManager | UserSettingManager<T> | This controller's setting manager. |
settingName | K | The name of this controller's setting. |
textMap | (value) => string | A function which maps setting values to their text representations. |
nextFunc | (currentValue) => NonNullable<T[K]> | A function which gets the next setting value given the current setting value. |
Returns
SoftKeyEnumUserSettingController<T, K>
Methods
destroy()
destroy():
void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Menus/SoftKeyUserSettingControllers.ts:122
Destroys this controller. This will remove the softkey menu item bound to this controller's setting.
Returns
void
init()
init():
void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Menus/SoftKeyUserSettingControllers.ts:107
Initializes this controller. This will create a softkey menu item and bind it to this controller's setting.
Returns
void