Class: SoftKeyMenu
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/Menus/SoftKeyMenu.ts:35
A softkey menu instance.
Extended by
EngineMenuFuelRemMenuInsetMenuLeanMenuMapOptMenuMFDFPLRootMenuMFDRootMenuSystemMenuViewMenuALTUnitsMenuMapHSILayoutMenuMapHSIMenuPFDOptMenuRootMenuSVTMenuWindMenuXPDRCodeMenuXPDRMenuMFDTrafficMapAltitudeMenuMFDTrafficMapMotionDurationMenuMFDTrafficMapMotionMenu
Constructors
Constructor
new SoftKeyMenu(
menuSystem):SoftKeyMenu
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/Menus/SoftKeyMenu.ts:44
Creates an instance of a SoftKeyMenu.
Parameters
| Parameter | Type | Description |
|---|---|---|
menuSystem | SoftKeyMenuSystem | The menu system that will manage this menu. |
Returns
SoftKeyMenu
Properties
menuSystem
protectedmenuSystem:SoftKeyMenuSystem
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/Menus/SoftKeyMenu.ts:44
The menu system that will manage this menu.
EmptyMenuItem
staticEmptyMenuItem:MenuItem
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/Menus/SoftKeyMenu.ts:117
An empty menu item.
Methods
addItem()
addItem(
index,label,handler?,value?,disabled?):void
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/Menus/SoftKeyMenu.ts:54
Adds a menu item to the softkey menu.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
index | number | undefined | The softkey index to add the menu item to. |
label | string | undefined | The label of the menu item. |
handler? | (menu) => void | undefined | The handler to call when the menu item is selected. |
value? | string | boolean | undefined | The value of the menu item, if any. |
disabled? | boolean | false | Whether or not the menu item is disabled. |
Returns
void
forEach()
forEach(
each):void
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/Menus/SoftKeyMenu.ts:97
Iterates over the menu items.
Parameters
| Parameter | Type | Description |
|---|---|---|
each | (menuItem, index) => void | The function to run over each menu item. |
Returns
void
getItem()
getItem(
index):MenuItem
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/Menus/SoftKeyMenu.ts:82
Gets a menu item.
Parameters
| Parameter | Type | Description |
|---|---|---|
index | number | The index of the menu item. |
Returns
The requested menu item.
handleBack()
handleBack():
void
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/Menus/SoftKeyMenu.ts:89
Handles a back menu action.
Returns
void
handleItemPressed()
handleItemPressed(
index):void
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/Menus/SoftKeyMenu.ts:108
Handles when a menu item is pressed.
Parameters
| Parameter | Type | Description |
|---|---|---|
index | number | The index of the menu item that was pressed. |
Returns
void
removeItem()
removeItem(
index):void
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/Menus/SoftKeyMenu.ts:73
Removes a menu item from the menu.
Parameters
| Parameter | Type | Description |
|---|---|---|
index | number | The softkey index to remove the menu item from. |
Returns
void