Detect back button but don't dismiss dialogfragment

Question

I have a dialogfragment for a floating dialog which includes a special keyboard that pops up when a user presses inside an EditText field (the normal IME is stopped from being displayed).

I would like the keyboard to be dismissed (visibility = GONE) when the user presses the back button (just as with a normal IME service) but the dialog to remain visible. However, there does not appear to be a way to do this as far as I can see from my fairly extensive reading on SO and elsewhere.

If I set the dialog to be non-cancelable then I don't get notified by onCancel() or onDismiss() because the dialog isn't cancelable.

If I set the dialog to be cancelable then I get notified, but the dialog is dismissed.

I can't attach an onKeyListener to the dialog in the fragment because it is replaced by the system so that the fragment can handle the dialog's life cycle.

Is there any way to do this? Or has access to the detection of key events been entirely fenced off for the purposes of the Fragment system?

Candie

Answer 1

The best way and cleanest way is to override onBackPressed() in the dialog you created in onCreateDialog().

@Override
public Dialog onCreateDialog(Bundle savedInstanceState) {
    return new Dialog(getActivity(), getTheme()){
        @Override
        public void onBackPressed() {
            //do your stuff
        }
    };
}

Vaal

This does not work in DialogFragments though since there is no onBackPressed() in the DialogFragment class. – Salzburg

DialogFragments wrap a Dialog - onCreateDialog creates this dialog. It works in DialogFragments. – Cryostat

I may only confirm this as best and most easy solution. Thanks for sharing this @Ian Wong – Wheelbase

Dialog could also be an instance of AppCompatDialog – Oldcastle

any ideas on what to do for AppCompatDialogFragment ? – Teressaterete

for some reason when you do it in BottomSheetDialogFragment the dialog becomes scuffed, the theme and styles are removed after this – Clance

when doing this for a BottomSheetDialogFragment you can just create a new BottomSheetDialog(context, theme) and pass in the context and theme. If you check the super method that is all it does. – Amaranthine

How do you this, when creating the dialog with onCreateView instead of onCreateDialog? I went with Manimaran As solution for now. https://mcmap.net/q/209358/-detect-back-button-but-don-39-t-dismiss-dialogfragment – Leaved

For Kotlin: override fun onCreateDialog(savedInstanceState: Bundle?): Dialog { return object : Dialog(activity!!, theme) { override fun onBackPressed() { //do your stuff } } } – Marijo

Answer 2

I had the same problem than you and I've fixed it attaching the onKeyListener to the dialogfragment.

In the method onResume() of the class that extend of DialogFragment put these piece of code:

    getDialog().setOnKeyListener(new OnKeyListener()
    {
        @Override
        public boolean onKey(android.content.DialogInterface dialog, int keyCode,android.view.KeyEvent event) {

            if ((keyCode ==  android.view.KeyEvent.KEYCODE_BACK))
                {
                     //Hide your keyboard here!!!
                     return true; // pretend we've processed it
                }
            else 
                return false; // pass on to be processed as normal
        }
    });

Here one of the problems that you can find is this code is going to be executed twice: one when the user press tha back button and another one when he leave to press it. In that case, you have to filter by event:

@Override
public void onResume() {
    super.onResume();

    getDialog().setOnKeyListener(new OnKeyListener()
    {
        @Override
        public boolean onKey(android.content.DialogInterface dialog, int keyCode,
                android.view.KeyEvent event) {

            if ((keyCode ==  android.view.KeyEvent.KEYCODE_BACK))
            {
                //This is the filter
                if (event.getAction()!=KeyEvent.ACTION_DOWN)
                        return true;
                else
                {
                    //Hide your keyboard here!!!!!!
                    return true; // pretend we've processed it
                }
            } 
            else 
                return false; // pass on to be processed as normal
        }
    });
}

Scepter

Instead of using the filter, I added getDialog().setOnKeyListener(null) which prevents the second call. – Prototype

Answer 3

As an addendum to Juan Pedro Martinez's answer I thought it would be helpful to clarify a specific question (one that I had) when looking at this thread.

If you wish to create a new DialogFragment and have it so the user can only cancel it using the back-button, which eliminates random screen touches from canceling the fragment prematurely, then this is the code that you would use.

In what ever code that you call the DialogFragment you need to set the cancelable setting to false so that NOTHING dismisses the fragment, no stray screen touches, etc.

DialogFragment mDialog= new MyDialogFragment();
mDialog.setCancelable(false);
mDialog.show(getFragmentManager(), "dialog");

Then, within your DialogFragment, in this case MyDaialogFragment.java, you add the onResume override code to have the dialog listen for the Back Button. When it's pressed it will execute the dismiss() to close the fragment.

@Override
 public void onResume() 
 {
     super.onResume();

     getDialog().setOnKeyListener(new OnKeyListener()
     {
         @Override
         public boolean onKey(android.content.DialogInterface dialog, 
                              int keyCode,android.view.KeyEvent event) 
         {
              if ((keyCode ==  android.view.KeyEvent.KEYCODE_BACK))
              {
                   // To dismiss the fragment when the back-button is pressed.
                   dismiss();
                   return true;
              }
              // Otherwise, do nothing else
              else return false;
         }
   });
}

Now your dialog will be called with the "setCancelable" to false, meaning nothing (no outside clicks) can cancel it and shut it down, and allowing (from within the dialog itself) only the back button to close it.

Ganbatte!

Eparchy

Perfect, thanks, I wanted to prevent accidental outside clicks whilst maintaining back button functionality, for me all I had to do was setCancelable(false) on the dialog instance in onCreateView inside the DialogFragment. – Jhvh

Answer 4

How has no one suggested this?

public Dialog onCreateDialog(Bundle savedInstanceState) {
  Dialog dialog = super.onCreateDialog(savedInstanceState);

  // Add back button listener
  dialog.setOnKeyListener(new Dialog.OnKeyListener() {
    @Override
    public boolean onKey(DialogInterface dialogInterface, int keyCode, KeyEvent keyEvent) {
      // getAction to make sure this doesn't double fire
      if (keyCode == KeyEvent.KEYCODE_BACK && keyEvent.getAction() == KeyEvent.ACTION_UP) {
        // Your code here
        return true; // Capture onKey
      }
      return false; // Don't capture
    }
  });

  return dialog;
}

Generalize

Answer 5

Use Fragment onCancel override method. It's called when you press back. here is a sample:

@Override
public void onCancel(DialogInterface dialog) {
    super.onCancel(dialog);

    // Add you codition
}

Melissamelisse

Note, that with this approach you cannot handle whether the DialogFragment will be dismissed or not. You can just get notified that it is to be dismissed – Hendon

Indeed @Leo Droidcoder Any idea how to intercept back button pressed before the dialogfragment cannot be dismissed ? – Obstruent

Answer 6

Since AppCompat 1.5.0-alpha01 AppCompatDialog is now extending ComponentDialog (source). That means in your DialogFragment you can now easily get a valid OnBackPressedDispatcher (from the fragment's dialog) that allows you to handle Back presses yourself.

kotlin:

class MyFragment: androidx.fragment.app.DialogFragment() {

    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        (dialog as androidx.activity.ComponentDialog)
            .onBackPressedDispatcher
            .addCallback(viewLifecycleOwner) {
                // handle back press
            }
    }
}

Note: when you add the callback it prevents the dialog from being dismissed/cancelled automatically by pressing Back.

Masinissa

This should be the correct answer so far. – Sse

Answer 7

When creating the dialog, override both onBackPressed and onTouchEvent :

        final Dialog dialog = new Dialog(activity) {
            @Override
            public boolean onTouchEvent(final MotionEvent event) {
                //note: all touch events that occur here are outside the dialog, yet their type is just touching-down
                boolean shouldAvoidDismissing = ... ;
                if (shouldAvoidDismissing) 
                    return true;
                return super.onTouchEvent(event);
            }

            @Override
            public void onBackPressed() {
                boolean shouldAvoidDismissing = ... ;
                if (!shouldSwitchToInviteMode)
                    dismiss();
                else
                    ...
            }
        };

Strobel

Answer 8

Prevent canceling DialogFragment:

dialog.setCanceledOnTouchOutside(false)
dialog.setCancelable(false)
dialog.setOnKeyListener { dialog, keyCode, event ->
    keyCode == KeyEvent.KEYCODE_BACK && event.action == KeyEvent.ACTION_UP
}

Ordzhonikidze

Answer 9

Extending off Juan Pedro Martinez's answer above. I wrote an extension on a DialogFragment that one could set from the onCreate() which will automatically set the key listener and remove it based off the lifecycle.

fun DialogFragment.setOnBackPressListener(onBackPress: () -> Boolean) {
    val listener = DialogInterface.OnKeyListener { _, keyCode, event ->
        if (keyCode == KeyEvent.KEYCODE_BACK && event?.action != KeyEvent.ACTION_DOWN) {
            onBackPress()
        } else {
            false
        }
    }
    val observer = object : LifecycleObserver {
        @OnLifecycleEvent(Lifecycle.Event.ON_RESUME)
        fun onResume() {
             dialog?.setOnKeyListener(listener)
        }

        @OnLifecycleEvent(Lifecycle.Event.ON_PAUSE)
        fun onPause() {
             dialog?.setOnKeyListener(null)
        }
    }
    lifecycle.addObserver(observer)
}

Usage in DialogFragment#onCreate

setOnBackPressListener {
    // handle back press here

    true // return true to indicate back press was handled, false if not
}

Laoighis

Answer 10

Try this and back to upvote my comment :D

/**
 * Callback when Back button is pressed.
 * By default it gonna call back press of host activity
 */
protected open fun onBackPressed() {
    requireActivity().onBackPressed()
}

override fun onCreateDialog(savedInstanceState: Bundle?): Dialog {
    return object : BottomSheetDialog(context!!, theme) {
        override fun onBackPressed() {
            [email protected]()
        }

        override fun setOnKeyListener(onKeyListener: DialogInterface.OnKeyListener?) {
            //Do not call super function
            //This function do nothing but DON'T REMOVE this.
            //Try to set null for onKeyListener is not working.
        }
    }
}

Luminal

Answer 11

Use onDismiss() callback of DialogFragment with a closeActivity flag

private var closeActivity: Boolean = true    

override fun onDismiss(dialog: DialogInterface?) {
        super.onDismiss(dialog)

        if (closeActivity) {
            activity!!.finish()
        }
    }

Sappy

Answer 12

It's a bit tricky here because we don't get any listner or callbacks on dialog fragment. On way to do it is to override the onDismiss() which will work as system callback which tells that dialog is dismissed and based on that we can setup our own custom callback as follow

override fun onDismiss(dialog: DialogInterface) {
    super.onDismiss(dialog)
    debugLog("Dialog is dismissed")
    dismiss()
    listener?.onRemoteBackPressed()
}

Heddie

Answer 13

You can override onDismiss method to detect the backpressed event

override fun onDismiss(dialog: DialogInterface) {
    super.onDismiss(dialog)

    // ... Do whatever you want
}

Monitor

Answer 14

With latest androidx support library, we can use the BackPressedDispatcher to dismiss the dialog fragment. Add below code in dialog fragment class to dismiss.

Refer Android Doc

@Override
public void onCreate(@Nullable Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    requireActivity().getOnBackPressedDispatcher().addCallback(this, new OnBackPressedCallback(true) {
        @Override
        public void handleOnBackPressed() {
            dismiss();
        }
    });

}

Protectionist

Answer 15

AndroidX OnBackPressedDispatcher can also be option for someone

Marlysmarmaduke

That doesn't seem to be the case: issuetracker.google.com/issues/149173280 – Morehead