snackprogressbar

lib / com.tingyik90.snackprogressbar / SnackProgressBar

SnackProgressBar

class SnackProgressBar

SnackProgressBar is the holder for information to be displayed via SnackProgressBarManager.

Types

Name Summary
OnActionClickListener Interface definition for a callback to be invoked when an action is clicked.interface OnActionClickListener

Annotations

Name Summary
SnackProgressBarType annotation class SnackProgressBarType

Constructors

Name Summary
<init> Creates a SnackProgressBar.SnackProgressBar(type: Int, message: String)

Functions

Name Summary
getBundle Gets the additional bundle of SnackProgressBar. This value may be null.fun getBundle(): Bundle?
putBundle Sets the additional bundle of SnackProgressBar, which can be retrieved later.fun putBundle(bundle: Bundle): SnackProgressBar
setAction Sets the action of SnackProgressBar. The action can be clicked to trigger OnActionClickListener.fun setAction(action: String, onActionClickListener: OnActionClickListener?): SnackProgressBar
setAllowUserInput Sets whether user input is allowed. Setting to FALSE will display an OverlayLayout which blocks user input.fun setAllowUserInput(allowUserInput: Boolean): SnackProgressBar
setIconBitmap Sets the icon of SnackProgressBar. Only a bitmap or a resId can be specified at any one time.fun setIconBitmap(bitmap: Bitmap): SnackProgressBar
setIconResource Sets the icon of SnackProgressBar. Only a bitmap or a resId can be specified at any one time.fun setIconResource(iconResId: Int): SnackProgressBar
setIsIndeterminate Sets whether the ProgressBar is indeterminate.fun setIsIndeterminate(isIndeterminate: Boolean): SnackProgressBar
setMessage Sets the message of SnackProgressBar.fun setMessage(message: String): SnackProgressBar
setProgressMax Sets the max progress for determinate ProgressBar.fun setProgressMax(progressMax: Int): SnackProgressBar
setShowProgressPercentage Sets whether to show progress in percentage.fun setShowProgressPercentage(showProgressPercentage: Boolean): SnackProgressBar
setSwipeToDismiss Sets whether user can swipe the SnackProgressBar to dismiss it.fun setSwipeToDismiss(swipeToDismiss: Boolean): SnackProgressBar
setType Sets the type of SnackProgressBar.fun setType(type: Int): Unit
toString Returns a string representation of the SnackProgressBar.fun toString(): String

Companion Object Properties

Name Summary
TYPE_CIRCULAR SnackProgressBar layout with message and circular ProgressBar.const val TYPE_CIRCULAR: Int
TYPE_HORIZONTAL SnackProgressBar layout with message and horizontal ProgressBar.const val TYPE_HORIZONTAL: Int
TYPE_NORMAL SnackProgressBar layout with message only.const val TYPE_NORMAL: Int