nutrient/com.pspdfkit.document.download/DownloadProgressFragment

DownloadProgressFragment

open class DownloadProgressFragment : DialogFragment

A fragment for retaining a DownloadJob and showing its progress. Create the fragment via its constructor and set its job. This is a retained fragment and can't be used as nested fragment.

Constructors

constructor()

Properties

dialog

open override val dialog: Dialog?

job

var job: DownloadJob?

The DownloadJob being tracked and displayed by this fragment. Reading returns the retained job, or null if none was set. Assigning a job makes the fragment retain it across configuration changes (if added to the activity) and show its progress via a dialog.

Functions

getDialog

open override fun getDialog(): Dialog?

Returns the Dialog managed by this fragment.

onCancel

open override fun onCancel(dialog: DialogInterface)

Called when the dialog is cancelled by the user. Cancels the progress collection, cancels the download job, and notifies any registered cancel listener.

onCreate

open override fun onCreate(savedInstanceState: Bundle?)

Called when the fragment is first created. Sets the fragment to be retained across configuration changes.

onCreateDialog

override fun onCreateDialog(savedInstanceState: Bundle?): Dialog

Creates and returns the download progress dialog.

onDestroyView

open override fun onDestroyView()

Called when the view hierarchy associated with the fragment is being removed. Handles the retained instance bug by clearing the dismiss message.

setDialogOnCancelListener

fun setDialogOnCancelListener(dialogCancelListener: DialogInterface.OnCancelListener?)

Sets a DialogInterface.OnCancelListener that will be informed when the progress dialog was cancelled by the user. Calling this method will replace any previously set listener. You may provide null to clear the listener.