com.smartdevicelink.proxy.rpc

Class Image

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.Image

All Implemented Interfaces:

Cloneable

public class Image
extends RPCStruct

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). Min: 0 Max: 65535	SmartDeviceLink 2.0
imageType	ImageType	Describes, whether it is 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_TYPE
static String	KEY_IS_TEMPLATE
static String	KEY_VALUE

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
Image() Constructs a newly allocated Image object
Image(Hashtable<String,Object> hash) Constructs a newly allocated Image object indicated by the Hashtable parameter
Image(String value, ImageType imageType) Constructs a newly allocated Image object

Method Summary

Modifier and Type	Method and Description
ImageType	getImageType() Get image type (static or dynamic image)
Boolean	getIsTemplate() Get whether this Image is a template image whose coloring should be decided by the HMI
String	getValue() Get either the static hex icon value or the binary image file name identifier (sent by PutFile)
Image	setImageType(ImageType imageType) Set the image type (static or dynamic image)
Image	setIsTemplate(Boolean isTemplate) Set whether this Image is a template image whose coloring should be decided by the HMI
Image	setValue(String value) Set either the static hex icon value or the binary image file name identifier (sent by PutFile)

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

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

public static final String KEY_VALUE

See Also:

Constant Field Values

KEY_IMAGE_TYPE

public static final String KEY_IMAGE_TYPE

See Also:

Constant Field Values

KEY_IS_TEMPLATE

public static final String KEY_IS_TEMPLATE

See Also:

Constant Field Values

Constructor Detail

Image

public Image()

Constructs a newly allocated Image object

Image

public Image(Hashtable<String,Object> hash)

Constructs a newly allocated Image object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

Image

public Image(@NonNull
             String value,
             @NonNull
             ImageType imageType)

Constructs a newly allocated Image object

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

Method Detail

setValue

public Image setValue(@NonNull
                      String value)

Set either the static hex icon value or the binary image file name identifier (sent by PutFile)

Parameters:

value - either the static hex icon value or the binary image file name identifier (sent by PutFile)

getValue

public String getValue()

Get either the static hex icon value or the binary image file name identifier (sent by PutFile)

Returns:

either the static hex icon value or the binary image file name identifier (sent by PutFile)

setImageType

public Image setImageType(@NonNull
                          ImageType imageType)

Set the image type (static or dynamic image)

Parameters:

imageType - whether it is a static or dynamic image

getImageType

public ImageType getImageType()

Get image type (static or dynamic image)

Returns:

the image type (static or dynamic image)

setIsTemplate

public Image setIsTemplate(Boolean isTemplate)

Set whether this Image is a template image whose coloring should be decided by the HMI

Parameters:

isTemplate - boolean that tells whether this Image is a template image

getIsTemplate

public Boolean getIsTemplate()

Get whether this Image is a template image whose coloring should be decided by the HMI

Returns:

boolean that tells whether this Image is a template image