Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
Documentation
SoftButtonState

SoftButtonState Class Reference

Constructors

Instance Methods

Constructors

new SoftButtonState(name, text, artwork)

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

Instance Methods

softButtonState.getArtwork() ⇒ [SdlArtwork, null]

Get the Artwork for the state

Kind: Instance method of SoftButtonState
Returns: [SdlArtwork, null] - an SdlArtwork object represents the artwork for the state

softButtonState.getHighlighted() ⇒ Boolean

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

Kind: Instance method of SoftButtonState
Returns: Boolean - boolean representing whether or not the button should be highlighted

softButtonState.getName() ⇒ [String, null]

Get the state name

Kind: Instance method of SoftButtonState
Returns: [String, null] - a String value represents the name of the state

softButtonState.getSoftButton() ⇒ SoftButton

Get the SoftButton for the state

Kind: Instance method of SoftButtonState
Returns: SoftButton - a SoftButton object represents the SoftButton for the state

softButtonState.getSystemAction() ⇒ SystemAction

Get whether selecting a SoftButton shall call a specific system action

Kind: Instance method of SoftButtonState
Returns: SystemAction - SystemAction value representing whether selecting a SoftButton shall call a specific action

softButtonState.setHighlighted(highlighted) ⇒ SoftButtonState

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

Kind: Instance method of SoftButtonState
Returns: SoftButtonState - A reference to this instance to support method chaining.

ParamTypeDescription
highlighted Boolean A boolean representing whether or not the button should be highlighted

softButtonState.setName(name) ⇒ SoftButtonState

Set the state name

Kind: Instance method of SoftButtonState
Returns: SoftButtonState - A reference to this instance to support method chaining.

ParamTypeDescription
name String A String value represents the name of the state

softButtonState.setSystemAction(systemAction) ⇒ SoftButtonState

Set whether selecting a SoftButton shall call a specific system action

Kind: Instance method of SoftButtonState
Returns: SoftButtonState - A reference to this instance to support method chaining.

ParamTypeDescription
systemAction SystemAction A SystemAction value representing whether selecting a SoftButton shall call a specific action
View on GitHub.com
Previous Section Next Section