How do I handle ImeOptions done button click

Question

I am having an EditText where I am setting the following property so that I can display the done button on the keyboard when user click on the EditText   editText setImeOptions EditorInfo IME ACTION DONE     When user clicks the done button on the screen keyboard  finished typing  I want to change a RadioButton state   How can I track done button when it is hit from screen keyboard

User · Answer

Kotlin Solution

The base way to handle it in Kotlin is:

edittext.setOnEditorActionListener { _, actionId, _ ->
    if (actionId == EditorInfo.IME_ACTION_DONE) {
        callback.invoke()
        true
    }
    false
}

Kotlin Extension

Use this to just call edittext.onDone{/*action*/} in your main code. Makes your code far more readable and maintainable

fun EditText.onDone(callback: () -> Unit) {
    setOnEditorActionListener { _, actionId, _ ->
        if (actionId == EditorInfo.IME_ACTION_DONE) {
            callback.invoke()
            true
        }
        false
    }
}

Don't forget to add these options to your edittext

<EditText ...
    android:imeOptions="actionDone"
    android:inputType="text"/>

If you need inputType="textMultiLine" support, read this post

User · Answer

Thanks to chikka anddev and Alex Cohn in Kotlin it is   text setOnEditorActionListener   v  actionId  event - gt      if  actionId    EditorInfo IME ACTION DONE            event  action    KeyEvent ACTION DOWN  amp  amp  event keyCode    KeyEvent KEYCODE ENTER            doSomething           true       else           false           Here I check for Enter key  because it returns EditorInfo IME NULL instead of IME ACTION DONE   See also Android imeOptions  quot actionDone quot  not working  Add android singleLine  true  in the EditText

User · Answer

lt EditText android imeOptions  actionDone            android inputType  text   gt    The Java code is   edittext setOnEditorActionListener new OnEditorActionListener          public boolean onEditorAction TextView v  int actionId  KeyEvent event            if  actionId    EditorInfo IME ACTION DONE                Log i TAG  Here you can write the code                return true                        return false

User · Answer

I know this question is old  but I want to point out what worked for me   I tried using the sample code from the Android Developers website  shown below   but it didn t work  So I checked the EditorInfo class  and I realized that the IME ACTION SEND integer value was specified as 0x00000004   Sample code from Android Developers   editTextEmail    EditText  findViewById R id editTextEmail   editTextEmail          setOnEditorActionListener new OnEditorActionListener                  Override             public boolean onEditorAction TextView v  int actionId                      KeyEvent event                    boolean handled   false                  if  actionId    EditorInfo IME ACTION SEND                           handle action here                        handled   true                                    return handled                              So  I added the integer value to my res values integers xml file    lt  xml version  1 0  encoding  utf-8   gt   lt resources gt       lt integer name  send  gt 0x00000004 lt  integer gt   lt  resources gt    Then  I edited my layout file res layouts activity home xml as follows   lt EditText android id    id editTextEmail    android layout width  match parent    android layout height  wrap content    android imeActionId   integer send    android imeActionLabel    string send label    android imeOptions  actionSend    android inputType  textEmailAddress   gt    And then  the sample code worked

User · Answer

While most people have answered the question directly  I wanted to elaborate more on the concept behind it  First  I was drawn to the attention of IME when I created a default Login Activity  It generated some code for me which included the following    lt EditText   android id    id password    android layout width  match parent    android layout height  wrap content    android hint   string prompt password    android imeActionId    id login    android imeActionLabel   string action sign in short    android imeOptions  actionUnspecified    android inputType  textPassword    android maxLines  1    android singleLine  true   gt    You should already be familiar with the inputType attribute  This just informs Android the type of text expected such as an email address  password or phone number  The full list of possible values can be found here    It was  however  the attribute imeOptions  actionUnspecified  that I didn t understand its purpose  Android allows you to interact with the keyboard that pops up from bottom of screen when text is selected using the InputMethodManager  On the bottom corner of the keyboard  there is a button  typically it says  Next  or  Done   depending on the current text field  Android allows you to customize this using android imeOptions  You can specify a  Send  button or  Next  button  The full list can be found here   With that  you can then listen for presses on the action button by defining a TextView OnEditorActionListener for the EditText element  As in your example   editText setOnEditorActionListener new EditText OnEditorActionListener          Override     public boolean onEditorAction EditText v  int actionId  KeyEvent event        if  actionId    EditorInfo IME ACTION DONE             do here your stuff f        return true            return false               Now in my example I had android imeOptions  actionUnspecified  attribute  This is useful when you want to try to login a user when they press the enter key  In your Activity  you can detect this tag and then attempt the login       mPasswordView    EditText  findViewById R id password       mPasswordView setOnEditorActionListener new TextView OnEditorActionListener              Override         public boolean onEditorAction TextView textView  int id  KeyEvent keyEvent                if  id    R id login    id    EditorInfo IME NULL                    attemptLogin                    return true                            return false

User · Answer

Try this  it should work for what you need           editText setOnEditorActionListener new EditText OnEditorActionListener          Override     public boolean onEditorAction TextView v  int actionId  KeyEvent event        if  actionId    EditorInfo IME ACTION DONE             do here your stuff f        return true            return false

User · Answer

If you use Android Annotations  https   github com androidannotations androidannotations  You can use   EditorAction annotation   EditorAction R id your component id  void onDoneAction EditText view  int actionId       if actionId    EditorInfo IME ACTION DONE             Todo  Do your work or call a method

User · Answer

More details on how to set the OnKeyListener  and have it listen for the Done button   First add OnKeyListener to the implements section of your class   Then add the function defined in the OnKeyListener interface         Respond to soft keyboard events  look for the DONE press on the password field      public boolean onKey View v  int keyCode  KeyEvent event        if   event getAction      KeyEvent ACTION DOWN   amp  amp           keyCode    KeyEvent KEYCODE ENTER                    Done pressed   Do something here               Returning false allows other listeners to react to the press      return false      Given an EditText object   EditText textField    EditText findViewById R id MyEditText   textField setOnKeyListener this

User · Answer

I ended up with a combination of Roberts and chirags answers     EditText findViewById R id search field   setOnEditorActionListener          new EditText OnEditorActionListener          Override     public boolean onEditorAction TextView v  int actionId  KeyEvent event               Identifier of the action  This will be either the identifier you supplied             or EditorInfo IME NULL if being called due to the enter key being pressed          if  actionId    EditorInfo IME ACTION SEARCH                    actionId    EditorInfo IME ACTION DONE                    event getAction      KeyEvent ACTION DOWN                  amp  amp  event getKeyCode      KeyEvent KEYCODE ENTER                onSearchAction v               return true                       Return true if you have consumed the action  else false          return false              Update  The above code would some times activate the callback twice  Instead I ve opted for the following code  which I got from the Google chat clients   public boolean onEditorAction TextView v  int actionId  KeyEvent event           If triggered by an enter key  this is the event  otherwise  this is null      if  event    null               if shift key is down  then we want to insert the   n  char in the TextView             otherwise  the default action is to send the message          if   event isShiftPressed                  if  isPreparedForSending                      confirmSendMessageIfNeeded                              return true                    return false             if  isPreparedForSending              confirmSendMessageIfNeeded              return true

[android] How do I handle ImeOptions' done button click?

Kotlin Solution

Kotlin Extension

Don't forget to add these options to your edittext

Examples related to android

Examples related to android-edittext

Examples related to ime