1ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok/* 2ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok * Copyright (C) 2010 The Android Open Source Project 3ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok * 4ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok * Licensed under the Apache License, Version 2.0 (the "License"); 5ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok * you may not use this file except in compliance with the License. 6ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok * You may obtain a copy of the License at 7ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok * 8ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok * http://www.apache.org/licenses/LICENSE-2.0 9ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok * 10ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok * Unless required by applicable law or agreed to in writing, software 11ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok * distributed under the License is distributed on an "AS IS" BASIS, 12ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok * See the License for the specific language governing permissions and 14ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok * limitations under the License. 15ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok */ 16ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok 17ab751aa085433e9f735d2e7603459c6c7e9d2fb0satokpackage android.view.inputmethod; 18ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok 197265d9bd6d80c5bedaa6de2b80f6619a301a07c8satokimport android.content.Context; 204f31353cb3b00c77c9420ef27ec949fd570ede3bsatokimport android.content.pm.ApplicationInfo; 21ab751aa085433e9f735d2e7603459c6c7e9d2fb0satokimport android.os.Parcel; 22ab751aa085433e9f735d2e7603459c6c7e9d2fb0satokimport android.os.Parcelable; 234f31353cb3b00c77c9420ef27ec949fd570ede3bsatokimport android.text.TextUtils; 249c4cc03a354922df08efacfc486ef0e80144d3easatokimport android.util.Slog; 25ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok 267265d9bd6d80c5bedaa6de2b80f6619a301a07c8satokimport java.util.ArrayList; 27ab751aa085433e9f735d2e7603459c6c7e9d2fb0satokimport java.util.Arrays; 289c4cc03a354922df08efacfc486ef0e80144d3easatokimport java.util.HashMap; 297265d9bd6d80c5bedaa6de2b80f6619a301a07c8satokimport java.util.HashSet; 3083e675f5ecf9f5615f3179ac102176faa3ae2596satokimport java.util.IllegalFormatException; 317265d9bd6d80c5bedaa6de2b80f6619a301a07c8satokimport java.util.List; 32a9778d4d442db65344e32318b1fd43ab54898389satokimport java.util.Locale; 33ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok 34ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok/** 359a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * This class is used to specify meta information of a subtype contained in an input method editor 369a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * (IME). Subtype can describe locale (e.g. en_US, fr_FR...) and mode (e.g. voice, keyboard...), 379a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * and is used for IME switch and settings. The input method subtype allows the system to bring up 389a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * the specified subtype of the designated IME directly. 3944b75030931d9c65c9e495a86d11d71da59b4429satok * 409a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * <p>It should be defined in an XML resource file of the input method with the 419a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * <code><subtype></code> element. For more information, see the guide to 4244b75030931d9c65c9e495a86d11d71da59b4429satok * <a href="{@docRoot}resources/articles/creating-input-method.html"> 4344b75030931d9c65c9e495a86d11d71da59b4429satok * Creating an Input Method</a>.</p> 44ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok */ 45ab751aa085433e9f735d2e7603459c6c7e9d2fb0satokpublic final class InputMethodSubtype implements Parcelable { 469c4cc03a354922df08efacfc486ef0e80144d3easatok private static final String TAG = InputMethodSubtype.class.getSimpleName(); 479c4cc03a354922df08efacfc486ef0e80144d3easatok private static final String EXTRA_VALUE_PAIR_SEPARATOR = ","; 489c4cc03a354922df08efacfc486ef0e80144d3easatok private static final String EXTRA_VALUE_KEY_VALUE_SEPARATOR = "="; 4983e675f5ecf9f5615f3179ac102176faa3ae2596satok // TODO: remove this 5083e675f5ecf9f5615f3179ac102176faa3ae2596satok private static final String EXTRA_KEY_UNTRANSLATABLE_STRING_IN_SUBTYPE_NAME = 5183e675f5ecf9f5615f3179ac102176faa3ae2596satok "UntranslatableReplacementStringInSubtypeName"; 529c4cc03a354922df08efacfc486ef0e80144d3easatok 539aabb95781bee6a44684a6f6feb155e115d24983satok private final boolean mIsAuxiliary; 54a86f5e448cd6d29340ca6cbe509bc6384bc0d711satok private final boolean mOverridesImplicitlyEnabledSubtype; 559aabb95781bee6a44684a6f6feb155e115d24983satok private final int mSubtypeHashCode; 56ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok private final int mSubtypeIconResId; 579aabb95781bee6a44684a6f6feb155e115d24983satok private final int mSubtypeNameResId; 58ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok private final String mSubtypeLocale; 599ef0283bdcd9534cc09ae37eb2b78771b95247b5satok private final String mSubtypeMode; 60ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok private final String mSubtypeExtraValue; 61e52eb4e289bf8d7b04582803b0d0f9ab7399c1afsatok private volatile HashMap<String, String> mExtraValueHashMapCache; 62ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok 63ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok /** 649a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * Constructor. 659a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * @param nameId Resource ID of the subtype name string. The string resource may have exactly 669a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * one %s in it. If there is, the %s part will be replaced with the locale's display name by 679a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * the formatter. Please refer to {@link #getDisplayName} for details. 689a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * @param iconId Resource ID of the subtype icon drawable. 69ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok * @param locale The locale supported by the subtype 70a9778d4d442db65344e32318b1fd43ab54898389satok * @param mode The mode supported by the subtype 719a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * @param extraValue The extra value of the subtype. This string is free-form, but the API 729a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * supplies tools to deal with a key-value comma-separated list; see 739a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * {@link #containsExtraValueKey} and {@link #getExtraValueOf}. 749a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * @param isAuxiliary true when this subtype is auxiliary, false otherwise. An auxiliary 759a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * subtype will not be shown in the list of enabled IMEs for choosing the current IME in 769a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * the Settings even when this subtype is enabled. Please note that this subtype will still 779a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * be shown in the list of IMEs in the IME switcher to allow the user to tentatively switch 789a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * to this subtype while an IME is shown. The framework will never switch the current IME to 799a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * this subtype by {@link android.view.inputmethod.InputMethodManager#switchToLastInputMethod}. 809a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * The intent of having this flag is to allow for IMEs that are invoked in a one-shot way as 819a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * auxiliary input mode, and return to the previous IME once it is finished (e.g. voice input). 823889e492bcad3c6f565d30da4e02d0dcde09d084satok * @hide 83ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok */ 84a86f5e448cd6d29340ca6cbe509bc6384bc0d711satok public InputMethodSubtype(int nameId, int iconId, String locale, String mode, String extraValue, 85a86f5e448cd6d29340ca6cbe509bc6384bc0d711satok boolean isAuxiliary) { 868b83a7297680911d666546ee0b3a464514dc2c27Ken Wakasa this(nameId, iconId, locale, mode, extraValue, isAuxiliary, false); 879aabb95781bee6a44684a6f6feb155e115d24983satok } 889aabb95781bee6a44684a6f6feb155e115d24983satok 899aabb95781bee6a44684a6f6feb155e115d24983satok /** 909a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * Constructor. 919a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * @param nameId Resource ID of the subtype name string. The string resource may have exactly 929a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * one %s in it. If there is, the %s part will be replaced with the locale's display name by 939a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * the formatter. Please refer to {@link #getDisplayName} for details. 949a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * @param iconId Resource ID of the subtype icon drawable. 959aabb95781bee6a44684a6f6feb155e115d24983satok * @param locale The locale supported by the subtype 96a9778d4d442db65344e32318b1fd43ab54898389satok * @param mode The mode supported by the subtype 979a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * @param extraValue The extra value of the subtype. This string is free-form, but the API 989a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * supplies tools to deal with a key-value comma-separated list; see 999a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * {@link #containsExtraValueKey} and {@link #getExtraValueOf}. 1009a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * @param isAuxiliary true when this subtype is auxiliary, false otherwise. An auxiliary 1019a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * subtype will not be shown in the list of enabled IMEs for choosing the current IME in 1029a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * the Settings even when this subtype is enabled. Please note that this subtype will still 1039a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * be shown in the list of IMEs in the IME switcher to allow the user to tentatively switch 1049a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * to this subtype while an IME is shown. The framework will never switch the current IME to 1059a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * this subtype by {@link android.view.inputmethod.InputMethodManager#switchToLastInputMethod}. 1069a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * The intent of having this flag is to allow for IMEs that are invoked in a one-shot way as 1079a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * auxiliary input mode, and return to the previous IME once it is finished (e.g. voice input). 1089a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * @param overridesImplicitlyEnabledSubtype true when this subtype should be enabled by default 1099a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * if no other subtypes in the IME are enabled explicitly. Note that a subtype with this 1109a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * parameter being true will not be shown in the list of subtypes in each IME's subtype enabler. 1119a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * Having an "automatic" subtype is an example use of this flag. 1129aabb95781bee6a44684a6f6feb155e115d24983satok */ 113a9778d4d442db65344e32318b1fd43ab54898389satok public InputMethodSubtype(int nameId, int iconId, String locale, String mode, String extraValue, 114a86f5e448cd6d29340ca6cbe509bc6384bc0d711satok boolean isAuxiliary, boolean overridesImplicitlyEnabledSubtype) { 115ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok mSubtypeNameResId = nameId; 116ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok mSubtypeIconResId = iconId; 117af4bf400abab86baee44dacbcdf13444d06ee46esatok mSubtypeLocale = locale != null ? locale : ""; 118af4bf400abab86baee44dacbcdf13444d06ee46esatok mSubtypeMode = mode != null ? mode : ""; 119af4bf400abab86baee44dacbcdf13444d06ee46esatok mSubtypeExtraValue = extraValue != null ? extraValue : ""; 1209aabb95781bee6a44684a6f6feb155e115d24983satok mIsAuxiliary = isAuxiliary; 121a86f5e448cd6d29340ca6cbe509bc6384bc0d711satok mOverridesImplicitlyEnabledSubtype = overridesImplicitlyEnabledSubtype; 122a9778d4d442db65344e32318b1fd43ab54898389satok mSubtypeHashCode = hashCodeInternal(mSubtypeLocale, mSubtypeMode, mSubtypeExtraValue, 123a86f5e448cd6d29340ca6cbe509bc6384bc0d711satok mIsAuxiliary, mOverridesImplicitlyEnabledSubtype); 124ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok } 125ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok 126ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok InputMethodSubtype(Parcel source) { 127af4bf400abab86baee44dacbcdf13444d06ee46esatok String s; 128ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok mSubtypeNameResId = source.readInt(); 129ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok mSubtypeIconResId = source.readInt(); 130af4bf400abab86baee44dacbcdf13444d06ee46esatok s = source.readString(); 131af4bf400abab86baee44dacbcdf13444d06ee46esatok mSubtypeLocale = s != null ? s : ""; 132af4bf400abab86baee44dacbcdf13444d06ee46esatok s = source.readString(); 133af4bf400abab86baee44dacbcdf13444d06ee46esatok mSubtypeMode = s != null ? s : ""; 134af4bf400abab86baee44dacbcdf13444d06ee46esatok s = source.readString(); 135af4bf400abab86baee44dacbcdf13444d06ee46esatok mSubtypeExtraValue = s != null ? s : ""; 1369aabb95781bee6a44684a6f6feb155e115d24983satok mIsAuxiliary = (source.readInt() == 1); 137a86f5e448cd6d29340ca6cbe509bc6384bc0d711satok mOverridesImplicitlyEnabledSubtype = (source.readInt() == 1); 138a9778d4d442db65344e32318b1fd43ab54898389satok mSubtypeHashCode = hashCodeInternal(mSubtypeLocale, mSubtypeMode, mSubtypeExtraValue, 139a86f5e448cd6d29340ca6cbe509bc6384bc0d711satok mIsAuxiliary, mOverridesImplicitlyEnabledSubtype); 140ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok } 141ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok 142ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok /** 1439a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * @return Resource ID of the subtype name string. 144ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok */ 145ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok public int getNameResId() { 146ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok return mSubtypeNameResId; 147ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok } 148ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok 149ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok /** 1509a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * @return Resource ID of the subtype icon drawable. 151ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok */ 152ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok public int getIconResId() { 153ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok return mSubtypeIconResId; 154ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok } 155ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok 156ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok /** 1579a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * @return The locale of the subtype. This method returns the "locale" string parameter passed 1589a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * to the constructor. 159ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok */ 160ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok public String getLocale() { 161ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok return mSubtypeLocale; 162ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok } 163ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok 164ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok /** 1659a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * @return The mode of the subtype. 166ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok */ 1679ef0283bdcd9534cc09ae37eb2b78771b95247b5satok public String getMode() { 1689ef0283bdcd9534cc09ae37eb2b78771b95247b5satok return mSubtypeMode; 169ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok } 170ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok 171ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok /** 1729a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * @return The extra value of the subtype. 173ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok */ 174ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok public String getExtraValue() { 175ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok return mSubtypeExtraValue; 176ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok } 177ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok 1789aabb95781bee6a44684a6f6feb155e115d24983satok /** 1799a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * @return true if this subtype is auxiliary, false otherwise. An auxiliary subtype will not be 1809a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * shown in the list of enabled IMEs for choosing the current IME in the Settings even when this 1819a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * subtype is enabled. Please note that this subtype will still be shown in the list of IMEs in 1829a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * the IME switcher to allow the user to tentatively switch to this subtype while an IME is 1839a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * shown. The framework will never switch the current IME to this subtype by 1849a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * {@link android.view.inputmethod.InputMethodManager#switchToLastInputMethod}. 1859a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * The intent of having this flag is to allow for IMEs that are invoked in a one-shot way as 1869a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * auxiliary input mode, and return to the previous IME once it is finished (e.g. voice input). 1879aabb95781bee6a44684a6f6feb155e115d24983satok */ 1889aabb95781bee6a44684a6f6feb155e115d24983satok public boolean isAuxiliary() { 1899aabb95781bee6a44684a6f6feb155e115d24983satok return mIsAuxiliary; 1909aabb95781bee6a44684a6f6feb155e115d24983satok } 1919aabb95781bee6a44684a6f6feb155e115d24983satok 1924f31353cb3b00c77c9420ef27ec949fd570ede3bsatok /** 1939a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * @return true when this subtype will be enabled by default if no other subtypes in the IME 1949a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * are enabled explicitly, false otherwise. Note that a subtype with this method returning true 1959a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * will not be shown in the list of subtypes in each IME's subtype enabler. Having an 1969a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * "automatic" subtype is an example use of this flag. 197a86f5e448cd6d29340ca6cbe509bc6384bc0d711satok */ 198a86f5e448cd6d29340ca6cbe509bc6384bc0d711satok public boolean overridesImplicitlyEnabledSubtype() { 199a86f5e448cd6d29340ca6cbe509bc6384bc0d711satok return mOverridesImplicitlyEnabledSubtype; 200a86f5e448cd6d29340ca6cbe509bc6384bc0d711satok } 201a86f5e448cd6d29340ca6cbe509bc6384bc0d711satok 202a86f5e448cd6d29340ca6cbe509bc6384bc0d711satok /** 2034f31353cb3b00c77c9420ef27ec949fd570ede3bsatok * @param context Context will be used for getting Locale and PackageManager. 2044f31353cb3b00c77c9420ef27ec949fd570ede3bsatok * @param packageName The package name of the IME 2054f31353cb3b00c77c9420ef27ec949fd570ede3bsatok * @param appInfo The application info of the IME 2064f31353cb3b00c77c9420ef27ec949fd570ede3bsatok * @return a display name for this subtype. The string resource of the label (mSubtypeNameResId) 2079a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * may have exactly one %s in it. If there is, the %s part will be replaced with the locale's 2089a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * display name by the formatter. If there is not, this method returns the string specified by 2099a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * mSubtypeNameResId. If mSubtypeNameResId is not specified (== 0), it's up to the framework to 2109a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * generate an appropriate display name. 2114f31353cb3b00c77c9420ef27ec949fd570ede3bsatok */ 2124f31353cb3b00c77c9420ef27ec949fd570ede3bsatok public CharSequence getDisplayName( 2134f31353cb3b00c77c9420ef27ec949fd570ede3bsatok Context context, String packageName, ApplicationInfo appInfo) { 214a9778d4d442db65344e32318b1fd43ab54898389satok final Locale locale = constructLocaleFromString(mSubtypeLocale); 215a9778d4d442db65344e32318b1fd43ab54898389satok final String localeStr = locale != null ? locale.getDisplayName() : mSubtypeLocale; 2164f31353cb3b00c77c9420ef27ec949fd570ede3bsatok if (mSubtypeNameResId == 0) { 217a9778d4d442db65344e32318b1fd43ab54898389satok return localeStr; 2184f31353cb3b00c77c9420ef27ec949fd570ede3bsatok } 21935412d63ee59b99a43725e466c5deef52b2324dfsatok final CharSequence subtypeName = context.getPackageManager().getText( 22035412d63ee59b99a43725e466c5deef52b2324dfsatok packageName, mSubtypeNameResId, appInfo); 2214f31353cb3b00c77c9420ef27ec949fd570ede3bsatok if (!TextUtils.isEmpty(subtypeName)) { 22283e675f5ecf9f5615f3179ac102176faa3ae2596satok final String replacementString = 22383e675f5ecf9f5615f3179ac102176faa3ae2596satok containsExtraValueKey(EXTRA_KEY_UNTRANSLATABLE_STRING_IN_SUBTYPE_NAME) 22483e675f5ecf9f5615f3179ac102176faa3ae2596satok ? getExtraValueOf(EXTRA_KEY_UNTRANSLATABLE_STRING_IN_SUBTYPE_NAME) 22583e675f5ecf9f5615f3179ac102176faa3ae2596satok : localeStr; 22683e675f5ecf9f5615f3179ac102176faa3ae2596satok try { 22783e675f5ecf9f5615f3179ac102176faa3ae2596satok return String.format( 22883e675f5ecf9f5615f3179ac102176faa3ae2596satok subtypeName.toString(), replacementString != null ? replacementString : ""); 22983e675f5ecf9f5615f3179ac102176faa3ae2596satok } catch (IllegalFormatException e) { 23083e675f5ecf9f5615f3179ac102176faa3ae2596satok Slog.w(TAG, "Found illegal format in subtype name("+ subtypeName + "): " + e); 23183e675f5ecf9f5615f3179ac102176faa3ae2596satok return ""; 23283e675f5ecf9f5615f3179ac102176faa3ae2596satok } 2334f31353cb3b00c77c9420ef27ec949fd570ede3bsatok } else { 234a9778d4d442db65344e32318b1fd43ab54898389satok return localeStr; 2354f31353cb3b00c77c9420ef27ec949fd570ede3bsatok } 2364f31353cb3b00c77c9420ef27ec949fd570ede3bsatok } 2374f31353cb3b00c77c9420ef27ec949fd570ede3bsatok 2389c4cc03a354922df08efacfc486ef0e80144d3easatok private HashMap<String, String> getExtraValueHashMap() { 2399c4cc03a354922df08efacfc486ef0e80144d3easatok if (mExtraValueHashMapCache == null) { 240e52eb4e289bf8d7b04582803b0d0f9ab7399c1afsatok synchronized(this) { 241e52eb4e289bf8d7b04582803b0d0f9ab7399c1afsatok if (mExtraValueHashMapCache == null) { 242e52eb4e289bf8d7b04582803b0d0f9ab7399c1afsatok mExtraValueHashMapCache = new HashMap<String, String>(); 243e52eb4e289bf8d7b04582803b0d0f9ab7399c1afsatok final String[] pairs = mSubtypeExtraValue.split(EXTRA_VALUE_PAIR_SEPARATOR); 244e52eb4e289bf8d7b04582803b0d0f9ab7399c1afsatok final int N = pairs.length; 245e52eb4e289bf8d7b04582803b0d0f9ab7399c1afsatok for (int i = 0; i < N; ++i) { 246e52eb4e289bf8d7b04582803b0d0f9ab7399c1afsatok final String[] pair = pairs[i].split(EXTRA_VALUE_KEY_VALUE_SEPARATOR); 247e52eb4e289bf8d7b04582803b0d0f9ab7399c1afsatok if (pair.length == 1) { 248e52eb4e289bf8d7b04582803b0d0f9ab7399c1afsatok mExtraValueHashMapCache.put(pair[0], null); 249e52eb4e289bf8d7b04582803b0d0f9ab7399c1afsatok } else if (pair.length > 1) { 250e52eb4e289bf8d7b04582803b0d0f9ab7399c1afsatok if (pair.length > 2) { 251e52eb4e289bf8d7b04582803b0d0f9ab7399c1afsatok Slog.w(TAG, "ExtraValue has two or more '='s"); 252e52eb4e289bf8d7b04582803b0d0f9ab7399c1afsatok } 253e52eb4e289bf8d7b04582803b0d0f9ab7399c1afsatok mExtraValueHashMapCache.put(pair[0], pair[1]); 254e52eb4e289bf8d7b04582803b0d0f9ab7399c1afsatok } 2559c4cc03a354922df08efacfc486ef0e80144d3easatok } 2569c4cc03a354922df08efacfc486ef0e80144d3easatok } 2579c4cc03a354922df08efacfc486ef0e80144d3easatok } 2589c4cc03a354922df08efacfc486ef0e80144d3easatok } 2599c4cc03a354922df08efacfc486ef0e80144d3easatok return mExtraValueHashMapCache; 2609c4cc03a354922df08efacfc486ef0e80144d3easatok } 2619c4cc03a354922df08efacfc486ef0e80144d3easatok 2629c4cc03a354922df08efacfc486ef0e80144d3easatok /** 2639c4cc03a354922df08efacfc486ef0e80144d3easatok * The string of ExtraValue in subtype should be defined as follows: 2649c4cc03a354922df08efacfc486ef0e80144d3easatok * example: key0,key1=value1,key2,key3,key4=value4 2659a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * @param key The key of extra value 2669a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * @return The subtype contains specified the extra value 2679c4cc03a354922df08efacfc486ef0e80144d3easatok */ 2689c4cc03a354922df08efacfc486ef0e80144d3easatok public boolean containsExtraValueKey(String key) { 2699c4cc03a354922df08efacfc486ef0e80144d3easatok return getExtraValueHashMap().containsKey(key); 2709c4cc03a354922df08efacfc486ef0e80144d3easatok } 2719c4cc03a354922df08efacfc486ef0e80144d3easatok 2729c4cc03a354922df08efacfc486ef0e80144d3easatok /** 2739c4cc03a354922df08efacfc486ef0e80144d3easatok * The string of ExtraValue in subtype should be defined as follows: 2749c4cc03a354922df08efacfc486ef0e80144d3easatok * example: key0,key1=value1,key2,key3,key4=value4 2759a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * @param key The key of extra value 2769a74476c0ab1aaa59e9aed6ecdeba43d5b4d3495Ken Wakasa * @return The value of the specified key 2779c4cc03a354922df08efacfc486ef0e80144d3easatok */ 2789c4cc03a354922df08efacfc486ef0e80144d3easatok public String getExtraValueOf(String key) { 2799c4cc03a354922df08efacfc486ef0e80144d3easatok return getExtraValueHashMap().get(key); 2809c4cc03a354922df08efacfc486ef0e80144d3easatok } 2819c4cc03a354922df08efacfc486ef0e80144d3easatok 282ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok @Override 283ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok public int hashCode() { 284ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok return mSubtypeHashCode; 285ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok } 286ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok 287ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok @Override 288ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok public boolean equals(Object o) { 289ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok if (o instanceof InputMethodSubtype) { 290ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok InputMethodSubtype subtype = (InputMethodSubtype) o; 291af4bf400abab86baee44dacbcdf13444d06ee46esatok return (subtype.hashCode() == hashCode()) 292af4bf400abab86baee44dacbcdf13444d06ee46esatok && (subtype.getNameResId() == getNameResId()) 293af4bf400abab86baee44dacbcdf13444d06ee46esatok && (subtype.getMode().equals(getMode())) 294ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok && (subtype.getIconResId() == getIconResId()) 295ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok && (subtype.getLocale().equals(getLocale())) 296a9778d4d442db65344e32318b1fd43ab54898389satok && (subtype.getExtraValue().equals(getExtraValue())) 297a9778d4d442db65344e32318b1fd43ab54898389satok && (subtype.isAuxiliary() == isAuxiliary()); 298ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok } 299ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok return false; 300ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok } 301ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok 3029aabb95781bee6a44684a6f6feb155e115d24983satok @Override 303ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok public int describeContents() { 304ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok return 0; 305ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok } 306ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok 3079aabb95781bee6a44684a6f6feb155e115d24983satok @Override 308ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok public void writeToParcel(Parcel dest, int parcelableFlags) { 309ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok dest.writeInt(mSubtypeNameResId); 310ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok dest.writeInt(mSubtypeIconResId); 311ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok dest.writeString(mSubtypeLocale); 3129ef0283bdcd9534cc09ae37eb2b78771b95247b5satok dest.writeString(mSubtypeMode); 313ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok dest.writeString(mSubtypeExtraValue); 3149aabb95781bee6a44684a6f6feb155e115d24983satok dest.writeInt(mIsAuxiliary ? 1 : 0); 315a86f5e448cd6d29340ca6cbe509bc6384bc0d711satok dest.writeInt(mOverridesImplicitlyEnabledSubtype ? 1 : 0); 316ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok } 317ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok 318ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok public static final Parcelable.Creator<InputMethodSubtype> CREATOR 319ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok = new Parcelable.Creator<InputMethodSubtype>() { 3209aabb95781bee6a44684a6f6feb155e115d24983satok @Override 321ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok public InputMethodSubtype createFromParcel(Parcel source) { 322ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok return new InputMethodSubtype(source); 323ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok } 324ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok 3259aabb95781bee6a44684a6f6feb155e115d24983satok @Override 326ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok public InputMethodSubtype[] newArray(int size) { 327ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok return new InputMethodSubtype[size]; 328ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok } 329ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok }; 330ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok 331a9778d4d442db65344e32318b1fd43ab54898389satok private static Locale constructLocaleFromString(String localeStr) { 332a9778d4d442db65344e32318b1fd43ab54898389satok if (TextUtils.isEmpty(localeStr)) 333a9778d4d442db65344e32318b1fd43ab54898389satok return null; 334a9778d4d442db65344e32318b1fd43ab54898389satok String[] localeParams = localeStr.split("_", 3); 335a9778d4d442db65344e32318b1fd43ab54898389satok // The length of localeStr is guaranteed to always return a 1 <= value <= 3 336a9778d4d442db65344e32318b1fd43ab54898389satok // because localeStr is not empty. 337a9778d4d442db65344e32318b1fd43ab54898389satok if (localeParams.length == 1) { 338a9778d4d442db65344e32318b1fd43ab54898389satok return new Locale(localeParams[0]); 339a9778d4d442db65344e32318b1fd43ab54898389satok } else if (localeParams.length == 2) { 340a9778d4d442db65344e32318b1fd43ab54898389satok return new Locale(localeParams[0], localeParams[1]); 341a9778d4d442db65344e32318b1fd43ab54898389satok } else if (localeParams.length == 3) { 342a9778d4d442db65344e32318b1fd43ab54898389satok return new Locale(localeParams[0], localeParams[1], localeParams[2]); 343a9778d4d442db65344e32318b1fd43ab54898389satok } 344a9778d4d442db65344e32318b1fd43ab54898389satok return null; 345a9778d4d442db65344e32318b1fd43ab54898389satok } 346a9778d4d442db65344e32318b1fd43ab54898389satok 347a9778d4d442db65344e32318b1fd43ab54898389satok private static int hashCodeInternal(String locale, String mode, String extraValue, 348a86f5e448cd6d29340ca6cbe509bc6384bc0d711satok boolean isAuxiliary, boolean overridesImplicitlyEnabledSubtype) { 349a86f5e448cd6d29340ca6cbe509bc6384bc0d711satok return Arrays.hashCode(new Object[] {locale, mode, extraValue, isAuxiliary, 350a86f5e448cd6d29340ca6cbe509bc6384bc0d711satok overridesImplicitlyEnabledSubtype}); 351ab751aa085433e9f735d2e7603459c6c7e9d2fb0satok } 3527265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok 3537265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok /** 3547265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok * Sort the list of InputMethodSubtype 3557265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok * @param context Context will be used for getting localized strings from IME 3567265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok * @param flags Flags for the sort order 3577265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok * @param imi InputMethodInfo of which subtypes are subject to be sorted 3587265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok * @param subtypeList List of InputMethodSubtype which will be sorted 3597265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok * @return Sorted list of subtypes 3607265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok * @hide 3617265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok */ 3627265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok public static List<InputMethodSubtype> sort(Context context, int flags, InputMethodInfo imi, 3637265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok List<InputMethodSubtype> subtypeList) { 3647265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok if (imi == null) return subtypeList; 3657265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok final HashSet<InputMethodSubtype> inputSubtypesSet = new HashSet<InputMethodSubtype>( 3667265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok subtypeList); 3677265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok final ArrayList<InputMethodSubtype> sortedList = new ArrayList<InputMethodSubtype>(); 3687265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok int N = imi.getSubtypeCount(); 3697265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok for (int i = 0; i < N; ++i) { 3707265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok InputMethodSubtype subtype = imi.getSubtypeAt(i); 3717265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok if (inputSubtypesSet.contains(subtype)) { 3727265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok sortedList.add(subtype); 3737265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok inputSubtypesSet.remove(subtype); 3747265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok } 3757265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok } 3767265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok // If subtypes in inputSubtypesSet remain, that means these subtypes are not 3777265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok // contained in imi, so the remaining subtypes will be appended. 3787265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok for (InputMethodSubtype subtype: inputSubtypesSet) { 3797265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok sortedList.add(subtype); 3807265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok } 3817265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok return sortedList; 3827265d9bd6d80c5bedaa6de2b80f6619a301a07c8satok } 383af4bf400abab86baee44dacbcdf13444d06ee46esatok} 384