com.smartdevicelink.proxy.rpc

Class DisplayCapability

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.DisplayCapability

All Implemented Interfaces:

Cloneable

public class DisplayCapability
extends RPCStruct

Contain the display related information and all windows related to that display.

Since:

6.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_DISPLAY_NAME
static String	KEY_WINDOW_CAPABILITIES
static String	KEY_WINDOW_TYPE_SUPPORTED

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
DisplayCapability()
DisplayCapability(Hashtable<String,Object> hash)

Method Summary

Modifier and Type	Method and Description
String	getDisplayName() Get the name of the display
List<WindowCapability>	getWindowCapabilities() Gets the windowCapabilities portion of the DisplayCapability class
List<WindowTypeCapabilities>	getWindowTypeSupported() Gets the windowTypeSupported portion of the DisplayCapability class
DisplayCapability	setDisplayName(String displayName) Set the name of the display displayName.length() > 1
DisplayCapability	setWindowCapabilities(List<WindowCapability> windowCapabilities) Sets the windowCapabilities portion of the DisplayCapability class.
DisplayCapability	setWindowTypeSupported(List<WindowTypeCapabilities> windowTypeSupported) Sets the windowTypeSupported portion of the DisplayCapability class.

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_DISPLAY_NAME

public static final String KEY_DISPLAY_NAME

See Also:

Constant Field Values

KEY_WINDOW_TYPE_SUPPORTED

public static final String KEY_WINDOW_TYPE_SUPPORTED

See Also:

Constant Field Values

KEY_WINDOW_CAPABILITIES

public static final String KEY_WINDOW_CAPABILITIES

See Also:

Constant Field Values

Constructor Detail

DisplayCapability

public DisplayCapability()

DisplayCapability

public DisplayCapability(Hashtable<String,Object> hash)

Method Detail

getDisplayName

public String getDisplayName()

Get the name of the display

Returns:

the name of the display

setDisplayName

public DisplayCapability setDisplayName(String displayName)

Set the name of the display displayName.length() > 1

Parameters:

displayName - the name of the display

setWindowTypeSupported

public DisplayCapability setWindowTypeSupported(List<WindowTypeCapabilities> windowTypeSupported)

Sets the windowTypeSupported portion of the DisplayCapability class. windowTypeSupported.size()>=1

Parameters:

windowTypeSupported - It informs the application how many windows the app is allowed to create per type.

getWindowTypeSupported

public List<WindowTypeCapabilities> getWindowTypeSupported()

Gets the windowTypeSupported portion of the DisplayCapability class

Returns:

List It informs the application how many windows the app is allowed to create per type.

setWindowCapabilities

public DisplayCapability setWindowCapabilities(List<WindowCapability> windowCapabilities)

Sets the windowCapabilities portion of the DisplayCapability class.

Parameters:

windowCapabilities - Contains a list of capabilities of all windows related to the app. Once the app has registered the capabilities of all windows are provided. GetSystemCapability still allows requesting window capabilities of all windows. After registration, only windows with capabilities changed will be included. Following cases will cause only affected windows to be included: 1. App creates a new window. After the window is created, a system capability notification will be sent related only to the created window. 2. App sets a new template to the window. The new template changes window capabilities. The notification will reflect those changes to the single window.

getWindowCapabilities

public List<WindowCapability> getWindowCapabilities()

Gets the windowCapabilities portion of the DisplayCapability class

Returns:

List Contains a list of capabilities of all windows related to the app.