[Views] Update ink drop for omnibox icons

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

 // Copyright (c) 2012 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_LOCATION_BAR_ICON_LABEL_BUBBLE_VIEW_H_
 #define CHROME_BROWSER_UI_VIEWS_LOCATION_BAR_ICON_LABEL_BUBBLE_VIEW_H_
 
 #include <string>
 
 #include "base/macros.h"
 #include "base/strings/string16.h"
 #include "ui/gfx/geometry/insets.h"
 #include "ui/gfx/geometry/size.h"
 #include "ui/views/animation/ink_drop_host_view.h"
+#include "ui/views/animation/ink_drop_observer.h"
+#include "ui/views/controls/button/custom_button.h"
 #include "ui/views/controls/label.h"
+#include "ui/views/widget/widget_observer.h"
 
 namespace gfx {
-class Canvas;
 class FontList;
 class ImageSkia;
 }
 
 namespace views {
 class ImageView;
-class Label;
+class InkDropContainerView;
+class InkDropMask;
 }
 
 // View used to draw a bubble, containing an icon and a label. We use this as a
 // base for the classes that handle the location icon (including the EV bubble),
 // tab-to-search UI, and content settings.
-class IconLabelBubbleView : public views::InkDropHostView {
+class IconLabelBubbleView : public views::InkDropObserver,
+                            public views::CustomButton,
+                            public views::ButtonListener,
+                            public views::WidgetObserver {
  public:
   static constexpr int kTrailingPaddingPreMd = 2;
 
   IconLabelBubbleView(const gfx::FontList& font_list, bool elide_in_middle);
   ~IconLabelBubbleView() override;
 
+  // views::InkDropObserver:
+  void InkDropAnimationStarted() override;
+
+  // views::ButtonListener:
+  void ButtonPressed(Button* sender, const ui::Event& event) override;
+
   void SetLabel(const base::string16& label);
   void SetImage(const gfx::ImageSkia& image);
 
   const views::ImageView* GetImageView() const { return image_; }
   views::ImageView* GetImageView() { return image_; }
 
  protected:
   static constexpr int kOpenTimeMS = 150;
 
   views::ImageView* image() { return image_; }
@@ skipping 16 matching lines @@
   // full-width view and can be used to animate the width of the view.
   virtual double WidthMultiplier() const;
 
   // Returns true when animation is in progress and is shrinking.
   virtual bool IsShrinking() const;
 
   // The view has been activated by a user gesture such as spacebar. Returns
   // true if some handling was performed.
   virtual bool OnActivate(const ui::Event& event);
 
+  // Returns true if the bubble anchored to the icon is shown. This is to
+  // prevent the bubble from reshowing on a mouse release.
+  virtual bool IsBubbleShown() const;
+
   // views::InkDropHostView:
   gfx::Size GetPreferredSize() const override;
   void Layout() override;
+  void OnBoundsChanged(const gfx::Rect& previous_bounds) override;
+  bool OnMousePressed(const ui::MouseEvent& event) override;
+
+  // void OnMouseReleased(const ui::MouseEvent& event) override;
   bool OnKeyPressed(const ui::KeyEvent& event) override;
   bool OnKeyReleased(const ui::KeyEvent& event) override;
   void GetAccessibleNodeData(ui::AXNodeData* node_data) override;
   void OnNativeThemeChanged(const ui::NativeTheme* native_theme) override;
   void AddInkDropLayer(ui::Layer* ink_drop_layer) override;
   void RemoveInkDropLayer(ui::Layer* ink_drop_layer) override;
+  std::unique_ptr<views::InkDrop> CreateInkDrop() override;
   std::unique_ptr<views::InkDropHighlight> CreateInkDropHighlight()
       const override;
+  std::unique_ptr<views::InkDropRipple> CreateInkDropRipple() const override;
+  std::unique_ptr<views::InkDropMask> CreateInkDropMask() const override;
   SkColor GetInkDropBaseColor() const override;
 
+  // views::CustomButton:
+  bool IsTriggerableEvent(const ui::Event& event) override;
+  void OnClickCanceled(const ui::Event& event) override;
+
+  // views::WidgetObserver:
+  void OnWidgetDestroying(views::Widget* widget) override;
+  void OnWidgetVisibilityChanged(views::Widget* widget, bool visible) override;
+
   const gfx::FontList& font_list() const { return label_->font_list(); }
 
   SkColor GetParentBackgroundColor() const;
 
   gfx::Size GetSizeForLabelWidth(int label_width) const;
 
  private:
+  // A view that draws the separator.
+  class SeparatorView : public views::View {
+   public:
+    explicit SeparatorView(IconLabelBubbleView* owner);
+
+    // views::View:
+    void OnPaint(gfx::Canvas* canvas) override;
+    bool CanProcessEventsWithinSubtree() const override;
+
+    // Updates the opacity based on the ink drop's state.
+    void UpdateOpacity();
+
+   private:
+    // Weak.
+    IconLabelBubbleView* owner_;
+  };
+
   // Amount of padding from the leading edge of the view to the leading edge of
   // the image, and from the trailing edge of the label (or image, if the label
   // is invisible) to the trailing edge of the view.
   int GetOuterPadding() const;
 
   // Spacing between the image and the label.
   int GetInternalSpacing() const;
 
   // Padding after the separator.
   int GetPostSeparatorPadding() const;
 
   float GetScaleFactor() const;
 
   // views::View:
   const char* GetClassName() const override;
-  void OnPaint(gfx::Canvas* canvas) override;
 
   // The contents of the bubble.
   views::ImageView* image_;
   views::Label* label_;
+  views::InkDropContainerView* ink_drop_container_;
+  std::unique_ptr<views::InkDropMask> ink_drop_mask_;
+  std::unique_ptr<SeparatorView> separator_view_;
 
   // The padding of the element that will be displayed after |this|. This value
   // is relevant for calculating the amount of space to reserve after the
   // separator.
   int next_element_interior_padding_ = 0;
 
+  // This is used to check if the bubble was showing during the mouse pressed
+  // event. If this is true then the OnButtonPressed() call is ignored to
+  // prevent the bubble from reshowing. This flag is necessary because
+  // OnButtonPressed() is called during the mouse released event.
+  bool suppress_button_action_;

[bruthig, 2017/03/22 17:20:16]

Instead of manually tracking this, would it be possible to configure the
CustomButton to NOTIFY_ON_PRESS instead?

[spqchan, 2017/03/24 17:58:03]

The expected behavior is to notify on release, especially since it's possible to
drag and drop the icon.

[bruthig, 2017/03/24 20:48:02]

Right, I guess it just seems odd that this needs to be manually tracked.  Why
isn't it sufficient to check IsBubbleShown() instead of
|suppress_button_action_|?  And why is ButtonPressed() even getting called if
IsTriggerable() overrides should be returning false?
And this makes me wonder how the bubbles are being dismissed and closed?

[spqchan, 2017/03/27 23:41:51]

I added a comment that explains this and modified the code so it's more clear.

We need this flag because the bubble gets dismissed on MouseReleased before
IsTriggerable() for the Mouse Released event got called. I changed it so that
instead of suppress_button_action, we'll have suppress_button_release.
IsTriggerable() will return !IsBubbleShown() && !suppress_button_release.

+
   DISALLOW_COPY_AND_ASSIGN(IconLabelBubbleView);
 };
 
 #endif  // CHROME_BROWSER_UI_VIEWS_LOCATION_BAR_ICON_LABEL_BUBBLE_VIEW_H_