[Badge] Support differing offsets for badges with/without text, support badge width and padding in styles.

PiperOrigin-RevId: 372538097

Author: hunterstich

lib/java/com/google/android/material/badge/BadgeDrawable.java

@@ -47,6 +47,7 @@
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import androidx.annotation.PluralsRes;
+import androidx.annotation.Px;
 import androidx.annotation.RestrictTo;
 import androidx.annotation.StringRes;
 import androidx.annotation.StyleRes;
@@ -175,9 +176,9 @@ public class BadgeDrawable extends Drawable implements TextDrawableDelegate {
   @NonNull private final MaterialShapeDrawable shapeDrawable;
   @NonNull private final TextDrawableHelper textDrawableHelper;
   @NonNull private final Rect badgeBounds;
-  private final float badgeRadius;
-  private final float badgeWithTextRadius;
-  private final float badgeWidePadding;
+  private float badgeRadius;
+  private float badgeWithTextRadius;
+  private float badgeWidePadding;
   @NonNull private final SavedState savedState;
 
   private float badgeCenterX;
@@ -216,6 +217,12 @@ public static final class SavedState implements Parcelable {
     @Dimension(unit = Dimension.PX)
     private int verticalOffset;
 
+    @Dimension(unit = Dimension.PX)
+    private int horizontalOffsetWithText;
+
+    @Dimension(unit = Dimension.PX)
+    private int verticalOffsetWithText;
+
     @Dimension(unit = Dimension.PX)
     private int additionalHorizontalOffset;
 
@@ -247,6 +254,8 @@ protected SavedState(@NonNull Parcel in) {
       badgeGravity = in.readInt();
       horizontalOffset = in.readInt();
       verticalOffset = in.readInt();
+      horizontalOffsetWithText = in.readInt();
+      verticalOffsetWithText = in.readInt();
       additionalHorizontalOffset = in.readInt();
       additionalVerticalOffset = in.readInt();
       isVisible = in.readInt() != 0;
@@ -284,6 +293,8 @@ public void writeToParcel(@NonNull Parcel dest, int flags) {
       dest.writeInt(badgeGravity);
       dest.writeInt(horizontalOffset);
       dest.writeInt(verticalOffset);
+      dest.writeInt(horizontalOffsetWithText);
+      dest.writeInt(verticalOffsetWithText);
       dest.writeInt(additionalHorizontalOffset);
       dest.writeInt(additionalVerticalOffset);
       dest.writeInt(isVisible ? 1 : 0);
@@ -379,6 +390,9 @@ private void restoreFromSavedState(@NonNull SavedState savedState) {
     setHorizontalOffset(savedState.horizontalOffset);
     setVerticalOffset(savedState.verticalOffset);
 
+    setHorizontalOffsetWithText(savedState.horizontalOffsetWithText);
+    setVerticalOffsetWithText(savedState.verticalOffsetWithText);
+
     setAdditionalHorizontalOffset(savedState.additionalHorizontalOffset);
     setAdditionalVerticalOffset(savedState.additionalVerticalOffset);
 
@@ -414,6 +428,25 @@ private void loadDefaultStateFromAttributes(
     setHorizontalOffset(a.getDimensionPixelOffset(R.styleable.Badge_horizontalOffset, 0));
     setVerticalOffset(a.getDimensionPixelOffset(R.styleable.Badge_verticalOffset, 0));
 
+    // Set the offsets when the badge has text. Default to using the badge "dot" offsets
+    // (horizontalOffset and verticalOffset) if there is no offsets defined for badges with text.
+    setHorizontalOffsetWithText(
+        a.getDimensionPixelOffset(
+            R.styleable.Badge_horizontalOffsetWithText, getHorizontalOffset()));
+    setVerticalOffsetWithText(
+        a.getDimensionPixelOffset(R.styleable.Badge_verticalOffsetWithText, getVerticalOffset()));
+
+    if (a.hasValue(R.styleable.Badge_badgeRadius)) {
+      badgeRadius = a.getDimension(R.styleable.Badge_badgeRadius, badgeRadius);
+    }
+    if (a.hasValue(R.styleable.Badge_badgeWidePadding)) {
+      badgeWidePadding = a.getDimension(R.styleable.Badge_badgeWidePadding, badgeWidePadding);
+    }
+    if (a.hasValue(R.styleable.Badge_badgeWithTextRadius)) {
+      badgeWithTextRadius =
+          a.getDimension(R.styleable.Badge_badgeWithTextRadius, badgeWithTextRadius);
+    }
+
     a.recycle();
   }
 
@@ -827,6 +860,26 @@ public int getHorizontalOffset() {
     return savedState.horizontalOffset;
   }
 
+  /**
+   * Sets how much (in pixels) to horizontally move this badge towards the center of its anchor
+   * when this badge has text.
+   *
+   * @param px badge's horizontal offset when the badge has text.
+   */
+  public void setHorizontalOffsetWithText(@Px int px) {
+    savedState.horizontalOffsetWithText = px;
+    updateCenterAndBounds();
+  }
+
+  /**
+   * Returns how much (in pixels) this badge is being horizontally offset towards the center of its
+   * anchor when this badge has text.
+   */
+  @Px
+  public int getHorizontalOffsetWithText() {
+    return savedState.horizontalOffsetWithText;
+  }
+
   /**
    * Sets how much (in pixels) more (in addition to {@code savedState.horizontalOffset}) to
    * horizontally move this badge towards the center of its anchor. Currently used to adjust the
@@ -859,6 +912,26 @@ public int getVerticalOffset() {
     return savedState.verticalOffset;
   }
 
+  /**
+   * Sets how much (in pixels) to vertically move this badge towards the center of its anchor when
+   * this badge has text.
+   *
+   * @param px badge's vertical offset when the badge has text.
+   */
+  public void setVerticalOffsetWithText(@Px int px) {
+    savedState.verticalOffsetWithText = px;
+    updateCenterAndBounds();
+  }
+
+  /**
+   * Returns how much (in pixels) this badge is being vertically moved towards the center of its
+   * anchor when the badge has text.
+   */
+  @Px
+  public int getVerticalOffsetWithText() {
+    return savedState.verticalOffsetWithText;
+  }
+
   /**
    * Sets how much (in pixels) more (in addition to {@code savedState.verticalOffset}) to vertically
    * move this badge towards the center of its anchor. Currently used to adjust the placement of
@@ -924,9 +997,19 @@ private void updateCenterAndBounds() {
     }
   }
 
+  private int getTotalVerticalOffsetForState() {
+    int vOffset = hasNumber() ? savedState.verticalOffsetWithText : savedState.verticalOffset;
+    return vOffset + savedState.additionalVerticalOffset;
+  }
+
+  private int getTotalHorizontalOffsetForState() {
+    int hOffset = hasNumber() ? savedState.horizontalOffsetWithText : savedState.horizontalOffset;
+    return hOffset + savedState.additionalHorizontalOffset;
+  }
+
   private void calculateCenterAndBounds(
       @NonNull Context context, @NonNull Rect anchorRect, @NonNull View anchorView) {
-    int totalVerticalOffset = savedState.verticalOffset + savedState.additionalVerticalOffset;
+    int totalVerticalOffset = getTotalVerticalOffsetForState();
     switch (savedState.badgeGravity) {
       case BOTTOM_END:
       case BOTTOM_START:
@@ -958,7 +1041,7 @@ private void calculateCenterAndBounds(
                     ? R.dimen.mtrl_badge_text_horizontal_edge_offset
                     : R.dimen.mtrl_badge_horizontal_edge_offset);
 
-    int totalHorizontalOffset = savedState.horizontalOffset + savedState.additionalHorizontalOffset;
+    int totalHorizontalOffset = getTotalHorizontalOffsetForState();
 
     // Update the centerX based on the badge width and 'inset' from start or end boundary of anchor.
     switch (savedState.badgeGravity) {

lib/java/com/google/android/material/badge/res/values/attrs.xml

@@ -21,6 +21,12 @@
   <attr name="badgeStyle" format="reference"/>
 
   <declare-styleable name="Badge">
+    <!-- The radius of a badge without text (a "dot"). -->
+    <attr name="badgeRadius" format="dimension"/>
+    <!-- Start and end padding for a badge that is oblong due to long text. -->
+    <attr name="badgeWidePadding" format="dimension"/>
+    <!-- Radius of a badge with text. -->
+    <attr name="badgeWithTextRadius" format="dimension"/>
     <attr name="backgroundColor" format="color"/>
     <attr name="badgeTextColor" format="color"/>
     <attr name="maxCharacterCount" format="integer"/>
@@ -36,9 +42,20 @@
       <enum name="BOTTOM_START" value ="8388691"/>
     </attr>
 
-    <!-- Offset moves the badge towards the center of its anchor. -->
+    <!-- Offsets the badge horizontally towards the center of its anchor when
+        the badge doesn't have text (is a "dot"). Defaults to 0. -->
     <attr name="horizontalOffset" format="dimension"/>
+    <!-- Offsets the badge vertically towards the center of its anchor when the
+         badge doesn't have text (is a "dot"). Defaults to 0. -->
     <attr name="verticalOffset" format="dimension"/>
+    <!-- Offsets the badge horizontally towards the center of its anchor when
+         the badge has text. If this is not defined, it will default to
+         horizontalOffset's value. -->
+    <attr name="horizontalOffsetWithText" format="dimension"/>
+    <!-- Offsets the badge vertically towards the center of its anchor when the
+         badge has text. If this is not defined, it will default to
+         verticalOffset's value. -->
+    <attr name="verticalOffsetWithText" format="dimension"/>
   </declare-styleable>
 
 </resources>

lib/java/com/google/android/material/badge/res/values/styles.xml

@@ -17,6 +17,9 @@
 <resources xmlns:tools="http://schemas.android.com/tools" tools:ignore="NewApi">
 
   <style name="Widget.MaterialComponents.Badge" parent="android:Widget">
+    <item name="badgeRadius">@dimen/mtrl_badge_radius</item>
+    <item name="badgeWidePadding">@dimen/mtrl_badge_long_text_horizontal_padding</item>
+    <item name="badgeWithTextRadius">@dimen/mtrl_badge_with_text_radius</item>
     <item name="backgroundColor">?attr/colorError</item>
     <item name="maxCharacterCount">@integer/mtrl_badge_max_character_count</item>
     <item name="badgeGravity">TOP_END</item>