Android - Introduce "keyboard accessory" for Autofill suggestions.

ui/android/java/src/org/chromium/ui/autofill/AutofillKeyboardAccessory.java

Index: ui/android/java/src/org/chromium/ui/autofill/AutofillKeyboardAccessory.java
diff --git a/ui/android/java/src/org/chromium/ui/autofill/AutofillKeyboardAccessory.java b/ui/android/java/src/org/chromium/ui/autofill/AutofillKeyboardAccessory.java
new file mode 100644
index 0000000000000000000000000000000000000000..90934af98d9087fde24c3c3e6aa00f8aea81bdbd
--- /dev/null
+++ b/ui/android/java/src/org/chromium/ui/autofill/AutofillKeyboardAccessory.java
@@ -0,0 +1,132 @@
+// Copyright 2013 The Chromium Authors. All rights reserved.

[David Trainor- moved to gerrit, 2015/04/20 23:29:43]

2015

[Evan Stade, 2015/04/21 00:48:51]

Done.

+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+package org.chromium.ui.autofill;
+
+import android.annotation.SuppressLint;
+import android.view.View;
+import android.view.ViewGroup;
+import android.view.accessibility.AccessibilityEvent;
+import android.widget.AdapterView;
+import android.widget.ListAdapter;
+import android.widget.ListView;
+
+import org.chromium.base.ApiCompatibilityUtils;
+import org.chromium.ui.DropdownAdapter;
+import org.chromium.ui.DropdownItem;
+import org.chromium.ui.R;
+import org.chromium.ui.base.WindowAndroid;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashSet;
+import java.util.List;
+
+/**
+ * The Autofill suggestion view that lists relevant suggestions.
+ */
+public class AutofillKeyboardAccessory extends ListView implements AdapterView.OnItemClickListener {
+    /**
+     * The constant used to specify a separator in a list of Autofill suggestions.
+     * Has to be kept in sync with enum in WebAutofillClient.h

[David Trainor- moved to gerrit, 2015/04/20 23:29:43]

Should we add a gyp target to build the Java enum from the C++ one?  That's been
the general rule lately AFAIK.  If not, this is fine :).

[Evan Stade, 2015/04/21 00:48:51]

mehhh

[David Trainor- moved to gerrit, 2015/04/21 06:55:47]

Haha I'm not sure your argument convinced me!  I'll let Newton chime in here,
but I will say I don't think anyone changing that file in WebKit will ever find
this file in Java and keep it up to date...

[Evan Stade, 2015/04/21 18:10:30]

OK, I looked at doing this. This file is in ui/ (because that's where
AutofillPopup lives, which is used by AW, and eventually this class will be used
by AW, I guess? I'm not sure if it will be easy to use this class in AW but I
don't like the idea of maintaining a separate UI just for AW) and the enum is in
components/. I believe ui/ can't depend on components/.

[David Trainor- moved to gerrit, 2015/04/21 21:02:31]

Okay in that case I'm fine with this for now.  Thanks for looking into it!

+     */
+    private static final int ITEM_ID_SEPARATOR_ENTRY = -3;
+
+    private final WindowAndroid mWindowAndroid;
+    private final AutofillKeyboardAccessoryDelegate mAutofillCallback;
+    private List<AutofillSuggestion> mSuggestions;
+
+    /**
+     * An interface to handle the touch interaction with an AutofillKeyboardAccessory object.
+     */
+    public interface AutofillKeyboardAccessoryDelegate {
+        /**
+         * Informs the controller the AutofillKeyboardAccessory was hidden.
+         */
+        public void dismissed();
+
+        /**
+         * Handles the selection of an Autofill suggestion from an AutofillKeyboardAccessory.
+         * @param listIndex The index of the selected Autofill suggestion.
+         */
+        public void suggestionSelected(int listIndex);
+    }
+
+    /**
+     * Creates an AutofillKeyboardAccessory with specified parameters.
+     * @param windowAndroid The owning WindowAndroid.
+     * @param autofillCallback A object that handles the calls to the native
+     * AutofillKeyboardAccessoryView.
+     */
+    public AutofillKeyboardAccessory(
+            WindowAndroid windowAndroid, AutofillKeyboardAccessoryDelegate autofillCallback) {

[David Trainor- moved to gerrit, 2015/04/20 23:29:43]

assert autofillCallback != null?

[Evan Stade, 2015/04/21 00:48:51]

Done.

+        super(windowAndroid.getActivity().get());
+        mWindowAndroid = windowAndroid;
+        mAutofillCallback = autofillCallback;
+
+        setBackgroundResource(R.drawable.autofill_accessory_view_border);
+        setOnItemClickListener(this);
+        setContentDescription(windowAndroid.getActivity().get().getString(
+                R.string.autofill_popup_content_description));
+    }
+
+    /**
+     * Filters the Autofill suggestions to the ones that we support and shows the popup.
+     * @param suggestions Autofill suggestion data.
+     * @param isRtl Gives the layout direction for the <input> field.
+     */
+    @SuppressLint("InlinedApi")
+    public void filterAndShow(AutofillSuggestion[] suggestions, boolean isRtl) {
+        mSuggestions = new ArrayList<AutofillSuggestion>(Arrays.asList(suggestions));
+        // Remove the AutofillSuggestions with IDs that are not supported by Android
+        ArrayList<DropdownItem> cleanedData = new ArrayList<DropdownItem>();
+        for (int i = 0; i < suggestions.length; i++) {
+            int itemId = suggestions[i].getSuggestionId();
+            if (itemId != ITEM_ID_SEPARATOR_ENTRY) {
+                cleanedData.add(suggestions[i]);
+            }
+        }
+
+        setAdapter(new DropdownAdapter(
+                mWindowAndroid.getActivity().get(), cleanedData, new HashSet<Integer>()));
+        ApiCompatibilityUtils.setLayoutDirection(
+                this, isRtl ? View.LAYOUT_DIRECTION_RTL : View.LAYOUT_DIRECTION_LTR);
+
+        int height = ViewGroup.LayoutParams.WRAP_CONTENT;
+        // Limit the visible number of suggestions (others are accessible via scrolling).
+        final int suggestionLimit = 2;
+        ListAdapter listAdapter = getAdapter();
+        if (listAdapter.getCount() > suggestionLimit) {
+            height = 0;
+            for (int i = 0; i < suggestionLimit; i++) {
+                View listItem = listAdapter.getView(i, null, this);
+                listItem.measure(0, 0);

[David Trainor- moved to gerrit, 2015/04/20 23:29:43]

Should we make a proper widthMeasureSpec and heightMeasureSpec here?  Look at
View#makeMeasureSpec().  It will end up at 0 anyway, but it seems like a future
proof/safe idea IMO.

[Evan Stade, 2015/04/21 00:48:51]

I prefer to avoid adding complexity for the sake of speculative future-proofing,
but maybe I don't fully understand the implications of what you're saying. Is
this not a "safe" way to determine a view's preferred/natural size?

[David Trainor- moved to gerrit, 2015/04/21 06:55:47]

I don't think changing it adds complexity.  I think changing it uses the API
correctly.  From a code search, it looks like we use
MeasureSpec.makeMeasureSpec() pretty much everywhere else in the codebase.  If
we have places where we don't, we should probably fix those too!

The issue is the int you're passing in is a union of a MeasureSpec mode and a
size.  It just happens that 0 has the correct behavior you want.  But passing 0
exposes the internals of how Android wants to format their MeasureSpec.  If you
want the same behavior, you should probably do the following for both the width
and height:

MeasureSpec.makeMeasureSpec(0, MeasureSpec.UNSPECIFIED)

[Evan Stade, 2015/04/21 18:10:30]

Done.

+                height += listItem.getMeasuredHeight();
+            }
+        }
+
+        setLayoutParams(new ViewGroup.LayoutParams(ViewGroup.LayoutParams.MATCH_PARENT, height));
+
+        if (getParent() == null) {
+            ViewGroup container = mWindowAndroid.getKeyboardAccessoryView();
+            container.addView(this);
+            container.setVisibility(View.VISIBLE);

[David Trainor- moved to gerrit, 2015/04/20 23:29:43]

Do we need to set visibility?

[Evan Stade, 2015/04/21 00:48:51]

it's possible that we could just leave it visible all the time. Would it be
allocated 0 space if it's WRAP_CONTENT and has no content?

It does seem like setting the visibility is likely to be a better idea in terms
of the performance optimizations it allows and for the readability of the code
and xml files.

[David Trainor- moved to gerrit, 2015/04/21 06:55:47]

Oh sorry I misread what you were setting visibility on.  I thought it was
setting visibility on the child that was being added/removed, not the container.
 My bad.

+            sendAccessibilityEvent(AccessibilityEvent.TYPE_WINDOW_STATE_CHANGED);
+        }
+    }
+
+    public void dismiss() {

[David Trainor- moved to gerrit, 2015/04/20 23:29:43]

Javadoc

[Evan Stade, 2015/04/21 18:10:30]

Done.

+        ViewGroup container = mWindowAndroid.getKeyboardAccessoryView();
+        container.removeView(this);
+        container.setVisibility(View.GONE);

[David Trainor- moved to gerrit, 2015/04/20 23:29:43]

Do we need to set visibility?

[Evan Stade, 2015/04/21 00:48:52]

Done.

+    }
+
+    @Override
+    public void onItemClick(AdapterView<?> parent, View view, int position, long id) {
+        DropdownAdapter adapter = (DropdownAdapter) parent.getAdapter();
+        int listIndex = mSuggestions.indexOf(adapter.getItem(position));
+        assert listIndex > -1;
+        mAutofillCallback.suggestionSelected(listIndex);
+    }
+}