Added in API level 3

EditorInfo

Kotlin |Java

public class EditorInfo
extends Object implements InputType, Parcelable

java.lang.Object
↳	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
`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.
`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.
`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.
`int`	`IME_ACTION_NONE` Bits of `IME_MASK_ACTION`: there is no available action.
`int`	`IME_ACTION_PREVIOUS` Bits of `IME_MASK_ACTION`: like `IME_ACTION_NEXT`, but for moving to the previous field.
`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).
`int`	`IME_ACTION_SEND` Bits of `IME_MASK_ACTION`: the action key performs a "send" operation, delivering the text to its target.
`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.
`int`	`IME_FLAG_FORCE_ASCII` Flag of `imeOptions`: used to request an IME that is capable of inputting ASCII characters.
`int`	`IME_FLAG_NAVIGATE_NEXT` Flag of `imeOptions`: used to specify that there is something interesting that a forward navigation can focus on.
`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.
`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.
`int`	`IME_FLAG_NO_ENTER_ACTION` Flag of `imeOptions`: used in conjunction with one of the actions masked by `IME_MASK_ACTION`.
`int`	`IME_FLAG_NO_EXTRACT_UI` Flag of `imeOptions`: used to specify that the IME does not need to show its extracted text UI.
`int`	`IME_FLAG_NO_FULLSCREEN` Flag of `imeOptions`: used to request that the IME never go into fullscreen mode.
`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.
`int`	`IME_MASK_ACTION` Set of bits in `imeOptions` that provide alternative actions associated with the "enter" key.
`int`	`IME_NULL` Generic unspecified type for `imeOptions`.

Inherited constants

From interface android.text.InputType

`int`	`TYPE_CLASS_DATETIME` Class for dates and times.
`int`	`TYPE_CLASS_NUMBER` Class for numeric text.
`int`	`TYPE_CLASS_PHONE` Class for a phone number.
`int`	`TYPE_CLASS_TEXT` Class for normal text.
`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.
`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.
`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.
`int`	`TYPE_NUMBER_VARIATION_PASSWORD` Variation of `TYPE_CLASS_NUMBER`: entering a numeric password.
`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.
`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.
`int`	`TYPE_TEXT_FLAG_CAP_CHARACTERS` Flag for `TYPE_CLASS_TEXT`: capitalize all characters.
`int`	`TYPE_TEXT_FLAG_CAP_SENTENCES` Flag for `TYPE_CLASS_TEXT`: capitalize the first character of each sentence.
`int`	`TYPE_TEXT_FLAG_CAP_WORDS` Flag for `TYPE_CLASS_TEXT`: capitalize the first character of every word.
`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.
`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.
`int`	`TYPE_TEXT_FLAG_NO_SUGGESTIONS` Flag for `TYPE_CLASS_TEXT`: the input method does not need to display any dictionary-based candidates.
`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.
`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.
`int`	`TYPE_TEXT_VARIATION_WEB_PASSWORD` Variation of `TYPE_CLASS_TEXT`: entering password inside of a web form.

From interface android.os.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(Parcel, int)`: 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)`".

Fields
`public static final Creator<EditorInfo>`	`CREATOR` Used to make this class parcelable.
`public 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()`.
`public 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.
`public String[]`	`contentMimeTypes` List of acceptable MIME types for `InputConnection#commitContent(InputContentInfo, int, Bundle)`.
`public Bundle`	`extras` Any extra data to supply to the input method.
`public int`	`fieldId` Identifier for the editor's field.
`public String`	`fieldName` Additional name for the editor's field.
`public LocaleList`	`hintLocales` List of the languages that the user is supposed to switch to no matter what input method subtype is currently used.
`public 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.
`public int`	`imeOptions` Extended type information for the editor, to help the IME better integrate with it.
`public int`	`initialCapsMode` The capitalization mode of the first character being edited in the text.
`public int`	`initialSelEnd` The text offset of the end of the selection at the time editing begins; -1 if not known.
`public int`	`initialSelStart` The text offset of the start of the selection at the time editing begins; -1 if not known.
`public int`	`inputType` The content type of the text box, whose bits are defined by `InputType`.
`public CharSequence`	`label` A label to show to the user describing the text they are writing.
`public String`	`packageName` Name of the package that owns this editor.
`public String`	`privateImeOptions` A string supplying additional information options that are private to a particular IME implementation.

Public constructors
`EditorInfo()`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`void`	`dump(Printer pw, String prefix)` Write debug output of this object.
`CharSequence`	`getInitialSelectedText(int flags)` Gets the selected text, if any.
`SurroundingText`	`getInitialSurroundingText(int beforeLength, int afterLength, int flags)` 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.
`CharSequence`	`getInitialTextAfterCursor(int length, int flags)` Get `length` characters of text after the current cursor position.
`CharSequence`	`getInitialTextBeforeCursor(int length, int flags)` Get `length` characters of text before the current cursor position.
`int`	`getInitialToolType()` Returns the initial `MotionEvent#ACTION_UP` tool type `MotionEvent#getToolType(int)` responsible for focus on the current editor.
`Set<Class<? extends PreviewableHandwritingGesture>>`	`getSupportedHandwritingGesturePreviews()` Returns the combination of Stylus handwriting gesture preview types supported by the current `Editor`.
`List<Class<? extends HandwritingGesture>>`	`getSupportedHandwritingGestures()` Returns the combination of Stylus handwriting gesture types supported by the current `Editor`.
`boolean`	`isStylusHandwritingEnabled()` Returns `true` when an `Editor` has stylus handwriting enabled.
`final void`	`makeCompatible(int targetSdkVersion)` Ensure that the data in this EditorInfo is compatible with an application that was developed against the given target API version.
`void`	`setInitialSurroundingSubText(CharSequence subText, int subTextStart)` Editors may use this method to provide initial input text to IMEs.
`void`	`setInitialSurroundingText(CharSequence sourceText)` Editors may use this method to provide initial input text to IMEs.
`void`	`setInitialToolType(int toolType)` Set the initial `MotionEvent#ACTION_UP` tool type `MotionEvent#getToolType(int)`.
`void`	`setStylusHandwritingEnabled(boolean enabled)` Set `true` if the `Editor` has `stylus handwriting` enabled.
`void`	`setSupportedHandwritingGesturePreviews(Set<Class<? extends PreviewableHandwritingGesture>> gestures)` Set the Handwriting gesture previews supported by the current `Editor`.
`void`	`setSupportedHandwritingGestures(List<Class<? extends HandwritingGesture>> gestures)` Set the Handwriting gestures supported by the current `Editor`.
`void`	`writeToParcel(Parcel dest, int flags)` Used to package this object into a `Parcel`.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Constants

IME_ACTION_DONE

Added in API level 3

public static final 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.

Constant Value: 6 (0x00000006)

IME_ACTION_GO

Added in API level 3

public static final 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. Typically used, for example, when entering a URL.

Constant Value: 2 (0x00000002)

IME_ACTION_NEXT

Added in API level 3

public static final 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.

Constant Value: 5 (0x00000005)

IME_ACTION_NONE

Added in API level 3

public static final int IME_ACTION_NONE

Bits of IME_MASK_ACTION: there is no available action.

Constant Value: 1 (0x00000001)

IME_ACTION_PREVIOUS

Added in API level 11

public static final int IME_ACTION_PREVIOUS

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.

Constant Value: 7 (0x00000007)

IME_ACTION_SEARCH

Added in API level 3

public static final 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).

Constant Value: 3 (0x00000003)

IME_ACTION_SEND

Added in API level 3

public static final int IME_ACTION_SEND

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.

Constant Value: 4 (0x00000004)

IME_ACTION_UNSPECIFIED

Added in API level 3

public static final 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.

Constant Value: 0 (0x00000000)

IME_FLAG_FORCE_ASCII

Added in API level 16

public static final int IME_FLAG_FORCE_ASCII

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 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.

Constant Value: -2147483648 (0x80000000)

IME_FLAG_NAVIGATE_NEXT

Added in API level 11

public static final int IME_FLAG_NAVIGATE_NEXT

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).

Constant Value: 134217728 (0x08000000)

IME_FLAG_NAVIGATE_PREVIOUS

Added in API level 11

public static final 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. 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).

Constant Value: 67108864 (0x04000000)

IME_FLAG_NO_ACCESSORY_ACTION

Added in API level 3

public static final 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. 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.

Constant Value: 536870912 (0x20000000)

IME_FLAG_NO_ENTER_ACTION

Added in API level 3

public static final int IME_FLAG_NO_ENTER_ACTION

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 TextView will automatically set this flag for you on multi-line text views.

Constant Value: 1073741824 (0x40000000)

IME_FLAG_NO_EXTRACT_UI

Added in API level 3

public static final int IME_FLAG_NO_EXTRACT_UI

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.

Constant Value: 268435456 (0x10000000)

IME_FLAG_NO_FULLSCREEN

Added in API level 11

public static final int IME_FLAG_NO_FULLSCREEN

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.

Constant Value: 33554432 (0x02000000)

IME_FLAG_NO_PERSONALIZED_LEARNING

Added in API level 26

public static final 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. 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.

Constant Value: 16777216 (0x01000000)

IME_MASK_ACTION

Added in API level 3

public static final int IME_MASK_ACTION

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.

Constant Value: 255 (0x000000ff)

IME_NULL

Added in API level 3

public static final int IME_NULL

Generic unspecified type for imeOptions.

Constant Value: 0 (0x00000000)

Fields

CREATOR

Added in API level 3

public static final Creator<EditorInfo> CREATOR

Used to make this class parcelable.

actionId

Added in API level 3

public 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().

actionLabel

Added in API level 3

public 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. 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

public String[] contentMimeTypes

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

public Bundle extras

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 R.attr.editorExtras attribute of a TextView.

fieldId

Added in API level 3

public int fieldId

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

public String fieldName

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

public LocaleList hintLocales

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 TextView.getTextLocales() only because it is used for text rendering.

See also:

hintText

Added in API level 3

public 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.

imeOptions

Added in API level 3

public int imeOptions

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

initialCapsMode

Added in API level 3

public int initialCapsMode

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

public int initialSelEnd

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

public int initialSelStart

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.

inputType

Added in API level 3

public int inputType

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

See also:

label

Added in API level 3

public CharSequence label

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

packageName

Added in API level 3

public String packageName

Name of the package that owns this editor.

IME authors: In API level 22 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 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 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

public String privateImeOptions

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 R.attr.privateImeOptions attribute of a TextView.

Public constructors

EditorInfo

public EditorInfo ()

Public methods

describeContents

Added in API level 3

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

dump

Added in API level 3

public void dump (Printer pw, 
                String prefix)

Write debug output of this object.

Parameters
`pw`	`Printer`
`prefix`	`String`

getInitialSelectedText

Added in API level 30

public CharSequence getInitialSelectedText (int flags)

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 `InputConnection.GET_TEXT_WITH_STYLES`

Returns
`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

public SurroundingText getInitialSurroundingText (int beforeLength, 
                int afterLength, 
                int flags)

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:

(maybeTrimmedAtHead)TextBeforeCursor + Selection + TextAfterCursor(maybeTrimmedAtTail)
(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 `InputConnection.GET_TEXT_WITH_STYLES`

Returns
`SurroundingText`	an `SurroundingText` object describing the surrounding text and state of selection, or `null` if the editor or system could not support this protocol.

Throws
`IllegalArgumentException`	if `beforeLength` or `afterLength` is negative.

getInitialTextAfterCursor

Added in API level 30

public CharSequence getInitialTextAfterCursor (int length, 
                int flags)

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 `InputConnection.GET_TEXT_WITH_STYLES`

Returns
`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

public CharSequence getInitialTextBeforeCursor (int length, 
                int flags)

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 `InputConnection.GET_TEXT_WITH_STYLES`

Returns
`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

public int getInitialToolType ()

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

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

See also:

getSupportedHandwritingGesturePreviews

Added in API level 34

public Set<Class<? extends PreviewableHandwritingGesture>> getSupportedHandwritingGesturePreviews ()

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().

Returns
`Set<Class<? extends 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

public List<Class<? extends HandwritingGesture>> getSupportedHandwritingGestures ()

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.

Returns
`List<Class<? extends 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

public boolean isStylusHandwritingEnabled ()

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

Returns
`boolean`

See also:

makeCompatible

Added in API level 11

public final void makeCompatible (int targetSdkVersion)

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

public void setInitialSurroundingSubText (CharSequence subText, 
                int subTextStart)

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

public void setInitialSurroundingText (CharSequence sourceText)

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

public void setInitialToolType (int toolType)

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

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

See also:

setStylusHandwritingEnabled

Added in API level 35

public void setStylusHandwritingEnabled (boolean enabled)

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:

View.setAutoHandwritingEnabled(boolean)

setSupportedHandwritingGesturePreviews

Added in API level 34

public void setSupportedHandwritingGesturePreviews (Set<Class<? extends PreviewableHandwritingGesture>> gestures)

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`	`Set`: 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

public void setSupportedHandwritingGestures (List<Class<? extends HandwritingGesture>> gestures)

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`	`List`: 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

public void writeToParcel (Parcel dest, 
                int flags)

Used to package this object into a Parcel.

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