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

Class SoftButton

Hierarchy

java.lang.Object
     com.smartdevicelink.proxy.RPCStruct

Package
com.smartdevicelink.proxy.rpc

Overview

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

Fields

KEY_IS_HIGHLIGHTED

public static final java.lang.String KEY_IS_HIGHLIGHTED
Constant Value
"isHighlighted"

KEY_SOFT_BUTTON_ID

public static final java.lang.String KEY_SOFT_BUTTON_ID
Constant Value
"softButtonID"

KEY_SYSTEM_ACTION

public static final java.lang.String KEY_SYSTEM_ACTION
Constant Value
"systemAction"

KEY_TEXT

public static final java.lang.String KEY_TEXT
Constant Value
"text"

KEY_TYPE

public static final java.lang.String KEY_TYPE
Constant Value
"type"

KEY_IMAGE

public static final java.lang.String KEY_IMAGE
Constant Value
"image"

Inherited Fields

From Class Fields
com.smartdevicelink.proxy.RPCStruct KEY_BULK_DATA, KEY_PROTECTED, store

Constructors

SoftButton()

public SoftButton()

SoftButton( java.util.Hashtable<java.lang.String, java.lang.Object> hash )

Constructs a new SoftButton object indicated by the Hashtable parameter

public SoftButton(java.util.Hashtable<java.lang.String, java.lang.Object> hash)

Parameters

hash
The Hashtable to use

SoftButton( SoftButtonType type, Integer softButtonID )

Constructs a new SoftButton object

public SoftButton(SoftButtonType type,Integer softButtonID)

Parameters

type
Describes, whether it is text, highlighted text, icon, or dynamic image.
softButtonID
Value which is returned via OnButtonPress / OnButtonEvent

Methods

setType( SoftButtonType type )

public void setType(SoftButtonType type)

Parameters

type

getType()

public com.smartdevicelink.proxy.rpc.enums.SoftButtonType getType()

setText( String text )

public void setText(String text)

Parameters

text

getText()

public java.lang.String getText()

setImage( Image image )

public void setImage(Image image)

Parameters

image

getImage()

public com.smartdevicelink.proxy.rpc.Image getImage()

setIsHighlighted( Boolean isHighlighted )

public void setIsHighlighted(Boolean isHighlighted)

Parameters

isHighlighted

getIsHighlighted()

public java.lang.Boolean getIsHighlighted()

setSoftButtonID( Integer softButtonID )

public void setSoftButtonID(Integer softButtonID)

Parameters

softButtonID

getSoftButtonID()

public java.lang.Integer getSoftButtonID()

setSystemAction( SystemAction systemAction )

public void setSystemAction(SystemAction systemAction)

Parameters

systemAction

getSystemAction()

public com.smartdevicelink.proxy.rpc.enums.SystemAction getSystemAction()

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCStruct getStoreValue, getStore, deserializeJSON, deserializeJSONObject, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section