Allow using a custom ViewRectProvider in the UserEducationHelper

We have a use case where we need our custom ViewRectProvider to call notifyRectHidden() when the rectangle that represents the anchor reaches a certain position, which dismisses the IPH.

Bug: 1085601
Change-Id: I687df3a1a24cf0e045b9ff39d127a60efbcc3802
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2212971Reviewed-by: Justin DeWitt <dewittj@chromium.org>
Reviewed-by: David Trainor <dtrainor@chromium.org>
Commit-Queue: Vincent Boisselle <vincb@google.com>
Cr-Commit-Position: refs/heads/master@{#803325}

chrome/android/java/src/org/chromium/chrome/browser/ntp/snippets/SectionHeaderView.java

@@ -107,8 +107,27 @@ public class SectionHeaderView extends LinearLayout implements View.OnClickListe
                     mHeader.isExpanded() ? 0 : R.drawable.hairline_border_card_background);
         }
     }
+
     /** Shows an IPH on the feed header menu button. */
     public void showMenuIph(UserEducationHelper helper) {
+        final ViewRectProvider rectProvider = new ViewRectProvider(mMenuView) {
+            // ViewTreeObserver.OnPreDrawListener implementation.
+            @Override
+            public boolean onPreDraw() {
+                boolean result = super.onPreDraw();
+
+                int minRectBottomPosPx =
+                        getResources().getDimensionPixelSize(R.dimen.toolbar_height_no_shadow)
+                        + mMenuView.getHeight() / 2;
+                // Notify that the rectangle is hidden to dismiss the popup if the anchor is
+                // positioned too high.
+                if (getRect().bottom < minRectBottomPosPx) {
+                    notifyRectHidden();
+                }
+
+                return result;
+            }
+        };
         helper.requestShowIPH(new IPHCommandBuilder(mMenuView.getContext().getResources(),
                 FeatureConstants.FEED_HEADER_MENU_FEATURE, R.string.ntp_feed_menu_iph,
                 R.string.accessibility_ntp_feed_menu_iph)
@@ -116,8 +135,9 @@ public class SectionHeaderView extends LinearLayout implements View.OnClickListe
                                       .setCircleHighlight(true)
                                       .setShouldHighlight(true)
                                       .setDismissOnTouch(false)
-                                      .setInsetRect(new Rect(0, 0, 0, 0))
+                                      .setInsetRect(new Rect(0, -1, 0, -1))
                                       .setAutoDismissTimeout(5 * 1000)
+                                      .setViewRectProvider(rectProvider)
                                       .build());
     }
 

chrome/android/java/src/org/chromium/chrome/browser/user_education/IPHCommand.java

@@ -9,6 +9,8 @@ import android.view.View;
 
 import androidx.annotation.Nullable;
 
+import org.chromium.ui.widget.ViewRectProvider;
+
 /**
  * Class encapsulating the data needed to show in-product help (IPH).
  */
@@ -26,11 +28,12 @@ public class IPHCommand {
     public final Runnable onShowCallback;
     public final Rect insetRect;
     public final long autoDismissTimeout;
+    public final ViewRectProvider viewRectProvider;
 
     IPHCommand(String featureName, String contentString, String accessibilityText,
             boolean circleHighlight, boolean shouldHighlight, boolean dismissOnTouch,
             View anchorView, Runnable onDismissCallback, Runnable onShowCallback, Rect insetRect,
-            long autoDismissTimeout) {
+            long autoDismissTimeout, ViewRectProvider viewRectProvider) {
         this.featureName = featureName;
         this.contentString = contentString;
         this.accessibilityText = accessibilityText;
@@ -42,5 +45,6 @@ public class IPHCommand {
         this.onShowCallback = onShowCallback;
         this.insetRect = insetRect;
         this.autoDismissTimeout = autoDismissTimeout;
+        this.viewRectProvider = viewRectProvider;
     }
 }
\ No newline at end of file

chrome/android/java/src/org/chromium/chrome/browser/user_education/IPHCommandBuilder.java

@@ -12,6 +12,7 @@ import androidx.annotation.StringRes;
 
 import org.chromium.chrome.R;
 import org.chromium.components.browser_ui.widget.textbubble.TextBubble;
+import org.chromium.ui.widget.ViewRectProvider;
 
 /**
  * Builder for (@see IPHCommand.java). Use this instead of constructing an IPHCommand directly.
@@ -35,6 +36,7 @@ public class IPHCommandBuilder {
     private Runnable mOnDismissCallback;
     private Rect mInsetRect;
     private long mAutoDismissTimeout = TextBubble.NO_TIMEOUT;
+    private ViewRectProvider mViewRectProvider;
 
     /**
      * Constructor for IPHCommandBuilder when you would like your strings to be resolved for you.
@@ -140,6 +142,17 @@ public class IPHCommandBuilder {
         return this;
     }
 
+    /**
+     *
+     * @param viewRectProvider Custom ViewRectProvider to replace the default one. Note that the
+     *                         provided insets will still be applied on the rectangle from the
+     *                         custom provider.
+     */
+    public IPHCommandBuilder setViewRectProvider(ViewRectProvider viewRectProvider) {
+        mViewRectProvider = viewRectProvider;
+        return this;
+    }
+
     /**
      *
      * @return an (@see IPHCommand) containing the accumulated state of this builder.
@@ -170,6 +183,6 @@ public class IPHCommandBuilder {
 
         return new IPHCommand(mFeatureName, mContentString, mAccessibilityText, mCircleHighlight,
                 mShouldHighlight, mDismissOnTouch, mAnchorView, mOnDismissCallback, mOnShowCallback,
-                mInsetRect, mAutoDismissTimeout);
+                mInsetRect, mAutoDismissTimeout, mViewRectProvider);
     }
 }
\ No newline at end of file

chrome/android/java/src/org/chromium/chrome/browser/user_education/UserEducationHelper.java

@@ -74,7 +74,9 @@ public class UserEducationHelper {
         String accessibilityString = iphCommand.accessibilityText;
         assert (!contentString.isEmpty());
         assert (!accessibilityString.isEmpty());
-        ViewRectProvider rectProvider = new ViewRectProvider(anchorView);
+        ViewRectProvider rectProvider = iphCommand.viewRectProvider != null
+                ? iphCommand.viewRectProvider
+                : new ViewRectProvider(anchorView);
 
         TextBubble textBubble =
                 new TextBubble(mActivity, anchorView, contentString, accessibilityString, true,