Skip to content

Most visited

Recently visited

navigation

KeyEvent.DispatcherState

public static class KeyEvent.DispatcherState
extends Object

java.lang.Object
   ↳ android.view.KeyEvent.DispatcherState


Use with dispatch(Callback, DispatcherState, Object) for more advanced key dispatching, such as long presses.

Summary

Public constructors

KeyEvent.DispatcherState()

Public methods

void handleUpEvent(KeyEvent event)

Handle key up event to stop tracking.

boolean isTracking(KeyEvent event)

Return true if the key event is for a key code that is currently being tracked by the dispatcher.

void performedLongPress(KeyEvent event)

Keep track of the given event's key code as having performed an action with a long press, so no action should occur on the up.

void reset(Object target)

Stop any tracking associated with this target.

void reset()

Reset back to initial state.

void startTracking(KeyEvent event, Object target)

Start tracking the key code associated with the given event.

Inherited methods

From class java.lang.Object

Public constructors

KeyEvent.DispatcherState

Added in API level 5
KeyEvent.DispatcherState ()

Public methods

handleUpEvent

Added in API level 5
void handleUpEvent (KeyEvent event)

Handle key up event to stop tracking. This resets the dispatcher state, and updates the key event state based on it.

This is only needed if you are directly dispatching events, rather than handling them in onKeyUp(int, KeyEvent).

Parameters
event KeyEvent

isTracking

Added in API level 5
boolean isTracking (KeyEvent event)

Return true if the key event is for a key code that is currently being tracked by the dispatcher.

Parameters
event KeyEvent
Returns
boolean

performedLongPress

Added in API level 5
void performedLongPress (KeyEvent event)

Keep track of the given event's key code as having performed an action with a long press, so no action should occur on the up.

This is only needed if you are directly dispatching events, rather than handling them in onKeyLongPress(int, KeyEvent).

Parameters
event KeyEvent

reset

Added in API level 5
void reset (Object target)

Stop any tracking associated with this target.

Parameters
target Object

reset

Added in API level 5
void reset ()

Reset back to initial state.

startTracking

Added in API level 5
void startTracking (KeyEvent event, 
                Object target)

Start tracking the key code associated with the given event. This can only be called on a key down. It will allow you to see any long press associated with the key, and will result in isTracking() return true on the long press and up events.

This is only needed if you are directly dispatching events, rather than handling them in onKeyDown(int, KeyEvent).

Parameters
event KeyEvent
target Object
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.