Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)

Added in API level 3

public abstract class

AbstractInputMethodService

extends Service
implements KeyEvent.Callback

java.lang.Object
↳	android.content.Context
	↳	android.content.ContextWrapper
		↳	android.app.Service
			↳	android.inputmethodservice.AbstractInputMethodService

Known Direct Subclasses

InputMethodService

Class Overview

AbstractInputMethodService provides a abstract base class for input methods. Normal input method implementations will not derive from this directly, instead building on top of InputMethodService or another more complete base class. Be sure to read InputMethod for more information on the basics of writing input methods.

This class combines a Service (representing the input method component to the system with the InputMethod interface that input methods must implement. This base class takes care of reporting your InputMethod from the service when clients bind to it, but provides no standard implementation of the InputMethod interface itself. Derived classes must implement that interface.

Summary

Nested Classes
class	AbstractInputMethodService.AbstractInputMethodImpl	Base class for derived classes to implement their `InputMethod` interface.
class	AbstractInputMethodService.AbstractInputMethodSessionImpl	Base class for derived classes to implement their `InputMethodSession` interface.

[Expand]

Inherited Constants

From class android.app.Service

From class android.content.Context

From interface android.content.ComponentCallbacks2

int	TRIM_MEMORY_BACKGROUND	Level for `onTrimMemory(int)` : the process has gone on to the LRU list.
int	TRIM_MEMORY_COMPLETE	Level for `onTrimMemory(int)` : the process is nearing the end of the background LRU list, and if more memory isn't found soon it will be killed.
int	TRIM_MEMORY_MODERATE	Level for `onTrimMemory(int)` : the process is around the middle of the background LRU list; freeing memory can help the system keep other processes running later in the list for better overall performance.
int	TRIM_MEMORY_RUNNING_CRITICAL	Level for `onTrimMemory(int)` : the process is not an expendable background process, but the device is running extremely low on memory and is about to not be able to keep any background processes running.
int	TRIM_MEMORY_RUNNING_LOW	Level for `onTrimMemory(int)` : the process is not an expendable background process, but the device is running low on memory.
int	TRIM_MEMORY_RUNNING_MODERATE	Level for `onTrimMemory(int)` : the process is not an expendable background process, but the device is running moderately low on memory.
int	TRIM_MEMORY_UI_HIDDEN	Level for `onTrimMemory(int)` : the process had been showing a user interface, and is no longer doing so.

Public Constructors
	AbstractInputMethodService ()

Public Methods
KeyEvent.DispatcherState	getKeyDispatcherState () Return the global `KeyEvent.DispatcherState` for used for processing events from the target application.
final IBinder	onBind ( Intent intent) Return the communication channel to the service.
abstract AbstractInputMethodService.AbstractInputMethodImpl	onCreateInputMethodInterface () Called by the framework during initialization, when the InputMethod interface for this service needs to be created.
abstract AbstractInputMethodService.AbstractInputMethodSessionImpl	onCreateInputMethodSessionInterface () Called by the framework when a new InputMethodSession interface is needed for a new client of the input method.
boolean	onGenericMotionEvent ( MotionEvent event) Implement this to handle generic motion events on your input method.
boolean	onTrackballEvent ( MotionEvent event) Implement this to handle trackball events on your input method.

Protected Methods
void	dump ( FileDescriptor fd, PrintWriter fout, String[] args) Implement this to handle `Binder.dump()` calls on your input method.

[Expand]

Inherited Methods

From class android.app.Service

void	dump ( FileDescriptor fd, PrintWriter writer, String[] args) Print the Service's state into the given stream.
final Application	getApplication () Return the application that owns this service.
abstract IBinder	onBind ( Intent intent) Return the communication channel to the service.
void	onConfigurationChanged ( Configuration newConfig) Called by the system when the device configuration changes while your component is running.
void	onCreate () Called by the system when the service is first created.
void	onDestroy () Called by the system to notify a Service that it is no longer used and is being removed.
void	onLowMemory () This is called when the overall system is running low on memory, and actively running processes should trim their memory usage.
void	onRebind ( Intent intent) Called when new clients have connected to the service, after it had previously been notified that all had disconnected in its `onUnbind(Intent)` .
void	onStart ( Intent intent, int startId) This method was deprecated in API level 5. Implement `onStartCommand(Intent, int, int)` instead.
int	onStartCommand ( Intent intent, int flags, int startId) Called by the system every time a client explicitly starts the service by calling `startService(Intent)` , providing the arguments it supplied and a unique integer token representing the start request.
void	onTaskRemoved ( Intent rootIntent) This is called if the service is currently running and the user has removed a task that comes from the service's application.
void	onTrimMemory (int level) Called when the operating system has determined that it is a good time for a process to trim unneeded memory from its process.
boolean	onUnbind ( Intent intent) Called when all clients have disconnected from a particular interface published by the service.
final void	startForeground (int id, Notification notification) Make this service run in the foreground, supplying the ongoing notification to be shown to the user while in this state.
final void	stopForeground (boolean removeNotification) Remove this service from foreground state, allowing it to be killed if more memory is needed.
final void	stopSelf () Stop the service, if it was previously started.
final void	stopSelf (int startId) Old version of `stopSelfResult(int)` that doesn't return a result.
final boolean	stopSelfResult (int startId) Stop the service if the most recent time it was started was `startId` .

From class android.content.ContextWrapper

From class android.content.Context

From class java.lang.Object

Object	clone () Creates and returns a copy of this `Object` .
boolean	equals ( Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize () Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class <?>	getClass () Returns the unique instance of `Class` that represents this object's class.
int	hashCode () Returns an integer hash code for this object.
final void	notify () Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll () Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString () Returns a string containing a concise, human-readable description of this object.
final void	wait () Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait (long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait (long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface android.content.ComponentCallbacks

From interface android.content.ComponentCallbacks2

From interface android.view.KeyEvent.Callback

abstract boolean	onKeyDown (int keyCode, KeyEvent event) Called when a key down event has occurred.
abstract boolean	onKeyLongPress (int keyCode, KeyEvent event) Called when a long press has occurred.
abstract boolean	onKeyMultiple (int keyCode, int count, KeyEvent event) Called when multiple down/up pairs of the same key have occurred in a row.
abstract boolean	onKeyUp (int keyCode, KeyEvent event) Called when a key up event has occurred.

Public Constructors

public AbstractInputMethodService ()

Added in API level 3

Public Methods

public KeyEvent.DispatcherState getKeyDispatcherState ()

Added in API level 5

Return the global KeyEvent.DispatcherState for used for processing events from the target application. Normally you will not need to use this directly, but just use the standard high-level event callbacks like onKeyDown(int, KeyEvent) .

public final IBinder onBind ( Intent intent)

Added in API level 3

Return the communication channel to the service. May return null if clients can not bind to the service. The returned IBinder is usually for a complex interface that has been described using aidl .

Note that unlike other application components, calls on to the IBinder interface returned here may not happen on the main thread of the process . More information about the main thread can be found in Processes and Threads .

Parameters

intent	The Intent that was used to bind to this service, as given to `Context.bindService` . Note that any extras that were included with the Intent at that point will not be seen here.

Returns

Return an IBinder through which clients can call on to the service.

public abstract AbstractInputMethodService.AbstractInputMethodImpl onCreateInputMethodInterface ()

Added in API level 3

Called by the framework during initialization, when the InputMethod interface for this service needs to be created.

public abstract AbstractInputMethodService.AbstractInputMethodSessionImpl onCreateInputMethodSessionInterface ()

Added in API level 3

Called by the framework when a new InputMethodSession interface is needed for a new client of the input method.

public boolean onGenericMotionEvent ( MotionEvent event)

Added in API level 17

Implement this to handle generic motion events on your input method.

Parameters

event	The motion event being received.

Returns

True if the event was handled in this function, false otherwise.

public boolean onTrackballEvent ( MotionEvent event)

Added in API level 3

Implement this to handle trackball events on your input method.

Parameters

event	The motion event being received.

Returns

True if the event was handled in this function, false otherwise.

Protected Methods

protected void dump ( FileDescriptor fd, PrintWriter fout, String[] args)

Added in API level 3

Implement this to handle Binder.dump() calls on your input method.

Parameters

fd	The raw file descriptor that the dump is being sent to.
fout	The PrintWriter to which you should dump your state. This will be closed for you after you return.
args	additional arguments to the dump request.

Results

Interfaces

Classes

AbstractInputMethodService

Class Overview

Summary

Public Constructors

public AbstractInputMethodService ()

Public Methods

public KeyEvent.DispatcherState getKeyDispatcherState ()

public final IBinder onBind ( Intent intent)

Parameters

Returns

public abstract AbstractInputMethodService.AbstractInputMethodImpl onCreateInputMethodInterface ()

public abstract AbstractInputMethodService.AbstractInputMethodSessionImpl onCreateInputMethodSessionInterface ()

public boolean onGenericMotionEvent ( MotionEvent event)

Parameters

Returns

See Also

public boolean onTrackballEvent ( MotionEvent event)

Parameters

Returns

See Also

Protected Methods

protected void dump ( FileDescriptor fd, PrintWriter fout, String[] args)

Parameters