com.smartdevicelink.proxy.rpc

Class TextField

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.TextField

All Implemented Interfaces:

Cloneable

public class TextField
extends RPCStruct

Struct defining the characteristics of a displayed field on the HMI.

Parameter List

Name	Type	Description	SmartDeviceLink Ver. Available
name	TextFieldName	Enumeration identifying the field.	SmartDeviceLink 1.0
characterSet	CharacterSet	The set of characters that are supported by this text field. All text is sent in UTF-8 format, but not all systems may support all of the characters expressed by UTF-8. All systems will support at least ASCII, but they may support more, either the LATIN-1 character set, or the full UTF-8 character set.	SmartDeviceLink 1.0
width	Integer	The number of characters in one row of this field. Minvalue="1" maxvalue="500"	SmartDeviceLink 1.0
rows	Integer	The number of rows for this text field. Minvalue="1" maxvalue="3"	SmartDeviceLink 1.0

Since:

SmartDeviceLink 1.0

See Also:

TextFieldName, Alert, Show, PerformInteraction, ScrollableMessage, PerformAudioPassThru, ShowConstantTbt

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_CHARACTER_SET
static String	KEY_NAME
static String	KEY_ROWS
static String	KEY_WIDTH

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
TextField() Constructs a newly allocated TextField object
TextField(Hashtable<String,Object> hash) Constructs a newly allocated TextField object indicated by the Hashtable parameter
TextField(TextFieldName name, CharacterSet characterSet, Integer width, Integer rows) Constructs a newly allocated TextField object

Method Summary

Modifier and Type	Method and Description
CharacterSet	getCharacterSet() Get the character set that is supported in this field.
TextFieldName	getName() Get the enumeration identifying the field.
Integer	getRows() Get the number of rows for this text field.
Integer	getWidth() Get the number of characters in one row of this field.
TextField	setCharacterSet(CharacterSet characterSet) Set the character set that is supported in this field.
TextField	setName(TextFieldName name) Set the enumeration identifying the field.
TextField	setRows(Integer rows)
TextField	setWidth(Integer width) Set the number of characters in one row of this field.

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_WIDTH

public static final String KEY_WIDTH

See Also:

Constant Field Values

KEY_CHARACTER_SET

public static final String KEY_CHARACTER_SET

See Also:

Constant Field Values

KEY_ROWS

public static final String KEY_ROWS

See Also:

Constant Field Values

KEY_NAME

public static final String KEY_NAME

See Also:

Constant Field Values

Constructor Detail

TextField

public TextField()

Constructs a newly allocated TextField object

TextField

public TextField(Hashtable<String,Object> hash)

Constructs a newly allocated TextField object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

TextField

public TextField(@NonNull
                 TextFieldName name,
                 @NonNull
                 CharacterSet characterSet,
                 @NonNull
                 Integer width,
                 @NonNull
                 Integer rows)

Constructs a newly allocated TextField object

Parameters:

name - Enumeration identifying the field.

characterSet - The set of characters that are supported by this text field. All text is sent in UTF-8 format, but not all systems may support all of the characters expressed by UTF-8. All systems will support at least ASCII, but they may support more, either the LATIN-1 character set, or the full UTF-8 character set.

width - The number of characters in one row of this field.

rows - The number of rows for this text field.

Method Detail

getName

public TextFieldName getName()

Get the enumeration identifying the field.

Returns:

the name of TextField

setName

public TextField setName(@NonNull
                         TextFieldName name)

Set the enumeration identifying the field.

Parameters:

name - the name of TextField

getCharacterSet

public CharacterSet getCharacterSet()

Get the character set that is supported in this field.

Returns:

The set of characters that are supported by this text field. All text is sent in UTF-8 format, but not all systems may support all of the characters expressed by UTF-8. All systems will support at least ASCII, but they may support more, either the LATIN-1 character set, or the full UTF-8 character set.

setCharacterSet

public TextField setCharacterSet(@NonNull
                                 CharacterSet characterSet)

Set the character set that is supported in this field.

Parameters:

characterSet - - The set of characters that are supported by this text field. All text is sent in UTF-8 format, but not all systems may support all of the characters expressed by UTF-8. All systems will support at least ASCII, but they may support more, either the LATIN-1 character set, or the full UTF-8 character set.

getWidth

public Integer getWidth()

Get the number of characters in one row of this field.

• Minvalue="1"
• maxvalue="500"

Returns:

the number of characters in one row of this field

setWidth

public TextField setWidth(@NonNull
                          Integer width)

Set the number of characters in one row of this field.

• Minvalue="1"
• maxvalue="500"

Parameters:

width - the number of characters in one row of this field

getRows

public Integer getRows()

Get the number of rows for this text field.

• Minvalue="1"
• maxvalue="3"

Returns:

the number of rows for this text field

setRows

public TextField setRows(@NonNull
                         Integer rows)