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

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

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"

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)

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)

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

setShortPressAvailable( Boolean shortPressAvailable )

set the button supports a short press.

public void setShortPressAvailable(Boolean shortPressAvailable)

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 void setLongPressAvailable(Boolean longPressAvailable)

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 void setUpDownAvailable(Boolean upDownAvailable)

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 void setImageSupported(Boolean imageSupported)

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()

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