Class Image
Hierarchy
java.lang.Object
com.smartdevicelink.proxy.RPCStruct
- Package
- com.smartdevicelink.proxy.rpc
Overview
Specifies, which image shall be used, e.g. in Alerts or on SoftButtons provided the display supports it.Parameter List
| Name | Type | Description | SmartDeviceLink Ver. Available |
|---|---|---|---|
| value | String | Either the static hex icon value or the binary image file name identifier (sent by PutFile).
|
SmartDeviceLink 2.0 |
| imageType | ImageType | Describes, whether it is a static or dynamic image. | SmartDeviceLink 2.0 |
Quick Jump
- Fields
- Constructors
- Methods
Fields
KEY_VALUE
public static final java.lang.String KEY_VALUE
- Constant Value
- "value"
KEY_IMAGE_TYPE
public static final java.lang.String KEY_IMAGE_TYPE
- Constant Value
- "imageType"
KEY_IS_TEMPLATE
public static final java.lang.String KEY_IS_TEMPLATE
- Constant Value
- "isTemplate"
Inherited Fields
| From Class | Fields |
|---|---|
| com.smartdevicelink.proxy.RPCStruct | KEY_BULK_DATA, KEY_PROTECTED, store |
Constructors
Image()
Constructs a newly allocated Image object
public Image()
Image( java.util.Hashtable<java.lang.String, java.lang.Object> hash )
Constructs a newly allocated Image object indicated by the Hashtable parameter
public Image(java.util.Hashtable<java.lang.String, java.lang.Object> hash)
Constructor Parameters
- hash
- The Hashtable to use
Image( String value, ImageType imageType )
Constructs a newly allocated Image object
public Image(String value,ImageType imageType)
Constructor Parameters
- value
- either the static hex icon value or the binary image file name identifier (sent by PutFile)
- imageType
- whether it is a static or dynamic image
Methods
setValue( String value )
Set either the static hex icon value or the binary image file name identifier (sent by PutFile)
public com.smartdevicelink.proxy.rpc.Image setValue(String value)
Method Parameters
- value
- either the static hex icon value or the binary image file name identifier (sent by PutFile)
getValue()
Get either the static hex icon value or the binary image file name identifier (sent by PutFile)
public java.lang.String getValue()
setImageType( ImageType imageType )
Set the image type (static or dynamic image)
public com.smartdevicelink.proxy.rpc.Image setImageType(ImageType imageType)
Method Parameters
- imageType
- whether it is a static or dynamic image
getImageType()
Get image type (static or dynamic image)
public com.smartdevicelink.proxy.rpc.enums.ImageType getImageType()
setIsTemplate( Boolean isTemplate )
Set whether this Image is a template image whose coloring should be decided by the HMI
public com.smartdevicelink.proxy.rpc.Image setIsTemplate(Boolean isTemplate)
Method Parameters
- isTemplate
- boolean that tells whether this Image is a template image
getIsTemplate()
Get whether this Image is a template image whose coloring should be decided by the HMI
public java.lang.Boolean getIsTemplate()
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 |