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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
|
/*
* Copyright (C) 2014 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.inputmethod.keyboard;
import android.text.InputType;
import android.view.inputmethod.EditorInfo;
import android.view.inputmethod.InputMethodSubtype;
import com.android.inputmethod.keyboard.internal.KeyboardIconsSet;
import com.android.inputmethod.keyboard.internal.MoreKeySpec;
import com.android.inputmethod.latin.Constants;
import com.android.inputmethod.latin.R;
import com.android.inputmethod.latin.RichInputMethodManager;
import com.android.inputmethod.latin.utils.SubtypeLocaleUtils;
import java.util.Arrays;
import java.util.Locale;
abstract class KeyboardLayoutSetNavigateMoreKeysBase extends KeyboardLayoutSetTestsBase {
private ExpectedMoreKey mExpectedNavigateNextMoreKey;
private ExpectedMoreKey mExpectedNavigatePreviousMoreKey;
private ExpectedMoreKey mExpectedEmojiMoreKey;
protected ExpectedMoreKey getExpectedNavigateNextMoreKey() {
return new ExpectedMoreKey(R.string.label_next_key);
}
protected ExpectedMoreKey getExpectedNavigatePreviousMoreKey() {
return new ExpectedMoreKey(R.string.label_previous_key);
}
protected ExpectedMoreKey getExpectedEmojiMoreKey() {
return new ExpectedMoreKey(KeyboardIconsSet.NAME_EMOJI_ACTION_KEY);
}
@Override
protected void setUp() throws Exception {
super.setUp();
mExpectedNavigateNextMoreKey = getExpectedNavigateNextMoreKey();
mExpectedNavigatePreviousMoreKey = getExpectedNavigatePreviousMoreKey();
mExpectedEmojiMoreKey = getExpectedEmojiMoreKey();
}
/**
* This class represents an expected more key.
*/
protected static class ExpectedMoreKey {
public static final int NO_LABEL = 0;
public static final ExpectedMoreKey[] EMPTY_MORE_KEYS = new ExpectedMoreKey[0];
public final int mLabelResId;
public final int mIconId;
public ExpectedMoreKey(final String iconName) {
mLabelResId = NO_LABEL;
mIconId = KeyboardIconsSet.getIconId(iconName);
}
public ExpectedMoreKey(final int labelResId) {
mLabelResId = labelResId;
mIconId = KeyboardIconsSet.ICON_UNDEFINED;
}
}
private void doTestMoreKeysOf(final int code, final InputMethodSubtype subtype,
final int elementId, final int inputType, final int imeOptions,
final ExpectedMoreKey ... expectedMoreKeys) {
final EditorInfo editorInfo = new EditorInfo();
editorInfo.inputType = inputType;
editorInfo.imeOptions = imeOptions;
final KeyboardLayoutSet layoutSet = createKeyboardLayoutSet(subtype, editorInfo);
final Keyboard keyboard = layoutSet.getKeyboard(elementId);
final Key actualKey = keyboard.getKey(code);
final MoreKeySpec[] actualMoreKeys = actualKey.getMoreKeys();
final String tag = actualKey.toString() + " moreKeys=" + Arrays.toString(actualMoreKeys);
if (expectedMoreKeys.length == 0) {
assertEquals(tag, null, actualMoreKeys);
return;
}
if (expectedMoreKeys.length == 1) {
assertEquals(tag + " fixedOrder", false, actualKey.isMoreKeysFixedOrder());
assertEquals(tag + " fixedColumn", false, actualKey.isMoreKeysFixedColumn());
} else {
assertEquals(tag + " fixedOrder", true, actualKey.isMoreKeysFixedOrder());
assertEquals(tag + " fixedColumn", true, actualKey.isMoreKeysFixedColumn());
// TODO: Can't handle multiple rows of more keys.
assertEquals(tag + " column",
expectedMoreKeys.length, actualKey.getMoreKeysColumnNumber());
}
assertNotNull(tag + " moreKeys", actualMoreKeys);
assertEquals(tag, expectedMoreKeys.length, actualMoreKeys.length);
for (int index = 0; index < actualMoreKeys.length; index++) {
final int expectedLabelResId = expectedMoreKeys[index].mLabelResId;
if (expectedLabelResId == ExpectedMoreKey.NO_LABEL) {
assertEquals(tag + " label " + index, null, actualMoreKeys[index].mLabel);
} else {
final CharSequence expectedLabel = getContext().getText(expectedLabelResId);
assertEquals(tag + " label " + index, expectedLabel, actualMoreKeys[index].mLabel);
}
final int expectedIconId = expectedMoreKeys[index].mIconId;
assertEquals(tag + " icon " + index, expectedIconId, actualMoreKeys[index].mIconId);
}
}
private void doTestNavigationMoreKeysOf(final int code, final InputMethodSubtype subtype,
final int elementId, final int inputType) {
// No navigate flag.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_NULL,
ExpectedMoreKey.EMPTY_MORE_KEYS);
// With next navigate flag.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_FLAG_NAVIGATE_NEXT,
mExpectedNavigateNextMoreKey);
// With previous navigate flag.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_FLAG_NAVIGATE_PREVIOUS,
mExpectedNavigatePreviousMoreKey);
// With next and previous naviagte flags.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_FLAG_NAVIGATE_NEXT | EditorInfo.IME_FLAG_NAVIGATE_PREVIOUS,
mExpectedNavigatePreviousMoreKey, mExpectedNavigateNextMoreKey);
// Action next.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_ACTION_NEXT,
ExpectedMoreKey.EMPTY_MORE_KEYS);
// Action next with next navigate flag.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_ACTION_NEXT | EditorInfo.IME_FLAG_NAVIGATE_NEXT,
ExpectedMoreKey.EMPTY_MORE_KEYS);
// Action next with previous navigate flag.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_ACTION_NEXT | EditorInfo.IME_FLAG_NAVIGATE_PREVIOUS,
mExpectedNavigatePreviousMoreKey);
// Action next with next and previous navigate flags.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_ACTION_NEXT | EditorInfo.IME_FLAG_NAVIGATE_NEXT
| EditorInfo.IME_FLAG_NAVIGATE_PREVIOUS,
mExpectedNavigatePreviousMoreKey);
// Action previous.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_ACTION_PREVIOUS,
ExpectedMoreKey.EMPTY_MORE_KEYS);
// Action previous with next navigate flag.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_ACTION_PREVIOUS | EditorInfo.IME_FLAG_NAVIGATE_NEXT,
mExpectedNavigateNextMoreKey);
// Action previous with previous navigate flag.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_ACTION_PREVIOUS | EditorInfo.IME_FLAG_NAVIGATE_PREVIOUS,
ExpectedMoreKey.EMPTY_MORE_KEYS);
// Action previous with next and previous navigate flags.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_ACTION_PREVIOUS | EditorInfo.IME_FLAG_NAVIGATE_NEXT
| EditorInfo.IME_FLAG_NAVIGATE_PREVIOUS,
mExpectedNavigateNextMoreKey);
}
private void doTestNavigationWithEmojiMoreKeysOf(final int code,
final InputMethodSubtype subtype, final int elementId, final int inputType) {
// No navigate flag.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_NULL,
mExpectedEmojiMoreKey);
// With next navigate flag.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_FLAG_NAVIGATE_NEXT,
mExpectedEmojiMoreKey, mExpectedNavigateNextMoreKey);
// With previous navigate flag.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_FLAG_NAVIGATE_PREVIOUS,
mExpectedEmojiMoreKey, mExpectedNavigatePreviousMoreKey);
// With next and previous naviagte flags.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_FLAG_NAVIGATE_NEXT | EditorInfo.IME_FLAG_NAVIGATE_PREVIOUS,
mExpectedEmojiMoreKey, mExpectedNavigatePreviousMoreKey,
mExpectedNavigateNextMoreKey);
// Action next.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_ACTION_NEXT,
mExpectedEmojiMoreKey);
// Action next with next navigate flag.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_ACTION_NEXT | EditorInfo.IME_FLAG_NAVIGATE_NEXT,
mExpectedEmojiMoreKey);
// Action next with previous navigate flag.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_ACTION_NEXT | EditorInfo.IME_FLAG_NAVIGATE_PREVIOUS,
mExpectedEmojiMoreKey, mExpectedNavigatePreviousMoreKey);
// Action next with next and previous navigate flags.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_ACTION_NEXT | EditorInfo.IME_FLAG_NAVIGATE_NEXT
| EditorInfo.IME_FLAG_NAVIGATE_PREVIOUS,
mExpectedEmojiMoreKey, mExpectedNavigatePreviousMoreKey);
// Action previous.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_ACTION_PREVIOUS,
mExpectedEmojiMoreKey);
// Action previous with next navigate flag.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_ACTION_PREVIOUS | EditorInfo.IME_FLAG_NAVIGATE_NEXT,
mExpectedEmojiMoreKey, mExpectedNavigateNextMoreKey);
// Action previous with previous navigate flag.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_ACTION_PREVIOUS | EditorInfo.IME_FLAG_NAVIGATE_PREVIOUS,
mExpectedEmojiMoreKey);
// Action previous with next and previous navigate flags.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_ACTION_PREVIOUS | EditorInfo.IME_FLAG_NAVIGATE_NEXT
| EditorInfo.IME_FLAG_NAVIGATE_PREVIOUS,
mExpectedEmojiMoreKey, mExpectedNavigateNextMoreKey);
}
private void doTestNoNavigationMoreKeysOf(final int code, final InputMethodSubtype subtype,
final int elementId, final int inputType) {
// No navigate flag.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_NULL,
ExpectedMoreKey.EMPTY_MORE_KEYS);
// With next navigate flag.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_FLAG_NAVIGATE_NEXT,
ExpectedMoreKey.EMPTY_MORE_KEYS);
// With previous navigate flag.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_FLAG_NAVIGATE_PREVIOUS,
ExpectedMoreKey.EMPTY_MORE_KEYS);
// With next and previous naviagte flags.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_FLAG_NAVIGATE_NEXT | EditorInfo.IME_FLAG_NAVIGATE_PREVIOUS,
ExpectedMoreKey.EMPTY_MORE_KEYS);
// Action next.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_ACTION_NEXT,
ExpectedMoreKey.EMPTY_MORE_KEYS);
// Action next with next navigate flag.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_ACTION_NEXT | EditorInfo.IME_FLAG_NAVIGATE_NEXT,
ExpectedMoreKey.EMPTY_MORE_KEYS);
// Action next with previous navigate flag.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_ACTION_NEXT | EditorInfo.IME_FLAG_NAVIGATE_PREVIOUS,
ExpectedMoreKey.EMPTY_MORE_KEYS);
// Action next with next and previous navigate flags.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_ACTION_NEXT | EditorInfo.IME_FLAG_NAVIGATE_NEXT
| EditorInfo.IME_FLAG_NAVIGATE_PREVIOUS,
ExpectedMoreKey.EMPTY_MORE_KEYS);
// Action previous.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_ACTION_PREVIOUS,
ExpectedMoreKey.EMPTY_MORE_KEYS);
// Action previous with next navigate flag.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_ACTION_PREVIOUS | EditorInfo.IME_FLAG_NAVIGATE_NEXT,
ExpectedMoreKey.EMPTY_MORE_KEYS);
// Action previous with previous navigate flag.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_ACTION_PREVIOUS | EditorInfo.IME_FLAG_NAVIGATE_PREVIOUS,
ExpectedMoreKey.EMPTY_MORE_KEYS);
// Action previous with next and previous navigate flags.
doTestMoreKeysOf(code, subtype, elementId, inputType,
EditorInfo.IME_ACTION_PREVIOUS | EditorInfo.IME_FLAG_NAVIGATE_NEXT
| EditorInfo.IME_FLAG_NAVIGATE_PREVIOUS,
ExpectedMoreKey.EMPTY_MORE_KEYS);
}
public void testMoreKeysOfEnterKey() {
final RichInputMethodManager richImm = RichInputMethodManager.getInstance();
final InputMethodSubtype subtype = richImm.findSubtypeByLocaleAndKeyboardLayoutSet(
Locale.US.toString(), SubtypeLocaleUtils.QWERTY);
// Password field.
doTestNavigationMoreKeysOf(Constants.CODE_ENTER, subtype, KeyboardId.ELEMENT_ALPHABET,
InputType.TYPE_CLASS_TEXT | InputType.TYPE_TEXT_VARIATION_PASSWORD);
// Email field.
doTestNavigationMoreKeysOf(Constants.CODE_ENTER, subtype, KeyboardId.ELEMENT_ALPHABET,
InputType.TYPE_CLASS_TEXT | InputType.TYPE_TEXT_VARIATION_EMAIL_ADDRESS);
// Url field.
doTestNavigationMoreKeysOf(Constants.CODE_ENTER, subtype, KeyboardId.ELEMENT_ALPHABET,
InputType.TYPE_CLASS_TEXT | InputType.TYPE_TEXT_VARIATION_URI);
// Phone number field.
doTestNavigationMoreKeysOf(Constants.CODE_ENTER, subtype, KeyboardId.ELEMENT_PHONE,
InputType.TYPE_CLASS_PHONE);
// Number field.
doTestNavigationMoreKeysOf(Constants.CODE_ENTER, subtype, KeyboardId.ELEMENT_NUMBER,
InputType.TYPE_CLASS_NUMBER);
// Date-time field.
doTestNavigationMoreKeysOf(Constants.CODE_ENTER, subtype, KeyboardId.ELEMENT_NUMBER,
InputType.TYPE_CLASS_DATETIME | InputType.TYPE_DATETIME_VARIATION_NORMAL);
// Date field.
doTestNavigationMoreKeysOf(Constants.CODE_ENTER, subtype, KeyboardId.ELEMENT_NUMBER,
InputType.TYPE_CLASS_DATETIME | InputType.TYPE_DATETIME_VARIATION_DATE);
// Time field.
doTestNavigationMoreKeysOf(Constants.CODE_ENTER, subtype, KeyboardId.ELEMENT_NUMBER,
InputType.TYPE_CLASS_DATETIME | InputType.TYPE_DATETIME_VARIATION_TIME);
// Text field.
if (isPhone()) {
// The enter key has an Emoji key as one of more keys.
doTestNavigationWithEmojiMoreKeysOf(Constants.CODE_ENTER, subtype,
KeyboardId.ELEMENT_ALPHABET,
InputType.TYPE_CLASS_TEXT);
} else {
// Tablet has a dedicated Emoji key, so the Enter key has no Emoji more key.
doTestNavigationMoreKeysOf(Constants.CODE_ENTER, subtype,
KeyboardId.ELEMENT_ALPHABET,
InputType.TYPE_CLASS_TEXT);
}
// Short message field.
if (isPhone()) {
// Enter key is switched to Emoji key on a short message field.
// Emoji key has no navigation more keys.
doTestNoNavigationMoreKeysOf(Constants.CODE_EMOJI, subtype,
KeyboardId.ELEMENT_ALPHABET,
InputType.TYPE_CLASS_TEXT | InputType.TYPE_TEXT_VARIATION_SHORT_MESSAGE);
} else {
doTestNavigationMoreKeysOf(Constants.CODE_ENTER, subtype,
KeyboardId.ELEMENT_ALPHABET,
InputType.TYPE_CLASS_TEXT | InputType.TYPE_TEXT_VARIATION_SHORT_MESSAGE);
}
}
}
|
