Refactor Contextual Search base classes

chrome/android/java/src/org/chromium/chrome/browser/compositor/bottombar/OverlayPanelAnimation.java

 // Copyright 2015 The Chromium Authors. All rights reserved.

[Theresa, 2016/01/21 00:39:02]

Not sure if the copyright year gets updated when files are moved (as opposed to
newly created)... I think it should probably get updated since it's technically
a new file.

[mdjones, 2016/01/21 02:30:14]

Done.

 // 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.compositor.bottombar.contextualsearch;
+package org.chromium.chrome.browser.compositor.bottombar;
 
 import static org.chromium.chrome.browser.compositor.layouts.ChromeAnimation.AnimatableAnimation.createAnimation;
 
 import android.content.Context;
 import android.view.animation.Interpolator;
 
 import org.chromium.chrome.browser.compositor.bottombar.OverlayPanel.PanelState;
 import org.chromium.chrome.browser.compositor.bottombar.OverlayPanel.StateChangeReason;
 import org.chromium.chrome.browser.compositor.layouts.ChromeAnimation;
 import org.chromium.chrome.browser.compositor.layouts.ChromeAnimation.Animatable;
 import org.chromium.chrome.browser.compositor.layouts.ChromeAnimation.Animation;
 import org.chromium.chrome.browser.compositor.layouts.LayoutUpdateHost;
 import org.chromium.chrome.browser.util.MathUtils;
 
 /**
- * Base abstract class for animating the Contextual Search Panel.
+ * Base abstract class for animating the Overlay Panel.
  */
-public abstract class ContextualSearchPanelAnimation extends ContextualSearchPanelBase
-        implements Animatable<ContextualSearchPanelAnimation.Property> {
+public abstract class OverlayPanelAnimation extends OverlayPanelBase
+        implements Animatable<OverlayPanelAnimation.Property> {
 
     /**
      * Animation properties.
      */
     protected enum Property {
         PANEL_HEIGHT,
         PROMO_VISIBILITY,
         BOTTOM_BAR_TEXT_VISIBILITY
     }
 
     /**
      * The base duration of animations in milliseconds. This value is based on
      * the Kennedy specification for slow animations.
      */
-    protected static final long BASE_ANIMATION_DURATION_MS = 218;
+    public static final long BASE_ANIMATION_DURATION_MS = 218;
 
     /**
      * The maximum animation duration in milliseconds.
      */
-    static final long MAXIMUM_ANIMATION_DURATION_MS = 350;
+    public static final long MAXIMUM_ANIMATION_DURATION_MS = 350;
 
     /**
      * The minimum animation duration in milliseconds.
      */
     private static final long MINIMUM_ANIMATION_DURATION_MS = Math.round(7 * 1000 / 60);
 
     /**
      * Average animation velocity in dps per second.
      */
     private static final float INITIAL_ANIMATION_VELOCITY_DP_PER_SECOND = 1750f;
@@ skipping 29 matching lines @@
     private boolean mIsAnimatingPanelClosing;
 
     // ============================================================================================
     // Constructor
     // ============================================================================================
 
     /**
      * @param context The current Android {@link Context}.
      * @param updateHost The {@link LayoutUpdateHost} used to request updates in the Layout.
      */
-    public ContextualSearchPanelAnimation(Context context, LayoutUpdateHost updateHost) {
+    public OverlayPanelAnimation(Context context, LayoutUpdateHost updateHost) {
         super(context);
         mUpdateHost = updateHost;
     }
 
     // ============================================================================================
     // Animation API
     // ============================================================================================
 
     /**
      * Notifies that the acceptance animation has finished.
      */
     protected void onPromoAcceptanceAnimationFinished() {
     }
 
     /**
-     * Animates the Contextual Search Panel to its maximized state.
+     * Animates the Overlay Panel Panel to its maximized state.

[Theresa, 2016/01/21 00:39:02]

Remove the extra "Panel" here and in other comments in this file.

[mdjones, 2016/01/21 02:30:14]

Whoops. Done

      *
      * @param reason The reason for the change of panel state.
      */
     protected void maximizePanel(StateChangeReason reason) {
         animatePanelToState(PanelState.MAXIMIZED, reason);
     }
 
     /**
-     * Animates the Contextual Search Panel to its intermediary state.
+     * Animates the Overlay Panel Panel to its intermediary state.
      *
      * @param reason The reason for the change of panel state.
      */
     protected void expandPanel(StateChangeReason reason) {
         animatePanelToState(PanelState.EXPANDED, reason);
     }
 
     /**
-     * Animates the Contextual Search Panel to its peeked state.
+     * Animates the Overlay Panel Panel to its peeked state.
      *
      * @param reason The reason for the change of panel state.
      */
     protected void peekPanel(StateChangeReason reason) {
         // Indicate to the Compositor that for now on the Panel should be
         // rendered, until it's closed.
         startShowing();
 
         // TODO(pedrosimonetti): Implement custom animation with the following values.
         // int SEARCH_BAR_ANIMATION_DURATION_MS = 218;
@@ skipping 19 matching lines @@
 
         if (animate) {
             mIsAnimatingPanelClosing = true;
             animatePanelToState(PanelState.CLOSED, reason);
         } else {
             resizePanelToState(PanelState.CLOSED, reason);
         }
     }
 
     /**
-     * Animates the Contextual Search Panel to a given |state| with a default duration.
+     * Animates the Overlay Panel Panel to a given |state| with a default duration.
      *
      * @param state The state to animate to.
      * @param reason The reason for the change of panel state.
      */
     private void animatePanelToState(PanelState state, StateChangeReason reason) {
         animatePanelToState(state, reason, BASE_ANIMATION_DURATION_MS);
     }
 
     /**
-     * Animates the Contextual Search Panel to a given |state| with a custom |duration|.
+     * Animates the Overlay Panel Panel to a given |state| with a custom |duration|.
      *
      * @param state The state to animate to.
      * @param reason The reason for the change of panel state.
      * @param duration The animation duration in milliseconds.
      */
     protected void animatePanelToState(PanelState state, StateChangeReason reason, long duration) {
         mAnimatingState = state;
         mAnimatingStateReason = reason;
 
         final float height = getPanelHeightFromState(state);
         animatePanelTo(height, duration);
     }
 
     /**
-     * Resizes the Contextual Search Panel to a given |state|.
+     * Resizes the Overlay Panel Panel to a given |state|.
      *
      * @param state The state to resize to.
      * @param reason The reason for the change of panel state.
      */
     protected void resizePanelToState(PanelState state, StateChangeReason reason) {
         cancelHeightAnimation();
 
         final float height = getPanelHeightFromState(state);
         setPanelHeight(height);
         setPanelState(state, reason);
@@ skipping 130 matching lines @@
         if (mUpdateHost != null) {
             mUpdateHost.requestUpdate();
         }
     }
 
     // ============================================================================================
     // Animation Framework
     // ============================================================================================
 
     /**
-     * Animates the Contextual Search Panel to a given |height| with a custom |duration|.
+     * Animates the Overlay Panel to a given |height| with a custom |duration|.
      *
      * @param height The height to animate to.
      * @param duration The animation duration in milliseconds.
      */
     private void animatePanelTo(float height, long duration) {
         animateProperty(Property.PANEL_HEIGHT, getHeight(), height, duration);
     }
 
     /**
-     * Animates the Contextual Search Panel.
+     * Animates the Overlay Panel.
      *
      * @param property The property which will be animated.
      * @param start The initial value.
      * @param end The final value.
      * @param duration The animation duration in milliseconds.
      */
     protected void animateProperty(Property property, float start, float end, long duration) {
         if (duration > 0) {
             if (animationIsRunning()) {
                 cancelAnimation(this, property);
@@ skipping 74 matching lines @@
 
         mAnimatingState = PanelState.UNDEFINED;
         mAnimatingStateReason = StateChangeReason.UNKNOWN;
     }
 
     /**
      * Creates an {@link org.chromium.chrome.browser.compositor.layouts.ChromeAnimation.Animatable}
      * and adds it to the animation.
      * Automatically sets the start value at the beginning of the animation.
      */
-    protected <T extends Enum<?>> void addToAnimation(Animatable<T> object, T prop, float start,
+    public <T extends Enum<?>> void addToAnimation(Animatable<T> object, T prop, float start,
             float end, long duration, long startTime) {
         addToAnimation(object, prop, start, end, duration, startTime, false);
     }
 
     /**
      * Creates an {@link org.chromium.chrome.browser.compositor.layouts.ChromeAnimation.Animatable}
      * and adds it to the animation. Uses a deceleration interpolator by default.
      */
-    protected <T extends Enum<?>> void addToAnimation(Animatable<T> object, T prop, float start,
+    public <T extends Enum<?>> void addToAnimation(Animatable<T> object, T prop, float start,
             float end, long duration, long startTime, boolean setStartValueAfterDelay) {
         addToAnimation(object, prop, start, end, duration, startTime, setStartValueAfterDelay,
                 ChromeAnimation.getDecelerateInterpolator());
     }
 
     /**
      * Creates an {@link org.chromium.chrome.browser.compositor.layouts.ChromeAnimation.Animatable}
      * and adds it to the animation.
      *
      * @param <T>                     The Enum type of the Property being used
@@ skipping 40 matching lines @@
      * Cancels any animation for the given object and property.
      * @param object The object being animated.
      * @param prop   The property to search for.
      */
     protected <T extends Enum<?>> void cancelAnimation(Animatable<T> object, T prop) {
         if (mLayoutAnimations != null) {
             mLayoutAnimations.cancel(object, prop);
         }
     }
 }