QwertyKeyListener


public class QwertyKeyListener
extends BaseKeyListener

java.lang.Object
   ↳ android.text.method.MetaKeyKeyListener
     ↳ android.text.method.BaseKeyListener
       ↳ android.text.method.QwertyKeyListener


This is the standard key listener for alphabetic input on qwerty keyboards. You should generally not need to instantiate this yourself; TextKeyListener will do it for you.

As for all implementations of KeyListener, this class is only concerned with hardware keyboards. Software input methods have no obligation to trigger the methods in this class.

Summary

Inherited constants

int META_ALT_LOCKED

Flag that indicates that the ALT key is locked.

int META_ALT_ON

Flag that indicates that the ALT key is on.

int META_CAP_LOCKED

Flag that indicates that the SHIFT key is locked in CAPS mode.

int META_SHIFT_ON

Flag that indicates that the SHIFT key is on.

int META_SYM_LOCKED

Flag that indicates that the SYM key is locked.

int META_SYM_ON

Flag that indicates that the SYM key is on.

Public constructors

QwertyKeyListener(TextKeyListener.Capitalize cap, boolean autoText)

Public methods

int getInputType()
static QwertyKeyListener getInstance(boolean autoText, TextKeyListener.Capitalize cap)

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

static QwertyKeyListener getInstanceForFullKeyboard()

Gets an instance of the listener suitable for use with full keyboards.

static void markAsReplaced(Spannable content, int start, int end, String original)

Marks the specified region of content as having contained original prior to AutoText replacement.

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

Handles presses of the meta keys.

Inherited methods

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

Performs the action that happens when you press the KeyEvent.KEYCODE_DEL key in a TextView.

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

Performs the action that happens when you press the KeyEvent.KEYCODE_FORWARD_DEL key in a TextView.

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

Handles presses of the meta keys.

boolean onKeyOther(View view, Editable content, KeyEvent event)

Base implementation handles ACTION_MULTIPLE KEYCODE_UNKNOWN by inserting the event's text into the content.

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).

static long adjustMetaAfterKeypress(long state)

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).

static void clearMetaKeyState(Editable content, int states)
long clearMetaKeyState(long state, int which)

Clears the state of the specified meta key if it is locked.

void clearMetaKeyState(View view, Editable content, int states)
static final int getMetaState(CharSequence text)

Gets the state of the meta keys.

static final int getMetaState(CharSequence text, int meta)

Gets the state of a particular meta key.

static final int getMetaState(long state)

Gets the state of the meta keys.

static final int getMetaState(CharSequence text, KeyEvent event)

Gets the state of the meta keys for a specific key event.

static final int getMetaState(long state, int meta)

Gets the state of a particular meta key.

static final int getMetaState(CharSequence text, int meta, KeyEvent event)

Gets the state of a particular meta key to use with a particular key event.

static long handleKeyDown(long state, int keyCode, KeyEvent event)

Handles presses of the meta keys.

static long handleKeyUp(long state, int keyCode, KeyEvent event)

Handles release 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 any meta state in the specified text.

static boolean isSelectingMetaTracker(CharSequence text, Object what)

Returns true if this object is one that this class would use to keep track of the selecting 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 long resetLockedMeta(long state)

Call this if you are a method that ignores the locked meta state (arrow keys, for example) and you handle a key.

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.

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

abstract void clearMetaKeyState(View view, Editable content, int states)

Remove the given shift states from the edited text.

abstract int getInputType()

Return the type of text that this key listener is manipulating, as per InputType.

abstract boolean onKeyDown(View view, Editable text, int keyCode, KeyEvent event)

If the key listener wants to handle this key, return true, otherwise return false and the caller (i.e. the widget host) will handle the key.

abstract boolean onKeyOther(View view, Editable text, KeyEvent event)

If the key listener wants to other kinds of key events, return true, otherwise return false and the caller (i.e. the widget host) will handle the key.

abstract boolean onKeyUp(View view, Editable text, int keyCode, KeyEvent event)

If the key listener wants to handle this key release, return true, otherwise return false and the caller (i.e. the widget host) will handle the key.

Public constructors

QwertyKeyListener

Added in API level 1
public QwertyKeyListener (TextKeyListener.Capitalize cap, 
                boolean autoText)

Parameters
cap TextKeyListener.Capitalize

autoText boolean

Public methods

getInputType

Added in API level 3
public int getInputType ()

Returns
int

getInstance

Added in API level 1
public static QwertyKeyListener getInstance (boolean autoText, 
                TextKeyListener.Capitalize cap)

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

Parameters
autoText boolean

cap TextKeyListener.Capitalize

getInstanceForFullKeyboard

Added in API level 11
public static QwertyKeyListener getInstanceForFullKeyboard ()

Gets an instance of the listener suitable for use with full keyboards. Disables auto-capitalization, auto-text and long-press initiated on-screen character pickers.

markAsReplaced

Added in API level 1
public static void markAsReplaced (Spannable content, 
                int start, 
                int end, 
                String original)

Marks the specified region of content as having contained original prior to AutoText replacement. Call this method when you have done or are about to do an AutoText-style replacement on a region of text and want to let the same mechanism (the user pressing DEL immediately after the change) undo the replacement.

Parameters
content Spannable: the Editable text where the replacement was made

start int: the start of the replaced region

end int: the end of the replaced region; the location of the cursor

original String: the text to be restored if the user presses DEL

onKeyDown

Added in API level 1
public boolean onKeyDown (View view, 
                Editable content, 
                int keyCode, 
                KeyEvent event)

Handles presses of the meta keys.

Parameters
view View

content Editable

keyCode int

event KeyEvent

Returns
boolean