Class: SoftKeyMenu
Defined in: src/garminsdk/softkey/SoftKeyMenu.ts:33
A Garmin softkey menu. Each menu contains up to 12 indexed menu items, each of which defines the display and behavior of a corresponding softkey.
Constructors
Constructor
new SoftKeyMenu(
menuSystem):SoftKeyMenu
Defined in: src/garminsdk/softkey/SoftKeyMenu.ts:45
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: src/garminsdk/softkey/SoftKeyMenu.ts:45
The menu system that will manage this menu.
SOFTKEY_COUNT
readonlystaticSOFTKEY_COUNT:12=12
Defined in: src/garminsdk/softkey/SoftKeyMenu.ts:36
The number of softkeys in each menu.
Methods
addItem()
addItem(
index,label,handler?,value?,disabled?):SoftKeyMenuItem
Defined in: src/garminsdk/softkey/SoftKeyMenu.ts:57
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. Must be between 0 and 11, inclusive. |
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
The new menu item.
Throws
Error if index is out of bounds.
destroy()
destroy():
void
Defined in: src/garminsdk/softkey/SoftKeyMenu.ts:135
Destroys this menu.
Returns
void
forEach()
forEach(
each):void
Defined in: src/garminsdk/softkey/SoftKeyMenu.ts:116
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):null|SoftKeyMenuItem
Defined in: src/garminsdk/softkey/SoftKeyMenu.ts:97
Gets a menu item.
Parameters
| Parameter | Type | Description |
|---|---|---|
index | number | The index of the menu item. Must be between 0 and 11, inclusive. |
Returns
null | SoftKeyMenuItem
The requested menu item.
Throws
Error if index is out of bounds.
handleBack()
handleBack():
void
Defined in: src/garminsdk/softkey/SoftKeyMenu.ts:108
Handles a back menu action.
Returns
void
handleItemPressed()
handleItemPressed(
index):void
Defined in: src/garminsdk/softkey/SoftKeyMenu.ts:124
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: src/garminsdk/softkey/SoftKeyMenu.ts:83
Removes a menu item from the menu.
Parameters
| Parameter | Type | Description |
|---|---|---|
index | number | The softkey index to remove the menu item from. Must be between 0 and 11, inclusive. |
Returns
void
Throws
Error if index is out of bounds.