Class: UserSettingTransformedSelectController<T, K, V>
A controller which binds a user setting that can take one of several enumerated values to a SelectControl component which displays transformed versions of the setting values.
Type parameters
Name | Type |
---|---|
T | extends UserSettingRecord |
K | extends keyof T & string |
V | V |
Hierarchy
UserSettingController
<T
,K
>↳
UserSettingTransformedSelectController
Constructors
constructor
• new UserSettingTransformedSelectController<T
, K
, V
>(settingManager
, settingName
, values
, transformedValues
, selectControlRef
): UserSettingTransformedSelectController
<T
, K
, V
>
Constructor.
Type parameters
Name | Type |
---|---|
T | extends UserSettingRecord |
K | extends string |
V | V |
Parameters
Name | Type | Description |
---|---|---|
settingManager | UserSettingManager <T > | This controller's settings manager. |
settingName | K | The name of the setting associated with this controller. |
values | SubscribableArray <NonNullable <T [K ]>> | A subscribable array which provides the values this controller can assign to its setting. |
transformedValues | SubscribableArray <V > | A subscribable array which provides the transformed values displayed by the SelectControl component controlled by this controller. |
selectControlRef | NodeReference <SelectControl <V >> | A node reference to the SelectControl which this controller controls. |
Returns
UserSettingTransformedSelectController
<T
, K
, V
>
Overrides
UserSettingController.constructor
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingSelectController.ts:83
Properties
itemSelectedHandler
• itemSelectedHandler: (index
: number
, item
: undefined
| V
, isRefresh
: boolean
) => void
A function which handles item selected events from the SelectControl component which this controller controls.
This handler should be passed to the SelectControl component via its onItemSelected
prop.
Type declaration
▸ (index
, item
, isRefresh
): void
A function which handles item selected events from the SelectControl component which this controller controls.
This handler should be passed to the SelectControl component via its onItemSelected
prop.
Parameters
Name | Type |
---|---|
index | number |
item | undefined | V |
isRefresh | boolean |
Returns
void
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingSelectController.ts:72
setting
• Readonly
setting: UserSetting
<NonNullable
<T
[K
]>>
The setting associated with this controller.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingController.ts:8
settingManager
• Readonly
settingManager: UserSettingManager
<T
>
This controller's settings manager.
Inherited from
UserSettingController.settingManager
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingSelectController.ts:84
settingName
• Readonly
settingName: K
The name of the setting associated with this controller.
Inherited from
UserSettingController.settingName
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingSelectController.ts:85
transformedValues
• Readonly
transformedValues: SubscribableArray
<V
>
A subscribable array which provides the transformed values displayed by the SelectControl component controlled by this controller.
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingSelectController.ts:87
values
• Readonly
values: SubscribableArray
<NonNullable
<T
[K
]>>
A subscribable array which provides the values this controller can assign to its setting.
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingSelectController.ts:86
Methods
init
▸ init(): void
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
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingController.ts:23
onSettingChanged
▸ onSettingChanged(value
): void
A callback which is called when value of this control's setting is changed.
Parameters
Name | Type | Description |
---|---|---|
value | NonNullable <T [K ]> | The new value of the setting. |
Returns
void
Overrides
UserSettingController.onSettingChanged
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingSelectController.ts:94