Class: SoftKeyMenuSystem
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/Menus/SoftKeyMenuSystem.ts:9
A system that manages the Garmin softkey menus.
Constructors
Constructor
new SoftKeyMenuSystem(
bus,hEventPrefix):SoftKeyMenuSystem
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/Menus/SoftKeyMenuSystem.ts:39
Creates an instance of the MenuSystem.
Parameters
| Parameter | Type | Description |
|---|---|---|
bus | EventBus | The event bus to use with this instance. |
hEventPrefix | string | The event prefix to use for the softkey H Events. |
Returns
SoftKeyMenuSystem
Properties
bus
bus:
EventBus
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/Menus/SoftKeyMenuSystem.ts:39
The event bus to use with this instance.
Methods
addMenu()
addMenu(
name,entry):void
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/Menus/SoftKeyMenuSystem.ts:65
Adds a menu to the menu system.
Parameters
| Parameter | Type | Description |
|---|---|---|
name | string | The route to the menu to add this menu entry to. |
entry | SoftKeyMenu | The menu entry to add. |
Returns
void
attachSoftKeys()
attachSoftKeys(
softKeys):void
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/Menus/SoftKeyMenuSystem.ts:115
Attaches the softkeys display component to the menu system.
Parameters
| Parameter | Type | Description |
|---|---|---|
softKeys | SoftKeyBar | The softkeys display component instance. |
Returns
void
back()
back():
void
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/Menus/SoftKeyMenuSystem.ts:93
Pops a menu off the stack and returns to the previous menu.
Returns
void
clear()
clear():
void
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/Menus/SoftKeyMenuSystem.ts:106
Clears the menu stack.
Returns
void
getMenu()
getMenu(
menuName):SoftKeyMenu
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/Menus/SoftKeyMenuSystem.ts:56
Gets the softkey menu registered with a given name.
Parameters
| Parameter | Type | Description |
|---|---|---|
menuName | string | Name of the menu. |
Returns
The requested soft keymenu.
pushMenu()
pushMenu(
name):void
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/Menus/SoftKeyMenuSystem.ts:73
Pushes a menu onto the menu system stack.
Parameters
| Parameter | Type | Description |
|---|---|---|
name | string | The name of the menu to push. |
Returns
void
replaceMenu()
replaceMenu(
name):void
Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/Menus/SoftKeyMenuSystem.ts:82
Replaces one menu with another on top of the stack.
Parameters
| Parameter | Type | Description |
|---|---|---|
name | string | The name of the menu to activate. |
Returns
void