com.smartdevicelink.managers.screen

Class SoftButtonObject

java.lang.Object

com.smartdevicelink.managers.screen.SoftButtonObject

All Implemented Interfaces:

Cloneable

public class SoftButtonObject
extends Object
implements Cloneable

SoftButtonObject
SoftButtonObject defines a button that can have multiple SoftButtonState values.
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:

SoftButtonState

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SoftButtonObject.OnEventListener

Constructor Summary

Constructors

Constructor and Description
SoftButtonObject(String name, List<SoftButtonState> states, String initialStateName, SoftButtonObject.OnEventListener onEventListener) Create a new instance of the SoftButtonObject with multiple states
SoftButtonObject(String name, SoftButtonState state, SoftButtonObject.OnEventListener onEventListener) Create a new instance of the SoftButtonObject with one state
SoftButtonObject(String name, String text, SdlArtwork artwork, SoftButtonObject.OnEventListener onEventListener) Create a new instance of the SoftButtonObject with one state

Method Summary

Modifier and Type	Method and Description
SoftButtonObject	clone() Creates a deep copy of the object
boolean	equals(Object o) Uses our custom hashCode for SoftButtonObject objects
int	getButtonId() Get the id of the SoftButtonObject
SoftButtonState	getCurrentState() Get the current state for the SoftButtonObject
String	getCurrentStateName() Get the name of the current state
SoftButton	getCurrentStateSoftButton() Get the SoftButton object for the current state
String	getName() Get the name of the SoftButtonObject
SoftButtonObject.OnEventListener	getOnEventListener() Get the event listener for the SoftButtonObject
List<SoftButtonState>	getStates() Get the SoftButtonState list
int	hashCode() Used to compile hashcode for SoftButtonsObjects for use to compare in equals method
void	setButtonId(int buttonId) Deprecated.
void	setCurrentStateName(String currentStateName) Set the name of the current state
void	setName(String name) Set the name of the SoftButtonObject
void	setOnEventListener(SoftButtonObject.OnEventListener onEventListener) Set the event listener for the SoftButtonObject
void	setStates(List<SoftButtonState> states) Set the the SoftButtonState list
protected void	setUpdateListener(com.smartdevicelink.managers.screen.SoftButtonObject.UpdateListener updateListener) Set the SoftButtonManager's update listener
void	transitionToNextState() Transition the SoftButtonObject to the next state
boolean	transitionToStateByName(String newStateName) Transition the SoftButtonObject to a specific state

Methods inherited from class java.lang.Object

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

Constructor Detail

SoftButtonObject

public SoftButtonObject(@NonNull
                        String name,
                        @NonNull
                        List<SoftButtonState> states,
                        @NonNull
                        String initialStateName,
                        SoftButtonObject.OnEventListener onEventListener)

Create a new instance of the SoftButtonObject with multiple states

Parameters:

name - a String value represents name of the object

states - a list of SoftButtonState represents the SoftButtonState values for the object. states should be unique for every SoftButtonObject. A SoftButtonState instance cannot be reused for multiple SoftButtonObjects.

initialStateName - a String value represents the name for the initial state

onEventListener - a listener that has a callback that will be triggered when a button event happens Note: the initialStateName should match exactly the name of one of the states for the object. Otherwise an exception will be thrown.

SoftButtonObject

public SoftButtonObject(@NonNull
                        String name,
                        @NonNull
                        SoftButtonState state,
                        SoftButtonObject.OnEventListener onEventListener)

Create a new instance of the SoftButtonObject with one state

Parameters:

name - a String value represents name of the object

state - a SoftButtonState represents state for the object

onEventListener - a listener that has a callback that will be triggered when a button event happens

SoftButtonObject

public SoftButtonObject(@NonNull
                        String name,
                        @NonNull
                        String text,
                        SdlArtwork artwork,
                        SoftButtonObject.OnEventListener onEventListener)

Create a new instance of the SoftButtonObject with one state

Parameters:

name - a String value represents name of the object

artwork - a SdlArtwork to be displayed on the button

onEventListener - a listener that has a callback that will be triggered when a button event happens

Method Detail

transitionToStateByName

public boolean transitionToStateByName(@NonNull
                                       String newStateName)

Transition the SoftButtonObject to a specific state

Parameters:

newStateName - a String value represents the name fo the state that we want to transition the SoftButtonObject to

Returns:

a boolean value that represents whether the transition succeeded or failed

transitionToNextState

public void transitionToNextState()

Transition the SoftButtonObject to the next state

getCurrentState

public SoftButtonState getCurrentState()

Get the current state for the SoftButtonObject

Returns:

a SoftButtonState represents the current state

getCurrentStateSoftButton

public SoftButton getCurrentStateSoftButton()

Get the SoftButton object for the current state

Returns:

a SoftButton object that is associated with the current state

setUpdateListener

protected void setUpdateListener(com.smartdevicelink.managers.screen.SoftButtonObject.UpdateListener updateListener)

Set the SoftButtonManager's update listener

Parameters:

updateListener - the SoftButtonManager.UpdateListener object

getName

public String getName()

Get the name of the SoftButtonObject

Returns:

a String that represents the name of the SoftButtonObject

setName

public void setName(@NonNull
                    String name)

Set the name of the SoftButtonObject

Parameters:

name - a String that represents the name of the SoftButtonObject

getStates

public List<SoftButtonState> getStates()

Get the SoftButtonState list

Returns:

a list of the object's soft button states

setStates

public void setStates(@NonNull
                      List<SoftButtonState> states)

Set the the SoftButtonState list

Parameters:

states - a list of the object's soft button states. states should be unique for every SoftButtonObject. A SoftButtonState instance cannot be reused for multiple SoftButtonObjects.

getCurrentStateName

public String getCurrentStateName()

Get the name of the current state

Returns:

a String that represents the name of the current state

setCurrentStateName

public void setCurrentStateName(@NonNull
                                String currentStateName)

Set the name of the current state

Parameters:

currentStateName - a String that represents the name of the current state

getButtonId

public int getButtonId()

Get the id of the SoftButtonObject

Returns:

an int value that represents the id of the SoftButtonObject

setButtonId

@Deprecated
public void setButtonId(int buttonId)

Deprecated.

DO NOT USE! let the managers assign ID's. In next major version change this will be restricted to the library Sets the id of the SoftButtonObject
Note: If the developer did not set buttonId, the manager will automatically assign an id before the SoftButtons are sent to the head unit. Please note that the manager may reuse ids from previous batch of SoftButtons that were already sent to the head unit

Parameters:

buttonId - an int value that represents the id of the SoftButtonObject

getOnEventListener

public SoftButtonObject.OnEventListener getOnEventListener()

Get the event listener for the SoftButtonObject

Returns:

OnEventListener

setOnEventListener

public void setOnEventListener(SoftButtonObject.OnEventListener onEventListener)

Set the event listener for the SoftButtonObject

Parameters:

onEventListener - a listener that has a callback that will be triggered when a button event happens

hashCode

public int hashCode()

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

Overrides:

hashCode in class Object

Returns:

Custom hashcode of SoftButtonObjects variables

equals

public boolean equals(Object o)

Uses our custom hashCode for SoftButtonObject 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 SoftButtonObject clone()

Creates a deep copy of the object

Overrides:

clone in class Object

Returns:

deep copy of the object, null if an exception occurred