com.smartdevicelink.managers.screen.choiceset

Class ChoiceCell

java.lang.Object

com.smartdevicelink.managers.screen.choiceset.ChoiceCell

All Implemented Interfaces:

Cloneable

public class ChoiceCell
extends Object
implements Cloneable

Constructor Summary

Constructors

Constructor and Description
ChoiceCell(String text) Initialize the cell with text and nothing else.
ChoiceCell(String text, List<String> voiceCommands, SdlArtwork artwork) Initialize the cell with text, optional artwork, and optional voice commands
ChoiceCell(String text, String secondaryText, String tertiaryText, List<String> voiceCommands, SdlArtwork artwork, SdlArtwork secondaryArtwork) Initialize the cell with all optional items

Method Summary

Modifier and Type	Method and Description
ChoiceCell	clone() Creates a deep copy of the object
boolean	equals(Object o) Uses our custom hashCode for ChoiceCell objects
SdlArtwork	getArtwork() Maps to Choice.image.
SdlArtwork	getSecondaryArtwork() Maps to Choice.secondaryImage.
String	getSecondaryText() Maps to Choice.secondaryText.
String	getTertiaryText() Maps to Choice.tertiaryText.
String	getText() Maps to Choice.menuName.
List<String>	getVoiceCommands() Maps to Choice.vrCommands.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ChoiceCell

public ChoiceCell(@NonNull
                  String text)

Initialize the cell with text and nothing else.

Parameters:

text - - The primary text of the cell.

ChoiceCell

public ChoiceCell(@NonNull
                  String text,
                  List<String> voiceCommands,
                  SdlArtwork artwork)

Initialize the cell with text, optional artwork, and optional voice commands

Parameters:

text - - The primary text of the cell

voiceCommands - - Strings that can be spoken by the user to activate this cell in a voice or both interaction mode

artwork - - The primary artwork of the cell

ChoiceCell

public ChoiceCell(@NonNull
                  String text,
                  String secondaryText,
                  String tertiaryText,
                  List<String> voiceCommands,
                  SdlArtwork artwork,
                  SdlArtwork secondaryArtwork)

Initialize the cell with all optional items

Parameters:

text - - The primary text

secondaryText - - The secondary text

tertiaryText - - The tertiary text

voiceCommands - - Strings that can be spoken by the user to activate this cell in a voice or both interaction mode

artwork - - The primary artwork of the cell

secondaryArtwork - - The secondary artwork of the cell

Method Detail

getText

public String getText()

Maps to Choice.menuName. The primary text of the cell. Duplicates within an `ChoiceSet` are not permitted and will result in the `ChoiceSet` failing to initialize.

Returns:

The primary text of the cell

getSecondaryText

public String getSecondaryText()

Maps to Choice.secondaryText. Optional secondary text of the cell, if available. Duplicates within an `ChoiceSet` are permitted.

Returns:

Optional secondary text of the cell

getTertiaryText

public String getTertiaryText()

Maps to Choice.tertiaryText. Optional tertiary text of the cell, if available. Duplicates within an `ChoiceSet` are permitted.

Returns:

Optional tertiary text of the cell

getVoiceCommands

public List<String> getVoiceCommands()

Maps to Choice.vrCommands. Optional voice commands the user can speak to activate the cell. If not set and the head unit requires it, this will be set to the number in the list that this item appears. However, this would be a very poor experience for a user if the choice set is presented as a voice only interaction or both interaction mode. Therefore, consider not setting this only when you know the choice set will be presented as a touch only interaction.

Returns:

The list of voice command strings

getArtwork

public SdlArtwork getArtwork()

Maps to Choice.image. Optional image for the cell. This will be uploaded before the cell is used when the cell is preloaded or presented for the first time.

Returns:

The SdlArtwork

getSecondaryArtwork

public SdlArtwork getSecondaryArtwork()

Maps to Choice.secondaryImage. Optional secondary image for the cell. This will be uploaded before the cell is used when the cell is preloaded or presented for the first time.

Returns:

The SdlArtwork

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Uses our custom hashCode for ChoiceCell objects

Overrides:

equals in class Object

Parameters:

o - - The object to compare

Returns:

boolean of whether the objects are the same or not

toString

@NonNull
public String toString()

Overrides:

toString in class Object

Returns:

A string description of the cell, useful for debugging.

clone

public ChoiceCell clone()

Creates a deep copy of the object

Overrides:

clone in class Object

Returns:

deep copy of the object, null if an exception occurred