com.smartdevicelink.managers.screen.menu

Class MenuManager

java.lang.Object

com.smartdevicelink.managers.BaseSubManager

com.smartdevicelink.managers.screen.menu.MenuManager

public class MenuManager
extends BaseSubManager

MenuManager

Note: This class must be accessed through the ScreenManager via the SdlManager. Do not instantiate it by itself.

The MenuManager takes MenuCell objects and creates and sends all necessary RPCs to build out a menu

Field Summary

Fields inherited from class com.smartdevicelink.managers.BaseSubManager

ERROR, internalInterface, LIMITED, READY, SETTING_UP, SHUTDOWN

Constructor Summary

Constructors

Constructor and Description
MenuManager(ISdl internalInterface, FileManager fileManager)

Method Summary

Modifier and Type	Method and Description
void	dispose() Called when manager is being torn down
DynamicMenuUpdatesMode	getDynamicMenuUpdatesMode()
List<MenuCell>	getMenuCells() Returns current list of menu cells
MenuConfiguration	getMenuConfiguration()
boolean	openMenu() Opens the Main Menu
boolean	openSubMenu(MenuCell cell) Opens a subMenu.
void	setDynamicUpdatesMode(DynamicMenuUpdatesMode value)
void	setMenuCells(List<MenuCell> cells) Creates and sends all associated Menu RPCs
void	setMenuConfiguration(MenuConfiguration menuConfiguration) This method is called via the screen manager to set the menuConfiguration.
void	start(CompletionListener listener) Starts up a BaseSubManager, and calls provided callback once BaseSubManager is done setting up or failed setup.

Methods inherited from class com.smartdevicelink.managers.BaseSubManager

getState, handleTransportUpdated, onTransportUpdate, transitionToState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MenuManager

public MenuManager(ISdl internalInterface,
                   FileManager fileManager)

Method Detail

start

public void start(CompletionListener listener)

Description copied from class: BaseSubManager

Starts up a BaseSubManager, and calls provided callback once BaseSubManager is done setting up or failed setup.

Overrides:

start in class BaseSubManager

Parameters:

listener - CompletionListener that is called once the BaseSubManager's state is READY, LIMITED, or ERROR

dispose

public void dispose()

Description copied from class: BaseSubManager

Called when manager is being torn down

Overrides:

dispose in class BaseSubManager

setDynamicUpdatesMode

public void setDynamicUpdatesMode(@NonNull
                                  DynamicMenuUpdatesMode value)

getDynamicMenuUpdatesMode

public DynamicMenuUpdatesMode getDynamicMenuUpdatesMode()

Returns:

The currently set DynamicMenuUpdatesMode. It defaults to ON_WITH_COMPAT_MODE

setMenuCells

public void setMenuCells(@NonNull
                         List<MenuCell> cells)

Creates and sends all associated Menu RPCs

Parameters:

cells - - the menu cells that are to be sent to the head unit, including their sub-cells.

getMenuCells

public List<MenuCell> getMenuCells()

Returns current list of menu cells

Returns:

a List of Currently set menu cells

openMenu

public boolean openMenu()

Opens the Main Menu

openSubMenu

public boolean openSubMenu(@NonNull
                           MenuCell cell)

Opens a subMenu.

Parameters:

cell - - A SubMenu cell whose sub menu you wish to open

setMenuConfiguration

public void setMenuConfiguration(@NonNull
                                 MenuConfiguration menuConfiguration)

This method is called via the screen manager to set the menuConfiguration. The menuConfiguration.SubMenuLayout value will be used when a menuCell with sub-cells has a null value for SubMenuLayout

Parameters:

menuConfiguration - - The default menuConfiguration

getMenuConfiguration

public MenuConfiguration getMenuConfiguration()