Tab obscuring no longer requires access to BottomSheet view

The setIsObscuringAllTabs API on BottomSheetController was originally
necessary because the TabObscuringHandler needed access to the view
being obscured. The handler has changed such that is is now token based
and therefore no longer needs to be an API on the controller.

Bug: 100227
Change-Id: Iff028b627833ceaa4cdd424c6e5305dde7b4dfd0
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2212512
Commit-Queue: Matthew Jones <mdjones@chromium.org>
Reviewed-by: Sandro Maggi <sandromaggi@google.com>
Reviewed-by: Theresa  <twellington@chromium.org>
Cr-Commit-Position: refs/heads/master@{#773309}

chrome/android/features/autofill_assistant/java/src/org/chromium/chrome/browser/autofill_assistant/AssistantBottomBarCoordinator.java

@@ -40,6 +40,7 @@ import org.chromium.components.browser_ui.bottomsheet.BottomSheetContent;
 import org.chromium.content_public.browser.UiThreadTaskTraits;
 import org.chromium.content_public.browser.WebContents;
 import org.chromium.ui.base.ApplicationViewportInsetSupplier;
+import org.chromium.ui.util.TokenHolder;
 
 /**
  * Coordinator responsible for the Autofill Assistant bottom bar.
@@ -88,6 +89,9 @@ class AssistantBottomBarCoordinator implements AssistantPeekHeightCoordinator.De
     @AssistantViewportMode
     private int mTargetViewportMode = AssistantViewportMode.NO_RESIZE;
 
+    /** A token held while the assistant is obscuring all tabs. */
+    private int mObscuringToken;
+
     AssistantBottomBarCoordinator(Activity activity, AssistantModel model,
             BottomSheetController controller,
             ApplicationViewportInsetSupplier applicationViewportInsetSupplier,
@@ -205,8 +209,12 @@ class AssistantBottomBarCoordinator implements AssistantPeekHeightCoordinator.De
                     hide();
                 }
             } else if (AssistantModel.ALLOW_TALKBACK_ON_WEBSITE == propertyKey) {
-                controller.setIsObscuringAllTabs(
-                        tabObscuringHandler, !model.get(AssistantModel.ALLOW_TALKBACK_ON_WEBSITE));
+                if (!model.get(AssistantModel.ALLOW_TALKBACK_ON_WEBSITE)) {
+                    mObscuringToken = tabObscuringHandler.obscureAllTabs();
+                } else {
+                    tabObscuringHandler.unobscureAllTabs(mObscuringToken);
+                    mObscuringToken = TokenHolder.INVALID_TOKEN;
+                }
             } else if (AssistantModel.WEB_CONTENTS == propertyKey) {
                 mWebContents = model.get(AssistantModel.WEB_CONTENTS);
             } else if (AssistantModel.TALKBACK_SHEET_SIZE_FRACTION == propertyKey) {
@@ -297,8 +305,8 @@ class AssistantBottomBarCoordinator implements AssistantPeekHeightCoordinator.De
         mWindowApplicationInsetSupplier.removeSupplier(mInsetSupplier);
         AccessibilityUtil.removeObserver(mAccessibilityObserver);
 
-        if (!mModel.get(AssistantModel.ALLOW_TALKBACK_ON_WEBSITE)) {
-            mBottomSheetController.setIsObscuringAllTabs(mTabObscuringHandler, false);
+        if (mObscuringToken != TokenHolder.INVALID_TOKEN) {
+            mTabObscuringHandler.unobscureAllTabs(mObscuringToken);
         }
 
         mInfoBoxCoordinator.destroy();

chrome/android/java/src/org/chromium/chrome/browser/ui/BottomSheetManager.java

@@ -42,6 +42,9 @@ class BottomSheetManager extends EmptyBottomSheetObserver implements Destroyable
     /** A delegate that provides the functionality of obscuring all tabs. */
     private TabObscuringHandler mTabObscuringHandler;
 
+    /** A token held while the bottom sheet is obscuring all visible tabs. */
+    private int mTabObscuringToken;
+
     /**
      * Used to track whether the active content has a custom scrim lifecycle. This is kept here
      * because there are some instances where the active content is changed prior to the close event
@@ -58,6 +61,7 @@ class BottomSheetManager extends EmptyBottomSheetObserver implements Destroyable
         mDialogManager = dialogManager;
         mSnackbarManager = snackbarManagerSupplier;
         mTabObscuringHandler = obscuringDelegate;
+        mTabObscuringToken = TokenHolder.INVALID_TOKEN;
 
         mSheetController.addObserver(this);
     }
@@ -80,7 +84,7 @@ class BottomSheetManager extends EmptyBottomSheetObserver implements Destroyable
             return;
         }
 
-        mSheetController.setIsObscuringAllTabs(mTabObscuringHandler, true);
+        setIsObscuringAllTabs(true);
 
         assert mAppModalToken == TokenHolder.INVALID_TOKEN;
         assert mTabModalToken == TokenHolder.INVALID_TOKEN;
@@ -101,7 +105,7 @@ class BottomSheetManager extends EmptyBottomSheetObserver implements Destroyable
             return;
         }
 
-        mSheetController.setIsObscuringAllTabs(mTabObscuringHandler, false);
+        setIsObscuringAllTabs(false);
 
         // Tokens can be invalid if the sheet has a custom lifecycle.
         if (mDialogManager.get() != null
@@ -117,6 +121,20 @@ class BottomSheetManager extends EmptyBottomSheetObserver implements Destroyable
         mTabModalToken = TokenHolder.INVALID_TOKEN;
     }
 
+    /**
+     * Set whether the bottom sheet is obscuring all tabs.
+     * @param isObscuring Whether the bottom sheet is considered to be obscuring.
+     */
+    private void setIsObscuringAllTabs(boolean isObscuring) {
+        if (isObscuring) {
+            assert mTabObscuringToken == TokenHolder.INVALID_TOKEN;
+            mTabObscuringToken = mTabObscuringHandler.obscureAllTabs();
+        } else {
+            mTabObscuringHandler.unobscureAllTabs(mTabObscuringToken);
+            mTabObscuringToken = TokenHolder.INVALID_TOKEN;
+        }
+    }
+
     @Override
     public void onSheetOffsetChanged(float heightFraction, float offsetPx) {
         if (mSnackbarManager.get() == null) return;

chrome/android/java/src/org/chromium/chrome/browser/widget/bottomsheet/BottomSheetController.java

@@ -26,7 +26,6 @@ import org.chromium.chrome.browser.lifecycle.Destroyable;
 import org.chromium.chrome.browser.tab.EmptyTabObserver;
 import org.chromium.chrome.browser.tab.Tab;
 import org.chromium.chrome.browser.tab.TabObserver;
-import org.chromium.chrome.browser.ui.TabObscuringHandler;
 import org.chromium.chrome.browser.vr.VrModuleProvider;
 import org.chromium.chrome.browser.widget.ScrimView.ScrimObserver;
 import org.chromium.chrome.browser.widget.ScrimView.ScrimParams;
@@ -35,7 +34,6 @@ import org.chromium.components.browser_ui.widget.scrim.ScrimCoordinator;
 import org.chromium.components.browser_ui.widget.scrim.ScrimProperties;
 import org.chromium.ui.KeyboardVisibilityDelegate;
 import org.chromium.ui.modelutil.PropertyModel;
-import org.chromium.ui.util.TokenHolder;
 import org.chromium.ui.vr.VrModeObserver;
 
 import java.lang.annotation.Retention;
@@ -164,9 +162,6 @@ public class BottomSheetController implements Destroyable {
      */
     private List<BottomSheetObserver> mPendingSheetObservers;
 
-    /** A token held while the bottom sheet is obscuring all visible tabs. */
-    private int mTabObscuringToken;
-
     /** The state of the sheet so it can be returned to what it was prior to suppression. */
     @SheetState
     private int mSheetStateBeforeSuppress;
@@ -196,7 +191,6 @@ public class BottomSheetController implements Destroyable {
         mBrowserControlsStateProvider = fullscreenManager;
         mFullscreenManager = fullscreenManager;
         mPendingSheetObservers = new ArrayList<>();
-        mTabObscuringToken = TokenHolder.INVALID_TOKEN;
 
         mPendingSheetObservers.add(new EmptyBottomSheetObserver() {
             /** The token used to enable browser controls persistence. */
@@ -517,21 +511,6 @@ public class BottomSheetController implements Destroyable {
         return mToolbarShadowHeight + mShadowTopOffset;
     }
 
-    /**
-     * Set whether the bottom sheet is obscuring all tabs.
-     * @param obscuringHandler A handler that provides the functionality of obscuring all tabs.
-     * @param isObscuring Whether the bottom sheet is considered to be obscuring.
-     */
-    public void setIsObscuringAllTabs(TabObscuringHandler obscuringHandler, boolean isObscuring) {
-        if (isObscuring) {
-            assert mTabObscuringToken == TokenHolder.INVALID_TOKEN;
-            mTabObscuringToken = obscuringHandler.obscureAllTabs();
-        } else {
-            obscuringHandler.unobscureAllTabs(mTabObscuringToken);
-            mTabObscuringToken = TokenHolder.INVALID_TOKEN;
-        }
-    }
-
     /**
      * @param observer The observer to add.
      */