/**
- * Copyright 2015 Soren Stoutner <soren@stoutner.com>.
+ * Copyright 2015-2016 Soren Stoutner <soren@stoutner.com>.
*
* This file is part of Privacy Browser <https://www.stoutner.com/privacy-browser>.
*
package com.stoutner.privacybrowser;
-import android.app.Activity;
+import android.annotation.SuppressLint;
import android.app.Dialog;
+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;
-import android.support.v4.app.DialogFragment;
+// 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.widget.EditText;
public class CreateHomeScreenShortcut extends AppCompatDialogFragment {
- // The public interface is used to send information back to the activity that called CreateHomeScreenShortcut.
+ // The public interface is used to send information back to the parent activity.
public interface CreateHomeScreenSchortcutListener {
- void onCreateHomeScreenShortcutCancel(DialogFragment dialog);
-
- void onCreateHomeScreenShortcutCreate(DialogFragment dialog);
+ void onCreateHomeScreenShortcut(AppCompatDialogFragment dialogFragment);
}
- CreateHomeScreenSchortcutListener buttonListener;
+ //`createHomeScreenShortcutListener` is used in `onAttach()` and `onCreateDialog()`.
+ private CreateHomeScreenSchortcutListener createHomeScreenShortcutListener;
- // Check to make sure that the activity that called CreateHomeScreenShortcut implements both listeners.
- public void onAttach(Activity activity) {
- super.onAttach(activity);
+ // Check to make sure that the parent activity implements the listener.
+ public void onAttach(Context context) {
+ super.onAttach(context);
try {
- buttonListener = (CreateHomeScreenSchortcutListener) activity;
- } catch (ClassCastException e) {
- throw new ClassCastException(activity.toString() + " must implement CreateHomeScreenShortcutListener.");
+ createHomeScreenShortcutListener = (CreateHomeScreenSchortcutListener) context;
+ } catch(ClassCastException exception) {
+ throw new ClassCastException(context.toString() + " must implement CreateHomeScreenShortcutListener.");
}
}
- // onCreateDialog requires @NonNull.
+ // `@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);
- // Use AlertDialog.Builder to create the AlertDialog
- AlertDialog.Builder alertDialogBuilder = new AlertDialog.Builder(getActivity());
- LayoutInflater customDialogInflater = getActivity().getLayoutInflater();
- alertDialogBuilder.setTitle(R.string.shortcut_name);
- alertDialogBuilder.setIcon(favoriteIconDrawable);
- alertDialogBuilder.setView(customDialogInflater.inflate(R.layout.create_home_screen_shortcut_dialog, null));
- alertDialogBuilder.setNegativeButton(R.string.cancel, new DialogInterface.OnClickListener() {
+ // 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(layoutInflater.inflate(R.layout.create_home_screen_shortcut_dialog, null));
+
+ // Set an `onClick` listener on the negative button.
+ dialogBuilder.setNegativeButton(R.string.cancel, new DialogInterface.OnClickListener() {
@Override
public void onClick(DialogInterface dialog, int which) {
- buttonListener.onCreateHomeScreenShortcutCancel(CreateHomeScreenShortcut.this);
+ // Do nothing if `Cancel` is clicked.
}
});
- alertDialogBuilder.setPositiveButton(R.string.create, new DialogInterface.OnClickListener() {
+
+ // Set an `onClick` listener on the positive button.
+ dialogBuilder.setPositiveButton(R.string.create, new DialogInterface.OnClickListener() {
@Override
public void onClick(DialogInterface dialog, int which) {
- buttonListener.onCreateHomeScreenShortcutCreate(CreateHomeScreenShortcut.this);
+ createHomeScreenShortcutListener.onCreateHomeScreenShortcut(CreateHomeScreenShortcut.this);
}
});
- // Assign the alertDialogBuilder to an AlertDialog.
- final AlertDialog alertDialog = alertDialogBuilder.create();
- // Show the keyboard when the dialog is displayed on the screen.
+ // 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 alertDialog before we can setOnKeyListener below.
+ // We need to show `alertDialog` before we can call `setOnKeyListener()` below.
alertDialog.show();
- EditText shortcutNameEditText = (EditText) alertDialog.findViewById(R.id.shortcutNameEditText);
-
// Allow the "enter" key on the keyboard to create the shortcut.
+ EditText shortcutNameEditText = (EditText) alertDialog.findViewById(R.id.shortcut_name_edittext);
+ assert shortcutNameEditText != null; // Remove the warning below that shortcutNameEditText might be null.
shortcutNameEditText.setOnKeyListener(new View.OnKeyListener() {
public boolean onKey(View v, int keyCode, KeyEvent event) {
- // If the event is a key-down event on the "enter" button, select the PositiveButton "Create".
+ // If the event is a key-down on the "enter" button, select the PositiveButton "Create".
if ((event.getAction() == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER)) {
// Trigger the create listener.
- buttonListener.onCreateHomeScreenShortcutCreate(CreateHomeScreenShortcut.this);
+ createHomeScreenShortcutListener.onCreateHomeScreenShortcut(CreateHomeScreenShortcut.this);
- // Manually dismiss alertDialog.
+ // Manually dismiss `alertDialog`.
alertDialog.dismiss();
// Consume the event.
return true;
- } else {
- // If any other key was pressed, do not consume the event.
+ } else { // If any other key was pressed, do not consume the event.
return false;
}
}
});
- // onCreateDialog requires the return of an AlertDialog.
+ // `onCreateDialog` requires the return of an `AlertDialog`.
return alertDialog;
}
}
\ No newline at end of file