com.smartdevicelink.proxy.rpc

Class SoftButton

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.SoftButton

All Implemented Interfaces:

Cloneable

public class SoftButton
extends RPCStruct

A simulated button or keyboard key that is displayed on a touch screen.

Parameter List

Name	Type	Description	Reg.	Notes	Version
type	SoftButtonType	Describes, whether it is text, highlighted text, icon, or dynamic image.			SmartDeviceLink 2.0
text	String	Optional text to display (if defined as TEXT or BOTH)	N	Min: 0; Maxlength: 500	SmartDeviceLink 2.0
image	Image	Optional image struct for SoftButton (if defined as IMAGE or BOTH).			SmartDeviceLink 2.0
isHighlighted	Boolean	True, if highlighted False, if not highlighted	N		SmartDeviceLink 2.0
softButtonID	Integer	Value which is returned via OnButtonPress / OnButtonEvent		Min: 0; Max: 65535	SmartDeviceLink 2.0
systemAction	SystemAction	Parameter indicating whether selecting a SoftButton shall call a specific system action. This is intended to allow Notifications to bring the callee into full / focus; or in the case of persistent overlays, the overlay can persist when a SoftButton is pressed.	N	defvalue: DEFAULT_ACTION	SmartDeviceLink 2.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_IMAGE
static String	KEY_IS_HIGHLIGHTED
static String	KEY_SOFT_BUTTON_ID
static String	KEY_SYSTEM_ACTION
static String	KEY_TEXT
static String	KEY_TYPE

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
SoftButton()
SoftButton(Hashtable<String,Object> hash) Constructs a new SoftButton object indicated by the Hashtable parameter
SoftButton(SoftButtonType type, Integer softButtonID) Constructs a new SoftButton object

Method Summary

Modifier and Type	Method and Description
Image	getImage()
Boolean	getIsHighlighted()
Integer	getSoftButtonID()
SystemAction	getSystemAction()
String	getText()
SoftButtonType	getType()
SoftButton	setImage(Image image)
SoftButton	setIsHighlighted(Boolean isHighlighted)
SoftButton	setSoftButtonID(Integer softButtonID)
SoftButton	setSystemAction(SystemAction systemAction)
SoftButton	setText(String text)
SoftButton	setType(SoftButtonType type)

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBoolean, getBulkData, getDouble, getFloat, getInteger, getLong, getMessageTypeName, getObject, getStore, getStoreValue, getString, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

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

Field Detail

KEY_IS_HIGHLIGHTED

public static final String KEY_IS_HIGHLIGHTED

See Also:

Constant Field Values

KEY_SOFT_BUTTON_ID

public static final String KEY_SOFT_BUTTON_ID

See Also:

Constant Field Values

KEY_SYSTEM_ACTION

public static final String KEY_SYSTEM_ACTION

See Also:

Constant Field Values

KEY_TEXT

public static final String KEY_TEXT

See Also:

Constant Field Values

KEY_TYPE

public static final String KEY_TYPE

See Also:

Constant Field Values

KEY_IMAGE

public static final String KEY_IMAGE

See Also:

Constant Field Values

Constructor Detail

SoftButton

public SoftButton()

SoftButton

public SoftButton(Hashtable<String,Object> hash)

Constructs a new SoftButton object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

SoftButton

public SoftButton(@NonNull
                  SoftButtonType type,
                  @NonNull
                  Integer softButtonID)

Constructs a new SoftButton object

Parameters:

type - Describes, whether it is text, highlighted text, icon, or dynamic image.

softButtonID - Value which is returned via OnButtonPress / OnButtonEvent

Method Detail

setType

public SoftButton setType(@NonNull
                          SoftButtonType type)

getType

public SoftButtonType getType()

setText

public SoftButton setText(String text)

getText

public String getText()

setImage

public SoftButton setImage(Image image)

getImage

public Image getImage()

setIsHighlighted

public SoftButton setIsHighlighted(Boolean isHighlighted)

getIsHighlighted

public Boolean getIsHighlighted()

setSoftButtonID

public SoftButton setSoftButtonID(@NonNull
                                  Integer softButtonID)

getSoftButtonID

public Integer getSoftButtonID()

setSystemAction

public SoftButton setSystemAction(SystemAction systemAction)

getSystemAction

public SystemAction getSystemAction()