InputConnection

CURSOR_UPDATE_FILTER_CHARACTER_BOUNDS

public static final int CURSOR_UPDATE_FILTER_CHARACTER_BOUNDS

The editor is requested to call InputMethodManager.updateCursorAnchorInfo(android.view.View, CursorAnchorInfo) with new character bounds CursorAnchorInfo.getCharacterBounds(int) whenever cursor/anchor position is changed. To disable monitoring, call InputConnection.requestCursorUpdates(int) again with this flag off.

This flag can be combined with other filters: CURSOR_UPDATE_FILTER_EDITOR_BOUNDS, CURSOR_UPDATE_FILTER_VISIBLE_LINE_BOUNDS, CURSOR_UPDATE_FILTER_TEXT_APPEARANCE, CURSOR_UPDATE_FILTER_INSERTION_MARKER and update flags CURSOR_UPDATE_IMMEDIATE and CURSOR_UPDATE_MONITOR.

Constant Value: 8 (0x00000008)

CURSOR_UPDATE_FILTER_EDITOR_BOUNDS

public static final int CURSOR_UPDATE_FILTER_EDITOR_BOUNDS

The editor is requested to call InputMethodManager.updateCursorAnchorInfo(android.view.View, CursorAnchorInfo) with new EditorBoundsInfo whenever cursor/anchor position is changed. To disable monitoring, call InputConnection.requestCursorUpdates(int) again with this flag off.

This flag can be used together with filters: CURSOR_UPDATE_FILTER_CHARACTER_BOUNDS, CURSOR_UPDATE_FILTER_VISIBLE_LINE_BOUNDS, CURSOR_UPDATE_FILTER_TEXT_APPEARANCE, CURSOR_UPDATE_FILTER_INSERTION_MARKER and update flags CURSOR_UPDATE_IMMEDIATE and CURSOR_UPDATE_MONITOR.

Constant Value: 4 (0x00000004)

CURSOR_UPDATE_FILTER_INSERTION_MARKER

public static final int CURSOR_UPDATE_FILTER_INSERTION_MARKER

The editor is requested to call InputMethodManager.updateCursorAnchorInfo(android.view.View, CursorAnchorInfo) with new Insertion marker info CursorAnchorInfo.getInsertionMarkerFlags(), CursorAnchorInfo.getInsertionMarkerBaseline(), etc whenever cursor/anchor position is changed. To disable monitoring, call InputConnection.requestCursorUpdates(int) again with this flag off.

This flag can be combined with other filters: CURSOR_UPDATE_FILTER_CHARACTER_BOUNDS, CURSOR_UPDATE_FILTER_VISIBLE_LINE_BOUNDS, CURSOR_UPDATE_FILTER_TEXT_APPEARANCE, CURSOR_UPDATE_FILTER_EDITOR_BOUNDS and update flags CURSOR_UPDATE_IMMEDIATE and CURSOR_UPDATE_MONITOR.

Constant Value: 16 (0x00000010)

CURSOR_UPDATE_FILTER_TEXT_APPEARANCE

public static final int CURSOR_UPDATE_FILTER_TEXT_APPEARANCE

The editor is requested to call InputMethodManager.updateCursorAnchorInfo(android.view.View, CursorAnchorInfo) with new text appearance info CursorAnchorInfo.getTextAppearanceInfo()} whenever cursor/anchor position is changed. To disable monitoring, call InputConnection.requestCursorUpdates(int) again with this flag off.

This flag can be combined with other filters: CURSOR_UPDATE_FILTER_CHARACTER_BOUNDS, CURSOR_UPDATE_FILTER_EDITOR_BOUNDS, CURSOR_UPDATE_FILTER_INSERTION_MARKER, CURSOR_UPDATE_FILTER_VISIBLE_LINE_BOUNDS and update flags CURSOR_UPDATE_IMMEDIATE and CURSOR_UPDATE_MONITOR.

Constant Value: 64 (0x00000040)

CURSOR_UPDATE_FILTER_VISIBLE_LINE_BOUNDS

public static final int CURSOR_UPDATE_FILTER_VISIBLE_LINE_BOUNDS

The editor is requested to call InputMethodManager.updateCursorAnchorInfo(android.view.View, CursorAnchorInfo) with new visible line bounds CursorAnchorInfo.getVisibleLineBounds() whenever cursor/anchor position is changed, the editor or its parent is scrolled or the line bounds changed due to text updates. To disable monitoring, call InputConnection.requestCursorUpdates(int) again with this flag off.

This flag can be combined with other filters: CURSOR_UPDATE_FILTER_CHARACTER_BOUNDS, CURSOR_UPDATE_FILTER_EDITOR_BOUNDS, CURSOR_UPDATE_FILTER_INSERTION_MARKER, CURSOR_UPDATE_FILTER_TEXT_APPEARANCE and update flags CURSOR_UPDATE_IMMEDIATE and CURSOR_UPDATE_MONITOR.

Constant Value: 32 (0x00000020)

CURSOR_UPDATE_IMMEDIATE

public static final int CURSOR_UPDATE_IMMEDIATE

The editor is requested to call InputMethodManager.updateCursorAnchorInfo(android.view.View, CursorAnchorInfo) at once, as soon as possible, regardless of cursor/anchor position changes. This flag can be used together with CURSOR_UPDATE_MONITOR.

Note by default all of CURSOR_UPDATE_FILTER_EDITOR_BOUNDS, CURSOR_UPDATE_FILTER_CHARACTER_BOUNDS, CURSOR_UPDATE_FILTER_VISIBLE_LINE_BOUNDS, CURSOR_UPDATE_FILTER_TEXT_APPEARANCE, and CURSOR_UPDATE_FILTER_INSERTION_MARKER, are included but specifying them can filter-out others. It can be CPU intensive to include all, filtering specific info is recommended.

Constant Value: 1 (0x00000001)

CURSOR_UPDATE_MONITOR

public static final int CURSOR_UPDATE_MONITOR

The editor is requested to call InputMethodManager.updateCursorAnchorInfo(android.view.View, CursorAnchorInfo) whenever cursor/anchor position is changed. To disable monitoring, call InputConnection.requestCursorUpdates(int) again with this flag off.

This flag can be used together with CURSOR_UPDATE_IMMEDIATE.

Note by default all of CURSOR_UPDATE_FILTER_EDITOR_BOUNDS, CURSOR_UPDATE_FILTER_CHARACTER_BOUNDS, CURSOR_UPDATE_FILTER_VISIBLE_LINE_BOUNDS, CURSOR_UPDATE_FILTER_TEXT_APPEARANCE, and CURSOR_UPDATE_FILTER_INSERTION_MARKER, are included but specifying them can filter-out others. It can be CPU intensive to include all, filtering specific info is recommended.

Constant Value: 2 (0x00000002)

GET_EXTRACTED_TEXT_MONITOR

public static final int GET_EXTRACTED_TEXT_MONITOR

Flag for use with getExtractedText(ExtractedTextRequest, int) to indicate you would like to receive updates when the extracted text changes.

Constant Value: 1 (0x00000001)

GET_TEXT_WITH_STYLES

public static final int GET_TEXT_WITH_STYLES

Flag for use with getTextAfterCursor(int, int), getTextBeforeCursor(int, int) and getSurroundingText(int, int, int) to have style information returned along with the text. If not set, getTextAfterCursor(int, int) sends only the raw text, without style or other spans. If set, it may return a complex CharSequence of both text and style spans. Editor authors: you should strive to send text with styles if possible, but it is not required.

Constant Value: 1 (0x00000001)

HANDWRITING_GESTURE_RESULT_CANCELLED

public static final int HANDWRITING_GESTURE_RESULT_CANCELLED

Result for performHandwritingGesture(android.view.inputmethod.HandwritingGesture, java.util.concurrent.Executor, java.util.function.IntConsumer) when HandwritingGesture was cancelled. This happens when the InputConnection is or becomes invalidated while performing the gesture, for example because a new InputConnection was started, or due to InputMethodManager.invalidateInput.

Constant Value: 4 (0x00000004)

HANDWRITING_GESTURE_RESULT_FAILED

public static final int HANDWRITING_GESTURE_RESULT_FAILED

Result for performHandwritingGesture(android.view.inputmethod.HandwritingGesture, java.util.concurrent.Executor, java.util.function.IntConsumer) when HandwritingGesture failed and there was no applicable HandwritingGesture.getFallbackText() or it couldn't be applied for any other reason.

Constant Value: 3 (0x00000003)

HANDWRITING_GESTURE_RESULT_FALLBACK

public static final int HANDWRITING_GESTURE_RESULT_FALLBACK

Result for performHandwritingGesture(android.view.inputmethod.HandwritingGesture, java.util.concurrent.Executor, java.util.function.IntConsumer) when HandwritingGesture failed but HandwritingGesture.getFallbackText() was committed.

Constant Value: 5 (0x00000005)

HANDWRITING_GESTURE_RESULT_SUCCESS

public static final int HANDWRITING_GESTURE_RESULT_SUCCESS

Result for performHandwritingGesture(android.view.inputmethod.HandwritingGesture, java.util.concurrent.Executor, java.util.function.IntConsumer) when HandwritingGesture is successfully executed on text.

Constant Value: 1 (0x00000001)

HANDWRITING_GESTURE_RESULT_UNKNOWN

public static final int HANDWRITING_GESTURE_RESULT_UNKNOWN

Result for performHandwritingGesture(android.view.inputmethod.HandwritingGesture, java.util.concurrent.Executor, java.util.function.IntConsumer) when editor didn't provide any result.

Constant Value: 0 (0x00000000)

HANDWRITING_GESTURE_RESULT_UNSUPPORTED

public static final int HANDWRITING_GESTURE_RESULT_UNSUPPORTED

Result for performHandwritingGesture(android.view.inputmethod.HandwritingGesture, java.util.concurrent.Executor, java.util.function.IntConsumer) when HandwritingGesture is unsupported by the current editor.

Constant Value: 2 (0x00000002)

INPUT_CONTENT_GRANT_READ_URI_PERMISSION

public static final int INPUT_CONTENT_GRANT_READ_URI_PERMISSION

When this flag is used, the editor will be able to request read access to the content URI contained in the InputContentInfo object.

Make sure that the content provider owning the Uri sets the grantUriPermissions attribute in its manifest or included the <grant-uri-permissions> tag. Otherwise InputContentInfo.requestPermission() can fail.

Although calling this API is allowed only for the IME that is currently selected, the client is able to request a temporary read-only access even after the current IME is switched to any other IME as long as the client keeps InputContentInfo object.

Constant Value: 1 (0x00000001)

beginBatchEdit

public abstract boolean beginBatchEdit ()

Tell the editor that you are starting a batch of editor operations. The editor will try to avoid sending you updates about its state until endBatchEdit() is called. Batch edits nest.

IME authors: use this to avoid getting calls to InputMethodService.onUpdateSelection(int, int, int, int, int, int) corresponding to intermediate state. Also, use this to avoid flickers that may arise from displaying intermediate state. Be sure to call endBatchEdit() for each call to this, or you may block updates in the editor.

Editor authors: while a batch edit is in progress, take care not to send updates to the input method and not to update the display. IMEs use this intensively to this effect. Also please note that batch edits need to nest correctly.

clearMetaKeyStates

public abstract boolean clearMetaKeyStates (int states)

Clear the given meta key pressed states in the given input connection.

This can be used by the IME to clear the meta key states set by a hardware keyboard with latched meta keys, if the editor keeps track of these.

closeConnection

public abstract void closeConnection ()

Called by the system up to only once to notify that the system is about to invalidate connection between the input method and the application.

Editor authors: You can clear all the nested batch edit right now and you no longer need to handle subsequent callbacks on this connection, including beginBatchEdit()}. Note that although the system tries to call this method whenever possible, there may be a chance that this method is not called in some exceptional situations.

Note: This does nothing when called from input methods.

commitCompletion

public abstract boolean commitCompletion (CompletionInfo text)

Commit a completion the user has selected from the possible ones previously reported to InputMethodSession#displayCompletions(CompletionInfo[]) or InputMethodManager#displayCompletions(View, CompletionInfo[]). This will result in the same behavior as if the user had selected the completion from the actual UI. In all other respects, this behaves like commitText(java.lang.CharSequence, int).

IME authors: please take care to send the same object that you received through InputMethodService.onDisplayCompletions(CompletionInfo[]).

Editor authors: if you never call InputMethodSession.displayCompletions(CompletionInfo[]) or InputMethodManager.displayCompletions(View, CompletionInfo[]) then a well-behaved IME should never call this on your input connection, but be ready to deal with misbehaving IMEs without crashing.

Calling this method (with a valid CompletionInfo object) will cause the editor to call InputMethodService.onUpdateSelection(int, int, int, int, int, int) on the current IME after the batch input is over. Editor authors, for this to happen you need to make the changes known to the input method by calling InputMethodManager.updateSelection(View, int, int, int, int), but be careful to wait until the batch edit is over if one is in progress.

commitContent

public abstract boolean commitContent (InputContentInfo inputContentInfo, 
                int flags, 
                Bundle opts)

Called by the input method to commit content such as a PNG image to the editor.

In order to avoid a variety of compatibility issues, this focuses on a simple use case, where editors and IMEs are expected to work cooperatively as follows:

• Editor must keep EditorInfo.contentMimeTypes equal to null if it does not support this method at all.
• Editor can ignore this request when the MIME type specified in inputContentInfo does not match any of EditorInfo.contentMimeTypes.
• Editor can ignore the cursor position when inserting the provided content.
• Editor can return true asynchronously, even before it starts loading the content.
• Editor should provide a way to delete the content inserted by this method or to revert the effect caused by this method.
• IME should not call this method when there is any composing text, in case calling this method causes a focus change.
• IME should grant a permission for the editor to read the content. See EditorInfo.packageName about how to obtain the package name of the editor.

commitCorrection

public abstract boolean commitCorrection (CorrectionInfo correctionInfo)

Commit a correction automatically performed on the raw user's input. A typical example would be to correct typos using a dictionary.

Calling this method will cause the editor to call InputMethodService.onUpdateSelection(int, int, int, int, int, int) on the current IME after the batch input is over. Editor authors, for this to happen you need to make the changes known to the input method by calling InputMethodManager.updateSelection(View, int, int, int, int), but be careful to wait until the batch edit is over if one is in progress.

commitText

public boolean commitText (CharSequence text, 
                int newCursorPosition, 
                TextAttribute textAttribute)

The variant of InputConnection.commitText(CharSequence, int). This method is used to allow the IME to provide extra information while setting up text.

commitText

public abstract boolean commitText (CharSequence text, 
                int newCursorPosition)

Commit text to the text box and set the new cursor position.

This method removes the contents of the currently composing text and replaces it with the passed CharSequence, and then moves the cursor according to newCursorPosition. If there is no composing text when this method is called, the new text is inserted at the cursor position, removing text inside the selection if any. This behaves like calling setComposingText(text, newCursorPosition) then finishComposingText().

Calling this method will cause the editor to call InputMethodService.onUpdateSelection(int, int, int, int, int, int) on the current IME after the batch input is over. Editor authors, for this to happen you need to make the changes known to the input method by calling InputMethodManager.updateSelection(View, int, int, int, int), but be careful to wait until the batch edit is over if one is in progress.

deleteSurroundingText

public abstract boolean deleteSurroundingText (int beforeLength, 
                int afterLength)

Delete beforeLength characters of text before the current cursor position, and delete afterLength characters of text after the current cursor position, excluding the selection. Before and after refer to the order of the characters in the string, not to their visual representation: this means you don't have to figure out the direction of the text and can just use the indices as-is.

The lengths are supplied in Java chars, not in code points or in glyphs.

Since this method only operates on text before and after the selection, it can't affect the contents of the selection. This may affect the composing span if the span includes characters that are to be deleted, but otherwise will not change it. If some characters in the composing span are deleted, the composing span will persist but get shortened by however many chars inside it have been removed.

IME authors: please be careful not to delete only half of a surrogate pair. Also take care not to delete more characters than are in the editor, as that may have ill effects on the application. Calling this method will cause the editor to call InputMethodService.onUpdateSelection(int, int, int, int, int, int) on your service after the batch input is over.

Editor authors: please be careful of race conditions in implementing this call. An IME can make a change to the text or change the selection position and use this method right away; you need to make sure the effects are consistent with the results of the latest edits. Also, although the IME should not send lengths bigger than the contents of the string, you should check the values for overflows and trim the indices to the size of the contents to avoid crashes. Since this changes the contents of the editor, you need to make the changes known to the input method by calling InputMethodManager.updateSelection(View, int, int, int, int), but be careful to wait until the batch edit is over if one is in progress.

deleteSurroundingTextInCodePoints

public abstract boolean deleteSurroundingTextInCodePoints (int beforeLength, 
                int afterLength)

A variant of deleteSurroundingText(int, int). Major differences are:

• The lengths are supplied in code points, not in Java chars or in glyphs.
• This method does nothing if there are one or more invalid surrogate pairs in the requested range.

Editor authors: In addition to the requirement in deleteSurroundingText(int, int), make sure to do nothing when one ore more invalid surrogate pairs are found in the requested range.

endBatchEdit

public abstract boolean endBatchEdit ()

Tell the editor that you are done with a batch edit previously initiated with beginBatchEdit(). This ends the latest batch only.

IME authors: make sure you call this exactly once for each call to beginBatchEdit().

Editor authors: please be careful about batch edit nesting. Updates still to be held back until the end of the last batch edit. In case you are delegating this API call to the one obtained from TextView.onCreateInputConnection(EditorInfo), there was an off-by-one that had returned true when its nested batch edit count becomes 0 as a result of invoking this API. This bug is fixed in Build.VERSION_CODES.TIRAMISU.

finishComposingText

public abstract boolean finishComposingText ()

Have the text editor finish whatever composing text is currently active. This simply leaves the text as-is, removing any special composing styling or other state that was around it. The cursor position remains unchanged.

IME authors: be aware that this call may be expensive with some editors.

Editor authors: please note that the cursor may be anywhere in the contents when this is called, including in the middle of the composing span or in a completely unrelated place. It must not move.

getCursorCapsMode

public abstract int getCursorCapsMode (int reqModes)

Retrieve the current capitalization mode in effect at the current cursor position in the text. See TextUtils.getCapsMode for more information.

This method may fail either if the input connection has become invalid (such as its process crashing) or the client is taking too long to respond with the text (it is given a couple seconds to return). In either case, 0 is returned.

This method does not affect the text in the editor in any way, nor does it affect the selection or composing spans.

Editor authors: please be careful of race conditions in implementing this call. An IME can change the cursor position and use this method right away; you need to make sure the returned value is consistent with the results of the latest edits and changes to the cursor position.

getExtractedText

public abstract ExtractedText getExtractedText (ExtractedTextRequest request, 
                int flags)

Retrieve the current text in the input connection's editor, and monitor for any changes to it. This function returns with the current text, and optionally the input connection can send updates to the input method when its text changes.

This method may fail either if the input connection has become invalid (such as its process crashing) or the client is taking too long to respond with the text (it is given a couple seconds to return). In either case, null is returned.

Editor authors: as a general rule, try to comply with the fields in request for how many chars to return, but if performance or convenience dictates otherwise, please feel free to do what is most appropriate for your case. Also, if the GET_EXTRACTED_TEXT_MONITOR flag is set, you should be calling InputMethodManager.updateExtractedText(View, int, ExtractedText) whenever you call InputMethodManager.updateSelection(View, int, int, int, int).

getHandler

public abstract Handler getHandler ()

Called by the system to enable application developers to specify a dedicated thread on which InputConnection methods are called back.

Editor authors: although you can return your custom subclasses of Handler, the system only uses Looper returned from Handler.getLooper(). You cannot intercept or cancel InputConnection callbacks by implementing this method.

IME authors: This method is not intended to be called from the IME. You will always receive null.

getSelectedText

public abstract CharSequence getSelectedText (int flags)

Gets the selected text, if any.

This method may fail if either the input connection has become invalid (such as its process crashing) or the client is taking too long to respond with the text (it is given a couple of seconds to return). In either case, null is returned.

This method must not cause any changes in the editor's state.

If GET_TEXT_WITH_STYLES is supplied as flags, the editor should return a SpannableString with all the spans set on the text.

IME authors: please consider this will trigger an IPC round-trip that will take some time. Assume this method consumes a lot of time. If you are using this to get the initial text around the cursor, you may consider using EditorInfo.getInitialTextBeforeCursor(int, int), EditorInfo.getInitialSelectedText(int), and EditorInfo.getInitialTextAfterCursor(int, int) to prevent IPC costs.

Editor authors: please be careful of race conditions in implementing this call. An IME can make a change to the text or change the selection position and use this method right away; you need to make sure the returned value is consistent with the results of the latest edits.

getSurroundingText

public SurroundingText getSurroundingText (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 range are for java characters, not glyphs that can be multiple characters.

This method may fail either if the input connection has become invalid (such as its process crashing), or the client is taking too long to respond with the text (it is given a couple seconds to return), or the protocol is not supported. In any of these cases, null is returned.

This method does not affect the text in the editor in any way, nor does it affect the selection or composing spans.

If GET_TEXT_WITH_STYLES is supplied as flags, the editor should return a Spanned with all the spans set on the text.

IME authors: please consider this will trigger an IPC round-trip that will take some time. Assume this method consumes a lot of time. If you are using this to get the initial surrounding text around the cursor, you may consider using EditorInfo.getInitialTextBeforeCursor(int, int), EditorInfo.getInitialSelectedText(int), and EditorInfo.getInitialTextAfterCursor(int, int) to prevent IPC costs.

getTextAfterCursor

public abstract CharSequence getTextAfterCursor (int n, 
                int flags)

Get n characters of text after the current cursor position.

This method may fail either if the input connection has become invalid (such as its process crashing) or the client is taking too long to respond with the text (it is given a couple seconds to return). In either case, null is returned.

This method does not affect the text in the editor in any way, nor does it affect the selection or composing spans.

If GET_TEXT_WITH_STYLES is supplied as flags, the editor should return a SpannableString with all the spans set on the text.

IME authors: please consider this will trigger an IPC round-trip that will take some time. Assume this method consumes a lot of time. If you are using this to get the initial text around the cursor, you may consider using EditorInfo.getInitialTextBeforeCursor(int, int), EditorInfo.getInitialSelectedText(int), and EditorInfo.getInitialTextAfterCursor(int, int) to prevent IPC costs.

Editor authors: please be careful of race conditions in implementing this call. An IME can make a change to the text and use this method right away; you need to make sure the returned value is consistent with the result of the latest edits. Also, you may return less than n characters if performance dictates so, but keep in mind IMEs are relying on this for many functions: you should not, for example, limit the returned value to the current line, and specifically do not return 0 characters unless the cursor is really at the end of the text.

getTextBeforeCursor

public abstract CharSequence getTextBeforeCursor (int n, 
                int flags)

Get n characters of text before the current cursor position.

This method may fail either if the input connection has become invalid (such as its process crashing) or the editor is taking too long to respond with the text (it is given a couple seconds to return). In either case, null is returned. This method does not affect the text in the editor in any way, nor does it affect the selection or composing spans.

If GET_TEXT_WITH_STYLES is supplied as flags, the editor should return a SpannableString with all the spans set on the text.

IME authors: please consider this will trigger an IPC round-trip that will take some time. Assume this method consumes a lot of time. Also, please keep in mind the Editor may choose to return less characters than requested even if they are available for performance reasons. If you are using this to get the initial text around the cursor, you may consider using EditorInfo.getInitialTextBeforeCursor(int, int), EditorInfo.getInitialSelectedText(int), and EditorInfo.getInitialTextAfterCursor(int, int) to prevent IPC costs.

Editor authors: please be careful of race conditions in implementing this call. An IME can make a change to the text and use this method right away; you need to make sure the returned value is consistent with the result of the latest edits. Also, you may return less than n characters if performance dictates so, but keep in mind IMEs are relying on this for many functions: you should not, for example, limit the returned value to the current line, and specifically do not return 0 characters unless the cursor is really at the start of the text.

performContextMenuAction

public abstract boolean performContextMenuAction (int id)

Perform a context menu action on the field. The given id may be one of: R.id.selectAll, R.id.startSelectingText, R.id.stopSelectingText, R.id.cut, R.id.copy, R.id.paste, R.id.copyUrl, or R.id.switchInputMethod

performEditorAction

public abstract boolean performEditorAction (int editorAction)

Have the editor perform an action it has said it can do.

This is typically used by IMEs when the user presses the key associated with the action.

performHandwritingGesture

public void performHandwritingGesture (HandwritingGesture gesture, 
                Executor executor, 
                IntConsumer consumer)

Perform a handwriting gesture on text.

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

performPrivateCommand

public abstract boolean performPrivateCommand (String action, 
                Bundle data)

API to send private commands from an input method to its connected editor. This can be used to provide domain-specific features that are only known between certain input methods and their clients. Note that because the InputConnection protocol is asynchronous, you have no way to get a result back or know if the client understood the command; you can use the information in EditorInfo to determine if a client supports a particular command.

performSpellCheck

public boolean performSpellCheck ()

Have the editor perform spell checking for the full content.

The editor can ignore this method call if it does not support spell checking.

previewHandwritingGesture

public boolean previewHandwritingGesture (PreviewableHandwritingGesture gesture, 
                CancellationSignal cancellationSignal)

Preview a handwriting gesture on text. Provides a real-time preview for a gesture to user for an ongoing gesture. e.g. as user begins to draw a circle around text, resulting selection SelectGesture is previewed while stylus is moving over applicable text.

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

replaceText

public boolean replaceText (int start, 
                int end, 
                CharSequence text, 
                int newCursorPosition, 
                TextAttribute textAttribute)

Replace the specific range in the editor with suggested text.

This method finishes whatever composing text is currently active and leaves the text as-it, replaces the specific range of text with the passed CharSequence, and then moves the cursor according to newCursorPosition. This behaves like calling finishComposingText(), setSelection(start, end), and then commitText(text, newCursorPosition, textAttribute).

Similar to setSelection(int, int), the order of start and end is not important. In effect, the region from start to end and the region from end to start is the same. Editor authors, be ready to accept a start that is greater than end.

reportFullscreenMode

public abstract boolean reportFullscreenMode (boolean enabled)

Called back when the connected IME switches between fullscreen and normal modes.

Editor authors: There is a bug on Build.VERSION_CODES.O and later devices that this method is called back on the main thread even when getHandler() is overridden. This bug is fixed in Build.VERSION_CODES.TIRAMISU.

IME authors: On Build.VERSION_CODES.O and later devices, input methods are no longer allowed to directly call this method at any time. To signal this event in the target application, input methods should always call InputMethodService.updateFullscreenMode() instead. This approach should work on API Build.VERSION_CODES.N_MR1 and prior devices.

requestCursorUpdates

public boolean requestCursorUpdates (int cursorUpdateMode, 
                int cursorUpdateFilter)

Called by the input method to ask the editor for calling back InputMethodManager.updateCursorAnchorInfo(android.view.View, CursorAnchorInfo) to notify cursor/anchor locations.

requestCursorUpdates

public abstract boolean requestCursorUpdates (int cursorUpdateMode)

Called by the input method to ask the editor for calling back InputMethodManager.updateCursorAnchorInfo(android.view.View, CursorAnchorInfo) to notify cursor/anchor locations.

requestTextBoundsInfo

public void requestTextBoundsInfo (RectF bounds, 
                Executor executor, 
                Consumer<TextBoundsInfoResult> consumer)

Called by input method to request the TextBoundsInfo for a range of text which is covered by or in vicinity of the given bounds. It can be used as a supplementary method to implement the handwriting gesture API - performHandwritingGesture(android.view.inputmethod.HandwritingGesture, java.util.concurrent.Executor, java.util.function.IntConsumer).

Editor authors: It's preferred that the editor returns a TextBoundsInfo of all the text lines whose bounds intersect with the given bounds.

IME authors: This method is expensive when the text is long. Please consider that both the text bounds computation and IPC round-trip to send the data are time consuming. It's preferable to only request text bounds in smaller areas.

sendKeyEvent

public abstract boolean sendKeyEvent (KeyEvent event)

Send a key event to the process that is currently attached through this input connection. The event will be dispatched like a normal key event, to the currently focused view; this generally is the view that is providing this InputConnection, but due to the asynchronous nature of this protocol that can not be guaranteed and the focus may have changed by the time the event is received.

This method can be used to send key events to the application. For example, an on-screen keyboard may use this method to simulate a hardware keyboard. There are three types of standard keyboards, numeric (12-key), predictive (20-key) and ALPHA (QWERTY). You can specify the keyboard type by specify the device id of the key event.

You will usually want to set the flag KeyEvent.FLAG_SOFT_KEYBOARD on all key event objects you give to this API; the flag will not be set for you.

Note that it's discouraged to send such key events in normal operation; this is mainly for use with InputType.TYPE_NULL type text fields. Use the commitText(CharSequence, int) family of methods to send text to the application instead.

setComposingRegion

public abstract boolean setComposingRegion (int start, 
                int end)

Mark a certain region of text as composing text. If there was a composing region, the characters are left as they were and the composing span removed, as if finishComposingText() has been called. The default style for composing text is used.

The passed indices are clipped to the contents bounds. If the resulting region is zero-sized, no region is marked and the effect is the same as that of calling finishComposingText(). The order of start and end is not important. In effect, the region from start to end and the region from end to start is the same. Editor authors, be ready to accept a start that is greater than end.

Since this does not change the contents of the text, editors should not call InputMethodManager.updateSelection(View, int, int, int, int) and IMEs should not receive InputMethodService.onUpdateSelection(int, int, int, int, int, int).

This has no impact on the cursor/selection position. It may result in the cursor being anywhere inside or outside the composing region, including cases where the selection and the composing region overlap partially or entirely.

setComposingRegion

public boolean setComposingRegion (int start, 
                int end, 
                TextAttribute textAttribute)

The variant of InputConnection.setComposingRegion(int, int). This method is used to allow the IME to provide extra information while setting up text.

setComposingText

public boolean setComposingText (CharSequence text, 
                int newCursorPosition, 
                TextAttribute textAttribute)

The variant of setComposingText(java.lang.CharSequence, int). This method is used to allow the IME to provide extra information while setting up composing text.

setComposingText

public abstract boolean setComposingText (CharSequence text, 
                int newCursorPosition)

Replace the currently composing text with the given text, and set the new cursor position. Any composing text set previously will be removed automatically.

If there is any composing span currently active, all characters that it comprises are removed. The passed text is added in its place, and a composing span is added to this text. If there is no composing span active, the passed text is added at the cursor position (removing selected characters first if any), and a composing span is added on the new text. Finally, the cursor is moved to the location specified by newCursorPosition.

This is usually called by IMEs to add or remove or change characters in the composing span. Calling this method will cause the editor to call InputMethodService.onUpdateSelection(int, int, int, int, int, int) on the current IME after the batch input is over.

Editor authors: please keep in mind the text may be very similar or completely different than what was in the composing span at call time, or there may not be a composing span at all. Please note that although it's not typical use, the string may be empty. Treat this normally, replacing the currently composing text with an empty string. Also, be careful with the cursor position. IMEs rely on this working exactly as described above. Since this changes the contents of the editor, you need to make the changes known to the input method by calling InputMethodManager.updateSelection(View, int, int, int, int), but be careful to wait until the batch edit is over if one is in progress. Note that this method can set the cursor position on either edge of the composing text or entirely outside it, but the IME may also go on to move the cursor position to within the composing text in a subsequent call so you should make no assumption at all: the composing text and the selection are entirely independent.

setImeConsumesInput

public boolean setImeConsumesInput (boolean imeConsumesInput)

Called by the input method to indicate that it consumes all input for itself, or no longer does so.

Editors should reflect that they are not receiving input by hiding the cursor if imeConsumesInput is true, and resume showing the cursor if it is false.

setSelection

public abstract boolean setSelection (int start, 
                int end)

Set the selection of the text editor. To set the cursor position, start and end should have the same value.

Since this moves the cursor, calling this method will cause the editor to call InputMethodService.onUpdateSelection(int, int, int, int, int, int) on the current IME after the batch input is over. Editor authors, for this to happen you need to make the changes known to the input method by calling InputMethodManager.updateSelection(View, int, int, int, int), but be careful to wait until the batch edit is over if one is in progress.

This has no effect on the composing region which must stay unchanged. The order of start and end is not important. In effect, the region from start to end and the region from end to start is the same. Editor authors, be ready to accept a start that is greater than end.

takeSnapshot

public TextSnapshot takeSnapshot ()

Called by the system when it needs to take a snapshot of multiple text-related data in an atomic manner.

Editor authors: Supporting this method is strongly encouraged. Atomically taken TextSnapshot is going to be really helpful for the system when optimizing IPCs in a safe and deterministic manner. Return null if an atomically taken TextSnapshot is unavailable. The system continues supporting such a scenario gracefully.

IME authors: Currently IMEs cannot call this method directly and always receive null as the result.