Save badge states in BottomNavigationMenuView.

PiperOrigin-RevId: 245446090

Author: wcshi

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

@@ -16,12 +16,17 @@
 
 package com.google.android.material.badge;
 
+import android.content.Context;
 import android.graphics.Rect;
 import android.os.Build.VERSION;
 import android.os.Build.VERSION_CODES;
+import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import androidx.annotation.RestrictTo;
 import androidx.annotation.RestrictTo.Scope;
+import com.google.android.material.badge.BadgeDrawable.SavedState;
+import com.google.android.material.internal.ParcelableSparseArray;
+import android.util.SparseArray;
 import android.view.View;
 import android.widget.FrameLayout;
 
@@ -105,4 +110,52 @@ public static void setBadgeDrawableBounds(
     badgeDrawable.setBounds(badgeBounds);
     badgeDrawable.updateBadgeCoordinates(anchor, preApi18BadgeParent);
   }
+
+  /**
+   * Given a map of int keys to {@code BadgeDrawable BadgeDrawables}, creates a parcelable map of
+   * unique int keys to {@code BadgeDrawable.SavedState SavedStates}. Useful for state restoration.
+   *
+   * @param badgeDrawables A {@link SparseArray} that contains a map of int keys (e.g. menuItemId)
+   *     to {@code BadgeDrawable BadgeDrawables}.
+   * @return A parcelable {@link SparseArray} that contains a map of int keys (e.g. menuItemId) to
+   *     {@code BadgeDrawable.SavedState SavedStates}.
+   */
+  public static ParcelableSparseArray createParcelableBadgeStates(
+      SparseArray<BadgeDrawable> badgeDrawables) {
+    ParcelableSparseArray badgeStates = new ParcelableSparseArray();
+    for (int i = 0; i < badgeDrawables.size(); i++) {
+      int key = badgeDrawables.keyAt(i);
+      BadgeDrawable badgeDrawable = badgeDrawables.valueAt(i);
+      if (badgeDrawable == null) {
+        throw new IllegalArgumentException("badgeDrawable cannot be null");
+      }
+      badgeStates.put(key, badgeDrawable.getSavedState());
+    }
+    return badgeStates;
+  }
+
+  /**
+   * Given a map of int keys to {@link BadgeDrawable.SavedState SavedStates}, creates a parcelable
+   * map of int keys to {@link BadgeDrawable BadgeDrawbles}. Useful for state restoration.
+   *
+   * @param context Current context
+   * @param badgeStates A parcelable {@link SparseArray} that contains a map of int keys (e.g.
+   *     menuItemId) to {@link BadgeDrawable.SavedState states}.
+   * @return A {@link SparseArray} that contains a map of int keys (e.g. menuItemId) to {@code
+   *     BadgeDrawable BadgeDrawbles}.
+   */
+  public static SparseArray<BadgeDrawable> createBadgeDrawablesFromSavedStates(
+      Context context, @NonNull ParcelableSparseArray badgeStates) {
+    SparseArray<BadgeDrawable> badgeDrawables = new SparseArray<>(badgeStates.size());
+    for (int i = 0; i < badgeStates.size(); i++) {
+      int key = badgeStates.keyAt(i);
+      BadgeDrawable.SavedState savedState = (SavedState) badgeStates.valueAt(i);
+      if (savedState == null) {
+        throw new IllegalArgumentException("BadgeDrawable's savedState cannot be null");
+      }
+      BadgeDrawable badgeDrawable = BadgeDrawable.createFromSavedState(context, savedState);
+      badgeDrawables.put(key, badgeDrawable);
+    }
+    return badgeDrawables;
+  }
 }

lib/java/com/google/android/material/bottomnavigation/BottomNavigationMenuView.java

@@ -25,6 +25,7 @@
 import android.content.res.Resources;
 import android.graphics.drawable.Drawable;
 import androidx.annotation.Dimension;
+import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import androidx.annotation.RestrictTo;
 import androidx.annotation.StyleRes;
@@ -67,7 +68,6 @@ public class BottomNavigationMenuView extends ViewGroup implements MenuView {
   private final OnClickListener onClickListener;
   private final Pools.Pool<BottomNavigationItemView> itemPool =
       new Pools.SynchronizedPool<>(ITEM_POOL_SIZE);
-  private final SparseArray<BadgeDrawable> badgeDrawables = new SparseArray<>(ITEM_POOL_SIZE);
 
   private boolean itemHorizontalTranslationEnabled;
   @LabelVisibilityMode private int labelVisibilityMode;
@@ -85,6 +85,7 @@ public class BottomNavigationMenuView extends ViewGroup implements MenuView {
   private Drawable itemBackground;
   private int itemBackgroundRes;
   private int[] tempChildWidths;
+  @NonNull private SparseArray<BadgeDrawable> badgeDrawables = new SparseArray<>(ITEM_POOL_SIZE);
 
   private BottomNavigationPresenter presenter;
   private MenuBuilder menu;
@@ -611,6 +612,14 @@ void tryRestoreSelectedItemId(int itemId) {
     }
   }
 
+  SparseArray<BadgeDrawable> getBadgeDrawables() {
+    return badgeDrawables;
+  }
+
+  void setBadgeDrawables(SparseArray<BadgeDrawable> badgeDrawables) {
+    this.badgeDrawables = badgeDrawables;
+  }
+
   @Nullable
   BadgeDrawable getBadge(int menuItemId) {
     return badgeDrawables.get(menuItemId);

lib/java/com/google/android/material/bottomnavigation/BottomNavigationPresenter.java

@@ -23,11 +23,15 @@
 import android.os.Parcelable;
 import androidx.annotation.NonNull;
 import androidx.annotation.RestrictTo;
+import com.google.android.material.badge.BadgeDrawable;
+import com.google.android.material.badge.BadgeUtils;
+import com.google.android.material.internal.ParcelableSparseArray;
 import androidx.appcompat.view.menu.MenuBuilder;
 import androidx.appcompat.view.menu.MenuItemImpl;
 import androidx.appcompat.view.menu.MenuPresenter;
 import androidx.appcompat.view.menu.MenuView;
 import androidx.appcompat.view.menu.SubMenuBuilder;
+import android.util.SparseArray;
 import android.view.ViewGroup;
 
 /** @hide */
@@ -104,13 +108,19 @@ public int getId() {
   public Parcelable onSaveInstanceState() {
     SavedState savedState = new SavedState();
     savedState.selectedItemId = menuView.getSelectedItemId();
+    savedState.badgeSavedStates =
+        BadgeUtils.createParcelableBadgeStates(menuView.getBadgeDrawables());
     return savedState;
   }
 
   @Override
   public void onRestoreInstanceState(Parcelable state) {
     if (state instanceof SavedState) {
       menuView.tryRestoreSelectedItemId(((SavedState) state).selectedItemId);
+      SparseArray<BadgeDrawable> badgeDrawables =
+          BadgeUtils.createBadgeDrawablesFromSavedStates(
+              menuView.getContext(), ((SavedState) state).badgeSavedStates);
+      menuView.setBadgeDrawables(badgeDrawables);
     }
   }
 
@@ -120,11 +130,13 @@ public void setUpdateSuspended(boolean updateSuspended) {
 
   static class SavedState implements Parcelable {
     int selectedItemId;
+    ParcelableSparseArray badgeSavedStates;
 
     SavedState() {}
 
     SavedState(Parcel in) {
       selectedItemId = in.readInt();
+      badgeSavedStates = in.readParcelable(getClass().getClassLoader());
     }
 
     @Override
@@ -135,6 +147,7 @@ public int describeContents() {
     @Override
     public void writeToParcel(@NonNull Parcel out, int flags) {
       out.writeInt(selectedItemId);
+      out.writeParcelable(badgeSavedStates, /* parcelableFlags= */ 0);
     }
 
     public static final Creator<SavedState> CREATOR =

tests/javatests/com/google/android/material/bottomnavigation/BottomNavigationViewTest.java

@@ -20,6 +20,7 @@
 import static com.google.android.material.testutils.BottomNavigationViewActions.setIconSize;
 import static com.google.android.material.testutils.BottomNavigationViewActions.setItemIconTintList;
 import static com.google.android.material.testutils.BottomNavigationViewActions.setLabelVisibilityMode;
+import static com.google.android.material.testutils.BottomNavigationViewActions.showBadgeNumberForMenuItem;
 import static androidx.test.espresso.Espresso.onView;
 import static androidx.test.espresso.action.ViewActions.click;
 import static androidx.test.espresso.assertion.ViewAssertions.matches;
@@ -87,6 +88,7 @@ public class BottomNavigationViewTest {
   @Before
   public void setUp() throws Exception {
     final BottomNavigationViewActivity activity = activityTestRule.getActivity();
+    activity.setTheme(R.style.Theme_MaterialComponents_Light);
     bottomNavigation = activity.findViewById(R.id.bottom_navigation);
 
     final Resources res = activity.getResources();
@@ -629,6 +631,9 @@ public void testSavedState() throws Throwable {
                 isDescendantOfA(withId(R.id.bottom_navigation)),
                 isDisplayed()))
         .perform(click());
+    // Show badge number on the first bottom navigation item view.
+    onView(withId(R.id.bottom_navigation))
+        .perform(showBadgeNumberForMenuItem(R.id.destination_home, 75));
     assertTrue(bottomNavigation.getMenu().findItem(R.id.destination_profile).isChecked());
     // Save the state
     final Parcelable state = bottomNavigation.onSaveInstanceState();
@@ -643,6 +648,9 @@ public void run() {
             testView.inflateMenu(R.menu.bottom_navigation_view_content);
             testView.onRestoreInstanceState(state);
             assertTrue(testView.getMenu().findItem(R.id.destination_profile).isChecked());
+            assertTrue(testView.getBadge(R.id.destination_home).isVisible());
+            assertEquals(75, testView.getBadge(R.id.destination_home).getNumber());
+            assertEquals(4, testView.getBadge(R.id.destination_home).getMaxCharacterCount());
           }
         });
   }

tests/javatests/com/google/android/material/testutils/BottomNavigationViewActions.java

@@ -73,6 +73,28 @@ public void perform(UiController uiController, View view) {
     };
   }
 
+  /** Sets and show badge number for the menu item of the navigation view. */
+  public static ViewAction showBadgeNumberForMenuItem(
+      @IdRes final int menuItemId, final int badgeNumber) {
+    return new ViewAction() {
+      @Override
+      public Matcher<View> getConstraints() {
+        return isDisplayed();
+      }
+
+      @Override
+      public String getDescription() {
+        return "Set menu item badge number";
+      }
+
+      @Override
+      public void perform(UiController uiController, View view) {
+        BottomNavigationView navigationView = (BottomNavigationView) view;
+        navigationView.showBadge(menuItemId).setNumber(badgeNumber);
+      }
+    };
+  }
+
   /** Add a navigation item to the bottom navigation view. */
   public static ViewAction addMenuItem(final String title) {
     return new ViewAction() {