Class: SoftKeyEnumUserSettingController<T, K>
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
| Name | Type |
|---|---|
T | extends UserSettingRecord |
K | extends keyof T & string |
Constructors
constructor
• new SoftKeyEnumUserSettingController<T, K>(softkeyMenu, softkeyIndex, softkeyLabel, settingManager, settingName, textMap, nextFunc): SoftKeyEnumUserSettingController<T, K>
Constructor.
Type parameters
| Name | Type |
|---|---|
T | extends UserSettingRecord |
K | extends string |
Parameters
| Name | 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: NonNullable<T[K]>) => string | A function which maps setting values to their text representations. |
nextFunc | (currentValue: NonNullable<T[K]>) => NonNullable<T[K]> | A function which gets the next setting value given the current setting value. |
Returns
SoftKeyEnumUserSettingController<T, K>
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Menus/SoftKeyUserSettingControllers.ts:93
Methods
destroy
▸ destroy(): void
Destroys this controller. This will remove the softkey menu item bound to this controller's setting.
Returns
void
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Menus/SoftKeyUserSettingControllers.ts:122
init
▸ init(): void
Initializes this controller. This will create a softkey menu item and bind it to this controller's setting.
Returns
void
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Menus/SoftKeyUserSettingControllers.ts:107