summaryrefslogtreecommitdiff
path: root/base/src/main/java/com/smartdevicelink/proxy/rpc/enums/TextFieldName.java
blob: cf33b73e04cd4bca46c20e5e473e844fc9c21660 (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
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
/*
 * 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.enums;
/** Names of the text fields that can appear on the display. 
 * 
 * @since SmartDeviceLink 1.0
 *
 */

public enum TextFieldName {
	/** The first line of first set of main fields of the persistent display; applies to "Show"
	 * 
	 */

    mainField1,
	/** The second line of first set of main fields of the persistent display; applies to "Show"
     * 
     */

    mainField2,
    /** The first line of second set of main fields of persistent display; applies to "Show"
     * 
     */

    mainField3,
    /** The second line of second set of main fields of the persistent display; applies to "Show"
     * 
     */

    mainField4,
    /** The status bar on NGN; applies to "Show"
     * 
     */

    statusBar,
    /** Text value for MediaClock field; applies to "Show"
     * 
     */

    mediaClock,
    /** The track field of NGN and GEN1.1 MFD displays. This field is only available for media applications; applies to "Show"
     * 
     */

    mediaTrack,
    /** The first line of the alert text field; applies to "Alert"
     * 
     */

    alertText1,
    /** The second line of the alert text field; applies to "Alert"
     * 
     */

    alertText2,
    /** The third line of the alert text field; applies to "Alert"
     * 
     */

    alertText3,
    /** Long form body of text that can include newlines and tabs; applies to "ScrollableMessage"
     * 
     */

    scrollableMessageBody,
    /** First line suggestion for a user response (in the case of VR enabled interaction)
     * 
     */

    initialInteractionText,
    /**  First line of navigation text
     * 
     */

    navigationText1,
    /** Second line of navigation text
     * 
     */

    navigationText2,
    /** Estimated Time of Arrival time for navigation
     * 
     */

    ETA,
    /** Total distance to destination for navigation
     * 
     */

    totalDistance,
    /** First line of text for audio pass thru
     * 
     */

    audioPassThruDisplayText1,
    /** Second line of text for audio pass thru
     * 
     */

    audioPassThruDisplayText2,
    /** Header text for slider
     * 
     */

    sliderHeader,
    /** Footer text for slider
     * 
     */

    sliderFooter,
    /** Primary text for Choice
     * 
     */

    menuName,
    /** Secondary text for Choice
     * 
     */

    secondaryText,
    /** Tertiary text for Choice
     * 
     */

    tertiaryText,
	/** Optional text to label an app menu button (for certain touchscreen platforms).
	 * 
	 */
    menuTitle,
    /**
     * Optional name / title of intended location for SendLocation.
     * 
     * @since SmartDeviceLink 4.0
     */
    locationName,
    /**
     * Optional description of intended location / establishment (if applicable) for SendLocation
     * 
     * @since SmartDeviceLink 4.0
     */
    locationDescription,
    /**
     * Optional location address (if applicable) for SendLocation.
     * 
     * @since SmartDeviceLink 4.0
     */
    addressLines,
    /**
     * Optional phone number of intended location / establishment (if applicable) for SendLocation.
     * 
     * @since SmartDeviceLink 4.0
     */
    phoneNumber,
    /**
     * Optional title of the template that will be displayed
     *
     * @since SmartDeviceLink 6.0
     */
    templateTitle,
    /**
     * The first line of the subtle alert text field; applies to `SubtleAlert` `alertText1`
     *
     * @since SmartDeviceLink 7.0.0
     */
    subtleAlertText1,
    /**
     * The second line of the subtle alert text field; applies to `SubtleAlert` `alertText2`
     *
     * @since SmartDeviceLink 7.0.0
     */
    subtleAlertText2,
    /**
     * A text field in the soft button of a subtle alert; applies to `SubtleAlert` `softButtons`
     *
     * @since SmartDeviceLink 7.0.0
     */
    subtleAlertSoftButtonText;
    ;
	  /**
       * Convert String to TextFieldName
       * @param value String
       * @return TextFieldName
       */

    public static TextFieldName valueForString(String value) {
        try{
            return valueOf(value);
        }catch(Exception e){
            return null;
        }
    }
}