AbstractInputMethodService.AbstractInputMethodSessionImpl

Base class for derived classes to implement their InputMethodSession interface. This takes care of basic maintenance of the session, but most behavior must be implemented in a derived class.

Summary

Public Constructors
	AbstractInputMethodService.AbstractInputMethodSessionImpl()

Public Constructors

AbstractInputMethodService.AbstractInputMethodSessionImpl()

Public Methods
void	dispatchKeyEvent(int seq, KeyEvent event, InputMethodSession.EventCallback callback) Take care of dispatching incoming key events to the appropriate callbacks on the service, and tell the client when this is done.
void	dispatchTrackballEvent(int seq, MotionEvent event, InputMethodSession.EventCallback callback) Take care of dispatching incoming trackball events to the appropriate callbacks on the service, and tell the client when this is done.
boolean	isEnabled() Check whether this session has been enabled by the system.
boolean	isRevoked() Check whether this session has been revoked by the system.
void	revokeSelf() Revoke the session from the client.
void	setEnabled(boolean enabled) Change the enabled state of the session.

Public Methods

void

dispatchKeyEvent(int seq, KeyEvent event, InputMethodSession.EventCallback callback)

Take care of dispatching incoming key events to the appropriate callbacks on the service, and tell the client when this is done.

void

dispatchTrackballEvent(int seq, MotionEvent event, InputMethodSession.EventCallback callback)

Take care of dispatching incoming trackball events to the appropriate callbacks on the service, and tell the client when this is done.

boolean

isEnabled()

Check whether this session has been enabled by the system.

boolean

isRevoked()

Check whether this session has been revoked by the system.

void

revokeSelf()

Revoke the session from the client.

void

setEnabled(boolean enabled)

Change the enabled state of the session.

[Expand]

Inherited Methods

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.view.inputmethod.InputMethodSession

abstract void	appPrivateCommand(String action, Bundle data) Process a private command sent from the application to the input method.
abstract void	dispatchKeyEvent(int seq, KeyEvent event, InputMethodSession.EventCallback callback) This method is called when a key is pressed.
abstract void	dispatchTrackballEvent(int seq, MotionEvent event, InputMethodSession.EventCallback callback) This method is called when there is a track ball event.
abstract void	displayCompletions(CompletionInfo[] completions) Called by a text editor that performs auto completion, to tell the input method about the completions it has available.
abstract void	finishInput() This method is called when the application would like to stop receiving text input.
abstract void	toggleSoftInput(int showFlags, int hideFlags) Toggle the soft input window.
abstract void	updateCursor(Rect newCursor) This method is called when cursor location of the target input field has changed within its window.
abstract void	updateExtractedText(int token, ExtractedText text) Called by a text editor to report its new extracted text when its contents change.
abstract void	updateSelection(int oldSelStart, int oldSelEnd, int newSelStart, int newSelEnd, int candidatesStart, int candidatesEnd) This method is called when the selection or cursor in the current target input field has changed.
abstract void	viewClicked(boolean focusChanged) This method is called when the user tapped a text view.

Public Methods

public void dispatchKeyEvent (int seq, KeyEvent event, InputMethodSession.EventCallback callback)

Since: API Level 3

Take care of dispatching incoming key events to the appropriate callbacks on the service, and tell the client when this is done.

Parameters

event	The key event.

Returns

Whether the input method wants to handle this event.

public void dispatchTrackballEvent (int seq, MotionEvent event, InputMethodSession.EventCallback callback)

Since: API Level 3

Take care of dispatching incoming trackball events to the appropriate callbacks on the service, and tell the client when this is done.

Parameters

event	The motion event.

Returns

Whether the input method wants to handle this event.

public boolean isEnabled ()

Since: API Level 3

Check whether this session has been enabled by the system. If not enabled, you should not execute any calls on to it.

public boolean isRevoked ()

Since: API Level 3

Check whether this session has been revoked by the system. Revoked session is also always disabled, so there is generally no need to explicitly check for this.

public void revokeSelf ()

Since: API Level 3

Revoke the session from the client. This disabled the session, and prevents it from ever being enabled again.

public void setEnabled (boolean enabled)

Since: API Level 3

Change the enabled state of the session. This only works if the session has not been revoked.

Results

Interfaces

Classes

Class Overview

Summary

Public Constructors

public AbstractInputMethodService.AbstractInputMethodSessionImpl ()

Public Methods

public void dispatchKeyEvent (int seq, KeyEvent event, InputMethodSession.EventCallback callback)

Parameters

Returns

public void dispatchTrackballEvent (int seq, MotionEvent event, InputMethodSession.EventCallback callback)

Parameters

Returns

public boolean isEnabled ()

public boolean isRevoked ()

public void revokeSelf ()

public void setEnabled (boolean enabled)

java.lang.Object
↳	android.inputmethodservice.AbstractInputMethodService.AbstractInputMethodSessionImpl