--- title: "Custom Download Dialog" canonical_url: "https://www.nutrient.io/guides/android/samples/custom-download-dialog-java/" md_url: "https://www.nutrient.io/guides/android/samples/custom-download-dialog-java.md" last_updated: "2026-05-15T19:10:04.916Z" description: "Build a custom DownloadProgressFragment for document downloads." --- # Custom Download Dialog Build a custom DownloadProgressFragment for document downloads. [Get Started](https://www.nutrient.io/sdk/android/getting-started.md) [All Samples](https://www.nutrient.io/guides/android/samples.md) [Download](https://www.nutrient.io/guides/android/downloads.md) [Launch Demo](https://www.nutrient.io/demo/) --- ```java /* * Copyright © 2017-2026 PSPDFKit GmbH. All rights reserved. * * The PSPDFKit Sample applications are licensed with a modified BSD license. * Please see License for details. This notice may not be removed from this file. */ package com.pspdfkit.catalog.examples.java; import android.app.Dialog; import android.content.Context; import android.content.Intent; import android.net.Uri; import android.view.LayoutInflater; import android.view.View; import android.widget.ProgressBar; import android.widget.TextView; import androidx.annotation.NonNull; import androidx.appcompat.app.AlertDialog; import androidx.fragment.app.FragmentActivity; import com.pspdfkit.catalog.R; import com.pspdfkit.catalog.SdkExample; import com.pspdfkit.configuration.activity.PdfActivityConfiguration; import com.pspdfkit.document.download.DownloadJob; import com.pspdfkit.document.download.DownloadProgressFragment; import com.pspdfkit.document.download.DownloadRequest; import com.pspdfkit.document.download.Progress; import com.pspdfkit.ui.PdfActivityIntentBuilder; import java.io.File; import java.util.Locale; /** * This is an example showing how to use the {@link DownloadJob} to download a PDF document from the * web with a custom DownloadProgressFragment. */ public class CustomDocumentDownloadExample extends SdkExample { /** Our custom progress fragment, that displays the name of the currently downloading file. */ public static class CustomDownloadProgressFragment extends DownloadProgressFragment { private TextView downloadDescription; private TextView downloadPercent; private TextView downloadSize; private ProgressBar progressBar; /** Formats the progress like "0.6/12 MB". */ private static String formatProgressSize(Progress progress) { int unit = 1000; int exp; char pre; if (progress.totalBytes < unit) { exp = 0; pre = 'B'; } else { exp = (int) (Math.log((double) progress.totalBytes) / Math.log((double) unit)); pre = "KMGTPE".charAt(exp - 1); } return String.format( Locale.getDefault(), "%.1f/%.1f %sB", progress.bytesReceived / Math.pow((double) unit, (double) exp), progress.totalBytes / Math.pow((double) unit, (double) exp), pre); } @NonNull @Override public Dialog createDialog() { View root = LayoutInflater.from(getContext()).inflate(R.layout.custom_download_dialog, null); // Setup our views. downloadDescription = root.findViewById(R.id.downloadDescription); downloadPercent = root.findViewById(R.id.downloadPercent); downloadSize = root.findViewById(R.id.downloadSize); progressBar = root.findViewById(R.id.progressBar); downloadDescription.setText(getString( R.string.dialog_download_description, getJob().getOutputFile().getName())); return new AlertDialog.Builder(getContext()).setView(root).create(); } @Override public void updateProgress(@NonNull Progress progress) { double percent = ((double) progress.bytesReceived / (double) progress.totalBytes) * 100; // Update the displayed progress. downloadPercent.setText(String.format(Locale.getDefault(), "%.0f%%", percent)); downloadSize.setText(formatProgressSize(progress)); progressBar.setProgress((int) (progress.bytesReceived / 1024)); } @Override public void configureDialog(@NonNull Progress progress, boolean isIndeterminate) { if (!isIndeterminate) { // If the progress isn't indeterminate we can show the exact progress. downloadPercent.setVisibility(View.VISIBLE); downloadSize.setVisibility(View.VISIBLE); progressBar.setIndeterminate(false); progressBar.setMax((int) (progress.totalBytes / 1024)); } } } public CustomDocumentDownloadExample(@NonNull final Context context) { super(context, R.string.customDownloadDialogExampleTitle, R.string.customDownloadDialogExampleDescription); } @Override public void launchExample( @NonNull final Context context, @NonNull final PdfActivityConfiguration.Builder configuration) { // Build a download request based on various input parameters. final DownloadRequest request = new DownloadRequest.Builder(context).uri("https://nutrient.io/downloads/case-study-box.pdf").outputFile(new File(context.getDir("documents", Context.MODE_PRIVATE), "case-study-box.pdf")).overwriteExisting(true).build(); // This will initiate the download. final DownloadJob job = DownloadJob.startDownload(request); final DownloadProgressFragment fragment = new CustomDownloadProgressFragment(); fragment.show(((FragmentActivity) context).getSupportFragmentManager(), "download-fragment"); fragment.setJob(job); job.setProgressListener(new DownloadJob.ProgressListenerAdapter() { @Override public void onComplete(@NonNull File output) { final Intent intent = PdfActivityIntentBuilder.fromUri(context, Uri.fromFile(output)).configuration(configuration.build()).build(); context.startActivity(intent); } @Override public void onError(@NonNull Throwable exception) { new AlertDialog.Builder(context).setMessage( "There was an error downloading the example PDF file. For further information see Logcat.").show(); } }); } } ``` This code sample is an example that illustrates how to use our SDK. Please adapt it to your specific use case. --- ## Related pages - [Application Policy](/guides/android/samples/application-policy-kotlin.md) - [Custom Form Highlight Color](/guides/android/samples/custom-form-highlight-color-java.md) - [Custom Page Templates](/guides/android/samples/custom-page-templates-java.md) - [Digital Signature (Basic)](/guides/android/samples/digital-signature-basic-kotlin.md) - [Disabled Annotation Property](/guides/android/samples/disabled-annotation-property-java.md) - [Image Document](/guides/android/samples/image-document-kotlin.md) - [Compose Image Document](/guides/android/samples/compose-image-document-kotlin.md) - [Inline Multimedia](/guides/android/samples/inline-multimedia-kotlin.md) - [JavaScript Form Filling](/guides/android/samples/javascript-form-filling-kotlin.md) - [Overlay Visibility](/guides/android/samples/overlay-visibility-kotlin.md) - [PdfFragment](/guides/android/samples/pdffragment-kotlin.md) - [Reader View](/guides/android/samples/reader-view-kotlin.md) - [Playground](/guides/android/samples/playground-kotlin.md) - [JavaScript Calculator](/guides/android/samples/javascript-calculator-kotlin.md) - [Text Field Suggestions](/guides/android/samples/text-field-suggestions-kotlin.md) - [Thumbnail Bar Modes](/guides/android/samples/thumbnail-bar-modes-kotlin.md) - [Signature Storage Database](/guides/android/samples/signature-storage-database-kotlin.md) - [Selection Customization](/guides/android/samples/selection-customization-java.md) - [Password Protected PDF](/guides/android/samples/password-protected-pdf-kotlin.md) - [Scientific Paper](/guides/android/samples/scientific-paper-kotlin.md) - [Try Instant](/guides/android/samples/try-instant-kotlin.md) - [Merge Documents](/guides/android/samples/merge-documents-kotlin.md) - [Annotation Rendering](/guides/android/samples/annotation-rendering-kotlin.md) - [Custom Data Provider](/guides/android/samples/custom-data-provider-kotlin.md) - [Annotations with Transparency](/guides/android/samples/annotations-with-transparency-kotlin.md) - [Annotation Flags](/guides/android/samples/annotation-flags-kotlin.md) - [AI Assistant (Multiple Documents, ViewPager)](/guides/android/samples/ai-assistant-multiple-documents-viewpager-kotlin.md) - [Custom Sharing Menu](/guides/android/samples/custom-sharing-menu-java.md) - [Add LTV to Existing Signature](/guides/android/samples/add-ltv-to-existing-signature-kotlin.md) - [Custom Toolbar Grouping](/guides/android/samples/custom-toolbar-grouping-java.md) - [Custom Layout](/guides/android/samples/custom-layout-kotlin.md) - [Custom ActionBar Actions](/guides/android/samples/custom-actionbar-actions-kotlin.md) - [Custom Activity Toolbars](/guides/android/samples/custom-activity-toolbars-java.md) - [Custom Note Hinter](/guides/android/samples/custom-note-hinter-kotlin.md) - [Custom Main Toolbar](/guides/android/samples/custom-main-toolbar-kotlin.md) - [Annotation Configuration](/guides/android/samples/annotation-configuration-kotlin.md) - [Annotation Selection Styling](/guides/android/samples/annotation-selection-styling-kotlin.md) - [Custom Search UI (Compose)](/guides/android/samples/custom-search-ui-compose-kotlin.md) - [Document Switcher](/guides/android/samples/document-switcher-java.md) - [File Annotation Creation](/guides/android/samples/file-annotation-creation-kotlin.md) - [Dynamic Pages on Scroll](/guides/android/samples/dynamic-pages-on-scroll-kotlin.md) - [Custom Activity Form Editing](/guides/android/samples/custom-activity-form-editing-java.md) - [Custom Stamp Annotations](/guides/android/samples/custom-stamp-annotations-java.md) - [Custom Outline Provider](/guides/android/samples/custom-outline-provider-kotlin.md) - [Compose Navigation](/guides/android/samples/compose-navigation-kotlin.md) - [Fragment Runtime Configuration](/guides/android/samples/fragment-runtime-configuration-kotlin.md) - [Annotation Overlay](/guides/android/samples/annotation-overlay-java.md) - [Instant Document JSON](/guides/android/samples/instant-document-json-kotlin.md) - [DocumentView Composable](/guides/android/samples/documentview-composable-kotlin.md) - [Form Creation](/guides/android/samples/form-creation-kotlin.md) - [Document Download](/guides/android/samples/document-download-kotlin.md) - [JavaScript Actions](/guides/android/samples/javascript-actions-kotlin.md) - [Instant JSON Attachment](/guides/android/samples/instant-json-attachment-kotlin.md) - [Digital Signature (Manual)](/guides/android/samples/digital-signature-manual-kotlin.md) - [Digital Signature (Third-Party)](/guides/android/samples/digital-signature-third-party-kotlin.md) - [Inline Search](/guides/android/samples/inline-search-java.md) - [Form Filling](/guides/android/samples/form-filling-kotlin.md) - [Form Click Intercept (Compose)](/guides/android/samples/form-click-intercept-compose-kotlin.md) - [Document Sharing](/guides/android/samples/document-sharing-java.md) - [Download Progress](/guides/android/samples/download-progress-kotlin.md) - [Popup Toolbar Customization](/guides/android/samples/popup-toolbar-customization-kotlin.md) - [Custom Sharing Dialog](/guides/android/samples/custom-sharing-dialog-java.md) - [PDF from Image](/guides/android/samples/pdf-from-image-kotlin.md) - [Digital Signature (Two-Step)](/guides/android/samples/digital-signature-two-step-kotlin.md) - [Remote URL](/guides/android/samples/remote-url-kotlin.md) - [PdfUiFragment](/guides/android/samples/pdfuifragment-kotlin.md) - [Runtime Configuration](/guides/android/samples/runtime-configuration-kotlin.md) - [Sound Extraction](/guides/android/samples/sound-extraction-kotlin.md) - [Document from Canvas](/guides/android/samples/document-from-canvas-kotlin.md) - [Tabbed Documents](/guides/android/samples/tabbed-documents-kotlin.md) - [Watermarks](/guides/android/samples/watermarks-kotlin.md) - [Programmatic Zoom](/guides/android/samples/programmatic-zoom-kotlin.md) - [Signature Parcelize](/guides/android/samples/signature-parcelize-kotlin.md) - [OCR](/guides/android/samples/ocr-kotlin.md) - [Vertical Scrollbar](/guides/android/samples/vertical-scrollbar-java.md) - [Split View](/guides/android/samples/split-view-java.md) - [XFDF Import/Export](/guides/android/samples/xfdf-import-export-kotlin.md) - [UI View Modes](/guides/android/samples/ui-view-modes-kotlin.md) - [LTV Signature](/guides/android/samples/ltv-signature-kotlin.md) - [Bookmark Highlighting](/guides/android/samples/bookmark-highlighting-kotlin.md) - [Custom Annotation Inspector](/guides/android/samples/custom-annotation-inspector-java.md) - [Annotation Sidebar](/guides/android/samples/annotation-sidebar-kotlin.md) - [AI Assistant (Single Document)](/guides/android/samples/ai-assistant-single-document-kotlin.md) - [AI Assistant (Multiple Documents, Compose)](/guides/android/samples/ai-assistant-multiple-documents-compose-kotlin.md) - [Document Comparison](/guides/android/samples/document-comparison-kotlin.md) - [Document Processing](/guides/android/samples/document-processing-kotlin.md) - [Custom Annotation Creation Toolbar](/guides/android/samples/custom-annotation-creation-toolbar-java.md) - [Custom Electronic Signature](/guides/android/samples/custom-electronic-signature-java.md) - [E-Learning](/guides/android/samples/e-learning-kotlin.md) - [Electronic + Digital Signing](/guides/android/samples/electronic-digital-signing-kotlin.md) - [Generate PDF Report](/guides/android/samples/generate-pdf-report-kotlin.md) - [Multimedia Annotations](/guides/android/samples/multimedia-annotations-kotlin.md) - [Forms with JavaScript](/guides/android/samples/forms-with-javascript-kotlin.md) - [External Document](/guides/android/samples/external-document-kotlin.md) - [Overlay Views](/guides/android/samples/overlay-views-kotlin.md) - [Kiosk Grid](/guides/android/samples/kiosk-grid-kotlin.md) - [Search Indexing](/guides/android/samples/search-indexing-kotlin.md) - [Annotation Creation](/guides/android/samples/annotation-creation-kotlin.md) - [Filterable Thumbnail Grid](/guides/android/samples/filterable-thumbnail-grid-kotlin.md) - [Tabbed Documents (Persistent)](/guides/android/samples/tabbed-documents-persistent-kotlin.md) - [Measurement Tools](/guides/android/samples/measurement-tools-kotlin.md) - [HTML-to-PDF Conversion](/guides/android/samples/html-to-pdf-conversion-kotlin.md) - [AES Encrypted File](/guides/android/samples/aes-encrypted-file-java.md) - [Construction Floor Plan](/guides/android/samples/construction-floor-plan-kotlin.md) - [Hide and Reveal Areas](/guides/android/samples/hide-and-reveal-areas-kotlin.md) - [Multiple Documents (Compose Pager)](/guides/android/samples/multiple-documents-compose-pager-kotlin.md) - [Screen Reader](/guides/android/samples/screen-reader-java.md) - [Custom Search UI (Views)](/guides/android/samples/custom-search-ui-views-java.md)