com.smartdevicelink.proxy.rpc

Class DisplayCapabilities

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.DisplayCapabilities

All Implemented Interfaces:

Cloneable

public class DisplayCapabilities
extends RPCStruct

Contains information about the display for the SDL system to which the application is currently connected.

Parameter List

Name	Type	Description	SmartDeviceLink Ver. Available
@property-deprecated displayType	DisplayType	The type of display	SmartDeviceLink 1.0
displayName	String	The name of the display	SmartDeviceLink 5.0
textField	TextField[]	An array of TextField structures, each of which describes a field in the HMI which the application can write to using operations such as Show, SetMediaClockTimer, etc. This array of TextField structures identify all the text fields to which the application can write on the current display (identified by DisplayType ).	SmartDeviceLink 1.0
mediaClockFormats	MediaClockFormat[]	An array of MediaClockFormat elements, defining the valid string formats used in specifying the contents of the media clock field	SmartDeviceLink 1.0
graphicSupported	Boolean	The display's persistent screen supports referencing a static or dynamic image.	SmartDeviceLink 2.0

Since:

SmartDeviceLink 1.0

See Also:

DisplayType, MediaClockFormat, TextField, ImageField

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_DISPLAY_NAME
static String	KEY_DISPLAY_TYPE Deprecated.
static String	KEY_GRAPHIC_SUPPORTED
static String	KEY_IMAGE_FIELDS
static String	KEY_MEDIA_CLOCK_FORMATS
static String	KEY_NUM_CUSTOM_PRESETS_AVAILABLE
static String	KEY_SCREEN_PARAMS
static String	KEY_TEMPLATES_AVAILABLE
static String	KEY_TEXT_FIELDS

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
DisplayCapabilities() Constructs a newly allocated DisplayCapabilities object
DisplayCapabilities(DisplayType displayType, List<TextField> textFields, List<MediaClockFormat> mediaClockFormats, Boolean graphicSupported) Deprecated.
DisplayCapabilities(Hashtable<String,Object> hash) Constructs a newly allocated DisplayCapabilities object indicated by the Hashtable parameter
DisplayCapabilities(String displayName, List<TextField> textFields, List<MediaClockFormat> mediaClockFormats, Boolean graphicSupported) Constructs a newly allocated DisplayCapabilities object

Method Summary

Modifier and Type	Method and Description
void	format(Version rpcVersion, boolean formatParams) This method should clean the the RPC to make sure it is compliant with the spec.
String	getDisplayName() Get the name of the display
DisplayType	getDisplayType() Deprecated.
Boolean	getGraphicSupported() Get the display's persistent screen supports.
List<ImageField>	getImageFields()
List<MediaClockFormat>	getMediaClockFormats() Get an array of MediaClockFormat elements, defining the valid string formats used in specifying the contents of the media clock field
Integer	getNumCustomPresetsAvailable()
ScreenParams	getScreenParams()
List<String>	getTemplatesAvailable()
List<TextField>	getTextFields() Get an array of TextField structures, each of which describes a field in the HMI which the application can write to using operations such as Show, SetMediaClockTimer, etc.
DisplayCapabilities	setDisplayName(String displayName) Set the name of the display
DisplayCapabilities	setDisplayType(DisplayType displayType) Deprecated.
DisplayCapabilities	setGraphicSupported(Boolean graphicSupported) set the display's persistent screen supports.
DisplayCapabilities	setImageFields(List<ImageField> imageFields)
DisplayCapabilities	setMediaClockFormats(List<MediaClockFormat> mediaClockFormats) Set an array of MediaClockFormat elements, defining the valid string formats used in specifying the contents of the media clock field
DisplayCapabilities	setNumCustomPresetsAvailable(Integer numCustomPresetsAvailable)
DisplayCapabilities	setScreenParams(ScreenParams screenParams)
DisplayCapabilities	setTemplatesAvailable(List<String> templatesAvailable)
DisplayCapabilities	setTextFields(List<TextField> textFields) Set an array of TextField structures, each of which describes a field in the HMI which the application can write to using operations such as Show, SetMediaClockTimer, etc.

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

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

@Deprecated
public static final String KEY_DISPLAY_TYPE

Deprecated.

See Also:

Constant Field Values

KEY_DISPLAY_NAME

public static final String KEY_DISPLAY_NAME

See Also:

Constant Field Values

KEY_MEDIA_CLOCK_FORMATS

public static final String KEY_MEDIA_CLOCK_FORMATS

See Also:

Constant Field Values

KEY_TEXT_FIELDS

public static final String KEY_TEXT_FIELDS

See Also:

Constant Field Values

KEY_IMAGE_FIELDS

public static final String KEY_IMAGE_FIELDS

See Also:

Constant Field Values

KEY_GRAPHIC_SUPPORTED

public static final String KEY_GRAPHIC_SUPPORTED

See Also:

Constant Field Values

KEY_SCREEN_PARAMS

public static final String KEY_SCREEN_PARAMS

See Also:

Constant Field Values

KEY_TEMPLATES_AVAILABLE

public static final String KEY_TEMPLATES_AVAILABLE

See Also:

Constant Field Values

KEY_NUM_CUSTOM_PRESETS_AVAILABLE

public static final String KEY_NUM_CUSTOM_PRESETS_AVAILABLE

See Also:

Constant Field Values

Constructor Detail

DisplayCapabilities

public DisplayCapabilities()

Constructs a newly allocated DisplayCapabilities object

DisplayCapabilities

public DisplayCapabilities(Hashtable<String,Object> hash)

Constructs a newly allocated DisplayCapabilities object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

DisplayCapabilities

@Deprecated
public DisplayCapabilities(@NonNull
                                       DisplayType displayType,
                                       @NonNull
                                       List<TextField> textFields,
                                       @NonNull
                                       List<MediaClockFormat> mediaClockFormats,
                                       @NonNull
                                       Boolean graphicSupported)

Deprecated.

Constructs a newly allocated DisplayCapabilities object

Parameters:

displayType - the display type

textFields - the List of textFields

mediaClockFormats - the List of MediaClockFormat

graphicSupported - true if the display supports graphics, false if it does not

DisplayCapabilities

public DisplayCapabilities(String displayName,
                           @NonNull
                           List<TextField> textFields,
                           @NonNull
                           List<MediaClockFormat> mediaClockFormats,
                           @NonNull
                           Boolean graphicSupported)

Constructs a newly allocated DisplayCapabilities object

Parameters:

displayName - the display name (String)

textFields - the List of textFields

mediaClockFormats - the List of MediaClockFormat

graphicSupported - true if the display supports graphics, false if it does not

Method Detail

format

public void format(Version rpcVersion,
                   boolean formatParams)

Description copied from class: RPCStruct

This method should clean the the RPC to make sure it is compliant with the spec.

NOTE: Super needs to be called at the END of the method

Overrides:

format in class RPCStruct

Parameters:

rpcVersion - the rpc spec version that has been negotiated. If value is null the the max value of RPC spec version this library supports should be used.

formatParams - if true, the format method will be called on subsequent params

getDisplayType

@Deprecated
public DisplayType getDisplayType()

Deprecated.

Get the type of display

Returns:

the type of display

setDisplayType

@Deprecated
public DisplayCapabilities setDisplayType(@NonNull
                                                      DisplayType displayType)

Deprecated.

Set the type of display

Parameters:

displayType - the display type

getDisplayName

public String getDisplayName()

Get the name of the display

Returns:

the name of the display

setDisplayName

public DisplayCapabilities setDisplayName(String displayName)

Set the name of the display

Parameters:

displayName - the name of the display

getTextFields

public List<TextField> getTextFields()

Get an array of TextField structures, each of which describes a field in the HMI which the application can write to using operations such as Show, SetMediaClockTimer, etc. This array of TextField structures identify all the text fields to which the application can write on the current display (identified by DisplayType ).

Returns:

the List of textFields

setTextFields

public DisplayCapabilities setTextFields(@NonNull
                                         List<TextField> textFields)

Set an array of TextField structures, each of which describes a field in the HMI which the application can write to using operations such as Show, SetMediaClockTimer, etc. This array of TextField structures identify all the text fields to which the application can write on the current display (identified by DisplayType ).

Parameters:

textFields - the List of textFields

getImageFields

public List<ImageField> getImageFields()

setImageFields

public DisplayCapabilities setImageFields(List<ImageField> imageFields)

getNumCustomPresetsAvailable

public Integer getNumCustomPresetsAvailable()

setNumCustomPresetsAvailable

public DisplayCapabilities setNumCustomPresetsAvailable(Integer numCustomPresetsAvailable)

getMediaClockFormats

public List<MediaClockFormat> getMediaClockFormats()

Get an array of MediaClockFormat elements, defining the valid string formats used in specifying the contents of the media clock field

Returns:

the Vector of mediaClockFormat

setMediaClockFormats

public DisplayCapabilities setMediaClockFormats(@NonNull
                                                List<MediaClockFormat> mediaClockFormats)

Set an array of MediaClockFormat elements, defining the valid string formats used in specifying the contents of the media clock field

Parameters:

mediaClockFormats - the List of MediaClockFormat

setGraphicSupported

public DisplayCapabilities setGraphicSupported(@NonNull
                                               Boolean graphicSupported)

set the display's persistent screen supports.

Parameters:

graphicSupported - true if the display supports graphics, false if it does not

Since:

SmartDeviceLink 2.0

getGraphicSupported

public Boolean getGraphicSupported()

Get the display's persistent screen supports.

Returns:

true if the display supports graphics, false if it does not

Since:

SmartDeviceLink 2.0

getTemplatesAvailable

public List<String> getTemplatesAvailable()

setTemplatesAvailable

public DisplayCapabilities setTemplatesAvailable(List<String> templatesAvailable)

setScreenParams

public DisplayCapabilities setScreenParams(ScreenParams screenParams)

getScreenParams

public ScreenParams getScreenParams()