Android - An Open Handset Alliance Project

android.text.method
public class

android.text.method.TextInputMethod

java.lang.Object
	android.text.method.MetaKeyInputMethod
		android.text.method.BaseInputMethod		InputMethod
			android.text.method.TextInputMethod

This is the input method for typing normal text. It delegates to other input methods appropriate to the current keyboard and language.

Nested Classes

TextInputMethod.Capitalize

Summary

Constants inherited from class android.text.method.MetaKeyInputMethod

META_ALT_LOCKED, META_ALT_ON, META_CAP_LOCKED, META_CAP_ON, META_SYM_LOCKED, META_SYM_ON

		Value
int	META_ALT_LOCKED	512	0x00000200
int	META_ALT_ON	2	0x00000002
int	META_CAP_LOCKED	256	0x00000100
int	META_CAP_ON	1	0x00000001
int	META_SYM_LOCKED	1024	0x00000400
int	META_SYM_ON	4	0x00000004

Public Constructors

					TextInputMethod(Capitalize cap, boolean autotext)
					Creates a new TextInputMethod with the specified capitalization and correction properties.

Public Methods

static	void	clear(Editable e)
		Clear all the input state (autotext, autocap, multitap, undo) from the specified Editable, going beyond Editable.clear(), which just clears the text but not the input state.
static	TextInputMethod	getInstance(boolean autotext, Capitalize cap)
		Returns a new or existing instance with the specified capitalization and correction properties.
static	TextInputMethod	getInstance()
		Returns a new or existing instance with no automatic capitalization or correction.
	boolean	onKeyDown(View view, Editable content, int keyCode, KeyEvent event)
		Handles presses of the meta keys.
	boolean	onKeyUp(View view, Editable content, int keyCode, KeyEvent event)
		Handles release of the meta keys.
static	boolean	shouldCap(Capitalize cap, CharSequence cs, int off)
		Returns whether it makes sense to automatically capitalize at the specified position in the specified text, with the specified rules.

	Object	clone()
		Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
	boolean	equals(Object o)
		Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
	void	finalize()
		Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final	Class	getClass()
		Answers the unique instance of java.lang.Class which represents the class of the receiver.
	int	hashCode()
		Answers an integer hash code for the receiver.
final	void	notify()
		Causes one thread which is `wait` ing on the receiver to be made ready to run.
final	void	notifyAll()
		Causes all threads which are `wait` ing on the receiver to be made ready to run.
	String	toString()
		Answers a string containing a concise, human-readable description of the receiver.
final	void	wait(long time, int frac)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait(long time)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait()
		Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

Methods inherited from interface android.text.method.InputMethod

onKeyDown, onKeyUp

Details

Public Constructors

public TextInputMethod(Capitalize cap, boolean autotext)

Creates a new TextInputMethod with the specified capitalization and correction properties.

Parameters

cap	when, if ever, to automatically capitalize.
autotext	whether to automatically do spelling corrections.

Public Methods

public static void clear(Editable e)

Clear all the input state (autotext, autocap, multitap, undo) from the specified Editable, going beyond Editable.clear(), which just clears the text but not the input state.

Parameters

e	the buffer whose text and state are to be cleared.

public static TextInputMethod getInstance(boolean autotext, Capitalize cap)

Returns a new or existing instance with the specified capitalization and correction properties.

Parameters

autotext	whether to automatically do spelling corrections.
cap	when, if ever, to automatically capitalize.

public static TextInputMethod getInstance()

Returns a new or existing instance with no automatic capitalization or correction.

public boolean onKeyDown(View view, Editable content, int keyCode, KeyEvent event)

Handles presses of the meta keys.

public boolean onKeyUp(View view, Editable content, int keyCode, KeyEvent event)

Handles release of the meta keys.

public static boolean shouldCap(Capitalize cap, CharSequence cs, int off)

Returns whether it makes sense to automatically capitalize at the specified position in the specified text, with the specified rules.

Parameters

cap	the capitalization rules to consider.
cs	the text in which an insertion is being made.
off	the offset into that text where the insertion is being made.

Returns

whether the character being inserted should be capitalized.

				boolean	onKeyDown(View view, Editable text, int keyCode, KeyEvent event)
					If the input method wants to handle this key, return true, otherwise return false and the caller (i.e.
				boolean	onKeyUp(View view, Editable text, int keyCode, KeyEvent event)
					If the input method wants to handle this key release, return true, otherwise return false and the caller (i.e.

Android - An Open Handset Alliance Project

Documentation

Goodies

android.text.method.TextInputMethod

Nested Classes

Summary

Constants inherited from class android.text.method.MetaKeyInputMethod

Public Constructors

Public Methods

Methods inherited from class android.text.method.BaseInputMethod

Methods inherited from class android.text.method.MetaKeyInputMethod

Methods inherited from class java.lang.Object

Methods inherited from interface android.text.method.InputMethod

Details

Public Constructors

public TextInputMethod(Capitalize cap, boolean autotext)

Parameters

Public Methods

public static void clear(Editable e)

Parameters

public static TextInputMethod getInstance(boolean autotext, Capitalize cap)

Parameters

public static TextInputMethod getInstance()

public boolean onKeyDown(View view, Editable content, int keyCode, KeyEvent event)

public boolean onKeyUp(View view, Editable content, int keyCode, KeyEvent event)

public static boolean shouldCap(Capitalize cap, CharSequence cs, int off)

Parameters

Returns

				boolean	backspace(View view, Editable content, int keyCode, KeyEvent event)
					Performs the action that happens when you press the DEL key in a TextView.
				boolean	onKeyDown(View view, Editable content, int keyCode, KeyEvent event)
					Handles presses of the meta keys.

	static	void	adjustMetaAfterKeypress(Spannable content)
			Call this method after you handle a keypress so that the meta state will be reset to unshifted (if it is not still down) or primed to be reset to unshifted (once it is released).
final	static	int	getMetaState(CharSequence text, int meta)
			Gets the state of a particular meta key.
final	static	int	getMetaState(CharSequence text)
			Gets the state of the meta keys.
	static	boolean	isMetaTracker(CharSequence text, Object what)
			Returns true if this object is one that this class would use to keep track of meta state in the specified text.
		boolean	onKeyDown(View view, Editable content, int keyCode, KeyEvent event)
			Handles presses of the meta keys.
		boolean	onKeyUp(View view, Editable content, int keyCode, KeyEvent event)
			Handles release of the meta keys.
	static	void	resetLockedMeta(Spannable content)
			Call this if you are a method that ignores the locked meta state (arrow keys, for example) and you handle a key.
	static	void	resetMetaState(Spannable text)
			Resets all meta state to inactive.


e.g. "intent" or "activity"