Google is committed to advancing racial equity for Black communities. See how.

EditorInfoCompat

class EditorInfoCompat
kotlin.Any
   ↳ androidx.core.view.inputmethod.EditorInfoCompat

Helper for accessing features in EditorInfo in a backwards compatible fashion.

Summary

Constants
static Int

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

static Int

Flag of EditorInfo#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.

Public constructors

Public methods
static Array<String!>

Gets MIME types that can be accepted by the target editor if the IME calls InputConnectionCompat#commitContent(InputConnection, EditorInfo, * InputContentInfoCompat, int, Bundle)

static CharSequence?
getInitialSelectedText(@NonNull editorInfo: EditorInfo, flags: Int)

Gets the selected text, if any.

static CharSequence?
getInitialTextAfterCursor(@NonNull editorInfo: EditorInfo, length: Int, flags: Int)

Get n characters of text after the current cursor position.

static CharSequence?
getInitialTextBeforeCursor(@NonNull editorInfo: EditorInfo, length: Int, flags: Int)

Get n characters of text before the current cursor position.

static Unit
setContentMimeTypes(@NonNull editorInfo: EditorInfo, @Nullable contentMimeTypes: Array<String!>?)

Sets MIME types that can be accepted by the target editor if the IME calls InputConnectionCompat#commitContent(InputConnection, EditorInfo, * InputContentInfoCompat, int, Bundle).

static Unit
setInitialSurroundingSubText(@NonNull editorInfo: EditorInfo, @NonNull subText: CharSequence, subTextStart: Int)

Editors may use this method to provide initial input text to IMEs.

static Unit
setInitialSurroundingText(@NonNull editorInfo: EditorInfo, @NonNull sourceText: CharSequence)

Editors may use this method to provide initial input text to IMEs.

Constants

IME_FLAG_FORCE_ASCII

static val IME_FLAG_FORCE_ASCII: Int

Flag of EditorInfo#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.

Value: 0x80000000

IME_FLAG_NO_PERSONALIZED_LEARNING

static val IME_FLAG_NO_PERSONALIZED_LEARNING: Int

Flag of EditorInfo#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.

Value: 0x1000000

Public constructors

<init>

EditorInfoCompat()

Deprecated: This type should not be instantiated as it contains only static methods.

Public methods

getContentMimeTypes

@NonNull static fun getContentMimeTypes(editorInfo: EditorInfo!): Array<String!>

Gets MIME types that can be accepted by the target editor if the IME calls InputConnectionCompat#commitContent(InputConnection, EditorInfo, * InputContentInfoCompat, int, Bundle)

Parameters
editorInfo EditorInfo!: the editor from which we get the MIME types
Return
Array<String!> an array of MIME types. An empty array means that is not supported on this editor

getInitialSelectedText

@Nullable static fun getInitialSelectedText(
    @NonNull 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.

Parameters
flags Int: Supplies additional options controlling how the text is returned. May be either 0 or InputConnection#GET_TEXT_WITH_STYLES.
Return
CharSequence? the text that is currently selected, if any. It could be an empty string when there is no text selected. When null is returned, the selected text might be too long or this protocol is not supported.

getInitialTextAfterCursor

@Nullable static fun getInitialTextAfterCursor(
    @NonNull 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.

Parameters
length Int: The expected length of the text.
flags Int: Supplies additional options controlling how the text is returned. May be either 0 or InputConnection#GET_TEXT_WITH_STYLES.
Return
CharSequence? the text after the cursor position; the length of the returned text might be less than n. When there is no text after the cursor, an empty string will be returned. It could also be null when the editor or system could not support this protocol.

getInitialTextBeforeCursor

@Nullable static fun getInitialTextBeforeCursor(
    @NonNull 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.

Parameters
length Int: The expected length of the text.
flags Int: Supplies additional options controlling how the text is returned. May be either 0 or InputConnection#GET_TEXT_WITH_STYLES.
Return
CharSequence? the text before the cursor position; the length of the returned text might be less than n. When there is no text before the cursor, an empty string will be returned. It could also be null when the editor or system could not support this protocol.

setContentMimeTypes

static fun setContentMimeTypes(
    @NonNull editorInfo: EditorInfo,
    @Nullable contentMimeTypes: Array<String!>?
): Unit

Sets MIME types that can be accepted by the target editor if the IME calls InputConnectionCompat#commitContent(InputConnection, EditorInfo, * InputContentInfoCompat, int, Bundle).

Parameters
editorInfo EditorInfo: the editor with which we associate supported MIME types
contentMimeTypes Array<String!>?: an array of MIME types. null and an empty array means that InputConnectionCompat#commitContent( * InputConnection, EditorInfo, InputContentInfoCompat, int, Bundle) is not supported on this Editor

setInitialSurroundingSubText

static fun setInitialSurroundingSubText(
    @NonNull editorInfo: EditorInfo,
    @NonNull 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 View#onCreateInputConnection(EditorInfo) 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.

Parameters
subText CharSequence: The input text. When it was trimmed, subTextStart must be provided correctly.
subTextStart Int: The position that the input text got trimmed. For example, when the editor wants to trim out the first 10 chars, subTextStart should be 10.

setInitialSurroundingText

static fun setInitialSurroundingText(
    @NonNull editorInfo: EditorInfo,
    @NonNull 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 View#onCreateInputConnection(EditorInfo) 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.

Parameters
sourceText CharSequence: The complete input text.