public
interface
KeyListener
| android.text.method.KeyListener |
 Known Indirect Subclasses
|
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
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.
Public methods | |
|---|---|
abstract
void
|
clearMetaKeyState(View view, Editable content, int states)
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 |
abstract
boolean
|
onKeyDown(View view, Editable text, int keyCode, KeyEvent event)
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, Editable text, KeyEvent event)
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, Editable text, int keyCode, KeyEvent event)
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. |
void clearMetaKeyState (View view, Editable content, int states)
Remove the given shift states from the edited text.
| Parameters | |
|---|---|
view |
View
|
content |
Editable
|
states |
int
|
int getInputType ()
Return the type of text that this key listener is manipulating,
as per InputType. This is used to
determine the mode of the soft keyboard that is shown for the editor.
If you return
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.
| Returns | |
|---|---|
int |
|
boolean onKeyDown (View view, Editable text, int keyCode, KeyEvent event)
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.
| Parameters | |
|---|---|
view |
View
|
text |
Editable
|
keyCode |
int
|
event |
KeyEvent
|
| Returns | |
|---|---|
boolean |
|
boolean onKeyOther (View view, Editable text, KeyEvent event)
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.
| Parameters | |
|---|---|
view |
View
|
text |
Editable
|
event |
KeyEvent
|
| Returns | |
|---|---|
boolean |
|
boolean onKeyUp (View view, Editable text, int keyCode, KeyEvent event)
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.
| Parameters | |
|---|---|
view |
View
|
text |
Editable
|
keyCode |
int
|
event |
KeyEvent
|
| Returns | |
|---|---|
boolean |
|
Developers