FileDocCategorySizeDatePackage
InputMethodManager.javaAPI DocAndroid 1.5 API53545Wed May 06 22:41:56 BST 2009android.view.inputmethod

InputMethodManager

public final class InputMethodManager extends Object
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 {@link Context#getSystemService(String) Context.getSystemService()}.

Topics covered here:

  1. Architecture Overview

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 {@link android.widget.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 {@link android.R.attr#inputType} if 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 {@link android.R.attr#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 {@link android.R.attr#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 {@link android.view.View#onCreateInputConnection} to return a new instance of your own {@link InputConnection} interface allowing the IME to interact with your editor.

Input Methods

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

See the {@link android.inputmethodservice.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 {@link InputMethod} interface, via the {@link android.Manifest.permission#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 {@link 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 {@link android.inputmethodservice.AbstractInputMethodService} for normal IMEs, but must be explicitly handled by an IME that is customizing the raw {@link InputMethodSession} implementation.

  • Only the active client's {@link 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 {@link 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.

Fields Summary
static final boolean
DEBUG
static final String
TAG
static final Object
mInstanceSync
static InputMethodManager
mInstance
final com.android.internal.view.IInputMethodManager
mService
final android.os.Looper
mMainLooper
final H
mH
final com.android.internal.view.IInputContext
mIInputContext
boolean
mActive
True if this input method client is active, initially false.
boolean
mHasBeenInactive
Set whenever this client becomes inactive, to know we need to reset state with the IME then next time we receive focus.
boolean
mFullscreenMode
As reported by IME through InputConnection.
android.view.View
mCurRootView
This is the root view of the overall window that currently has input method focus.
android.view.View
mServedView
This is the view that should currently be served by an input method, regardless of the state of setting that up.
android.view.View
mNextServedView
This is then next view that will be served by the input method, when we get around to updating things.
boolean
mNextServedNeedsStart
True if we should restart input in the next served view, even if the view hasn't actually changed from the current serve view.
boolean
mServedConnecting
This is set when we are in the process of connecting, to determine when we have actually finished.
EditorInfo
mCurrentTextBoxAttribute
This is non-null when we have connected the served view; it holds the attributes that were last retrieved from the served view and given to the input connection.
InputConnection
mServedInputConnection
The InputConnection that was last retrieved from the served view.
CompletionInfo[]
mCompletions
The completions that were last provided by the served view.
android.graphics.Rect
mTmpCursorRect
android.graphics.Rect
mCursorRect
int
mCursorSelStart
int
mCursorSelEnd
int
mCursorCandStart
int
mCursorCandEnd
int
mBindSequence
Sequence number of this binding, as returned by the server.
String
mCurId
ID of the method we are bound to.
com.android.internal.view.IInputMethodSession
mCurMethod
The actual instance of the method to make calls on it.
static final int
MSG_DUMP
static final int
MSG_BIND
static final int
MSG_UNBIND
static final int
MSG_SET_ACTIVE
final IInputMethodClient.Stub
mClient
final InputConnection
mDummyInputConnection
public static final int
SHOW_IMPLICIT
Flag for {@link #showSoftInput} 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.
public static final int
SHOW_FORCED
Flag for {@link #showSoftInput} 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.
public static final int
RESULT_UNCHANGED_SHOWN
Flag for the {@link ResultReceiver} result code from {@link #showSoftInput(View, int, ResultReceiver)} and {@link #hideSoftInputFromWindow(IBinder, int, ResultReceiver)}: the state of the soft input window was unchanged and remains shown.
public static final int
RESULT_UNCHANGED_HIDDEN
Flag for the {@link ResultReceiver} result code from {@link #showSoftInput(View, int, ResultReceiver)} and {@link #hideSoftInputFromWindow(IBinder, int, ResultReceiver)}: the state of the soft input window was unchanged and remains hidden.
public static final int
RESULT_SHOWN
Flag for the {@link ResultReceiver} result code from {@link #showSoftInput(View, int, ResultReceiver)} and {@link #hideSoftInputFromWindow(IBinder, int, ResultReceiver)}: the state of the soft input window changed from hidden to shown.
public static final int
RESULT_HIDDEN
Flag for the {@link ResultReceiver} result code from {@link #showSoftInput(View, int, ResultReceiver)} and {@link #hideSoftInputFromWindow(IBinder, int, ResultReceiver)}: the state of the soft input window changed from shown to hidden.
public static final int
HIDE_IMPLICIT_ONLY
Flag for {@link #hideSoftInputFromWindow} to indicate that the soft input window should only be hidden if it was not explicitly shown by the user.
public static final int
HIDE_NOT_ALWAYS
Flag for {@link #hideSoftInputFromWindow} to indicate that the soft input window should normally be hidden, unless it was originally shown with {@link #SHOW_FORCED}.
Constructors Summary
InputMethodManager(com.android.internal.view.IInputMethodManager service, android.os.Looper looper)

    
        
        mService = service;
        mMainLooper = looper;
        mH = new H(looper);
        mIInputContext = new ControlledInputConnectionWrapper(looper,
                mDummyInputConnection);
        
        if (mInstance == null) {
            mInstance = this;
        }
Methods Summary
public voidcheckFocus()

hide

        // This is called a lot, so short-circuit before locking.
        if (mServedView == mNextServedView && !mNextServedNeedsStart) {
            return;
        }
        
        InputConnection ic = null;
        synchronized (mH) {
            if (mServedView == mNextServedView && !mNextServedNeedsStart) {
                return;
            }
            if (DEBUG) Log.v(TAG, "checkFocus: view=" + mServedView
                    + " next=" + mNextServedView
                    + " restart=" + mNextServedNeedsStart);
            
            mNextServedNeedsStart = false;
            if (mNextServedView == null) {
                finishInputLocked();
                // In this case, we used to have a focused view on the window,
                // but no longer do.  We should make sure the input method is
                // no longer shown, since it serves no purpose.
                closeCurrentInput();
                return;
            }
            
            ic = mServedInputConnection;
            
            mServedView = mNextServedView;
            mCurrentTextBoxAttribute = null;
            mCompletions = null;
            mServedConnecting = true;
        }
        
        if (ic != null) {
            ic.finishComposingText();
        }
        
        startInputInner();
voidclearBindingLocked()
Reset all of the state associated with being bound to an input method.

        clearConnectionLocked();
        mBindSequence = -1;
        mCurId = null;
        mCurMethod = null;
voidclearConnectionLocked()
Reset all of the state associated with a served view being connected to an input method

        mCurrentTextBoxAttribute = null;
        mServedInputConnection = null;
voidcloseCurrentInput()

        try {
            mService.hideSoftInput(mClient, HIDE_NOT_ALWAYS, null);
        } catch (RemoteException e) {
        }
public voiddispatchKeyEvent(android.content.Context context, int seq, android.view.KeyEvent key, com.android.internal.view.IInputMethodCallback callback)

hide

        synchronized (mH) {
            if (DEBUG) Log.d(TAG, "dispatchKeyEvent");
    
            if (mCurMethod == null) {
                try {
                    callback.finishedEvent(seq, false);
                } catch (RemoteException e) {
                }
                return;
            }
    
            if (key.getAction() == KeyEvent.ACTION_DOWN
                    && key.getKeyCode() == KeyEvent.KEYCODE_SYM) {
                showInputMethodPicker();
                try {
                    callback.finishedEvent(seq, true);
                } catch (RemoteException e) {
                }
                return;
            }
            try {
                if (DEBUG) Log.v(TAG, "DISPATCH KEY: " + mCurMethod);
                mCurMethod.dispatchKeyEvent(seq, key, callback);
            } catch (RemoteException e) {
                Log.w(TAG, "IME died: " + mCurId + " dropping: " + key, e);
                try {
                    callback.finishedEvent(seq, false);
                } catch (RemoteException ex) {
                }
            }
        }
voiddispatchTrackballEvent(android.content.Context context, int seq, android.view.MotionEvent motion, com.android.internal.view.IInputMethodCallback callback)

hide

        synchronized (mH) {
            if (DEBUG) Log.d(TAG, "dispatchTrackballEvent");
    
            if (mCurMethod == null || mCurrentTextBoxAttribute == null) {
                try {
                    callback.finishedEvent(seq, false);
                } catch (RemoteException e) {
                }
                return;
            }
    
            try {
                if (DEBUG) Log.v(TAG, "DISPATCH TRACKBALL: " + mCurMethod);
                mCurMethod.dispatchTrackballEvent(seq, motion, callback);
            } catch (RemoteException e) {
                Log.w(TAG, "IME died: " + mCurId + " dropping trackball: " + motion, e);
                try {
                    callback.finishedEvent(seq, false);
                } catch (RemoteException ex) {
                }
            }
        }
public voiddisplayCompletions(android.view.View view, CompletionInfo[] completions)

        checkFocus();
        synchronized (mH) {
            if (mServedView != view && (mServedView == null
                            || !mServedView.checkInputConnectionProxy(view))) {
                return;
            }
            
            mCompletions = completions;
            if (mCurMethod != null) {
                try {
                    mCurMethod.displayCompletions(mCompletions);
                } catch (RemoteException e) {
                }
            }
        }
voiddoDump(java.io.FileDescriptor fd, java.io.PrintWriter fout, java.lang.String[] args)

        final Printer p = new PrintWriterPrinter(fout);
        p.println("Input method client state for " + this + ":");
        
        p.println("  mService=" + mService);
        p.println("  mMainLooper=" + mMainLooper);
        p.println("  mIInputContext=" + mIInputContext);
        p.println("  mActive=" + mActive
                + " mHasBeenInactive=" + mHasBeenInactive
                + " mBindSequence=" + mBindSequence
                + " mCurId=" + mCurId);
        p.println("  mCurMethod=" + mCurMethod);
        p.println("  mCurRootView=" + mCurRootView);
        p.println("  mServedView=" + mServedView);
        p.println("  mNextServedNeedsStart=" + mNextServedNeedsStart
                + " mNextServedView=" + mNextServedView);
        p.println("  mServedConnecting=" + mServedConnecting);
        if (mCurrentTextBoxAttribute != null) {
            p.println("  mCurrentTextBoxAttribute:");
            mCurrentTextBoxAttribute.dump(p, "    ");
        } else {
            p.println("  mCurrentTextBoxAttribute: null");
        }
        p.println("  mServedInputConnection=" + mServedInputConnection);
        p.println("  mCompletions=" + mCompletions);
        p.println("  mCursorRect=" + mCursorRect);
        p.println("  mCursorSelStart=" + mCursorSelStart
                + " mCursorSelEnd=" + mCursorSelEnd
                + " mCursorCandStart=" + mCursorCandStart
                + " mCursorCandEnd=" + mCursorCandEnd);
voidfinishInputLocked()
Disconnect any existing input connection, clearing the served view.

        mNextServedView = null;
        if (mServedView != null) {
            if (DEBUG) Log.v(TAG, "FINISH INPUT: " + mServedView);
            
            if (mCurrentTextBoxAttribute != null) {
                try {
                    mService.finishInput(mClient);
                } catch (RemoteException e) {
                }
            }
            
            if (mServedInputConnection != null) {
                // We need to tell the previously served view that it is no
                // longer the input target, so it can reset its state.  Schedule
                // this call on its window's Handler so it will be on the correct
                // thread and outside of our lock.
                Handler vh = mServedView.getHandler();
                if (vh != null) {
                    // This will result in a call to reportFinishInputConnection()
                    // below.
                    vh.sendMessage(vh.obtainMessage(ViewRoot.FINISH_INPUT_CONNECTION,
                            mServedInputConnection));
                }
            }
            
            mServedView = null;
            mCompletions = null;
            mServedConnecting = false;
            clearConnectionLocked();
        }
public voidfocusIn(android.view.View view)
Call this when a view receives focus.

hide

        synchronized (mH) {
            focusInLocked(view);
        }
voidfocusInLocked(android.view.View view)

        if (DEBUG) Log.v(TAG, "focusIn: " + view);
        
        if (mCurRootView != view.getRootView()) {
            // This is a request from a window that isn't in the window with
            // IME focus, so ignore it.
            if (DEBUG) Log.v(TAG, "Not IME target window, ignoring");
            return;
        }
        
        mNextServedView = view;
        scheduleCheckFocusLocked(view);
public voidfocusOut(android.view.View view)
Call this when a view loses focus.

hide

        synchronized (mH) {
            if (DEBUG) Log.v(TAG, "focusOut: " + view
                    + " mServedView=" + mServedView
                    + " winFocus=" + view.hasWindowFocus());
            if (mServedView != view) {
                // The following code would auto-hide the IME if we end up
                // with no more views with focus.  This can happen, however,
                // whenever we go into touch mode, so it ends up hiding
                // at times when we don't really want it to.  For now it
                // seems better to just turn it all off.
                if (false && view.hasWindowFocus()) {
                    mNextServedView = null;
                    scheduleCheckFocusLocked(view);
                }
            }
        }
public com.android.internal.view.IInputMethodClientgetClient()

hide

        return mClient;
public java.util.ListgetEnabledInputMethodList()

        try {
            return mService.getEnabledInputMethodList();
        } catch (RemoteException e) {
            throw new RuntimeException(e);
        }
public com.android.internal.view.IInputContextgetInputContext()

hide

        return mIInputContext;
public java.util.ListgetInputMethodList()

        try {
            return mService.getInputMethodList();
        } catch (RemoteException e) {
            throw new RuntimeException(e);
        }
public static android.view.inputmethod.InputMethodManagergetInstance(android.content.Context context)
Retrieve the global InputMethodManager instance, creating it if it doesn't already exist.

hide

        synchronized (mInstanceSync) {
            if (mInstance != null) {
                return mInstance;
            }
            IBinder b = ServiceManager.getService(Context.INPUT_METHOD_SERVICE);
            IInputMethodManager service = IInputMethodManager.Stub.asInterface(b);
            mInstance = new InputMethodManager(service, context.getMainLooper());
        }
        return mInstance;
public voidhideSoftInputFromInputMethod(android.os.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.

param
token Supplies the identifying token given to an input method when it was started, which allows it to perform this operation on itself.
param
flags Provides additional operating flags. Currently may be 0 or have the {@link #HIDE_IMPLICIT_ONLY}, {@link #HIDE_NOT_ALWAYS} bit set.

        try {
            mService.hideMySoftInput(token, flags);
        } catch (RemoteException e) {
            throw new RuntimeException(e);
        }
public booleanhideSoftInputFromWindow(android.os.IBinder windowToken, int flags)
Synonym for {@link #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.

param
windowToken The token of the window that is making the request, as returned by {@link View#getWindowToken() View.getWindowToken()}.
param
flags Provides additional operating flags. Currently may be 0 or have the {@link #HIDE_IMPLICIT_ONLY} bit set.

    
                                                                         
          
        return hideSoftInputFromWindow(windowToken, flags, null);
public booleanhideSoftInputFromWindow(android.os.IBinder windowToken, int flags, android.os.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.

param
windowToken The token of the window that is making the request, as returned by {@link View#getWindowToken() View.getWindowToken()}.
param
flags Provides additional operating flags. Currently may be 0 or have the {@link #HIDE_IMPLICIT_ONLY} bit set.
param
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 {@link #RESULT_UNCHANGED_SHOWN}, {@link #RESULT_UNCHANGED_HIDDEN}, {@link #RESULT_SHOWN}, or {@link #RESULT_HIDDEN}.

        checkFocus();
        synchronized (mH) {
            if (mServedView == null || mServedView.getWindowToken() != windowToken) {
                return false;
            }

            try {
                return mService.hideSoftInput(mClient, flags, resultReceiver);
            } catch (RemoteException e) {
            }
            return false;
        }
public voidhideStatusIcon(android.os.IBinder imeToken)

        try {
            mService.updateStatusIcon(imeToken, null, 0);
        } catch (RemoteException e) {
            throw new RuntimeException(e);
        }
public booleanisAcceptingText()
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.

        checkFocus();
        return mServedInputConnection != null;
public booleanisActive(android.view.View view)
Return true if the given view is the currently active view for the input method.

        checkFocus();
        synchronized (mH) {
            return (mServedView == view
                    || (mServedView != null
                            && mServedView.checkInputConnectionProxy(view)))
                    && mCurrentTextBoxAttribute != null;
        }
public booleanisActive()
Return true if any view is currently active in the input method.

        checkFocus();
        synchronized (mH) {
            return mServedView != null && mCurrentTextBoxAttribute != null;
        }
public booleanisFullscreenMode()
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.

        return mFullscreenMode;
public booleanisWatchingCursor(android.view.View view)
Returns true if the current input method wants to watch the location of the input editor's cursor in its window.

        return false;
public voidonWindowFocus(android.view.View rootView, android.view.View focusedView, int softInputMode, boolean first, int windowFlags)
Called by ViewRoot when its window gets input focus.

hide

        synchronized (mH) {
            if (DEBUG) Log.v(TAG, "onWindowFocus: " + focusedView
                    + " softInputMode=" + softInputMode
                    + " first=" + first + " flags=#"
                    + Integer.toHexString(windowFlags));
            if (mHasBeenInactive) {
                if (DEBUG) Log.v(TAG, "Has been inactive!  Starting fresh");
                mHasBeenInactive = false;
                mNextServedNeedsStart = true;
            }
            focusInLocked(focusedView != null ? focusedView : rootView);
        }
        
        checkFocus();
        
        synchronized (mH) {
            try {
                final boolean isTextEditor = focusedView != null &&
                        focusedView.onCheckIsTextEditor();
                mService.windowGainedFocus(mClient, rootView.getWindowToken(),
                        focusedView != null, isTextEditor, softInputMode, first,
                        windowFlags);
            } catch (RemoteException e) {
            }
        }
public static android.view.inputmethod.InputMethodManagerpeekInstance()
Private optimization: retrieve the global InputMethodManager instance, if it exists.

hide

        return mInstance;
public voidreportFinishInputConnection(InputConnection ic)
Called from the FINISH_INPUT_CONNECTION message above.

hide

        if (mServedInputConnection != ic) {
            ic.finishComposingText();
        }
public voidrestartInput(android.view.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().

param
view The view whose text has changed.

        checkFocus();
        synchronized (mH) {
            if (mServedView != view && (mServedView == null
                    || !mServedView.checkInputConnectionProxy(view))) {
                return;
            }
            
            mServedConnecting = true;
        }
        
        startInputInner();
voidscheduleCheckFocusLocked(android.view.View view)

        Handler vh = view.getHandler();
        if (vh != null && !vh.hasMessages(ViewRoot.CHECK_FOCUS)) {
            // This will result in a call to checkFocus() below.
            vh.sendMessage(vh.obtainMessage(ViewRoot.CHECK_FOCUS));
        }
public voidsendAppPrivateCommand(android.view.View view, java.lang.String action, android.os.Bundle data)
Call {@link InputMethodSession#appPrivateCommand(String, Bundle) InputMethodSession.appPrivateCommand()} on the current Input Method.

param
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.
param
action 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.
param
data Any data to include with the command.

        checkFocus();
        synchronized (mH) {
            if ((mServedView != view && (mServedView == null
                        || !mServedView.checkInputConnectionProxy(view)))
                    || mCurrentTextBoxAttribute == null || mCurMethod == null) {
                return;
            }
            try {
                if (DEBUG) Log.v(TAG, "APP PRIVATE COMMAND " + action + ": " + data);
                mCurMethod.appPrivateCommand(action, data);
            } catch (RemoteException e) {
                Log.w(TAG, "IME died: " + mCurId, e);
            }
        }
public voidsetFullscreenMode(boolean fullScreen)

hide

        mFullscreenMode = fullScreen;
public voidsetInputMethod(android.os.IBinder token, java.lang.String id)
Force switch to a new input method component. This can only be called from the currently active input method, as validated by the given token.

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

        try {
            mService.setInputMethod(token, id);
        } catch (RemoteException e) {
            throw new RuntimeException(e);
        }
public voidshowInputMethodPicker()

        synchronized (mH) {
            try {
                mService.showInputMethodPickerFromClient(mClient);
            } catch (RemoteException e) {
                Log.w(TAG, "IME died: " + mCurId, e);
            }
        }
public booleanshowSoftInput(android.view.View view, int flags)
Synonym for {@link #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.

param
view The currently focused view, which would like to receive soft keyboard input.
param
flags Provides additional operating flags. Currently may be 0 or have the {@link #SHOW_IMPLICIT} bit set.

    
                                                                     
          
        return showSoftInput(view, flags, null);
public booleanshowSoftInput(android.view.View view, int flags, android.os.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.

param
view The currently focused view, which would like to receive soft keyboard input.
param
flags Provides additional operating flags. Currently may be 0 or have the {@link #SHOW_IMPLICIT} bit set.
param
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 {@link #RESULT_UNCHANGED_SHOWN}, {@link #RESULT_UNCHANGED_HIDDEN}, {@link #RESULT_SHOWN}, or {@link #RESULT_HIDDEN}.

    
                                                                                                                                
         
              
        checkFocus();
        synchronized (mH) {
            if (mServedView != view && (mServedView == null
                    || !mServedView.checkInputConnectionProxy(view))) {
                return false;
            }

            try {
                return mService.showSoftInput(mClient, flags, resultReceiver);
            } catch (RemoteException e) {
            }
            
            return false;
        }
public voidshowSoftInputFromInputMethod(android.os.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.

param
token Supplies the identifying token given to an input method when it was started, which allows it to perform this operation on itself.
param
flags Provides additional operating flags. Currently may be 0 or have the {@link #SHOW_IMPLICIT} or {@link #SHOW_FORCED} bit set.

        try {
            mService.showMySoftInput(token, flags);
        } catch (RemoteException e) {
            throw new RuntimeException(e);
        }
public voidshowSoftInputUnchecked(int flags, android.os.ResultReceiver resultReceiver)

hide

        try {
            mService.showSoftInput(mClient, flags, resultReceiver);
        } catch (RemoteException e) {
        }
public voidshowStatusIcon(android.os.IBinder imeToken, java.lang.String packageName, int iconId)

        try {
            mService.updateStatusIcon(imeToken, packageName, iconId);
        } catch (RemoteException e) {
            throw new RuntimeException(e);
        }
public voidstartGettingWindowFocus(android.view.View rootView)

hide

        synchronized (mH) {
            mCurRootView = rootView;
        }
voidstartInputInner()

        final View view;
        synchronized (mH) {
            view = mServedView;
            
            // Make sure we have a window token for the served view.
            if (DEBUG) Log.v(TAG, "Starting input: view=" + view);
            if (view == null) {
                if (DEBUG) Log.v(TAG, "ABORT input: no served view!");
                return;
            }
        }
        
        // Now we need to get an input connection from the served view.
        // This is complicated in a couple ways: we can't be holding our lock
        // when calling out to the view, and we need to make sure we call into
        // the view on the same thread that is driving its view hierarchy.
        Handler vh = view.getHandler();
        if (vh == null) {
            // If the view doesn't have a handler, something has changed out
            // from under us, so just bail.
            if (DEBUG) Log.v(TAG, "ABORT input: no handler for view!");
            return;
        }
        if (vh.getLooper() != Looper.myLooper()) {
            // The view is running on a different thread than our own, so
            // we need to reschedule our work for over there.
            if (DEBUG) Log.v(TAG, "Starting input: reschedule to view thread");
            vh.post(new Runnable() {
                public void run() {
                    startInputInner();
                }
            });
            return;
        }
        
        // Okay we are now ready to call into the served view and have it
        // do its stuff.
        // Life is good: let's hook everything up!
        EditorInfo tba = new EditorInfo();
        tba.packageName = view.getContext().getPackageName();
        tba.fieldId = view.getId();
        InputConnection ic = view.onCreateInputConnection(tba);
        if (DEBUG) Log.v(TAG, "Starting input: tba=" + tba + " ic=" + ic);
        
        synchronized (mH) {
            // Now that we are locked again, validate that our state hasn't
            // changed.
            if (mServedView != view || !mServedConnecting) {
                // Something else happened, so abort.
                if (DEBUG) Log.v(TAG, 
                        "Starting input: finished by someone else (view="
                        + mServedView + " conn=" + mServedConnecting + ")");
                return;
            }
            
            // If we already have a text box, then this view is already
            // connected so we want to restart it.
            final boolean initial = mCurrentTextBoxAttribute == null;
            
            // Hook 'em up and let 'er rip.
            mCurrentTextBoxAttribute = tba;
            mServedConnecting = false;
            mServedInputConnection = ic;
            IInputContext servedContext;
            if (ic != null) {
                mCursorSelStart = tba.initialSelStart;
                mCursorSelEnd = tba.initialSelEnd;
                mCursorCandStart = -1;
                mCursorCandEnd = -1;
                mCursorRect.setEmpty();
                servedContext = new ControlledInputConnectionWrapper(vh.getLooper(), ic);
            } else {
                servedContext = null;
            }
            
            try {
                if (DEBUG) Log.v(TAG, "START INPUT: " + view + " ic="
                        + ic + " tba=" + tba + " initial=" + initial);
                InputBindResult res = mService.startInput(mClient,
                        servedContext, tba, initial, mCurMethod == null);
                if (DEBUG) Log.v(TAG, "Starting input: Bind result=" + res);
                if (res != null) {
                    if (res.id != null) {
                        mBindSequence = res.sequence;
                        mCurMethod = res.method;
                    } else {
                        // This means there is no input method available.
                        if (DEBUG) Log.v(TAG, "ABORT input: no input method!");
                        return;
                    }
                }
                if (mCurMethod != null && mCompletions != null) {
                    try {
                        mCurMethod.displayCompletions(mCompletions);
                    } catch (RemoteException e) {
                    }
                }
            } catch (RemoteException e) {
                Log.w(TAG, "IME died: " + mCurId, e);
            }
        }
public voidtoggleSoftInput(int showFlags, int hideFlags)

        if (mCurMethod != null) {
            try {
                mCurMethod.toggleSoftInput(showFlags, hideFlags);
            } catch (RemoteException e) {
            }
        }
public voidtoggleSoftInputFromWindow(android.os.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.

param
windowToken The token of the window that is making the request, as returned by {@link View#getWindowToken() View.getWindowToken()}.
param
showFlags Provides additional operating flags. May be 0 or have the {@link #SHOW_IMPLICIT}, {@link #SHOW_FORCED} bit set.
param
hideFlags Provides additional operating flags. May be 0 or have the {@link #HIDE_IMPLICIT_ONLY}, {@link #HIDE_NOT_ALWAYS} bit set.

        synchronized (mH) {
            if (mServedView == null || mServedView.getWindowToken() != windowToken) {
                return;
            }
            if (mCurMethod != null) {
                try {
                    mCurMethod.toggleSoftInput(showFlags, hideFlags);
                } catch (RemoteException e) {
                }
            }
        }
public voidupdateCursor(android.view.View view, int left, int top, int right, int bottom)
Report the current cursor location in its window.

        checkFocus();
        synchronized (mH) {
            if ((mServedView != view && (mServedView == null
                        || !mServedView.checkInputConnectionProxy(view)))
                    || mCurrentTextBoxAttribute == null || mCurMethod == null) {
                return;
            }
            
            mTmpCursorRect.set(left, top, right, bottom);
            if (!mCursorRect.equals(mTmpCursorRect)) {
                if (DEBUG) Log.d(TAG, "updateCursor");

                try {
                    if (DEBUG) Log.v(TAG, "CURSOR CHANGE: " + mCurMethod);
                    mCurMethod.updateCursor(mTmpCursorRect);
                    mCursorRect.set(mTmpCursorRect);
                } catch (RemoteException e) {
                    Log.w(TAG, "IME died: " + mCurId, e);
                }
            }
        }
public voidupdateExtractedText(android.view.View view, int token, ExtractedText text)

        checkFocus();
        synchronized (mH) {
            if (mServedView != view && (mServedView == null
                    || !mServedView.checkInputConnectionProxy(view))) {
                return;
            }
            
            if (mCurMethod != null) {
                try {
                    mCurMethod.updateExtractedText(token, text);
                } catch (RemoteException e) {
                }
            }
        }
public voidupdateSelection(android.view.View view, int selStart, int selEnd, int candidatesStart, int candidatesEnd)
Report the current selection range.

        checkFocus();
        synchronized (mH) {
            if ((mServedView != view && (mServedView == null
                        || !mServedView.checkInputConnectionProxy(view)))
                    || mCurrentTextBoxAttribute == null || mCurMethod == null) {
                return;
            }
            
            if (mCursorSelStart != selStart || mCursorSelEnd != selEnd
                    || mCursorCandStart != candidatesStart
                    || mCursorCandEnd != candidatesEnd) {
                if (DEBUG) Log.d(TAG, "updateSelection");

                try {
                    if (DEBUG) Log.v(TAG, "SELECTION CHANGE: " + mCurMethod);
                    mCurMethod.updateSelection(mCursorSelStart, mCursorSelEnd,
                            selStart, selEnd, candidatesStart, candidatesEnd);
                    mCursorSelStart = selStart;
                    mCursorSelEnd = selEnd;
                    mCursorCandStart = candidatesStart;
                    mCursorCandEnd = candidatesEnd;
                } catch (RemoteException e) {
                    Log.w(TAG, "IME died: " + mCurId, e);
                }
            }
        }
public voidwindowDismissed(android.os.IBinder appWindowToken)
When the focused window is dismissed, this method is called to finish the input method started before.

hide

        checkFocus();
        synchronized (mH) {
            if (mServedView != null &&
                    mServedView.getWindowToken() == appWindowToken) {
                finishInputLocked();
            }
        }