WindowCapability (sdl_android 5.3.1 API)

java.lang.Object
- com.smartdevicelink.proxy.RPCStruct
- - com.smartdevicelink.proxy.rpc.WindowCapability

All Implemented Interfaces:: Cloneable

public class WindowCapability
extends RPCStruct

Since:: 6.0

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KEY_BUTTON_CAPABILITIES`
`static String`	`KEY_DYNAMIC_UPDATE_CAPABILITIES`
`static String`	`KEY_IMAGE_FIELDS`
`static String`	`KEY_IMAGE_TYPE_SUPPORTED`
`static String`	`KEY_KEYBOARD_CAPABILITIES`
`static String`	`KEY_MENU_LAYOUTS_AVAILABLE`
`static String`	`KEY_NUM_CUSTOM_PRESETS_AVAILABLE`
`static String`	`KEY_SOFT_BUTTON_CAPABILITIES`
`static String`	`KEY_TEMPLATES_AVAILABLE`
`static String`	`KEY_TEXT_FIELDS`
`static String`	`KEY_WINDOW_ID`

Fields inherited from class com.smartdevicelink.proxy.RPCStruct
KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors
Constructor and Description

WindowCapability()

WindowCapability(Hashtable<String,Object> hash)

Constructors
Constructor and Description
`WindowCapability()`
`WindowCapability(Hashtable<String,Object> hash)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<ButtonCapabilities>`	`getButtonCapabilities()` Gets the buttonCapabilities portion of the WindowCapability class
`DynamicUpdateCapabilities`	`getDynamicUpdateCapabilities()` Gets the dynamicUpdateCapabilities.
`List<ImageField>`	`getImageFields()` Get an array of ImageField structures.
`List<ImageType>`	`getImageTypeSupported()` Get an array of ImageType elements.
`KeyboardCapabilities`	`getKeyboardCapabilities()` Gets the keyboardCapabilities.
`List<MenuLayout>`	`getMenuLayoutsAvailable()` An array of available menu layouts.
`Integer`	`getNumCustomPresetsAvailable()` Gets the numCustomPresetsAvailable.
`List<SoftButtonCapabilities>`	`getSoftButtonCapabilities()` Gets the softButtonCapabilities portion of the WindowCapability class
`List<String>`	`getTemplatesAvailable()` Get an array of templatesAvailable.
`List<TextField>`	`getTextFields()` Get an array of TextField structures.
`Integer`	`getWindowID()` Gets the windowID.
`WindowCapability`	`setButtonCapabilities(List<ButtonCapabilities> buttonCapabilities)` Sets the buttonCapabilities portion of the WindowCapability class.
`WindowCapability`	`setDynamicUpdateCapabilities(DynamicUpdateCapabilities dynamicUpdateCapabilities)` Sets the dynamicUpdateCapabilities.
`WindowCapability`	`setImageFields(List<ImageField> imageFields)` Set an array of ImageField structures.
`WindowCapability`	`setImageTypeSupported(List<ImageType> imageTypeSupported)` Set an array of ImageType elements.
`WindowCapability`	`setKeyboardCapabilities(KeyboardCapabilities keyboardCapabilities)` Sets the keyboardCapabilities.
`WindowCapability`	`setMenuLayoutsAvailable(List<MenuLayout> menuLayout)` An array of available menu layouts.
`WindowCapability`	`setNumCustomPresetsAvailable(Integer numCustomPresetsAvailable)` Sets the numCustomPresetsAvailable.
`WindowCapability`	`setSoftButtonCapabilities(List<SoftButtonCapabilities> softButtonCapabilities)` Sets the softButtonCapabilities portion of the WindowCapability class.
`WindowCapability`	`setTemplatesAvailable(List<String> templatesAvailable)` Set an array of templatesAvailable.
`WindowCapability`	`setTextFields(List<TextField> textFields)` Set an array of TextField structures.
`WindowCapability`	`setWindowID(Integer windowID)` Sets the windowID.

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_WINDOW_ID
```
public static final String KEY_WINDOW_ID
```
    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_IMAGE_TYPE_SUPPORTED
```
public static final String KEY_IMAGE_TYPE_SUPPORTED
```
    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
  - KEY_BUTTON_CAPABILITIES
```
public static final String KEY_BUTTON_CAPABILITIES
```
    See Also:
    
    Constant Field Values
  - KEY_SOFT_BUTTON_CAPABILITIES
```
public static final String KEY_SOFT_BUTTON_CAPABILITIES
```
    See Also:
    
    Constant Field Values
  - KEY_MENU_LAYOUTS_AVAILABLE
```
public static final String KEY_MENU_LAYOUTS_AVAILABLE
```
    See Also:
    
    Constant Field Values
  - KEY_DYNAMIC_UPDATE_CAPABILITIES
```
public static final String KEY_DYNAMIC_UPDATE_CAPABILITIES
```
    See Also:
    
    Constant Field Values
  - KEY_KEYBOARD_CAPABILITIES
```
public static final String KEY_KEYBOARD_CAPABILITIES
```
    Since:
    
    SmartDeviceLink 7.1.0
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WindowCapability
```
public WindowCapability()
```
  - WindowCapability
```
public WindowCapability(Hashtable<String,Object> hash)
```
- Method Detail
  - setWindowID
```
public WindowCapability setWindowID(Integer windowID)
```
    Sets the windowID. The specified ID of the window. Can be set to a predefined window, or omitted for the main window on the main display.
    
    Parameters:
    
    windowID - A unique ID to identify the window. The value of '0' will always be the default main window on the main display and should not be used in this context as it will already be created for the app. See PredefinedWindows enum. Creating a window with an ID that is already in use will be rejected with `INVALID_ID`.
  - getWindowID
```
public Integer getWindowID()
```
    Gets the windowID.
    
    Returns:
    
    Integer
  - getTextFields
```
public List<TextField> getTextFields()
```
    Get an array of TextField structures.
    
    Returns:
    
    the List of textFields
  - setTextFields
```
public WindowCapability setTextFields(List<TextField> textFields)
```
    Set an array of TextField structures. It's set of all fields that support text data. 1<= textFields.size() <= 100
    
    Parameters:
    
    textFields - the List of textFields
  - getImageFields
```
public List<ImageField> getImageFields()
```
    Get an array of ImageField structures.
    
    Returns:
    
    the List of imageFields
  - setImageFields
```
public WindowCapability setImageFields(List<ImageField> imageFields)
```
    Set an array of ImageField structures. A set of all fields that support images. 1<= ImageFields.size() <= 100
    
    Parameters:
    
    imageFields - the List of imageFields
  - getImageTypeSupported
```
public List<ImageType> getImageTypeSupported()
```
    Get an array of ImageType elements.
    
    Returns:
    
    the List of imageTypeSupported
  - setImageTypeSupported
```
public WindowCapability setImageTypeSupported(List<ImageType> imageTypeSupported)
```
    Set an array of ImageType elements. 0<= imageTypeSupported.size() <= 1000
    
    Parameters:
    
    imageTypeSupported - the List of ImageType
  - getTemplatesAvailable
```
public List<String> getTemplatesAvailable()
```
    Get an array of templatesAvailable.
    
    Returns:
    
    the List of templatesAvailable
  - setTemplatesAvailable
```
public WindowCapability setTemplatesAvailable(List<String> templatesAvailable)
```
    Set an array of templatesAvailable. 0<= templatesAvailable.size() <= 100
    
    Parameters:
    
    templatesAvailable - the List of String
  - getNumCustomPresetsAvailable
```
public Integer getNumCustomPresetsAvailable()
```
    Gets the numCustomPresetsAvailable.
    
    Returns:
    
    Integer
  - setNumCustomPresetsAvailable
```
public WindowCapability setNumCustomPresetsAvailable(Integer numCustomPresetsAvailable)
```
    Sets the numCustomPresetsAvailable. The number of on-window custom presets available (if any); otherwise omitted. 1<= numCustomPresetsAvailable.size() <= 100
    
    Parameters:
    
    numCustomPresetsAvailable -
  - setButtonCapabilities
```
public WindowCapability setButtonCapabilities(List<ButtonCapabilities> buttonCapabilities)
```
    Sets the buttonCapabilities portion of the WindowCapability class. 1<= buttonCapabilities.size() <= 100
    
    Parameters:
    
    buttonCapabilities - It refers to number of buttons and the capabilities of each on-window button.
  - getButtonCapabilities
```
public List<ButtonCapabilities> getButtonCapabilities()
```
    Gets the buttonCapabilities portion of the WindowCapability class
    
    Returns:
    
    List It refers to number of buttons and the capabilities of each on-window button.
  - setSoftButtonCapabilities
```
public WindowCapability setSoftButtonCapabilities(List<SoftButtonCapabilities> softButtonCapabilities)
```
    Sets the softButtonCapabilities portion of the WindowCapability class. 1<= softButtonCapabilities.size() <= 100
    
    Parameters:
    
    softButtonCapabilities - It refers to number of soft buttons available on-window and the capabilities for each button.
  - getSoftButtonCapabilities
```
public List<SoftButtonCapabilities> getSoftButtonCapabilities()
```
    Gets the softButtonCapabilities portion of the WindowCapability class
    
    Returns:
    
    List It refers to number of soft buttons available on-window and the capabilities for each button.
  - setMenuLayoutsAvailable
```
public WindowCapability setMenuLayoutsAvailable(List<MenuLayout> menuLayout)
```
    An array of available menu layouts. If this parameter is not provided, only the `LIST` layout is assumed to be available
    
    Parameters:
    
    menuLayout - - An array of MenuLayouts
  - getMenuLayoutsAvailable
```
public List<MenuLayout> getMenuLayoutsAvailable()
```
    An array of available menu layouts. If this parameter is not provided, only the `LIST` layout is assumed to be available
    
    Returns:
    
    MenuLayout[]
  - setDynamicUpdateCapabilities
```
public WindowCapability setDynamicUpdateCapabilities(DynamicUpdateCapabilities dynamicUpdateCapabilities)
```
    Sets the dynamicUpdateCapabilities.
    
    Parameters:
    
    dynamicUpdateCapabilities - Contains the head unit's capabilities for dynamic updating features declaring if the module will send dynamic update RPCs.
    
    Since:
    
    SmartDeviceLink 7.0.0
  - getDynamicUpdateCapabilities
```
public DynamicUpdateCapabilities getDynamicUpdateCapabilities()
```
    Gets the dynamicUpdateCapabilities.
    
    Returns:
    
    DynamicUpdateCapabilities Contains the head unit's capabilities for dynamic updating features declaring if the module will send dynamic update RPCs.
    
    Since:
    
    SmartDeviceLink 7.0.0
  - setKeyboardCapabilities
```
public WindowCapability setKeyboardCapabilities(KeyboardCapabilities keyboardCapabilities)
```
    Sets the keyboardCapabilities.
    
    Parameters:
    
    keyboardCapabilities - See KeyboardCapabilities
    
    Since:
    
    SmartDeviceLink 7.1.0
  - getKeyboardCapabilities
```
public KeyboardCapabilities getKeyboardCapabilities()
```
    Gets the keyboardCapabilities.
    
    Returns:
    
    KeyboardCapabilities See KeyboardCapabilities
    
    Since:
    
    SmartDeviceLink 7.1.0

Class WindowCapability

Field Summary

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

Constructor Summary

Method Summary

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

Methods inherited from class java.lang.Object

Field Detail

KEY_WINDOW_ID

KEY_TEXT_FIELDS

KEY_IMAGE_FIELDS

KEY_IMAGE_TYPE_SUPPORTED

KEY_TEMPLATES_AVAILABLE

KEY_NUM_CUSTOM_PRESETS_AVAILABLE

KEY_BUTTON_CAPABILITIES

KEY_SOFT_BUTTON_CAPABILITIES

KEY_MENU_LAYOUTS_AVAILABLE

KEY_DYNAMIC_UPDATE_CAPABILITIES

KEY_KEYBOARD_CAPABILITIES

Constructor Detail

WindowCapability

WindowCapability

Method Detail

setWindowID

getWindowID

getTextFields

setTextFields

getImageFields

setImageFields

getImageTypeSupported

setImageTypeSupported

getTemplatesAvailable

setTemplatesAvailable

getNumCustomPresetsAvailable

setNumCustomPresetsAvailable

setButtonCapabilities

getButtonCapabilities

setSoftButtonCapabilities

getSoftButtonCapabilities

setMenuLayoutsAvailable

getMenuLayoutsAvailable

setDynamicUpdateCapabilities

getDynamicUpdateCapabilities

setKeyboardCapabilities

getKeyboardCapabilities