KeyListener

Kotlin |Java

interface KeyListener

android.text.method.KeyListener

Known Direct Subclasses

BaseKeyListener

Abstract base class for key listeners.

Known Indirect Subclasses

DateKeyListener, DateTimeKeyListener, DialerKeyListener, DigitsKeyListener, MultiTapKeyListener, NumberKeyListener, QwertyKeyListener, TextKeyListener, 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
DigitsKeyListener	For digits-only text entry
MultiTapKeyListener	This is the standard key listener for alphabetic input on 12-key keyboards.
NumberKeyListener	For numeric text entry
QwertyKeyListener	This is the standard key listener for alphabetic input on qwerty keyboards.
TextKeyListener	This is the key listener for typing normal text.
TimeKeyListener	For entering times in a text field.

Interface for converting text key events into edit operations on an Editable class. Note that for most cases this interface has been superceded by general soft input methods as defined by android.view.inputmethod.InputMethod; it should only be used for cases where an application has its own on-screen keypad and also wants to process hard keyboard events to match it.

Key presses on soft input methods are not required to trigger the methods in this listener, and are in fact discouraged to do so. The default android keyboard will not trigger these for any key to any application targetting Jelly Bean or later, and will only deliver it for some key presses to applications targetting Ice Cream Sandwich or earlier.

Summary

Public methods
abstract Unit	`clearMetaKeyState(view: View!, content: Editable!, states: Int)` 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 `android.text.InputType`.
abstract Boolean	`onKeyDown(view: View!, text: Editable!, keyCode: Int, event: KeyEvent!)` 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!, text: Editable!, event: KeyEvent!)` 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!, text: Editable!, keyCode: Int, event: KeyEvent!)` 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 methods

clearMetaKeyState

Added in API level 3

abstract fun clearMetaKeyState(
    view: View!, 
    content: Editable!, 
    states: Int
): Unit

Remove the given shift states from the edited text.

getInputType

Added in API level 3

abstract fun getInputType(): Int

Return the type of text that this key listener is manipulating, as per android.text.InputType. This is used to determine the mode of the soft keyboard that is shown for the editor.

If you return android.text.InputType#TYPE_NULL then no soft keyboard will provided. In other words, you must be providing your own key pad for on-screen input and the key listener will be used to handle input from a hard keyboard.

If you return any other value, a soft input method will be created when the user puts focus in the editor, which will provide a keypad and also consume hard key events. This means that the key listener will generally not be used, instead the soft input method will take care of managing key input as per the content type returned here.

onKeyDown

Added in API level 1

abstract fun onKeyDown(
    view: View!, 
    text: Editable!, 
    keyCode: Int, 
    event: KeyEvent!
): Boolean

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.

onKeyOther

Added in API level 3

abstract fun onKeyOther(
    view: View!, 
    text: Editable!, 
    event: KeyEvent!
): Boolean

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.

onKeyUp

Added in API level 1

abstract fun onKeyUp(
    view: View!, 
    text: Editable!, 
    keyCode: Int, 
    event: KeyEvent!
): Boolean

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.