Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Sidebar

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

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

Name Type Description SmartDeviceLink Ver. Available
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)

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)

Parameters

displayType
the display type
textFields
the List of textFields
mediaClockFormats
the List of MediaClockFormat
graphicSupported

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)

Parameters

displayName
the display name (String)
textFields
the List of textFields
mediaClockFormats
the List of MediaClockFormat
graphicSupported

Methods

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 void setDisplayType(DisplayType displayType)

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 void setDisplayName(String displayName)

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

Parameters

textFields
the List of textFields

getImageFields()

public java.util.List getImageFields()

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

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

Parameters

imageFields

getNumCustomPresetsAvailable()

public java.lang.Integer getNumCustomPresetsAvailable()

setNumCustomPresetsAvailable( Integer numCustomPresetsAvailable )

public void setNumCustomPresetsAvailable(Integer numCustomPresetsAvailable)

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 void setMediaClockFormats(java.util.List<com.smartdevicelink.proxy.rpc.enums.MediaClockFormat> mediaClockFormats)

Parameters

mediaClockFormats
the List of MediaClockFormat

setGraphicSupported( Boolean graphicSupported )

set the display's persistent screen supports.

public void setGraphicSupported(Boolean graphicSupported)

Parameters

graphicSupported

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 void setTemplatesAvailable(java.util.List<java.lang.String> templatesAvailable)

Parameters

templatesAvailable

setScreenParams( ScreenParams screenParams )

public void setScreenParams(ScreenParams screenParams)

Parameters

screenParams

getScreenParams()

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

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCStruct getStoreValue, getStore, deserializeJSON, deserializeJSONObject, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section