Class TextField
Hierarchy
java.lang.Object
com.smartdevicelink.proxy.RPCStruct
- Package
- com.smartdevicelink.proxy.rpc
Overview
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.
|
SmartDeviceLink 1.0 |
| rows | Integer | The number of rows for this text field.
|
SmartDeviceLink 1.0 |
Quick Jump
- Fields
- Constructors
- Methods
Fields
KEY_WIDTH
public static final java.lang.String KEY_WIDTH
- Constant Value
- "width"
KEY_CHARACTER_SET
public static final java.lang.String KEY_CHARACTER_SET
- Constant Value
- "characterSet"
KEY_ROWS
public static final java.lang.String KEY_ROWS
- Constant Value
- "rows"
KEY_NAME
public static final java.lang.String KEY_NAME
- Constant Value
- "name"
Inherited Fields
| From Class | Fields |
|---|---|
| com.smartdevicelink.proxy.RPCStruct | KEY_BULK_DATA, KEY_PROTECTED, store |
Constructors
TextField()
Constructs a newly allocated TextField object
public TextField()
TextField( java.util.Hashtable<java.lang.String, java.lang.Object> hash )
Constructs a newly allocated TextField object indicated by the Hashtable parameter
public TextField(java.util.Hashtable<java.lang.String, java.lang.Object> hash)
Constructor Parameters
- hash
- The Hashtable to use
TextField( TextFieldName name, CharacterSet characterSet, Integer width, Integer rows )
Constructs a newly allocated TextField object
public TextField(TextFieldName name,CharacterSet characterSet,Integer width,Integer rows)
Constructor 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.
Methods
getName()
Get the enumeration identifying the field.
public com.smartdevicelink.proxy.rpc.enums.TextFieldName getName()
setName( TextFieldName name )
Set the enumeration identifying the field.
public com.smartdevicelink.proxy.rpc.TextField setName(TextFieldName name)
Method Parameters
- name
- the name of TextField
getCharacterSet()
Get the character set that is supported in this field.
public com.smartdevicelink.proxy.rpc.enums.CharacterSet getCharacterSet()
setCharacterSet( CharacterSet characterSet )
Set the character set that is supported in this field.
public com.smartdevicelink.proxy.rpc.TextField setCharacterSet(CharacterSet characterSet)
Method 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()
Get the number of characters in one row of this field.
- Minvalue="1"
- maxvalue="500"
public java.lang.Integer getWidth()
setWidth( Integer width )
Set the number of characters in one row of this field.
- Minvalue="1"
- maxvalue="500"
public com.smartdevicelink.proxy.rpc.TextField setWidth(Integer width)
Method Parameters
- width
- the number of characters in one row of this field
getRows()
Get the number of rows for this text field.
- Minvalue="1"
- maxvalue="3"
public java.lang.Integer getRows()
setRows( Integer rows )
public com.smartdevicelink.proxy.rpc.TextField setRows(Integer rows)
Method Parameters
- rows
Inherited Methods
| From Class | Methods |
|---|---|
| com.smartdevicelink.proxy.RPCStruct | getStoreValue, getStore, deserializeJSON, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong, clone, equals, hashCode |
| java.lang.Object | getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize |