com.smartdevicelink.proxy.rpc

Class SetDisplayLayout

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCRequest

com.smartdevicelink.proxy.rpc.SetDisplayLayout

All Implemented Interfaces:

Cloneable

Deprecated.

in SmartDeviceLink 6.0

@Deprecated
public class SetDisplayLayout
extends RPCRequest

If using Widgets with Core > 6.0, use Show to change widget layouts
Used to set an alternate display layout. If not sent, default screen for given platform will be shown

Parameter List

Param Name	Type	Description	Req.	Notes	Version Available
displayLayout	string	Predefined or dynamically created screen layout. Currently only predefined screen layouts are defined. Predefined layouts include: "ONSCREEN_PRESETS" Custom screen containing app-defined onscreen presets.	Y	maxlength: 500	SmartDeviceLink 2.0
dayColorScheme	TemplateColorScheme	The color scheme that is used for day.	N		SmartDeviceLink 5.0
nightColorScheme	TemplateColorScheme	The color scheme that is used for night.	N		SmartDeviceLink 5.0

Response

Non-default Result Codes:

SUCCESS

INVALID_DATA

OUT_OF_MEMORY

TOO_MANY_PENDING_REQUESTS

APPLICATION_NOT_REGISTERED

GENERIC_ERROR

REJECTED

Since:

SmartDeviceLink 2.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_DAY_COLOR_SCHEME Deprecated.
static String	KEY_DISPLAY_LAYOUT Deprecated.
static String	KEY_NIGHT_COLOR_SCHEME Deprecated.

Fields inherited from class com.smartdevicelink.proxy.RPCRequest

onResponseListener

Fields inherited from class com.smartdevicelink.proxy.RPCMessage

function, KEY_CORRELATION_ID, KEY_FUNCTION_NAME, KEY_NOTIFICATION, KEY_PARAMETERS, KEY_REQUEST, KEY_RESPONSE, messageType, parameters

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
SetDisplayLayout() Deprecated. Constructs a new SetDisplayLayout object
SetDisplayLayout(Hashtable<String,Object> hash) Deprecated. Constructs a new SetDisplayLayout object indicated by the Hashtable parameter
SetDisplayLayout(String displayLayout) Deprecated. Constructs a new SetDisplayLayout object

Method Summary

Modifier and Type	Method and Description
TemplateColorScheme	getDayColorScheme() Deprecated. Gets the color scheme that is currently used for day
String	getDisplayLayout() Deprecated. Gets a display layout.
TemplateColorScheme	getNightColorScheme() Deprecated. Gets the color scheme that is currently used for night
SetDisplayLayout	setDayColorScheme(TemplateColorScheme templateColorScheme) Deprecated. Sets the color scheme that is intended to be used for day
SetDisplayLayout	setDisplayLayout(String displayLayout) Deprecated. Sets a display layout.
SetDisplayLayout	setNightColorScheme(TemplateColorScheme templateColorScheme) Deprecated. Sets the color scheme that is intended to be used for night

Methods inherited from class com.smartdevicelink.proxy.RPCRequest

getCorrelationID, getOnRPCResponseListener, setCorrelationID, setOnRPCResponseListener

Methods inherited from class com.smartdevicelink.proxy.RPCMessage

getBoolean, getDouble, getFloat, getFunctionID, getFunctionName, getInteger, getLong, getMessageType, getObject, getParameters, getString, setFunctionName, setParameters

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBulkData, getMessageTypeName, getStore, getStoreValue, 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_LAYOUT

public static final String KEY_DISPLAY_LAYOUT

Deprecated.

See Also:

Constant Field Values

KEY_DAY_COLOR_SCHEME

public static final String KEY_DAY_COLOR_SCHEME

Deprecated.

See Also:

Constant Field Values

KEY_NIGHT_COLOR_SCHEME

public static final String KEY_NIGHT_COLOR_SCHEME

Deprecated.

See Also:

Constant Field Values

Constructor Detail

SetDisplayLayout

public SetDisplayLayout()

Deprecated.

Constructs a new SetDisplayLayout object

SetDisplayLayout

public SetDisplayLayout(Hashtable<String,Object> hash)

Deprecated.

Constructs a new SetDisplayLayout object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

SetDisplayLayout

public SetDisplayLayout(@NonNull
                        String displayLayout)

Deprecated.

Constructs a new SetDisplayLayout object

Parameters:

displayLayout - a String value representing a display layout

Method Detail

setDisplayLayout

public SetDisplayLayout setDisplayLayout(@NonNull
                                         String displayLayout)

Deprecated.

Sets a display layout. Predefined or dynamically created screen layout. Currently only predefined screen layouts are defined. Predefined layouts include: "ONSCREEN_PRESETS" Custom screen containing app-defined onscreen presets. Currently defined for GEN2

Parameters:

displayLayout - a String value representing a display layout

getDisplayLayout

public String getDisplayLayout()

Deprecated.

Gets a display layout.

getDayColorScheme

public TemplateColorScheme getDayColorScheme()

Deprecated.

Gets the color scheme that is currently used for day

Returns:

TemplateColorScheme - a TemplateColorScheme object representing the colors that are used for day color scheme

Since:

SmartDeviceLink 5.0

setDayColorScheme

public SetDisplayLayout setDayColorScheme(TemplateColorScheme templateColorScheme)

Deprecated.

Sets the color scheme that is intended to be used for day

Parameters:

templateColorScheme - a TemplateColorScheme object representing the colors that will be used for day color scheme

Since:

SmartDeviceLink 5.0

getNightColorScheme

public TemplateColorScheme getNightColorScheme()

Deprecated.

Gets the color scheme that is currently used for night

Returns:

TemplateColorScheme - a TemplateColorScheme object representing the colors that are used for night color scheme

Since:

SmartDeviceLink 5.0

setNightColorScheme

public SetDisplayLayout setNightColorScheme(TemplateColorScheme templateColorScheme)

Deprecated.

Sets the color scheme that is intended to be used for night

Parameters:

templateColorScheme - a TemplateColorScheme object representing the colors that will be used for night color scheme

Since:

SmartDeviceLink 5.0