to top
Android APIs
public abstract class

BaseKeyListener

extends MetaKeyKeyListener
implements KeyListener
java.lang.Object
   ↳ android.text.method.MetaKeyKeyListener
     ↳ android.text.method.BaseKeyListener
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Abstract base class for key listeners. Provides a basic foundation for entering and editing text. Subclasses should override onKeyDown(View, Editable, int, KeyEvent) and 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

[Expand]
Inherited Constants
From class android.text.method.MetaKeyKeyListener
Public Constructors
BaseKeyListener()
Public Methods
boolean backspace(View view, Editable content, int keyCode, KeyEvent event)
Performs the action that happens when you press the 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 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.
[Expand]
Inherited Methods
From class android.text.method.MetaKeyKeyListener
From class java.lang.Object
From interface android.text.method.KeyListener

Public Constructors

public BaseKeyListener ()

Added in API level 1

Public Methods

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

Added in API level 1

Performs the action that happens when you press the 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.

Returns
  • true if anything was deleted; false otherwise.

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

Added in API level 11

Performs the action that happens when you press the 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.

Returns
  • true if anything was deleted; false otherwise.

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

Added in API level 1

Handles presses of the meta keys.

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

Added in API level 3

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