bluetooth: Implement RSSI indicator on android

chrome/android/java/src/org/chromium/chrome/browser/ItemChooserDialog.java

 // Copyright 2015 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;
 
 import android.app.Activity;
 import android.app.Dialog;
 import android.content.Context;
 import android.content.DialogInterface;
 import android.graphics.Color;
 import android.graphics.drawable.ColorDrawable;
+import android.graphics.drawable.Drawable;
 import android.text.SpannableString;
 import android.text.method.LinkMovementMethod;
 import android.view.Gravity;
 import android.view.LayoutInflater;
 import android.view.View;
 import android.view.ViewGroup;
 import android.view.ViewGroup.LayoutParams;
 import android.view.Window;
 import android.widget.AdapterView;
 import android.widget.ArrayAdapter;
 import android.widget.Button;
+import android.widget.ImageView;
 import android.widget.LinearLayout;
 import android.widget.ListView;
 import android.widget.ProgressBar;
+import android.widget.RelativeLayout;
 import android.widget.TextView;
 
+import org.chromium.base.Log;
 import org.chromium.base.ApiCompatibilityUtils;
 import org.chromium.base.VisibleForTesting;
 import org.chromium.chrome.R;
 import org.chromium.chrome.browser.util.MathUtils;
 import org.chromium.ui.base.DeviceFormFactor;
 import org.chromium.ui.widget.TextViewWithClickableSpans;
 
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Map;
@@ skipping 19 matching lines @@
          */
         void onItemSelected(String id);
     }
 
     /**
      * A class representing one data row in the picker.
      */
     public static class ItemChooserRow {
         private final String mKey;
         private String mDescription;
+        private Drawable mIcon;
+        private String mIconDescription;
+
+        public ItemChooserRow(
+                String key, String description, Drawable icon, String iconDescription) {
+            mKey = key;
+            mDescription = description;
+            mIcon = icon;
+            mIconDescription = iconDescription;
+        }
 
         public ItemChooserRow(String key, String description) {
-            mKey = key;
-            mDescription = description;
+            this(key, description, null, null);
+        }
+
+        public Drawable getIcon() {
+            return mIcon;
         }
 
         @Override
         public boolean equals(Object obj) {
             if (!(obj instanceof ItemChooserRow)) return false;
             if (this == obj) return true;
             ItemChooserRow item = (ItemChooserRow) obj;
-            return mKey.equals(item.mKey) && mDescription.equals(item.mDescription);
+
+            if (mIcon == null ^ item.mIcon == null) return false;
+
+            if (mIcon != null && item.mIcon != null
+                    && !mIcon.getConstantState().equals(item.mIcon.getConstantState()))
+                return false;
+
+            if (mIconDescription == null ^ item.mIconDescription == null) return false;
+
+            if (mIconDescription != null && mIconDescription.equals(item.mIconDescription)) {
+                return false;
+            }
+
+            if (mKey.equals(item.mKey) && mDescription.equals(item.mDescription)) return true;
+
+            return false;
         }
 
         @Override
         public int hashCode() {
-            return mKey.hashCode() + mDescription.hashCode();
+            return mKey.hashCode() + mDescription.hashCode() + mIcon.hashCode();
+        }
+
+        @Override
+        public String toString() {
+            return mKey + ":" + mDescription + ":" + mIcon.toString();
         }
     }
 
     /**
      * The labels to show in the dialog.
      */
     public static class ItemChooserLabels {
         // The title at the top of the dialog.
         public final CharSequence title;
         // The message to show while there are no results.
@@ skipping 36 matching lines @@
     public class ItemAdapter extends ArrayAdapter<ItemChooserRow>
             implements AdapterView.OnItemClickListener {
         private final LayoutInflater mInflater;
 
         // The background color of the highlighted item.
         private final int mBackgroundHighlightColor;
 
         // The color of the non-highlighted text.
         private final int mDefaultTextColor;
 
+        // The color of disabled text.
+        private final int mDisabledTextColor;
+
+        // Indicates whether rows will contain an icon.
+        private boolean mUsingIcon;
+
         // The zero-based index of the item currently selected in the dialog,
         // or -1 (INVALID_POSITION) if nothing is selected.
         private int mSelectedItem = ListView.INVALID_POSITION;
 
         // A set of keys that are marked as disabled in the dialog.
         private Set<String> mDisabledEntries = new HashSet<String>();
 
         // Item descriptions are counted in a map.
         private Map<String, Integer> mItemDescriptionMap = new HashMap<>();
 
         // Map of keys to items so that we can access the items in O(1).
         private Map<String, ItemChooserRow> mKeyToItemMap = new HashMap<>();
 
-        public ItemAdapter(Context context, int resource) {
+        public ItemAdapter(Context context, int resource, boolean usingIcon) {
             super(context, resource);
 
             mInflater = LayoutInflater.from(context);
 
+            mUsingIcon = usingIcon;
+
             mBackgroundHighlightColor = ApiCompatibilityUtils.getColor(getContext().getResources(),
                     R.color.light_active_color);
             mDefaultTextColor = ApiCompatibilityUtils.getColor(getContext().getResources(),
                     R.color.default_text_color);
+            mDisabledTextColor = ApiCompatibilityUtils.getColor(
+                    getContext().getResources(), R.color.primary_text_disabled_material_light);
         }
 
         @Override
         public boolean isEmpty() {
             boolean isEmpty = super.isEmpty();
             if (isEmpty) {
                 assert mKeyToItemMap.isEmpty();
                 assert mDisabledEntries.isEmpty();
                 assert mItemDescriptionMap.isEmpty();
             } else {
                 assert !mKeyToItemMap.isEmpty();
                 assert !mItemDescriptionMap.isEmpty();
             }
             return isEmpty;
         }
 
-        public void addOrUpdate(ItemChooserRow item) {
+      public void addOrUpdate(ItemChooserRow item, boolean didUpdateOldDrawable) {

[Ian Wen, 2016/10/14 01:39:51]

I see many equal checks here and above. Which leads me to thinking whether it's
even necessary to check equality. If we convert the dialog so that it gives out
the item row and let the client to update it, then the update logic will be
trivial, and we no longer need to care if anything has changed or not, because
the client will have a better idea.

Also this way we do not need to create temporary objects anymore, especially
when addOrUpdate is called very frequently.

             ItemChooserRow oldItem = mKeyToItemMap.get(item.mKey);
+
             if (oldItem != null) {
-                if (oldItem.equals(item)) {
+                if (oldItem.equals(item) && !didUpdateOldDrawable) {
                     // No need to update anything.
                     return;
                 }
+
                 if (!oldItem.mDescription.equals(item.mDescription)) {
                     removeFromDescriptionsMap(oldItem.mDescription);
                     oldItem.mDescription = item.mDescription;
                     addToDescriptionsMap(oldItem.mDescription);
                 }
+
+                if (item.mIcon != null && (oldItem.mIcon == null
+                                                  || !item.mIcon.getConstantState().equals(
+                                                             oldItem.mIcon.getConstantState()))) {
+                    oldItem.mIcon = item.mIcon;
+                }
+
                 notifyDataSetChanged();
                 return;
             }
             ItemChooserRow result = mKeyToItemMap.put(item.mKey, item);
             assert result == null;
 
             addToDescriptionsMap(item.mDescription);
             add(item);
         }
 
+        public ItemChooserRow getItemChooserRow(String key) {
+            return mKeyToItemMap.get(key);
+        }
+
         @Override
         public void remove(ItemChooserRow item) {
             ItemChooserRow oldItem = mKeyToItemMap.remove(item.mKey);
             if (oldItem == null) return;
             int oldItemPosition = getPosition(oldItem);
             // If the removed item is the item that is currently selected, deselect it
             // and disable the confirm button. Otherwise if the removed item is before
             // the currently selected item, the currently selected item's index needs
             // to be adjusted by one.
             if (oldItemPosition == mSelectedItem) {
@@ skipping 74 matching lines @@
             return 1;
         }
 
         @Override
         public long getItemId(int position) {
             return position;
         }
 
         @Override
         public View getView(int position, View convertView, ViewGroup parent) {
-            TextView view;
-            if (convertView instanceof TextView) {
-                view = (TextView) convertView;
+            RelativeLayout view;
+            if (convertView instanceof RelativeLayout) {

[Ian Wen, 2016/10/14 01:39:51]

Can the view be of a different type? If not I would simply check if convertView
is null. If so inflate it. Otherwise directly use it.

+                view = (RelativeLayout) convertView;
             } else {
-                view = (TextView) mInflater.inflate(
+                view = (RelativeLayout) mInflater.inflate(
                         R.layout.item_chooser_dialog_row, parent, false);
-            }
-
-            // Set highlighting for currently selected item.
-            if (position == mSelectedItem) {
-                view.setBackgroundColor(mBackgroundHighlightColor);
-                view.setTextColor(Color.WHITE);
-            } else {
-                view.setBackground(null);
-                if (!isEnabled(position)) {
-                    view.setTextColor(ApiCompatibilityUtils.getColor(getContext().getResources(),
-                            R.color.primary_text_disabled_material_light));
+                View icon = view.findViewById(R.id.icon);
+                if (mUsingIcon) {

[Ian Wen, 2016/10/14 01:39:51]

Instead of using this boolean, shall we grab the corresponding itemrow and check
if there is icon in it?

+                    icon.setVisibility(View.VISIBLE);
                 } else {
-                    view.setTextColor(mDefaultTextColor);
+                    icon.setVisibility(View.GONE);
                 }
             }
 
-            view.setText(getDisplayText(position));
+            boolean selected = position == mSelectedItem;
+            TextView description = (TextView) view.findViewById(R.id.description);
+            description.setText(getDisplayText(position));
+
+            if (selected) {

[Ian Wen, 2016/10/14 01:39:51]

The color manipulation could be simplified by color state list. Please refer to
the demo I sent you. :)

+                view.setBackgroundColor(mBackgroundHighlightColor);
+                description.setTextColor(Color.WHITE);
+            } else {
+                view.setBackground(null);
+                description.setTextColor(
+                        isEnabled(position) ? mDefaultTextColor : mDisabledTextColor);
+            }
+
+            if (mUsingIcon) {
+                ImageView icon = (ImageView) view.findViewById(R.id.icon);
+                Drawable d = getItem(position).mIcon;
+                icon.setVisibility(d == null ? View.INVISIBLE : View.VISIBLE);
+                if (d != null) {
+                  icon.setImageLevel(d.getLevel());
+                }
+                icon.setImageDrawable(d);
+                icon.setSelected(selected);
+                icon.invalidateDrawable(d);
+                icon.setContentDescription(getItem(position).mIconDescription);
+            }
+
             return view;
         }
 
         @Override
         public void onItemClick(AdapterView<?> adapter, View view, int position, long id) {
             mSelectedItem = position;
             mConfirmButton.setEnabled(true);
             mItemAdapter.notifyDataSetChanged();
         }
 
@@ skipping 48 matching lines @@
     // The maximum height of the listview in the dialog (in dp).
     private static final int MAX_HEIGHT_DP = (int) (LIST_ROW_HEIGHT_DP * 8.5);
 
     /**
      * Creates the ItemChooserPopup and displays it (and starts waiting for data).
      *
      * @param activity Activity which is used for launching a dialog.
      * @param callback The callback used to communicate back what was selected.
      * @param labels The labels to show in the dialog.
      */
-    public ItemChooserDialog(
-            Activity activity, ItemSelectedCallback callback, ItemChooserLabels labels) {
+    public ItemChooserDialog(Activity activity, ItemSelectedCallback callback,
+            ItemChooserLabels labels, boolean usingIcon) {
         mActivity = activity;
         mItemSelectedCallback = callback;
         mLabels = labels;
 
         LinearLayout dialogContainer = (LinearLayout) LayoutInflater.from(mActivity).inflate(
                 R.layout.item_chooser_dialog, null);
 
         mListView = (ListView) dialogContainer.findViewById(R.id.items);
         mProgressBar = (ProgressBar) dialogContainer.findViewById(R.id.progress);
         mStatus = (TextView) dialogContainer.findViewById(R.id.status);
@@ skipping 13 matching lines @@
         mConfirmButton.setEnabled(false);
         mConfirmButton.setOnClickListener(new View.OnClickListener() {
             @Override
             public void onClick(View v) {
                 mItemSelectedCallback.onItemSelected(mItemAdapter.getSelectedItemKey());
                 mDialog.setOnDismissListener(null);
                 mDialog.dismiss();
             }
         });
 
-        mItemAdapter = new ItemAdapter(mActivity, R.layout.item_chooser_dialog_row);
+        mItemAdapter = new ItemAdapter(mActivity, R.layout.item_chooser_dialog_row, usingIcon);
         mItemAdapter.setNotifyOnChange(true);
         mListView.setAdapter(mItemAdapter);
         mListView.setEmptyView(mEmptyMessage);
         mListView.setOnItemClickListener(mItemAdapter);
         mListView.setDivider(null);
         setState(State.STARTING);
 
         // The list is the main element in the dialog and it should grow and
         // shrink according to the size of the screen available.
         View listViewContainer = dialogContainer.findViewById(R.id.container);
@@ skipping 53 matching lines @@
         mDialog.dismiss();
     }
 
     /**
     * Add an item to the end of the list to show in the dialog if the item
     * was not in the chooser. Otherwise update the items description.
     *
     * @param item The item to be added to the end of the chooser or updated.
     */
     public void addOrUpdateItem(ItemChooserRow item) {
+        addOrUpdateItem(item, false /* didUpdateOldDrawable */);

[Ian Wen, 2016/10/14 01:39:51]

I would remove this comment.

+    }
+
+    public void addOrUpdateItem(ItemChooserRow item, boolean didUpdateOldDrawable) {
         mProgressBar.setVisibility(View.GONE);
-        mItemAdapter.addOrUpdate(item);
+        mItemAdapter.addOrUpdate(item, didUpdateOldDrawable);
         setState(State.PROGRESS_UPDATE_AVAILABLE);
     }
 
+    public ItemChooserRow getItemChooserRow(String key) {
+        return mItemAdapter.getItemChooserRow(key);
+    }
+
     /**
     * Remove an item that is shown in the dialog.
     *
     * @param item The item to be removed in the chooser.
     */
     public void removeItemFromList(ItemChooserRow item) {
         mItemAdapter.remove(item);
         setState(State.DISCOVERY_IDLE);
     }
 
@@ skipping 65 matching lines @@
     }
 
     /**
      * Returns the ItemAdapter associated with this class. For use with tests only.
      */
     @VisibleForTesting
     public ItemAdapter getItemAdapterForTesting() {
         return mItemAdapter;
     }
 }