1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
/*
* Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following
* disclaimer in the documentation and/or other materials provided with the
* distribution.
*
* Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
import com.smartdevicelink.proxy.RPCStruct;
import com.smartdevicelink.proxy.rpc.enums.CharacterSet;
import com.smartdevicelink.proxy.rpc.enums.TextFieldName;
import java.util.Hashtable;
/**
* Struct defining the characteristics of a displayed field on the HMI.
* <p><b> Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
* <th>Type</th>
* <th>Description</th>
* <th>SmartDeviceLink Ver. Available</th>
* </tr>
* <tr>
* <td>name</td>
* <td>TextFieldName</td>
* <td>Enumeration identifying the field. </td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>characterSet</td>
* <td>CharacterSet</td>
* <td>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. </td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>width</td>
* <td>Integer</td>
* <td>The number of characters in one row of this field.
* <ul>
* <li>Minvalue="1"</li>
* <li>maxvalue="500"</li>
* </ul>
* </td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>rows</td>
* <td>Integer</td>
* <td>The number of rows for this text field.
* <ul>
* <li>Minvalue="1"</li>
* <li>maxvalue="3"</li>
* </ul>
* </td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* </table>
*
* @see TextFieldName
* @see Alert
* @see Show
* @see PerformInteraction
* @see ScrollableMessage
* @see PerformAudioPassThru
* @see ShowConstantTbt
* @since SmartDeviceLink 1.0
*/
public class TextField extends RPCStruct {
public static final String KEY_WIDTH = "width";
public static final String KEY_CHARACTER_SET = "characterSet";
public static final String KEY_ROWS = "rows";
public static final String KEY_NAME = "name";
/**
* Constructs a newly allocated TextField object
*/
public TextField() {
}
/**
* Constructs a newly allocated TextField object indicated by the Hashtable parameter
*
* @param hash The Hashtable to use
*/
public TextField(Hashtable<String, Object> hash) {
super(hash);
}
/**
* Constructs a newly allocated TextField object
*
* @param name Enumeration identifying the field.
* @param 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.
* @param width The number of characters in one row of this field.
* @param rows The number of rows for this text field.
*/
public TextField(@NonNull TextFieldName name, @NonNull CharacterSet characterSet, @NonNull Integer width, @NonNull Integer rows) {
this();
setName(name);
setCharacterSet(characterSet);
setWidth(width);
setRows(rows);
}
/**
* Get the enumeration identifying the field.
*
* @return the name of TextField
*/
public TextFieldName getName() {
return (TextFieldName) getObject(TextFieldName.class, KEY_NAME);
}
/**
* Set the enumeration identifying the field.
*
* @param name the name of TextField
*/
public TextField setName(@NonNull TextFieldName name) {
setValue(KEY_NAME, name);
return this;
}
/**
* Get the character set that is supported in this field.
*
* @return 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.
*/
public CharacterSet getCharacterSet() {
return (CharacterSet) getObject(CharacterSet.class, KEY_CHARACTER_SET);
}
/**
* Set the character set that is supported in this field.
*
* @param 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.
*/
public TextField setCharacterSet(@NonNull CharacterSet characterSet) {
setValue(KEY_CHARACTER_SET, characterSet);
return this;
}
/**
* Get the number of characters in one row of this field.
* <ul>
* <li>Minvalue="1"</li>
* <li>maxvalue="500"</li>
* </ul>
*
* @return the number of characters in one row of this field
*/
public Integer getWidth() {
return getInteger(KEY_WIDTH);
}
/**
* Set the number of characters in one row of this field.
* <ul>
* <li>Minvalue="1"</li>
* <li>maxvalue="500"</li>
* </ul>
*
* @param width the number of characters in one row of this field
*/
public TextField setWidth(@NonNull Integer width) {
setValue(KEY_WIDTH, width);
return this;
}
/**
* Get the number of rows for this text field.
* <ul>
* <li>Minvalue="1"</li>
* <li>maxvalue="3"</li>
* </ul>
*
* @return the number of rows for this text field
*/
public Integer getRows() {
return getInteger(KEY_ROWS);
}
public TextField setRows(@NonNull Integer rows) {
setValue(KEY_ROWS, rows);
return this;
}
}
|
