Skip to content

Most visited

Recently visited

navigation
Added in API level 3

KeyboardView.OnKeyboardActionListener

public static interface KeyboardView.OnKeyboardActionListener

android.inputmethodservice.KeyboardView.OnKeyboardActionListener


Listener for virtual keyboard events.

Summary

Public methods

abstract void onKey(int primaryCode, int[] keyCodes)

Send a key press to the listener.

abstract void onPress(int primaryCode)

Called when the user presses a key.

abstract void onRelease(int primaryCode)

Called when the user releases a key.

abstract void onText(CharSequence text)

Sends a sequence of characters to the listener.

abstract void swipeDown()

Called when the user quickly moves the finger from up to down.

abstract void swipeLeft()

Called when the user quickly moves the finger from right to left.

abstract void swipeRight()

Called when the user quickly moves the finger from left to right.

abstract void swipeUp()

Called when the user quickly moves the finger from down to up.

Public methods

onKey

Added in API level 3
void onKey (int primaryCode, 
                int[] keyCodes)

Send a key press to the listener.

Parameters
primaryCode int: this is the key that was pressed
keyCodes int: the codes for all the possible alternative keys with the primary code being the first. If the primary key code is a single character such as an alphabet or number or symbol, the alternatives will include other characters that may be on the same key or adjacent keys. These codes are useful to correct for accidental presses of a key adjacent to the intended key.

onPress

Added in API level 3
void onPress (int primaryCode)

Called when the user presses a key. This is sent before the onKey(int, int[]) is called. For keys that repeat, this is only called once.

Parameters
primaryCode int: the unicode of the key being pressed. If the touch is not on a valid key, the value will be zero.

onRelease

Added in API level 3
void onRelease (int primaryCode)

Called when the user releases a key. This is sent after the onKey(int, int[]) is called. For keys that repeat, this is only called once.

Parameters
primaryCode int: the code of the key that was released

onText

Added in API level 3
void onText (CharSequence text)

Sends a sequence of characters to the listener.

Parameters
text CharSequence: the sequence of characters to be displayed.

swipeDown

Added in API level 3
void swipeDown ()

Called when the user quickly moves the finger from up to down.

swipeLeft

Added in API level 3
void swipeLeft ()

Called when the user quickly moves the finger from right to left.

swipeRight

Added in API level 3
void swipeRight ()

Called when the user quickly moves the finger from left to right.

swipeUp

Added in API level 3
void swipeUp ()

Called when the user quickly moves the finger from down to up.

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.