Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
Documentation
TextField

TextField Class Reference

Constructors

Instance Methods

Constructors

new TextField(parameters)

Initalizes an instance of TextField.

Instance Methods

textField.getCharacterSet() ⇒ CharacterSet

Get the CharacterSet

Kind: Instance method of TextField
Returns: CharacterSet - the KEY_CHARACTER_SET value

textField.getNameParam() ⇒ TextFieldName

Get the NameParam

Kind: Instance method of TextField
Returns: TextFieldName - the KEY_NAME value

textField.getRows() ⇒ Number

Get the Rows

Kind: Instance method of TextField
Returns: Number - the KEY_ROWS value

textField.getWidth() ⇒ Number

Get the Width

Kind: Instance method of TextField
Returns: Number - the KEY_WIDTH value

textField.setCharacterSet(set) ⇒ TextField

Set the CharacterSet

Kind: Instance method of TextField
Returns: TextField - The class instance for method chaining.

ParamTypeDescription
set 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. - The desired CharacterSet.

textField.setNameParam(name) ⇒ TextField

Set the NameParam

Kind: Instance method of TextField
Returns: TextField - The class instance for method chaining.

ParamTypeDescription
name TextFieldName The name that identifies the field. See TextFieldName. - The desired NameParam.

textField.setRows(rows) ⇒ TextField

Set the Rows

Kind: Instance method of TextField
Returns: TextField - The class instance for method chaining.

ParamTypeDescription
rows Number The number of rows of this field. - The desired Rows. {'num_min_value': 1, 'num_max_value': 8}

textField.setWidth(width) ⇒ TextField

Set the Width

Kind: Instance method of TextField
Returns: TextField - The class instance for method chaining.

ParamTypeDescription
width Number The number of characters in one row of this field. - The desired Width. {'num_min_value': 1, 'num_max_value': 500}
View on GitHub.com
Previous Section Next Section