Create Java subpackage folders.
[PrivacyBrowser.git] / app / src / main / java / com / stoutner / privacybrowser / dialogs / CreateHomeScreenShortcut.java
1 /**
2  * Copyright 2015-2016 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.Dialog;
24 import android.content.Context;
25 import android.content.DialogInterface;
26 import android.graphics.drawable.BitmapDrawable;
27 import android.graphics.drawable.Drawable;
28 import android.os.Bundle;
29 import android.support.annotation.NonNull;
30 // If we don't use android.support.v7.app.AlertDialog instead of android.app.AlertDialog then the dialog will be covered by the keyboard.
31 import android.support.v7.app.AlertDialog;
32 // We have to use `AppCompatDialogFragment` instead of `DialogFragment` or an error is produced on API <=22.
33 import android.support.v7.app.AppCompatDialogFragment;
34 import android.view.KeyEvent;
35 import android.view.LayoutInflater;
36 import android.view.View;
37 import android.view.WindowManager;
38 import android.widget.EditText;
39
40 import com.stoutner.privacybrowser.activities.MainWebView;
41 import com.stoutner.privacybrowser.R;
42
43 public class CreateHomeScreenShortcut extends AppCompatDialogFragment {
44     // The public interface is used to send information back to the parent activity.
45     public interface CreateHomeScreenSchortcutListener {
46         void onCreateHomeScreenShortcut(AppCompatDialogFragment dialogFragment);
47     }
48
49     //`createHomeScreenShortcutListener` is used in `onAttach()` and `onCreateDialog()`.
50     private CreateHomeScreenSchortcutListener createHomeScreenShortcutListener;
51
52     // Check to make sure that the parent activity implements the listener.
53     public void onAttach(Context context) {
54         super.onAttach(context);
55         try {
56             createHomeScreenShortcutListener = (CreateHomeScreenSchortcutListener) context;
57         } catch(ClassCastException exception) {
58             throw new ClassCastException(context.toString() + " must implement CreateHomeScreenShortcutListener.");
59         }
60     }
61
62     // `@SuppressLing("InflateParams")` removes the warning about using `null` as the parent view group when inflating the `AlertDialog`.
63     @SuppressLint("InflateParams")
64     @Override
65     @NonNull
66     public Dialog onCreateDialog(Bundle savedInstanceState) {
67         // Get the activity's layout inflater.
68         LayoutInflater layoutInflater = getActivity().getLayoutInflater();
69
70         // Create a drawable version of the favorite icon.
71         Drawable favoriteIconDrawable = new BitmapDrawable(getResources(), MainWebView.favoriteIcon);
72
73         // Use `AlertDialog.Builder` to create the `AlertDialog`.  `R.style.LightAlertDialog` formats the color of the button text.
74         AlertDialog.Builder dialogBuilder = new AlertDialog.Builder(getActivity(), R.style.LightAlertDialog);
75         dialogBuilder.setTitle(R.string.create_shortcut);
76         dialogBuilder.setIcon(favoriteIconDrawable);
77         // The parent view is `null` because it will be assigned by `AlertDialog`.
78         dialogBuilder.setView(layoutInflater.inflate(R.layout.create_home_screen_shortcut_dialog, null));
79
80         // Set an `onClick` listener on the negative button.
81         dialogBuilder.setNegativeButton(R.string.cancel, new DialogInterface.OnClickListener() {
82             @Override
83             public void onClick(DialogInterface dialog, int which) {
84                 // Do nothing if `Cancel` is clicked.
85             }
86         });
87
88         // Set an `onClick` listener on the positive button.
89         dialogBuilder.setPositiveButton(R.string.create, new DialogInterface.OnClickListener() {
90             @Override
91             public void onClick(DialogInterface dialog, int which) {
92                 createHomeScreenShortcutListener.onCreateHomeScreenShortcut(CreateHomeScreenShortcut.this);
93             }
94         });
95
96
97         // Create an `AlertDialog` from the `AlertDialog.Builder`.
98         final AlertDialog alertDialog = dialogBuilder.create();
99
100         // Remove the warning below that `setSoftInputMode` might produce `java.lang.NullPointerException`.
101         assert alertDialog.getWindow() != null;
102
103         // Show the keyboard when the Dialog is displayed on the screen.
104         alertDialog.getWindow().setSoftInputMode(WindowManager.LayoutParams.SOFT_INPUT_STATE_ALWAYS_VISIBLE);
105
106         // We need to show `alertDialog` before we can call `setOnKeyListener()` below.
107         alertDialog.show();
108
109         // Allow the "enter" key on the keyboard to create the shortcut.
110         EditText shortcutNameEditText = (EditText) alertDialog.findViewById(R.id.shortcut_name_edittext);
111         assert shortcutNameEditText != null;  // Remove the warning below that shortcutNameEditText might be null.
112         shortcutNameEditText.setOnKeyListener(new View.OnKeyListener() {
113             public boolean onKey(View v, int keyCode, KeyEvent event) {
114                 // If the event is a key-down on the "enter" button, select the PositiveButton "Create".
115                 if ((event.getAction() == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER)) {
116                     // Trigger the create listener.
117                     createHomeScreenShortcutListener.onCreateHomeScreenShortcut(CreateHomeScreenShortcut.this);
118
119                     // Manually dismiss `alertDialog`.
120                     alertDialog.dismiss();
121
122                     // Consume the event.
123                     return true;
124                 } else {  // If any other key was pressed, do not consume the event.
125                     return false;
126                 }
127             }
128         });
129
130         // `onCreateDialog` requires the return of an `AlertDialog`.
131         return alertDialog;
132     }
133 }