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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
|
/*
* 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.DisplayType;
import com.smartdevicelink.proxy.rpc.enums.MediaClockFormat;
import com.smartdevicelink.util.Version;
import java.util.Hashtable;
import java.util.List;
/**
* Contains information about the display for the SDL system to which the application is currently connected.
* <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>@Deprecated <s>displayType</s></td>
* <td><s>DisplayType</s></td>
* <td><s>The type of display</s>
* </td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>displayName</td>
* <td>String</td>
* <td>The name of the display
* </td>
* <td>SmartDeviceLink 5.0</td>
* </tr>
* <tr>
* <td>textField</td>
* <td>TextField[]</td>
* <td>An array of TextField structures, each of which describes a field in the HMI which the application can write to using operations such as <i>{@linkplain Show}</i>, <i>{@linkplain SetMediaClockTimer}</i>, etc.
* This array of TextField structures identify all the text fields to which the application can write on the current display (identified by DisplayType ).
* </td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>mediaClockFormats</td>
* <td>MediaClockFormat[]</td>
* <td>An array of MediaClockFormat elements, defining the valid string formats used in specifying the contents of the media clock field</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>graphicSupported</td>
* <td>Boolean</td>
* <td>The display's persistent screen supports referencing a static or dynamic image.</td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* </table>
* @since SmartDeviceLink 1.0
* @see DisplayType
* @see MediaClockFormat
* @see TextField
* @see ImageField
*
*/
public class DisplayCapabilities extends RPCStruct {
public static final String KEY_DISPLAY_TYPE = "displayType";
public static final String KEY_DISPLAY_NAME = "displayName";
public static final String KEY_MEDIA_CLOCK_FORMATS = "mediaClockFormats";
public static final String KEY_TEXT_FIELDS = "textFields";
public static final String KEY_IMAGE_FIELDS = "imageFields";
public static final String KEY_GRAPHIC_SUPPORTED = "graphicSupported";
public static final String KEY_SCREEN_PARAMS = "screenParams";
public static final String KEY_TEMPLATES_AVAILABLE = "templatesAvailable";
public static final String KEY_NUM_CUSTOM_PRESETS_AVAILABLE = "numCustomPresetsAvailable";
/**
* Constructs a newly allocated DisplayCapabilities object
*/
public DisplayCapabilities() { }
/**
* Constructs a newly allocated DisplayCapabilities object indicated by the Hashtable parameter
* @param hash The Hashtable to use
*/
public DisplayCapabilities(Hashtable<String, Object> hash) {
super(hash);
}
/**
* Constructs a newly allocated DisplayCapabilities object
* @param displayType the display type
* @param textFields the List of textFields
* @param mediaClockFormats the List of MediaClockFormat
* @param graphicSupported true if the display supports graphics, false if it does not
*/
@Deprecated
public DisplayCapabilities(@NonNull DisplayType displayType, @NonNull List<TextField> textFields, @NonNull List<MediaClockFormat> mediaClockFormats, @NonNull Boolean graphicSupported) {
this();
setDisplayType(displayType);
setTextFields(textFields);
setMediaClockFormats(mediaClockFormats);
setGraphicSupported(graphicSupported);
}
/**
* Constructs a newly allocated DisplayCapabilities object
* @param displayName the display name (String)
* @param textFields the List of textFields
* @param mediaClockFormats the List of MediaClockFormat
* @param graphicSupported true if the display supports graphics, false if it does not
*/
public DisplayCapabilities(String displayName, @NonNull List<TextField> textFields, @NonNull List<MediaClockFormat> mediaClockFormats, @NonNull Boolean graphicSupported) {
this();
setDisplayName(displayName);
setTextFields(textFields);
setMediaClockFormats(mediaClockFormats);
setGraphicSupported(graphicSupported);
}
@Override
public void format(Version rpcVersion, boolean formatParams) {
super.format(rpcVersion, formatParams);
if(!store.containsKey(KEY_GRAPHIC_SUPPORTED)){
// At some point this was added to the RPC spec as mandatory but at least in v1.0.0
// it was not included.
store.put(KEY_GRAPHIC_SUPPORTED, Boolean.FALSE);
}
}
/**
* Get the type of display
* @return the type of display
*/
@Deprecated
public DisplayType getDisplayType() {
return (DisplayType) getObject(DisplayType.class, KEY_DISPLAY_TYPE);
}
/**
* Set the type of display
* @param displayType the display type
*/
@Deprecated
public void setDisplayType( @NonNull DisplayType displayType ) {
setValue(KEY_DISPLAY_TYPE, displayType);
}
/** Get the name of the display
* @return the name of the display
*/
public String getDisplayName() {
return getString(KEY_DISPLAY_NAME);
}
/**
* Set the name of the display
* @param displayName the name of the display
*/
public void setDisplayName( String displayName ) {
setValue(KEY_DISPLAY_NAME, displayName);
}
/**
*Get an array of TextField structures, each of which describes a field in the HMI which the application can write to using operations such as <i>{@linkplain Show}</i>, <i>{@linkplain SetMediaClockTimer}</i>, etc.
* This array of TextField structures identify all the text fields to which the application can write on the current display (identified by DisplayType ).
* @return the List of textFields
*/
@SuppressWarnings("unchecked")
public List<TextField> getTextFields() {
return (List<TextField>) getObject(TextField.class, KEY_TEXT_FIELDS);
}
/**
* Set an array of TextField structures, each of which describes a field in the HMI which the application can write to using operations such as <i>{@linkplain Show}</i>, <i>{@linkplain SetMediaClockTimer}</i>, etc.
* This array of TextField structures identify all the text fields to which the application can write on the current display (identified by DisplayType ).
* @param textFields the List of textFields
*/
public void setTextFields( @NonNull List<TextField> textFields ) {
setValue(KEY_TEXT_FIELDS, textFields);
}
@SuppressWarnings("unchecked")
public List<ImageField> getImageFields() {
return (List<ImageField>) getObject(ImageField.class, KEY_IMAGE_FIELDS);
}
public void setImageFields( List<ImageField> imageFields ) {
setValue(KEY_IMAGE_FIELDS, imageFields);
}
public Integer getNumCustomPresetsAvailable() {
return getInteger(KEY_NUM_CUSTOM_PRESETS_AVAILABLE);
}
public void setNumCustomPresetsAvailable(Integer numCustomPresetsAvailable) {
setValue(KEY_NUM_CUSTOM_PRESETS_AVAILABLE, numCustomPresetsAvailable);
}
/**
* Get an array of MediaClockFormat elements, defining the valid string formats used in specifying the contents of the media clock field
* @return the Veotor of mediaClockFormat
*/
@SuppressWarnings("unchecked")
public List<MediaClockFormat> getMediaClockFormats() {
return (List<MediaClockFormat>) getObject(MediaClockFormat.class, KEY_MEDIA_CLOCK_FORMATS);
}
/**
* Set an array of MediaClockFormat elements, defining the valid string formats used in specifying the contents of the media clock field
* @param mediaClockFormats the List of MediaClockFormat
*/
public void setMediaClockFormats( @NonNull List<MediaClockFormat> mediaClockFormats ) {
setValue(KEY_MEDIA_CLOCK_FORMATS, mediaClockFormats);
}
/**
* set the display's persistent screen supports.
* @param graphicSupported true if the display supports graphics, false if it does not
* @since SmartDeviceLink 2.0
*/
public void setGraphicSupported(@NonNull Boolean graphicSupported) {
setValue(KEY_GRAPHIC_SUPPORTED, graphicSupported);
}
/**
* Get the display's persistent screen supports.
* @return true if the display supports graphics, false if it does not
* @since SmartDeviceLink 2.0
*/
public Boolean getGraphicSupported() {
return getBoolean(KEY_GRAPHIC_SUPPORTED);
}
@SuppressWarnings("unchecked")
public List<String> getTemplatesAvailable() {
return (List<String>) getObject(String.class, KEY_TEMPLATES_AVAILABLE);
}
public void setTemplatesAvailable(List<String> templatesAvailable) {
setValue(KEY_TEMPLATES_AVAILABLE, templatesAvailable);
}
public void setScreenParams(ScreenParams screenParams) {
setValue(KEY_SCREEN_PARAMS, screenParams);
}
@SuppressWarnings("unchecked")
public ScreenParams getScreenParams() {
return (ScreenParams) getObject(ScreenParams.class, KEY_SCREEN_PARAMS);
}
}
|
