com.smartdevicelink.managers.screen

Class SoftButtonState

java.lang.Object

com.smartdevicelink.managers.screen.SoftButtonState

public class SoftButtonState
extends Object

SoftButtonState
Defines an individual state for SoftButtonObject.
The states of SoftButtonObject allow the developer to not have to manage multiple SoftButtons that have very similar functionality.
For example, a repeat button in a music app can be thought of as one SoftButtonObject with three typical states: repeat off, repeat 1, and repeat on.

See Also:

SoftButtonObject

Constructor Summary

Constructors

Constructor and Description
SoftButtonState(String name, String text, SdlArtwork artwork) Creates a new instance of SoftButtonState Note: state names should be different for each SoftButtonObject

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Uses our custom hashCode for SoftButtonState objects
SdlArtwork	getArtwork() Get the Artwork for the state
boolean	getHighlighted() Get whether or not the button should be highlighted on the UI
String	getName() Get the state name
SoftButton	getSoftButton() Get the SoftButton for the state
SystemAction	getSystemAction() Get whether selecting a SoftButton shall call a specific system action See SystemAction
int	hashCode() Used to compile hashcode for SoftButtonState for use to compare in equals method
void	setHighlighted(boolean highlighted) Set whether or not the button should be highlighted on the UI
void	setName(String name) Set the state name
void	setSystemAction(SystemAction systemAction) Set whether selecting a SoftButton shall call a specific system action See SystemAction

Methods inherited from class java.lang.Object

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

Constructor Detail

SoftButtonState

public SoftButtonState(@NonNull
                       String name,
                       String text,
                       SdlArtwork artwork)

Creates a new instance of SoftButtonState Note: state names should be different for each SoftButtonObject

Parameters:

name - a String value represents name of the state

text - a String represents the text for the state

artwork - an SdlArtwork represents the artwork for the state

Method Detail

getName

public String getName()

Get the state name

Returns:

a String value represents the name of the state

setName

public void setName(@NonNull
                    String name)

Set the state name

Parameters:

name - a String value represents the name of the state

getHighlighted

public boolean getHighlighted()

Get whether or not the button should be highlighted on the UI

Returns:

boolean representing whether or not the button should be highlighted

setHighlighted

public void setHighlighted(boolean highlighted)

Set whether or not the button should be highlighted on the UI

Parameters:

highlighted - boolean representing whether or not the button should be highlighted

getSystemAction

public SystemAction getSystemAction()

Get whether selecting a SoftButton shall call a specific system action See SystemAction

Returns:

SystemAction value representing whether selecting a SoftButton shall call a specific action

setSystemAction

public void setSystemAction(SystemAction systemAction)

Set whether selecting a SoftButton shall call a specific system action See SystemAction

Parameters:

systemAction - SystemAction value representing whether selecting a SoftButton shall call a specific action

getSoftButton

public SoftButton getSoftButton()

Get the SoftButton for the state

Returns:

a SoftButton object represents the SoftButton for the state

getArtwork

public SdlArtwork getArtwork()

Get the Artwork for the state

Returns:

an SdlArtwork object represents the artwork for the state

hashCode

public int hashCode()

Used to compile hashcode for SoftButtonState for use to compare in equals method

Overrides:

hashCode in class Object

Returns:

Custom hashcode of SoftButtonState variables

equals

public boolean equals(Object o)

Uses our custom hashCode for SoftButtonState objects

Overrides:

equals in class Object

Parameters:

o - - The object to compare

Returns:

boolean of whether the objects are the same or not