Class DisplayCapability
Hierarchy
java.lang.Object
com.smartdevicelink.proxy.RPCStruct
- Package
- com.smartdevicelink.proxy.rpc
Overview
Contain the display related information and all windows related to that display.Quick Jump
- Fields
- Constructors
- Methods
-
- getDisplayName()
- setDisplayName(String displayName)
- setWindowTypeSupported(java.util.List<com.smartdevicelink.proxy.rpc.WindowTypeCapabilities> windowTypeSupported)
- getWindowTypeSupported()
- setWindowCapabilities(java.util.List<com.smartdevicelink.proxy.rpc.WindowCapability> windowCapabilities)
- getWindowCapabilities()
Fields
KEY_DISPLAY_NAME
public static final java.lang.String KEY_DISPLAY_NAME
- Constant Value
- "displayName"
KEY_WINDOW_TYPE_SUPPORTED
public static final java.lang.String KEY_WINDOW_TYPE_SUPPORTED
- Constant Value
- "windowTypeSupported"
KEY_WINDOW_CAPABILITIES
public static final java.lang.String KEY_WINDOW_CAPABILITIES
- Constant Value
- "windowCapabilities"
Inherited Fields
| From Class | Fields |
|---|---|
| com.smartdevicelink.proxy.RPCStruct | KEY_BULK_DATA, KEY_PROTECTED, store |
Constructors
DisplayCapability()
public DisplayCapability()
DisplayCapability( java.util.Hashtable<java.lang.String, java.lang.Object> hash )
public DisplayCapability(java.util.Hashtable<java.lang.String, java.lang.Object> hash)
Constructor Parameters
- hash
Methods
getDisplayName()
Get the name of the display
public java.lang.String getDisplayName()
setDisplayName( String displayName )
Set the name of the display {@code displayName.length() > 1}
public com.smartdevicelink.proxy.rpc.DisplayCapability setDisplayName(String displayName)
Method Parameters
- displayName
- the name of the display
setWindowTypeSupported( java.util.List<com.smartdevicelink.proxy.rpc.WindowTypeCapabilities> windowTypeSupported )
Sets the windowTypeSupported portion of the DisplayCapability class. {@code windowTypeSupported.size()>=1}
public com.smartdevicelink.proxy.rpc.DisplayCapability setWindowTypeSupported(java.util.List<com.smartdevicelink.proxy.rpc.WindowTypeCapabilities> windowTypeSupported)
Method Parameters
- windowTypeSupported
- It informs the application how many windows the app is allowed to create per type.
getWindowTypeSupported()
Gets the windowTypeSupported portion of the DisplayCapability class
public java.util.List getWindowTypeSupported()
setWindowCapabilities( java.util.List<com.smartdevicelink.proxy.rpc.WindowCapability> windowCapabilities )
Sets the windowCapabilities portion of the DisplayCapability class.
public com.smartdevicelink.proxy.rpc.DisplayCapability setWindowCapabilities(java.util.List<com.smartdevicelink.proxy.rpc.WindowCapability> windowCapabilities)
Method 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()
Gets the windowCapabilities portion of the DisplayCapability class
public java.util.List getWindowCapabilities()
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 |