[ash-md] Added different highlighting modes to the InkDropImpl.

ui/views/animation/ink_drop_impl.h

 // Copyright 2015 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 UI_VIEWS_ANIMATION_INK_DROP_IMPL_H_
 #define UI_VIEWS_ANIMATION_INK_DROP_IMPL_H_
 
 #include <memory>
 
 #include "base/macros.h"
 #include "ui/gfx/geometry/rect.h"
 #include "ui/gfx/geometry/size.h"
 #include "ui/views/animation/ink_drop.h"
 #include "ui/views/animation/ink_drop_highlight_observer.h"
 #include "ui/views/animation/ink_drop_ripple_observer.h"
 #include "ui/views/views_export.h"
 
-namespace base {
-class Timer;
-}  // namespace base
-
 namespace views {
 namespace test {
 class InkDropImplTestApi;
 }  // namespace test
 
 class InkDropRipple;
 class InkDropHost;
 class InkDropHighlight;
 class InkDropFactoryTest;
 
 // A functional implementation of an InkDrop.
 class VIEWS_EXPORT InkDropImpl : public InkDrop,
                                  public InkDropRippleObserver,
                                  public InkDropHighlightObserver {
  public:
+  // The different auto highlight behaviors.
+  enum class AutoHighlightMode {
+    // No auto-highlighting is done. The highlight will only be shown/hidden as
+    // per the hover/focus settings.
+    NONE,
+    // The highlight will be hidden when a ripple becomes visible. After the
+    // ripple is hidden the highlight will be made visible again if the
+    // hover/focus settings deem it should be.
+    HIDE_ON_RIPPLE,
+    // The highlight is made visible when the ripple becomes visible. After the
+    // ripple is hidden the highlight will be hidden again if the hover/focus
+    // settings deem it should be.
+    SHOW_ON_RIPPLE,
+  };
+
   // Constructs an ink drop that will attach the ink drop to the given
   // |ink_drop_host|.
   explicit InkDropImpl(InkDropHost* ink_drop_host);
   ~InkDropImpl() override;
 
+  void SetShowHighlightOnHover(bool show_highlight_on_hover);

[sky, 2016/11/02 02:52:11]

Do these need to change once a button is created? Could the configuration be
passed into the constructor?

[bruthig, 2016/11/04 18:50:37]

Not currently, but having them as configuration methods allows clients to create
a base prototype and update the few things that it wants to be different.  For
example see ToolbarActionView::CreateInkDrop().

+
+  void SetShowHighlightOnFocus(bool show_highlight_on_focus);
+
+  // Auto highlighting is a mechanism to show/hide the highlight based on the
+  // visibility of the ripple. See the documentation of the AutoHighlightMode
+  // for more info on the different modes.
+  //
+  // This method is intended as a configuration option to be used after
+  // construction. Behavior is undefined if |this| has already handled any
+  // InkDrop defined functions.
+  void SetAutoHighlightMode(AutoHighlightMode auto_highlight_mode);
+
   // InkDrop:
   InkDropState GetTargetInkDropState() const override;
   void AnimateToState(InkDropState ink_drop_state) override;
   void SnapToActivated() override;
   void SetHovered(bool is_hovered) override;
   void SetFocused(bool is_focused) override;
 
  private:
   friend class test::InkDropImplTestApi;
 
+  // Base state classes.
+  class HighlightState;
+
+  // AutoHighlightMode::NONE
+  class NoAutoHighlightHiddenState;
+  class NoAutoHighlightVisibleState;
+
+  // AutoHighlightMode::HIDE_ON_RIPPLE
+  class HideHighlightOnRippleHiddenState;
+  class HideHighlightOnRippleVisibleState;
+
+  // AutoHighlightMode::SHOW_ON_RIPPLE states
+  class ShowHighlightOnRippleHiddenState;
+  class ShowHighlightOnRippleVisibleState;
+
+  class HighlightStateFactory;
+
   // Destroys |ink_drop_ripple_| if it's targeted to the HIDDEN state.
   void DestroyHiddenTargetedAnimations();
 
   // Creates a new InkDropRipple and sets it to |ink_drop_ripple_|. If
   // |ink_drop_ripple_| wasn't null then it will be destroyed using
   // DestroyInkDropRipple().
   void CreateInkDropRipple();
 
   // Destroys the current |ink_drop_ripple_|.
   void DestroyInkDropRipple();
@@ skipping 30 matching lines @@
                       InkDropAnimationEndedReason reason) override;
 
   // Enables or disables the highlight state based on |should_highlight| and if
   // an animation is triggered it will be scheduled to have the given
   // |animation_duration|. If |explode| is true the highlight will expand as it
   // fades out. |explode| is ignored when |should_higlight| is true.
   void SetHighlight(bool should_highlight,
                     base::TimeDelta animation_duration,
                     bool explode);
 
-  // Returns true if this ink drop is hovered or focused.
+  // Returns true if |this| should be hovered based on hover/focus status.
   bool ShouldHighlight() const;
 
-  // Starts the |highlight_after_ripple_timer_| timer. This will stop the
-  // current
-  // |highlight_after_ripple_timer_| instance if it exists.
-  void StartHighlightAfterRippleTimer();
+  // Returns true if |this| should be hovered based on focus status.
+  bool ShouldHighlightBasedOnFocus() const;
 
-  // Callback for when the |highlight_after_ripple_timer_| fires.
-  void HighlightAfterRippleTimerFired();
+  // Updates the current |highlight_state_|. Calls Exit()/Enter() on the
+  // previous/new state to notify them of the transition.
+  void SetHighlightState(std::unique_ptr<HighlightState> highlight_state);
 
   // The host of the ink drop. Used to poll for information such as whether the
   // highlight should be shown or not.
   InkDropHost* ink_drop_host_;
 
   // The root Layer that parents the InkDropRipple layers and the
   // InkDropHighlight layers. The |root_layer_| is the one that is added and
   // removed from the InkDropHost.
   std::unique_ptr<ui::Layer> root_layer_;
 
   // True when the |root_layer_| has been added to the |ink_drop_host_|.
   bool root_layer_added_to_host_;
 
   // The current InkDropHighlight. Lazily created using
   // CreateInkDropHighlight();
   std::unique_ptr<InkDropHighlight> highlight_;
 
+  // True denotes the highlight should be shown when this is hovered.
+  bool show_highlight_on_hover_;
+
+  // True denotes the highlight should be shown when this is focused.
+  bool show_highlight_on_focus_;
+
   // Tracks the logical hovered state of |this| as manipulated by the public
   // SetHovered() function.
   bool is_hovered_;
 
   // Tracks the logical focused state of |this| as manipulated by the public
   // SetFocused() function.
   bool is_focused_;
 
   // The current InkDropRipple. Created on demand using CreateInkDropRipple().
   std::unique_ptr<InkDropRipple> ink_drop_ripple_;
 
-  // The timer used to delay the highlight fade in after an ink drop ripple
-  // animation.
-  std::unique_ptr<base::Timer> highlight_after_ripple_timer_;
+  // Used by |this| to initialize the starting |highlight_state_| and by the
+  // current |highlight_state_ to create the next state.
+  std::unique_ptr<HighlightStateFactory> highlight_state_factory_;
+
+  // The current state object that handles all inputs that affect the visibility
+  // of the InkDropHighlight.
+  std::unique_ptr<HighlightState> highlight_state_;
 
   DISALLOW_COPY_AND_ASSIGN(InkDropImpl);
 };
 
 }  // namespace views
 
 #endif  // UI_VIEWS_ANIMATION_INK_DROP_IMPL_H_