Add support for highlighting menu items

chrome/android/java/src/org/chromium/chrome/browser/appmenu/AppMenuAdapter.java

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 package org.chromium.chrome.browser.appmenu;
 
 import android.animation.Animator;
 import android.animation.AnimatorListenerAdapter;
 import android.animation.AnimatorSet;
 import android.animation.ObjectAnimator;
+import android.content.res.Resources;
 import android.graphics.drawable.Drawable;
+import android.graphics.drawable.LayerDrawable;
+import android.support.annotation.IdRes;
 import android.text.TextUtils;
 import android.view.LayoutInflater;
 import android.view.MenuItem;
 import android.view.View;
 import android.view.View.OnClickListener;
 import android.view.ViewGroup;
 import android.widget.BaseAdapter;
 import android.widget.ImageView;
 import android.widget.ListView;
 import android.widget.TextView;
 
 import org.chromium.base.ApiCompatibilityUtils;
+import org.chromium.base.ContextUtils;
 import org.chromium.chrome.R;
 import org.chromium.chrome.browser.omaha.UpdateMenuItemHelper;
 import org.chromium.chrome.browser.widget.TintedImageButton;
 import org.chromium.ui.base.LocalizationUtils;
 import org.chromium.ui.interpolators.BakedBezierInterpolator;
 
 import java.util.List;
 
 /**
  * ListAdapter to customize the view of items in the list.
@@ skipping 56 matching lines @@
     private static final int ENTER_ITEM_DURATION_MS = 350;
     private static final int ENTER_ITEM_BASE_DELAY_MS = 80;
     private static final int ENTER_ITEM_ADDL_DELAY_MS = 30;
     private static final float ENTER_STANDARD_ITEM_OFFSET_Y_DP = -10.f;
     private static final float ENTER_STANDARD_ITEM_OFFSET_X_DP = 10.f;
 
     private final AppMenu mAppMenu;
     private final LayoutInflater mInflater;
     private final List<MenuItem> mMenuItems;
     private final int mNumMenuItems;
+    @IdRes
+    private final int mHighlightedItemId;
     private final float mDpToPx;
 
-    public AppMenuAdapter(AppMenu appMenu, List<MenuItem> menuItems, LayoutInflater inflater) {
+    // Use a single PulseDrawable to spawn the other drawables so that the ConstantState gets
+    // shared.  This allows the animation to stay in step even as the views are recycled and the
+    // background gets changed.  This Drawable isn't just used directly because Drawables need to
+    // have a single owner or the internals of View can modify it's state as it gets cleared later.
+    private PulseDrawable mHighlightDrawableSource;
+
+    public AppMenuAdapter(AppMenu appMenu, List<MenuItem> menuItems, LayoutInflater inflater,
+            @IdRes int highlightedItemId) {
         mAppMenu = appMenu;
         mMenuItems = menuItems;
         mInflater = inflater;
+        mHighlightedItemId = highlightedItemId;
         mNumMenuItems = menuItems.size();
         mDpToPx = inflater.getContext().getResources().getDisplayMetrics().density;
     }
 
     @Override
     public int getCount() {
         return mNumMenuItems;
     }
 
     @Override
@@ skipping 41 matching lines @@
                 StandardMenuItemViewHolder holder = null;
                 if (convertView == null
                         || !(convertView.getTag() instanceof StandardMenuItemViewHolder)) {
                     holder = new StandardMenuItemViewHolder();
                     convertView = mInflater.inflate(R.layout.menu_item, parent, false);
                     holder.text = (TextView) convertView.findViewById(R.id.menu_item_text);
                     holder.image = (AppMenuItemIcon) convertView.findViewById(R.id.menu_item_icon);
                     convertView.setTag(holder);
                     convertView.setTag(R.id.menu_item_enter_anim_id,
                             buildStandardItemEnterAnimator(convertView, position));
+                    convertView.setTag(
+                            R.id.menu_item_original_background, convertView.getBackground());
                 } else {
                     holder = (StandardMenuItemViewHolder) convertView.getTag();
                 }
 
                 setupStandardMenuItemViewHolder(holder, convertView, item);
                 break;
             }
             case UPDATE_MENU_ITEM: {
                 CustomMenuItemViewHolder holder = null;
                 if (convertView == null
                         || !(convertView.getTag() instanceof CustomMenuItemViewHolder)) {
                     holder = new CustomMenuItemViewHolder();
                     convertView = mInflater.inflate(R.layout.update_menu_item, parent, false);
                     holder.text = (TextView) convertView.findViewById(R.id.menu_item_text);
                     holder.image = (AppMenuItemIcon) convertView.findViewById(R.id.menu_item_icon);
                     holder.summary = (TextView) convertView.findViewById(R.id.menu_item_summary);
                     convertView.setTag(holder);
                     convertView.setTag(R.id.menu_item_enter_anim_id,
                             buildStandardItemEnterAnimator(convertView, position));
+                    convertView.setTag(
+                            R.id.menu_item_original_background, convertView.getBackground());
                 } else {
                     holder = (CustomMenuItemViewHolder) convertView.getTag();
                 }
 
                 setupStandardMenuItemViewHolder(holder, convertView, item);
                 String summary = UpdateMenuItemHelper.getInstance().getMenuItemSummaryText(
                         mInflater.getContext());
                 if (TextUtils.isEmpty(summary)) {
                     holder.summary.setVisibility(View.GONE);
                 } else {
@@ skipping 15 matching lines @@
                 break;
             }
             case TITLE_BUTTON_MENU_ITEM: {
                 TitleButtonMenuItemViewHolder holder = null;
                 if (convertView == null
                         || !(convertView.getTag() instanceof TitleButtonMenuItemViewHolder)) {
                     holder = new TitleButtonMenuItemViewHolder();
                     convertView = mInflater.inflate(R.layout.title_button_menu_item, parent, false);
                     holder.title = (TextView) convertView.findViewById(R.id.title);
                     holder.button = (TintedImageButton) convertView.findViewById(R.id.button);
-
+                    holder.button.setTag(
+                            R.id.menu_item_original_background, holder.button.getBackground());
                     View animatedView = convertView;
 
                     convertView.setTag(holder);
                     convertView.setTag(R.id.menu_item_enter_anim_id,
                             buildStandardItemEnterAnimator(animatedView, position));
+                    convertView.setTag(
+                            R.id.menu_item_original_background, convertView.getBackground());
                 } else {
                     holder = (TitleButtonMenuItemViewHolder) convertView.getTag();
                 }
                 final MenuItem titleItem = item.hasSubMenu() ? item.getSubMenu().getItem(0) : item;
                 holder.title.setText(titleItem.getTitle());
                 holder.title.setEnabled(titleItem.isEnabled());
                 holder.title.setFocusable(titleItem.isEnabled());
                 holder.title.setOnClickListener(new OnClickListener() {
                     @Override
                     public void onClick(View v) {
                         mAppMenu.onItemClick(titleItem);
                     }
                 });
 
                 if (item.getSubMenu().getItem(1).getIcon() != null) {
                     holder.button.setVisibility(View.VISIBLE);
                     setupImageButton(holder.button, item.getSubMenu().getItem(1));
                 } else {
                     holder.button.setVisibility(View.GONE);
                 }
                 convertView.setFocusable(false);
                 convertView.setEnabled(false);
                 break;
             }
             default:
                 assert false : "Unexpected MenuItem type";
         }
+
+        checkHighlightDrawable(convertView, false, item.getItemId());
+
         return convertView;
     }
 
     private void setupImageButton(TintedImageButton button, final MenuItem item) {
         // Store and recover the level of image as button.setimageDrawable
         // resets drawable to default level.
         int currentLevel = item.getIcon().getLevel();
         button.setImageDrawable(item.getIcon());
         item.getIcon().setLevel(currentLevel);
         if (item.isChecked()) {
             button.setTint(ApiCompatibilityUtils.getColorStateList(
                     button.getResources(), R.color.blue_mode_tint));
         }
         button.setEnabled(item.isEnabled());
         button.setFocusable(item.isEnabled());
         button.setContentDescription(item.getTitleCondensed());
 
         button.setOnClickListener(new OnClickListener() {
             @Override
             public void onClick(View v) {
                 mAppMenu.onItemClick(item);
             }
         });
 
+        checkHighlightDrawable(button, true, item.getItemId());
+
         // Menu items may be hidden by command line flags before they get to this point.
         button.setVisibility(item.isVisible() ? View.VISIBLE : View.GONE);
     }
 
     private void setupStandardMenuItemViewHolder(StandardMenuItemViewHolder holder,
             View convertView, final MenuItem item) {
         // Set up the icon.
         Drawable icon = item.getIcon();
         holder.image.setImageDrawable(icon);
         holder.image.setVisibility(icon == null ? View.GONE : View.VISIBLE);
@@ skipping 41 matching lines @@
                 view.setAlpha(0.f);
             }
         });
         return animation;
     }
 
     /**
      * This builds an {@link Animator} for the enter animation of icon row menu items.  This means
      * it will animate the alpha from 0 to 1 and translate the views from 10dp to 0dp on the x axis.
      *
-     * @param views        The list if icons in the menu item that should be animated.
-     * @return             The {@link Animator}.
+     * @param buttons The list of icons in the menu item that should be animated.
+     * @return        The {@link Animator}.
      */
-    private Animator buildIconItemEnterAnimator(final ImageView[] views) {
+    private Animator buildIconItemEnterAnimator(final ImageView[] buttons) {
         final boolean rtl = LocalizationUtils.isLayoutRtl();
         final float offsetXPx = ENTER_STANDARD_ITEM_OFFSET_X_DP * mDpToPx * (rtl ? -1.f : 1.f);
-        final int maxViewsToAnimate = views.length;
+        final int maxViewsToAnimate = buttons.length;
 
         AnimatorSet animation = new AnimatorSet();
         AnimatorSet.Builder builder = null;
         for (int i = 0; i < maxViewsToAnimate; i++) {
             final int startDelay = ENTER_ITEM_ADDL_DELAY_MS * i;
 
-            Animator alpha = ObjectAnimator.ofFloat(views[i], View.ALPHA, 0.f, 1.f);
-            Animator translate = ObjectAnimator.ofFloat(views[i], View.TRANSLATION_X, offsetXPx, 0);
+            ImageView view = buttons[i];
+            Animator alpha = ObjectAnimator.ofFloat(view, View.ALPHA, 0.f, 1.f);
+            Animator translate = ObjectAnimator.ofFloat(view, View.TRANSLATION_X, offsetXPx, 0);
             alpha.setStartDelay(startDelay);
             translate.setStartDelay(startDelay);
             alpha.setDuration(ENTER_ITEM_DURATION_MS);
             translate.setDuration(ENTER_ITEM_DURATION_MS);
 
             if (builder == null) {
                 builder = animation.play(alpha);
             } else {
                 builder.with(alpha);
             }
             builder.with(translate);
         }
         animation.setStartDelay(ENTER_ITEM_BASE_DELAY_MS);
         animation.setInterpolator(BakedBezierInterpolator.FADE_IN_CURVE);
 
         animation.addListener(new AnimatorListenerAdapter() {
             @Override
             public void onAnimationStart(Animator animation) {
                 for (int i = 0; i < maxViewsToAnimate; i++) {
-                    views[i].setAlpha(0.f);
+                    buttons[i].setAlpha(0.f);
                 }
             }
         });
         return animation;
     }
 
     private View createMenuItemRow(
             View convertView, ViewGroup parent, MenuItem item, int numItems) {
         RowItemViewHolder holder = null;
         if (convertView == null
                 || !(convertView.getTag() instanceof RowItemViewHolder)
                 || ((RowItemViewHolder) convertView.getTag()).buttons.length != numItems) {
             holder = new RowItemViewHolder(numItems);
             convertView = mInflater.inflate(R.layout.icon_row_menu_item, parent, false);
+            convertView.setTag(R.id.menu_item_original_background, convertView.getBackground());
 
             // Save references to all the buttons.
             for (int i = 0; i < numItems; i++) {
-                holder.buttons[i] =
+                TintedImageButton view =
                         (TintedImageButton) convertView.findViewById(BUTTON_IDS[i]);
+                holder.buttons[i] = view;
+                holder.buttons[i].setTag(
+                        R.id.menu_item_original_background, holder.buttons[i].getBackground());
             }
 
             // Remove unused menu items.
             for (int j = numItems; j < 5; j++) {
                 ((ViewGroup) convertView).removeView(convertView.findViewById(BUTTON_IDS[j]));
             }
 
             convertView.setTag(holder);
             convertView.setTag(R.id.menu_item_enter_anim_id,
                     buildIconItemEnterAnimator(holder.buttons));
         } else {
             holder = (RowItemViewHolder) convertView.getTag();
         }
 
         for (int i = 0; i < numItems; i++) {
             setupImageButton(holder.buttons[i], item.getSubMenu().getItem(i));
         }
         convertView.setFocusable(false);
         convertView.setEnabled(false);
         return convertView;
     }
 
+    private void checkHighlightDrawable(View view, boolean isIcon, int itemId) {

[Ted C, 2017/04/12 18:05:57]

I think maybe this should be:

highlightItemIfNecessary or something

This name is not what I expected this method would do.

[David Trainor- moved to gerrit, 2017/04/12 18:59:37]

Done.

+        Drawable background = (Drawable) view.getTag(R.id.menu_item_original_background);
+        if (background == null) return;
+
+        if (itemId != mHighlightedItemId) {
+            view.setBackground(background);
+            return;
+        }
+
+        if (mHighlightDrawableSource == null) {
+            mHighlightDrawableSource = isIcon ? PulseDrawableFactory.createCircle()
+                                              : PulseDrawableFactory.createHighlight();
+        }
+
+        Resources resources = ContextUtils.getApplicationContext().getResources();
+
+        PulseDrawable pulse =
+                (PulseDrawable) mHighlightDrawableSource.getConstantState().newDrawable(resources);
+        if (background.getConstantState() != null) {
+            background = background.getConstantState().newDrawable(resources);

[Ted C, 2017/04/12 18:05:56]

Why aren't we reusing the background as is?

[David Trainor- moved to gerrit, 2017/04/12 18:59:36]

I can probably make it work.  Here's why it's breaking:
1. LayerDrawable calls Drawable#setCallback(...) on the background Drawable as
it's added, effectively stealing ownership but not telling anyone.
2. View.setBackground(LayerDrawable) calls Drawable#setCallback(null) when it
drops it's internal reference to the old background.  Sadly this detaches the
Drawable from LayerDrawable and not the View... as the callback was already
swapped to the View.

A solution might be:

view.setBackground(null);

// build the LayerDrawable, reuse the background.

view.setBackground(drawable);

I'll test this tonight

+        }
+
+        LayerDrawable drawable = new LayerDrawable(new Drawable[] {pulse, background});
+        view.setBackground(drawable);
+        pulse.start();
+    }
+
     static class StandardMenuItemViewHolder {
         public TextView text;
         public AppMenuItemIcon image;
     }
 
     static class CustomMenuItemViewHolder extends StandardMenuItemViewHolder {
         public TextView summary;
     }
 
     private static class RowItemViewHolder {
         public TintedImageButton[] buttons;
 
         RowItemViewHolder(int numButtons) {
             buttons = new TintedImageButton[numButtons];
         }
     }
 
     static class TitleButtonMenuItemViewHolder {
         public TextView title;
         public TintedImageButton button;
     }
 }