2 * Copyright © 2016-2018 Soren Stoutner <soren@stoutner.com>.
4 * This file is part of Privacy Browser <https://www.stoutner.com/privacy-browser>.
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.
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.
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/>.
20 package com.stoutner.privacybrowser.dialogs;
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.database.Cursor;
28 import android.database.MatrixCursor;
29 import android.database.MergeCursor;
30 import android.graphics.Bitmap;
31 import android.graphics.BitmapFactory;
32 import android.os.Bundle;
33 import android.support.annotation.NonNull;
34 // `AppCompatDialogFragment` is required instead of `DialogFragment` or an error is produced on API <=22.
35 import android.support.v4.widget.ResourceCursorAdapter;
36 import android.support.v7.app.AppCompatDialogFragment;
37 import android.text.Editable;
38 import android.text.TextWatcher;
39 import android.view.KeyEvent;
40 import android.view.View;
41 import android.view.WindowManager;
42 import android.widget.AdapterView;
43 import android.widget.Button;
44 import android.widget.EditText;
45 import android.widget.ImageView;
46 import android.widget.RadioButton;
47 import android.widget.RadioGroup;
48 import android.widget.Spinner;
49 import android.widget.TextView;
51 import com.stoutner.privacybrowser.R;
52 import com.stoutner.privacybrowser.activities.MainWebViewActivity;
53 import com.stoutner.privacybrowser.helpers.BookmarksDatabaseHelper;
55 public class EditBookmarkDatabaseViewDialog extends AppCompatDialogFragment {
56 // Instantiate the constants.
57 public static final int HOME_FOLDER_DATABASE_ID = -1;
59 // Instantiate the class variables.
60 private EditBookmarkDatabaseViewListener editBookmarkDatabaseViewListener;
61 private int bookmarkDatabaseId;
62 private String currentBookmarkName;
63 private String currentUrl;
64 private int currentFolderDatabaseId;
65 private String currentDisplayOrder;
66 private RadioButton newIconRadioButton;
67 private EditText nameEditText;
68 private EditText urlEditText;
69 private Spinner folderSpinner;
70 private EditText displayOrderEditText;
71 private Button editButton;
73 // The public interface is used to send information back to the parent activity.
74 public interface EditBookmarkDatabaseViewListener {
75 void onSaveBookmark(AppCompatDialogFragment dialogFragment, int selectedBookmarkDatabaseId);
79 public void onAttach(Context context) {
80 // Run the default commands.
81 super.onAttach(context);
83 // Get a handle for `EditBookmarkDatabaseViewListener` from `context`.
85 editBookmarkDatabaseViewListener = (EditBookmarkDatabaseViewListener) context;
86 } catch(ClassCastException exception) {
87 throw new ClassCastException(context.toString() + " must implement EditBookmarkDatabaseViewListener.");
91 // Store the database ID in the arguments bundle.
92 public static EditBookmarkDatabaseViewDialog bookmarkDatabaseId(int databaseId) {
94 Bundle bundle = new Bundle();
96 // Store the bookmark database ID in the bundle.
97 bundle.putInt("Database ID", databaseId);
99 // Add the bundle to the dialog.
100 EditBookmarkDatabaseViewDialog editBookmarkDatabaseViewDialog = new EditBookmarkDatabaseViewDialog();
101 editBookmarkDatabaseViewDialog.setArguments(bundle);
103 // Return the new dialog.
104 return editBookmarkDatabaseViewDialog;
108 public void onCreate(Bundle savedInstanceState) {
109 // Run the default commands.
110 super.onCreate(savedInstanceState);
112 // Remove the incorrect lint warning below that `getInt()` might be null.
113 assert getArguments() != null;
115 // Store the bookmark database ID in the class variable.
116 bookmarkDatabaseId = getArguments().getInt("Database ID");
119 // `@SuppressLing("InflateParams")` removes the warning about using `null` as the parent view group when inflating the `AlertDialog`.
120 @SuppressLint("InflateParams")
123 public Dialog onCreateDialog(Bundle savedInstanceState) {
124 // Initialize the database helper. The two `nulls` do not specify the database name or a `CursorFactory`. The `0` specifies a database version, but that is ignored and set instead using a constant in `BookmarksDatabaseHelper`.
125 BookmarksDatabaseHelper bookmarksDatabaseHelper = new BookmarksDatabaseHelper(getContext(), null, null, 0);
127 // Get a `Cursor` with the selected bookmark and move it to the first position.
128 Cursor bookmarkCursor = bookmarksDatabaseHelper.getBookmarkCursor(bookmarkDatabaseId);
129 bookmarkCursor.moveToFirst();
131 // Use `AlertDialog.Builder` to create the `AlertDialog`.
132 AlertDialog.Builder dialogBuilder;
134 // Set the style according to the theme.
135 if (MainWebViewActivity.darkTheme) {
136 dialogBuilder = new AlertDialog.Builder(getActivity(), R.style.PrivacyBrowserAlertDialogDark);
138 dialogBuilder = new AlertDialog.Builder(getActivity(), R.style.PrivacyBrowserAlertDialogLight);
142 dialogBuilder.setTitle(R.string.edit_bookmark);
144 // Remove the incorrect lint warning below that `getLayoutInflater()` might be null.
145 assert getActivity() != null;
147 // Set the view. The parent view is `null` because it will be assigned by `AlertDialog`.
148 dialogBuilder.setView(getActivity().getLayoutInflater().inflate(R.layout.edit_bookmark_databaseview_dialog, null));
150 // Set an `onClick()` listener for the negative button.
151 dialogBuilder.setNegativeButton(R.string.cancel, (DialogInterface dialog, int which) -> {
152 // Do nothing. The `AlertDialog` will close automatically.
155 // Set the `onClick()` listener fo the positive button.
156 dialogBuilder.setPositiveButton(R.string.save, (DialogInterface dialog, int which) -> {
157 // Return the `DialogFragment` to the parent activity on save.
158 editBookmarkDatabaseViewListener.onSaveBookmark(EditBookmarkDatabaseViewDialog.this, bookmarkDatabaseId);
161 // Create an `AlertDialog` from the `AlertDialog.Builder`.
162 final AlertDialog alertDialog = dialogBuilder.create();
164 // Remove the warning below that `setSoftInputMode` might produce `java.lang.NullPointerException`.
165 assert alertDialog.getWindow() != null;
167 // Set the keyboard to be hidden when the `AlertDialog` is first shown. If this is not set, the `AlertDialog` will not shrink when the keyboard is displayed.
168 alertDialog.getWindow().setSoftInputMode(WindowManager.LayoutParams.SOFT_INPUT_STATE_HIDDEN);
170 // The `AlertDialog` must be shown before items in the layout can be modified.
173 // Get handles for the layout items.
174 TextView databaseIdTextView = alertDialog.findViewById(R.id.edit_bookmark_database_id_textview);
175 RadioGroup iconRadioGroup = alertDialog.findViewById(R.id.edit_bookmark_icon_radiogroup);
176 ImageView currentIconImageView = alertDialog.findViewById(R.id.edit_bookmark_current_icon);
177 ImageView newFavoriteIconImageView = alertDialog.findViewById(R.id.edit_bookmark_webpage_favorite_icon);
178 newIconRadioButton = alertDialog.findViewById(R.id.edit_bookmark_webpage_favorite_icon_radiobutton);
179 nameEditText = alertDialog.findViewById(R.id.edit_bookmark_name_edittext);
180 urlEditText = alertDialog.findViewById(R.id.edit_bookmark_url_edittext);
181 folderSpinner = alertDialog.findViewById(R.id.edit_bookmark_folder_spinner);
182 displayOrderEditText = alertDialog.findViewById(R.id.edit_bookmark_display_order_edittext);
183 editButton = alertDialog.getButton(AlertDialog.BUTTON_POSITIVE);
185 // Store the current bookmark values.
186 currentBookmarkName = bookmarkCursor.getString(bookmarkCursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME));
187 currentUrl = bookmarkCursor.getString(bookmarkCursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_URL));
188 currentDisplayOrder = bookmarkCursor.getString(bookmarkCursor.getColumnIndex(BookmarksDatabaseHelper.DISPLAY_ORDER));
190 // Set the database ID.
191 databaseIdTextView.setText(String.valueOf(bookmarkCursor.getInt(bookmarkCursor.getColumnIndex(BookmarksDatabaseHelper._ID))));
193 // Get the current favorite icon byte array from the `Cursor`.
194 byte[] currentIconByteArray = bookmarkCursor.getBlob(bookmarkCursor.getColumnIndex(BookmarksDatabaseHelper.FAVORITE_ICON));
196 // Convert the byte array to a `Bitmap` beginning at the first byte and ending at the last.
197 Bitmap currentIconBitmap = BitmapFactory.decodeByteArray(currentIconByteArray, 0, currentIconByteArray.length);
199 // Display `currentIconBitmap` in `edit_bookmark_current_icon`.
200 currentIconImageView.setImageBitmap(currentIconBitmap);
202 // Get a `Bitmap` of the favorite icon from `MainWebViewActivity` and display it in `edit_bookmark_web_page_favorite_icon`.
203 newFavoriteIconImageView.setImageBitmap(MainWebViewActivity.favoriteIconBitmap);
205 // Populate the bookmark name and URL `EditTexts`.
206 nameEditText.setText(currentBookmarkName);
207 urlEditText.setText(currentUrl);
209 // Setup a `MatrixCursor` "Home Folder".
210 String[] matrixCursorColumnNames = {BookmarksDatabaseHelper._ID, BookmarksDatabaseHelper.BOOKMARK_NAME};
211 MatrixCursor matrixCursor = new MatrixCursor(matrixCursorColumnNames);
212 matrixCursor.addRow(new Object[]{HOME_FOLDER_DATABASE_ID, getString(R.string.home_folder)});
214 // Get a `Cursor` with the list of all the folders.
215 Cursor foldersCursor = bookmarksDatabaseHelper.getAllFoldersCursor();
217 // Combine `matrixCursor` and `foldersCursor`.
218 MergeCursor foldersMergeCursor = new MergeCursor(new Cursor[]{matrixCursor, foldersCursor});
220 // Remove the incorrect lint warning below that `getContext()` might be null.
221 assert getContext() != null;
223 // Create a `ResourceCursorAdapter` for the `Spinner`. `0` specifies no flags.;
224 ResourceCursorAdapter foldersCursorAdapter = new ResourceCursorAdapter(getContext(), R.layout.edit_bookmark_databaseview_spinner_item, foldersMergeCursor, 0) {
226 public void bindView(View view, Context context, Cursor cursor) {
227 // Get a handle for the `Spinner` item `TextView`.
228 TextView spinnerItemTextView = view.findViewById(R.id.spinner_item_textview);
230 // Set the `TextView` to display the folder name.
231 spinnerItemTextView.setText(cursor.getString(cursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME)));
235 // Set the `ResourceCursorAdapter` drop drown view resource.
236 foldersCursorAdapter.setDropDownViewResource(R.layout.edit_bookmark_databaseview_spinner_dropdown_item);
238 // Set the adapter for the folder `Spinner`.
239 folderSpinner.setAdapter(foldersCursorAdapter);
241 // Get the parent folder name.
242 String parentFolder = bookmarkCursor.getString(bookmarkCursor.getColumnIndex(BookmarksDatabaseHelper.PARENT_FOLDER));
244 // Select the current folder in the `Spinner` if the bookmark isn't in the "Home Folder".
245 if (!parentFolder.equals("")) {
246 // Get the database ID of the parent folder.
247 int folderDatabaseId = bookmarksDatabaseHelper.getFolderDatabaseId(bookmarkCursor.getString(bookmarkCursor.getColumnIndex(BookmarksDatabaseHelper.PARENT_FOLDER)));
249 // Initialize `parentFolderPosition` and the iteration variable.
250 int parentFolderPosition = 0;
253 // Find the parent folder position in folders `ResourceCursorAdapter`.
255 if (foldersCursorAdapter.getItemId(i) == folderDatabaseId) {
256 // Store the current position for the parent folder.
257 parentFolderPosition = i;
259 // Try the next entry.
262 // Stop when the parent folder position is found or all the items in the `ResourceCursorAdapter` have been checked.
263 } while ((parentFolderPosition == 0) && (i < foldersCursorAdapter.getCount()));
265 // Select the parent folder in the `Spinner`.
266 folderSpinner.setSelection(parentFolderPosition);
269 // Store the current folder database ID.
270 currentFolderDatabaseId = (int) folderSpinner.getSelectedItemId();
272 // Populate the display order `EditText`.
273 displayOrderEditText.setText(String.valueOf(bookmarkCursor.getInt(bookmarkCursor.getColumnIndex(BookmarksDatabaseHelper.DISPLAY_ORDER))));
275 // Initially disable the edit button.
276 editButton.setEnabled(false);
278 // Update the edit button if the icon selection changes.
279 iconRadioGroup.setOnCheckedChangeListener((group, checkedId) -> {
280 // Update the edit button.
284 // Update the edit button if the bookmark name changes.
285 nameEditText.addTextChangedListener(new TextWatcher() {
287 public void beforeTextChanged(CharSequence s, int start, int count, int after) {
292 public void onTextChanged(CharSequence s, int start, int before, int count) {
297 public void afterTextChanged(Editable s) {
298 // Update the edit button.
303 // Update the edit button if the URL changes.
304 urlEditText.addTextChangedListener(new TextWatcher() {
306 public void beforeTextChanged(CharSequence s, int start, int count, int after) {
311 public void onTextChanged(CharSequence s, int start, int before, int count) {
316 public void afterTextChanged(Editable s) {
317 // Update the edit button.
322 // Update the edit button if the folder changes.
323 folderSpinner.setOnItemSelectedListener(new AdapterView.OnItemSelectedListener() {
325 public void onItemSelected(AdapterView<?> parent, View view, int position, long id) {
326 // Update the edit button.
331 public void onNothingSelected(AdapterView<?> parent) {
336 // Update the edit button if the display order changes.
337 displayOrderEditText.addTextChangedListener(new TextWatcher() {
339 public void beforeTextChanged(CharSequence s, int start, int count, int after) {
344 public void onTextChanged(CharSequence s, int start, int before, int count) {
349 public void afterTextChanged(Editable s) {
350 // Update the edit button.
355 // Allow the `enter` key on the keyboard to save the bookmark from the bookmark name `EditText`.
356 nameEditText.setOnKeyListener((View v, int keyCode, KeyEvent event) -> {
357 // Save the bookmark if the event is a key-down on the "enter" button.
358 if ((event.getAction() == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER) && editButton.isEnabled()) { // The enter key was pressed and the edit button is enabled.
359 // Trigger the `Listener` and return the `DialogFragment` to the parent activity.
360 editBookmarkDatabaseViewListener.onSaveBookmark(EditBookmarkDatabaseViewDialog.this, bookmarkDatabaseId);
362 // Manually dismiss `alertDialog`.
363 alertDialog.dismiss();
365 // Consume the event.
367 } else { // If any other key was pressed, or if the edit button is currently disabled, do not consume the event.
372 // Allow the "enter" key on the keyboard to save the bookmark from the URL `EditText`.
373 urlEditText.setOnKeyListener((View v, int keyCode, KeyEvent event) -> {
374 // Save the bookmark if the event is a key-down on the "enter" button.
375 if ((event.getAction() == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER) && editButton.isEnabled()) { // The enter key was pressed and the edit button is enabled.
376 // Trigger the `Listener` and return the `DialogFragment` to the parent activity.
377 editBookmarkDatabaseViewListener.onSaveBookmark(EditBookmarkDatabaseViewDialog.this, bookmarkDatabaseId);
379 // Manually dismiss the `AlertDialog`.
380 alertDialog.dismiss();
382 // Consume the event.
384 } else { // If any other key was pressed, or if the edit button is currently disabled, do not consume the event.
389 // Allow the "enter" key on the keyboard to save the bookmark from the display order `EditText`.
390 displayOrderEditText.setOnKeyListener((View v, int keyCode, KeyEvent event) -> {
391 // Save the bookmark if the event is a key-down on the "enter" button.
392 if ((event.getAction() == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER) && editButton.isEnabled()) { // The enter key was pressed and the edit button is enabled.
393 // Trigger the `Listener` and return the `DialogFragment` to the parent activity.
394 editBookmarkDatabaseViewListener.onSaveBookmark(EditBookmarkDatabaseViewDialog.this, bookmarkDatabaseId);
396 // Manually dismiss the `AlertDialog`.
397 alertDialog.dismiss();
399 // Consume the event.
401 } else { // If any other key was pressed, or if the edit button is currently disabled, do not consume the event.
406 // `onCreateDialog` requires the return of an `AlertDialog`.
410 private void updateEditButton() {
411 // Get the values from the dialog.
412 String newName = nameEditText.getText().toString();
413 String newUrl = urlEditText.getText().toString();
414 int newFolderDatabaseId = (int) folderSpinner.getSelectedItemId();
415 String newDisplayOrder = displayOrderEditText.getText().toString();
417 // Has the favorite icon changed?
418 boolean iconChanged = newIconRadioButton.isChecked();
420 // Has the name changed?
421 boolean nameChanged = !newName.equals(currentBookmarkName);
423 // Has the URL changed?
424 boolean urlChanged = !newUrl.equals(currentUrl);
426 // Has the folder changed?
427 boolean folderChanged = newFolderDatabaseId != currentFolderDatabaseId;
429 // Has the display order changed?
430 boolean displayOrderChanged = !newDisplayOrder.equals(currentDisplayOrder);
432 // Is the display order empty?
433 boolean displayOrderNotEmpty = !newDisplayOrder.isEmpty();
435 // Update the enabled status of the edit button.
436 editButton.setEnabled((iconChanged || nameChanged || urlChanged || folderChanged || displayOrderChanged) && displayOrderNotEmpty);