Android - Handle Enter in an EditText

Question

I am wondering if there is a way to handle the user pressing Enter while typing in an EditText  something like the onSubmit HTML event   Also wondering if there is a way to manipulate the virtual keyboard in such a way that the  Done  button is labeled something else  for example  Go   and performs a certain action when clicked  again  like onSubmit

User · Answer

Add these depencendy  and it should work   import android view KeyEvent  import android view View  import android widget EditText

User · Answer

In your xml  add the imeOptions attribute to the editText   lt EditText     android id    id edittext additem              android imeOptions  actionDone        gt    Then  in your Java code  add the OnEditorActionListener to the same EditText  mAddItemEditText setOnEditorActionListener new TextView OnEditorActionListener              Override         public boolean onEditorAction TextView v  int actionId  KeyEvent event                if actionId    EditorInfo IME ACTION DONE                     do stuff                 return true                            return false                      Here is the explanation- The imeOptions actionDone will assign  actionDone  to the EnterKey  The EnterKey in the keyboard will change from  Enter  to  Done   So when Enter Key is pressed  it will trigger this action and thus you will handle it

User · Answer

I had a similar purpose  I wanted to resolve pressing the  Enter  key on the keyboard  which I wanted to customize  in an AutoCompleteTextView which extends TextView  I tried different solutions from above and they seemed to work  BUT I experienced some problems when I switched the input type on my device  Nexus 4 with AOKP ROM  from SwiftKey 3  where it worked perfectly  to the standard Android keyboard  where instead of handling my code from the listener  a new line was entered after pressing the  Enter  key  It took me a while to handle this problem  but I don t know if it will work under all circumstances no matter which input type you use    So here s my solution   Set the input type attribute of the TextView in the xml to  text    android inputType  text    Customize the label of the  Enter  key on the keyboard   myTextView setImeActionLabel  Custom text   KeyEvent KEYCODE ENTER     Set an OnEditorActionListener to the TextView   myTextView setOnEditorActionListener new OnEditorActionListener          Override     public boolean onEditorAction TextView v  int actionId          KeyEvent event            boolean handled   false      if  event getAction      KeyEvent KEYCODE ENTER                   Handle pressing  Enter  key here          handled   true            return handled              I hope this can help others to avoid the problems I had  because they almost drove me nuts

User · Answer

A dependable way to respond to an  lt enter gt  in an EditText is with a TextWatcher  a LocalBroadcastManager  and a BroadcastReceiver  You need to add the v4 support library to use the LocalBroadcastManager  I use the tutorial at vogella com  7 3  Local broadcast events with LocalBroadcastManager  because of its complete concise code Example  In onTextChanged before is the index of the end of the change before the change  minus start  When in the TextWatcher the UI nbsp thread is busy updating editText s editable  so we send an Intent to wake up the BroadcastReceiver when the UI nbsp thread is done updating editText   import android content Context  import android content Intent  import android content IntentFilter  import android text Editable    in onCreate  editText addTextChangedListener new TextWatcher       public void onTextChanged    CharSequence s  int start  int before  int count          check if exactly one char was added and it was an  lt enter gt      if  before  0  amp  amp  count  1  amp  amp  s charAt start     n         Intent intent new Intent  enter       Integer startInteger new Integer start       intent putExtra  Start   startInteger toString        Add data     mySendBroadcast intent     in the BroadcastReceiver s onReceive  int start Integer parseInt intent getStringExtra  Start     editText getText   replace start  start 1        remove the  lt enter gt    respond to the  lt enter gt  here

User · Answer

This question hasn t been answered yet with Butterknife   LAYOUT XML   lt android support design widget TextInputLayout         android layout width  match parent          android layout height  wrap content          android hint   string some input hint  gt            lt android support design widget TextInputEditText             android id    id textinput              android layout width  match parent              android layout height  wrap content              android imeOptions  actionSend              android inputType  text textCapSentences textAutoComplete textAutoCorrect   gt       lt  android support design widget TextInputLayout gt    JAVA APP   OnEditorAction R id textinput  boolean onEditorAction int actionId  KeyEvent key       boolean handled   false      if  actionId    EditorInfo IME ACTION SEND     key getKeyCode      KeyEvent KEYCODE ENTER               do whatever you want         handled   true            return handled

User · Answer

This should work   input addTextChangedListener new TextWatcher                  Override            public void afterTextChanged Editable s                  Override                public void beforeTextChanged CharSequence s  int start               int count  int after                              Override                public void onTextChanged CharSequence s  int start               int before  int count                   if  -1    input getText   toString   indexOf    n                          input setText  Enter was pressed

User · Answer

Easiest way to detect Enter key being pressed is  mPasswordField setOnEditorActionListener new TextView OnEditorActionListener                  Override             public boolean onEditorAction TextView v  int actionId  KeyEvent event                    if  event   null         KeyEvent  If triggered by an enter key  this is the event  otherwise  this is null                      signIn mEmailField getText   toString    mPasswordField getText   toString                         return true                    else                       return false

User · Answer

First  you have to set EditText listen to key press   Override protected void onCreate Bundle savedInstanceState        super onCreate savedInstanceState       setContentView R layout activity main            Set the EditText listens to key press     EditText edittextproductnumber    EditText  findViewById R id editTextproductnumber       edittextproductnumber setOnKeyListener this        Second  define the event upon the key press  for example  event to set TextView s text    Override public boolean onKey View v  int keyCode  KeyEvent event           TODO Auto-generated method stub      Listen to  Enter  key press  if   event getAction      KeyEvent ACTION DOWN   amp  amp   keyCode    KeyEvent KEYCODE ENTER           TextView textviewmessage    TextView  findViewById R id textViewmessage        textviewmessage setText  You hit  Enter  key         return true      return false          And finally  do not forget to import EditText TextView OnKeyListener KeyEvent at top   import android view KeyEvent  import android view View OnKeyListener  import android widget EditText  import android widget TextView

User · Answer

working perfectly  public class MainActivity extends AppCompatActivity     TextView t  Button b  EditText e    Override protected void onCreate Bundle savedInstanceState        super onCreate savedInstanceState       setContentView R layout activity main        b    Button  findViewById R id b       e    EditText  findViewById R id e        e addTextChangedListener new TextWatcher               Override         public void onTextChanged CharSequence s  int start  int before  int count                 if  before    0  amp  amp  count    1  amp  amp  s charAt start       n                      b performClick                    e getText   replace start  start   1         remove the  lt enter gt                                    Override         public void beforeTextChanged CharSequence s  int start  int count  int after              Override         public void afterTextChanged Editable s                  b setOnClickListener new View OnClickListener              Override         public void onClick View v                b setText  ok                              working perfectly

User · Answer

This will give you a callable function when the user presses the return key   fun EditText setLineBreakListener onLineBreak     - gt  Unit        val lineBreak     n      doOnTextChanged   text          - gt          val currentText   text toString               Check if text contains a line break         if  currentText contains lineBreak                     Uncommenting the lines below will remove the line break from the string                and set the cursor back to the end of the line                 val cleanedString   currentText replace lineBreak                     setText cleanedString                 setSelection cleanedString length               onLineBreak                         Usage  editText setLineBreakListener       doSomething

User · Answer

you can use this way editText setOnEditorActionListener  v  actionId  event  - gt           if  actionId    EditorInfo IME ACTION DONE                 Do some things                 return true                  return false       you can see list of action there  For example  IME ACTION GO IME ACTION SEARCH IME ACTION SEND

User · Answer

I know this is a year old  but I just discovered this works perfectly for an EditText   EditText textin    EditText  findViewById R id editText1   textin setInputType InputType TYPE CLASS TEXT     It prevents anything but text and space  I could not tab   return     n    or anything

User · Answer

I am wondering if there is a way to   handle the user pressing Enter while   typing in an EditText  something like   the onSubmit HTML event    Yes       Also wondering if there is a way to   manipulate the virtual keyboard in   such a way that the  Done  button is   labeled something else  for example    Go   and performs a certain action   when clicked  again  like onSubmit     Also yes   You will want to look at the android imeActionId and android imeOptions attributes  plus the setOnEditorActionListener   method  all on TextView   For changing the text of the  Done  button to a custom string  use    mEditText setImeActionLabel  Custom text   KeyEvent KEYCODE ENTER

User · Answer

This works fine on LG Android phones  It prevents ENTER and other special characters to be interpreted as normal character  Next or Done button appears automatically and ENTER works as expected   edit setInputType InputType TYPE CLASS TEXT

User · Answer

Kotlin solution to react to enter press using Lambda expression          editText setOnKeyListener      keyCode  event - gt              if keyCode    KeyEvent KEYCODE ENTER  amp  amp  event action  KeyEvent ACTION DOWN                 react to enter press here                           true            not doing the additional check for the type of event will cause this listener to be called twice when pressed once  once for ACTION DOWN  once for ACTION UP

User · Answer

editText setOnEditorActionListener new TextView OnEditorActionListener              Override         public boolean onEditorAction TextView v  int actionId  KeyEvent event                if  actionId    0    event getAction      KeyEvent ACTION DOWN                       Action                 return true                else                   return false                                    Xml   lt EditText         android id    id editText2          android layout width  fill parent          android layout height  wrap content          android hint   string password          android imeOptions  actionGo flagNoFullscreen          android inputType  textPassword          android maxLines  1    gt

User · Answer

I created a helper class for this by extending the new MaterialAlertDialogBuilder Usage new InputPopupBuilder context           setInput R string send                   R string enter your message                   text - gt  sendFeedback text  activity            setTitle R string contact us           show      Code public class InputPopupBuilder extends MaterialAlertDialogBuilder        private final Context context      private final AppCompatEditText input       public InputPopupBuilder Context context            super context           this context   context          input   new AppCompatEditText context           input setInputType InputType TYPE CLASS TEXT           setView input              public InputPopupBuilder setInput int actionLabel  int hint  Callback callback            input setHint hint           input setImeActionLabel context getString actionLabel   KeyEvent KEYCODE ENTER           input setOnEditorActionListener  TextView OnEditorActionListener   v  actionId  event  - gt                if  actionId    EditorInfo IME NULL                      amp  amp  event getAction      KeyEvent ACTION DOWN                    Editable text   input getText                    if  text    null                        callback onClick text toString                         return true                                              return false                       setPositiveButton actionLabel   dialog  which  - gt                Editable text   input getText                if  text    null                    callback onClick text toString                                        return this             public InputPopupBuilder setText String text           input setText text           return this             public InputPopupBuilder setInputType int inputType           input setInputType inputType           return this             public interface Callback           void onClick String text            Requires implementation  com google android material material 1 3 0-alpha04

User · Answer

Here s a simple static function that you can throw into your Utils or Keyboards class that will execute code when the user hits the return key on a hardware or software keyboard  It s a modified version of  earlcasper s excellent answer          Return a TextView OnEditorActionListener that will execute code when an enter is pressed on    the keyboard  lt br gt      lt code gt         myTextView setOnEditorActionListener Keyboards onEnterEditorActionListener new Runnable  - gt              Toast makeText context  Enter Pressed  Toast LENGTH SHORT  show                    lt  code gt      param doOnEnter A Runnable for what to do when the user hits enter     return the TextView OnEditorActionListener     public static TextView OnEditorActionListener onEnterEditorActionListener final Runnable doOnEnter       return      actionId  event  - gt            if  event  null                if  actionId    EditorInfo IME ACTION DONE                       Capture soft enters in a singleLine EditText that is the last EditText                  doOnEnter run                    return true                else if  actionId  EditorInfo IME ACTION NEXT                       Capture soft enters in other singleLine EditTexts                 doOnEnter run                    return true                else                   return false      Let system handle all other null KeyEvents                         else if  actionId  EditorInfo IME NULL                   Capture most soft enters in multi-line EditTexts and all hard enters                 They supply a zero actionId and a valid KeyEvent rather than                a non-zero actionId and a null event like the previous cases              if  event getAction    KeyEvent ACTION DOWN                       We capture the event when key is first pressed                  return true                else                   doOnEnter run                    return true       We consume the event when the key is released                          else                  We let the system handle it when the listener                is triggered by something that wasn t an enter              return false

User · Answer

Here s what you do  It s also hidden in the Android Developer s sample code  Bluetooth Chat   Replace the bold parts that say  example  with your own variables and methods   First  import what you need into the main Activity where you want the return button to do something special   import android view inputmethod EditorInfo  import android widget TextView  import android view KeyEvent    Now  make a variable of type TextView OnEditorActionListener for your return key  here I use exampleListener    TextView OnEditorActionListener exampleListener   new TextView OnEditorActionListener      Then you need to tell the listener two things about what to do when the return button is pressed  It needs to know what EditText we re talking about  here I use exampleView   and then it needs to know what to do when the Enter key is pressed  here  example confirm     If this is the last or only EditText in your Activity  it should do the same thing as the onClick method for your Submit  or OK  Confirm  Send  Save  etc  button   public boolean onEditorAction TextView exampleView  int actionId  KeyEvent event       if  actionId    EditorInfo IME NULL          amp  amp  event getAction      KeyEvent ACTION DOWN           example confirm     match this behavior to your  Send   or Confirm  button         return true      Finally  set the listener  most likely in your onCreate method    exampleView setOnEditorActionListener exampleListener

User · Answer

Just as an addendum to Chad s response  which worked almost perfectly for me   I found that I needed to add a check on the KeyEvent action type to prevent my code executing twice  once on the key-up and once on the key-down event    if  actionId    EditorInfo IME NULL  amp  amp  event getAction      KeyEvent ACTION DOWN           your code here     See http   developer android com reference android view KeyEvent html for info about repeating action events  holding the enter key  etc

User · Answer

Hardware keyboards always yield enter events  but software keyboards return different actionIDs  and nulls in singleLine EditTexts   This code responds every time the user presses enter in an EditText that this listener has been set to  regardless of EditText or keyboard type   import android view inputmethod EditorInfo  import android view KeyEvent  import android widget TextView OnEditorActionListener   listener new TextView OnEditorActionListener        Override   public boolean onEditorAction TextView view  int actionId  KeyEvent event        if  event  null          if  actionId  EditorInfo IME ACTION DONE            Capture soft enters in a singleLine EditText that is the last EditText        else if  actionId  EditorInfo IME ACTION NEXT            Capture soft enters in other singleLine EditTexts       else return false      Let system handle all other null KeyEvents           else if  actionId  EditorInfo IME NULL            Capture most soft enters in multi-line EditTexts and all hard enters         They supply a zero actionId and a valid KeyEvent rather than        a non-zero actionId and a null event like the previous cases        if  event getAction    KeyEvent ACTION DOWN             We capture the event when key is first pressed        else  return true       We consume the event when the key is released              else  return false          We let the system handle it when the listener        is triggered by something that wasn t an enter           Code from this point on will execute whenever the user        presses enter in an attached view  regardless of position          keyboard  or singleLine status       if  view  multiLineEditText   multiLineEditText setText  You pressed enter        if  view  singleLineEditText   singleLineEditText setText  You pressed next        if  view  lastSingleLineEditText   lastSingleLineEditText setText  You pressed done        return true       Consume the event          The default appearance of the enter key in singleLine false gives a bent arrow enter keypad  When singleLine true in the last EditText the key says DONE  and on the EditTexts before it it says NEXT  By default  this behavior is consistent across all vanilla  android  and google emulators  The scrollHorizontal attribute doesn t make any difference  The null test is important because the response of phones to soft enters is left to the manufacturer and even in the emulators  the vanilla Level 16 emulators respond to long soft enters in multi-line and scrollHorizontal EditTexts with an actionId of NEXT and a null for the event

User · Answer

Type this code in your editor so that it can import necessary modules    query setOnEditorActionListener new TextView OnEditorActionListener              Override         public boolean onEditorAction TextView textView  int actionId  KeyEvent keyEvent                if actionId    EditorInfo IME ACTION DONE                        keyEvent getAction      KeyEvent ACTION DOWN                            keyEvent getAction      KeyEvent KEYCODE ENTER                        Put your function here ---                   return true                             return false

User · Answer

This page describes exactly how to do this  https   developer android com training keyboard-input style html Set the android imeOptions then you just check the actionId in onEditorAction  So if you set imeOptions to  actionDone  then you would check for  actionId    EditorInfo IME ACTION DONE  in onEditorAction  Also  make sure to set the android inputType  If using Material Design put code in TextInputEditText  Here s the EditText from the example linked above   lt EditText     android id  quot   id search quot      android layout width  quot fill parent quot      android layout height  quot wrap content quot      android hint  quot  string search hint quot      android inputType  quot text quot      android imeOptions  quot actionSend quot    gt   You can also set this programmatically using the setImeOptions int  function  Here s the OnEditorActionListener from the example linked above  EditText editText    EditText  findViewById R id search   editText setOnEditorActionListener new OnEditorActionListener          Override     public boolean onEditorAction TextView v  int actionId  KeyEvent event            boolean handled   false          if  actionId    EditorInfo IME ACTION SEND                sendMessage                handled   true                    return handled

User · Answer

Using Kotlin I ve made a function that handles all kinds of  done -like actions for EditText  including the keyboard  and it s possible to modify it and also handle other keys as you wish  too    private val DEFAULT ACTIONS TO HANDLE AS DONE FOR EDIT TEXT   arrayListOf EditorInfo IME ACTION SEND  EditorInfo IME ACTION GO  EditorInfo IME ACTION SEARCH  EditorInfo IME ACTION DONE  private val DEFAULT KEYS TO HANDLE AS DONE FOR EDIT TEXT   arrayListOf KeyEvent KEYCODE ENTER  KeyEvent KEYCODE NUMPAD ENTER   fun EditText setOnDoneListener function     - gt  Unit  onKeyListener  OnKeyListener    null  onEditorActionListener  TextView OnEditorActionListener    null                                 actionsToHandle  Collection lt Int gt    DEFAULT ACTIONS TO HANDLE AS DONE FOR EDIT TEXT                                 keysToHandle  Collection lt Int gt    DEFAULT KEYS TO HANDLE AS DONE FOR EDIT TEXT        setOnEditorActionListener   v  actionId  event - gt          if  onEditorActionListener  onEditorAction v  actionId  event     true              return setOnEditorActionListener true         if  actionsToHandle contains actionId                 function invoke               return setOnEditorActionListener true                   return setOnEditorActionListener false           setOnKeyListener   v  keyCode  event - gt          if  onKeyListener  onKey v  keyCode  event     true              return setOnKeyListener true         if  event action    KeyEvent ACTION DOWN  amp  amp  keysToHandle contains keyCode                 function invoke               return setOnKeyListener true                   return setOnKeyListener false           So  sample usage           editText setOnDoneListener                 do something              As for changing the label  I think it depends on the keyboard app  and that it usually change only on landscape  as written here  Anyway  example usage for this           editText imeOptions   EditorInfo IME ACTION DONE         editText setImeActionLabel  ASD   editText imeOptions    Or  if you want in XML        lt EditText         android id    id editText  android layout width  wrap content  android layout height  wrap content          android imeActionLabel  ZZZ  android imeOptions  actionDone    gt    And the result  shown in landscape

User · Answer

password setOnEditorActionListener new TextView OnEditorActionListener             public boolean onEditorAction TextView v  int actionId  KeyEvent event                if event    null  amp  amp  event getKeyCode      KeyEvent KEYCODE ENTER  amp  amp  event getAction      KeyEvent ACTION DOWN                    InputMethodManager imm    InputMethodManager  getSystemService Context INPUT METHOD SERVICE                   imm toggleSoftInput InputMethodManager SHOW IMPLICIT  0                   submit performClick                    return true                            return false                      Works very fine for me In addition hide keyboard

User · Answer

You can also do it    editText setOnKeyListener new OnKeyListener                   Override             public boolean onKey View v  int keyCode  KeyEvent event                                if  event getAction      KeyEvent ACTION DOWN                          amp  amp  event getKeyCode            KeyEvent KEYCODE ENTER                                         Log i  event    captured                         return false                                  return false

User · Answer

Ok  If none of answers work for you and not get mad yet  I have a solution  Use AppCompatMultiAutoCompleteTextView  yep   instead of EditText with this code  kotlin  val filter   InputFilter   source  start  end          - gt          var keepOriginal   true         val sb   StringBuilder end - start          for  i in start until end                val c   source i              if  c      n                   sb append c              else                   keepOriginal   false                   TODO WRITE YOUR CODE HERE                                 if  keepOriginal  null else               if  source is Spanned                    val sp   SpannableString sb                  TextUtils copySpansFrom source  start  sb length  null  sp  0                  sp               else                   sb                                appCompatMultiAutoCompleteTextView filters   arrayOf filter    It  probably  work in all device  I test it in android 4 4  amp  10  Its work in xiaomi too  I damn   android

User · Answer

final EditText edittext    EditText  findViewById R id edittext       edittext setOnKeyListener new OnKeyListener             public boolean onKey View v  int keyCode  KeyEvent event                   If the event is a key-down event on the  enter  button             if   event getAction      KeyEvent ACTION DOWN   amp  amp                       keyCode    KeyEvent KEYCODE ENTER                        Perform action on key press                 Toast makeText HelloFormStuff this  edittext getText    Toast LENGTH SHORT  show                    return true                            return false

User · Answer

InputType on the textfield must be text in order for what CommonsWare said to work  Just tried all of this  no inputType before the trial and nothing worked  Enter kept registering as soft enter  After inputType   text  everything including the setImeLabel worked   Example   android inputType  text

User · Answer

final EditText edittext    EditText  findViewById R id edittext   edittext setOnKeyListener new OnKeyListener         public boolean onKey View v  int keyCode  KeyEvent event               If the event is a key-down event on the  enter  button         if   event getAction      KeyEvent ACTION DOWN   amp  amp               keyCode    KeyEvent KEYCODE ENTER                  Perform action on key press           Toast makeText HelloFormStuff this  edittext getText    Toast LENGTH SHORT  show              return true                    return false

User · Answer

Replace  quot txtid quot  with your EditText ID  EditText txtinput  txtinput findViewById R id txtid      txtinput setOnEditorActionListener new TextView OnEditorActionListener              Override         public boolean onEditorAction TextView v  int actionId  KeyEvent event                if   event    null  amp  amp   event getKeyCode      KeyEvent KEYCODE ENTER           actionId    EditorInfo IME ACTION DONE                                        Code for the action you want to proceed with                   InputMethodManager inputManager    InputMethodManager                          getSystemService Context INPUT METHOD SERVICE                     inputManager hideSoftInputFromWindow getCurrentFocus   getWindowToken                            InputMethodManager HIDE NOT ALWAYS                             return false

[android] Android - Handle "Enter" in an EditText

Examples related to android

Examples related to android-edittext

Examples related to textview