Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit d0bbe217 authored by Yohei Yukawa's avatar Yohei Yukawa
Browse files

Add comments for some int fields in EditorInfo 

As a preparation to add a new flag into EditorInfo, this CL aims to make
it clear what bits in EditorInfo are already used and what bits are
still available for new features.

There should be no behavior change because there is no code change.

Bug: 28157942
Test: compile, as there is no actual code change
Change-Id: Ie4b216dbb0978d8dc1c5e91762b87d065c7a1cac
parent 446e723c

core/java/android/view/inputmethod/EditorInfo.java

+73 −0
Original line number Diff line number Diff line
@@ -33,6 +33,54 @@ import java.util.Arrays; 
 * importantly the type of text content it contains and the current cursor position.

 */

public class EditorInfo implements InputType, Parcelable {

    /**

     * Masks for {@link inputType}

     *

     * <pre>

     * |-------|-------|-------|-------|

     *                              1111 TYPE_MASK_CLASS

     *                      11111111     TYPE_MASK_VARIATION

     *          111111111111             TYPE_MASK_FLAGS

     * |-------|-------|-------|-------|

     *                                   TYPE_NULL

     * |-------|-------|-------|-------|

     *                                 1 TYPE_CLASS_TEXT

     *                             1     TYPE_TEXT_VARIATION_URI

     *                            1      TYPE_TEXT_VARIATION_EMAIL_ADDRESS

     *                            11     TYPE_TEXT_VARIATION_EMAIL_SUBJECT

     *                           1       TYPE_TEXT_VARIATION_SHORT_MESSAGE

     *                           1 1     TYPE_TEXT_VARIATION_LONG_MESSAGE

     *                           11      TYPE_TEXT_VARIATION_PERSON_NAME

     *                           111     TYPE_TEXT_VARIATION_POSTAL_ADDRESS

     *                          1        TYPE_TEXT_VARIATION_PASSWORD

     *                          1  1     TYPE_TEXT_VARIATION_VISIBLE_PASSWORD

     *                          1 1      TYPE_TEXT_VARIATION_WEB_EDIT_TEXT

     *                          1 11     TYPE_TEXT_VARIATION_FILTER

     *                          11       TYPE_TEXT_VARIATION_PHONETIC

     *                          11 1     TYPE_TEXT_VARIATION_WEB_EMAIL_ADDRESS

     *                          111      TYPE_TEXT_VARIATION_WEB_PASSWORD

     *                     1             TYPE_TEXT_FLAG_CAP_CHARACTERS

     *                    1              TYPE_TEXT_FLAG_CAP_WORDS

     *                   1               TYPE_TEXT_FLAG_CAP_SENTENCES

     *                  1                TYPE_TEXT_FLAG_AUTO_CORRECT

     *                 1                 TYPE_TEXT_FLAG_AUTO_COMPLETE

     *                1                  TYPE_TEXT_FLAG_MULTI_LINE

     *               1                   TYPE_TEXT_FLAG_IME_MULTI_LINE

     *              1                    TYPE_TEXT_FLAG_NO_SUGGESTIONS

     * |-------|-------|-------|-------|

     *                                1  TYPE_CLASS_NUMBER

     *                             1     TYPE_NUMBER_VARIATION_PASSWORD

     *                     1             TYPE_NUMBER_FLAG_SIGNED

     *                    1              TYPE_NUMBER_FLAG_DECIMAL

     * |-------|-------|-------|-------|

     *                                11 TYPE_CLASS_PHONE

     * |-------|-------|-------|-------|

     *                               1   TYPE_CLASS_DATETIME

     *                             1     TYPE_DATETIME_VARIATION_DATE

     *                            1      TYPE_DATETIME_VARIATION_TIME

     * |-------|-------|-------|-------|</pre>

     */



    /**

     * The content type of the text box, whose bits are defined by

     * {@link InputType}.
@@ -207,6 +255,31 @@ public class EditorInfo implements InputType, Parcelable { 
     */

    public static final int IME_NULL = 0x00000000;



    /**

     * Masks for {@link imeOptions}

     *

     * <pre>

     * |-------|-------|-------|-------|

     *                              1111 IME_MASK_ACTION

     * |-------|-------|-------|-------|

     *                                   IME_ACTION_UNSPECIFIED

     *                                 1 IME_ACTION_NONE

     *                                1  IME_ACTION_GO

     *                                11 IME_ACTION_SEARCH

     *                               1   IME_ACTION_SEND

     *                               1 1 IME_ACTION_NEXT

     *                               11  IME_ACTION_DONE

     *                               111 IME_ACTION_PREVIOUS

     *        1                          IME_FLAG_NO_FULLSCREEN

     *       1                           IME_FLAG_NAVIGATE_PREVIOUS

     *      1                            IME_FLAG_NAVIGATE_NEXT

     *     1                             IME_FLAG_NO_EXTRACT_UI

     *    1                              IME_FLAG_NO_ACCESSORY_ACTION

     *   1                               IME_FLAG_NO_ENTER_ACTION

     *  1                                IME_FLAG_FORCE_ASCII

     * |-------|-------|-------|-------|</pre>

     */



    /**

     * Extended type information for the editor, to help the IME better

     * integrate with it.