com.smartdevicelink.managers.screen.menu

Class MenuCell

java.lang.Object

com.smartdevicelink.managers.screen.menu.MenuCell

All Implemented Interfaces:

Cloneable

public class MenuCell
extends Object
implements Cloneable

Constructor Summary

Constructors

Constructor and Description
MenuCell(String title, MenuLayout subMenuLayout, SdlArtwork icon, List<MenuCell> subCells) Deprecated.
MenuCell(String title, SdlArtwork icon, List<String> voiceCommands, MenuSelectionListener listener) Deprecated.
MenuCell(String title, String secondaryText, String tertiaryText, MenuLayout subMenuLayout, SdlArtwork icon, SdlArtwork secondaryArtwork, List<MenuCell> subCells) Creates a new MenuCell Object with multiple parameters and optional fields set NOTE: because this has sub-cells, there does not need to be a listener
MenuCell(String title, String secondaryText, String tertiaryText, SdlArtwork icon, SdlArtwork secondaryArtwork, List<String> voiceCommands, MenuSelectionListener listener) Creates a new MenuCell Object with multiple parameters and optional fields set

Method Summary

Modifier and Type	Method and Description
MenuCell	clone() Creates a deep copy of the object
boolean	equals(Object o) Uses our custom hashCode for MenuCell objects
SdlArtwork	getIcon() Gets the icon for the cell
MenuSelectionListener	getMenuSelectionListener() The listener that gets triggered when the menuCell object is selected
SdlArtwork	getSecondaryArtwork() Get the cell's secondaryArtwork
String	getSecondaryText() Get the cell's secondaryText
List<MenuCell>	getSubCells() The list of subCells for this menu item
MenuLayout	getSubMenuLayout() The submenu's layout that the subCells will be shown in.
String	getTertiaryText() Get the cell's tertiaryText
String	getTitle() Gets the title of the menu cell
List<String>	getVoiceCommands() the string list used by the IVI system for voice commands
int	hashCode() Note: You should compare using the equals(Object) method.
void	setIcon(SdlArtwork icon) Sets the icon of the menu cell
void	setMenuSelectionListener(MenuSelectionListener menuSelectionListener) The listener for when a menu item is selected
void	setSecondaryArtwork(SdlArtwork secondaryArtwork) Sets the secondaryArtwork
void	setSecondaryText(String secondaryText) Sets the secondaryText
void	setSubCells(List<MenuCell> subCells) The list of MenuCells that can be set as subCells
void	setSubMenuLayout(MenuLayout subMenuLayout) The submenu's layout that the subCells will be shown in.
void	setTertiaryText(String tertiaryText) Sets the tertiaryText
void	setTitle(String title) Sets the title of the menu cell
void	setVoiceCommands(List<String> voiceCommands) A list of Strings that will be used for voice commands

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MenuCell

@Deprecated
public MenuCell(@NonNull
                            String title,
                            @Nullable
                            SdlArtwork icon,
                            @Nullable
                            List<String> voiceCommands,
                            @Nullable
                            MenuSelectionListener listener)

Deprecated.

Creates a new MenuCell Object with multiple parameters set

Parameters:

title - The cell's primary text

icon - The cell's image

voiceCommands - Voice commands that will activate the menu cell

listener - Calls the code that will be run when the menu cell is selected

MenuCell

public MenuCell(@NonNull
                String title,
                @Nullable
                String secondaryText,
                @Nullable
                String tertiaryText,
                @Nullable
                SdlArtwork icon,
                @Nullable
                SdlArtwork secondaryArtwork,
                @Nullable
                List<String> voiceCommands,
                @Nullable
                MenuSelectionListener listener)

Creates a new MenuCell Object with multiple parameters and optional fields set

Parameters:

title - The cell's primary text

secondaryText - The cell's secondary text

tertiaryText - The cell's tertiary text

icon - The cell's image

secondaryArtwork - The cell's secondary image

voiceCommands - Voice commands that will activate the menu cell

listener - Calls the code that will be run when the menu cell is selected

MenuCell

@Deprecated
public MenuCell(@NonNull
                            String title,
                            @Nullable
                            MenuLayout subMenuLayout,
                            @Nullable
                            SdlArtwork icon,
                            @Nullable
                            List<MenuCell> subCells)

Deprecated.

Creates a new MenuCell Object with multiple parameters set NOTE: because this has sub-cells, there does not need to be a listener

Parameters:

title - The cell's primary text

subMenuLayout - The submenu's layout that the subCells will be shown in. If `null`, the default submenu layout in the screen manager's `MenuConfiguration` will be used.

icon - The cell's image

subCells - The sub-cells for the sub menu that will appear when the cell is selected

MenuCell

public MenuCell(@NonNull
                String title,
                @Nullable
                String secondaryText,
                @Nullable
                String tertiaryText,
                @Nullable
                MenuLayout subMenuLayout,
                @Nullable
                SdlArtwork icon,
                @Nullable
                SdlArtwork secondaryArtwork,
                @Nullable
                List<MenuCell> subCells)

Creates a new MenuCell Object with multiple parameters and optional fields set NOTE: because this has sub-cells, there does not need to be a listener

Parameters:

title - The cell's primary text

secondaryText - The cell's secondary text

tertiaryText - The cell's tertiary text

subMenuLayout - The submenu's layout that the subCells will be shown in. If `null`, the default submenu layout in the screen manager's `MenuConfiguration` will be used.

icon - The cell's image

secondaryArtwork - The cell's secondary image

subCells - The sub-cells for the sub menu that will appear when the cell is selected

Method Detail

setTitle

public void setTitle(@NonNull
                     String title)

Sets the title of the menu cell

Parameters:

title - - the title of the cell. Required

getTitle

public String getTitle()

Gets the title of the menu cell

Returns:

The title of the cell object

setIcon

public void setIcon(SdlArtwork icon)

Sets the icon of the menu cell

Parameters:

icon - - the icon being set, of type SdlArtwork

getIcon

public SdlArtwork getIcon()

Gets the icon for the cell

Returns:

the SdlArtwork icon for the cell

setVoiceCommands

public void setVoiceCommands(List<String> voiceCommands)

A list of Strings that will be used for voice commands

Parameters:

voiceCommands - - the string list used by the IVI system for voice commands

getVoiceCommands

public List<String> getVoiceCommands()

the string list used by the IVI system for voice commands

Returns:

The String List used by the menu cell object for voice commands

setSubCells

public void setSubCells(List<MenuCell> subCells)

The list of MenuCells that can be set as subCells

Parameters:

subCells - - the list of subCells for this menu item

getSubCells

public List<MenuCell> getSubCells()

The list of subCells for this menu item

Returns:

a list of MenuCells that are the subCells for this menu item

setMenuSelectionListener

public void setMenuSelectionListener(MenuSelectionListener menuSelectionListener)

The listener for when a menu item is selected

Parameters:

menuSelectionListener - the listener for this menuCell object

getMenuSelectionListener

public MenuSelectionListener getMenuSelectionListener()

The listener that gets triggered when the menuCell object is selected

Returns:

the MenuSelectionListener for the cell

setSubMenuLayout

public void setSubMenuLayout(MenuLayout subMenuLayout)

The submenu's layout that the subCells will be shown in. If `null`, the default submenu layout set via the screen manager's `MenuConfiguration` will be used.

Parameters:

subMenuLayout - - the layout used for the sub menu

getSubMenuLayout

public MenuLayout getSubMenuLayout()

The submenu's layout that the subCells will be shown in. If `null`, the default submenu layout set via the screen manager's `MenuConfiguration` will be used.

Returns:

- the layout used for the sub menu

setSecondaryText

public void setSecondaryText(String secondaryText)

Sets the secondaryText

Parameters:

secondaryText - the cell's secondaryText

getSecondaryText

public String getSecondaryText()

Get the cell's secondaryText

Returns:

the cell's secondaryText

setTertiaryText

public void setTertiaryText(String tertiaryText)

Sets the tertiaryText

Parameters:

tertiaryText - the cell's tertiaryText

getTertiaryText

public String getTertiaryText()

Get the cell's tertiaryText

Returns:

the cell's tertiaryText

setSecondaryArtwork

public void setSecondaryArtwork(SdlArtwork secondaryArtwork)

Sets the secondaryArtwork

Parameters:

secondaryArtwork - the cell's secondaryArtwork

getSecondaryArtwork

public SdlArtwork getSecondaryArtwork()

Get the cell's secondaryArtwork

Returns:

the cell's secondaryArtwork

hashCode

public int hashCode()

Note: You should compare using the equals(Object) method.
Hash the parameters of the object and return the result for comparison For each param, increase the rotation distance by one. It is necessary to rotate each of our properties because a simple bitwise OR will produce equivalent results if, for example: Object 1: getText() = "Hi", getSecondaryText() = "Hello" Object 2: getText() = "Hello", getSecondaryText() = "Hi"

Overrides:

hashCode in class Object

Returns:

the hash code as an int

equals

public boolean equals(Object o)

Uses our custom hashCode for MenuCell objects

Overrides:

equals in class Object

Parameters:

o - - The object to compare

Returns:

boolean of whether the objects are the same or not

clone

public MenuCell clone()

Creates a deep copy of the object

Overrides:

clone in class Object

Returns:

deep copy of the object, null if an exception occurred