Delete shifting mode in favor of label visibility mode.

PiperOrigin-RevId: 182431135

Author: afohrman

lib/java/android/support/design/bottomnavigation/LabelVisibilityMode.java

@@ -29,23 +29,23 @@
  * LabelVisibilityMode#LABEL_VISIBILITY_LABELED} sets the label to always show, and {@link
  * LabelVisibilityMode#LABEL_VISIBILITY_UNLABELED} sets the label to never show.
  *
- * <p>Setting the label visibility mode to {@link LabelVisibilityMode#LABEL_VISIBILITY_LEGACY} sets
- * the label to behave as it used to with {@link ShiftingMode}.
+ * <p>Setting the label visibility mode to {@link LabelVisibilityMode#LABEL_VISIBILITY_AUTO} sets
+ * the label to behave as "labeled" when there are 3 items or less, or "selected" when there are 4
+ * items or more.
  */
 @IntDef({
-  LabelVisibilityMode.LABEL_VISIBILITY_LEGACY,
+  LabelVisibilityMode.LABEL_VISIBILITY_AUTO,
   LabelVisibilityMode.LABEL_VISIBILITY_SELECTED,
   LabelVisibilityMode.LABEL_VISIBILITY_LABELED,
   LabelVisibilityMode.LABEL_VISIBILITY_UNLABELED
 })
 @Retention(RetentionPolicy.SOURCE)
 public @interface LabelVisibilityMode {
   /**
-   * Label is shown when {@link ShiftingMode} is enabled, or hidden when it is not.
-   *
-   * @deprecated Use an explicit {@link LabelVisibilityMode}s instead.
+   * Label behaves as "labeled" when there are 3 items or less, or "selected" when there are 4 items
+   * or more.
    */
-  @Deprecated int LABEL_VISIBILITY_LEGACY = -1;
+  int LABEL_VISIBILITY_AUTO = -1;
 
   /** Label is shown on the selected navigation item. */
   int LABEL_VISIBILITY_SELECTED = 0;

lib/java/android/support/design/bottomnavigation/ShiftingMode.java

@@ -55,8 +55,8 @@ public class BottomNavigationItemView extends FrameLayout implements MenuView.It
   private float scaleUpFactor;
   private float scaleDownFactor;
 
-  private boolean shiftingMode;
   private int labelVisibilityMode;
+  private boolean isShifting;
 
   private ImageView icon;
   private final TextView smallLabel;
@@ -111,9 +111,9 @@ public int getItemPosition() {
     return itemPosition;
   }
 
-  public void setShiftingMode(boolean enabled) {
-    if (shiftingMode != enabled) {
-      shiftingMode = enabled;
+  public void setShifting(boolean shifting) {
+    if (isShifting != shifting) {
+      isShifting = shifting;
 
       boolean initialized = itemData != null;
       if (initialized) {
@@ -125,14 +125,14 @@ public void setShiftingMode(boolean enabled) {
   public void setLabelVisibilityMode(@LabelVisibilityMode int mode) {
     if (labelVisibilityMode != mode) {
       labelVisibilityMode = mode;
-
+      
       boolean initialized = itemData != null;
       if (initialized) {
         setChecked(itemData.isChecked());
       }
     }
   }
-
+  
   @Override
   public MenuItemImpl getItemData() {
     return itemData;
@@ -157,8 +157,8 @@ public void setChecked(boolean checked) {
     smallLabel.setPivotY(smallLabel.getBaseline());
 
     switch (labelVisibilityMode) {
-      case LabelVisibilityMode.LABEL_VISIBILITY_LEGACY:
-        if (shiftingMode) {
+      case LabelVisibilityMode.LABEL_VISIBILITY_AUTO:
+        if (isShifting) {
           if (checked) {
             setViewLayoutParams(icon, defaultMargin, Gravity.CENTER_HORIZONTAL | Gravity.TOP);
             setViewValues(largeLabel, 1f, 1f, VISIBLE);

lib/java/android/support/design/internal/BottomNavigationItemView.java

@@ -25,7 +25,6 @@
 import android.support.annotation.RestrictTo;
 import android.support.annotation.StyleRes;
 import android.support.design.bottomnavigation.LabelVisibilityMode;
-import android.support.design.bottomnavigation.ShiftingMode;
 import android.support.transition.AutoTransition;
 import android.support.transition.TransitionManager;
 import android.support.transition.TransitionSet;
@@ -59,7 +58,6 @@ public class BottomNavigationMenuView extends ViewGroup implements MenuView {
   private final OnClickListener onClickListener;
   private final Pools.Pool<BottomNavigationItemView> itemPool = new Pools.SynchronizedPool<>(5);
 
-  private int shiftingModeFlag = ShiftingMode.SHIFTING_MODE_AUTO;
   private boolean itemHorizontalTranslation;
   @LabelVisibilityMode private int labelVisibilityMode;
 
@@ -130,7 +128,7 @@ protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
 
     final int heightSpec = MeasureSpec.makeMeasureSpec(itemHeight, MeasureSpec.EXACTLY);
 
-    if (isShifting(shiftingModeFlag, visibleCount) && itemHorizontalTranslation) {
+    if (isShifting(labelVisibilityMode, visibleCount) && itemHorizontalTranslation) {
       final View activeChild = getChildAt(selectedItemPosition);
       int activeItemWidth = activeItemMinWidth;
       if (activeChild.getVisibility() != View.GONE) {
@@ -351,43 +349,14 @@ public int getItemBackgroundRes() {
     return itemBackgroundRes;
   }
 
-  /**
-   * Sets shifting mode override flag for menu view. If this flag is set to {@link
-   * ShiftingMode#SHIFTING_MODE_OFF}, this menu will not have shifting behavior even if it has more
-   * than 3 children. If this flag is set to {@link ShiftingMode#SHIFTING_MODE_ON}, this menu will
-   * have shifting behavior for any number of children. If this flag is set to {@link
-   * ShiftingMode#SHIFTING_MODE_AUTO} this menu will have shifting behavior only if it has 3 or more
-   * children.
-   *
-   * @param shiftingMode one of {@link ShiftingMode#SHIFTING_MODE_OFF}, {@link
-   *     ShiftingMode#SHIFTING_MODE_ON}, or {@link ShiftingMode#SHIFTING_MODE_AUTO}
-   * @deprecated use {@link #setLabelVisibilityMode(int)} instead
-   */
-  @Deprecated
-  public void setShiftingMode(@ShiftingMode int shiftingMode) {
-    shiftingModeFlag = shiftingMode;
-  }
-
-  /**
-   * Gets the status of shifting mode override flag for this menu view.
-   *
-   * @return Shifting mode flag for this menu view (default {@link ShiftingMode#SHIFTING_MODE_AUTO})
-   * @deprecated use {@link #getLabelVisibilityMode()} instead
-   */
-  @Deprecated
-  @ShiftingMode
-  public int getShiftingMode() {
-    return shiftingModeFlag;
-  }
-
   /**
    * Sets the navigation items' label visibility mode.
    *
    * <p>The label is either always shown, never shown, or only shown when activated. Also supports
-   * legacy mode, which uses {@link ShiftingMode} to decide whether the label should be shown.
+   * "auto" mode, which uses the item count to determine whether to show or hide the label.
    *
    * @param labelVisibilityMode mode which decides whether or not the label should be shown. Can be
-   *     one of {@link LabelVisibilityMode#LABEL_VISIBILITY_LEGACY}, {@link
+   *     one of {@link LabelVisibilityMode#LABEL_VISIBILITY_AUTO}, {@link
    *     LabelVisibilityMode#LABEL_VISIBILITY_SELECTED}, {@link
    *     LabelVisibilityMode#LABEL_VISIBILITY_LABELED}, or {@link
    *     LabelVisibilityMode#LABEL_VISIBILITY_UNLABELED}
@@ -407,19 +376,21 @@ public int getLabelVisibilityMode() {
   }
 
   /**
-   * Sets whether the menu items horizontally translate in shifting mode.
+   * Sets whether the menu items horizontally translate on selection when the combined item widths
+   * fill the screen.
    *
-   * @param itemHorizontalTranslation whether the menu items horizontally translate in shifting mode
+   * @param itemHorizontalTranslation whether the menu items horizontally translate on selection
    * @see #getItemHorizontalTranslation()
    */
   public void setItemHorizontalTranslation(boolean itemHorizontalTranslation) {
     this.itemHorizontalTranslation = itemHorizontalTranslation;
   }
 
   /**
-   * Returns whether the menu items horizontally translate in shifting mode.
+   * Returns whether the menu items horizontally translate on selection when the combined item
+   * widths fill the screen.
    *
-   * @return whether the menu items horizontally translate in shifting mode
+   * @return whether the menu items horizontally translate on selection
    * @see #setItemHorizontalTranslation(boolean)
    */
   public boolean getItemHorizontalTranslation() {
@@ -466,7 +437,7 @@ public void buildMenuView() {
       return;
     }
     buttons = new BottomNavigationItemView[menu.size()];
-    boolean shifting = isShifting(shiftingModeFlag, menu.getVisibleItems().size());
+    boolean shifting = isShifting(labelVisibilityMode, menu.getVisibleItems().size());
     for (int i = 0; i < menu.size(); i++) {
       presenter.setUpdateSuspended(true);
       menu.getItem(i).setCheckable(true);
@@ -480,7 +451,7 @@ public void buildMenuView() {
       child.setTextAppearanceActive(itemTextAppearanceActive);
       child.setTextColor(itemTextColorFromUser);
       child.setItemBackground(itemBackgroundRes);
-      child.setShiftingMode(shifting);
+      child.setShifting(shifting);
       child.setLabelVisibilityMode(labelVisibilityMode);
       child.initialize((MenuItemImpl) menu.getItem(i), 0);
       child.setItemPosition(i);
@@ -517,11 +488,11 @@ public void updateMenuView() {
       TransitionManager.beginDelayedTransition(this, set);
     }
 
-    boolean shifting = isShifting(shiftingModeFlag, menu.getVisibleItems().size());
+    boolean shifting = isShifting(labelVisibilityMode, menu.getVisibleItems().size());
     for (int i = 0; i < menuSize; i++) {
       presenter.setUpdateSuspended(true);
-      buttons[i].setShiftingMode(shifting);
       buttons[i].setLabelVisibilityMode(labelVisibilityMode);
+      buttons[i].setShifting(shifting);
       buttons[i].initialize((MenuItemImpl) menu.getItem(i), 0);
       presenter.setUpdateSuspended(false);
     }
@@ -539,10 +510,10 @@ public int getSelectedItemId() {
     return selectedItemId;
   }
 
-  private boolean isShifting(@ShiftingMode int shiftingMode, int childCount) {
-    return shiftingMode == ShiftingMode.SHIFTING_MODE_AUTO
+  private boolean isShifting(@LabelVisibilityMode int labelVisibilityMode, int childCount) {
+    return labelVisibilityMode == LabelVisibilityMode.LABEL_VISIBILITY_AUTO
         ? childCount > 3
-        : shiftingMode == ShiftingMode.SHIFTING_MODE_ON;
+        : labelVisibilityMode == LabelVisibilityMode.LABEL_VISIBILITY_SELECTED;
   }
 
   void tryRestoreSelectedItemId(int itemId) {