[MaterialShapeDrawable] Introduce ShapeAppearance interface to reduce branching between ShapeAppearanceModel and StateListShapeAppearanceModel

PiperOrigin-RevId: 784395554

Author: imhappi

lib/java/com/google/android/material/button/MaterialButton.java

@@ -80,6 +80,7 @@
 import com.google.android.material.resources.MaterialResources;
 import com.google.android.material.shape.MaterialShapeDrawable;
 import com.google.android.material.shape.MaterialShapeUtils;
+import com.google.android.material.shape.ShapeAppearance;
 import com.google.android.material.shape.ShapeAppearanceModel;
 import com.google.android.material.shape.Shapeable;
 import com.google.android.material.shape.StateListShapeAppearanceModel;
@@ -298,23 +299,23 @@ public MaterialButton(@NonNull Context context, @Nullable AttributeSet attrs, in
     StateListShapeAppearanceModel stateListShapeAppearanceModel =
         StateListShapeAppearanceModel.create(
             context, attributes, R.styleable.MaterialButton_shapeAppearance);
-    ShapeAppearanceModel shapeAppearanceModel =
+    ShapeAppearance shapeAppearance =
         stateListShapeAppearanceModel != null
-            ? stateListShapeAppearanceModel.getDefaultShape(/* withCornerSizeOverrides= */ true)
+            ? stateListShapeAppearanceModel
             : ShapeAppearanceModel.builder(context, attrs, defStyleAttr, DEF_STYLE_RES).build();
     boolean opticalCenterEnabled =
         attributes.getBoolean(R.styleable.MaterialButton_opticalCenterEnabled, false);
 
     // Loads and sets background drawable attributes
-    materialButtonHelper = new MaterialButtonHelper(this, shapeAppearanceModel);
+    materialButtonHelper = new MaterialButtonHelper(this, shapeAppearance);
     materialButtonHelper.loadFromAttributes(attributes);
 
     // Sets the checked state after the MaterialButtonHelper is initialized.
     setCheckedInternal(attributes.getBoolean(R.styleable.MaterialButton_android_checked, false));
 
-    if (stateListShapeAppearanceModel != null) {
+    if (shapeAppearance instanceof StateListShapeAppearanceModel) {
       materialButtonHelper.setCornerSpringForce(createSpringForce());
-      materialButtonHelper.setStateListShapeAppearanceModel(stateListShapeAppearanceModel);
+      materialButtonHelper.setShapeAppearance(shapeAppearance);
     }
     setOpticalCenterEnabled(opticalCenterEnabled);
 
@@ -1396,7 +1397,7 @@ public void setCheckable(boolean checkable) {
   @Override
   public void setShapeAppearanceModel(@NonNull ShapeAppearanceModel shapeAppearanceModel) {
     if (isUsingOriginalBackground()) {
-      materialButtonHelper.setShapeAppearanceModel(shapeAppearanceModel);
+      materialButtonHelper.setShapeAppearance(shapeAppearanceModel);
     } else {
       throw new IllegalStateException(
           "Attempted to set ShapeAppearanceModel on a MaterialButton which has an overwritten"
@@ -1425,45 +1426,44 @@ public ShapeAppearanceModel getShapeAppearanceModel() {
   }
 
   /**
-   * Sets the {@link StateListShapeAppearanceModel} used for this {@link MaterialButton}'s original
+   * Sets the {@link ShapeAppearance} used for this {@link MaterialButton}'s original
    * drawables.
    *
    * @throws IllegalStateException if the MaterialButton's background has been overwritten.
    * @hide
    */
   @RestrictTo(LIBRARY_GROUP)
-  public void setStateListShapeAppearanceModel(
-      @NonNull StateListShapeAppearanceModel stateListShapeAppearanceModel) {
+  public void setShapeAppearance(
+      @NonNull ShapeAppearance shapeAppearance) {
     if (isUsingOriginalBackground()) {
-      if (materialButtonHelper.getCornerSpringForce() == null
-          && stateListShapeAppearanceModel.isStateful()) {
+      if (materialButtonHelper.getCornerSpringForce() == null && shapeAppearance.isStateful()) {
         materialButtonHelper.setCornerSpringForce(createSpringForce());
       }
-      materialButtonHelper.setStateListShapeAppearanceModel(stateListShapeAppearanceModel);
+      materialButtonHelper.setShapeAppearance(shapeAppearance);
     } else {
       throw new IllegalStateException(
-          "Attempted to set StateListShapeAppearanceModel on a MaterialButton which has an"
+          "Attempted to set ShapeAppearance on a MaterialButton which has an"
               + " overwritten background.");
     }
   }
 
   /**
-   * Returns the {@link StateListShapeAppearanceModel} used for this {@link MaterialButton}'s
+   * Returns the {@link ShapeAppearance} used for this {@link MaterialButton}'s
    * original drawables.
    *
-   * <p>This {@link StateListShapeAppearanceModel} can be modified to change the component's shape.
+   * <p>This {@link ShapeAppearance} can be modified to change the component's shape.
    *
    * @throws IllegalStateException if the MaterialButton's background has been overwritten.
    * @hide
    */
-  @Nullable
+  @NonNull
   @RestrictTo(LIBRARY_GROUP)
-  public StateListShapeAppearanceModel getStateListShapeAppearanceModel() {
+  public ShapeAppearance getShapeAppearance() {
     if (isUsingOriginalBackground()) {
-      return materialButtonHelper.getStateListShapeAppearanceModel();
+      return materialButtonHelper.getShapeAppearance();
     } else {
       throw new IllegalStateException(
-          "Attempted to get StateListShapeAppearanceModel from a MaterialButton which has an"
+          "Attempted to get ShapeAppearance from a MaterialButton which has an"
               + " overwritten background.");
     }
   }

lib/java/com/google/android/material/button/MaterialButtonGroup.java

@@ -56,6 +56,7 @@
 import com.google.android.material.resources.MaterialAttributes;
 import com.google.android.material.shape.AbsoluteCornerSize;
 import com.google.android.material.shape.CornerSize;
+import com.google.android.material.shape.ShapeAppearance;
 import com.google.android.material.shape.ShapeAppearanceModel;
 import com.google.android.material.shape.StateListCornerSize;
 import com.google.android.material.shape.StateListShapeAppearanceModel;
@@ -146,9 +147,7 @@ public class MaterialButtonGroup extends LinearLayout {
 
   private int overflowMode = OVERFLOW_MODE_NONE;
 
-  private final List<ShapeAppearanceModel> originalChildShapeAppearanceModels = new ArrayList<>();
-  private final List<StateListShapeAppearanceModel> originalChildStateListShapeAppearanceModels =
-      new ArrayList<>();
+  private final List<ShapeAppearance> originalChildShapeAppearanceModels = new ArrayList<>();
 
   private final PressedStateTracker pressedStateTracker = new PressedStateTracker();
   private final Comparator<MaterialButton> childOrderComparator =
@@ -319,8 +318,7 @@ public void addView(@NonNull View child, int index, @Nullable ViewGroup.LayoutPa
     buttonChild.setOnPressedChangeListenerInternal(pressedStateTracker);
 
     // Saves original child shape appearance.
-    originalChildShapeAppearanceModels.add(buttonChild.getShapeAppearanceModel());
-    originalChildStateListShapeAppearanceModels.add(buttonChild.getStateListShapeAppearanceModel());
+    originalChildShapeAppearanceModels.add(buttonChild.getShapeAppearance());
 
     // Enable children based on the MaterialButtonToggleGroup own isEnabled
     buttonChild.setEnabled(isEnabled());
@@ -337,7 +335,6 @@ public void onViewRemoved(View child) {
     int indexOfChild = indexOfChild(child);
     if (indexOfChild >= 0) {
       originalChildShapeAppearanceModels.remove(indexOfChild);
-      originalChildStateListShapeAppearanceModels.remove(indexOfChild);
     }
 
     childShapesDirty = true;
@@ -348,6 +345,15 @@ public void onViewRemoved(View child) {
     adjustChildMarginsAndUpdateLayout();
   }
 
+  /**
+   * Returns the original {@link ShapeAppearanceModel} for the {@link MaterialButton} child at the
+   * given index.
+   */
+  @NonNull
+  public ShapeAppearanceModel getChildOriginalShapeAppearanceModel(int index) {
+    return originalChildShapeAppearanceModels.get(index).getDefaultShape();
+  }
+
   private void recoverAllChildrenLayoutParams() {
     for (int i = 0; i < getChildCount(); i++) {
       MaterialButton child = getChildButton(i);
@@ -576,12 +582,9 @@ void updateChildShapes() {
           originalStateListShapeBuilder
               .setCornerSizeOverride(innerCornerSize, cornerPositionBitsToOverride)
               .build();
-      if (newStateListShape.isStateful()) {
-        button.setStateListShapeAppearanceModel(newStateListShape);
-      } else {
-        button.setShapeAppearanceModel(
-            newStateListShape.getDefaultShape(/* withCornerSizeOverrides= */ true));
-      }
+      button.setShapeAppearance(newStateListShape.isStateful()
+          ? newStateListShape
+          : newStateListShape.getDefaultShape(/* withCornerSizeOverrides= */ true));
     }
   }
 
@@ -600,14 +603,15 @@ void updateChildShapes() {
   @NonNull
   private StateListShapeAppearanceModel.Builder getOriginalStateListShapeBuilder(
       boolean isFirstVisible, boolean isLastVisible, int index) {
-    StateListShapeAppearanceModel originalStateList =
+    ShapeAppearance originalStateList =
         groupStateListShapeAppearance != null && (isFirstVisible || isLastVisible)
             ? groupStateListShapeAppearance
-            : originalChildStateListShapeAppearanceModels.get(index);
+            : originalChildShapeAppearanceModels.get(index);
     // If the state list shape is not specified, creates one from the shape appearance model.
-    return originalStateList == null
-        ? new StateListShapeAppearanceModel.Builder(originalChildShapeAppearanceModels.get(index))
-        : originalStateList.toBuilder();
+    return !(originalStateList instanceof StateListShapeAppearanceModel)
+        ? new StateListShapeAppearanceModel.Builder(
+            (ShapeAppearanceModel) originalChildShapeAppearanceModels.get(index))
+        : ((StateListShapeAppearanceModel) originalStateList).toBuilder();
   }
 
   /**

lib/java/com/google/android/material/button/MaterialButtonHelper.java

@@ -42,6 +42,7 @@
 import com.google.android.material.ripple.RippleUtils;
 import com.google.android.material.shape.MaterialShapeDrawable;
 import com.google.android.material.shape.MaterialShapeDrawable.OnCornerSizeChangeListener;
+import com.google.android.material.shape.ShapeAppearance;
 import com.google.android.material.shape.ShapeAppearanceModel;
 import com.google.android.material.shape.Shapeable;
 import com.google.android.material.shape.StateListShapeAppearanceModel;
@@ -51,8 +52,7 @@
 class MaterialButtonHelper {
 
   private final MaterialButton materialButton;
-  @NonNull private ShapeAppearanceModel shapeAppearanceModel;
-  @Nullable private StateListShapeAppearanceModel stateListShapeAppearanceModel;
+  @NonNull private ShapeAppearance shapeAppearance;
   @Nullable private SpringForce cornerSpringForce;
   @Nullable private OnCornerSizeChangeListener onCornerSizeChangeListener;
 
@@ -77,9 +77,9 @@ class MaterialButtonHelper {
   private LayerDrawable rippleDrawable;
   private int elevation;
 
-  MaterialButtonHelper(MaterialButton button, @NonNull ShapeAppearanceModel shapeAppearanceModel) {
+  MaterialButtonHelper(MaterialButton button, @NonNull ShapeAppearance shapeAppearance) {
     materialButton = button;
-    this.shapeAppearanceModel = shapeAppearanceModel;
+    this.shapeAppearance = shapeAppearance;
   }
 
   void loadFromAttributes(@NonNull TypedArray attributes) {
@@ -93,7 +93,7 @@ void loadFromAttributes(@NonNull TypedArray attributes) {
     // cornerRadius should override whatever corner radius is set in shapeAppearanceModel
     if (attributes.hasValue(R.styleable.MaterialButton_cornerRadius)) {
       cornerRadius = attributes.getDimensionPixelSize(R.styleable.MaterialButton_cornerRadius, -1);
-      setShapeAppearanceModel(shapeAppearanceModel.withCornerSize(cornerRadius));
+      setShapeAppearance(shapeAppearance.withCornerSize(cornerRadius));
       cornerRadiusSet = true;
     }
 
@@ -208,10 +208,7 @@ void setShouldDrawSurfaceColorStroke(boolean shouldDrawSurfaceColorStroke) {
    * @return Drawable representing background for this button.
    */
   private Drawable createBackground() {
-    MaterialShapeDrawable backgroundDrawable = new MaterialShapeDrawable(shapeAppearanceModel);
-    if (stateListShapeAppearanceModel != null) {
-      backgroundDrawable.setStateListShapeAppearanceModel(stateListShapeAppearanceModel);
-    }
+    MaterialShapeDrawable backgroundDrawable = new MaterialShapeDrawable(shapeAppearance);
     if (cornerSpringForce != null) {
       backgroundDrawable.setCornerSpringForce(cornerSpringForce);
     }
@@ -226,11 +223,7 @@ private Drawable createBackground() {
     }
     backgroundDrawable.setStroke(strokeWidth, strokeColor);
 
-    MaterialShapeDrawable surfaceColorStrokeDrawable =
-        new MaterialShapeDrawable(shapeAppearanceModel);
-    if (stateListShapeAppearanceModel != null) {
-      surfaceColorStrokeDrawable.setStateListShapeAppearanceModel(stateListShapeAppearanceModel);
-    }
+    MaterialShapeDrawable surfaceColorStrokeDrawable = new MaterialShapeDrawable(shapeAppearance);
     if (cornerSpringForce != null) {
       surfaceColorStrokeDrawable.setCornerSpringForce(cornerSpringForce);
     }
@@ -241,11 +234,7 @@ private Drawable createBackground() {
             ? MaterialColors.getColor(materialButton, R.attr.colorSurface)
             : Color.TRANSPARENT);
 
-    maskDrawable = new MaterialShapeDrawable(shapeAppearanceModel);
-    if (stateListShapeAppearanceModel != null) {
-      ((MaterialShapeDrawable) maskDrawable)
-          .setStateListShapeAppearanceModel(stateListShapeAppearanceModel);
-    }
+    maskDrawable = new MaterialShapeDrawable(shapeAppearance);
     if (cornerSpringForce != null) {
       ((MaterialShapeDrawable) maskDrawable).setCornerSpringForce(cornerSpringForce);
     }
@@ -332,7 +321,7 @@ void setCornerRadius(int cornerRadius) {
       this.cornerRadius = cornerRadius;
       cornerRadiusSet = true;
 
-      setShapeAppearanceModel(shapeAppearanceModel.withCornerSize(cornerRadius));
+      setShapeAppearance(shapeAppearance.withCornerSize(cornerRadius));
     }
   }
 
@@ -402,37 +391,28 @@ private void updateButtonShape() {
     } else {
       MaterialShapeDrawable backgroundDrawable = getMaterialShapeDrawable();
       if (backgroundDrawable != null) {
-        if (stateListShapeAppearanceModel != null) {
-          backgroundDrawable.setStateListShapeAppearanceModel(stateListShapeAppearanceModel);
-        } else {
-          backgroundDrawable.setShapeAppearanceModel(shapeAppearanceModel);
-        }
+        backgroundDrawable.setShapeAppearance(shapeAppearance);
         if (cornerSpringForce != null) {
           backgroundDrawable.setCornerSpringForce(cornerSpringForce);
         }
       }
       MaterialShapeDrawable strokeDrawable = getSurfaceColorStrokeDrawable();
       if (strokeDrawable != null) {
-        if (stateListShapeAppearanceModel != null) {
-          strokeDrawable.setStateListShapeAppearanceModel(stateListShapeAppearanceModel);
-        } else {
-          strokeDrawable.setShapeAppearanceModel(shapeAppearanceModel);
-        }
+        strokeDrawable.setShapeAppearance(shapeAppearance);
         if (cornerSpringForce != null) {
           strokeDrawable.setCornerSpringForce(cornerSpringForce);
         }
       }
       Shapeable animatedShapeable = getMaskDrawable();
       if (animatedShapeable != null) {
-        animatedShapeable.setShapeAppearanceModel(shapeAppearanceModel);
         if (animatedShapeable instanceof MaterialShapeDrawable) {
           MaterialShapeDrawable maskDrawable = (MaterialShapeDrawable) animatedShapeable;
-          if (stateListShapeAppearanceModel != null) {
-            maskDrawable.setStateListShapeAppearanceModel(stateListShapeAppearanceModel);
-          }
+          maskDrawable.setShapeAppearance(shapeAppearance);
           if (cornerSpringForce != null) {
             maskDrawable.setCornerSpringForce(cornerSpringForce);
           }
+        } else {
+          animatedShapeable.setShapeAppearanceModel(shapeAppearance.getDefaultShape());
         }
       }
     }
@@ -455,7 +435,7 @@ public Shapeable getMaskDrawable() {
   void setCornerSpringForce(@NonNull SpringForce springForce) {
     this.cornerSpringForce = springForce;
     // We don't want to set unused spring objects.
-    if (stateListShapeAppearanceModel != null) {
+    if (shapeAppearance instanceof StateListShapeAppearanceModel) {
       updateButtonShape();
     }
   }
@@ -465,26 +445,19 @@ SpringForce getCornerSpringForce() {
     return this.cornerSpringForce;
   }
 
-  void setStateListShapeAppearanceModel(
-      @NonNull StateListShapeAppearanceModel stateListShapeAppearanceModel) {
-    this.stateListShapeAppearanceModel = stateListShapeAppearanceModel;
+  void setShapeAppearance(@NonNull ShapeAppearance shapeAppearanceModel) {
+    this.shapeAppearance = shapeAppearanceModel;
     updateButtonShape();
   }
 
-  @Nullable
-  StateListShapeAppearanceModel getStateListShapeAppearanceModel() {
-    return this.stateListShapeAppearanceModel;
-  }
-
-  void setShapeAppearanceModel(@NonNull ShapeAppearanceModel shapeAppearanceModel) {
-    this.shapeAppearanceModel = shapeAppearanceModel;
-    this.stateListShapeAppearanceModel = null;
-    updateButtonShape();
+  @NonNull
+  ShapeAppearance getShapeAppearance() {
+    return shapeAppearance;
   }
 
   @NonNull
   ShapeAppearanceModel getShapeAppearanceModel() {
-    return this.shapeAppearanceModel;
+    return shapeAppearance.getDefaultShape();
   }
 
   public void setInsetBottom(@Dimension int newInsetBottom) {

lib/java/com/google/android/material/ripple/RippleDrawableCompat.java

@@ -99,7 +99,7 @@ public ShapeAppearanceModel getShapeAppearanceModel() {
 
   public void setStateListShapeAppearanceModel(
       @NonNull StateListShapeAppearanceModel stateListShapeAppearanceModel) {
-    drawableState.delegate.setStateListShapeAppearanceModel(stateListShapeAppearanceModel);
+    drawableState.delegate.setShapeAppearance(stateListShapeAppearanceModel);
   }
 
   @Nullable