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