Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
US
JP
US
JP
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
JavaEE Documentation
DisplayCapabilities

Class DisplayCapabilities

Hierarchy

java.lang.Object
     com.smartdevicelink.proxy.RPCStruct

Package
com.smartdevicelink.proxy.rpc

Overview

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

Quick Jump

Fields
Constructors
Methods

Fields

KEY_DISPLAY_TYPE

public static final java.lang.String KEY_DISPLAY_TYPE
Constant Value
"displayType"

KEY_DISPLAY_NAME

public static final java.lang.String KEY_DISPLAY_NAME
Constant Value
"displayName"

KEY_MEDIA_CLOCK_FORMATS

public static final java.lang.String KEY_MEDIA_CLOCK_FORMATS
Constant Value
"mediaClockFormats"

KEY_TEXT_FIELDS

public static final java.lang.String KEY_TEXT_FIELDS
Constant Value
"textFields"

KEY_IMAGE_FIELDS

public static final java.lang.String KEY_IMAGE_FIELDS
Constant Value
"imageFields"

KEY_GRAPHIC_SUPPORTED

public static final java.lang.String KEY_GRAPHIC_SUPPORTED
Constant Value
"graphicSupported"

KEY_SCREEN_PARAMS

public static final java.lang.String KEY_SCREEN_PARAMS
Constant Value
"screenParams"

KEY_TEMPLATES_AVAILABLE

public static final java.lang.String KEY_TEMPLATES_AVAILABLE
Constant Value
"templatesAvailable"

KEY_NUM_CUSTOM_PRESETS_AVAILABLE

public static final java.lang.String KEY_NUM_CUSTOM_PRESETS_AVAILABLE
Constant Value
"numCustomPresetsAvailable"

Inherited Fields

From Class Fields
com.smartdevicelink.proxy.RPCStruct KEY_BULK_DATA, KEY_PROTECTED, store

Constructors

DisplayCapabilities()

Constructs a newly allocated DisplayCapabilities object 

public DisplayCapabilities()

DisplayCapabilities( java.util.Hashtable<java.lang.String, java.lang.Object> hash )

Constructs a newly allocated DisplayCapabilities object indicated by the Hashtable parameter 

public DisplayCapabilities(java.util.Hashtable<java.lang.String, java.lang.Object> hash)

Constructor Parameters

hash
The Hashtable to use

DisplayCapabilities( DisplayType displayType, java.util.List<com.smartdevicelink.proxy.rpc.TextField> textFields, java.util.List<com.smartdevicelink.proxy.rpc.enums.MediaClockFormat> mediaClockFormats, Boolean graphicSupported )

Constructs a newly allocated DisplayCapabilities object 

public DisplayCapabilities(DisplayType displayType,java.util.List<com.smartdevicelink.proxy.rpc.TextField> textFields,java.util.List<com.smartdevicelink.proxy.rpc.enums.MediaClockFormat> mediaClockFormats,Boolean graphicSupported)

Constructor 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( String displayName, java.util.List<com.smartdevicelink.proxy.rpc.TextField> textFields, java.util.List<com.smartdevicelink.proxy.rpc.enums.MediaClockFormat> mediaClockFormats, Boolean graphicSupported )

Constructs a newly allocated DisplayCapabilities object 

public DisplayCapabilities(String displayName,java.util.List<com.smartdevicelink.proxy.rpc.TextField> textFields,java.util.List<com.smartdevicelink.proxy.rpc.enums.MediaClockFormat> mediaClockFormats,Boolean graphicSupported)

Constructor 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

Methods

format( Version rpcVersion, boolean formatParams )

public void format(Version rpcVersion,boolean formatParams)

Method Parameters

rpcVersion
formatParams

getDisplayType()

Deprecated
Get the type of display 

public com.smartdevicelink.proxy.rpc.enums.DisplayType getDisplayType()

setDisplayType( DisplayType displayType )

Deprecated
Set the type of display 

public com.smartdevicelink.proxy.rpc.DisplayCapabilities setDisplayType(DisplayType displayType)

Method Parameters

displayType
the display type

getDisplayName()

Get the name of the display 

public java.lang.String getDisplayName()

setDisplayName( String displayName )

Set the name of the display 

public com.smartdevicelink.proxy.rpc.DisplayCapabilities setDisplayName(String displayName)

Method Parameters

displayName
the name of the display

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

public java.util.List getTextFields()

setTextFields( java.util.List<com.smartdevicelink.proxy.rpc.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 ). 

public com.smartdevicelink.proxy.rpc.DisplayCapabilities setTextFields(java.util.List<com.smartdevicelink.proxy.rpc.TextField> textFields)

Method Parameters

textFields
the List of textFields

getImageFields()

public java.util.List getImageFields()

setImageFields( java.util.List<com.smartdevicelink.proxy.rpc.ImageField> imageFields )

public com.smartdevicelink.proxy.rpc.DisplayCapabilities setImageFields(java.util.List<com.smartdevicelink.proxy.rpc.ImageField> imageFields)

Method Parameters

imageFields

getNumCustomPresetsAvailable()

public java.lang.Integer getNumCustomPresetsAvailable()

setNumCustomPresetsAvailable( Integer numCustomPresetsAvailable )

public com.smartdevicelink.proxy.rpc.DisplayCapabilities setNumCustomPresetsAvailable(Integer numCustomPresetsAvailable)

Method Parameters

numCustomPresetsAvailable

getMediaClockFormats()

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

public java.util.List getMediaClockFormats()

setMediaClockFormats( java.util.List<com.smartdevicelink.proxy.rpc.enums.MediaClockFormat> mediaClockFormats )

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

public com.smartdevicelink.proxy.rpc.DisplayCapabilities setMediaClockFormats(java.util.List<com.smartdevicelink.proxy.rpc.enums.MediaClockFormat> mediaClockFormats)

Method Parameters

mediaClockFormats
the List of MediaClockFormat

setGraphicSupported( Boolean graphicSupported )

set the display's persistent screen supports. 

public com.smartdevicelink.proxy.rpc.DisplayCapabilities setGraphicSupported(Boolean graphicSupported)

Method Parameters

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

getGraphicSupported()

Get the display's persistent screen supports. 

public java.lang.Boolean getGraphicSupported()

getTemplatesAvailable()

public java.util.List getTemplatesAvailable()

setTemplatesAvailable( java.util.List<java.lang.String> templatesAvailable )

public com.smartdevicelink.proxy.rpc.DisplayCapabilities setTemplatesAvailable(java.util.List<java.lang.String> templatesAvailable)

Method Parameters

templatesAvailable

setScreenParams( ScreenParams screenParams )

public com.smartdevicelink.proxy.rpc.DisplayCapabilities setScreenParams(ScreenParams screenParams)

Method Parameters

screenParams

getScreenParams()

public com.smartdevicelink.proxy.rpc.ScreenParams getScreenParams()

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
View on GitHub.com
Previous Section Next Section