[BadgeDrawable] add horizontal and vertical offset to control position

Resolves #638
Resolves #630

Co-authored-by:wcshi <[email protected]>

GIT_ORIGIN_REV_ID=511c955a11e05fdc0848c74938c4c194da22826e
PiperOrigin-RevId: 275522709

Author: Chaoyang0201

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

@@ -35,6 +35,7 @@
 import android.os.Parcelable;
 import androidx.annotation.AttrRes;
 import androidx.annotation.ColorInt;
+import androidx.annotation.Dimension;
 import androidx.annotation.IntDef;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
@@ -187,6 +188,12 @@ public static final class SavedState implements Parcelable {
     @PluralsRes private int contentDescriptionQuantityStrings;
     @BadgeGravity private int badgeGravity;
 
+    @Dimension(unit = Dimension.PX)
+    private int horizontalOffset;
+
+    @Dimension(unit = Dimension.PX)
+    private int verticalOffset;
+
     public SavedState(@NonNull Context context) {
       // If the badge text color attribute was not explicitly set, use the text color specified in
       // the TextAppearance.
@@ -207,6 +214,8 @@ protected SavedState(@NonNull Parcel in) {
       contentDescriptionNumberless = in.readString();
       contentDescriptionQuantityStrings = in.readInt();
       badgeGravity = in.readInt();
+      horizontalOffset = in.readInt();
+      verticalOffset = in.readInt();
     }
 
     public static final Creator<SavedState> CREATOR =
@@ -239,6 +248,8 @@ public void writeToParcel(@NonNull Parcel dest, int flags) {
       dest.writeString(contentDescriptionNumberless.toString());
       dest.writeInt(contentDescriptionQuantityStrings);
       dest.writeInt(badgeGravity);
+      dest.writeInt(horizontalOffset);
+      dest.writeInt(verticalOffset);
     }
   }
 
@@ -321,6 +332,9 @@ private void restoreFromSavedState(@NonNull SavedState savedState) {
     setBadgeTextColor(savedState.badgeTextColor);
 
     setBadgeGravity(savedState.badgeGravity);
+
+    setHorizontalOffset(savedState.horizontalOffset);
+    setVerticalOffset(savedState.verticalOffset);
   }
 
   private void loadDefaultStateFromAttributes(
@@ -348,6 +362,10 @@ private void loadDefaultStateFromAttributes(
     }
 
     setBadgeGravity(a.getInt(R.styleable.Badge_badgeGravity, TOP_END));
+
+    setHorizontalOffset(a.getDimensionPixelOffset(R.styleable.Badge_horizontalOffset, 0));
+    setVerticalOffset(a.getDimensionPixelOffset(R.styleable.Badge_verticalOffset, 0));
+
     a.recycle();
   }
 
@@ -631,6 +649,42 @@ public CharSequence getContentDescription() {
     }
   }
 
+  /**
+   * Sets how much (in pixels) to horizontally move this badge towards the center of its anchor.
+   *
+   * @param px badge's horizontal offset
+   */
+  public void setHorizontalOffset(int px) {
+    savedState.horizontalOffset = px;
+    updateCenterAndBounds();
+  }
+
+  /**
+   * Returns how much (in pixels) this badge is being horizontally offset towards the center of its
+   * anchor.
+   */
+  public int getHorizontalOffset() {
+    return savedState.horizontalOffset;
+  }
+
+  /**
+   * Sets how much (in pixels) to vertically move this badge towards the center of its anchor.
+   *
+   * @param px badge's vertical offset
+   */
+  public void setVerticalOffset(int px) {
+    savedState.verticalOffset = px;
+    updateCenterAndBounds();
+  }
+
+  /**
+   * Returns how much (in pixels) this badge is being vertically moved towards the center of its
+   * anchor.
+   */
+  public int getVerticalOffset() {
+    return savedState.verticalOffset;
+  }
+
   private void setTextAppearanceResource(@StyleRes int id) {
     Context context = contextRef.get();
     if (context == null) {
@@ -687,12 +741,12 @@ private void calculateCenterAndBounds(
     switch (savedState.badgeGravity) {
       case BOTTOM_END:
       case BOTTOM_START:
-        badgeCenterY = anchorRect.bottom;
+        badgeCenterY = anchorRect.bottom - savedState.verticalOffset;
         break;
       case TOP_END:
       case TOP_START:
       default:
-        badgeCenterY = anchorRect.top;
+        badgeCenterY = anchorRect.top + savedState.verticalOffset;
         break;
     }
 
@@ -720,16 +774,16 @@ private void calculateCenterAndBounds(
       case TOP_START:
         badgeCenterX =
             ViewCompat.getLayoutDirection(anchorView) == View.LAYOUT_DIRECTION_LTR
-                ? anchorRect.left - halfBadgeWidth + inset
-                : anchorRect.right + halfBadgeWidth - inset;
+                ? anchorRect.left - halfBadgeWidth + inset + savedState.horizontalOffset
+                : anchorRect.right + halfBadgeWidth - inset - savedState.horizontalOffset;
         break;
       case BOTTOM_END:
       case TOP_END:
       default:
         badgeCenterX =
             ViewCompat.getLayoutDirection(anchorView) == View.LAYOUT_DIRECTION_LTR
-                ? anchorRect.right + halfBadgeWidth - inset
-                : anchorRect.left - halfBadgeWidth + inset;
+                ? anchorRect.right + halfBadgeWidth - inset - savedState.horizontalOffset
+                : anchorRect.left - halfBadgeWidth + inset + savedState.horizontalOffset;
         break;
     }
   }

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

@@ -21,5 +21,7 @@
   <public name="maxCharacterCount" type="attr"/>
   <public name="number" type="attr"/>
   <public name="badgeGravity" type="attr"/>
+  <public name="horizontalOffset" type="attr"/>
+  <public name="verticalOffset" type="attr"/>
   <public name="Widget.MaterialComponents.Badge" type="style"/>
 </resources>

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

@@ -35,6 +35,10 @@
       <!-- Gravity.BOTTOM | Gravity.START -->
       <enum name="BOTTOM_START" value ="8388691"/>
     </attr>
+
+    <!-- Offset moves the badge towards the center of its anchor. -->
+    <attr name="horizontalOffset" format="dimension"/>
+    <attr name="verticalOffset" format="dimension"/>
   </declare-styleable>
 
 </resources>

lib/javatests/com/google/android/material/badge/BadgeDrawableTest.java

@@ -26,6 +26,7 @@
 import androidx.annotation.XmlRes;
 import androidx.core.content.res.ResourcesCompat;
 import android.util.AttributeSet;
+import android.util.TypedValue;
 import android.view.Gravity;
 import androidx.test.core.app.ApplicationProvider;
 import com.google.android.material.badge.BadgeDrawable.SavedState;
@@ -34,6 +35,7 @@
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.robolectric.RobolectricTestRunner;
+import org.robolectric.annotation.Config;
 import org.robolectric.annotation.internal.DoNotInstrument;
 
 /** Test for {@link BadgeDrawable} */
@@ -43,6 +45,9 @@ public class BadgeDrawableTest {
 
   private static final int TEST_BADGE_NUMBER = 26;
 
+  private static final int TEST_BADGE_HORIZONTAL_OFFSET = 10;
+  private static final int TEST_BADGE_VERTICAL_OFFSET = 5;
+
   private final Context context = ApplicationProvider.getApplicationContext();
 
   @Before
@@ -62,6 +67,9 @@ public void testSavedState() {
     badgeDrawable.setNumber(TEST_BADGE_NUMBER);
     badgeDrawable.setBadgeGravity(BadgeDrawable.TOP_START);
 
+    badgeDrawable.setHorizontalOffset(TEST_BADGE_HORIZONTAL_OFFSET);
+    badgeDrawable.setVerticalOffset(TEST_BADGE_VERTICAL_OFFSET);
+
     badgeDrawable.setBackgroundColor(testBackgroundColor);
     badgeDrawable.setBadgeTextColor(testBadgeTextColor);
 
@@ -79,6 +87,9 @@ public void testSavedState() {
     assertThat(restoredBadgeDrawable.getAlpha()).isEqualTo(255);
     assertThat(restoredBadgeDrawable.getMaxCharacterCount()).isEqualTo(4);
     assertThat(restoredBadgeDrawable.getBadgeGravity()).isEqualTo(BadgeDrawable.TOP_START);
+    // badge offsets
+    assertThat(restoredBadgeDrawable.getHorizontalOffset()).isEqualTo(TEST_BADGE_HORIZONTAL_OFFSET);
+    assertThat(restoredBadgeDrawable.getVerticalOffset()).isEqualTo(TEST_BADGE_VERTICAL_OFFSET);
   }
 
   // Verify that the hardcoded badge gravity attribute values match their piped Gravity counter
@@ -106,16 +117,24 @@ public void testBadgeGravityAttributeValue_bottomStart() {
         R.xml.standalone_badge_gravity_bottom_start, Gravity.BOTTOM | Gravity.START);
   }
 
+  @Test
+  @Config(qualifiers = "w360dp-h640dp-xhdpi")
+  public void testHorizontalOffset() {
+    BadgeDrawable badgeDrawable =
+        BadgeDrawable.createFromResource(context, R.xml.standalone_badge_offset);
+    assertThat(badgeDrawable.getHorizontalOffset()).isEqualTo(dpToPx(TEST_BADGE_HORIZONTAL_OFFSET));
+  }
+
+  @Test
+  @Config(qualifiers = "w360dp-h640dp-xhdpi")
+  public void testVerticalOffset() {
+    BadgeDrawable badgeDrawable =
+        BadgeDrawable.createFromResource(context, R.xml.standalone_badge_offset);
+    assertThat(badgeDrawable.getVerticalOffset()).isEqualTo(dpToPx(TEST_BADGE_VERTICAL_OFFSET));
+  }
+
   private void testBadgeGravityValueHelper(@XmlRes int xmlId, int expectedValue) {
-    AttributeSet attrs = DrawableUtils.parseDrawableXml(context, xmlId, "badge");
-    @StyleRes int style = attrs.getStyleAttribute();
-    if (style == 0) {
-      style = R.style.Widget_MaterialComponents_Badge;
-    }
-    TypedArray a =
-        context
-            .getTheme()
-            .obtainStyledAttributes(attrs, R.styleable.Badge, R.attr.badgeStyle, style);
+    TypedArray a = getTypedArray(xmlId);
 
     int value = 0;
     if (a.hasValue(R.styleable.Badge_badgeGravity)) {
@@ -124,4 +143,21 @@ private void testBadgeGravityValueHelper(@XmlRes int xmlId, int expectedValue) {
     assertThat(value).isEqualTo(expectedValue);
     a.recycle();
   }
+
+  private TypedArray getTypedArray(@XmlRes int xmlId) {
+    AttributeSet attrs = DrawableUtils.parseDrawableXml(context, xmlId, "badge");
+    @StyleRes int style = attrs.getStyleAttribute();
+    if (style == 0) {
+      style = R.style.Widget_MaterialComponents_Badge;
+    }
+    return context
+        .getTheme()
+        .obtainStyledAttributes(attrs, R.styleable.Badge, R.attr.badgeStyle, style);
+  }
+
+  private int dpToPx(float dp) {
+    return (int)
+        TypedValue.applyDimension(
+            TypedValue.COMPLEX_UNIT_DIP, dp, context.getResources().getDisplayMetrics());
+  }
 }

lib/javatests/com/google/android/material/badge/res/xml/standalone_badge_offset.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+  Copyright 2019 The Android Open Source Project
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      https://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+  -->
+
+<badge
+  xmlns:app="http://schemas.android.com/apk/res-auto"
+  app:maxCharacterCount="2"
+  app:horizontalOffset="10dp"
+  app:verticalOffset="5dp"/>