Customizing the download progress dialog in Java for Android

1
/*
2
 *   Copyright © 2017-2025 PSPDFKit GmbH. All rights reserved.
3
 *
4
 *   The PSPDFKit Sample applications are licensed with a modified BSD license.
5
 *   Please see License for details. This notice may not be removed from this file.
6
 */
7

8
package com.pspdfkit.catalog.examples.java;
9

10
import android.app.Dialog;
11
import android.content.Context;
12
import android.content.Intent;
13
import android.net.Uri;
14
import android.view.LayoutInflater;
15
import android.view.View;
16
import android.widget.ProgressBar;
17
import android.widget.TextView;
18
import androidx.annotation.NonNull;
19
import androidx.appcompat.app.AlertDialog;
20
import androidx.fragment.app.FragmentActivity;
21
import com.pspdfkit.catalog.R;
22
import com.pspdfkit.catalog.SdkExample;
23
import com.pspdfkit.configuration.activity.PdfActivityConfiguration;
24
import com.pspdfkit.document.download.DownloadJob;
25
import com.pspdfkit.document.download.DownloadProgressFragment;
26
import com.pspdfkit.document.download.DownloadRequest;
27
import com.pspdfkit.document.download.Progress;
28
import com.pspdfkit.ui.PdfActivityIntentBuilder;
29
import java.io.File;
30
import java.util.Locale;
31

32
/**
33
 * This is an example showing how to use the {@link DownloadJob} to download a PDF document from the
34
 * web with a custom DownloadProgressFragment.
35
 */
36
public class CustomDocumentDownloadExample extends SdkExample {
37

38
    /** Our custom progress fragment, that displays the name of the currently downloading file. */
39
    public static class CustomDownloadProgressFragment extends DownloadProgressFragment {
40

41
        private TextView downloadDescription;
42
        private TextView downloadPercent;
43
        private TextView downloadSize;
44
        private ProgressBar progressBar;
45

46
        /** Formats the progress like "0.6/12 MB". */
47
        private static String formatProgressSize(Progress progress) {
48
            int unit = 1000;
49
            int exp;
50
            char pre;
51
            if (progress.totalBytes < unit) {
52
                exp = 0;
53
                pre = 'B';
54
            } else {
55
                exp = (int) (Math.log((double) progress.totalBytes) / Math.log((double) unit));
56
                pre = "KMGTPE".charAt(exp - 1);
57
            }
58
            return String.format(
59
                    Locale.getDefault(),
60
                    "%.1f/%.1f %sB",
61
                    progress.bytesReceived / Math.pow((double) unit, (double) exp),
62
                    progress.totalBytes / Math.pow((double) unit, (double) exp),
63
                    pre);
64
        }
65

66
        @NonNull
67
        @Override
68
        protected Dialog createDialog() {
69
            View root = LayoutInflater.from(getContext()).inflate(R.layout.custom_download_dialog, null);
70
            // Setup our views.
71
            downloadDescription = root.findViewById(R.id.downloadDescription);
72
            downloadPercent = root.findViewById(R.id.downloadPercent);
73
            downloadSize = root.findViewById(R.id.downloadSize);
74
            progressBar = root.findViewById(R.id.progressBar);
75

76
            downloadDescription.setText(getString(
77
                    R.string.dialog_download_description,
78
                    getJob().getOutputFile().getName()));
79
            return new AlertDialog.Builder(getContext()).setView(root).create();
80
        }
81

82
        @Override
83
        protected void updateProgress(@NonNull Progress progress) {
84
            double percent = ((double) progress.bytesReceived / (double) progress.totalBytes) * 100;
85
            // Update the displayed progress.
86
            downloadPercent.setText(String.format(Locale.getDefault(), "%.0f%%", percent));
87
            downloadSize.setText(formatProgressSize(progress));
88
            progressBar.setProgress((int) (progress.bytesReceived / 1024));
89
        }
90

91
        @Override
92
        protected void configureDialog(@NonNull Progress progress, boolean isIndeterminate) {
93
            if (!isIndeterminate) {
94
                // If the progress isn't indeterminate we can show the exact progress.
95
                downloadPercent.setVisibility(View.VISIBLE);
96
                downloadSize.setVisibility(View.VISIBLE);
97
                progressBar.setIndeterminate(false);
98
                progressBar.setMax((int) (progress.totalBytes / 1024));
99
            }
100
        }
101
    }
102

103
    public CustomDocumentDownloadExample(@NonNull final Context context) {
104
        super(
105
                context.getString(R.string.customDownloadDialogExampleTitle),
106
                context.getString(R.string.customDownloadDialogExampleDescription));
107
    }
108

109
    @Override
110
    public void launchExample(
111
            @NonNull final Context context, @NonNull final PdfActivityConfiguration.Builder configuration) {
112

113
        // Build a download request based on various input parameters.
114
        final DownloadRequest request = new DownloadRequest.Builder(context)
115
                .uri("https://nutrient.io/downloads/case-study-box.pdf")
116
                .outputFile(new File(context.getDir("documents", Context.MODE_PRIVATE), "case-study-box.pdf"))
117
                .overwriteExisting(true)
118
                .build();
119

120
        // This will initiate the download.
121
        final DownloadJob job = DownloadJob.startDownload(request);
122
        final DownloadProgressFragment fragment = new CustomDownloadProgressFragment();
123
        fragment.show(((FragmentActivity) context).getSupportFragmentManager(), "download-fragment");
124
        fragment.setJob(job);
125

126
        job.setProgressListener(new DownloadJob.ProgressListenerAdapter() {
127
            @Override
128
            public void onComplete(@NonNull File output) {
129
                final Intent intent = PdfActivityIntentBuilder.fromUri(context, Uri.fromFile(output))
130
                        .configuration(configuration.build())
131
                        .build();
132

133
                context.startActivity(intent);
134
            }
135

136
            @Override
137
            public void onError(@NonNull Throwable exception) {
138
                new AlertDialog.Builder(context)
139
                        .setMessage(
140
                                "There was an error downloading the example PDF file. For further information see Logcat.")
141
                        .show();
142
            }
143
        });
144
    }
145
}