MenuCell Class Reference

Instance Methods

clone() ⇒ MenuCell
equals(other) ⇒ Boolean
equalsWithUniqueTitle(other) ⇒ Boolean
getIcon() ⇒ SdlArtwork
getMenuSelectionListener() ⇒ MenuSelectionListener
getSecondaryArtwork() ⇒ SdlArtwork
getSecondaryText() ⇒ String
getSubCells() ⇒ Array.<MenuCell>
getSubMenuLayout() ⇒ MenuLayout
getTertiaryText() ⇒ String
getTitle() ⇒ String
getVoiceCommands() ⇒ Array.<String>
isSubMenuCell() ⇒ Boolean
setIcon(icon) ⇒ MenuCell
setMenuSelectionListener(menuSelectionListener) ⇒ MenuCell
setSecondaryArtwork(secondaryArtwork) ⇒ MenuCell
setSecondaryText(secondaryText) ⇒ MenuCell
setSubCells(subCells) ⇒ MenuCell
setSubMenuLayout(subMenuLayout) ⇒ MenuCell
setTertiaryText(tertiaryText) ⇒ MenuCell
setTitle(title) ⇒ MenuCell
setVoiceCommands(voiceCommands) ⇒ MenuCell

Constructors

new MenuCell(title)

Creates a new instance of MenuCell

Instance Methods

menuCell.clone() ⇒ `MenuCell`

Creates a deep copy of the object

Kind: Instance method of MenuCell
Returns: MenuCell - A deep copy of the object

menuCell.equals(other) ⇒ `Boolean`

Checks whether two MenuCells can be considered equivalent, but does not compare the unique title

Kind: Instance method of MenuCell
Returns: Boolean - Whether the objects are the same or not

Param	Type	Description
other	`MenuCell`	The object to compare

menuCell.equalsWithUniqueTitle(other) ⇒ `Boolean`

Checks whether two MenuCells can be considered equivalent, and also compares the unique title

Kind: Instance method of MenuCell
Returns: Boolean - Whether the objects are the same or not

Param	Type	Description
other	`MenuCell`	The object to compare

menuCell.getIcon() ⇒ `SdlArtwork`

Gets the icon of the menu cell

Kind: Instance method of MenuCell
Returns: SdlArtwork - The cell's icon to be displayed

menuCell.getMenuSelectionListener() ⇒ `MenuSelectionListener`

Gets the menu listener of the menu cell

Kind: Instance method of MenuCell
Returns: MenuSelectionListener - The listener for when a menu item is selected

menuCell.getSecondaryArtwork() ⇒ `SdlArtwork`

Gets the secondary artwork of the menu cell

Kind: Instance method of MenuCell
Returns: SdlArtwork - The secondary artwork

menuCell.getSecondaryText() ⇒ `String`

Gets the secondary text of the menu cell

Kind: Instance method of MenuCell
Returns: String - The secondary text

menuCell.getSubCells() ⇒ `Array.<MenuCell>`

Gets the sub cells of the menu cell

Kind: Instance method of MenuCell
Returns: Array.<MenuCell> - The list of MenuCells that can be set as subCells

menuCell.getSubMenuLayout() ⇒ `MenuLayout`

Gets the sub menu layout of the menu cell

Kind: Instance method of MenuCell
Returns: MenuLayout - 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.

menuCell.getTertiaryText() ⇒ `String`

Gets the tertiary text of the menu cell

Kind: Instance method of MenuCell
Returns: String - The tertiary text

menuCell.getTitle() ⇒ `String`

Gets the title of the menu cell

Kind: Instance method of MenuCell
Returns: String - The title of the cell object

menuCell.getVoiceCommands() ⇒ `Array.<String>`

Gets the voice commands of the menu cell

Kind: Instance method of MenuCell
Returns: Array.<String> - A list of Strings that will be used for voice commands

menuCell.isSubMenuCell() ⇒ `Boolean`

Checks whether this cell can support subcells

Kind: Instance method of MenuCell
Returns: Boolean - Whether subcells are supported