CircularProgressLayout

Kotlin |Java

public class CircularProgressLayout

---

CircularProgressLayout adds a circular countdown timer behind the view it contains, typically used to automatically confirm an operation after a short delay has elapsed.

The developer can specify a countdown interval via setTotalTime and a listener via setOnTimerFinishedListener to be called when the time has elapsed after startTimer has been called. Tap action can be received via setOnClickListener and can be used to cancel the timer via stopTimer method.

Alternatively, this layout can be used to show indeterminate progress by calling setIndeterminate method.

Summary

Nested types
CircularProgressLayout.OnTimerFinishedListener	Interface to implement for listening to onTimerFinished event.

Public constructors
CircularProgressLayout(@NonNull Context context)
CircularProgressLayout(     @NonNull Context context,     @NonNull AttributeSet attrs )
CircularProgressLayout(     @NonNull Context context,     @NonNull AttributeSet attrs,     @NonNull int defStyleAttr )
CircularProgressLayout(     @NonNull Context context,     @NonNull AttributeSet attrs,     @NonNull int defStyleAttr,     @NonNull int defStyleRes )

Public methods
@ColorInt @NonNull int	getBackgroundColor() Returns the background color of the CircularProgressDrawable.
@NonNull int[]	getColorSchemeColors() Returns the color scheme colors of the progress drawable
@Nullable CircularProgressLayout.OnTimerFinishedListener	getOnTimerFinishedListener() Returns the OnTimerFinishedListener that is registered to this layout.
@NonNull CircularProgressDrawable	getProgressDrawable() Returns the CircularProgressDrawable used as background of this layout.
@NonNull float	getStartingRotation() Returns the starting rotation of the progress drawable.
@NonNull float	getStrokeWidth() Returns the stroke width of the progress drawable in pixels.
@NonNull long	getTotalTime() Returns the total time in milliseconds for the timer to countdown to.
@NonNull boolean	isIndeterminate() Returns if progress is showing as an indeterminate spinner.
@NonNull boolean	isTimerRunning() Returns if the timer is running.
@Override @NonNull void	setBackgroundColor(@ColorInt @NonNull int color) Sets the background color of the CircularProgressDrawable, which is drawn as a circle inside the progress drawable.
@NonNull void	setColorSchemeColors(@NonNull int[] colors) Sets the color scheme colors of the progress drawable, which is equivalent to calling setColorSchemeColors method on background drawable of this layout.
@NonNull void	setIndeterminate(@NonNull boolean indeterminate) Sets if progress should be shown as an indeterminate spinner.
@NonNull void	setOnTimerFinishedListener(     @Nullable CircularProgressLayout.OnTimerFinishedListener listener ) Sets the OnTimerFinishedListener to be notified when timer countdown is finished.
@NonNull void	setStartingRotation(@NonNull float rotation) Sets the starting rotation for the progress drawable to start from.
@NonNull void	setStrokeWidth(@NonNull float strokeWidth) Sets the stroke width of the progress drawable in pixels.
@NonNull void	setTotalTime(@NonNull long totalTime) Sets the total time in milliseconds for the timer to countdown to.
@NonNull void	startTimer() Starts the timer countdown.
@NonNull void	stopTimer() Stops the timer countdown.

Inherited methods
From class FrameLayout @NonNull FrameLayout.LayoutParams generateLayoutParams(@NonNull AttributeSet attrs) @NonNull CharSequence getAccessibilityClassName() @NonNull boolean getConsiderGoneChildrenWhenMeasuring() This method is deprecated. @NonNull boolean getMeasureAllChildren() @NonNull void setForegroundGravity(@NonNull int foregroundGravity) @NonNull void setMeasureAllChildren(@NonNull boolean measureAll) @NonNull boolean shouldDelayChildPressedState()
From class View @NonNull void addOnAttachStateChangeListener(     @NonNull View.OnAttachStateChangeListener listener )