Abstract Class: UserSettingController<T, K>

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UserSettings/UserSettingController.ts:6

A controller which binds a user setting to a control component.

Extended by

• UserSettingNumberController
• UserSettingSelectController
• UserSettingTransformedSelectController
• UserSettingToggleController

Type Parameters

Type Parameter
T extends UserSettingRecord
K extends keyof T & string

Constructors

Constructor

new UserSettingController<T, K>(settingManager, settingName): UserSettingController<T, K>

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UserSettings/UserSettingController.ts:15

Constructor.

Parameters

Parameter	Type	Description
settingManager	UserSettingManager<T>	This controller's settings manager.
settingName	K	The name of the setting associated with this controller.

Returns

UserSettingController<T, K>

Properties

setting

readonly setting: UserSetting<ToNonNullable<PropertyTypeOf<T, K>>>

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UserSettings/UserSettingController.ts:8

The setting associated with this controller.

---

settingManager

readonly settingManager: UserSettingManager<T>

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UserSettings/UserSettingController.ts:15

This controller's settings manager.

---

settingName

readonly settingName: K

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UserSettings/UserSettingController.ts:15

The name of the setting associated with this controller.

Methods

init()

init(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UserSettings/UserSettingController.ts:23

Initializes this controller. This will immediately change the state of this controller's control component to reflect the current value of this controller's setting. Furthermore, any future changes to the setting's value will be synced to the control component.

Returns

void

---

onSettingChanged()

abstract protected onSettingChanged(value): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UserSettings/UserSettingController.ts:31

A callback which is called when value of this control's setting is changed.

Parameters

Parameter	Type	Description
value	T[K]	The new value of the setting.

Returns

void