blob: 68020812bc086c248b8ec331017a3b752f9944fb (
plain)
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
|
package com.smartdevicelink.proxy.rpc;
import java.util.Hashtable;
import com.smartdevicelink.proxy.RPCStruct;
import com.smartdevicelink.proxy.constants.Names;
import com.smartdevicelink.proxy.rpc.enums.CharacterSet;
import com.smartdevicelink.proxy.rpc.enums.TextFieldName;
import com.smartdevicelink.util.DebugTool;
/**
* Struct defining the characteristics of a displayed field on the HMI.
* <p><b> Parameter List
* <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 character set that is supported in this field. </td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>width</td>
* <td>Int16</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>Int16</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>
* @since SmartDeviceLink 1.0
*/
public class TextField extends RPCStruct {
/**
* 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 hash) {
super(hash);
}
/**
* Get the enumeration identifying the field.
* @return the name of TextField
*/
public TextFieldName getName() {
Object obj = store.get(Names.name);
if (obj instanceof TextFieldName) {
return (TextFieldName) obj;
} else if (obj instanceof String) {
TextFieldName theCode = null;
try {
theCode = TextFieldName.valueForString((String) obj);
} catch (Exception e) {
DebugTool.logError("Failed to parse " + getClass().getSimpleName() + "." + Names.name, e);
}
return theCode;
}
return null;
}
/**
* Set the enumeration identifying the field.
* @param name the name of TextField
*/
public void setName( TextFieldName name ) {
if (name != null) {
store.put(Names.name, name );
}
}
/**
* Get the character set that is supported in this field.
* @return the character set
*/
public CharacterSet getCharacterSet() {
Object obj = store.get(Names.characterSet);
if (obj instanceof CharacterSet) {
return (CharacterSet) obj;
} else if (obj instanceof String) {
CharacterSet theCode = null;
try {
theCode = CharacterSet.valueForString((String) obj);
} catch (Exception e) {
DebugTool.logError("Failed to parse " + getClass().getSimpleName() + "." + Names.characterSet, e);
}
return theCode;
}
return null;
}
/**
* Set the character set that is supported in this field.
* @param characterSet - the character set
*/
public void setCharacterSet( CharacterSet characterSet ) {
if (characterSet != null) {
store.put(Names.characterSet, characterSet );
}
}
/**
* 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 (Integer) store.get( Names.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 void setWidth( Integer width ) {
if (width != null) {
store.put(Names.width, width );
}
}
/**
*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 (Integer) store.get( Names.rows );
}
public void setRows( Integer rows ) {
if (rows != null) {
store.put(Names.rows, rows );
}
}
}
|
