lightbulb_outline Help shape the future of the Google Play Console, Android Studio, and Firebase. Start survey
added in API level 1

View.OnKeyListener

public static interface View.OnKeyListener

android.view.View.OnKeyListener


Interface definition for a callback to be invoked when a hardware key event is dispatched to this view. The callback will be invoked before the key event is given to the view. This is only useful for hardware keyboards; a software input method has no obligation to trigger this listener.

Summary

Public methods

abstract boolean onKey(View v, int keyCode, KeyEvent event)

Called when a hardware key is dispatched to a view.

Public methods

onKey

added in API level 1
public abstract boolean onKey (View v, 
                int keyCode, 
                KeyEvent event)

Called when a hardware key is dispatched to a view. This allows listeners to get a chance to respond before the target view.

Key presses in software keyboards will generally NOT trigger this method, although some may elect to do so in some situations. Do not assume a software input method has to be key-based; even if it is, it may use key presses in a different way than you expect, so there is no way to reliably catch soft input key presses.

Parameters
v View: The view the key has been dispatched to.

keyCode int: The code for the physical key that was pressed

event KeyEvent: The KeyEvent object containing full information about the event.

Returns
boolean True if the listener has consumed the event, false otherwise.