IviInstanceMenuItemCollectionConfigurator

interface IviInstanceMenuItemCollectionConfigurator

Interface to configure the menu items of an IVI instance.

The order of the map entries defines the (initial) order of the menu items in the main menu.

Each map entry maps a MenuItemConfig instance to a FrontendConfig instance. This mapping defines the frontend that is associated with the menu item.

Each mapped FrontendConfig instance must be present in the IVI instance configuration. The FrontendConfig instance is matched against its FrontendConfig.frontendBuilderName, FrontendConfig.implementationModule and FrontendConfig.subPackageName property values.

Types

Link copied to clipboard
interface InsertConfigurator

Interface to insert menu items before or after another.

Functions

Link copied to clipboard
abstract fun addAllFirst(items: LinkedHashMap<MenuItemConfig, FrontendConfig>)

Adds all the given items map to the beginning of the menu.

abstract fun addAllFirst(items: List<Pair<MenuItemConfig, FrontendConfig>>)

Adds all the given items pairs to the beginning of the menu.

Link copied to clipboard
abstract fun addAllLast(items: LinkedHashMap<MenuItemConfig, FrontendConfig>)

Adds all the given items map to the end of the menu.

abstract fun addAllLast(items: List<Pair<MenuItemConfig, FrontendConfig>>)

Adds all the given items pairs to the end of the menu.

Link copied to clipboard
abstract fun addFirst(vararg item: Pair<MenuItemConfig, FrontendConfig>)

Adds the given item pair to the beginning of the menu.

Link copied to clipboard
abstract fun addLast(vararg item: Pair<MenuItemConfig, FrontendConfig>)

Adds the given item pair to the end of the menu.

Link copied to clipboard
abstract fun after(menuItem: MenuItemConfig, action: Action<IviInstanceMenuItemCollectionConfigurator.InsertConfigurator>)

Adds the items added through action after menuItem.

Link copied to clipboard
abstract fun before(menuItem: MenuItemConfig, action: Action<IviInstanceMenuItemCollectionConfigurator.InsertConfigurator>)

Adds the items added through action before menuItem.

Link copied to clipboard
abstract fun remove(vararg frontend: FrontendConfig)

Removes the menu item that is associated with frontend.

abstract fun remove(vararg menuItem: MenuItemConfig)

Removes the given menuItem.

Link copied to clipboard
abstract fun replace(old: MenuItemConfig, new: Pair<MenuItemConfig, FrontendConfig>)

Replaces old menu item with new.

Link copied to clipboard
abstract fun replaceAll(items: LinkedHashMap<MenuItemConfig, FrontendConfig>)
abstract fun replaceAll(items: List<Pair<MenuItemConfig, FrontendConfig>>)

Replaces all configured menu items with the items.