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.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;
@@ skipping 68 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 int mHighlightedColor;
     private final float mDpToPx;
 
-    public AppMenuAdapter(AppMenu appMenu, List<MenuItem> menuItems, LayoutInflater inflater) {
+    // Cached drawables to avoid animation glitches if views get rebuilt.
+    private Drawable mCachedHighlightIconDrawable;
+    private Drawable mCachedHighlightRowDrawable;
+
+    public AppMenuAdapter(AppMenu appMenu, List<MenuItem> menuItems, LayoutInflater inflater,
+            @IdRes int highlightedItemId) {
         mAppMenu = appMenu;
         mMenuItems = menuItems;
         mInflater = inflater;
+        mHighlightedItemId = highlightedItemId;
+        mHighlightedColor = ApiCompatibilityUtils.getColor(
+                mInflater.getContext().getResources(), R.color.google_blue_500);
         mNumMenuItems = menuItems.size();
         mDpToPx = inflater.getContext().getResources().getDisplayMetrics().density;
     }
 
     @Override
     public int getCount() {
         return mNumMenuItems;
     }
 
     @Override
@@ skipping 38 matching lines @@
         final MenuItem item = getItem(position);
         switch (getItemViewType(position)) {
             case STANDARD_MENU_ITEM: {
                 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);
+                    holder.background = convertView.getBackground();
                     convertView.setTag(holder);
                     convertView.setTag(R.id.menu_item_enter_anim_id,
                             buildStandardItemEnterAnimator(convertView, position));
                 } 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);
+                    holder.background = convertView.getBackground();
                     convertView.setTag(holder);
                     convertView.setTag(R.id.menu_item_enter_anim_id,
                             buildStandardItemEnterAnimator(convertView, position));
                 } else {
                     holder = (CustomMenuItemViewHolder) convertView.getTag();
                 }
 
                 setupStandardMenuItemViewHolder(holder, convertView, item);
                 String summary = UpdateMenuItemHelper.getInstance().getMenuItemSummaryText(
                         mInflater.getContext());
@@ skipping 17 matching lines @@
                 convertView = createMenuItemRow(convertView, parent, item, 5);
                 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.background = convertView.getBackground();
+                    holder.button.view = (TintedImageButton) convertView.findViewById(R.id.button);
+                    holder.button.background = holder.button.view.getBackground();
 
                     View animatedView = convertView;
 
                     convertView.setTag(holder);
                     convertView.setTag(R.id.menu_item_enter_anim_id,
                             buildStandardItemEnterAnimator(animatedView, position));
                 } 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);
+                    holder.button.view.setVisibility(View.VISIBLE);
                     setupImageButton(holder.button, item.getSubMenu().getItem(1));
                 } else {
-                    holder.button.setVisibility(View.GONE);
+                    holder.button.view.setVisibility(View.GONE);
                 }
                 convertView.setFocusable(false);
                 convertView.setEnabled(false);
                 break;
             }
             default:
                 assert false : "Unexpected MenuItem type";
         }
+
+        checkRowHighlight(item.getItemId(), convertView);
+
         return convertView;
     }
 
-    private void setupImageButton(TintedImageButton button, final MenuItem item) {
+    private void setupImageButton(RowItemButton button, final MenuItem item) {
         // Store and recover the level of image as button.setimageDrawable
         // resets drawable to default level.
+        TintedImageButton view = button.view;
+
         int currentLevel = item.getIcon().getLevel();
-        button.setImageDrawable(item.getIcon());
+        view.setImageDrawable(item.getIcon());
         item.getIcon().setLevel(currentLevel);
         if (item.isChecked()) {
-            button.setTint(ApiCompatibilityUtils.getColorStateList(
-                    button.getResources(), R.color.blue_mode_tint));
+            view.setTint(ApiCompatibilityUtils.getColorStateList(
+                    view.getResources(), R.color.blue_mode_tint));
         }
-        button.setEnabled(item.isEnabled());
-        button.setFocusable(item.isEnabled());
-        button.setContentDescription(item.getTitleCondensed());
+        view.setEnabled(item.isEnabled());
+        view.setFocusable(item.isEnabled());
+        view.setContentDescription(item.getTitleCondensed());
 
-        button.setOnClickListener(new OnClickListener() {
+        view.setOnClickListener(new OnClickListener() {
             @Override
             public void onClick(View v) {
                 mAppMenu.onItemClick(item);
             }
         });
 
+        checkItemHighlight(item.getItemId(), view, button.background, true);
+
         // Menu items may be hidden by command line flags before they get to this point.
-        button.setVisibility(item.isVisible() ? View.VISIBLE : View.GONE);
+        view.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);
         holder.image.setChecked(item.isChecked());
         holder.text.setText(item.getTitle());
@@ skipping 39 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 RowItemButton[] 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].view;
+            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].view.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);
+            holder.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 = view;
+                holder.buttons[i].background = view.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;
     }
 
-    static class StandardMenuItemViewHolder {
+    private void checkRowHighlight(int itemId, View view) {
+        if (mHighlightedItemId == 0) return;
+
+        Object tag = view.getTag();
+        if (tag == null || !(tag instanceof MenuItemViewHolder)) return;

[Ted C, 2017/03/31 19:01:47]

when isn't the tag a MenuItemViewHolder?  It seems like it is the root of all of
the tags.

Why would tag be null?

+
+        Drawable background = ((MenuItemViewHolder) tag).background;
+
+        checkItemHighlight(itemId, view, background, false);
+    }
+
+    private void checkItemHighlight(
+            int itemId, View view, Drawable viewBackground, boolean isIcon) {
+        if (mHighlightedItemId == 0) return;
+
+        if (mHighlightedItemId == itemId) {
+            view.setBackground(new LayerDrawable(
+                    new Drawable[] {getHighlightDrawable(isIcon), viewBackground}));
+        } else {
+            view.setBackground(viewBackground);
+        }
+    }
+
+    private Drawable getHighlightDrawable(boolean isIcon) {
+        if (isIcon) {
+            if (mCachedHighlightIconDrawable == null) {
+                mCachedHighlightIconDrawable = new IconHighlightDrawable(mHighlightedColor);
+            }
+            return mCachedHighlightIconDrawable;
+        } else {
+            if (mCachedHighlightRowDrawable == null) {
+                mCachedHighlightRowDrawable = new RowHighlightDrawable(mHighlightedColor);
+            }
+            return mCachedHighlightRowDrawable;
+        }
+    }
+
+    static class MenuItemViewHolder { public Drawable background; }
+
+    static class StandardMenuItemViewHolder extends MenuItemViewHolder {
         public TextView text;
         public AppMenuItemIcon image;
     }
 
     static class CustomMenuItemViewHolder extends StandardMenuItemViewHolder {
         public TextView summary;
     }
 
-    private static class RowItemViewHolder {
-        public TintedImageButton[] buttons;
+    static class RowItemButton {
+        public TintedImageButton view;
+        public Drawable background;
+    }
+
+    private static class RowItemViewHolder extends MenuItemViewHolder {
+        public RowItemButton[] buttons;
 
         RowItemViewHolder(int numButtons) {
-            buttons = new TintedImageButton[numButtons];
+            buttons = new RowItemButton[numButtons];
+            for (int i = 0; i < numButtons; i++) {
+                buttons[i] = new RowItemButton();
+            }
         }
     }
 
-    static class TitleButtonMenuItemViewHolder {
+    static class TitleButtonMenuItemViewHolder extends MenuItemViewHolder {
         public TextView title;
-        public TintedImageButton button;
+        public RowItemButton button = new RowItemButton();
     }
 }