Switch to AppCompatDialogFragment for dialogs that return values due to crashes in...

[PrivacyBrowserAndroid.git] / app / src / main / java / com / stoutner / privacybrowser / CreateHomeScreenShortcut.java

diff --git a/app/src/main/java/com/stoutner/privacybrowser/CreateHomeScreenShortcut.java b/app/src/main/java/com/stoutner/privacybrowser/CreateHomeScreenShortcut.java
index 4a6b2fa7317768f04872dea018c60562f03fb0a1..6159f8da141f8cc5a3257e52a3c4c2ba6e82ac55 100644 (file)
--- a/app/src/main/java/com/stoutner/privacybrowser/CreateHomeScreenShortcut.java
+++ b/app/src/main/java/com/stoutner/privacybrowser/CreateHomeScreenShortcut.java
@@ -19,66 +19,70 @@
 
 package com.stoutner.privacybrowser;
 
-import android.app.Activity;
+import android.annotation.SuppressLint;
 import android.app.Dialog;
-import android.app.DialogFragment;
+import android.content.Context;
 import android.content.DialogInterface;
 import android.graphics.drawable.BitmapDrawable;
 import android.graphics.drawable.Drawable;
 import android.os.Bundle;
+import android.support.annotation.NonNull;
 // If we don't use android.support.v7.app.AlertDialog instead of android.app.AlertDialog then the dialog will be covered by the keyboard.
 import android.support.v7.app.AlertDialog;
+// We have to use `AppCompatDialogFragment` instead of `DialogFragment` or an error is produced on API <=22.
+import android.support.v7.app.AppCompatDialogFragment;
 import android.view.KeyEvent;
 import android.view.LayoutInflater;
 import android.view.View;
 import android.view.WindowManager;
 import android.widget.EditText;
 
-public class CreateHomeScreenShortcut extends DialogFragment {
+public class CreateHomeScreenShortcut extends AppCompatDialogFragment {
     // The public interface is used to send information back to the parent activity.
     public interface CreateHomeScreenSchortcutListener {
-        void onCancelCreateHomeScreenShortcut(DialogFragment dialogFragment);
-
-        void onCreateHomeScreenShortcut(DialogFragment dialogFragment);
+        void onCreateHomeScreenShortcut(AppCompatDialogFragment dialogFragment);
     }
 
-    //createHomeScreenShortcutListener is used in onAttach and and onCreateDialog.
+    //`createHomeScreenShortcutListener` is used in `onAttach()` and `onCreateDialog()`.
     private CreateHomeScreenSchortcutListener createHomeScreenShortcutListener;
 
     // Check to make sure that the parent activity implements the listener.
-    public void onAttach(Activity parentActivity) {
-        super.onAttach(parentActivity);
+    public void onAttach(Context context) {
+        super.onAttach(context);
         try {
-            createHomeScreenShortcutListener = (CreateHomeScreenSchortcutListener) parentActivity;
+            createHomeScreenShortcutListener = (CreateHomeScreenSchortcutListener) context;
         } catch(ClassCastException exception) {
-            throw new ClassCastException(parentActivity.toString() + " must implement CreateHomeScreenShortcutListener.");
+            throw new ClassCastException(context.toString() + " must implement CreateHomeScreenShortcutListener.");
         }
     }
 
+    // `@SuppressLing("InflateParams")` removes the warning about using `null` as the parent view group when inflating the `AlertDialog`.
+    @SuppressLint("InflateParams")
     @Override
+    @NonNull
     public Dialog onCreateDialog(Bundle savedInstanceState) {
+        // Get the activity's layout inflater.
+        LayoutInflater layoutInflater = getActivity().getLayoutInflater();
+
         // Create a drawable version of the favorite icon.
         Drawable favoriteIconDrawable = new BitmapDrawable(getResources(), MainWebViewActivity.favoriteIcon);
 
-        // Get the activity's layout inflater.
-        LayoutInflater customDialogInflater = getActivity().getLayoutInflater();
-
-        // Use AlertDialog.Builder to create the AlertDialog.  The style formats the color of the button text.
+        // Use `AlertDialog.Builder` to create the `AlertDialog`.  `R.style.LightAlertDialog` formats the color of the button text.
         AlertDialog.Builder dialogBuilder = new AlertDialog.Builder(getActivity(), R.style.LightAlertDialog);
         dialogBuilder.setTitle(R.string.create_shortcut);
         dialogBuilder.setIcon(favoriteIconDrawable);
-        // The parent view is "null" because it will be assigned by AlertDialog.
-        dialogBuilder.setView(customDialogInflater.inflate(R.layout.create_home_screen_shortcut_dialog, null));
+        // The parent view is `null` because it will be assigned by `AlertDialog`.
+        dialogBuilder.setView(layoutInflater.inflate(R.layout.create_home_screen_shortcut_dialog, null));
 
-        // Set an onClick listener on the negative button.
+        // Set an `onClick` listener on the negative button.
         dialogBuilder.setNegativeButton(R.string.cancel, new DialogInterface.OnClickListener() {
             @Override
             public void onClick(DialogInterface dialog, int which) {
-                createHomeScreenShortcutListener.onCancelCreateHomeScreenShortcut(CreateHomeScreenShortcut.this);
+                // Do nothing if `Cancel` is clicked.
             }
         });
 
-        // Set an onClick listener on the positive button.
+        // Set an `onClick` listener on the positive button.
         dialogBuilder.setPositiveButton(R.string.create, new DialogInterface.OnClickListener() {
             @Override
             public void onClick(DialogInterface dialog, int which) {
@@ -87,13 +91,16 @@ public class CreateHomeScreenShortcut extends DialogFragment {
         });
 
 
-        // Create an AlertDialog from the AlertDialogBuilder.
+        // Create an `AlertDialog` from the `AlertDialog.Builder`.
         final AlertDialog alertDialog = dialogBuilder.create();
 
+        // Remove the warning below that `setSoftInputMode` might produce `java.lang.NullPointerException`.
+        assert alertDialog.getWindow() != null;
+
         // Show the keyboard when the Dialog is displayed on the screen.
         alertDialog.getWindow().setSoftInputMode(WindowManager.LayoutParams.SOFT_INPUT_STATE_ALWAYS_VISIBLE);
 
-        // We need to show the AlertDialog before we can call setOnKeyListener() below.
+        // We need to show `alertDialog` before we can call `setOnKeyListener()` below.
         alertDialog.show();
 
         // Allow the "enter" key on the keyboard to create the shortcut.
@@ -117,7 +124,7 @@ public class CreateHomeScreenShortcut extends DialogFragment {
             }
         });
 
-        // onCreateDialog requires the return of an AlertDialog.
+        // `onCreateDialog` requires the return of an `AlertDialog`.
         return alertDialog;
     }
 }
\ No newline at end of file