Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Sidebar

Class ChoiceCell

Hierarchy

java.lang.Object

Package
com.smartdevicelink.managers.screen.choiceset

Constructors

ChoiceCell( String text )

Initialize the cell with text and nothing else.

public ChoiceCell(String text)

Parameters

text
- The primary text of the cell.

ChoiceCell( String text, java.util.List<java.lang.String> voiceCommands, SdlArtwork artwork )

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

public ChoiceCell(String text,java.util.List<java.lang.String> voiceCommands,SdlArtwork artwork)

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( String text, String secondaryText, String tertiaryText, java.util.List<java.lang.String> voiceCommands, SdlArtwork artwork, SdlArtwork secondaryArtwork )

Initialize the cell with all optional items

public ChoiceCell(String text,String secondaryText,String tertiaryText,java.util.List<java.lang.String> voiceCommands,SdlArtwork artwork,SdlArtwork secondaryArtwork)

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

Methods

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.

public java.lang.String getText()

getSecondaryText()

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

public java.lang.String getSecondaryText()

getTertiaryText()

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

public java.lang.String getTertiaryText()

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.

public java.util.List getVoiceCommands()

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.

public com.smartdevicelink.managers.file.filetypes.SdlArtwork getArtwork()

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.

public com.smartdevicelink.managers.file.filetypes.SdlArtwork getSecondaryArtwork()

hashCode()

public int hashCode()

equals( Object o )

Uses our custom hashCode for ChoiceCell objects

public boolean equals(Object o)

Parameters

o
- The object to compare

toString()

public java.lang.String toString()

Inherited Methods

From Class Methods
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section