com.smartdevicelink.proxy.rpc

Class TemplateConfiguration

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.TemplateConfiguration

All Implemented Interfaces:

Cloneable

public class TemplateConfiguration
extends RPCStruct

Used to set an alternate template layout to a window.

Since:

6.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_DAY_COLOR_SCHEME
static String	KEY_NIGHT_COLOR_SCHEME
static String	KEY_TEMPLATE

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
TemplateConfiguration() Constructs a new TemplateConfiguration object
TemplateConfiguration(Hashtable<String,Object> hash) Constructs a new TemplateConfiguration object indicated by the Hashtable parameter
TemplateConfiguration(String template) Constructs a new TemplateConfiguration object

Method Summary

Modifier and Type	Method and Description
TemplateColorScheme	getDayColorScheme() Gets the dayColorScheme.
TemplateColorScheme	getNightColorScheme() Gets the nightColorScheme.
String	getTemplate() Gets the template.
TemplateConfiguration	setDayColorScheme(TemplateColorScheme dayColorScheme) Sets the dayColorScheme.
TemplateConfiguration	setNightColorScheme(TemplateColorScheme nightColorScheme) Sets the nightColorScheme.
TemplateConfiguration	setTemplate(String template) Sets the template.

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_TEMPLATE

public static final String KEY_TEMPLATE

See Also:

Constant Field Values

KEY_DAY_COLOR_SCHEME

public static final String KEY_DAY_COLOR_SCHEME

See Also:

Constant Field Values

KEY_NIGHT_COLOR_SCHEME

public static final String KEY_NIGHT_COLOR_SCHEME

See Also:

Constant Field Values

Constructor Detail

TemplateConfiguration

public TemplateConfiguration(@NonNull
                             String template)

Constructs a new TemplateConfiguration object

Parameters:

template - Predefined or dynamically created window template. Currently only predefined window template layouts are defined.

TemplateConfiguration

public TemplateConfiguration(Hashtable<String,Object> hash)

Constructs a new TemplateConfiguration object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

TemplateConfiguration

public TemplateConfiguration()

Constructs a new TemplateConfiguration object

Method Detail

getTemplate

public String getTemplate()

Gets the template.

Returns:

String -an Predefined or dynamically created window template. Currently only predefined window template layouts are defined.

setTemplate

public TemplateConfiguration setTemplate(@NonNull
                                         String template)

Sets the template. It can be Predefined or dynamically created window template. Currently only predefined window template layouts are defined.

Parameters:

template - Predefined or dynamically created window template. Currently only predefined window template layouts are defined.

getDayColorScheme

public TemplateColorScheme getDayColorScheme()

Gets the dayColorScheme.

Returns:

TemplateColorScheme

setDayColorScheme

public TemplateConfiguration setDayColorScheme(TemplateColorScheme dayColorScheme)

Sets the dayColorScheme.

Parameters:

dayColorScheme - TemplateColorScheme for the day

getNightColorScheme

public TemplateColorScheme getNightColorScheme()

Gets the nightColorScheme.

Returns:

TemplateColorScheme

setNightColorScheme

public TemplateConfiguration setNightColorScheme(TemplateColorScheme nightColorScheme)

Sets the nightColorScheme.

Parameters:

nightColorScheme - TemplateColorScheme for the night