Skip to main content

Class: SoftKeyBooleanUserSettingController<T, K>

A controller which binds a status bar softkey to a user setting that takes a boolean value. Once bound, each press of the softkey will toggle the value of the setting.

Type parameters

NameType
Textends UserSettingRecord
Kextends keyof UserSettingValueFilter<T, boolean> & string

Constructors

constructor

new SoftKeyBooleanUserSettingController<T, K>(softkeyMenu, softkeyIndex, softkeyLabel, settingManager, settingName): SoftKeyBooleanUserSettingController<T, K>

Constructor.

Type parameters

NameType
Textends UserSettingRecord
Kextends string

Parameters

NameTypeDescription
softkeyMenuSoftKeyMenuThe softkey menu to which this controller's bound softkey belongs.
softkeyIndexnumberThe index in the softkey menu at which this controller's bound softkey is located.
softkeyLabelstringThe text label of this controller's bound softkey.
settingManagerUserSettingManager<T>This controller's setting manager.
settingNameKThe name of this controller's setting.

Returns

SoftKeyBooleanUserSettingController<T, K>

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Menus/SoftKeyUserSettingControllers.ts:28

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:55


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:40