progressdialoglibrary/com.techiness.progressdialoglibrary/ProgressDialog

ProgressDialog

class ProgressDialog @JvmOverloads constructor( modeConstant: Int = MODE_INDETERMINATE, context: Context, themeConstant: Int = THEME_LIGHT)

An easy to use ProgressDialog library for Android API level 24 and above. The below given parameters apply for all the overloaded constructors in Java or a Single Constructor with default arguments in Kotlin.

Parameters

context

The Activity context which must be provided for sure no matter which overloaded constructor is called.

modeConstant

The Int constant, which is an optional parameter that accepts either MODE_DETERMINATE or MODE_INDETERMINATE. If it is not passed, MODE_INDETERMINATE will be set by default, which can be changed later by setting mode.

themeConstant

The Int constant, which is an optional parameter that accepts either THEME_DARK, THEME_LIGHT, or THEME_FOLLOW_SYSTEM If it is not passed, THEME_LIGHT will be set by default, which can be changed later by setting theme.

NOTE : THEME_FOLLOW_SYSTEM can be used starting from Android API Level 30 (Android 11) only. Attempting to use it in lower versions will throw IllegalArgumentException.

Constructors

ProgressDialog

fun ProgressDialog(context: Context, themeConstant: Int = THEME_LIGHT)

ProgressDialog

@JvmOverloads

fun ProgressDialog( modeConstant: Int = MODE_INDETERMINATE, context: Context, themeConstant: Int = THEME_LIGHT)

Types

Companion

object Companion

ModeConstant

annotation class ModeConstant

ThemeConstant

annotation class ThemeConstant

Functions

dismiss

fun dismiss()

Dismisses the ProgressDialog, removing it from the Screen. Calls DialogInterface.OnDismissListener, if it is set using setOnDismissListener. To be used after the Task calling ProgressDialog is Over or if any Exception Occurs during Task execution. In case of passing to Another Activity/Fragment, this method SHOULD be called before starting the next Activity/Fragment. Else, it would cause WindowLeakedException.

getDeterminateDrawable

fun getDeterminateDrawable(): Drawable?

Gets the Drawable object used to draw the Determinate ProgressBar. Can be used only in MODE_DETERMINATE.

getIndeterminateDrawable

fun getIndeterminateDrawable(): Drawable?

Gets the Drawable object used to draw the Indeterminate ProgressBar. Can be used only in MODE_INDETERMINATE.

getMessage

fun getMessage(): CharSequence

Gets the Message showed in the ProgressDialog.

getTitle

fun getTitle(): CharSequence

Gets the Current Title of The ProgressDialog.

hasProgressReachedMaxValue

fun hasProgressReachedMaxValue(): Boolean

Checks if ProgressValue is equal to MaxValue. Can be used only in MODE_DETERMINATE.

hasSecondaryProgressReachedMaxValue

fun hasSecondaryProgressReachedMaxValue(): Boolean

Checks if Secondary ProgressValue is equal to MaxValue. Can be used only in MODE_DETERMINATE.

hideNegativeButton

fun hideNegativeButton()

Hides the NegativeButton. NegativeButton is Hidden by Default. Use this method only if you have used setNegativeButton or setNegativeButton before. Note : This method will not hide the Title. You have to explicitly call hideTitle to do the same.

hideProgressText

fun hideProgressText(): Boolean

Hides the Progress TextView. Can be used only in MODE_DETERMINATE.

hideTitle

fun hideTitle(): Boolean

Hides the Title of ProgressDialog. Title is Hidden by Default. Use this method only if you have used setTitle before. This method won't work if setNegativeButton was used before.

incrementProgress

fun incrementProgress()

Increments the Progress Value of Determinate ProgressBar using the Offset Value set using incrementValue. Can be used only in MODE_DETERMINATE Mode.

remainingProgress

fun remainingProgress(): Int

Gets the Integral Value required to reach MaxValue from the current ProgressValue. Can be used only in MODE_DETERMINATE.

secondaryRemainingProgress

fun secondaryRemainingProgress(): Int

Gets the Integral Value required to reach MaxValue from the current Secondary ProgressValue. Can be used only in MODE_DETERMINATE.

setDeterminateDrawable

fun setDeterminateDrawable(progressDrawable: Drawable?): Boolean

Sets a Custom Drawable to the Determinate ProgressBar. Can be used only in MODE_DETERMINATE. Use this when you need to define a custom Drawable Design for Determinate ProgressBar.

fun setDeterminateDrawable(@DrawableRes progressDrawableResID: Int): Boolean

Sets a Custom Drawable from the passed Drawable resource to the Determinate ProgressBar. Can be used only in MODE_DETERMINATE. Use this when you need to define a custom Drawable Design for Determinate ProgressBar.

setIndeterminateDrawable

fun setIndeterminateDrawable(progressDrawable: Drawable?): Boolean

Sets a Custom Drawable to the Indeterminate ProgressBar. Can be used only in MODE_DETERMINATE. Use this when you need to define a custom Drawable Design for Indeterminate ProgressBar.

fun setIndeterminateDrawable(@DrawableRes progressDrawableResID: Int): Boolean

Sets a Custom Drawable from the passed Drawable resource to the Indeterminate ProgressBar. Can be used only in MODE_INDETERMINATE. Use this when you need to define a custom Drawable Design for Indeterminate ProgressBar.

setMessage

fun setMessage(message: CharSequence)

Sets the Text to be displayed alongside ProgressBar. Message is "Loading" by Default.

fun setMessage(@StringRes messageResID: Int)

Sets the Text from the resID provided, to be displayed alongside ProgressBar. Message is "Loading" by Default.

setNegativeButton

fun setNegativeButton( text: CharSequence, title: CharSequence, listener: View.OnClickListener?)

Sets the NegativeButton with the passed text for the ProgressDialog and also sets the OnClickListener for the Button. NegativeButton is hidden by default. This method makes it visible. This method also enables the Title to be shown (even if it was hidden till then). If setTitle or setTitle was used before, and new Title is passed, the new Title will Override the previously set Title. If null is passed for listener, default listener which dismisses the ProgressDialog when clicked, will be used.

fun setNegativeButton( @StringRes textResID: Int, @StringRes titleResID: Int, listener: View.OnClickListener?)

Sets the NegativeButton with the text from passed resource id for the ProgressDialog and also sets the OnClickListener for the Button. NegativeButton is hidden by default. This method makes it visible. This method also enables the Title to be shown (even if it was hidden till then). If setTitle or setTitle was used before, and new titleResID is passed, the new Title will Override the previously set Title. If null is passed for listener, default listener which dismisses the ProgressDialog when clicked, will be used.

setOnCancelListener

fun setOnCancelListener(onCancelListener: DialogInterface.OnCancelListener): Boolean

Sets the DialogInterface.OnCancelListener for ProgressDialog. Should be used only if isCancelable was set true earlier since cancel() cannot be called explicitly and ProgressDialog is NOT cancelable by Default.

setOnDismissListener

fun setOnDismissListener(onDismissListener: DialogInterface.OnDismissListener)

Sets the DialogInterface.OnDismissListener for ProgressDialog.

setOnShowListener

@JvmOverloads

fun setOnShowListener(isTimeTrackingEnabled: Boolean = false, onShowListener: DialogInterface.OnShowListener?)

Sets the DialogInterface.OnShowListener for ProgressDialog. Time Tracking is disabled by Default. It can be enabled by passing true to the isTimeTrackingEnabled parameter of the function. The onshowListener parameter can be null when isTimeTrackingEnabled parameter is passed. If null is passed for onShowListener when isTimeTrackingEnabled is not passed, no listener will be set. Enabling Time Tracking will make isCancelable to true automatically, since Time Tracking is an indefinite operation. It is recommended to set NEGATIVE BUTTON using setNegativeButton Method or set DialogInterface.OnDismissListener using setOnDismissListener after enabling Time Tracking feature. Time Tracking will stop when progress reaches maxValue or when the Dialog is dismissed or cancelled.

setTitle

fun setTitle(title: CharSequence)

Sets the Title of ProgressDialog. This is "ProgressDialog" by Default. Title is Hidden by Default. This Method makes the Title Visible. Title will be made visible automatically if setNegativeButton or setNegativeButton was used before.

fun setTitle(@StringRes titleResID: Int)

Sets the Title of ProgressDialog using the String resource given. Title is "ProgressDialog" by Default. Title is Hidden by Default. This Method makes the Title Visible. Title will be made visible automatically if setNegativeButton or setNegativeButton was used before.

show

fun show()

Starts the ProgressDialog and shows it on the Screen.

showProgressTextAsFraction

fun showProgressTextAsFraction(progressTextAsFraction: Boolean): Boolean

Toggles the Progress TextView's format as Fraction if "true" is passed. Progress TextView's Default format is Percentage format. Can be used only in MODE_DETERMINATE. If hideProgressText was used before, this method will again make Progress TextView visible.

Properties

incrementValue

var incrementValue: Int = 1

Gets/Sets the Increment Value of the MODE_DETERMINATE ProgressDialog. The default value is 1. Gets the Increment Value only if the ProgressDialog is in MODE_DETERMINATE Mode, else -1 is returned. Sets the Increment Value only if the ProgressDialog is in MODE_DETERMINATE Mode. If the passed parameter is greater than maxValue, it will not be set.

isCancelable

var isCancelable: Boolean = false

Toggles the Cancelable property of ProgressDialog which is false by Default. If it is set to true, the User can cancel the ProgressDialog by pressing Back Button or by touching any other part of the screen. It is NOT RECOMMENDED to set Cancelable to true unless Time Tracking is enabled.

maxValue

var maxValue: Int

Gets/Sets the Maximum value of MODE_DETERMINATE ProgressBar. Gets the Maximum Value only if the ProgressBar is in MODE_DETERMINATE. Else, -1 is returned. Sets the parameter value as Maximum Value only if the ProgressBar is in MODE_DETERMINATE Mode. It is advised to Set this value before setting progress or calling incrementProgress Method.

mode

var mode: Int

Gets/Sets the mode of the ProgressDialog which is MODE_INDETERMINATE by Default. If you're going to use only one Mode constantly, no need to set this. Instead, use an appropriate Constructor to set the required Mode during Instantiation. Only MODE_DETERMINATE or MODE_INDETERMINATE should be passed as parameter for the Setter.

progress

var progress: Int

Gets/Sets the Progress Value of Determinate ProgressBar. Can be used only in MODE_DETERMINATE Mode. Does not do anything if the ProgressDialog is in MODE_INDETERMINATE Mode. If the parameter progress is greater than MaxValue for Setter, MaxValue will be set as Progress. The Getter will return the current Progress Value if it is in MODE_DETERMINATE Mode, else -1 will be returned.

progressTintList

var progressTintList: ColorStateList?

Gets/Sets the Tint List Associated with the Current MODE_DETERMINATE or MODE_INDETERMINATE Mode ProgressDialog respectively.

secondaryProgress

var secondaryProgress: Int

Gets/Sets the Secondary ProgressValue. Can be used only in MODE_DETERMINATE. Getter returns the Secondary ProgressValue only if the ProgressDialog is in MODE_DETERMINATE else -1 is returned. Setter works only when called on MODE_DETERMINATE Mode.

secondaryProgressTintList

var secondaryProgressTintList: ColorStateList?

Gets/Sets the Secondary Progress Tint List Associated with the Current MODE_DETERMINATE or MODE_INDETERMINATE Mode ProgressDialog respectively.

theme

var theme: Int

Gets/Sets the theme of the ProgressDialog. The theme is THEME_LIGHT by Default. If you're going to use only one Theme constantly, no need to set this. Instead, use an appropriate Constructor to set the required Theme during Instantiation. Only THEME_LIGHT, THEME_DARK or THEME_FOLLOW_SYSTEM should be passed as parameter for the Setter.