BaseKeyListener

Kotlin |Java

public abstract class BaseKeyListener
extends MetaKeyKeyListener implements KeyListener

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

Known direct subclasses

MultiTapKeyListener, NumberKeyListener, QwertyKeyListener, TextKeyListener

MultiTapKeyListener	This is the standard key listener for alphabetic input on 12-key keyboards.
NumberKeyListener	For numeric text entry As for all implementations of `KeyListener`, this class is only concerned with hardware keyboards.
QwertyKeyListener	This is the standard key listener for alphabetic input on qwerty keyboards.
TextKeyListener	This is the key listener for typing normal text.

Known indirect subclasses

DateKeyListener, DateTimeKeyListener, DialerKeyListener, DigitsKeyListener, TimeKeyListener

DateKeyListener	For entering dates in a text field.
DateTimeKeyListener	For entering dates and times in the same text field.
DialerKeyListener	For dialing-only text entry As for all implementations of `KeyListener`, this class is only concerned with hardware keyboards.
DigitsKeyListener	For digits-only text entry As for all implementations of `KeyListener`, this class is only concerned with hardware keyboards.
TimeKeyListener	For entering times in a text field.

Abstract base class for key listeners. Provides a basic foundation for entering and editing text. Subclasses should override onKeyDown(View, Editable, int, KeyEvent) and MetaKeyKeyListener.onKeyUp(View, Editable, int, KeyEvent) to insert characters as keys are pressed.

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

From class android.text.method.MetaKeyKeyListener

`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
`BaseKeyListener()`

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

Inherited methods

From class


        
          android.text.method.MetaKeyKeyListener

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

From class


        
          java.lang.Object

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

From interface


        
          android.text.method.KeyListener

`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

BaseKeyListener

public BaseKeyListener ()

Public methods

backspace

Added in API level 1

public 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. If there is a selection, deletes the selection; otherwise, deletes the character before the cursor, if any; ALT+DEL deletes everything on the line the cursor is on.

Parameters
`view`	`View`
`content`	`Editable`
`keyCode`	`int`
`event`	`KeyEvent`

Returns
`boolean`	true if anything was deleted; false otherwise.

forwardDelete

Added in API level 11

public 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. If there is a selection, deletes the selection; otherwise, deletes the character before the cursor, if any; ALT+FORWARD_DEL deletes everything on the line the cursor is on.

Parameters
`view`	`View`
`content`	`Editable`
`keyCode`	`int`
`event`	`KeyEvent`

Returns
`boolean`	true if anything was deleted; false otherwise.

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`

onKeyOther

Added in API level 3

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

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

Parameters
`view`	`View`
`content`	`Editable`
`event`	`KeyEvent`

Returns
`boolean`