Skip to main content

Class: SoftKeyMenu

A softkey menu instance.

Hierarchy

Constructors

constructor

new SoftKeyMenu(menuSystem): SoftKeyMenu

Creates an instance of a SoftKeyMenu.

Parameters

NameTypeDescription
menuSystemSoftKeyMenuSystemThe menu system that will manage this menu.

Returns

SoftKeyMenu

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Menus/SoftKeyMenu.ts:44

Properties

Protected menuSystem: SoftKeyMenuSystem

The menu system that will manage this menu.

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Menus/SoftKeyMenu.ts:44


EmptyMenuItem

Static EmptyMenuItem: MenuItem

An empty menu item.

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Menus/SoftKeyMenu.ts:117

Methods

addItem

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

Adds a menu item to the softkey menu.

Parameters

NameTypeDefault valueDescription
indexnumberundefinedThe softkey index to add the menu item to.
labelstringundefinedThe label of the menu item.
handler?(menu: SoftKeyMenu) => voidundefinedThe handler to call when the menu item is selected.
value?string | booleanundefinedThe value of the menu item, if any.
disabledbooleanfalseWhether or not the menu item is disabled.

Returns

void

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Menus/SoftKeyMenu.ts:54


forEach

forEach(each): void

Iterates over the menu items.

Parameters

NameTypeDescription
each(menuItem: MenuItem, index: number) => voidThe function to run over each menu item.

Returns

void

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Menus/SoftKeyMenu.ts:97


getItem

getItem(index): MenuItem

Gets a menu item.

Parameters

NameTypeDescription
indexnumberThe index of the menu item.

Returns

MenuItem

The requested menu item.

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Menus/SoftKeyMenu.ts:82


handleBack

handleBack(): void

Handles a back menu action.

Returns

void

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Menus/SoftKeyMenu.ts:89


handleItemPressed

handleItemPressed(index): void

Handles when a menu item is pressed.

Parameters

NameTypeDescription
indexnumberThe index of the menu item that was pressed.

Returns

void

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Menus/SoftKeyMenu.ts:108


removeItem

removeItem(index): void

Removes a menu item from the menu.

Parameters

NameTypeDescription
indexnumberThe softkey index to remove the menu item from.

Returns

void

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Menus/SoftKeyMenu.ts:73