Merge "Clarify on DEFAULT_INPUT_METHOD and InputMethodInfo#getId()"

This commit is contained in:
Yohei Yukawa
2021-07-23 23:16:11 +00:00
committed by Android (Google) Code Review
2 changed files with 12 additions and 4 deletions

View File

@@ -6410,8 +6410,15 @@ public final class Settings {
public static final String DATA_ROAMING = Global.DATA_ROAMING;
/**
* Setting to record the input method used by default, holding the ID
* of the desired method.
* Stores {@link android.view.inputmethod.InputMethodInfo#getId()} of the input method
* service that is currently selected.
*
* <p>Although the name {@link #DEFAULT_INPUT_METHOD} implies that there is a concept of
* <i>default</i> input method, in reality this setting is no more or less than the
* <strong>currently selected</strong> input method. This setting can be updated at any
* time as a result of user-initiated and system-initiated input method switching.</p>
*
* <p>Use {@link ComponentName#unflattenFromString(String)} to parse the stored value.</p>
*/
@Readable
public static final String DEFAULT_INPUT_METHOD = "default_input_method";

View File

@@ -418,8 +418,9 @@ public final class InputMethodInfo implements Parcelable {
}
/**
* Return a unique ID for this input method. The ID is generated from
* the package and class name implementing the method.
* @return a unique ID for this input method, which is guaranteed to be the same as the result
* of {@code getComponent().flattenToShortString()}.
* @see ComponentName#unflattenFromString(String)
*/
public String getId() {
return mId;