Skip to content

Most visited

Recently visited

navigation

InputMethodManager

public final class InputMethodManager
extends Object

java.lang.Object
   ↳ android.view.inputmethod.InputMethodManager


Central system API to the overall input method framework (IMF) architecture, which arbitrates interaction between applications and the current input method. You can retrieve an instance of this interface with Context.getSystemService().

Topics covered here:

  1. Architecture Overview
  2. Applications
  3. Input Methods
  4. Security

Architecture Overview

There are three primary parties involved in the input method framework (IMF) architecture:

  • The input method manager as expressed by this class is the central point of the system that manages interaction between all other parts. It is expressed as the client-side API here which exists in each application context and communicates with a global system service that manages the interaction across all processes.
  • An input method (IME) implements a particular interaction model allowing the user to generate text. The system binds to the current input method that is use, causing it to be created and run, and tells it when to hide and show its UI. Only one IME is running at a time.
  • Multiple client applications arbitrate with the input method manager for input focus and control over the state of the IME. Only one such client is ever active (working with the IME) at a time.

Applications

In most cases, applications that are using the standard TextView or its subclasses will have little they need to do to work well with soft input methods. The main things you need to be aware of are:

  • Properly set the inputType in your editable text views, so that the input method will have enough context to help the user in entering text into them.
  • Deal well with losing screen space when the input method is displayed. Ideally an application should handle its window being resized smaller, but it can rely on the system performing panning of the window if needed. You should set the windowSoftInputMode attribute on your activity or the corresponding values on windows you create to help the system determine whether to pan or resize (it will try to determine this automatically but may get it wrong).
  • You can also control the preferred soft input state (open, closed, etc) for your window using the same windowSoftInputMode attribute.

More finer-grained control is available through the APIs here to directly interact with the IMF and its IME -- either showing or hiding the input area, letting the user pick an input method, etc.

For the rare people amongst us writing their own text editors, you will need to implement onCreateInputConnection(EditorInfo) to return a new instance of your own InputConnection interface allowing the IME to interact with your editor.

Input Methods

An input method (IME) is implemented as a Service, typically deriving from InputMethodService. It must provide the core InputMethod interface, though this is normally handled by InputMethodService and implementors will only need to deal with the higher-level API there.

See the InputMethodService class for more information on implementing IMEs.

Security

There are a lot of security issues associated with input methods, since they essentially have freedom to completely drive the UI and monitor everything the user enters. The Android input method framework also allows arbitrary third party IMEs, so care must be taken to restrict their selection and interactions.

Here are some key points about the security architecture behind the IMF:

  • Only the system is allowed to directly access an IME's InputMethod interface, via the BIND_INPUT_METHOD permission. This is enforced in the system by not binding to an input method service that does not require this permission, so the system can guarantee no other untrusted clients are accessing the current input method outside of its control.

  • There may be many client processes of the IMF, but only one may be active at a time. The inactive clients can not interact with key parts of the IMF through the mechanisms described below.

  • Clients of an input method are only given access to its InputMethodSession interface. One instance of this interface is created for each client, and only calls from the session associated with the active client will be processed by the current IME. This is enforced by AbstractInputMethodService for normal IMEs, but must be explicitly handled by an IME that is customizing the raw InputMethodSession implementation.

  • Only the active client's InputConnection will accept operations. The IMF tells each client process whether it is active, and the framework enforces that in inactive processes calls on to the current InputConnection will be ignored. This ensures that the current IME can only deliver events and text edits to the UI that the user sees as being in focus.

  • An IME can never interact with an InputConnection while the screen is off. This is enforced by making all clients inactive while the screen is off, and prevents bad IMEs from driving the UI when the user can not be aware of its behavior.

  • A client application can ask that the system let the user pick a new IME, but can not programmatically switch to one itself. This avoids malicious applications from switching the user to their own IME, which remains running when the user navigates away to another application. An IME, on the other hand, is allowed to programmatically switch the system to another IME, since it already has full control of user input.

  • The user must explicitly enable a new IME in settings before they can switch to it, to confirm with the system that they know about it and want to make it available for use.

Summary

Constants

int HIDE_IMPLICIT_ONLY

Flag for hideSoftInputFromWindow(IBinder, int) to indicate that the soft input window should only be hidden if it was not explicitly shown by the user.

int HIDE_NOT_ALWAYS

Flag for hideSoftInputFromWindow(IBinder, int) to indicate that the soft input window should normally be hidden, unless it was originally shown with SHOW_FORCED.

int RESULT_HIDDEN

Flag for the ResultReceiver result code from showSoftInput(View, int, ResultReceiver) and hideSoftInputFromWindow(IBinder, int, ResultReceiver): the state of the soft input window changed from shown to hidden.

int RESULT_SHOWN

Flag for the ResultReceiver result code from showSoftInput(View, int, ResultReceiver) and hideSoftInputFromWindow(IBinder, int, ResultReceiver): the state of the soft input window changed from hidden to shown.

int RESULT_UNCHANGED_HIDDEN

Flag for the ResultReceiver result code from showSoftInput(View, int, ResultReceiver) and hideSoftInputFromWindow(IBinder, int, ResultReceiver): the state of the soft input window was unchanged and remains hidden.

int RESULT_UNCHANGED_SHOWN

Flag for the ResultReceiver result code from showSoftInput(View, int, ResultReceiver) and hideSoftInputFromWindow(IBinder, int, ResultReceiver): the state of the soft input window was unchanged and remains shown.

int SHOW_FORCED

Flag for showSoftInput(View, int) to indicate that the user has forced the input method open (such as by long-pressing menu) so it should not be closed until they explicitly do so.

int SHOW_IMPLICIT

Flag for showSoftInput(View, int) to indicate that this is an implicit request to show the input window, not as the result of a direct request by the user.

Public methods

void dispatchKeyEventFromInputMethod(View targetView, KeyEvent event)

Provides the default implementation of sendKeyEvent(KeyEvent), which is expected to dispatch an keyboard event sent from the IME to an appropriate event target depending on the given View and the current focus state.

void displayCompletions(View view, CompletionInfo[] completions)
InputMethodSubtype getCurrentInputMethodSubtype()

Returns the current input method subtype.

List<InputMethodInfo> getEnabledInputMethodList()
List<InputMethodSubtype> getEnabledInputMethodSubtypeList(InputMethodInfo imi, boolean allowsImplicitlySelectedSubtypes)

Returns a list of enabled input method subtypes for the specified input method info.

List<InputMethodInfo> getInputMethodList()
InputMethodSubtype getLastInputMethodSubtype()
Map<InputMethodInfoList<InputMethodSubtype>> getShortcutInputMethodsAndSubtypes()

Returns a map of all shortcut input method info and their subtypes.

void hideSoftInputFromInputMethod(IBinder token, int flags)

Close/hide the input method's soft input area, so the user no longer sees it or can interact with it.

boolean hideSoftInputFromWindow(IBinder windowToken, int flags)

Synonym for hideSoftInputFromWindow(IBinder, int, ResultReceiver) without a result: request to hide the soft input window from the context of the window that is currently accepting input.

boolean hideSoftInputFromWindow(IBinder windowToken, int flags, ResultReceiver resultReceiver)

Request to hide the soft input window from the context of the window that is currently accepting input.

void hideStatusIcon(IBinder imeToken)
boolean isAcceptingText()

Return true if the currently served view is accepting full text edits.

boolean isActive()

Return true if any view is currently active in the input method.

boolean isActive(View view)

Return true if the given view is the currently active view for the input method.

boolean isFullscreenMode()

Allows you to discover whether the attached input method is running in fullscreen mode.

boolean isWatchingCursor(View view)

This method was deprecated in API level 21. Use requestCursorUpdates(int) instead.

void restartInput(View view)

If the input method is currently connected to the given view, restart it with its new contents.

void sendAppPrivateCommand(View view, String action, Bundle data)

Call InputMethodSession.appPrivateCommand() on the current Input Method.

void setAdditionalInputMethodSubtypes(String imiId, InputMethodSubtype[] subtypes)

Set additional input method subtypes.

boolean setCurrentInputMethodSubtype(InputMethodSubtype subtype)

Switch to a new input method subtype of the current input method.

void setInputMethod(IBinder token, String id)

Force switch to a new input method component.

void setInputMethodAndSubtype(IBinder token, String id, InputMethodSubtype subtype)

Force switch to a new input method and subtype.

boolean shouldOfferSwitchingToNextInputMethod(IBinder imeToken)

Returns true if the current IME needs to offer the users ways to switch to a next input method (e.g.

void showInputMethodAndSubtypeEnabler(String imiId)

Show the settings for enabling subtypes of the specified input method.

void showInputMethodPicker()
boolean showSoftInput(View view, int flags, ResultReceiver resultReceiver)

Explicitly request that the current input method's soft input area be shown to the user, if needed.

boolean showSoftInput(View view, int flags)

Synonym for showSoftInput(View, int, ResultReceiver) without a result receiver: explicitly request that the current input method's soft input area be shown to the user, if needed.

void showSoftInputFromInputMethod(IBinder token, int flags)

Show the input method's soft input area, so the user sees the input method window and can interact with it.

void showStatusIcon(IBinder imeToken, String packageName, int iconId)
boolean switchToLastInputMethod(IBinder imeToken)

Force switch to the last used input method and subtype.

boolean switchToNextInputMethod(IBinder imeToken, boolean onlyCurrentIme)

Force switch to the next input method and subtype.

void toggleSoftInput(int showFlags, int hideFlags)
void toggleSoftInputFromWindow(IBinder windowToken, int showFlags, int hideFlags)

This method toggles the input method window display.

void updateCursor(View view, int left, int top, int right, int bottom)

This method was deprecated in API level 21. Use updateCursorAnchorInfo(View, CursorAnchorInfo) instead.

void updateCursorAnchorInfo(View view, CursorAnchorInfo cursorAnchorInfo)

Report positional change of the text insertion point and/or characters in the composition string.

void updateExtractedText(View view, int token, ExtractedText text)
void updateSelection(View view, int selStart, int selEnd, int candidatesStart, int candidatesEnd)

Report the current selection range.

void viewClicked(View view)

Notify the event when the user tapped or clicked the text view.

Inherited methods

From class java.lang.Object

Constants

HIDE_IMPLICIT_ONLY

Added in API level 3
int HIDE_IMPLICIT_ONLY

Flag for hideSoftInputFromWindow(IBinder, int) to indicate that the soft input window should only be hidden if it was not explicitly shown by the user.

Constant Value: 1 (0x00000001)

HIDE_NOT_ALWAYS

Added in API level 3
int HIDE_NOT_ALWAYS

Flag for hideSoftInputFromWindow(IBinder, int) to indicate that the soft input window should normally be hidden, unless it was originally shown with SHOW_FORCED.

Constant Value: 2 (0x00000002)

RESULT_HIDDEN

Added in API level 3
int RESULT_HIDDEN

Flag for the ResultReceiver result code from showSoftInput(View, int, ResultReceiver) and hideSoftInputFromWindow(IBinder, int, ResultReceiver): the state of the soft input window changed from shown to hidden.

Constant Value: 3 (0x00000003)

RESULT_SHOWN

Added in API level 3
int RESULT_SHOWN

Flag for the ResultReceiver result code from showSoftInput(View, int, ResultReceiver) and hideSoftInputFromWindow(IBinder, int, ResultReceiver): the state of the soft input window changed from hidden to shown.

Constant Value: 2 (0x00000002)

RESULT_UNCHANGED_HIDDEN

Added in API level 3
int RESULT_UNCHANGED_HIDDEN

Flag for the ResultReceiver result code from showSoftInput(View, int, ResultReceiver) and hideSoftInputFromWindow(IBinder, int, ResultReceiver): the state of the soft input window was unchanged and remains hidden.

Constant Value: 1 (0x00000001)

RESULT_UNCHANGED_SHOWN

Added in API level 3
int RESULT_UNCHANGED_SHOWN

Flag for the ResultReceiver result code from showSoftInput(View, int, ResultReceiver) and hideSoftInputFromWindow(IBinder, int, ResultReceiver): the state of the soft input window was unchanged and remains shown.

Constant Value: 0 (0x00000000)

SHOW_FORCED

Added in API level 3
int SHOW_FORCED

Flag for showSoftInput(View, int) to indicate that the user has forced the input method open (such as by long-pressing menu) so it should not be closed until they explicitly do so.

Constant Value: 2 (0x00000002)

SHOW_IMPLICIT

Added in API level 3
int SHOW_IMPLICIT

Flag for showSoftInput(View, int) to indicate that this is an implicit request to show the input window, not as the result of a direct request by the user. The window may not be shown in this case.

Constant Value: 1 (0x00000001)

Public methods

dispatchKeyEventFromInputMethod

Added in API level 24
void dispatchKeyEventFromInputMethod (View targetView, 
                KeyEvent event)

Provides the default implementation of sendKeyEvent(KeyEvent), which is expected to dispatch an keyboard event sent from the IME to an appropriate event target depending on the given View and the current focus state.

CAUTION: This method is provided only for the situation where sendKeyEvent(KeyEvent) needs to be implemented without relying on BaseInputConnection. Do not use this API for anything else.

Parameters
targetView View: the default target view. If null is specified, then this method tries to find a good event target based on the current focus state.
event KeyEvent: the key event to be dispatched.

displayCompletions

Added in API level 3
void displayCompletions (View view, 
                CompletionInfo[] completions)

Parameters
view View
completions CompletionInfo

getCurrentInputMethodSubtype

Added in API level 11
InputMethodSubtype getCurrentInputMethodSubtype ()

Returns the current input method subtype. This subtype is one of the subtypes in the current input method. This method returns null when the current input method doesn't have any input method subtype.

Returns
InputMethodSubtype

getEnabledInputMethodList

Added in API level 3
List<InputMethodInfo> getEnabledInputMethodList ()

Returns
List<InputMethodInfo>

getEnabledInputMethodSubtypeList

Added in API level 11
List<InputMethodSubtype> getEnabledInputMethodSubtypeList (InputMethodInfo imi, 
                boolean allowsImplicitlySelectedSubtypes)

Returns a list of enabled input method subtypes for the specified input method info.

Parameters
imi InputMethodInfo: An input method info whose subtypes list will be returned.
allowsImplicitlySelectedSubtypes boolean: A boolean flag to allow to return the implicitly selected subtypes. If an input method info doesn't have enabled subtypes, the framework will implicitly enable subtypes according to the current system language.
Returns
List<InputMethodSubtype>

getInputMethodList

Added in API level 3
List<InputMethodInfo> getInputMethodList ()

Returns
List<InputMethodInfo>

getLastInputMethodSubtype

Added in API level 14
InputMethodSubtype getLastInputMethodSubtype ()

Returns
InputMethodSubtype

getShortcutInputMethodsAndSubtypes

Added in API level 11
Map<InputMethodInfoList<InputMethodSubtype>> getShortcutInputMethodsAndSubtypes ()

Returns a map of all shortcut input method info and their subtypes.

Returns
Map<InputMethodInfoList<InputMethodSubtype>>

hideSoftInputFromInputMethod

Added in API level 3
void hideSoftInputFromInputMethod (IBinder token, 
                int flags)

Close/hide the input method's soft input area, so the user no longer sees it or can interact with it. This can only be called from the currently active input method, as validated by the given token.

Parameters
token IBinder: Supplies the identifying token given to an input method when it was started, which allows it to perform this operation on itself.
flags int: Provides additional operating flags. Currently may be 0 or have the HIDE_IMPLICIT_ONLY, HIDE_NOT_ALWAYS bit set.

hideSoftInputFromWindow

Added in API level 3
boolean hideSoftInputFromWindow (IBinder windowToken, 
                int flags)

Synonym for hideSoftInputFromWindow(IBinder, int, ResultReceiver) without a result: request to hide the soft input window from the context of the window that is currently accepting input.

Parameters
windowToken IBinder: The token of the window that is making the request, as returned by View.getWindowToken().
flags int: Provides additional operating flags. Currently may be 0 or have the HIDE_IMPLICIT_ONLY bit set.
Returns
boolean

hideSoftInputFromWindow

Added in API level 3
boolean hideSoftInputFromWindow (IBinder windowToken, 
                int flags, 
                ResultReceiver resultReceiver)

Request to hide the soft input window from the context of the window that is currently accepting input. This should be called as a result of the user doing some actually than fairly explicitly requests to have the input window hidden.

Caveat: ResultReceiver instance passed to this method can be a long-lived object, because it may not be garbage-collected until all the corresponding ResultReceiver objects transferred to different processes get garbage-collected. Follow the general patterns to avoid memory leaks in Android. Consider to use WeakReference so that application logic objects such as Activity and Context can be garbage collected regardless of the lifetime of ResultReceiver.

Parameters
windowToken IBinder: The token of the window that is making the request, as returned by View.getWindowToken().
flags int: Provides additional operating flags. Currently may be 0 or have the HIDE_IMPLICIT_ONLY bit set.
resultReceiver ResultReceiver: If non-null, this will be called by the IME when it has processed your request to tell you what it has done. The result code you receive may be either RESULT_UNCHANGED_SHOWN, RESULT_UNCHANGED_HIDDEN, RESULT_SHOWN, or RESULT_HIDDEN.
Returns
boolean

hideStatusIcon

Added in API level 3
void hideStatusIcon (IBinder imeToken)

Parameters
imeToken IBinder

isAcceptingText

Added in API level 3
boolean isAcceptingText ()

Return true if the currently served view is accepting full text edits. If false, it has no input connection, so can only handle raw key events.

Returns
boolean

isActive

Added in API level 3
boolean isActive ()

Return true if any view is currently active in the input method.

Returns
boolean

isActive

Added in API level 3
boolean isActive (View view)

Return true if the given view is the currently active view for the input method.

Parameters
view View
Returns
boolean

isFullscreenMode

Added in API level 3
boolean isFullscreenMode ()

Allows you to discover whether the attached input method is running in fullscreen mode. Return true if it is fullscreen, entirely covering your UI, else returns false.

Returns
boolean

isWatchingCursor

Added in API level 3
boolean isWatchingCursor (View view)

This method was deprecated in API level 21.
Use requestCursorUpdates(int) instead.

Return true if the current input method wants to watch the location of the input editor's cursor in its window.

Parameters
view View
Returns
boolean

restartInput

Added in API level 3
void restartInput (View view)

If the input method is currently connected to the given view, restart it with its new contents. You should call this when the text within your view changes outside of the normal input method or key input flow, such as when an application calls TextView.setText().

Parameters
view View: The view whose text has changed.

sendAppPrivateCommand

Added in API level 3
void sendAppPrivateCommand (View view, 
                String action, 
                Bundle data)

Call InputMethodSession.appPrivateCommand() on the current Input Method.

Parameters
view View: Optional View that is sending the command, or null if you want to send the command regardless of the view that is attached to the input method.
action String: Name of the command to be performed. This must be a scoped name, i.e. prefixed with a package name you own, so that different developers will not create conflicting commands.
data Bundle: Any data to include with the command.

setAdditionalInputMethodSubtypes

Added in API level 14
void setAdditionalInputMethodSubtypes (String imiId, 
                InputMethodSubtype[] subtypes)

Set additional input method subtypes. Only a process which shares the same uid with the IME can add additional input method subtypes to the IME. Please note that a subtype's status is stored in the system. For example, enabled subtypes are remembered by the framework even after they are removed by using this method. If you re-add the same subtypes again, they will just get enabled. If you want to avoid such conflicts, for instance, you may want to create a "different" new subtype even with the same locale and mode, by changing its extra value. The different subtype won't get affected by the stored past status. (You may want to take a look at hashCode() to refer to the current implementation.)

NOTE: If the same subtype exists in both the manifest XML file and additional subtypes specified by subtypes, those multiple instances are automatically merged into one instance.

CAVEAT: In API Level 23 and prior, the system may do nothing if an empty InputMethodSubtype is specified in subtypes, which prevents you from removing the last one entry of additional subtypes. If your IME statically defines one or more subtypes in the manifest XML file, you may be able to work around this limitation by specifying one of those statically defined subtypes in subtypes.

Parameters
imiId String: Id of InputMethodInfo which additional input method subtypes will be added to.
subtypes InputMethodSubtype: subtypes will be added as additional subtypes of the current input method.

setCurrentInputMethodSubtype

Added in API level 11
boolean setCurrentInputMethodSubtype (InputMethodSubtype subtype)

Switch to a new input method subtype of the current input method.

Parameters
subtype InputMethodSubtype: A new input method subtype to switch.
Returns
boolean true if the current subtype was successfully switched. When the specified subtype is null, this method returns false.

setInputMethod

Added in API level 3
void setInputMethod (IBinder token, 
                String id)

Force switch to a new input method component. This can only be called from an application or a service which has a token of the currently active input method.

Parameters
token IBinder: Supplies the identifying token given to an input method when it was started, which allows it to perform this operation on itself.
id String: The unique identifier for the new input method to be switched to.

setInputMethodAndSubtype

Added in API level 11
void setInputMethodAndSubtype (IBinder token, 
                String id, 
                InputMethodSubtype subtype)

Force switch to a new input method and subtype. This can only be called from an application or a service which has a token of the currently active input method.

Parameters
token IBinder: Supplies the identifying token given to an input method when it was started, which allows it to perform this operation on itself.
id String: The unique identifier for the new input method to be switched to.
subtype InputMethodSubtype: The new subtype of the new input method to be switched to.

shouldOfferSwitchingToNextInputMethod

Added in API level 19
boolean shouldOfferSwitchingToNextInputMethod (IBinder imeToken)

Returns true if the current IME needs to offer the users ways to switch to a next input method (e.g. a globe key.). When an IME sets supportsSwitchingToNextInputMethod and this method returns true, the IME has to offer ways to to invoke switchToNextInputMethod(IBinder, boolean) accordingly.

Note that the system determines the most appropriate next input method and subtype in order to provide the consistent user experience in switching between IMEs and subtypes.

Parameters
imeToken IBinder: Supplies the identifying token given to an input method when it was started, which allows it to perform this operation on itself.
Returns
boolean

showInputMethodAndSubtypeEnabler

Added in API level 11
void showInputMethodAndSubtypeEnabler (String imiId)

Show the settings for enabling subtypes of the specified input method.

Parameters
imiId String: An input method, whose subtypes settings will be shown. If imiId is null, subtypes of all input methods will be shown.

showInputMethodPicker

Added in API level 3
void showInputMethodPicker ()

showSoftInput

Added in API level 3
boolean showSoftInput (View view, 
                int flags, 
                ResultReceiver resultReceiver)

Explicitly request that the current input method's soft input area be shown to the user, if needed. Call this if the user interacts with your view in such a way that they have expressed they would like to start performing input into it.

Caveat: ResultReceiver instance passed to this method can be a long-lived object, because it may not be garbage-collected until all the corresponding ResultReceiver objects transferred to different processes get garbage-collected. Follow the general patterns to avoid memory leaks in Android. Consider to use WeakReference so that application logic objects such as Activity and Context can be garbage collected regardless of the lifetime of ResultReceiver.

Parameters
view View: The currently focused view, which would like to receive soft keyboard input.
flags int: Provides additional operating flags. Currently may be 0 or have the SHOW_IMPLICIT bit set.
resultReceiver ResultReceiver: If non-null, this will be called by the IME when it has processed your request to tell you what it has done. The result code you receive may be either RESULT_UNCHANGED_SHOWN, RESULT_UNCHANGED_HIDDEN, RESULT_SHOWN, or RESULT_HIDDEN.
Returns
boolean

showSoftInput

Added in API level 3
boolean showSoftInput (View view, 
                int flags)

Synonym for showSoftInput(View, int, ResultReceiver) without a result receiver: explicitly request that the current input method's soft input area be shown to the user, if needed.

Parameters
view View: The currently focused view, which would like to receive soft keyboard input.
flags int: Provides additional operating flags. Currently may be 0 or have the SHOW_IMPLICIT bit set.
Returns
boolean

showSoftInputFromInputMethod

Added in API level 3
void showSoftInputFromInputMethod (IBinder token, 
                int flags)

Show the input method's soft input area, so the user sees the input method window and can interact with it. This can only be called from the currently active input method, as validated by the given token.

Parameters
token IBinder: Supplies the identifying token given to an input method when it was started, which allows it to perform this operation on itself.
flags int: Provides additional operating flags. Currently may be 0 or have the SHOW_IMPLICIT or SHOW_FORCED bit set.

showStatusIcon

Added in API level 3
void showStatusIcon (IBinder imeToken, 
                String packageName, 
                int iconId)

Parameters
imeToken IBinder
packageName String
iconId int

switchToLastInputMethod

Added in API level 11
boolean switchToLastInputMethod (IBinder imeToken)

Force switch to the last used input method and subtype. If the last input method didn't have any subtypes, the framework will simply switch to the last input method with no subtype specified.

Parameters
imeToken IBinder: Supplies the identifying token given to an input method when it was started, which allows it to perform this operation on itself.
Returns
boolean true if the current input method and subtype was successfully switched to the last used input method and subtype.

switchToNextInputMethod

Added in API level 16
boolean switchToNextInputMethod (IBinder imeToken, 
                boolean onlyCurrentIme)

Force switch to the next input method and subtype. If there is no IME enabled except current IME and subtype, do nothing.

Parameters
imeToken IBinder: Supplies the identifying token given to an input method when it was started, which allows it to perform this operation on itself.
onlyCurrentIme boolean: if true, the framework will find the next subtype which belongs to the current IME
Returns
boolean true if the current input method and subtype was successfully switched to the next input method and subtype.

toggleSoftInput

Added in API level 3
void toggleSoftInput (int showFlags, 
                int hideFlags)

Parameters
showFlags int
hideFlags int

toggleSoftInputFromWindow

Added in API level 3
void toggleSoftInputFromWindow (IBinder windowToken, 
                int showFlags, 
                int hideFlags)

This method toggles the input method window display. If the input window is already displayed, it gets hidden. If not the input window will be displayed.

Parameters
windowToken IBinder: The token of the window that is making the request, as returned by View.getWindowToken().
showFlags int: Provides additional operating flags. May be 0 or have the SHOW_IMPLICIT, SHOW_FORCED bit set.
hideFlags int: Provides additional operating flags. May be 0 or have the HIDE_IMPLICIT_ONLY, HIDE_NOT_ALWAYS bit set.

updateCursor

Added in API level 3
void updateCursor (View view, 
                int left, 
                int top, 
                int right, 
                int bottom)

This method was deprecated in API level 21.
Use updateCursorAnchorInfo(View, CursorAnchorInfo) instead.

Report the current cursor location in its window.

Parameters
view View
left int
top int
right int
bottom int

updateCursorAnchorInfo

Added in API level 21
void updateCursorAnchorInfo (View view, 
                CursorAnchorInfo cursorAnchorInfo)

Report positional change of the text insertion point and/or characters in the composition string.

Parameters
view View
cursorAnchorInfo CursorAnchorInfo

updateExtractedText

Added in API level 3
void updateExtractedText (View view, 
                int token, 
                ExtractedText text)

Parameters
view View
token int
text ExtractedText

updateSelection

Added in API level 3
void updateSelection (View view, 
                int selStart, 
                int selEnd, 
                int candidatesStart, 
                int candidatesEnd)

Report the current selection range.

Editor authors, you need to call this method whenever the cursor moves in your editor. Remember that in addition to doing this, your editor needs to always supply current cursor values in initialSelStart and initialSelEnd every time onCreateInputConnection(EditorInfo) is called, which happens whenever the keyboard shows up or the focus changes to a text field, among other cases.

Parameters
view View
selStart int
selEnd int
candidatesStart int
candidatesEnd int

viewClicked

Added in API level 14
void viewClicked (View view)

Notify the event when the user tapped or clicked the text view.

Parameters
view View
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.