Class WindowCapability

KEY_WINDOW_ID

public static final java.lang.String KEY_WINDOW_ID

Constant Value

"windowID"

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_IMAGE_TYPE_SUPPORTED

public static final java.lang.String KEY_IMAGE_TYPE_SUPPORTED

Constant Value

"imageTypeSupported"

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"

KEY_BUTTON_CAPABILITIES

public static final java.lang.String KEY_BUTTON_CAPABILITIES

Constant Value

"buttonCapabilities"

KEY_SOFT_BUTTON_CAPABILITIES

public static final java.lang.String KEY_SOFT_BUTTON_CAPABILITIES

Constant Value

"softButtonCapabilities"

KEY_MENU_LAYOUTS_AVAILABLE

public static final java.lang.String KEY_MENU_LAYOUTS_AVAILABLE

Constant Value

"menuLayoutsAvailable"

KEY_DYNAMIC_UPDATE_CAPABILITIES

public static final java.lang.String KEY_DYNAMIC_UPDATE_CAPABILITIES

Constant Value

"dynamicUpdateCapabilities"

KEY_KEYBOARD_CAPABILITIES

public static final java.lang.String KEY_KEYBOARD_CAPABILITIES

Constant Value

"keyboardCapabilities"

WindowCapability()

public WindowCapability()

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

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

Constructor Parameters

hash

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.

public com.smartdevicelink.proxy.rpc.WindowCapability setWindowID(Integer windowID)

Method 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()

Gets the windowID.

public java.lang.Integer getWindowID()

getTextFields()

Get an array of TextField structures.

public java.util.List getTextFields()

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

Set an array of TextField structures. It's set of all fields that support text data. {@code 1<= textFields.size() <= 100}

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

Method Parameters

textFields

the List of textFields

getImageFields()

Get an array of ImageField structures.

public java.util.List getImageFields()

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

Set an array of ImageField structures. A set of all fields that support images. {@code 1<= ImageFields.size() <= 100}

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

Method Parameters

imageFields

the List of imageFields

getImageTypeSupported()

Get an array of ImageType elements.

public java.util.List getImageTypeSupported()

setImageTypeSupported( java.util.List<com.smartdevicelink.proxy.rpc.enums.ImageType> imageTypeSupported )

Set an array of ImageType elements. {@code 0<= imageTypeSupported.size() <= 1000}

public com.smartdevicelink.proxy.rpc.WindowCapability setImageTypeSupported(java.util.List<com.smartdevicelink.proxy.rpc.enums.ImageType> imageTypeSupported)

Method Parameters

imageTypeSupported

the List of ImageType

getTemplatesAvailable()

Get an array of templatesAvailable.

public java.util.List getTemplatesAvailable()

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

Set an array of templatesAvailable. {@code 0<= templatesAvailable.size() <= 100}

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

Method Parameters

templatesAvailable

the List of String

getNumCustomPresetsAvailable()

Gets the numCustomPresetsAvailable.

public java.lang.Integer getNumCustomPresetsAvailable()

setNumCustomPresetsAvailable( Integer numCustomPresetsAvailable )

Sets the numCustomPresetsAvailable. The number of on-window custom presets available (if any); otherwise omitted. {@code 1<= numCustomPresetsAvailable.size() <= 100}

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

Method Parameters

numCustomPresetsAvailable

setButtonCapabilities( java.util.List<com.smartdevicelink.proxy.rpc.ButtonCapabilities> buttonCapabilities )

Sets the buttonCapabilities portion of the WindowCapability class. {@code 1<= buttonCapabilities.size() <= 100}

public com.smartdevicelink.proxy.rpc.WindowCapability setButtonCapabilities(java.util.List<com.smartdevicelink.proxy.rpc.ButtonCapabilities> buttonCapabilities)

Method Parameters

buttonCapabilities

It refers to number of buttons and the capabilities of each on-window button.

getButtonCapabilities()

Gets the buttonCapabilities portion of the WindowCapability class

public java.util.List getButtonCapabilities()

setSoftButtonCapabilities( java.util.List<com.smartdevicelink.proxy.rpc.SoftButtonCapabilities> softButtonCapabilities )

Sets the softButtonCapabilities portion of the WindowCapability class. {@code 1<= softButtonCapabilities.size() <= 100}

public com.smartdevicelink.proxy.rpc.WindowCapability setSoftButtonCapabilities(java.util.List<com.smartdevicelink.proxy.rpc.SoftButtonCapabilities> softButtonCapabilities)

Method Parameters

softButtonCapabilities

It refers to number of soft buttons available on-window and the capabilities for each button.

getSoftButtonCapabilities()

Gets the softButtonCapabilities portion of the WindowCapability class

public java.util.List getSoftButtonCapabilities()

setMenuLayoutsAvailable( java.util.List<com.smartdevicelink.proxy.rpc.enums.MenuLayout> menuLayout )

An array of available menu layouts. If this parameter is not provided, only the `LIST` layout is assumed to be available

public com.smartdevicelink.proxy.rpc.WindowCapability setMenuLayoutsAvailable(java.util.List<com.smartdevicelink.proxy.rpc.enums.MenuLayout> menuLayout)

Method Parameters

menuLayout

- An array of MenuLayouts

getMenuLayoutsAvailable()

An array of available menu layouts. If this parameter is not provided, only the `LIST` layout is assumed to be available

public java.util.List getMenuLayoutsAvailable()

setDynamicUpdateCapabilities( DynamicUpdateCapabilities dynamicUpdateCapabilities )

Sets the dynamicUpdateCapabilities.

public com.smartdevicelink.proxy.rpc.WindowCapability setDynamicUpdateCapabilities(DynamicUpdateCapabilities dynamicUpdateCapabilities)

Method Parameters

dynamicUpdateCapabilities

Contains the head unit's capabilities for dynamic updating features declaring if the module will send dynamic update RPCs.

getDynamicUpdateCapabilities()

Gets the dynamicUpdateCapabilities.

public com.smartdevicelink.proxy.rpc.DynamicUpdateCapabilities getDynamicUpdateCapabilities()

setKeyboardCapabilities( KeyboardCapabilities keyboardCapabilities )

Sets the keyboardCapabilities.

public com.smartdevicelink.proxy.rpc.WindowCapability setKeyboardCapabilities(KeyboardCapabilities keyboardCapabilities)

Method Parameters

keyboardCapabilities

See KeyboardCapabilities

getKeyboardCapabilities()

Gets the keyboardCapabilities.

public com.smartdevicelink.proxy.rpc.KeyboardCapabilities getKeyboardCapabilities()