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 68 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.EventConstants;
 import org.chromium.components.feature_engagement.FeatureConstants;
 import org.chromium.components.feature_engagement.Tracker;
 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 1452 matching lines @@
     public void destroy() {
         mIsInitialized = false;
         // Update the title before destroying the tab. http://b/5783092
         updateTitle();
 
         if (mTabUma != null) mTabUma.onDestroy();
 
         for (TabObserver observer : mObservers) observer.onDestroyed(this);
         mObservers.clear();
 
+        hideMediaDownloadInProductHelp();
+
         NativePage currentNativePage = mNativePage;
         mNativePage = null;
         destroyNativePageInternal(currentNativePage);
         destroyContentViewCore(true);
 
         // Destroys the native tab after destroying the ContentView but before destroying the
         // InfoBarContainer. The native tab should be destroyed before the infobar container as
         // destroying the native tab cleanups up any remaining infobars. The infobar container
         // expects all infobars to be cleaned up before its own destruction.
         assert mNativeTabAndroid != 0;
@@ skipping 1231 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
+    private void showMediaDownloadInProductHelp(int x, int y, int width, int height) {
+        // If we are not currently showing the widget, ask the tracker if we can show it.
+        if (mDownloadIPHBubble == null) {
+            Tracker tracker = TrackerFactory.getTrackerForProfile(Profile.getLastUsedProfile());
+            tracker.notifyEvent(EventConstants.MEDIA_DOWNLOAD_BUTTON_DISPLAYED);
+            if (!tracker.shouldTriggerHelpUI(FeatureConstants.MEDIA_DOWNLOAD_FEATURE)) {
+                // Inform native that the button was dismissed to notify the renderer that the
+                // request was rejected.
+                nativeMediaDownloadInProductHelpDismissed(mNativeTabAndroid);
+                return;
+            }
+
+            mDownloadIPHBubble = new TextBubble(getApplicationContext(),
+                    mContentViewCore.getContainerView(), R.string.iph_media_download_text,
+                    R.string.iph_media_download_accessibility_text);
+            mDownloadIPHBubble.setDismissOnTouchInteraction(true);

[Khushal, 2017/08/16 21:02:06]

Oh and about the user scrolling/interacting with the page. That would dismiss
the in-product-help, that logic is here. We have a listener to observer any
touch events on the window and dismisses it. 

+            mDownloadIPHBubble.addOnDismissListener(new OnDismissListener() {
+                @Override
+                public void onDismiss() {
+                    hideMediaDownloadInProductHelp();
+                }
+            });
+        }
+
+        Rect rect = new Rect(x, y, x + width, y + height);
+        mDownloadIPHBubble.setAnchorRect(rect);
+        mDownloadIPHBubble.show();
+    }
+
+    @CalledByNative
+    private void hideMediaDownloadInProductHelp() {
+        if (mDownloadIPHBubble == null) return;
+
+        mDownloadIPHBubble.dismiss();
+        mDownloadIPHBubble = null;
+        Tracker tracker = TrackerFactory.getTrackerForProfile(Profile.getLastUsedProfile());
+        tracker.dismissed(FeatureConstants.MEDIA_DOWNLOAD_FEATURE);
+        nativeMediaDownloadInProductHelpDismissed(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 14 matching lines @@
     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 void nativeClearThumbnailPlaceholder(long nativeTabAndroid);
     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 nativeMediaDownloadInProductHelpDismissed(long nativeTabAndroid);
 }