app/src/main/java/com/stoutner/privacybrowser/dialogs/CreateHomeScreenShortcut.java

   1 /*
   2  * Copyright 2015-2017 Soren Stoutner <soren@stoutner.com>.
   3  *
   4  * This file is part of Privacy Browser <https://www.stoutner.com/privacy-browser>.
   5  *
   6  * Privacy Browser is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * Privacy Browser is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with Privacy Browser.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 package com.stoutner.privacybrowser.dialogs;
  21
  22 import android.annotation.SuppressLint;
  23 import android.app.AlertDialog;
  24 import android.app.Dialog;
  25 import android.content.Context;
  26 import android.content.DialogInterface;
  27 import android.graphics.drawable.BitmapDrawable;
  28 import android.graphics.drawable.Drawable;
  29 import android.os.Bundle;
  30 import android.support.annotation.NonNull;
  31 // We have to use `AppCompatDialogFragment` instead of `DialogFragment` or an error is produced on API <=22.
  32 import android.support.v7.app.AppCompatDialogFragment;
  33 import android.view.KeyEvent;
  34 import android.view.LayoutInflater;
  35 import android.view.View;
  36 import android.view.WindowManager;
  37 import android.widget.EditText;
  38
  39 import com.stoutner.privacybrowser.activities.MainWebView;
  40 import com.stoutner.privacybrowser.R;
  41
  42 public class CreateHomeScreenShortcut extends AppCompatDialogFragment {
  43     // The public interface is used to send information back to the parent activity.
  44     public interface CreateHomeScreenSchortcutListener {
  45         void onCreateHomeScreenShortcut(AppCompatDialogFragment dialogFragment);
  46     }
  47
  48     //`createHomeScreenShortcutListener` is used in `onAttach()` and `onCreateDialog()`.
  49     private CreateHomeScreenSchortcutListener createHomeScreenShortcutListener;
  50
  51     // Check to make sure that the parent activity implements the listener.
  52     public void onAttach(Context context) {
  53         super.onAttach(context);
  54         try {
  55             createHomeScreenShortcutListener = (CreateHomeScreenSchortcutListener) context;
  56         } catch(ClassCastException exception) {
  57             throw new ClassCastException(context.toString() + " must implement CreateHomeScreenShortcutListener.");
  58         }
  59     }
  60
  61     // `@SuppressLing("InflateParams")` removes the warning about using `null` as the parent view group when inflating the `AlertDialog`.
  62     @SuppressLint("InflateParams")
  63     @Override
  64     @NonNull
  65     public Dialog onCreateDialog(Bundle savedInstanceState) {
  66         // Get the activity's layout inflater.
  67         LayoutInflater layoutInflater = getActivity().getLayoutInflater();
  68
  69         // Create a drawable version of the favorite icon.
  70         Drawable favoriteIconDrawable = new BitmapDrawable(getResources(), MainWebView.favoriteIcon);
  71
  72         // Use `AlertDialog.Builder` to create the `AlertDialog`.  `R.style.LightAlertDialog` formats the color of the button text.
  73         AlertDialog.Builder dialogBuilder = new AlertDialog.Builder(getActivity(), R.style.LightAlertDialog);
  74         dialogBuilder.setTitle(R.string.create_shortcut);
  75         dialogBuilder.setIcon(favoriteIconDrawable);
  76         // The parent view is `null` because it will be assigned by `AlertDialog`.
  77         dialogBuilder.setView(layoutInflater.inflate(R.layout.create_home_screen_shortcut_dialog, null));
  78
  79         // Set an `onClick` listener on the negative button.
  80         dialogBuilder.setNegativeButton(R.string.cancel, new DialogInterface.OnClickListener() {
  81             @Override
  82             public void onClick(DialogInterface dialog, int which) {
  83                 // Do nothing if `Cancel` is clicked.
  84             }
  85         });
  86
  87         // Set an `onClick` listener on the positive button.
  88         dialogBuilder.setPositiveButton(R.string.create, new DialogInterface.OnClickListener() {
  89             @Override
  90             public void onClick(DialogInterface dialog, int which) {
  91                 createHomeScreenShortcutListener.onCreateHomeScreenShortcut(CreateHomeScreenShortcut.this);
  92             }
  93         });
  94
  95
  96         // Create an `AlertDialog` from the `AlertDialog.Builder`.
  97         final AlertDialog alertDialog = dialogBuilder.create();
  98
  99         // Remove the warning below that `setSoftInputMode` might produce `java.lang.NullPointerException`.
 100         assert alertDialog.getWindow() != null;
 101
 102         // Show the keyboard when the Dialog is displayed on the screen.
 103         alertDialog.getWindow().setSoftInputMode(WindowManager.LayoutParams.SOFT_INPUT_STATE_ALWAYS_VISIBLE);
 104
 105         // We need to show `alertDialog` before we can call `setOnKeyListener()` below.
 106         alertDialog.show();
 107
 108         // Allow the "enter" key on the keyboard to create the shortcut.
 109         EditText shortcutNameEditText = (EditText) alertDialog.findViewById(R.id.shortcut_name_edittext);
 110         assert shortcutNameEditText != null;  // Remove the warning below that shortcutNameEditText might be null.
 111         shortcutNameEditText.setOnKeyListener(new View.OnKeyListener() {
 112             public boolean onKey(View v, int keyCode, KeyEvent event) {
 113                 // If the event is a key-down on the "enter" button, select the PositiveButton "Create".
 114                 if ((event.getAction() == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER)) {
 115                     // Trigger the create listener.
 116                     createHomeScreenShortcutListener.onCreateHomeScreenShortcut(CreateHomeScreenShortcut.this);
 117
 118                     // Manually dismiss `alertDialog`.
 119                     alertDialog.dismiss();
 120
 121                     // Consume the event.
 122                     return true;
 123                 } else {  // If any other key was pressed, do not consume the event.
 124                     return false;
 125                 }
 126             }
 127         });
 128
 129         // `onCreateDialog` requires the return of an `AlertDialog`.
 130         return alertDialog;
 131     }
 132 }