chrome/blink: Add functionality for in-product help for media elements.

chrome/android/java/src/org/chromium/chrome/browser/tab/Tab.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.tab;
 
 import android.annotation.SuppressLint;
 import android.app.Activity;
 import android.app.Application;
 import android.content.Context;
@@ skipping 69 matching lines @@
 import org.chromium.chrome.browser.tab.TabUma.TabCreationState;
 import org.chromium.chrome.browser.tabmodel.AsyncTabParamsManager;
 import org.chromium.chrome.browser.tabmodel.TabModel;
 import org.chromium.chrome.browser.tabmodel.TabModel.TabLaunchType;
 import org.chromium.chrome.browser.tabmodel.TabModel.TabSelectionType;
 import org.chromium.chrome.browser.tabmodel.TabModelImpl;
 import org.chromium.chrome.browser.tabmodel.TabModelSelector;
 import org.chromium.chrome.browser.tabmodel.TabReparentingParams;
 import org.chromium.chrome.browser.util.ColorUtils;
 import org.chromium.chrome.browser.util.FeatureUtilities;
+import org.chromium.chrome.browser.widget.textbubble.TextBubble;
 import org.chromium.chrome.browser.widget.textbubble.ViewAnchoredTextBubble;
 import org.chromium.components.dom_distiller.core.DomDistillerUrlUtils;
 import org.chromium.components.feature_engagement_tracker.EventConstants;
 import org.chromium.components.feature_engagement_tracker.FeatureConstants;
 import org.chromium.components.feature_engagement_tracker.FeatureEngagementTracker;
 import org.chromium.components.navigation_interception.InterceptNavigationDelegate;
 import org.chromium.components.security_state.ConnectionSecurityLevel;
 import org.chromium.components.sync.SyncConstants;
 import org.chromium.content.browser.ContentView;
 import org.chromium.content.browser.ContentViewCore;
@@ skipping 275 matching lines @@
      * widely used the data saver feature is for a particular user at a time (i.e. not since the
      * user started using Chrome).
      */
     private long mDataSavedOnStartPageLoad;
 
     private final int mDefaultThemeColor;
     private int mThemeColor;
 
     private ChromeDownloadDelegate mDownloadDelegate;
 
+    /**
+     * The Text bubble used to display In Product help widget for download feature on videos.
+     */
+    private TextBubble mDownloadIPHBubble;
+
     /** Whether or not the tab closing the tab can send the user back to the app that opened it. */
     private boolean mIsAllowedToReturnToExternalApp;
 
     private GestureStateListener createGestureStateListener() {
         return new GestureStateListener() {
             @Override
             public void onFlingStartGesture(int scrollOffsetY, int scrollExtentY) {
                 onScrollingStateChanged();
             }
 
@@ skipping 2702 matching lines @@
 
     /**
      * Configures web preferences for viewing downloaded media.
      * @param enabled Whether embedded media experience should be enabled.
      */
     public void enableEmbeddedMediaExperience(boolean enabled) {
         if (mNativeTabAndroid == 0) return;
         nativeEnableEmbeddedMediaExperience(mNativeTabAndroid, enabled);
     }
 
+    @CalledByNative
+    public void showMediaDownloadInProductHelp(int x, int y, int width, int height) {

[nyquist, 2017/06/29 02:10:23]

Nit: Could this and the method below be private?

[Khushal, 2017/07/07 04:18:14]

Done.

+        // If we are not currently showing the widget, ask the tracker if we can show it.
+        if (mDownloadIPHBubble == null) {
+            FeatureEngagementTracker tracker =
+                    FeatureEngagementTrackerFactory.getFeatureEngagementTrackerForProfile(
+                            getProfile());
+            tracker.notifyEvent(EventConstants.MEDIA_DOWNLOAD_BUTTON_DISPLAYED);
+            if (tracker.shouldTriggerHelpUI(FeatureConstants.MEDIA_DOWNLOAD_FEATURE)) {
+                mDownloadIPHBubble = new TextBubble(getApplicationContext(),
+                        mContentViewCore.getContainerView(), R.string.iph_media_download_text,
+                        R.string.iph_media_download_accessibility_text);
+                mDownloadIPHBubble.show();

[nyquist, 2017/06/29 02:10:23]

Optional nit: It's probably just me, but it feels weird when this isn't the last
line...

[Khushal, 2017/07/07 04:18:14]

Done.

+                mDownloadIPHBubble.setDismissOnTouchInteraction(true);
+                mDownloadIPHBubble.addOnDismissListener(new OnDismissListener() {
+                    @Override
+                    public void onDismiss() {
+                        hideMediaDownloadInProductHelp();
+                    }
+                });
+            } else {
+                // Inform native that the button was dismissed to notify the renderer that the
+                // request was rejected.
+                nativeDownloadMediaInProductHelpDismissed(mNativeTabAndroid);

[nyquist, 2017/06/29 02:10:23]

Note to self, this is in the same callstack as show

+                return;
+            }
+        }
+
+        Rect rect = new Rect(x, y, x + width, y + height);
+        mDownloadIPHBubble.setAnchorRect(rect);
+    }
+
+    @CalledByNative
+    public void hideMediaDownloadInProductHelp() {
+        if (mDownloadIPHBubble == null) return;
+
+        mDownloadIPHBubble.dismiss();
+        mDownloadIPHBubble = null;
+        FeatureEngagementTracker tracker =
+                FeatureEngagementTrackerFactory.getFeatureEngagementTrackerForProfile(getProfile());
+        tracker.dismissed(FeatureConstants.MEDIA_DOWNLOAD_FEATURE);
+        nativeDownloadMediaInProductHelpDismissed(mNativeTabAndroid);
+    }
+
     private native void nativeInit();
     private native void nativeDestroy(long nativeTabAndroid);
     private native void nativeInitWebContents(long nativeTabAndroid, boolean incognito,
             boolean isBackgroundTab, WebContents webContents,
             TabWebContentsDelegateAndroid delegate, ContextMenuPopulator contextMenuPopulator);
     private native void nativeUpdateDelegates(long nativeTabAndroid,
             TabWebContentsDelegateAndroid delegate, ContextMenuPopulator contextMenuPopulator);
     private native void nativeDestroyWebContents(long nativeTabAndroid, boolean deleteNative);
     private native void nativeOnPhysicalBackingSizeChanged(
             long nativeTabAndroid, WebContents webContents, int width, int height);
@@ skipping 12 matching lines @@
     private native void nativeLoadOriginalImage(long nativeTabAndroid);
     private native long nativeGetBookmarkId(long nativeTabAndroid, boolean onlyEditable);
     private native void nativeSetInterceptNavigationDelegate(long nativeTabAndroid,
             InterceptNavigationDelegate delegate);
     private native void nativeAttachToTabContentManager(long nativeTabAndroid,
             TabContentManager tabContentManager);
     private native boolean nativeHasPrerenderedUrl(long nativeTabAndroid, String url);
     private native void nativeSetWebappManifestScope(long nativeTabAndroid, String scope);
     private native void nativeEnableEmbeddedMediaExperience(long nativeTabAndroid, boolean enabled);
     private native void nativeAttachDetachedTab(long nativeTabAndroid);
+    private native void nativeDownloadMediaInProductHelpDismissed(long nativeTabAndroid);
 }