Class: UserSettingTransformedSelectController<T, K, V>
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingSelectController.ts:67
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.
Extends
UserSettingController
<T
,K
>
Type Parameters
Type Parameter |
---|
T extends UserSettingRecord |
K extends keyof T & string |
V |
Constructors
Constructor
new UserSettingTransformedSelectController<
T
,K
,V
>(settingManager
,settingName
,values
,transformedValues
,selectControlRef
):UserSettingTransformedSelectController
<T
,K
,V
>
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingSelectController.ts:83
Constructor.
Parameters
Parameter | 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
Properties
itemSelectedHandler()
itemSelectedHandler: (
index
,item
,isRefresh
) =>void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingSelectController.ts:72
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.
A callback which is called when an item is selected using the SelectControl component.
Parameters
Parameter | Type | Description |
---|---|---|
index | number | The index of the selected item. |
item | undefined | V | The selected item. |
isRefresh | boolean | Whether the selection was made due to a refresh. |
Returns
void
setting
readonly
setting:UserSetting
<NonNullable
<T
[K
]>>
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingController.ts:8
The setting associated with this controller.
Inherited from
settingManager
readonly
settingManager:UserSettingManager
<T
>
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingSelectController.ts:84
This controller's settings manager.
Inherited from
UserSettingController
.settingManager
settingName
readonly
settingName:K
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingSelectController.ts:85
The name of the setting associated with this controller.
Inherited from
UserSettingController
.settingName
transformedValues
readonly
transformedValues:SubscribableArray
<V
>
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingSelectController.ts:87
A subscribable array which provides the transformed values displayed by the SelectControl component controlled by this controller.
values
readonly
values:SubscribableArray
<NonNullable
<T
[K
]>>
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingSelectController.ts:86
A subscribable array which provides the values this controller can assign to its setting.
Methods
init()
init():
void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/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
Inherited from
onSettingChanged()
protected
onSettingChanged(value
):void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingSelectController.ts:94
A callback which is called when value of this control's setting is changed.
Parameters
Parameter | Type | Description |
---|---|---|
value | NonNullable <T [K ]> | The new value of the setting. |
Returns
void