Add PageActionIconContainer interface

This CL is the start of a refactor to pull update methods for
page action icons out of the LocationBar interface and into
a PageActionIconContainer interface so that page action icons
can live outside of the location bar.

Design doc: https://docs.google.com/document/d/18HJywSmw6JiYMxFTbP496ivilPblOT8A63V12ip3ymE/

Bug: 788051
Change-Id: I2ae0e289d1e777e7bde5d0d73094dbbc60b2109a
Reviewed-on: https://chromium-review.googlesource.com/1049126Reviewed-by: Scott Violet <sky@chromium.org>
Commit-Queue: Scott Violet <sky@chromium.org>
Cr-Commit-Position: refs/heads/master@{#558378}

chrome/browser/ui/BUILD.gn

@@ -1405,6 +1405,7 @@ split_static_library("ui") {
       "omnibox/clipboard_utils.h",
       "omnibox/omnibox_theme.cc",
       "omnibox/omnibox_theme.h",
+      "page_action/page_action_icon_container.h",
       "page_info/page_info_dialog.cc",
       "page_info/page_info_dialog.h",
       "page_info/page_info_infobar_delegate.cc",
@@ -3193,6 +3194,8 @@ split_static_library("ui") {
         "views/omnibox/omnibox_view_views.h",
         "views/omnibox/rounded_omnibox_results_frame.cc",
         "views/omnibox/rounded_omnibox_results_frame.h",
+        "views/page_action/page_action_icon_container_view.cc",
+        "views/page_action/page_action_icon_container_view.h",
         "views/passwords/manage_passwords_icon_views.cc",
         "views/passwords/manage_passwords_icon_views.h",
         "views/permission_bubble/chooser_bubble_ui_views.cc",

chrome/browser/ui/browser_window.h

@@ -36,6 +36,7 @@ class ExclusiveAccessContext;
 class FindBar;
 class GURL;
 class LocationBar;
+class PageActionIconContainer;
 class StatusBubble;
 class ToolbarActionsBar;
 
@@ -164,6 +165,9 @@ class BrowserWindow : public ui::BaseWindow {
   // the TabStripModel has an active tab.
   virtual gfx::Size GetContentsSize() const = 0;
 
+  // Returns the container of page action icons.
+  virtual PageActionIconContainer* GetPageActionIconContainer() = 0;
+
   // Returns the location bar.
   virtual LocationBar* GetLocationBar() const = 0;
 

chrome/browser/ui/cocoa/browser_window_cocoa.h

@@ -81,6 +81,7 @@ class BrowserWindowCocoa
   bool ShouldHideUIForFullscreen() const override;
   bool IsFullscreen() const override;
   bool IsFullscreenBubbleVisible() const override;
+  PageActionIconContainer* GetPageActionIconContainer() override;
   LocationBar* GetLocationBar() const override;
   void SetFocusToLocationBar(bool select_all) override;
   void UpdateReloadStopState(bool is_loading, bool force) override;

chrome/browser/ui/cocoa/browser_window_cocoa.mm

@@ -402,6 +402,10 @@ bool BrowserWindowCocoa::IsFullscreenBubbleVisible() const {
   return false;  // Currently only called from toolkit-views page_info.
 }
 
+PageActionIconContainer* BrowserWindowCocoa::GetPageActionIconContainer() {
+  return [controller_ locationBarBridge];
+}
+
 LocationBar* BrowserWindowCocoa::GetLocationBar() const {
   return [controller_ locationBarBridge];
 }

chrome/browser/ui/cocoa/location_bar/location_bar_view_mac.h

@@ -16,6 +16,7 @@
 #include "chrome/browser/ui/cocoa/omnibox/omnibox_view_mac.h"
 #include "chrome/browser/ui/location_bar/location_bar.h"
 #include "chrome/browser/ui/omnibox/chrome_omnibox_edit_controller.h"
+#include "chrome/browser/ui/page_action/page_action_icon_container.h"
 #include "components/content_settings/core/common/content_settings_types.h"
 #include "components/prefs/pref_member.h"
 #include "components/security_state/core/security_state.h"
@@ -57,6 +58,7 @@ enum class PageInfoVerboseType {
 class LocationBarViewMac : public LocationBar,
                            public LocationBarTesting,
                            public ChromeOmniboxEditController,
+                           public PageActionIconContainer,
                            public zoom::ZoomEventManagerObserver {
  public:
   LocationBarViewMac(AutocompleteTextField* field,
@@ -161,6 +163,9 @@ class LocationBarViewMac : public LocationBar,
   const ToolbarModel* GetToolbarModel() const override;
   content::WebContents* GetWebContents() override;
 
+  // PageActionIconContainer:
+  void UpdatePageActionIcon(PageActionIconType) override;
+
   PageInfoVerboseType GetPageInfoVerboseType() const;
 
   // Returns true if the page info decoration should display security verbose.

chrome/browser/ui/cocoa/location_bar/location_bar_view_mac.mm

@@ -515,6 +515,12 @@ WebContents* LocationBarViewMac::GetWebContents() {
   return browser_->tab_strip_model()->GetActiveWebContents();
 }
 
+void LocationBarViewMac::UpdatePageActionIcon(PageActionIconType) {
+  // TODO(https://crbug.com/788051): Return page action icons for updating here
+  // as update methods are migrated out of LocationBar to the
+  // PageActionIconContainer interface.
+}
+
 PageInfoVerboseType LocationBarViewMac::GetPageInfoVerboseType() const {
   if (omnibox_view_->IsEditingOrEmpty() ||
       omnibox_view_->model()->is_keyword_hint()) {

chrome/browser/ui/page_action/page_action_icon_container.h

+// Copyright (c) 2018 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.
+
+#ifndef CHROME_BROWSER_UI_PAGE_ACTION_PAGE_ACTION_ICON_CONTAINER_H_
+#define CHROME_BROWSER_UI_PAGE_ACTION_PAGE_ACTION_ICON_CONTAINER_H_
+
+enum class PageActionIconType {
+  // TODO(https://crbug.com/788051): Migrate page action icon update methods out
+  // of LocationBar to this interface.
+};
+
+class PageActionIconContainer {
+ public:
+  // Signals a page action icon to update its visual state if it is present in
+  // the browser window.
+  virtual void UpdatePageActionIcon(PageActionIconType type) = 0;
+};
+
+#endif  // CHROME_BROWSER_UI_PAGE_ACTION_PAGE_ACTION_ICON_CONTAINER_H_

chrome/browser/ui/views/frame/browser_view.cc

@@ -83,6 +83,7 @@
 #include "chrome/browser/ui/views/location_bar/location_bar_view.h"
 #include "chrome/browser/ui/views/location_bar/star_view.h"
 #include "chrome/browser/ui/views/omnibox/omnibox_view_views.h"
+#include "chrome/browser/ui/views/page_action/page_action_icon_container_view.h"
 #include "chrome/browser/ui/views/profiles/profile_indicator_icon.h"
 #include "chrome/browser/ui/views/status_bubble_views.h"
 #include "chrome/browser/ui/views/tab_contents/chrome_web_contents_view_focus_helper.h"
@@ -966,6 +967,10 @@ void BrowserView::SetToolbarButtonProvider(ToolbarButtonProvider* provider) {
   toolbar_button_provider_ = provider;
 }
 
+PageActionIconContainer* BrowserView::GetPageActionIconContainer() {
+  return toolbar_button_provider_->GetPageActionIconContainerView();
+}
+
 LocationBar* BrowserView::GetLocationBar() const {
   return GetLocationBarView();
 }

chrome/browser/ui/views/frame/browser_view.h

@@ -314,6 +314,7 @@ class BrowserView : public BrowserWindow,
   bool ShouldHideUIForFullscreen() const override;
   bool IsFullscreen() const override;
   bool IsFullscreenBubbleVisible() const override;
+  PageActionIconContainer* GetPageActionIconContainer() override;
   LocationBar* GetLocationBar() const override;
   void SetFocusToLocationBar(bool select_all) override;
   void UpdateReloadStopState(bool is_loading, bool force) override;

chrome/browser/ui/views/frame/hosted_app_button_container.cc

@@ -10,6 +10,7 @@
 #include "chrome/browser/ui/views/frame/browser_view.h"
 #include "chrome/browser/ui/views/frame/hosted_app_menu_button.h"
 #include "chrome/browser/ui/views/location_bar/content_setting_image_view.h"
+#include "chrome/browser/ui/views/page_action/page_action_icon_container_view.h"
 #include "chrome/browser/ui/views/toolbar/browser_actions_container.h"
 #include "ui/compositor/layer_animation_element.h"
 #include "ui/compositor/layer_animation_sequence.h"
@@ -192,6 +193,9 @@ HostedAppButtonContainer::HostedAppButtonContainer(BrowserView* browser_view,
   content_settings_container_ = content_settings_container.get();
   AddChildView(content_settings_container.release());
 
+  page_action_icon_container_view_ = new PageActionIconContainerView();
+  AddChildView(page_action_icon_container_view_);
+
   AddChildView(browser_actions_container_);
 
   app_menu_button_->SetIconColor(active_icon_color);
@@ -295,6 +299,11 @@ HostedAppButtonContainer::GetBrowserActionsContainer() {
   return browser_actions_container_;
 }
 
+PageActionIconContainerView*
+HostedAppButtonContainer::GetPageActionIconContainerView() {
+  return page_action_icon_container_view_;
+}
+
 AppMenuButton* HostedAppButtonContainer::GetAppMenuButton() {
   return app_menu_button_;
 }

chrome/browser/ui/views/frame/hosted_app_button_container.h

@@ -81,6 +81,7 @@ class HostedAppButtonContainer : public views::AccessiblePaneView,
 
   // ToolbarButtonProvider:
   BrowserActionsContainer* GetBrowserActionsContainer() override;
+  PageActionIconContainerView* GetPageActionIconContainerView() override;
   AppMenuButton* GetAppMenuButton() override;
   void FocusToolbar() override;
   views::AccessiblePaneView* GetAsAccessiblePaneView() override;
@@ -99,9 +100,10 @@ class HostedAppButtonContainer : public views::AccessiblePaneView,
   base::OneShotTimer fade_in_content_setting_buttons_timer_;
 
   // Owned by the views hierarchy.
-  HostedAppMenuButton* app_menu_button_;
-  ContentSettingsContainer* content_settings_container_;
-  BrowserActionsContainer* browser_actions_container_;
+  HostedAppMenuButton* app_menu_button_ = nullptr;
+  ContentSettingsContainer* content_settings_container_ = nullptr;
+  PageActionIconContainerView* page_action_icon_container_view_ = nullptr;
+  BrowserActionsContainer* browser_actions_container_ = nullptr;
 
   base::OneShotTimer opening_animation_timer_;
 

chrome/browser/ui/views/frame/toolbar_button_provider.h

@@ -7,6 +7,7 @@
 
 class AppMenuButton;
 class BrowserActionsContainer;
+class PageActionIconContainerView;
 
 namespace views {
 class AccessiblePaneView;
@@ -19,6 +20,9 @@ class ToolbarButtonProvider {
   // Gets the browser actions container.
   virtual BrowserActionsContainer* GetBrowserActionsContainer() = 0;
 
+  // Gets the page action icon container.
+  virtual PageActionIconContainerView* GetPageActionIconContainerView() = 0;
+
   // Gets the app menu button.
   virtual AppMenuButton* GetAppMenuButton() = 0;
 

chrome/browser/ui/views/location_bar/location_bar_view.cc

@@ -56,6 +56,7 @@
 #include "chrome/browser/ui/views/location_bar/star_view.h"
 #include "chrome/browser/ui/views/location_bar/zoom_bubble_view.h"
 #include "chrome/browser/ui/views/location_bar/zoom_view.h"
+#include "chrome/browser/ui/views/page_action/page_action_icon_container_view.h"
 #include "chrome/browser/ui/views/page_info/page_info_bubble_view.h"
 #include "chrome/browser/ui/views/passwords/manage_passwords_icon_views.h"
 #include "chrome/browser/ui/views/translate/translate_bubble_view.h"
@@ -275,6 +276,9 @@ void LocationBarView::Init() {
                   AddChildView(icon_view);
                 });
 
+  page_action_icon_container_view_ = new PageActionIconContainerView();
+  AddChildView(page_action_icon_container_view_);
+
   clear_all_button_ = views::CreateVectorImageButton(this);
   clear_all_button_->SetTooltipText(
       l10n_util::GetStringUTF16(IDS_OMNIBOX_CLEAR_ALL));

chrome/browser/ui/views/location_bar/location_bar_view.h

@@ -17,6 +17,7 @@
 #include "chrome/browser/extensions/extension_context_menu_model.h"
 #include "chrome/browser/ui/location_bar/location_bar.h"
 #include "chrome/browser/ui/omnibox/chrome_omnibox_edit_controller.h"
+#include "chrome/browser/ui/page_action/page_action_icon_container.h"
 #include "chrome/browser/ui/views/dropdown_bar_host.h"
 #include "chrome/browser/ui/views/dropdown_bar_host_delegate.h"
 #include "chrome/browser/ui/views/extensions/extension_popup.h"
@@ -50,6 +51,7 @@ class SelectedKeywordView;
 class StarView;
 class TranslateIconView;
 class ZoomView;
+class PageActionIconContainerView;
 
 namespace autofill {
 class SaveCardIconView;
@@ -173,6 +175,10 @@ class LocationBarView : public LocationBar,
   // The translate icon. It may not be visible.
   TranslateIconView* translate_icon_view() { return translate_icon_view_; }
 
+  PageActionIconContainerView* page_action_icon_container_view() {
+    return page_action_icon_container_view_;
+  }
+
   // Returns the screen coordinates of the omnibox (where the URL text appears,
   // not where the icons are shown).
   gfx::Point GetOmniboxViewOrigin() const;
@@ -477,6 +483,8 @@ class LocationBarView : public LocationBar,
   // A list of all bubble descendants ordered by focus.
   std::vector<BubbleIconView*> bubble_icons_;
 
+  PageActionIconContainerView* page_action_icon_container_view_ = nullptr;
+
   // The security level when the location bar was last updated. Used to decide
   // whether to animate security level transitions.
   security_state::SecurityLevel last_update_security_level_ =

chrome/browser/ui/views/page_action/page_action_icon_container_view.cc

+// Copyright (c) 2018 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.
+
+#include "chrome/browser/ui/views/page_action/page_action_icon_container_view.h"
+
+void PageActionIconContainerView::UpdatePageActionIcon(PageActionIconType) {
+  // TODO(https://crbug.com/788051): Update page action icons here as update
+  // methods are migrated out of LocationBar to the PageActionIconContainer
+  // interface.
+}

chrome/browser/ui/views/page_action/page_action_icon_container_view.h

+// Copyright (c) 2018 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.
+
+#ifndef CHROME_BROWSER_UI_VIEWS_PAGE_ACTION_PAGE_ACTION_ICON_CONTAINER_VIEW_H_
+#define CHROME_BROWSER_UI_VIEWS_PAGE_ACTION_PAGE_ACTION_ICON_CONTAINER_VIEW_H_
+
+#include "chrome/browser/ui/page_action/page_action_icon_container.h"
+#include "ui/views/view.h"
+
+class PageActionIconContainerView : public views::View,
+                                    public PageActionIconContainer {
+ public:
+  PageActionIconContainerView() {}
+
+ private:
+  // PageActionIconContainer:
+  void UpdatePageActionIcon(PageActionIconType type) override;
+};
+
+#endif  // CHROME_BROWSER_UI_VIEWS_PAGE_ACTION_PAGE_ACTION_ICON_CONTAINER_VIEW_H_

chrome/browser/ui/views/toolbar/toolbar_view.cc

@@ -687,6 +687,10 @@ BrowserActionsContainer* ToolbarView::GetBrowserActionsContainer() {
   return browser_actions_;
 }
 
+PageActionIconContainerView* ToolbarView::GetPageActionIconContainerView() {
+  return location_bar_->page_action_icon_container_view();
+}
+
 AppMenuButton* ToolbarView::GetAppMenuButton() {
   return app_menu_button_;
 }

chrome/browser/ui/views/toolbar/toolbar_view.h

@@ -187,6 +187,7 @@ class ToolbarView : public views::AccessiblePaneView,
 
   // ToolbarButtonProvider:
   BrowserActionsContainer* GetBrowserActionsContainer() override;
+  PageActionIconContainerView* GetPageActionIconContainerView() override;
   AppMenuButton* GetAppMenuButton() override;
   void FocusToolbar() override;
   views::AccessiblePaneView* GetAsAccessiblePaneView() override;

chrome/test/base/test_browser_window.cc

@@ -115,6 +115,10 @@ LocationBar* TestBrowserWindow::GetLocationBar() const {
   return const_cast<TestLocationBar*>(&location_bar_);
 }
 
+PageActionIconContainer* TestBrowserWindow::GetPageActionIconContainer() {
+  return nullptr;
+}
+
 ToolbarActionsBar* TestBrowserWindow::GetToolbarActionsBar() {
   return nullptr;
 }

chrome/test/base/test_browser_window.h

@@ -13,6 +13,7 @@
 #include "chrome/browser/ui/browser_dialogs.h"
 #include "chrome/browser/ui/browser_window.h"
 #include "chrome/browser/ui/location_bar/location_bar.h"
+#include "chrome/browser/ui/page_action/page_action_icon_container.h"
 #include "chrome/common/buildflags.h"
 
 #if defined(OS_CHROMEOS)
@@ -74,6 +75,7 @@ class TestBrowserWindow : public BrowserWindow {
   bool IsFullscreen() const override;
   bool IsFullscreenBubbleVisible() const override;
   LocationBar* GetLocationBar() const override;
+  PageActionIconContainer* GetPageActionIconContainer() override;
   void SetFocusToLocationBar(bool select_all) override {}
   void UpdateReloadStopState(bool is_loading, bool force) override {}
   void UpdateToolbar(content::WebContents* contents) override {}