com.smartdevicelink.proxy.rpc

Class SoftButtonCapabilities

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.SoftButtonCapabilities

All Implemented Interfaces:

Cloneable

public class SoftButtonCapabilities
extends RPCStruct

Contains information about a SoftButton's capabilities.

Parameter List

Name	Type	Description	SmartDeviceLink Ver. Available
shortPressAvailable	Boolean	The button supports a short press. Whenever the button is pressed short, onButtonPressed( SHORT) will be invoked.	SmartDeviceLink 2.0
longPressAvailable	Boolean	The button supports a LONG press. Whenever the button is pressed long, onButtonPressed( LONG) will be invoked.	SmartDeviceLink 2.0
upDownAvailable	Boolean	The button supports "button down" and "button up". Whenever the button is pressed, onButtonEvent( DOWN) will be invoked. Whenever the button is released, onButtonEvent( UP) will be invoked. *	SmartDeviceLink 2.0
imageSupported	Boolean	The button supports referencing a static or dynamic image.	SmartDeviceLink 2.0

Since:

SmartDeviceLink 2.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_IMAGE_SUPPORTED
static String	KEY_LONG_PRESS_AVAILABLE
static String	KEY_SHORT_PRESS_AVAILABLE
static String	KEY_TEXT_SUPPORTED
static String	KEY_UP_DOWN_AVAILABLE

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
SoftButtonCapabilities() Constructs a newly allocated SoftButtonCapabilities object
SoftButtonCapabilities(Boolean shortPressAvailable, Boolean longPressAvailable, Boolean upDownAvailable, Boolean imageSupported) Constructs a newly allocated SoftButtonCapabilities object
SoftButtonCapabilities(Hashtable<String,Object> hash) Constructs a newly allocated SoftButtonCapabilities object indicated by the Hashtable parameter

Method Summary

Modifier and Type	Method and Description
void	format(Version rpcVersion, boolean formatParams) This method should clean the the RPC to make sure it is compliant with the spec.
Boolean	getImageSupported() get the button supports referencing a static or dynamic image.
Boolean	getLongPressAvailable() get whether the button supports a LONG press.
Boolean	getShortPressAvailable() get whether the button supports a short press.
Boolean	getTextSupported() get the text support.
Boolean	getUpDownAvailable() get the button supports "button down" and "button up".
SoftButtonCapabilities	setImageSupported(Boolean imageSupported) set the button supports referencing a static or dynamic image.
SoftButtonCapabilities	setLongPressAvailable(Boolean longPressAvailable) set the button supports a LONG press.
SoftButtonCapabilities	setShortPressAvailable(Boolean shortPressAvailable) set the button supports a short press.
SoftButtonCapabilities	setTextSupported(Boolean textSupported) set the text support.
SoftButtonCapabilities	setUpDownAvailable(Boolean upDownAvailable) set the button supports "button down" and "button up".

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, 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_IMAGE_SUPPORTED

public static final String KEY_IMAGE_SUPPORTED

See Also:

Constant Field Values

KEY_SHORT_PRESS_AVAILABLE

public static final String KEY_SHORT_PRESS_AVAILABLE

See Also:

Constant Field Values

KEY_LONG_PRESS_AVAILABLE

public static final String KEY_LONG_PRESS_AVAILABLE

See Also:

Constant Field Values

KEY_UP_DOWN_AVAILABLE

public static final String KEY_UP_DOWN_AVAILABLE

See Also:

Constant Field Values

KEY_TEXT_SUPPORTED

public static final String KEY_TEXT_SUPPORTED

See Also:

Constant Field Values

Constructor Detail

SoftButtonCapabilities

public SoftButtonCapabilities()

Constructs a newly allocated SoftButtonCapabilities object

SoftButtonCapabilities

public SoftButtonCapabilities(Hashtable<String,Object> hash)

Constructs a newly allocated SoftButtonCapabilities object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

SoftButtonCapabilities

public SoftButtonCapabilities(@NonNull
                              Boolean shortPressAvailable,
                              @NonNull
                              Boolean longPressAvailable,
                              @NonNull
                              Boolean upDownAvailable,
                              @NonNull
                              Boolean imageSupported)

Constructs a newly allocated SoftButtonCapabilities object

Parameters:

shortPressAvailable - The button supports a short press.

longPressAvailable - The button supports a LONG press

upDownAvailable - The button supports "button down" and "button up".

imageSupported - The button supports referencing a static or dynamic image.

Method Detail

format

public void format(Version rpcVersion,
                   boolean formatParams)

Description copied from class: RPCStruct

This method should clean the the RPC to make sure it is compliant with the spec.

NOTE: Super needs to be called at the END of the method

Overrides:

format in class RPCStruct

Parameters:

rpcVersion - the rpc spec version that has been negotiated. If value is null the the max value of RPC spec version this library supports should be used.

formatParams - if true, the format method will be called on subsequent params

setShortPressAvailable

public SoftButtonCapabilities setShortPressAvailable(@NonNull
                                                     Boolean shortPressAvailable)

set the button supports a short press.

Parameters:

shortPressAvailable - whether the button supports a short press.

getShortPressAvailable

public Boolean getShortPressAvailable()

get whether the button supports a short press.

Returns:

whether the button supports a short press

setLongPressAvailable

public SoftButtonCapabilities setLongPressAvailable(@NonNull
                                                    Boolean longPressAvailable)

set the button supports a LONG press.

Parameters:

longPressAvailable - whether the button supports a long press

getLongPressAvailable

public Boolean getLongPressAvailable()

get whether the button supports a LONG press.

Returns:

whether the button supports a LONG press

setUpDownAvailable

public SoftButtonCapabilities setUpDownAvailable(@NonNull
                                                 Boolean upDownAvailable)

set the button supports "button down" and "button up".

Parameters:

upDownAvailable - the button supports "button down" and "button up".

getUpDownAvailable

public Boolean getUpDownAvailable()

get the button supports "button down" and "button up".

Returns:

the button supports "button down" and "button up".

setImageSupported

public SoftButtonCapabilities setImageSupported(@NonNull
                                                Boolean imageSupported)

set the button supports referencing a static or dynamic image.

Parameters:

imageSupported - whether the button supports referencing a static or dynamic image.

getImageSupported

public Boolean getImageSupported()

get the button supports referencing a static or dynamic image.

Returns:

the button supports referencing a static or dynamic image.

setTextSupported

public SoftButtonCapabilities setTextSupported(Boolean textSupported)

set the text support. If not included, the default value should be considered true that the button will support text.

Parameters:

textSupported - whether the button supports the use of text or not.

Since:

6.0

getTextSupported

public Boolean getTextSupported()

get the text support.

Returns:

Boolean - the text is supported or not.