Android APIs
Summary: Methods | [Expand All]
Added in API level 1
public static interface

KeyEvent.Callback

android.view.KeyEvent.Callback
Known Indirect Subclasses

Summary

Public Methods
abstract boolean onKeyDown(int keyCode, KeyEvent event)
Called when a key down event has occurred.
abstract boolean onKeyLongPress(int keyCode, KeyEvent event)
Called when a long press has occurred.
abstract boolean onKeyMultiple(int keyCode, int count, KeyEvent event)
Called when multiple down/up pairs of the same key have occurred in a row.
abstract boolean onKeyUp(int keyCode, KeyEvent event)
Called when a key up event has occurred.

Public Methods

public abstract boolean onKeyDown (int keyCode, KeyEvent event)

Added in API level 1

Called when a key down event has occurred. If you return true, you can first call KeyEvent.startTracking() to have the framework track the event through its onKeyUp(int, KeyEvent) and also call your onKeyLongPress(int, KeyEvent) if it occurs.

Parameters
keyCode The value in event.getKeyCode().
event Description of the key event.
Returns
  • If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false.

public abstract boolean onKeyLongPress (int keyCode, KeyEvent event)

Added in API level 5

Called when a long press has occurred. If you return true, the final key up will have FLAG_CANCELED and FLAG_CANCELED_LONG_PRESS set. Note that in order to receive this callback, someone in the event change must return true from onKeyDown(int, KeyEvent) and call startTracking() on the event.

Parameters
keyCode The value in event.getKeyCode().
event Description of the key event.
Returns
  • If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false.

public abstract boolean onKeyMultiple (int keyCode, int count, KeyEvent event)

Added in API level 1

Called when multiple down/up pairs of the same key have occurred in a row.

Parameters
keyCode The value in event.getKeyCode().
count Number of pairs as returned by event.getRepeatCount().
event Description of the key event.
Returns
  • If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false.

public abstract boolean onKeyUp (int keyCode, KeyEvent event)

Added in API level 1

Called when a key up event has occurred.

Parameters
keyCode The value in event.getKeyCode().
event Description of the key event.
Returns
  • If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false.