1.12.0+1.0.31-sesl8+rev1

SESL Material/com.google.android.material.progressindicator/BaseProgressIndicator

BaseProgressIndicator

abstract class BaseProgressIndicator<S : BaseProgressIndicatorSpec?> : ProgressBar

This class contains the common functions shared in different types of progress indicators. This is an abstract class which is not meant for directly use.

With the default style Widget.MaterialComponents.ProgressIndicator, 4dp indicator/track thickness and no animation is used for visibility change. Without customization, primaryColor will be used as the indicator color; the indicator color applying disabledAlpha will be used as the track color. The following attributes can be used to customize the progress indicator's appearance:

trackThickness: the thickness of the indicator and track.
indicatorColor: the color(s) of the indicator.
trackColor: the color of the track.
trackCornerRadius: the radius of the rounded corner of the indicator and track.
showAnimationBehavior: the animation direction to show the indicator and track.
hideAnimationBehavior: the animation direction to hide the indicator and track.

Inheritors

LinearProgressIndicator

CircularProgressIndicator

Types

HideAnimationBehavior

@RestrictTo(value = Scope.LIBRARY_GROUP)

@Retention(value = RetentionPolicy.SOURCE)

annotation class HideAnimationBehavior

ShowAnimationBehavior

@RestrictTo(value = Scope.LIBRARY_GROUP)

@Retention(value = RetentionPolicy.SOURCE)

annotation class ShowAnimationBehavior

Properties

val HIDE_ESCAPE: Int = 3

val HIDE_INWARD: Int = 2

val HIDE_NONE: Int = 0

val HIDE_OUTWARD: Int = 1

val SHOW_INWARD: Int = 2

val SHOW_NONE: Int = 0

val SHOW_OUTWARD: Int = 1

Functions

getCurrentDrawable

open fun getCurrentDrawable(): Drawable

Returns the corresponding drawable based on current indeterminate state.

getHideAnimationBehavior

open fun getHideAnimationBehavior(): Int

Returns the hide animation behavior used in this progress indicator.

getIndeterminateDrawable

open fun getIndeterminateDrawable(): IndeterminateDrawable<S>

getIndicatorColor

open fun getIndicatorColor(): Array<Int>

Returns the array of colors used in the indicator of this progress indicator.

getIndicatorTrackGapSize

open fun getIndicatorTrackGapSize(): Int

Returns the size of the gap between the indicator and track in pixels.

getProgressDrawable

open fun getProgressDrawable(): DeterminateDrawable<S>

getShowAnimationBehavior

open fun getShowAnimationBehavior(): Int

Returns the show animation behavior used in this progress indicator.

open fun getTrackColor(): Int

Returns the color used in the track of this progress indicator.

getTrackCornerRadius

open fun getTrackCornerRadius(): Int

Returns the radius of the rounded corner for the indicator and track in pixels.

getTrackThickness

open fun getTrackThickness(): Int

Returns the track thickness of this progress indicator in pixels.

open fun hide()

Hides the progress indicator.

open fun invalidate()

setAnimatorDurationScaleProvider

@RestrictTo(value = Scope.LIBRARY_GROUP)

@VisibleForTesting

open fun setAnimatorDurationScaleProvider(@NonNull animatorDurationScaleProvider: AnimatorDurationScaleProvider)

setHideAnimationBehavior

open fun setHideAnimationBehavior(hideAnimationBehavior: Int)

Sets the hide animation behavior used in this progress indicator.

setIndeterminate

open fun setIndeterminate(indeterminate: Boolean)

Sets the progress mode of the progress indicator.

setIndeterminateDrawable

open fun setIndeterminateDrawable(@Nullable drawable: Drawable)

Sets a new indeterminate drawable.

setIndicatorColor

open fun setIndicatorColor(@ColorInt indicatorColors: Array<Int>)

Sets the colors used in the indicator of this progress indicator.

setIndicatorTrackGapSize

open fun setIndicatorTrackGapSize(@Px indicatorTrackGapSize: Int)

Sets the size of the gap between the indicator and track in pixels.

open fun setProgress(progress: Int)

Sets the current progress to the specified value.

setProgressCompat

open fun setProgressCompat(progress: Int, animated: Boolean)

Sets the current progress to the specified value with/without animation based on the input.

setProgressDrawable

open fun setProgressDrawable(@Nullable drawable: Drawable)

Sets a new progress drawable.

setShowAnimationBehavior

open fun setShowAnimationBehavior(showAnimationBehavior: Int)

Sets the show animation behavior used in this progress indicator.

open fun setTrackColor(@ColorInt trackColor: Int)

Sets the color of the track of this progress indicator.

setTrackCornerRadius

open fun setTrackCornerRadius(@Px trackCornerRadius: Int)

Sets the radius of the rounded corner for the indicator and track in pixels.

setTrackThickness

open fun setTrackThickness(@Px trackThickness: Int)

Sets the track thickness of this progress indicator.

setVisibilityAfterHide

open fun setVisibilityAfterHide(visibility: Int)

Sets the visibility which the component will be after hide animation finishes.

open fun show()

Shows the progress indicator.