EditorInfoCompat

const val IME_FLAG_FORCE_ASCII = -2147483648: Int

Flag of imeOptions: used to request an IME that is capable of inputting ASCII characters.

The intention of this flag is to ensure that the user can type Roman alphabet characters in a android.widget.TextView. It is typically used for an account ID or password input.

In many cases, IMEs are already able to input ASCII even without being told so (such IMEs already respect this flag in a sense), but there are cases when this is not the default. For instance, users of languages using a different script like Arabic, Greek, Hebrew or Russian typically have a keyboard that can't input ASCII characters by default.

Applications need to be aware that the flag is not a guarantee, and some IMEs may not respect it. However, it is strongly recommended for IME authors to respect this flag especially when their IME could end up with a state where only languages using non-ASCII are enabled.

const val IME_FLAG_NO_PERSONALIZED_LEARNING = 16777216: Int

Flag of imeOptions: used to request that the IME does not update any personalized data such as typing history and personalized language model based on what the user typed on this text editing object. Typical use cases are:

• When the application is in a special mode, where user's activities are expected to be not recorded in the application's history. Some web browsers and chat applications may have this kind of modes.
• When storing typing history does not make much sense. Specifying this flag in typing games may help to avoid typing history from being filled up with words that the user is less likely to type in their daily life. Another example is that when the application already knows that the expected input is not a valid word (e.g. a promotion code that is not a valid word in any natural language).

Applications need to be aware that the flag is not a guarantee, and some IMEs may not respect it.

java-static fun getContentMimeTypes(editorInfo: EditorInfo): Array<String!>

Gets MIME types that can be accepted by the target editor if the IME calls commitContent

java-static fun getInitialSelectedText(editorInfo: EditorInfo, flags: Int): CharSequence?

Gets the selected text, if any. May be null when no text is selected or the selected text is way too long.

java-static fun getInitialTextAfterCursor(editorInfo: EditorInfo, length: Int, flags: Int): CharSequence?

Get n characters of text after the current cursor position. May be null when the protocol is not supported.

java-static fun getInitialTextBeforeCursor(editorInfo: EditorInfo, length: Int, flags: Int): CharSequence?

Get n characters of text before the current cursor position. May be null when the protocol is not supported.

java-static fun isStylusHandwritingEnabled(editorInfo: EditorInfo): Boolean

Returns true when an editor has stylus handwriting enabled. false by default.

java-static fun setContentMimeTypes(
    editorInfo: EditorInfo,
    contentMimeTypes: Array<String!>?
): Unit

Sets MIME types that can be accepted by the target editor if the IME calls commitContent.

java-static fun setInitialSurroundingSubText(
    editorInfo: EditorInfo,
    subText: CharSequence,
    subTextStart: Int
): Unit

Editors may use this method to provide initial input text to IMEs. As the surrounding text could be used to provide various input assistance, we recommend editors to provide the complete initial input text in its onCreateInputConnection callback. When trimming the input text is needed, call this method instead of setInitialSurroundingText(CharSequence) and provide the trimmed position info. Always try to include the selected text within subText to give the system best flexibility to choose where and how to trim subText when necessary.

java-static fun setInitialSurroundingText(
    editorInfo: EditorInfo,
    sourceText: CharSequence
): Unit

Editors may use this method to provide initial input text to IMEs. As the surrounding text could be used to provide various input assistance, we recommend editors to provide the complete initial input text in its onCreateInputConnection callback. The supplied text will then be processed to serve #getInitialTextBeforeCursor, #getInitialSelectedText, and #getInitialTextBeforeCursor. System is allowed to trim sourceText for various reasons while keeping the most valuable data to IMEs.

Editor authors: Providing the initial input text helps reducing IPC calls for IMEs to provide many modern features right after the connection setup. We recommend calling this method in your implementation.

java-static fun setStylusHandwritingEnabled(editorInfo: EditorInfo, enabled: Boolean): Unit

Set true if the editor has stylus handwriting enabled. false by default, editor must set it true to indicate that it supports stylus handwriting.