How to capture the virtual keyboard show hide event in Android

Question

I would like to alter the layout based on whether the virtual keyboard is shown or not  I ve searched the API and various blogs but can t seem to find anything useful   Is it possible   Thanks

User · Answer

Sander  I believe you are trying to show the view blocked by the soft keyboard  Try this http   android-developers blogspot com 2009 04 updating-applications-for-on-screen html

User · Answer

what I did is created simple binding to hide view when keyboard is visible  Solution is based on current AndroidX implementation for WindowInsetsCompat which is still in beta  androidx core 1 5  - source private fun isKeyboardVisible insets  WindowInsets   Boolean       val insetsCompat   WindowInsetsCompat toWindowInsetsCompat insets      val systemWindow   insetsCompat systemWindowInsets     val rootStable   insetsCompat stableInsets     if  systemWindow bottom  gt  rootStable bottom               This handles the adjustResize case on  lt  API 30  since            systemWindow bottom is probably going to be the IME         return true           return false     BindingAdapter  quot goneWhenKeyboardVisible quot   fun View goneWhenKeyboardVisible enabled  Boolean        if  enabled            setOnApplyWindowInsetsListener   view  insets - gt              visibility   if  isKeyboardVisible insets   GONE else VISIBLE             insets                 else           setOnApplyWindowInsetsListener null          visibility   VISIBLE          usage   lt FrameLayout                 android id  quot   id bottom toolbar quot                  android layout width  quot match parent quot                  android layout height  quot wrap content quot                  app goneWhenKeyboardVisible  quot   true  quot                    gt

User · Answer

If you want to handle show hide of IMM  virtual  keyboard window from your Activity  you ll need to subclass your layout and override onMesure method so that you can determine the measured width and the measured height of your layout   After that set subclassed layout as main view for your Activity by setContentView    Now you ll be able to handle IMM show hide window events  If this sounds complicated  it s not that really  Here s the code   main xml       lt  xml version  1 0  encoding  utf-8   gt      lt LinearLayout xmlns android  http   schemas android com apk res android          android layout width  fill parent          android layout height  fill parent          android orientation  horizontal   gt           lt EditText              android id    id SearchText                android text                  android inputType  text               android layout width  fill parent               android layout height  34dip               android singleLine  True                 gt           lt Button              android id    id Search                android layout width  60dip               android layout height  34dip               android gravity    center                 gt       lt  LinearLayout gt    Now inside your Activity declare subclass for your layout  main xml       public class MainSearchLayout extends LinearLayout        public MainSearchLayout Context context  AttributeSet attributeSet            super context  attributeSet           LayoutInflater inflater    LayoutInflater  context getSystemService Context LAYOUT INFLATER SERVICE           inflater inflate R layout main  this               Override     protected void onMeasure int widthMeasureSpec  int heightMeasureSpec            Log d  Search Layout    Handling Keyboard Window shown             final int proposedheight   MeasureSpec getSize heightMeasureSpec           final int actualHeight   getHeight             if  actualHeight  gt  proposedheight                  Keyboard is shown            else                  Keyboard is hidden                   super onMeasure widthMeasureSpec  heightMeasureSpec             You can see from the code that we inflate layout for our Activity in subclass constructor  inflater inflate R layout main  this     And now just set content view of subclassed layout for our Activity   public class MainActivity extends Activity            Called when the activity is first created          Override     public void onCreate Bundle savedInstanceState            super onCreate savedInstanceState            MainSearchLayout searchLayout   new MainSearchLayout this  null            setContentView searchLayout                 rest of the Activity code and subclassed layout

User · Answer

Like  amalBit s answer  register a listener to global layout and calculate the difference of dectorView s visible bottom and its proposed bottom  if the difference is bigger than some value guessed IME s height   we think IME is up       final EditText edit    EditText  findViewById R id edittext       edit getViewTreeObserver   addOnGlobalLayoutListener new ViewTreeObserver OnGlobalLayoutListener              Override         public void onGlobalLayout                 if  keyboardShown edit getRootView                       Log d  keyboard    keyboard UP                  else                   Log d  keyboard    keyboard Down                                     private boolean keyboardShown View rootView         final int softKeyboardHeight   100      Rect r   new Rect        rootView getWindowVisibleDisplayFrame r       DisplayMetrics dm   rootView getResources   getDisplayMetrics        int heightDiff   rootView getBottom   - r bottom      return heightDiff  gt  softKeyboardHeight   dm density      the height threshold 100 is the guessed minimum height of IME   This works for both adjustPan and adjustResize

User · Answer

You can also check for first DecorView s child bottom padding  It will be set to non-zero value when keyboard is shown    Override protected void onLayout boolean changed  int left  int top  int right  int bottom        View view   getRootView        if  view    null  amp  amp   view     ViewGroup  view  getChildAt 0      null            setKeyboardVisible view getPaddingBottom    gt  0             super onLayout changed  left  top  right  bottom

User · Answer

2020 Update This is now possible  On Android 11  you can do view setWindowInsetsAnimationCallback object   WindowInsetsAnimation Callback       override fun onEnd animation  WindowInsetsAnimation            super onEnd animation          val showingKeyboard   view rootWindowInsets isVisible WindowInsets Type ime               now use the boolean for something           You can also listen to the animation of showing hiding the keyboard and do a corresponding transition  I recommend reading Android 11 preview and the corresponding documentation Before Android 11 However  this work has not been made available in a Compat version  so you need to resort to hacks  You can get the window insets and if the bottom insets are bigger than some value you find to be reasonably good  by experimentation   you can consider that to be showing the keyboard  This is not great and can fail in some cases  but there is no framework support for that  This is a good answer on this exact question https   stackoverflow com a 36259261 372076  Alternatively  here s a page giving some different approaches to achieve this pre Android 11  https   developer salesforce com docs atlas en-us noversion service sdk android meta service sdk android android detecting keyboard htm  Note  This solution will not work for soft keyboards and onConfigurationChanged will not be called for soft  virtual  keyboards    You ve got to handle configuration changes yourself  http   developer android com guide topics resources runtime-changes html HandlingTheChange Sample     from the link above  Override public void onConfigurationChanged Configuration newConfig        super onConfigurationChanged newConfig                Checks whether a hardware keyboard is available     if  newConfig hardKeyboardHidden    Configuration HARDKEYBOARDHIDDEN NO            Toast makeText this   quot keyboard visible quot   Toast LENGTH SHORT  show          else if  newConfig hardKeyboardHidden    Configuration HARDKEYBOARDHIDDEN YES            Toast makeText this   quot keyboard hidden quot   Toast LENGTH SHORT  show             Then just change the visibility of some views  update a field  and change your layout file

User · Answer

I did this way   Add OnKeyboardVisibilityListener interface    public interface OnKeyboardVisibilityListener       void onVisibilityChanged boolean visible       HomeActivity java   public class HomeActivity extends Activity implements OnKeyboardVisibilityListener     Override protected void onCreate Bundle savedInstanceState        super onCreate savedInstanceState       setContentView R layout activity sign up          Other stuff        setKeyboardVisibilityListener this      private void setKeyboardVisibilityListener final OnKeyboardVisibilityListener onKeyboardVisibilityListener        final View parentView     ViewGroup  findViewById android R id content   getChildAt 0       parentView getViewTreeObserver   addOnGlobalLayoutListener new ViewTreeObserver OnGlobalLayoutListener              private boolean alreadyOpen          private final int defaultKeyboardHeightDP   100          private final int EstimatedKeyboardDP   defaultKeyboardHeightDP    Build VERSION SDK INT  gt   Build VERSION CODES LOLLIPOP   48   0           private final Rect rect   new Rect              Override         public void onGlobalLayout                 int estimatedKeyboardHeight    int  TypedValue applyDimension TypedValue COMPLEX UNIT DIP  EstimatedKeyboardDP  parentView getResources   getDisplayMetrics                 parentView getWindowVisibleDisplayFrame rect               int heightDiff   parentView getRootView   getHeight   -  rect bottom - rect top               boolean isShown   heightDiff  gt   estimatedKeyboardHeight               if  isShown    alreadyOpen                    Log i  Keyboard state    Ignoring global layout change                       return                            alreadyOpen   isShown              onKeyboardVisibilityListener onVisibilityChanged isShown                          Override public void onVisibilityChanged boolean visible        Toast makeText HomeActivity this  visible    Keyboard is active     Keyboard is Inactive   Toast LENGTH SHORT  show            Hope this would help you

User · Answer

I have sort of a hack to do this  Although there doesn t seem to be a way to detect when the soft keyboard has shown or hidden  you can in fact detect when it is about to be shown or hidden by setting an OnFocusChangeListener on the EditText that you re listening to   EditText et    EditText  findViewById R id et   et setOnFocusChangeListener new View OnFocusChangeListener                  Override         public void onFocusChange View view  boolean hasFocus                          hasFocus tells us whether soft keyboard is about to show                     NOTE  One thing to be aware of with this hack is that this callback is fired immediately when the EditText gains or loses focus  This will actually fire right before the soft keyboard shows or hides  The best way I ve found to do something after the keyboard shows or hides is to use a Handler and delay something   400ms  like so   EditText et    EditText  findViewById R id et   et setOnFocusChangeListener new View OnFocusChangeListener                  Override         public void onFocusChange View view  boolean hasFocus                        new Handler   postDelayed new Runnable                                          Override                     public void run                                                   do work here                                          400

User · Answer

Based on the Code from Nebojsa Tomcic I ve developed the following RelativeLayout-Subclass   import java util ArrayList   import android content Context  import android util AttributeSet  import android widget RelativeLayout   public class KeyboardDetectorRelativeLayout extends RelativeLayout        public interface IKeyboardChanged           void onKeyboardShown            void onKeyboardHidden               private ArrayList lt IKeyboardChanged gt  keyboardListener   new ArrayList lt IKeyboardChanged gt          public KeyboardDetectorRelativeLayout Context context  AttributeSet attrs  int defStyle            super context  attrs  defStyle              public KeyboardDetectorRelativeLayout Context context  AttributeSet attrs            super context  attrs              public KeyboardDetectorRelativeLayout Context context            super context              public void addKeyboardStateChangedListener IKeyboardChanged listener            keyboardListener add listener              public void removeKeyboardStateChangedListener IKeyboardChanged listener            keyboardListener remove listener               Override     protected void onMeasure int widthMeasureSpec  int heightMeasureSpec            final int proposedheight   MeasureSpec getSize heightMeasureSpec           final int actualHeight   getHeight             if  actualHeight  gt  proposedheight                notifyKeyboardShown              else if  actualHeight  lt  proposedheight                notifyKeyboardHidden                      super onMeasure widthMeasureSpec  heightMeasureSpec              private void notifyKeyboardHidden             for  IKeyboardChanged listener   keyboardListener                listener onKeyboardHidden                         private void notifyKeyboardShown             for  IKeyboardChanged listener   keyboardListener                listener onKeyboardShown                         This works quite fine    Mark  that this solution will just work when Soft Input Mode of your Activity is set to  WindowManager LayoutParams SOFT INPUT ADJUST RESIZE

User · Answer

Not sure if anyone post this  Found this solution simple to use   The SoftKeyboard class is on gist github com   But while keyboard popup hide event callback we need a handler to properly do things on UI      Somewhere else in your code    RelativeLayout mainLayout   findViewById R layout main layout      You must use your root layout InputMethodManager im    InputMethodManager  getSystemService Service INPUT METHOD SERVICE       Instantiate and pass a callback    SoftKeyboard softKeyboard  softKeyboard   new SoftKeyboard mainLayout  im   softKeyboard setSoftKeyboardCallback new SoftKeyboard SoftKeyboardChanged           Override     public void onSoftKeyboardHide                     Code here         new Handler Looper getMainLooper    post new Runnable                      Override                 public void run                            Code here will run in UI thread                                                                       Override     public void onSoftKeyboardShow                     Code here         new Handler Looper getMainLooper    post new Runnable                      Override                 public void run                            Code here will run in UI thread

User · Answer

Nebojsa s solution almost worked for me   When I clicked inside a multi-line EditText it knew the keyboard was displayed  but when I started typing inside the EditText  the actualHeight and proposedHeight were still the same so it did not know they keyboard was still displayed   I made a slight modification to store the max height and it works fine   Here is the revised subclass   public class CheckinLayout extends RelativeLayout        private int largestHeight       public CheckinLayout Context context  AttributeSet attributeSet            super context  attributeSet           LayoutInflater inflater    LayoutInflater  context getSystemService Context LAYOUT INFLATER SERVICE           inflater inflate R layout checkin  this               Override     protected void onMeasure int widthMeasureSpec  int heightMeasureSpec            final int proposedheight   MeasureSpec getSize heightMeasureSpec           largestHeight   Math max largestHeight  getHeight              if  largestHeight  gt  proposedheight                 Keyboard is shown         else                Keyboard is hidden          super onMeasure widthMeasureSpec  heightMeasureSpec

User · Answer

using viewTreeObserver for easily get the keyboard event   layout parent viewTreeObserver addOnGlobalLayoutListener               val r   Rect               layout parent getWindowVisibleDisplayFrame r              if  layout parent rootView height -  r bottom - r top   gt  100       if more than 100 pixels  its probably a keyboard                    Log e  TAG     keyboard open                 else                   Log e  TAG     keyboard close                                layout parent is your view like edit text parent

User · Answer

This may not be the most effective solution  But this worked for me every time    I call this function where ever i need to listen to the softKeyboard   boolean isOpened   false   public void setListenerToRootView         final View activityRootView   getWindow   getDecorView   findViewById android R id content       activityRootView getViewTreeObserver   addOnGlobalLayoutListener new OnGlobalLayoutListener              Override         public void onGlobalLayout                  int heightDiff   activityRootView getRootView   getHeight   - activityRootView getHeight                if  heightDiff  gt  100       99  of the time the height diff will be due to a keyboard                  Toast makeText getApplicationContext     Gotcha    softKeyboardup   0  show                     if  isOpened    false                          Do two things  make the view top visible and the editText smaller                                   isOpened   true                else if  isOpened    true                    Toast makeText getApplicationContext     softkeyborad Down      0  show                    isOpened   false                                      Note   This approach will cause issues if the user uses a floating keyboard

User · Answer

I solve this by overriding onKeyPreIme int keyCode  KeyEvent event  in my custom EditText    Override public boolean onKeyPreIme int keyCode  KeyEvent event        if  keyCode    KeyEvent KEYCODE BACK  amp  amp  event getAction      KeyEvent ACTION UP              keyboard will be hidden

User · Answer

I have solve the problem on single line textview back coding   package com helpingdoc   import android content Context  import android util AttributeSet  import android util Log  import android view LayoutInflater  import android view View  import android widget LinearLayout   public class MainSearchLayout extends LinearLayout       int hieght   0      public MainSearchLayout Context context  AttributeSet attributeSet             super context  attributeSet           LayoutInflater inflater    LayoutInflater  context getSystemService Context LAYOUT INFLATER SERVICE           inflater inflate R layout main  this                 Override     protected void onMeasure int widthMeasureSpec  int heightMeasureSpec            Log d  Search Layout    Handling Keyboard Window shown           if getHeight   gt hieght              hieght   getHeight                     final int proposedheight   MeasureSpec getSize heightMeasureSpec           final int actualHeight   getHeight            System out println      hieght      hieght           System out println      actualhieght      actualHeight           System out println      proposedheight      proposedheight           if  actualHeight  gt  proposedheight                  Keyboard is shown             else if actualHeight lt proposedheight                  Keyboard is hidden                     if proposedheight    hieght                   Keyboard is hidden                   super onMeasure widthMeasureSpec  heightMeasureSpec

User · Answer

Hide Show events for keyboard can be listened through simple hack in OnGlobalLayoutListener      final View activityRootView   findViewById R id top root           activityRootView getViewTreeObserver   addOnGlobalLayoutListener new OnGlobalLayoutListener                 public void onGlobalLayout                     int heightDiff   activityRootView getRootView   getHeight   - activityRootView getHeight                     if  heightDiff  gt  100                           keyboard is up                   else                          keyboard is down                                               Here activityRootView is your Activity s root view

User · Answer

Nebojsa Tomcic s answer wasn t helpful for me  I have RelativeLayout with TextView and AutoCompleteTextView inside it  I need to scroll the TextView to the bottom when the keyboard is showed and when it s hidden  To accomplish this I overrode onLayout method and it works fine for me   public class ExtendedLayout extends RelativeLayout       public ExtendedLayout Context context  AttributeSet attributeSet                super context  attributeSet           LayoutInflater inflater    LayoutInflater                  context getSystemService Context LAYOUT INFLATER SERVICE           inflater inflate R layout main  this               Override     protected void onLayout boolean changed  int l  int t  int r  int b                super onLayout changed  l  t  r  b            if  changed                        int scrollEnd    textView getLineCount   - textView getHeight                     textView getLineHeight      textView getLineHeight                textView scrollTo 0  scrollEnd

[android] How to capture the "virtual keyboard show/hide" event in Android?

Examples related to android

Examples related to events

Examples related to android-softkeyboard