Class SoftButtonCapabilities
Hierarchy
java.lang.Object
com.smartdevicelink.proxy.RPCStruct
- Package
- com.smartdevicelink.proxy.rpc
Overview
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 |
Quick Jump
- Fields
- Constructors
- Methods
-
- format(Version rpcVersion,boolean formatParams)
- setShortPressAvailable(Boolean shortPressAvailable)
- getShortPressAvailable()
- setLongPressAvailable(Boolean longPressAvailable)
- getLongPressAvailable()
- setUpDownAvailable(Boolean upDownAvailable)
- getUpDownAvailable()
- setImageSupported(Boolean imageSupported)
- getImageSupported()
- setTextSupported(Boolean textSupported)
- getTextSupported()
Fields
KEY_IMAGE_SUPPORTED
public static final java.lang.String KEY_IMAGE_SUPPORTED
- Constant Value
- "imageSupported"
KEY_SHORT_PRESS_AVAILABLE
public static final java.lang.String KEY_SHORT_PRESS_AVAILABLE
- Constant Value
- "shortPressAvailable"
KEY_LONG_PRESS_AVAILABLE
public static final java.lang.String KEY_LONG_PRESS_AVAILABLE
- Constant Value
- "longPressAvailable"
KEY_UP_DOWN_AVAILABLE
public static final java.lang.String KEY_UP_DOWN_AVAILABLE
- Constant Value
- "upDownAvailable"
KEY_TEXT_SUPPORTED
public static final java.lang.String KEY_TEXT_SUPPORTED
- Constant Value
- "textSupported"
Inherited Fields
| From Class | Fields |
|---|---|
| com.smartdevicelink.proxy.RPCStruct | KEY_BULK_DATA, KEY_PROTECTED, store |
Constructors
SoftButtonCapabilities()
Constructs a newly allocated SoftButtonCapabilities object
public SoftButtonCapabilities()
SoftButtonCapabilities( java.util.Hashtable<java.lang.String, java.lang.Object> hash )
Constructs a newly allocated SoftButtonCapabilities object indicated by the Hashtable parameter
public SoftButtonCapabilities(java.util.Hashtable<java.lang.String, java.lang.Object> hash)
Constructor Parameters
- hash
- The Hashtable to use
SoftButtonCapabilities( Boolean shortPressAvailable, Boolean longPressAvailable, Boolean upDownAvailable, Boolean imageSupported )
Constructs a newly allocated SoftButtonCapabilities object
public SoftButtonCapabilities(Boolean shortPressAvailable,Boolean longPressAvailable,Boolean upDownAvailable,Boolean imageSupported)
Constructor 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.
Methods
format( Version rpcVersion, boolean formatParams )
public void format(Version rpcVersion,boolean formatParams)
Method Parameters
- rpcVersion
- formatParams
setShortPressAvailable( Boolean shortPressAvailable )
set the button supports a short press.
public com.smartdevicelink.proxy.rpc.SoftButtonCapabilities setShortPressAvailable(Boolean shortPressAvailable)
Method Parameters
- shortPressAvailable
- whether the button supports a short press.
getShortPressAvailable()
get whether the button supports a short press.
public java.lang.Boolean getShortPressAvailable()
setLongPressAvailable( Boolean longPressAvailable )
set the button supports a LONG press.
public com.smartdevicelink.proxy.rpc.SoftButtonCapabilities setLongPressAvailable(Boolean longPressAvailable)
Method Parameters
- longPressAvailable
- whether the button supports a long press
getLongPressAvailable()
get whether the button supports a LONG press.
public java.lang.Boolean getLongPressAvailable()
setUpDownAvailable( Boolean upDownAvailable )
set the button supports "button down" and "button up".
public com.smartdevicelink.proxy.rpc.SoftButtonCapabilities setUpDownAvailable(Boolean upDownAvailable)
Method Parameters
- upDownAvailable
- the button supports "button down" and "button up".
getUpDownAvailable()
get the button supports "button down" and "button up".
public java.lang.Boolean getUpDownAvailable()
setImageSupported( Boolean imageSupported )
set the button supports referencing a static or dynamic image.
public com.smartdevicelink.proxy.rpc.SoftButtonCapabilities setImageSupported(Boolean imageSupported)
Method Parameters
- imageSupported
- whether the button supports referencing a static or dynamic image.
getImageSupported()
get the button supports referencing a static or dynamic image.
public java.lang.Boolean getImageSupported()
setTextSupported( Boolean textSupported )
set the text support. If not included, the default value should be considered true that the button will support text.
public com.smartdevicelink.proxy.rpc.SoftButtonCapabilities setTextSupported(Boolean textSupported)
Method Parameters
- textSupported
- whether the button supports the use of text or not.
getTextSupported()
get the text support.
public java.lang.Boolean getTextSupported()
Inherited Methods
| From Class | Methods |
|---|---|
| com.smartdevicelink.proxy.RPCStruct | getStoreValue, getStore, deserializeJSON, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong, clone, equals, hashCode |
| java.lang.Object | getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize |