Added in API level 3

EditorInfo

---

Kotlin |Java

open class EditorInfo : InputType, Parcelable

kotlin.Any
↳	android.view.inputmethod.EditorInfo

An EditorInfo describes several attributes of a text editing object that an input method is communicating with (typically an EditText), most importantly the type of text content it contains and the current cursor position.

Summary

Constants
static Int	IME_ACTION_DONE Bits of IME_MASK_ACTION: the action key performs a "done" operation, typically meaning there is nothing more to input and the IME will be closed.
static Int	IME_ACTION_GO Bits of IME_MASK_ACTION: the action key performs a "go" operation to take the user to the target of the text they typed.
static Int	IME_ACTION_NEXT Bits of IME_MASK_ACTION: the action key performs a "next" operation, taking the user to the next field that will accept text.
static Int	IME_ACTION_NONE Bits of IME_MASK_ACTION: there is no available action.
static Int	IME_ACTION_PREVIOUS Bits of IME_MASK_ACTION: like IME_ACTION_NEXT, but for moving to the previous field.
static Int	IME_ACTION_SEARCH Bits of IME_MASK_ACTION: the action key performs a "search" operation, taking the user to the results of searching for the text they have typed (in whatever context is appropriate).
static Int	IME_ACTION_SEND Bits of IME_MASK_ACTION: the action key performs a "send" operation, delivering the text to its target.
static Int	IME_ACTION_UNSPECIFIED Bits of IME_MASK_ACTION: no specific action has been associated with this editor, let the editor come up with its own if it can.
static Int	IME_FLAG_FORCE_ASCII Flag of imeOptions: used to request an IME that is capable of inputting ASCII characters.
static Int	IME_FLAG_NAVIGATE_NEXT Flag of imeOptions: used to specify that there is something interesting that a forward navigation can focus on.
static Int	IME_FLAG_NAVIGATE_PREVIOUS Flag of imeOptions: like IME_FLAG_NAVIGATE_NEXT, but specifies there is something interesting that a backward navigation can focus on.
static Int	IME_FLAG_NO_ACCESSORY_ACTION Flag of imeOptions: used in conjunction with one of the actions masked by IME_MASK_ACTION, this indicates that the action should not be available as an accessory button on the right of the extracted text when the input method is full-screen.
static Int	IME_FLAG_NO_ENTER_ACTION Flag of imeOptions: used in conjunction with one of the actions masked by IME_MASK_ACTION.
static Int	IME_FLAG_NO_EXTRACT_UI Flag of imeOptions: used to specify that the IME does not need to show its extracted text UI.
static Int	IME_FLAG_NO_FULLSCREEN Flag of imeOptions: used to request that the IME never go into fullscreen mode.
static Int	IME_FLAG_NO_PERSONALIZED_LEARNING Flag of imeOptions: used to request that the IME should not update any personalized data such as typing history and personalized language model based on what the user typed on this text editing object.
static Int	IME_MASK_ACTION Set of bits in imeOptions that provide alternative actions associated with the "enter" key.
static Int	IME_NULL Generic unspecified type for imeOptions.

Inherited constants
From class Parcelable Int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. Int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.
From class InputType Int TYPE_CLASS_DATETIME Class for dates and times. It supports the following variations: TYPE_DATETIME_VARIATION_NORMAL TYPE_DATETIME_VARIATION_DATE, and TYPE_DATETIME_VARIATION_TIME. Int TYPE_CLASS_NUMBER Class for numeric text. This class supports the following flags: TYPE_NUMBER_FLAG_SIGNED and TYPE_NUMBER_FLAG_DECIMAL. It also supports the following variations: TYPE_NUMBER_VARIATION_NORMAL and TYPE_NUMBER_VARIATION_PASSWORD. IME authors: If you do not recognize the variation, normal should be assumed. Int TYPE_CLASS_PHONE Class for a phone number. This class currently supports no variations or flags. Int TYPE_CLASS_TEXT Class for normal text. This class supports the following flags (only one of which should be set): TYPE_TEXT_FLAG_CAP_CHARACTERS, TYPE_TEXT_FLAG_CAP_WORDS, and. TYPE_TEXT_FLAG_CAP_SENTENCES. It also supports the following variations: TYPE_TEXT_VARIATION_NORMAL, and TYPE_TEXT_VARIATION_URI. If you do not recognize the variation, normal should be assumed. Int TYPE_DATETIME_VARIATION_DATE Default variation of TYPE_CLASS_DATETIME: allows entering only a date. Int TYPE_DATETIME_VARIATION_NORMAL Default variation of TYPE_CLASS_DATETIME: allows entering both a date and time. Int TYPE_DATETIME_VARIATION_TIME Default variation of TYPE_CLASS_DATETIME: allows entering only a time. Int TYPE_MASK_CLASS Mask of bits that determine the overall class of text being given. Currently supported classes are: TYPE_CLASS_TEXT, TYPE_CLASS_NUMBER, TYPE_CLASS_PHONE, TYPE_CLASS_DATETIME. IME authors: If the class is not one you understand, assume TYPE_CLASS_TEXT with NO variation or flags. Int TYPE_MASK_FLAGS Mask of bits that provide addition bit flags of options. Int TYPE_MASK_VARIATION Mask of bits that determine the variation of the base content class. Int TYPE_NULL Special content type for when no explicit type has been specified. This should be interpreted to mean that the target input connection is not rich, it can not process and show things like candidate text nor retrieve the current text, so the input method will need to run in a limited "generate key events" mode, if it supports it. Note that some input methods may not support it, for example a voice-based input method will likely not be able to generate key events even if this flag is set. Int TYPE_NUMBER_FLAG_DECIMAL Flag of TYPE_CLASS_NUMBER: the number is decimal, allowing a decimal point to provide fractional values. Int TYPE_NUMBER_FLAG_SIGNED Flag of TYPE_CLASS_NUMBER: the number is signed, allowing a positive or negative sign at the start. Int TYPE_NUMBER_VARIATION_NORMAL Default variation of TYPE_CLASS_NUMBER: plain normal numeric text. This was added in android.os.Build.VERSION_CODES#HONEYCOMB. An IME must target this API version or later to see this input type; if it doesn't, a request for this type will be dropped when passed through EditorInfo.makeCompatible(int). Int TYPE_NUMBER_VARIATION_PASSWORD Variation of TYPE_CLASS_NUMBER: entering a numeric password. This was added in android.os.Build.VERSION_CODES#HONEYCOMB. An IME must target this API version or later to see this input type; if it doesn't, a request for this type will be dropped when passed through EditorInfo.makeCompatible(int). Int TYPE_TEXT_FLAG_AUTO_COMPLETE Flag for TYPE_CLASS_TEXT: the text editor (which means the application) is performing auto-completion of the text being entered based on its own semantics, which it will present to the user as they type. This generally means that the input method should not be showing candidates itself, but can expect the editor to supply its own completions/candidates from InputMethodSession.displayCompletions() as a result of the editor calling InputMethodManager.displayCompletions(). Note the contrast with TYPE_TEXT_FLAG_AUTO_CORRECT and TYPE_TEXT_FLAG_NO_SUGGESTIONS: TYPE_TEXT_FLAG_AUTO_COMPLETE means the editor should show an interface for displaying suggestions, but instead of supplying its own it will rely on the Editor to pass completions/corrections. Int TYPE_TEXT_FLAG_AUTO_CORRECT Flag for TYPE_CLASS_TEXT: the user is entering free-form text that should have auto-correction applied to it. Without this flag, the IME will not try to correct typos. You should always set this flag unless you really expect users to type non-words in this field, for example to choose a name for a character in a game. Contrast this with TYPE_TEXT_FLAG_AUTO_COMPLETE and TYPE_TEXT_FLAG_NO_SUGGESTIONS: TYPE_TEXT_FLAG_AUTO_CORRECT means that the IME will try to auto-correct typos as the user is typing, but does not define whether the IME offers an interface to show suggestions. Int TYPE_TEXT_FLAG_CAP_CHARACTERS Flag for TYPE_CLASS_TEXT: capitalize all characters. Overrides TYPE_TEXT_FLAG_CAP_WORDS and TYPE_TEXT_FLAG_CAP_SENTENCES. This value is explicitly defined to be the same as TextUtils#CAP_MODE_CHARACTERS. Of course, this only affects languages where there are upper-case and lower-case letters. Int TYPE_TEXT_FLAG_CAP_SENTENCES Flag for TYPE_CLASS_TEXT: capitalize the first character of each sentence. This value is explicitly defined to be the same as TextUtils#CAP_MODE_SENTENCES. For example in English it means to capitalize after a period and a space (note that other languages may have different characters for period, or not use spaces, or use different grammatical rules). Of course, this only affects languages where there are upper-case and lower-case letters. Int TYPE_TEXT_FLAG_CAP_WORDS Flag for TYPE_CLASS_TEXT: capitalize the first character of every word. Overrides TYPE_TEXT_FLAG_CAP_SENTENCES. This value is explicitly defined to be the same as TextUtils#CAP_MODE_WORDS. Of course, this only affects languages where there are upper-case and lower-case letters. Int TYPE_TEXT_FLAG_ENABLE_TEXT_CONVERSION_SUGGESTIONS Flag for TYPE_CLASS_TEXT: Let the IME know the text conversion suggestions are required by the application. Text conversion suggestion is for the transliteration languages which has pronunciation characters and target characters. When the user is typing the pronunciation charactes, the IME could provide the possible target characters to the user. When this flag is set, the IME should insert the text conversion suggestions through Builder#setTextConversionSuggestions(List) and the TextAttribute with initialized with the text conversion suggestions is provided by the IME to the application. To receive the additional information, the application needs to implement InputConnection#setComposingText(CharSequence, int, TextAttribute), InputConnection#setComposingRegion(int, int, TextAttribute), and InputConnection#commitText(CharSequence, int, TextAttribute). Int TYPE_TEXT_FLAG_IME_MULTI_LINE Flag for TYPE_CLASS_TEXT: the regular text view associated with this should not be multi-line, but when a fullscreen input method is providing text it should use multiple lines if it can. Int TYPE_TEXT_FLAG_MULTI_LINE Flag for TYPE_CLASS_TEXT: multiple lines of text can be entered into the field. If this flag is not set, the text field will be constrained to a single line. The IME may also choose not to display an enter key when this flag is not set, as there should be no need to create new lines. Int TYPE_TEXT_FLAG_NO_SUGGESTIONS Flag for TYPE_CLASS_TEXT: the input method does not need to display any dictionary-based candidates. This is useful for text views that do not contain words from the language and do not benefit from any dictionary-based completions or corrections. It overrides the TYPE_TEXT_FLAG_AUTO_CORRECT value when set. Please avoid using this unless you are certain this is what you want. Many input methods need suggestions to work well, for example the ones based on gesture typing. Consider clearing TYPE_TEXT_FLAG_AUTO_CORRECT instead if you just do not want the IME to correct typos. Note the contrast with TYPE_TEXT_FLAG_AUTO_CORRECT and TYPE_TEXT_FLAG_AUTO_COMPLETE: TYPE_TEXT_FLAG_NO_SUGGESTIONS means the IME does not need to show an interface to display suggestions. Most IMEs will also take this to mean they do not need to try to auto-correct what the user is typing. Int TYPE_TEXT_VARIATION_EMAIL_ADDRESS Variation of TYPE_CLASS_TEXT: entering an e-mail address. Int TYPE_TEXT_VARIATION_EMAIL_SUBJECT Variation of TYPE_CLASS_TEXT: entering the subject line of an e-mail. Int TYPE_TEXT_VARIATION_FILTER Variation of TYPE_CLASS_TEXT: entering text to filter contents of a list etc. Int TYPE_TEXT_VARIATION_LONG_MESSAGE Variation of TYPE_CLASS_TEXT: entering the content of a long, possibly formal message such as the body of an e-mail. Int TYPE_TEXT_VARIATION_NORMAL Default variation of TYPE_CLASS_TEXT: plain old normal text. Int TYPE_TEXT_VARIATION_PASSWORD Variation of TYPE_CLASS_TEXT: entering a password. Int TYPE_TEXT_VARIATION_PERSON_NAME Variation of TYPE_CLASS_TEXT: entering the name of a person. Int TYPE_TEXT_VARIATION_PHONETIC Variation of TYPE_CLASS_TEXT: entering text for phonetic pronunciation, such as a phonetic name field in contacts. This is mostly useful for languages where one spelling may have several phonetic readings, like Japanese. Int TYPE_TEXT_VARIATION_POSTAL_ADDRESS Variation of TYPE_CLASS_TEXT: entering a postal mailing address. Int TYPE_TEXT_VARIATION_SHORT_MESSAGE Variation of TYPE_CLASS_TEXT: entering a short, possibly informal message such as an instant message or a text message. Int TYPE_TEXT_VARIATION_URI Variation of TYPE_CLASS_TEXT: entering a URI. Int TYPE_TEXT_VARIATION_VISIBLE_PASSWORD Variation of TYPE_CLASS_TEXT: entering a password, which should be visible to the user. Int TYPE_TEXT_VARIATION_WEB_EDIT_TEXT Variation of TYPE_CLASS_TEXT: entering text inside of a web form. Int TYPE_TEXT_VARIATION_WEB_EMAIL_ADDRESS Variation of TYPE_CLASS_TEXT: entering e-mail address inside of a web form. This was added in android.os.Build.VERSION_CODES#HONEYCOMB. An IME must target this API version or later to see this input type; if it doesn't, a request for this type will be seen as TYPE_TEXT_VARIATION_EMAIL_ADDRESS when passed through EditorInfo.makeCompatible(int). Int TYPE_TEXT_VARIATION_WEB_PASSWORD Variation of TYPE_CLASS_TEXT: entering password inside of a web form. This was added in android.os.Build.VERSION_CODES#HONEYCOMB. An IME must target this API version or later to see this input type; if it doesn't, a request for this type will be seen as TYPE_TEXT_VARIATION_PASSWORD when passed through EditorInfo.makeCompatible(int).

Public constructors
EditorInfo()

Public methods
open Int	describeContents()
open Unit	dump(pw: Printer!, prefix: String!) Write debug output of this object.
open CharSequence?	getInitialSelectedText(flags: Int) Gets the selected text, if any.
open SurroundingText?	getInitialSurroundingText(beforeLength: Int, afterLength: Int, flags: Int) Gets the surrounding text around the current cursor, with beforeLength characters of text before the cursor (start of the selection), afterLength characters of text after the cursor (end of the selection), and all of the selected text.
open CharSequence?	getInitialTextAfterCursor(length: Int, flags: Int) Get length characters of text after the current cursor position.
open CharSequence?	getInitialTextBeforeCursor(length: Int, flags: Int) Get length characters of text before the current cursor position.
open Int	getInitialToolType() Returns the initial MotionEvent#ACTION_UP tool type MotionEvent#getToolType(int) responsible for focus on the current editor.
open MutableSet<Class<out PreviewableHandwritingGesture!>!>	getSupportedHandwritingGesturePreviews() Returns the combination of Stylus handwriting gesture preview types supported by the current Editor.
open MutableList<Class<out HandwritingGesture!>!>	getSupportedHandwritingGestures() Returns the combination of Stylus handwriting gesture types supported by the current Editor.
open Boolean	isStylusHandwritingEnabled() Returns true when an Editor has stylus handwriting enabled.
Unit	makeCompatible(targetSdkVersion: Int) Ensure that the data in this EditorInfo is compatible with an application that was developed against the given target API version.
open Unit	setInitialSurroundingSubText(subText: CharSequence, subTextStart: Int) Editors may use this method to provide initial input text to IMEs.
open Unit	setInitialSurroundingText(sourceText: CharSequence) Editors may use this method to provide initial input text to IMEs.
open Unit	setInitialToolType(toolType: Int) Set the initial MotionEvent#ACTION_UP tool type MotionEvent#getToolType(int).
open Unit	setStylusHandwritingEnabled(enabled: Boolean) Set true if the Editor has stylus handwriting enabled.
open Unit	setSupportedHandwritingGesturePreviews(gestures: MutableSet<Class<out PreviewableHandwritingGesture!>!>) Set the Handwriting gesture previews supported by the current Editor.
open Unit	setSupportedHandwritingGestures(gestures: MutableList<Class<out HandwritingGesture!>!>) Set the Handwriting gestures supported by the current Editor.
open Unit	writeToParcel(dest: Parcel, flags: Int) Used to package this object into a Parcel.

Properties
static Parcelable.Creator<EditorInfo!>	CREATOR Used to make this class parcelable.
Int	actionId If actionLabel has been given, this is the id for that command when the user presses its button that is delivered back with InputConnection.performEditorAction().
CharSequence!	actionLabel In some cases an IME may be able to display an arbitrary label for a command the user can perform, which you can specify here.
Array<String!>?	contentMimeTypes List of acceptable MIME types for InputConnection#commitContent(InputContentInfo, int, Bundle).
Bundle!	extras Any extra data to supply to the input method.
Int	fieldId Identifier for the editor's field.
String!	fieldName Additional name for the editor's field.
LocaleList?	hintLocales List of the languages that the user is supposed to switch to no matter what input method subtype is currently used.
CharSequence!	hintText The "hint" text of the text view, typically shown in-line when the text is empty to tell the user what to enter.
Int	imeOptions Extended type information for the editor, to help the IME better integrate with it.
Int	initialCapsMode The capitalization mode of the first character being edited in the text.
Int	initialSelEnd The text offset of the end of the selection at the time editing begins; -1 if not known.
Int	initialSelStart The text offset of the start of the selection at the time editing begins; -1 if not known.
Int	inputType The content type of the text box, whose bits are defined by InputType.
CharSequence!	label A label to show to the user describing the text they are writing.
String!	packageName Name of the package that owns this editor.
String!	privateImeOptions A string supplying additional information options that are private to a particular IME implementation.

Constants

IME_ACTION_DONE

Added in API level 3

static val IME_ACTION_DONE: Int

Bits of IME_MASK_ACTION: the action key performs a "done" operation, typically meaning there is nothing more to input and the IME will be closed.

Value: 6

IME_ACTION_GO

Added in API level 3

static val IME_ACTION_GO: Int

Bits of IME_MASK_ACTION: the action key performs a "go" operation to take the user to the target of the text they typed. Typically used, for example, when entering a URL.

Value: 2

IME_ACTION_NEXT

Added in API level 3

static val IME_ACTION_NEXT: Int

Bits of IME_MASK_ACTION: the action key performs a "next" operation, taking the user to the next field that will accept text.

Value: 5

IME_ACTION_NONE

Added in API level 3

static val IME_ACTION_NONE: Int

Bits of IME_MASK_ACTION: there is no available action.

Value: 1

IME_ACTION_PREVIOUS

Added in API level 11

static val IME_ACTION_PREVIOUS: Int

Bits of IME_MASK_ACTION: like IME_ACTION_NEXT, but for moving to the previous field. This will normally not be used to specify an action (since it precludes IME_ACTION_NEXT), but can be returned to the app if it sets IME_FLAG_NAVIGATE_PREVIOUS.

Value: 7

IME_ACTION_SEARCH

Added in API level 3

static val IME_ACTION_SEARCH: Int

Bits of IME_MASK_ACTION: the action key performs a "search" operation, taking the user to the results of searching for the text they have typed (in whatever context is appropriate).

Value: 3

IME_ACTION_SEND

Added in API level 3

static val IME_ACTION_SEND: Int

Bits of IME_MASK_ACTION: the action key performs a "send" operation, delivering the text to its target. This is typically used when composing a message in IM or SMS where sending is immediate.

Value: 4

IME_ACTION_UNSPECIFIED

Added in API level 3

static val IME_ACTION_UNSPECIFIED: Int

Bits of IME_MASK_ACTION: no specific action has been associated with this editor, let the editor come up with its own if it can.

Value: 0

IME_FLAG_FORCE_ASCII

Added in API level 16

static val IME_FLAG_FORCE_ASCII: 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. A lot of the time, 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: -2147483648

IME_FLAG_NAVIGATE_NEXT

Added in API level 11

static val IME_FLAG_NAVIGATE_NEXT: Int

Flag of imeOptions: used to specify that there is something interesting that a forward navigation can focus on. This is like using IME_ACTION_NEXT, except allows the IME to be multiline (with an enter key) as well as provide forward navigation. Note that some IMEs may not be able to do this, especially when running on a small screen where there is little space. In that case it does not need to present a UI for this option. Like IME_ACTION_NEXT, if the user selects the IME's facility to forward navigate, this will show up in the application at InputConnection.performEditorAction(int).

Value: 134217728

IME_FLAG_NAVIGATE_PREVIOUS

Added in API level 11

static val IME_FLAG_NAVIGATE_PREVIOUS: Int

Flag of imeOptions: like IME_FLAG_NAVIGATE_NEXT, but specifies there is something interesting that a backward navigation can focus on. If the user selects the IME's facility to backward navigate, this will show up in the application as an IME_ACTION_PREVIOUS at InputConnection.performEditorAction(int).

Value: 67108864

IME_FLAG_NO_ACCESSORY_ACTION

Added in API level 3

static val IME_FLAG_NO_ACCESSORY_ACTION: Int

Flag of imeOptions: used in conjunction with one of the actions masked by IME_MASK_ACTION, this indicates that the action should not be available as an accessory button on the right of the extracted text when the input method is full-screen. Note that by setting this flag, there can be cases where the action is simply never available to the user. Setting this generally means that you think that in fullscreen mode, where there is little space to show the text, it's not worth taking some screen real estate to display the action and it should be used instead to show more text.

Value: 536870912

IME_FLAG_NO_ENTER_ACTION

Added in API level 3

static val IME_FLAG_NO_ENTER_ACTION: Int

Flag of imeOptions: used in conjunction with one of the actions masked by IME_MASK_ACTION. If this flag is not set, IMEs will normally replace the "enter" key with the action supplied. This flag indicates that the action should not be available in-line as a replacement for the "enter" key. Typically this is because the action has such a significant impact or is not recoverable enough that accidentally hitting it should be avoided, such as sending a message. Note that android.widget.TextView will automatically set this flag for you on multi-line text views.

Value: 1073741824

IME_FLAG_NO_EXTRACT_UI

Added in API level 3

static val IME_FLAG_NO_EXTRACT_UI: Int

Flag of imeOptions: used to specify that the IME does not need to show its extracted text UI. For input methods that may be fullscreen, often when in landscape mode, this allows them to be smaller and let part of the application be shown behind, through transparent UI parts in the fullscreen IME. The part of the UI visible to the user may not be responsive to touch because the IME will receive touch events, which may confuse the user; use IME_FLAG_NO_FULLSCREEN instead for a better experience. Using this flag is discouraged and it may become deprecated in the future. Its meaning is unclear in some situations and it may not work appropriately on older versions of the platform.

Value: 268435456

IME_FLAG_NO_FULLSCREEN

Added in API level 11

static val IME_FLAG_NO_FULLSCREEN: Int

Flag of imeOptions: used to request that the IME never go into fullscreen mode. By default, IMEs may go into full screen mode when they think it's appropriate, for example on small screens in landscape orientation where displaying a software keyboard may occlude such a large portion of the screen that the remaining part is too small to meaningfully display the application UI. If this flag is set, compliant IMEs will never go into full screen mode, and always leave some space to display the application UI. Applications need to be aware that the flag is not a guarantee, and some IMEs may ignore it.

Value: 33554432

IME_FLAG_NO_PERSONALIZED_LEARNING

Added in API level 26

static val IME_FLAG_NO_PERSONALIZED_LEARNING: Int

Flag of imeOptions: used to request that the IME should 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: 16777216

IME_MASK_ACTION

Added in API level 3

static val IME_MASK_ACTION: Int

Set of bits in imeOptions that provide alternative actions associated with the "enter" key. This both helps the IME provide better feedback about what the enter key will do, and also allows it to provide alternative mechanisms for providing that command.

Value: 255

IME_NULL

Added in API level 3

static val IME_NULL: Int

Generic unspecified type for imeOptions.

Value: 0

Public constructors

EditorInfo

EditorInfo()

Public methods

describeContents

Added in API level 3

open fun describeContents(): Int

Return
Int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

dump

Added in API level 3

open fun dump(
    pw: Printer!, 
    prefix: String!
): Unit

Write debug output of this object.

getInitialSelectedText

Added in API level 30

open fun getInitialSelectedText(flags: Int): CharSequence?

Gets the selected text, if any. May be null when the protocol is not supported 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. Value is either 0 or android.view.inputmethod.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.

getInitialSurroundingText

Added in API level 31

open fun getInitialSurroundingText(
    beforeLength: Int, 
    afterLength: Int, 
    flags: Int
): SurroundingText?

Gets the surrounding text around the current cursor, with beforeLength characters of text before the cursor (start of the selection), afterLength characters of text after the cursor (end of the selection), and all of the selected text.

The initial surrounding text for return could be trimmed if oversize. Fundamental trimming rules are:

• The text before the cursor is the most important information to IMEs.
• The text after the cursor is the second important information to IMEs.
• The selected text is the least important information but it shall NEVER be truncated. When it is too long, just drop it.

For example, the subText can be viewed as TextBeforeCursor + Selection + TextAfterCursor. The result could be:

1. (maybeTrimmedAtHead)TextBeforeCursor + Selection + TextAfterCursor(maybeTrimmedAtTail)
2. (maybeTrimmedAtHead)TextBeforeCursor + TextAfterCursor(maybeTrimmedAtTail)

Parameters
beforeLength	Int: The expected length of the text before the cursor. Value is 0 or greater
afterLength	Int: The expected length of the text after the cursor. Value is 0 or greater
flags	Int: Supplies additional options controlling how the text is returned. May be either 0 or InputConnection#GET_TEXT_WITH_STYLES. Value is either 0 or android.view.inputmethod.InputConnection#GET_TEXT_WITH_STYLES

Return
SurroundingText?	an android.view.inputmethod.SurroundingText object describing the surrounding text and state of selection, or null if the editor or system could not support this protocol.

Exceptions
java.lang.IllegalArgumentException	if beforeLength or afterLength is negative.

getInitialTextAfterCursor

Added in API level 30

open fun getInitialTextAfterCursor(
    length: Int, 
    flags: Int
): CharSequence?

Get length 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. Value is 0 or greater
flags	Int: Supplies additional options controlling how the text is returned. May be either 0 or InputConnection#GET_TEXT_WITH_STYLES. Value is either 0 or android.view.inputmethod.InputConnection#GET_TEXT_WITH_STYLES

Return
CharSequence?	the text after the cursor position; the length of the returned text might be less than length. 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

Added in API level 30

open fun getInitialTextBeforeCursor(
    length: Int, 
    flags: Int
): CharSequence?

Get length 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. Value is 0 or greater
flags	Int: Supplies additional options controlling how the text is returned. May be either 0 or InputConnection#GET_TEXT_WITH_STYLES. Value is either 0 or android.view.inputmethod.InputConnection#GET_TEXT_WITH_STYLES

Return
CharSequence?	the text before the cursor position; the length of the returned text might be less than length. 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.

getInitialToolType

Added in API level 34

open fun getInitialToolType(): Int

Returns the initial MotionEvent#ACTION_UP tool type MotionEvent#getToolType(int) responsible for focus on the current editor.

Return
Int	toolType MotionEvent#getToolType(int). Value is android.view.MotionEvent#TOOL_TYPE_UNKNOWN, android.view.MotionEvent#TOOL_TYPE_FINGER, android.view.MotionEvent#TOOL_TYPE_STYLUS, android.view.MotionEvent#TOOL_TYPE_MOUSE, android.view.MotionEvent#TOOL_TYPE_ERASER, or android.view.MotionEvent.TOOL_TYPE_PALM

See Also

• #setInitialToolType(int)
• android.view.MotionEvent#getToolType(int)
• android.inputmethodservice.InputMethodService#onUpdateEditorToolType(int)

getSupportedHandwritingGesturePreviews

Added in API level 34

open fun getSupportedHandwritingGesturePreviews(): MutableSet<Class<out PreviewableHandwritingGesture!>!>

Returns the combination of Stylus handwriting gesture preview types supported by the current Editor. For an editor that supports Stylus Handwriting. InputMethodManager#startStylusHandwriting, it also declares supported gesture previews.

Note: A supported gesture EditorInfo#getSupportedHandwritingGestures() may not have preview supported EditorInfo#getSupportedHandwritingGesturePreviews().

Return
MutableSet<Class<out PreviewableHandwritingGesture!>!>	Set of supported gesture preview classes. One of SelectGesture, SelectRangeGesture, DeleteGesture, DeleteRangeGesture. This value cannot be null.

See Also

• #getSupportedHandwritingGestures()

getSupportedHandwritingGestures

Added in API level 34

open fun getSupportedHandwritingGestures(): MutableList<Class<out HandwritingGesture!>!>

Returns the combination of Stylus handwriting gesture types supported by the current Editor. For an editor that supports Stylus Handwriting. InputMethodManager#startStylusHandwriting, it also declares supported gestures.

Return
MutableList<Class<out HandwritingGesture!>!>	List of supported gesture classes including any of SelectGesture, InsertGesture, DeleteGesture. This value cannot be null.

See Also

• #getSupportedHandwritingGesturePreviews()

isStylusHandwritingEnabled

Added in API level 35

open fun isStylusHandwritingEnabled(): Boolean

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

See Also

• #setStylusHandwritingEnabled(boolean)
• android.view.inputmethod.InputMethodManager#isStylusHandwritingAvailable()

makeCompatible

Added in API level 11

fun makeCompatible(targetSdkVersion: Int): Unit

Ensure that the data in this EditorInfo is compatible with an application that was developed against the given target API version. This can impact the following input types: InputType#TYPE_TEXT_VARIATION_WEB_EMAIL_ADDRESS, InputType#TYPE_TEXT_VARIATION_WEB_PASSWORD, InputType#TYPE_NUMBER_VARIATION_NORMAL, InputType#TYPE_NUMBER_VARIATION_PASSWORD.

This is called by the framework for input method implementations; you should not generally need to call it yourself.

Parameters
targetSdkVersion	Int: The API version number that the compatible application was developed against.

setInitialSurroundingSubText

Added in API level 30

open fun setInitialSurroundingSubText(
    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. Starting from VERSION_CODES#S, spans that do not implement Parcelable will be automatically dropped.

Parameters
subText	CharSequence: The input text. When it was trimmed, subTextStart must be provided correctly. This value cannot be null.
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

Added in API level 30

open fun setInitialSurroundingText(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. Starting from VERSION_CODES#S, spans that do not implement Parcelable will be automatically dropped.

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. This value cannot be null.

setInitialToolType

Added in API level 34

open fun setInitialToolType(toolType: Int): Unit

Set the initial MotionEvent#ACTION_UP tool type MotionEvent#getToolType(int). that brought focus to the view.

Parameters
toolType	Int: Value is android.view.MotionEvent#TOOL_TYPE_UNKNOWN, android.view.MotionEvent#TOOL_TYPE_FINGER, android.view.MotionEvent#TOOL_TYPE_STYLUS, android.view.MotionEvent#TOOL_TYPE_MOUSE, android.view.MotionEvent#TOOL_TYPE_ERASER, or android.view.MotionEvent.TOOL_TYPE_PALM

See Also

• #getInitialToolType()
• android.view.MotionEvent#getToolType(int)
• android.inputmethodservice.InputMethodService#onUpdateEditorToolType(int)

setStylusHandwritingEnabled

Added in API level 35

open fun setStylusHandwritingEnabled(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.

Parameters
enabled	Boolean: true if stylus handwriting is enabled.

See Also

• android.view.View#setAutoHandwritingEnabled(boolean)

setSupportedHandwritingGesturePreviews

Added in API level 34

open fun setSupportedHandwritingGesturePreviews(gestures: MutableSet<Class<out PreviewableHandwritingGesture!>!>): Unit

Set the Handwriting gesture previews supported by the current Editor. For an editor that supports Stylus Handwriting InputMethodManager#startStylusHandwriting, it is also recommended that it declares supported gesture previews.

Note: A supported gesture EditorInfo#getSupportedHandwritingGestures() may not have preview supported EditorInfo#getSupportedHandwritingGesturePreviews().

If editor doesn't support one of the declared types, gesture preview will be ignored.

Parameters
gestures	MutableSet<Class<out PreviewableHandwritingGesture!>!>: Set of supported gesture classes. One of SelectGesture, SelectRangeGesture, DeleteGesture, DeleteRangeGesture. This value cannot be null.

See Also

• #setSupportedHandwritingGestures(List)

setSupportedHandwritingGestures

Added in API level 34

open fun setSupportedHandwritingGestures(gestures: MutableList<Class<out HandwritingGesture!>!>): Unit

Set the Handwriting gestures supported by the current Editor. For an editor that supports Stylus Handwriting InputMethodManager#startStylusHandwriting, it is also recommended that it declares supported gestures.

If editor doesn't support one of the declared types, IME will not send those Gestures to the editor. Instead they will fallback to using normal text input.

Note: A supported gesture may not have preview supported getSupportedHandwritingGesturePreviews().

Parameters
gestures	MutableList<Class<out HandwritingGesture!>!>: List of supported gesture classes including any of SelectGesture, InsertGesture, DeleteGesture. This value cannot be null.

See Also

• #setSupportedHandwritingGesturePreviews(Set)

writeToParcel

Added in API level 3

open fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Used to package this object into a Parcel.

Parameters
dest	Parcel: The Parcel to be written.
flags	Int: The flags used for parceling.

Properties

CREATOR

Added in API level 3

static val CREATOR: Parcelable.Creator<EditorInfo!>

Used to make this class parcelable.

actionId

Added in API level 3

var actionId: Int

If actionLabel has been given, this is the id for that command when the user presses its button that is delivered back with InputConnection.performEditorAction().

actionLabel

Added in API level 3

var actionLabel: CharSequence!

In some cases an IME may be able to display an arbitrary label for a command the user can perform, which you can specify here. This is typically used as the label for the action to use in-line as a replacement for the "enter" key (see actionId). Remember the key where this will be displayed is typically very small, and there are significant localization challenges to make this fit in all supported languages. Also you can not count absolutely on this being used, as some IMEs may ignore this.

contentMimeTypes

Added in API level 25

var contentMimeTypes: Array<String!>?

List of acceptable MIME types for InputConnection#commitContent(InputContentInfo, int, Bundle).

null or an empty array means that InputConnection#commitContent(InputContentInfo, int, Bundle) is not supported in this editor.

extras

Added in API level 3

var extras: Bundle!

Any extra data to supply to the input method. This is for extended communication with specific input methods; the name fields in the bundle should be scoped (such as "com.mydomain.im.SOME_FIELD") so that they don't conflict with others. This field can be filled in from the android.R.attr#editorExtras attribute of a TextView.

fieldId

Added in API level 3

var fieldId: Int

Identifier for the editor's field. This is optional, and may be 0. By default it is filled in with the result of View.getId() on the View that is being edited.

fieldName

Added in API level 3

var fieldName: String!

Additional name for the editor's field. This can supply additional name information for the field. By default it is null. The actual contents have no meaning.

hintLocales

Added in API level 24

var hintLocales: LocaleList?

List of the languages that the user is supposed to switch to no matter what input method subtype is currently used. This special "hint" can be used mainly for, but not limited to, multilingual users who want IMEs to switch language context automatically.

null means that no special language "hint" is needed.

Editor authors: Specify this only when you are confident that the user will switch to certain languages in this context no matter what input method subtype is currently selected. Otherwise, keep this null. Explicit user actions and/or preferences would be good signals to specify this special "hint", For example, a chat application may be able to put the last used language at the top of hintLocales based on whom the user is going to talk, by remembering what language is used in the last conversation. Do not specify android.widget.TextView#getTextLocales() only because it is used for text rendering.

See Also

• android.widget.TextView#setImeHintLocales(LocaleList)
• android.widget.TextView#getImeHintLocales()

hintText

Added in API level 3

var hintText: CharSequence!

The "hint" text of the text view, typically shown in-line when the text is empty to tell the user what to enter.

imeOptions

Added in API level 3

var imeOptions: Int

Extended type information for the editor, to help the IME better integrate with it.

initialCapsMode

Added in API level 3

var initialCapsMode: Int

The capitalization mode of the first character being edited in the text. Values may be any combination of TextUtils.CAP_MODE_CHARACTERS, TextUtils.CAP_MODE_WORDS, and TextUtils.CAP_MODE_SENTENCES, though you should generally just take a non-zero value to mean "start out in caps mode".

initialSelEnd

Added in API level 3

var initialSelEnd: Int

The text offset of the end of the selection at the time editing begins; -1 if not known. Keep in mind that, without knowing the cursor position, many IMEs will not be able to offer their full feature set and may behave in unpredictable ways: pass the actual cursor position here if possible at all.

Also, this needs to be the cursor position right now, not at some point in the past, even if input is starting in the same text field as before. When the app is filling this object, input is about to start by definition, and this value will override any value the app may have passed to InputMethodManager#updateSelection(android.view.View, int, int, int, int) before.

initialSelStart

Added in API level 3

var initialSelStart: Int

The text offset of the start of the selection at the time editing begins; -1 if not known. Keep in mind that, without knowing the cursor position, many IMEs will not be able to offer their full feature set and may even behave in unpredictable ways: pass the actual cursor position here if possible at all.

Also, this needs to be the cursor position right now, not at some point in the past, even if input is starting in the same text field as before. When the app is filling this object, input is about to start by definition, and this value will override any value the app may have passed to InputMethodManager#updateSelection(android.view.View, int, int, int, int) before.

inputType

Added in API level 3

var inputType: Int

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

See Also

• android.text.InputType
• #TYPE_MASK_CLASS
• #TYPE_MASK_VARIATION
• #TYPE_MASK_FLAGS

label

Added in API level 3

var label: CharSequence!

A label to show to the user describing the text they are writing.

packageName

Added in API level 3

var packageName: String!

Name of the package that owns this editor.

IME authors: In API level 22 android.os.Build.VERSION_CODES#LOLLIPOP_MR1 and prior, do not trust this package name. The system had not verified the consistency between the package name here and application's uid. Consider to use InputBinding#getUid(), which is trustworthy. Starting from android.os.Build.VERSION_CODES#M, the system verifies the consistency between this package name and application uid before EditorInfo is passed to the input method.

Editor authors: Starting from android.os.Build.VERSION_CODES#M, the application is no longer able to establish input connections if the package name provided here is inconsistent with application's uid.

privateImeOptions

Added in API level 3

var privateImeOptions: String!

A string supplying additional information options that are private to a particular IME implementation. The string must be scoped to a package owned by the implementation, to ensure there are no conflicts between implementations, but other than that you can put whatever you want in it to communicate with the IME. For example, you could have a string that supplies an argument like "com.example.myapp.SpecialMode=3". This field is can be filled in from the android.R.attr#privateImeOptions attribute of a TextView.