Class: CasSoftKeyMenu

Defined in: workingtitle-instruments-g3000/html_ui/PFD/SoftKey/CasSoftKeyMenu.ts:10

The CAS softkey menu.

Extends

• SoftKeyMenu

Constructors

Constructor

new CasSoftKeyMenu(menuSystem, pfdIndex, isSplit): CasSoftKeyMenu

Defined in: workingtitle-instruments-g3000/html_ui/PFD/SoftKey/CasSoftKeyMenu.ts:25

Creates a new instance of CasSoftKeyMenu.

Parameters

Parameter	Type	Description
menuSystem	SoftKeyMenuSystem	The softkey menu system.
pfdIndex	PfdIndex	The index of the PFD instrument to which this menu belongs.
isSplit	boolean	Whether the menu is a split-mode menu.

Returns

CasSoftKeyMenu

Overrides

SoftKeyMenu.constructor

Properties

menuSystem

protected menuSystem: SoftKeyMenuSystem

Defined in: garminsdk/softkey/SoftKeyMenu.ts:47

The menu system that will manage this menu.

Inherited from

SoftKeyMenu.menuSystem

---

SOFTKEY_COUNT

readonly static SOFTKEY_COUNT: 12 = 12

Defined in: garminsdk/softkey/SoftKeyMenu.ts:38

The number of softkeys in each menu.

Inherited from

SoftKeyMenu.SOFTKEY_COUNT

Methods

addItem()

addItem(index, label, handler?, value?, disabled?): SoftKeyMenuItem

Defined in: garminsdk/softkey/SoftKeyMenu.ts:59

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

SoftKeyMenuItem

The new menu item.

Throws

Error if index is out of bounds.

Inherited from

SoftKeyMenu.addItem

---

destroy()

destroy(): void

Defined in: workingtitle-instruments-g3000/html_ui/PFD/SoftKey/CasSoftKeyMenu.ts:51

Destroys this menu.

Returns

void

Overrides

SoftKeyMenu.destroy

---

forEach()

forEach(each): void

Defined in: garminsdk/softkey/SoftKeyMenu.ts:119

Iterates over the menu items.

Parameters

Parameter	Type	Description
each	(menuItem, index) => void	The function to run over each menu item.

Returns

void

Inherited from

SoftKeyMenu.forEach

---

getItem()

getItem(index): SoftKeyMenuItem | null

Defined in: garminsdk/softkey/SoftKeyMenu.ts:100

Gets a menu item.

Parameters

Parameter	Type	Description
index	number	The index of the menu item. Must be between 0 and 11, inclusive.

Returns

SoftKeyMenuItem | null

The requested menu item.

Throws

Error if index is out of bounds.

Inherited from

SoftKeyMenu.getItem

---

handleBack()

handleBack(): void

Defined in: garminsdk/softkey/SoftKeyMenu.ts:111

Handles a back menu action.

Returns

void

Inherited from

SoftKeyMenu.handleBack

---

handleItemPressed()

handleItemPressed(index): void

Defined in: garminsdk/softkey/SoftKeyMenu.ts:127

Handles when a menu item is pressed.

Parameters

Parameter	Type	Description
index	number	The index of the menu item that was pressed.

Returns

void

Inherited from

SoftKeyMenu.handleItemPressed

---

removeItem()

removeItem(index): void

Defined in: garminsdk/softkey/SoftKeyMenu.ts:86

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.

Inherited from

SoftKeyMenu.removeItem