[ProgressIndicator] Made BaseProgressIndicator and BaseProgressIndicatorSpec abstract.

PiperOrigin-RevId: 342737029

Author: pekingme

lib/java/com/google/android/material/progressindicator/AnimatedVisibilityChangeBehavior.java

@@ -49,7 +49,7 @@
 
 /**
  * This class contains the common functions shared in different types of progress indicators. This
- * is an abstract class which is meant for directly use.
+ * is an abstract class which is not meant for directly use.
  *
  * <p>With the default style {@link R.style#Widget_MaterialComponents_ProgressIndicator}, 4dp
  * indicator/track size and no animation is used for visibility change. Without customization,
@@ -66,7 +66,8 @@
  *   <li>{@code hideAnimationBehavior}: the animation direction to hide the indicator and track.
  * </ul>
  */
-public class BaseProgressIndicator extends ProgressBar {
+public abstract class BaseProgressIndicator<S extends BaseProgressIndicatorSpec>
+    extends ProgressBar {
   // Constants for show/hide animation behaviors.
   public static final int SHOW_NONE = 0;
   public static final int SHOW_OUTWARD = 1;
@@ -83,10 +84,10 @@ public class BaseProgressIndicator extends ProgressBar {
    * The maximum time, in milliseconds, that the requested hide action is allowed to wait once
    * {@link #show()} is called.
    */
-  private static final int MAX_HIDE_DELAY = 1000;
+  static final int MAX_HIDE_DELAY = 1000;
 
   /** A place to hold all the attributes. */
-  final BaseProgressIndicatorSpec baseSpec;
+  S spec;
 
   /** A temp place to hold new progress while switching from indeterminate to determinate mode. */
   private int storedProgress;
@@ -117,7 +118,7 @@ public class BaseProgressIndicator extends ProgressBar {
 
   private long lastShowStartTime = -1L;
 
-  private AnimatorDurationScaleProvider animatorDurationScaleProvider;
+  AnimatorDurationScaleProvider animatorDurationScaleProvider;
 
   // The flag to mark if an indeterminate mode switching is requested.
   private boolean isIndeterminateModeChangeRequested = false;
@@ -127,14 +128,6 @@ public class BaseProgressIndicator extends ProgressBar {
 
   // **************** Constructors ****************
 
-  protected BaseProgressIndicator(@NonNull Context context) {
-    this(context, null);
-  }
-
-  protected BaseProgressIndicator(@NonNull Context context, @Nullable AttributeSet attrs) {
-    this(context, attrs, 0);
-  }
-
   protected BaseProgressIndicator(
       @NonNull Context context, @Nullable AttributeSet attrs, @AttrRes final int defStyleAttr) {
     super(wrap(context, attrs, defStyleAttr, DEF_STYLE_RES), attrs, defStyleAttr);
@@ -143,7 +136,7 @@ protected BaseProgressIndicator(
     // passed in.
     context = getContext();
 
-    baseSpec = new BaseProgressIndicatorSpec(context, attrs, defStyleAttr);
+    spec = createSpec(context, attrs);
 
     // Loads additional attributes for view level.
     TypedArray a =
@@ -162,6 +155,8 @@ protected BaseProgressIndicator(
     isParentDoneInitializing = true;
   }
 
+  abstract S createSpec(@NonNull Context context, @NonNull AttributeSet attrs);
+
   // ******************** Initialization **********************
 
   private void registerAnimationCallbacks() {
@@ -329,7 +324,7 @@ protected synchronized void onDraw(@NonNull Canvas canvas) {
   @Override
   protected synchronized void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
     super.onMeasure(widthMeasureSpec, heightMeasureSpec);
-    DrawingDelegate drawingDelegate = getCurrentDrawingDelegate();
+    DrawingDelegate<S> drawingDelegate = getCurrentDrawingDelegate();
     if (drawingDelegate == null) {
       return;
     }
@@ -363,7 +358,7 @@ public Drawable getCurrentDrawable() {
 
   /** Returns the drawing delegate associated with the current drawable. */
   @Nullable
-  private DrawingDelegate getCurrentDrawingDelegate() {
+  private DrawingDelegate<S> getCurrentDrawingDelegate() {
     if (isIndeterminate()) {
       return getIndeterminateDrawable() == null
           ? null
@@ -386,7 +381,7 @@ public void setProgressDrawable(@Nullable Drawable drawable) {
       return;
     }
     if (drawable instanceof DeterminateDrawable) {
-      DeterminateDrawable determinateDrawable = (DeterminateDrawable) drawable;
+      DeterminateDrawable<S> determinateDrawable = (DeterminateDrawable<S>) drawable;
       determinateDrawable.hideNow();
       super.setProgressDrawable(determinateDrawable);
       // Every time ProgressBar sets progress drawable, it refreshes the drawable's level with
@@ -411,7 +406,7 @@ public void setIndeterminateDrawable(@Nullable Drawable drawable) {
       return;
     }
     if (drawable instanceof IndeterminateDrawable) {
-      ((IndeterminateDrawable) drawable).hideNow();
+      ((DrawableWithAnimatedVisibilityChange) drawable).hideNow();
       super.setIndeterminateDrawable(drawable);
     } else {
       throw new IllegalArgumentException(
@@ -421,14 +416,14 @@ public void setIndeterminateDrawable(@Nullable Drawable drawable) {
 
   @Nullable
   @Override
-  public DeterminateDrawable getProgressDrawable() {
-    return (DeterminateDrawable) super.getProgressDrawable();
+  public DeterminateDrawable<S> getProgressDrawable() {
+    return (DeterminateDrawable<S>) super.getProgressDrawable();
   }
 
   @Nullable
   @Override
-  public IndeterminateDrawable getIndeterminateDrawable() {
-    return (IndeterminateDrawable) super.getIndeterminateDrawable();
+  public IndeterminateDrawable<S> getIndeterminateDrawable() {
+    return (IndeterminateDrawable<S>) super.getIndeterminateDrawable();
   }
 
   /**
@@ -537,7 +532,7 @@ public synchronized void setIndeterminate(boolean indeterminate) {
    */
   @Px
   public int getIndicatorSize() {
-    return baseSpec.indicatorSize;
+    return spec.indicatorSize;
   }
 
   /**
@@ -549,8 +544,8 @@ public int getIndicatorSize() {
    *     com.google.android.material.progressindicator.R.stylable#BaseProgressIndicator_indicatorSize
    */
   public void setIndicatorSize(@Px int indicatorSize) {
-    if (baseSpec.indicatorSize != indicatorSize) {
-      baseSpec.indicatorSize = indicatorSize;
+    if (spec.indicatorSize != indicatorSize) {
+      spec.indicatorSize = indicatorSize;
       requestLayout();
     }
   }
@@ -564,7 +559,7 @@ public void setIndicatorSize(@Px int indicatorSize) {
    */
   @NonNull
   public int[] getIndicatorColor() {
-    return baseSpec.indicatorColors;
+    return spec.indicatorColors;
   }
 
   /**
@@ -581,7 +576,7 @@ public void setIndicatorColor(@ColorInt int... indicatorColors) {
       indicatorColors = new int[] {MaterialColors.getColor(getContext(), R.attr.colorPrimary, -1)};
     }
     if (!Arrays.equals(getIndicatorColor(), indicatorColors)) {
-      baseSpec.indicatorColors = indicatorColors;
+      spec.indicatorColors = indicatorColors;
       getIndeterminateDrawable().getAnimatorDelegate().invalidateSpecValues();
       invalidate();
     }
@@ -596,7 +591,7 @@ public void setIndicatorColor(@ColorInt int... indicatorColors) {
    */
   @ColorInt
   public int getTrackColor() {
-    return baseSpec.trackColor;
+    return spec.trackColor;
   }
 
   /**
@@ -608,8 +603,8 @@ public int getTrackColor() {
    *     com.google.android.material.progressindicator.R.stylable#BaseProgressIndicator_trackColor
    */
   public void setTrackColor(@ColorInt int trackColor) {
-    if (baseSpec.trackColor != trackColor) {
-      baseSpec.trackColor = trackColor;
+    if (spec.trackColor != trackColor) {
+      spec.trackColor = trackColor;
       invalidate();
     }
   }
@@ -623,7 +618,7 @@ public void setTrackColor(@ColorInt int trackColor) {
    */
   @Px
   public int getIndicatorCornerRadius() {
-    return baseSpec.indicatorCornerRadius;
+    return spec.indicatorCornerRadius;
   }
 
   /**
@@ -635,8 +630,8 @@ public int getIndicatorCornerRadius() {
    *     com.google.android.material.progressindicator.R.stylable#BaseProgressIndicator_indicatorCornerRadius
    */
   public void setIndicatorCornerRadius(@Px int indicatorCornerRadius) {
-    if (baseSpec.indicatorCornerRadius != indicatorCornerRadius) {
-      baseSpec.indicatorCornerRadius = min(indicatorCornerRadius, baseSpec.indicatorSize / 2);
+    if (spec.indicatorCornerRadius != indicatorCornerRadius) {
+      spec.indicatorCornerRadius = min(indicatorCornerRadius, spec.indicatorSize / 2);
     }
   }
 
@@ -649,7 +644,7 @@ public void setIndicatorCornerRadius(@Px int indicatorCornerRadius) {
    */
   @ShowAnimationBehavior
   public int getShowAnimationBehavior() {
-    return baseSpec.showAnimationBehavior;
+    return spec.showAnimationBehavior;
   }
 
   /**
@@ -661,7 +656,7 @@ public int getShowAnimationBehavior() {
    *     com.google.android.material.progressindicator.R.stylable#BaseProgressIndicator_showAnimationBehavior
    */
   public void setShowAnimationBehavior(@ShowAnimationBehavior int showAnimationBehavior) {
-    baseSpec.showAnimationBehavior = showAnimationBehavior;
+    spec.showAnimationBehavior = showAnimationBehavior;
     invalidate();
   }
 
@@ -674,7 +669,7 @@ public void setShowAnimationBehavior(@ShowAnimationBehavior int showAnimationBeh
    */
   @HideAnimationBehavior
   public int getHideAnimationBehavior() {
-    return baseSpec.hideAnimationBehavior;
+    return spec.hideAnimationBehavior;
   }
 
   /**
@@ -686,7 +681,7 @@ public int getHideAnimationBehavior() {
    *     com.google.android.material.progressindicator.R.stylable#BaseProgressIndicator_hideAnimationBehavior
    */
   public void setHideAnimationBehavior(@HideAnimationBehavior int hideAnimationBehavior) {
-    baseSpec.hideAnimationBehavior = hideAnimationBehavior;
+    spec.hideAnimationBehavior = hideAnimationBehavior;
     invalidate();
   }
 
@@ -745,6 +740,20 @@ public void setProgressCompat(int progress, boolean animated) {
     }
   }
 
+  /**
+   * Sets the visibility which the component will be after hide animation finishes.
+   *
+   * @param visibility New component's visibility after the hide animation finishes.
+   */
+  public void setVisibilityAfterHide(int visibility) {
+    if (visibility != View.VISIBLE && visibility != View.INVISIBLE && visibility != View.GONE) {
+      throw new IllegalArgumentException(
+          "The component's visibility must be one of VISIBLE, INVISIBLE, and GONE defined in"
+              + " View.");
+    }
+    visibilityAfterHide = visibility;
+  }
+
   @VisibleForTesting
   public void setAnimatorDurationScaleProvider(
       @NonNull AnimatorDurationScaleProvider animatorDurationScaleProvider) {

lib/java/com/google/android/material/progressindicator/BaseProgressIndicator.java

@@ -37,9 +37,9 @@
 
 /**
  * This class contains the parameters shared between linear type and circular type. The parameters
- * reflect the attribtues defined in {@link R.styleable#BaseProgressIndicator}.
+ * reflect the attributes defined in {@link R.styleable#BaseProgressIndicator}.
  */
-public class BaseProgressIndicatorSpec implements AnimatedVisibilityChangeBehavior {
+public abstract class BaseProgressIndicatorSpec {
   /** The size of the progress track and indicator. */
   @Px public int indicatorSize;
 
@@ -52,8 +52,7 @@ public class BaseProgressIndicatorSpec implements AnimatedVisibilityChangeBehavi
 
   /**
    * The color array of the progress stroke. In determinate mode and single color indeterminate
-   * mode, only the first item will be used. This field combines the attribute indicatorColor and
-   * indicatorColors defined in the XML.
+   * mode, only the first item will be used.
    */
   @NonNull public int[] indicatorColors = new int[0];
 
@@ -69,8 +68,6 @@ public class BaseProgressIndicatorSpec implements AnimatedVisibilityChangeBehavi
   /** The animation behavior to hide the indicator and track. */
   @HideAnimationBehavior public int hideAnimationBehavior;
 
-  protected BaseProgressIndicatorSpec(){}
-
   /**
    * Instantiates BaseProgressIndicatorSpec.
    *
@@ -82,10 +79,10 @@ protected BaseProgressIndicatorSpec(){}
    */
   protected BaseProgressIndicatorSpec(
       @NonNull Context context, @Nullable AttributeSet attrs, @AttrRes final int defStyleAttr) {
-    loadSpecFromAttributes(context, attrs, defStyleAttr);
+    loadBaseSpecFromAttributes(context, attrs, defStyleAttr);
   }
 
-  private void loadSpecFromAttributes(
+  private void loadBaseSpecFromAttributes(
       @NonNull Context context, @Nullable AttributeSet attrs, @AttrRes final int defStyleAttr) {
     int defaultIndicatorSize =
         context.getResources().getDimensionPixelSize(R.dimen.mtrl_progress_indicator_size);
@@ -179,13 +176,13 @@ private void loadTrackColor(@NonNull Context context, @NonNull TypedArray typedA
     trackColor = MaterialColors.compositeARGBWithAlpha(trackColor, trackAlpha);
   }
 
-  @Override
   public boolean isShowAnimationEnabled() {
     return showAnimationBehavior != BaseProgressIndicator.SHOW_NONE;
   }
 
-  @Override
   public boolean isHideAnimationEnabled() {
     return hideAnimationBehavior != BaseProgressIndicator.HIDE_NONE;
   }
+
+  abstract void validateSpec();
 }