OSDN Git Service

Improve the API document for supportsSwitchingToNextInputMethod
authorsatok <satok@google.com>
Mon, 26 Aug 2013 05:17:18 +0000 (14:17 +0900)
committersatok <satok@google.com>
Tue, 27 Aug 2013 02:08:24 +0000 (11:08 +0900)
Bug: 10461455
Change-Id: I0d3c5d3cd40f7ad057970fddd141bfd838e246f4

core/java/android/view/inputmethod/InputMethodManager.java
core/res/res/values/attrs.xml

index f97e3dd..54b87de 100644 (file)
@@ -1876,9 +1876,13 @@ public final class InputMethodManager {
     }
 
     /**
-     * Returns true if the current IME needs to offer the users a way to switch to a next input
-     * method. When the user triggers it, the IME has to call {@link #switchToNextInputMethod} to
-     * switch to a next input method which is selected by the system.
+     * Returns true if the current IME needs to offer the users ways to switch to a next input
+     * method (e.g. a globe key.).
+     * When an IME sets supportsSwitchingToNextInputMethod and this method returns true,
+     * the IME has to offer ways to to invoke {@link #switchToNextInputMethod} accordingly.
+     * <p> Note that the system determines the most appropriate next input method
+     * and subtype in order to provide the consistent user experience in switching
+     * between IMEs and subtypes.
      * @param imeToken Supplies the identifying token given to an input method when it was started,
      * which allows it to perform this operation on itself.
      */
index 50ea08b..c239b02 100644 (file)
              method should be considered an option as the default. -->
         <attr name="isDefault" format="boolean" />
         <!-- Set to true if this input method supports ways to switch to
-             a next input method (e.g. a globe key.). -->
+             a next input method (e.g. a globe key.). When this is true and
+             InputMethodManager#shouldOfferSwitchingToNextInputMethod() returns true,
+             the IME has to offer ways to to invoke InputMethodManager#switchToNextInputMethod()
+             accordingly.
+             <p> Note that the system determines the most appropriate next input method
+             and subtype in order to provide the consistent user experience in switching
+             between IMEs and subtypes. -->
         <attr name="supportsSwitchingToNextInputMethod" format="boolean" />
     </declare-styleable>