Class ButtonCapabilities
Hierarchy
java.lang.Object
com.smartdevicelink.proxy.RPCStruct
- Package
- com.smartdevicelink.proxy.rpc
Overview
Provides information about the capabilities of a SDL HMI button.Parameter List
| Name | Type | Description | SmartDeviceLink Ver. Available |
|---|---|---|---|
| name | ButtonName | The name of theSDL HMI button. | SmartDeviceLink 1.0 |
| shortPressAvailable | Boolean | The button supports a SHORT press. See com.smartdevicelink.proxy.rpc.enums.ButtonPressMode for more information. | SmartDeviceLink 1.0 |
| longPressAvailable | Boolean | The button supports a LONG press. See com.smartdevicelink.proxy.rpc.enums.ButtonPressMode for more information. | SmartDeviceLink 1.0 |
| upDownAvailable | Boolean | The button supports "button down" and "button up". When the button is depressed, the OnButtonEvent notification will be invoked with a value of BUTTONDOWN.
When the button is released, the OnButtonEvent notification will be invoked with a value of BUTTONUP. |
SmartDeviceLink 1.0 |
Upon the request HMI must provide the list of the following information:
The names of all existing/supported hardware buttons.
The availability of LONG/SHORT press for each existing/supported hardware button correspondingly
The availability of UP/DOWN events for each existing/supported hardware button correspondingly.
Quick Jump
- Fields
- Constructors
- Methods
Fields
KEY_NAME
public static final java.lang.String KEY_NAME
- Constant Value
- "name"
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_MODULE_INFO
public static final java.lang.String KEY_MODULE_INFO
- Constant Value
- "moduleInfo"
Inherited Fields
| From Class | Fields |
|---|---|
| com.smartdevicelink.proxy.RPCStruct | KEY_BULK_DATA, KEY_PROTECTED, store |
Constructors
ButtonCapabilities()
Constructs a newly allocated ButtonCapabilities object
public ButtonCapabilities()
ButtonCapabilities( java.util.Hashtable<java.lang.String, java.lang.Object> hash )
Constructs a newly allocated ButtonCapabilities object indicated by the Hashtable parameter
public ButtonCapabilities(java.util.Hashtable<java.lang.String, java.lang.Object> hash)
Constructor Parameters
- hash
- The Hashtable to use
ButtonCapabilities( ButtonName name, Boolean shortPressAvailable, Boolean longPressAvailable, Boolean upDownAvailable )
Constructs a newly allocated ButtonCapabilities object
public ButtonCapabilities(ButtonName name,Boolean shortPressAvailable,Boolean longPressAvailable,Boolean upDownAvailable)
Constructor Parameters
- name
- the name of button
- shortPressAvailable
- True if support otherwise False.
- longPressAvailable
- True if support otherwise False.
- upDownAvailable
- True if support otherwise False.
Methods
getName()
Get the name of theSDL HMI button.
public com.smartdevicelink.proxy.rpc.enums.ButtonName getName()
setName( ButtonName name )
Set the name of theSDL HMI button.
public com.smartdevicelink.proxy.rpc.ButtonCapabilities setName(ButtonName name)
Method Parameters
- name
- the name of button
getShortPressAvailable()
Whether the button supports a SHORT press. See com.smartdevicelink.proxy.rpc.enums.ButtonPressMode for more information.
public java.lang.Boolean getShortPressAvailable()
setShortPressAvailable( Boolean shortPressAvailable )
Set the button supports a SHORT press. See com.smartdevicelink.proxy.rpc.enums.ButtonPressMode for more information.
public com.smartdevicelink.proxy.rpc.ButtonCapabilities setShortPressAvailable(Boolean shortPressAvailable)
Method Parameters
- shortPressAvailable
- True if support otherwise False.
getLongPressAvailable()
Whether the button supports a LONG press. See com.smartdevicelink.proxy.rpc.enums.ButtonPressMode for more information.
public java.lang.Boolean getLongPressAvailable()
setLongPressAvailable( Boolean longPressAvailable )
Set the button supports a LONG press. See com.smartdevicelink.proxy.rpc.enums.ButtonPressMode for more information.
public com.smartdevicelink.proxy.rpc.ButtonCapabilities setLongPressAvailable(Boolean longPressAvailable)
Method Parameters
- longPressAvailable
- True if support otherwise False.
getUpDownAvailable()
Whether the button supports "button down" and "button up". When the button is depressed, the OnButtonEvent notification will be invoked with a value of BUTTONDOWN.
public java.lang.Boolean getUpDownAvailable()
setUpDownAvailable( Boolean upDownAvailable )
Set the button supports "button down" and "button up". When the button is depressed, the OnButtonEvent notification will be invoked with a value of BUTTONDOWN.
public com.smartdevicelink.proxy.rpc.ButtonCapabilities setUpDownAvailable(Boolean upDownAvailable)
Method Parameters
- upDownAvailable
- True if support otherwise False.
setModuleInfo( ModuleInfo info )
Sets ModuleInfo for this capability
public com.smartdevicelink.proxy.rpc.ButtonCapabilities setModuleInfo(ModuleInfo info)
Method Parameters
- info
- the ModuleInfo to be set
getModuleInfo()
Gets a ModuleInfo of this capability
public com.smartdevicelink.proxy.rpc.ModuleInfo getModuleInfo()
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 |