blob: 2eeb132bbf55150750cdcb1c17eabc3148b8ea3f [file] [log] [blame]
Winson Chung321e9ee2010-08-09 13:37:56 -07001/*
Adam Cohen7d30a372013-07-01 17:03:59 -07002 * Copyright (C) 2012 The Android Open Source Project
Winson Chung321e9ee2010-08-09 13:37:56 -07003 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Daniel Sandler325dc232013-06-05 22:57:57 -040017package com.android.launcher3;
Winson Chung321e9ee2010-08-09 13:37:56 -070018
Sunny Goyalc4bb3732019-06-20 11:34:14 -070019import static com.android.launcher3.Utilities.shouldDisableGestures;
Sunny Goyald0030b02017-12-08 15:07:24 -080020import static com.android.launcher3.compat.AccessibilityManagerCompat.isAccessibilityEnabled;
21import static com.android.launcher3.compat.AccessibilityManagerCompat.isObservedEventType;
Jon Miranda71cb80c2019-01-24 21:25:13 -080022import static com.android.launcher3.config.FeatureFlags.QUICKSTEP_SPRINGS;
Sunny Goyalb7b01352018-08-09 12:31:20 -070023import static com.android.launcher3.touch.OverScroll.OVERSCROLL_DAMP_FACTOR;
Sunny Goyald0030b02017-12-08 15:07:24 -080024
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -070025import android.animation.LayoutTransition;
Adam Cohen7d30a372013-07-01 17:03:59 -070026import android.animation.TimeInterpolator;
Sunny Goyalcf25b522015-07-09 00:01:18 -070027import android.annotation.SuppressLint;
Winson Chung321e9ee2010-08-09 13:37:56 -070028import android.content.Context;
Adam Cohen9c4949e2010-10-05 12:27:22 -070029import android.content.res.TypedArray;
Jon Miranda71cb80c2019-01-24 21:25:13 -080030import android.graphics.Canvas;
Winson Chung321e9ee2010-08-09 13:37:56 -070031import android.graphics.Rect;
Svetoslav Ganov08055f62012-05-15 11:06:36 -070032import android.os.Bundle;
Tony Wickhamd58c2d52018-05-04 12:10:55 -070033import android.provider.Settings;
Winson Chung321e9ee2010-08-09 13:37:56 -070034import android.util.AttributeSet;
Winson Chung785d2eb2011-04-14 16:08:02 -070035import android.util.Log;
Winson Chung185d7162011-02-28 13:47:29 -080036import android.view.InputDevice;
37import android.view.KeyEvent;
Winson Chung321e9ee2010-08-09 13:37:56 -070038import android.view.MotionEvent;
39import android.view.VelocityTracker;
40import android.view.View;
41import android.view.ViewConfiguration;
Sunny Goyal4ffec482016-02-09 11:28:52 -080042import android.view.ViewDebug;
Winson Chung321e9ee2010-08-09 13:37:56 -070043import android.view.ViewGroup;
44import android.view.ViewParent;
Winson Chung6a0f57d2011-06-29 20:10:49 -070045import android.view.accessibility.AccessibilityEvent;
46import android.view.accessibility.AccessibilityNodeInfo;
Adam Cohene0f66b52010-11-23 15:06:07 -080047import android.view.animation.Interpolator;
Vadim Trysheve6bbefb2018-04-03 13:38:06 -070048import android.widget.ScrollView;
Tony Wickhamf549dab2016-05-16 09:54:06 -070049
Sunny Goyal5bc6b6f2017-10-26 15:36:10 -070050import com.android.launcher3.anim.Interpolators;
Tony Wickhamd58c2d52018-05-04 12:10:55 -070051import com.android.launcher3.config.FeatureFlags;
Tony Wickhamf549dab2016-05-16 09:54:06 -070052import com.android.launcher3.pageindicators.PageIndicator;
Sunny Goyalb72d8b22017-07-14 00:02:27 -070053import com.android.launcher3.touch.OverScroll;
Sunny Goyalb7b01352018-08-09 12:31:20 -070054import com.android.launcher3.util.OverScroller;
Adam Cohen091440a2015-03-18 14:16:05 -070055import com.android.launcher3.util.Thunk;
Tony Wickhamf549dab2016-05-16 09:54:06 -070056
Winson Chung6a0f57d2011-06-29 20:10:49 -070057import java.util.ArrayList;
58
Winson Chung321e9ee2010-08-09 13:37:56 -070059/**
60 * An abstraction of the original Workspace which supports browsing through a
Michael Jurka0142d492010-08-25 17:46:15 -070061 * sequential list of "pages"
Winson Chung321e9ee2010-08-09 13:37:56 -070062 */
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -080063public abstract class PagedView<T extends View & PageIndicator> extends ViewGroup {
Winson Chung321e9ee2010-08-09 13:37:56 -070064 private static final String TAG = "PagedView";
Winson Chung785d2eb2011-04-14 16:08:02 -070065 private static final boolean DEBUG = false;
Sunny Goyal20a13ff2018-03-13 16:44:00 -070066
Michael Jurka0142d492010-08-25 17:46:15 -070067 protected static final int INVALID_PAGE = -1;
Sunny Goyal20a13ff2018-03-13 16:44:00 -070068 protected static final ComputePageScrollsLogic SIMPLE_SCROLL_LOGIC = (v) -> v.getVisibility() != GONE;
Winson Chung321e9ee2010-08-09 13:37:56 -070069
Vadim Tryshevfedca432015-08-19 17:55:02 -070070 public static final int PAGE_SNAP_ANIMATION_DURATION = 750;
Winson Chung321e9ee2010-08-09 13:37:56 -070071
Sunny Goyalb72d8b22017-07-14 00:02:27 -070072 // OverScroll constants
Adam Cohen8d769d62017-06-23 17:27:38 -070073 private final static int OVERSCROLL_PAGE_SNAP_ANIMATION_DURATION = 270;
Adam Cohen8d769d62017-06-23 17:27:38 -070074
Adam Cohenb64cb5a2011-02-15 13:53:42 -080075 private static final float RETURN_TO_ORIGINAL_PAGE_THRESHOLD = 0.33f;
Adam Cohen00481b32011-11-18 12:03:48 -080076 // The page is moved more than halfway, automatically move to the next page on touch up.
77 private static final float SIGNIFICANT_MOVE_THRESHOLD = 0.4f;
Adam Cohen68d73932010-11-15 10:50:58 -080078
Sunny Goyal8e2133b2015-05-06 13:39:07 -070079 private static final float MAX_SCROLL_PROGRESS = 1.0f;
80
Adam Cohen265b9a62011-12-07 14:37:18 -080081 // The following constants need to be scaled based on density. The scaled versions will be
82 // assigned to the corresponding member variables below.
83 private static final int FLING_THRESHOLD_VELOCITY = 500;
84 private static final int MIN_SNAP_VELOCITY = 1500;
85 private static final int MIN_FLING_VELOCITY = 250;
86
Adam Cohen21cd0022013-10-09 18:57:02 -070087 public static final int INVALID_RESTORE_PAGE = -1001;
88
Adam Cohenf358a4b2013-07-23 16:47:31 -070089 private boolean mFreeScroll = false;
Adam Cohenf358a4b2013-07-23 16:47:31 -070090
Adam Cohen265b9a62011-12-07 14:37:18 -080091 protected int mFlingThresholdVelocity;
92 protected int mMinFlingVelocity;
93 protected int mMinSnapVelocity;
Michael Jurka0142d492010-08-25 17:46:15 -070094
Michael Jurka0142d492010-08-25 17:46:15 -070095 protected boolean mFirstLayout = true;
96
Sunny Goyal4ffec482016-02-09 11:28:52 -080097 @ViewDebug.ExportedProperty(category = "launcher")
Michael Jurka0142d492010-08-25 17:46:15 -070098 protected int mCurrentPage;
Adam Cohene61a9a22013-06-11 15:45:31 -070099
Sunny Goyal4ffec482016-02-09 11:28:52 -0800100 @ViewDebug.ExportedProperty(category = "launcher")
Michael Jurka0142d492010-08-25 17:46:15 -0700101 protected int mNextPage = INVALID_PAGE;
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700102 protected int mMinScrollX;
Sunny Goyalc86df472016-02-25 09:19:38 -0800103 protected int mMaxScrollX;
Sunny Goyalb7b01352018-08-09 12:31:20 -0700104 protected OverScroller mScroller;
Adam Cohenf9618852013-11-08 06:45:03 -0800105 private Interpolator mDefaultInterpolator;
Winson Chung321e9ee2010-08-09 13:37:56 -0700106 private VelocityTracker mVelocityTracker;
Sunny Goyale15e2a82017-12-15 13:05:42 -0800107 protected int mPageSpacing = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -0700108
109 private float mDownMotionX;
Adam Cohen7d30a372013-07-01 17:03:59 -0700110 private float mDownMotionY;
Sunny Goyalcf25b522015-07-09 00:01:18 -0700111 private float mLastMotionX;
112 private float mLastMotionXRemainder;
Sunny Goyalcf25b522015-07-09 00:01:18 -0700113 private float mTotalMotionX;
Adam Cohenedb40762013-07-18 16:45:45 -0700114
Vadim Trysheve628c472018-05-16 14:28:18 -0700115 protected int[] mPageScrolls;
Sunny Goyalaad33592018-08-07 17:20:35 -0700116 private boolean mIsBeingDragged;
Adam Cohencae7f572013-11-04 14:42:52 -0800117
Michael Jurka7426c422010-11-11 15:23:47 -0800118 protected int mTouchSlop;
Winson Chung321e9ee2010-08-09 13:37:56 -0700119 private int mMaximumVelocity;
Adam Cohen68d73932010-11-15 10:50:58 -0800120 protected boolean mAllowOverScroll = true;
Winson Chung321e9ee2010-08-09 13:37:56 -0700121
Michael Jurka5f1c5092010-09-03 14:15:02 -0700122 protected static final int INVALID_POINTER = -1;
Winson Chung321e9ee2010-08-09 13:37:56 -0700123
Michael Jurka5f1c5092010-09-03 14:15:02 -0700124 protected int mActivePointerId = INVALID_POINTER;
Winson Chung321e9ee2010-08-09 13:37:56 -0700125
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700126 protected boolean mIsPageInTransition = false;
Patrick Dubroy1262e362010-10-06 15:49:50 -0700127
Jon Miranda71cb80c2019-01-24 21:25:13 -0800128 protected float mSpringOverScrollX;
129
Sunny Goyal061380a2016-02-29 15:15:03 -0800130 protected boolean mWasInOverscroll = false;
Adam Cohenc2d6e892014-10-16 09:49:24 -0700131
Adam Cohen8d769d62017-06-23 17:27:38 -0700132 protected int mUnboundedScrollX;
133
Winson Chungd2be3812013-07-16 11:11:32 -0700134 // Page Indicator
Adam Cohen091440a2015-03-18 14:16:05 -0700135 @Thunk int mPageIndicatorViewId;
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800136 protected T mPageIndicator;
Adam Cohen7d30a372013-07-01 17:03:59 -0700137
John Spurlock77e1f472013-09-11 10:09:51 -0400138 protected final Rect mInsets = new Rect();
Tony Wickhamdfb5cc92018-02-26 16:41:57 -0800139 protected boolean mIsRtl;
John Spurlock77e1f472013-09-11 10:09:51 -0400140
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800141 // Similar to the platform implementation of isLayoutValid();
142 protected boolean mIsLayoutValid;
143
Vadim Tryshev528b9e02018-05-24 18:22:03 -0700144 private int[] mTmpIntPair = new int[2];
145
Winson Chung321e9ee2010-08-09 13:37:56 -0700146 public PagedView(Context context) {
147 this(context, null);
148 }
149
150 public PagedView(Context context, AttributeSet attrs) {
151 this(context, attrs, 0);
152 }
153
154 public PagedView(Context context, AttributeSet attrs, int defStyle) {
155 super(context, attrs, defStyle);
Winson Chungc9ca2982013-07-19 12:07:38 -0700156
Adam Cohen9c4949e2010-10-05 12:27:22 -0700157 TypedArray a = context.obtainStyledAttributes(attrs,
158 R.styleable.PagedView, defStyle, 0);
Winson Chungd2be3812013-07-16 11:11:32 -0700159 mPageIndicatorViewId = a.getResourceId(R.styleable.PagedView_pageIndicator, -1);
Adam Cohen9c4949e2010-10-05 12:27:22 -0700160 a.recycle();
161
Winson Chung321e9ee2010-08-09 13:37:56 -0700162 setHapticFeedbackEnabled(false);
Sunny Goyal70660032015-05-14 00:07:08 -0700163 mIsRtl = Utilities.isRtl(getResources());
Michael Jurka0142d492010-08-25 17:46:15 -0700164 init();
Winson Chung321e9ee2010-08-09 13:37:56 -0700165 }
166
167 /**
168 * Initializes various states for this workspace.
169 */
Michael Jurka0142d492010-08-25 17:46:15 -0700170 protected void init() {
Sunny Goyalb7b01352018-08-09 12:31:20 -0700171 mScroller = new OverScroller(getContext());
Sunny Goyal5bc6b6f2017-10-26 15:36:10 -0700172 setDefaultInterpolator(Interpolators.SCROLL);
Winson Chung86f77532010-08-24 11:08:22 -0700173 mCurrentPage = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -0700174
175 final ViewConfiguration configuration = ViewConfiguration.get(getContext());
Adam Cohen7d30a372013-07-01 17:03:59 -0700176 mTouchSlop = configuration.getScaledPagingTouchSlop();
Winson Chung321e9ee2010-08-09 13:37:56 -0700177 mMaximumVelocity = configuration.getScaledMaximumFlingVelocity();
Adam Cohen265b9a62011-12-07 14:37:18 -0800178
Sunny Goyalcf25b522015-07-09 00:01:18 -0700179 float density = getResources().getDisplayMetrics().density;
180 mFlingThresholdVelocity = (int) (FLING_THRESHOLD_VELOCITY * density);
181 mMinFlingVelocity = (int) (MIN_FLING_VELOCITY * density);
182 mMinSnapVelocity = (int) (MIN_SNAP_VELOCITY * density);
Sunny Goyala9f55462018-03-25 18:15:15 -0700183
184 if (Utilities.ATLEAST_OREO) {
185 setDefaultFocusHighlightEnabled(false);
186 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700187 }
188
Adam Cohenf9618852013-11-08 06:45:03 -0800189 protected void setDefaultInterpolator(Interpolator interpolator) {
190 mDefaultInterpolator = interpolator;
191 mScroller.setInterpolator(mDefaultInterpolator);
192 }
193
Sunny Goyald0a6ae72016-06-16 12:29:03 -0700194 public void initParentViews(View parent) {
195 if (mPageIndicatorViewId > -1) {
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800196 mPageIndicator = parent.findViewById(mPageIndicatorViewId);
Sunny Goyalc64cfdd2016-05-18 14:12:02 -0700197 mPageIndicator.setMarkersCount(getChildCount());
Winson Chungd2be3812013-07-16 11:11:32 -0700198 }
199 }
200
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800201 public T getPageIndicator() {
Adam Cohenedb40762013-07-18 16:45:45 -0700202 return mPageIndicator;
203 }
204
Adam Cohen674531f2013-12-13 15:07:14 -0800205 /**
Tony Wickham29d853c2015-09-08 10:35:56 -0700206 * Returns the index of the currently displayed page. When in free scroll mode, this is the page
207 * that the user was on before entering free scroll mode (e.g. the home screen page they
208 * long-pressed on to enter the overview). Try using {@link #getPageNearestToCenterOfScreen()}
209 * to get the page the user is currently scrolling over.
Winson Chung321e9ee2010-08-09 13:37:56 -0700210 */
Sunny Goyal83a8f042015-05-19 12:52:12 -0700211 public int getCurrentPage() {
Winson Chung86f77532010-08-24 11:08:22 -0700212 return mCurrentPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700213 }
Adam Cohen7d30a372013-07-01 17:03:59 -0700214
Hyunyoung Songb76cd622015-04-16 14:34:09 -0700215 /**
216 * Returns the index of page to be shown immediately afterwards.
217 */
Vadim Tryshevfedca432015-08-19 17:55:02 -0700218 public int getNextPage() {
Winson Chung360e63f2012-04-27 13:48:05 -0700219 return (mNextPage != INVALID_PAGE) ? mNextPage : mCurrentPage;
220 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700221
Adam Cohenf9c184a2016-01-15 16:47:43 -0800222 public int getPageCount() {
Winson Chung321e9ee2010-08-09 13:37:56 -0700223 return getChildCount();
224 }
225
Sunny Goyal83a8f042015-05-19 12:52:12 -0700226 public View getPageAt(int index) {
Winson Chung321e9ee2010-08-09 13:37:56 -0700227 return getChildAt(index);
228 }
229
Adam Cohenae4f1552011-10-20 00:15:42 -0700230 protected int indexToPage(int index) {
231 return index;
232 }
233
Winson Chung321e9ee2010-08-09 13:37:56 -0700234 /**
Winson Chungbbc60d82010-11-11 16:34:41 -0800235 * Updates the scroll of the current page immediately to its final scroll position. We use this
236 * in CustomizePagedView to allow tabs to share the same PagedView while resetting the scroll of
237 * the previous tab page.
238 */
239 protected void updateCurrentPageScroll() {
Adam Cohen0ffac432013-07-10 11:19:26 -0700240 // If the current page is invalid, just reset the scroll position to zero
241 int newX = 0;
242 if (0 <= mCurrentPage && mCurrentPage < getPageCount()) {
Adam Cohenedb40762013-07-18 16:45:45 -0700243 newX = getScrollForPage(mCurrentPage);
Adam Cohen0ffac432013-07-10 11:19:26 -0700244 }
Sunny Goyalc82c6392018-06-06 15:39:13 -0700245 scrollTo(newX, 0);
Sunny Goyalb7b01352018-08-09 12:31:20 -0700246 mScroller.startScroll(mScroller.getCurrPos(), newX - mScroller.getCurrPos());
Sunny Goyalc82c6392018-06-06 15:39:13 -0700247 forceFinishScroller(true);
Winson Chungbbc60d82010-11-11 16:34:41 -0800248 }
249
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700250 private void abortScrollerAnimation(boolean resetNextPage) {
Adam Cohen4fe4c932013-10-28 16:02:34 -0700251 mScroller.abortAnimation();
252 // We need to clean up the next page here to avoid computeScrollHelper from
253 // updating current page on the pass.
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700254 if (resetNextPage) {
255 mNextPage = INVALID_PAGE;
Sunny Goyal857b1b92018-03-05 10:49:05 -0800256 pageEndTransition();
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700257 }
Chet Haasebc2f0822012-10-26 17:59:53 -0700258 }
Adam Cohen4fe4c932013-10-28 16:02:34 -0700259
Tony Wickham8f7ead32016-04-07 18:46:44 -0700260 private void forceFinishScroller(boolean resetNextPage) {
Adam Cohen4fe4c932013-10-28 16:02:34 -0700261 mScroller.forceFinished(true);
262 // We need to clean up the next page here to avoid computeScrollHelper from
263 // updating current page on the pass.
Tony Wickham8f7ead32016-04-07 18:46:44 -0700264 if (resetNextPage) {
265 mNextPage = INVALID_PAGE;
Sunny Goyal857b1b92018-03-05 10:49:05 -0800266 pageEndTransition();
Tony Wickham8f7ead32016-04-07 18:46:44 -0700267 }
Adam Cohen4fe4c932013-10-28 16:02:34 -0700268 }
269
Adam Cohen6f127a62014-06-12 14:54:41 -0700270 private int validateNewPage(int newPage) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700271 newPage = ensureWithinScrollBounds(newPage);
Adam Cohen6f127a62014-06-12 14:54:41 -0700272 // Ensure that it is clamped by the actual set of children in all cases
Sunny Goyal4d519f22017-10-24 10:32:40 -0700273 return Utilities.boundToRange(newPage, 0, getPageCount() - 1);
Adam Cohen6f127a62014-06-12 14:54:41 -0700274 }
275
Chet Haasebc2f0822012-10-26 17:59:53 -0700276 /**
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700277 * @return The closest page to the provided page that is within mMinScrollX and mMaxScrollX.
278 */
279 private int ensureWithinScrollBounds(int page) {
280 int dir = !mIsRtl ? 1 : - 1;
281 int currScroll = getScrollForPage(page);
282 int prevScroll;
283 while (currScroll < mMinScrollX) {
284 page += dir;
285 prevScroll = currScroll;
286 currScroll = getScrollForPage(page);
287 if (currScroll <= prevScroll) {
288 Log.e(TAG, "validateNewPage: failed to find a page > mMinScrollX");
289 break;
290 }
291 }
292 while (currScroll > mMaxScrollX) {
293 page -= dir;
294 prevScroll = currScroll;
295 currScroll = getScrollForPage(page);
296 if (currScroll >= prevScroll) {
297 Log.e(TAG, "validateNewPage: failed to find a page < mMaxScrollX");
298 break;
299 }
300 }
301 return page;
302 }
303
Tony Wickham03f27012019-04-25 14:22:54 -0700304 public void setCurrentPage(int currentPage) {
305 setCurrentPage(currentPage, INVALID_PAGE);
306 }
307
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700308 /**
Winson Chung86f77532010-08-24 11:08:22 -0700309 * Sets the current page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700310 */
Tony Wickham03f27012019-04-25 14:22:54 -0700311 public void setCurrentPage(int currentPage, int overridePrevPage) {
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800312 if (!mScroller.isFinished()) {
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700313 abortScrollerAnimation(true);
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800314 }
Michael Jurkad3ef3062010-11-23 16:23:58 -0800315 // don't introduce any checks like mCurrentPage == currentPage here-- if we change the
316 // the default
317 if (getChildCount() == 0) {
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800318 return;
319 }
Tony Wickham03f27012019-04-25 14:22:54 -0700320 int prevPage = overridePrevPage != INVALID_PAGE ? overridePrevPage : mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700321 mCurrentPage = validateNewPage(currentPage);
Winson Chung181c3dc2013-07-17 15:36:20 -0700322 updateCurrentPageScroll();
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700323 notifyPageSwitchListener(prevPage);
Winson Chunga12a2502010-12-20 14:41:35 -0800324 invalidate();
Winson Chung321e9ee2010-08-09 13:37:56 -0700325 }
326
Winson Chung8c87cd82013-07-23 16:20:10 -0700327 /**
Adam Cohen674531f2013-12-13 15:07:14 -0800328 * Should be called whenever the page changes. In the case of a scroll, we wait until the page
329 * has settled.
330 */
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700331 protected void notifyPageSwitchListener(int prevPage) {
Adam Cohen674531f2013-12-13 15:07:14 -0800332 updatePageIndicator();
333 }
334
335 private void updatePageIndicator() {
Sunny Goyal4cbf0462014-08-28 16:19:39 -0700336 if (mPageIndicator != null) {
Tony Mak4f521af2018-03-15 16:37:34 +0000337 mPageIndicator.setActiveMarker(getNextPage());
Winson Chungd2be3812013-07-16 11:11:32 -0700338 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700339 }
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700340 protected void pageBeginTransition() {
341 if (!mIsPageInTransition) {
342 mIsPageInTransition = true;
343 onPageBeginTransition();
Michael Jurkad74c9842011-07-10 12:44:21 -0700344 }
Patrick Dubroy1262e362010-10-06 15:49:50 -0700345 }
346
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700347 protected void pageEndTransition() {
348 if (mIsPageInTransition) {
349 mIsPageInTransition = false;
350 onPageEndTransition();
Michael Jurkad74c9842011-07-10 12:44:21 -0700351 }
Michael Jurka0142d492010-08-25 17:46:15 -0700352 }
353
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700354 protected boolean isPageInTransition() {
355 return mIsPageInTransition;
Adam Cohen26976d92011-03-22 15:33:33 -0700356 }
357
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700358 /**
359 * Called when the page starts moving as part of the scroll. Subclasses can override this
360 * to provide custom behavior during animation.
361 */
362 protected void onPageBeginTransition() {
Patrick Dubroy1262e362010-10-06 15:49:50 -0700363 }
364
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700365 /**
366 * Called when the page ends moving as part of the scroll. Subclasses can override this
367 * to provide custom behavior during animation.
368 */
369 protected void onPageEndTransition() {
Adam Cohenc2d6e892014-10-16 09:49:24 -0700370 mWasInOverscroll = false;
Michael Jurka0142d492010-08-25 17:46:15 -0700371 }
372
Sunny Goyalc86df472016-02-25 09:19:38 -0800373 protected int getUnboundedScrollX() {
Adam Cohen8d769d62017-06-23 17:27:38 -0700374 return mUnboundedScrollX;
Sunny Goyalc86df472016-02-25 09:19:38 -0800375 }
376
Winson Chung321e9ee2010-08-09 13:37:56 -0700377 @Override
Adam Cohen68d73932010-11-15 10:50:58 -0800378 public void scrollBy(int x, int y) {
Sunny Goyalc86df472016-02-25 09:19:38 -0800379 scrollTo(getUnboundedScrollX() + x, getScrollY() + y);
Adam Cohen68d73932010-11-15 10:50:58 -0800380 }
381
382 @Override
Michael Jurka0142d492010-08-25 17:46:15 -0700383 public void scrollTo(int x, int y) {
Adam Cohen8d769d62017-06-23 17:27:38 -0700384 mUnboundedScrollX = x;
385
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700386 boolean isXBeforeFirstPage = mIsRtl ? (x > mMaxScrollX) : (x < mMinScrollX);
387 boolean isXAfterLastPage = mIsRtl ? (x < mMinScrollX) : (x > mMaxScrollX);
Jon Miranda71cb80c2019-01-24 21:25:13 -0800388
389 if (!isXBeforeFirstPage && !isXAfterLastPage) {
390 mSpringOverScrollX = 0;
391 }
392
Adam Cohen0ffac432013-07-10 11:19:26 -0700393 if (isXBeforeFirstPage) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700394 super.scrollTo(mIsRtl ? mMaxScrollX : mMinScrollX, y);
Adam Cohen68d73932010-11-15 10:50:58 -0800395 if (mAllowOverScroll) {
Adam Cohenc2d6e892014-10-16 09:49:24 -0700396 mWasInOverscroll = true;
Sunny Goyal70660032015-05-14 00:07:08 -0700397 if (mIsRtl) {
Adam Cohen0ffac432013-07-10 11:19:26 -0700398 overScroll(x - mMaxScrollX);
399 } else {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700400 overScroll(x - mMinScrollX);
Adam Cohen0ffac432013-07-10 11:19:26 -0700401 }
Adam Cohen68d73932010-11-15 10:50:58 -0800402 }
Adam Cohen0ffac432013-07-10 11:19:26 -0700403 } else if (isXAfterLastPage) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700404 super.scrollTo(mIsRtl ? mMinScrollX : mMaxScrollX, y);
Adam Cohen68d73932010-11-15 10:50:58 -0800405 if (mAllowOverScroll) {
Adam Cohenc2d6e892014-10-16 09:49:24 -0700406 mWasInOverscroll = true;
Sunny Goyal70660032015-05-14 00:07:08 -0700407 if (mIsRtl) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700408 overScroll(x - mMinScrollX);
Adam Cohen0ffac432013-07-10 11:19:26 -0700409 } else {
410 overScroll(x - mMaxScrollX);
411 }
Adam Cohen68d73932010-11-15 10:50:58 -0800412 }
413 } else {
Adam Cohenc2d6e892014-10-16 09:49:24 -0700414 if (mWasInOverscroll) {
415 overScroll(0);
416 mWasInOverscroll = false;
417 }
Adam Cohen68d73932010-11-15 10:50:58 -0800418 super.scrollTo(x, y);
419 }
Sunny Goyalb7b01352018-08-09 12:31:20 -0700420
Michael Jurka0142d492010-08-25 17:46:15 -0700421 }
422
Adam Cohen53805212013-10-01 10:39:23 -0700423 private void sendScrollAccessibilityEvent() {
Sunny Goyald0030b02017-12-08 15:07:24 -0800424 if (isObservedEventType(getContext(), AccessibilityEvent.TYPE_VIEW_SCROLLED)) {
Vadim Tryshevf4715972015-05-08 17:21:03 -0700425 if (mCurrentPage != getNextPage()) {
426 AccessibilityEvent ev =
427 AccessibilityEvent.obtain(AccessibilityEvent.TYPE_VIEW_SCROLLED);
Vadim Tryshev7066c122015-05-21 14:06:35 -0700428 ev.setScrollable(true);
429 ev.setScrollX(getScrollX());
430 ev.setScrollY(getScrollY());
431 ev.setMaxScrollX(mMaxScrollX);
432 ev.setMaxScrollY(0);
Adam Cohen53805212013-10-01 10:39:23 -0700433
Vadim Tryshevf4715972015-05-08 17:21:03 -0700434 sendAccessibilityEventUnchecked(ev);
Adam Cohen53805212013-10-01 10:39:23 -0700435 }
Adam Cohen53805212013-10-01 10:39:23 -0700436 }
437 }
438
Michael Jurka0142d492010-08-25 17:46:15 -0700439 // we moved this functionality to a helper function so SmoothPagedView can reuse it
440 protected boolean computeScrollHelper() {
Tony Wickham95cdb3a2016-02-18 14:37:07 -0800441 return computeScrollHelper(true);
442 }
443
Vadim Tryshev2c430b32018-04-04 14:45:21 -0700444 protected void announcePageForAccessibility() {
445 if (isAccessibilityEnabled(getContext())) {
446 // Notify the user when the page changes
447 announceForAccessibility(getCurrentPageDescription());
448 }
449 }
450
Tony Wickham95cdb3a2016-02-18 14:37:07 -0800451 protected boolean computeScrollHelper(boolean shouldInvalidate) {
Winson Chung321e9ee2010-08-09 13:37:56 -0700452 if (mScroller.computeScrollOffset()) {
Winson Chung557d6ed2011-07-08 15:34:52 -0700453 // Don't bother scrolling if the page does not need to be moved
Sunny Goyalb7b01352018-08-09 12:31:20 -0700454 if (getUnboundedScrollX() != mScroller.getCurrPos()
455 || getScrollX() != mScroller.getCurrPos()) {
456 scrollTo(mScroller.getCurrPos(), 0);
Winson Chung557d6ed2011-07-08 15:34:52 -0700457 }
Tony Wickham95cdb3a2016-02-18 14:37:07 -0800458 if (shouldInvalidate) {
459 invalidate();
460 }
Michael Jurka0142d492010-08-25 17:46:15 -0700461 return true;
Tony Wickham95cdb3a2016-02-18 14:37:07 -0800462 } else if (mNextPage != INVALID_PAGE && shouldInvalidate) {
Adam Cohen53805212013-10-01 10:39:23 -0700463 sendScrollAccessibilityEvent();
464
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700465 int prevPage = mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700466 mCurrentPage = validateNewPage(mNextPage);
Winson Chung86f77532010-08-24 11:08:22 -0700467 mNextPage = INVALID_PAGE;
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700468 notifyPageSwitchListener(prevPage);
Winson Chungb44b5242011-06-13 11:32:14 -0700469
Adam Cohen73aa9752010-11-24 16:26:58 -0800470 // We don't want to trigger a page end moving unless the page has settled
471 // and the user has stopped scrolling
Sunny Goyalaad33592018-08-07 17:20:35 -0700472 if (!mIsBeingDragged) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700473 pageEndTransition();
Adam Cohen73aa9752010-11-24 16:26:58 -0800474 }
Winson Chungc27d1bb2011-09-29 12:07:42 -0700475
Vadim Tryshev2c430b32018-04-04 14:45:21 -0700476 if (canAnnouncePageDescription()) {
477 announcePageForAccessibility();
Adam Cohen0ffac432013-07-10 11:19:26 -0700478 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700479 }
Michael Jurka0142d492010-08-25 17:46:15 -0700480 return false;
481 }
482
483 @Override
484 public void computeScroll() {
485 computeScrollHelper();
Winson Chung321e9ee2010-08-09 13:37:56 -0700486 }
487
Sunny Goyalce8809a2018-01-18 14:02:47 -0800488 public int getExpectedHeight() {
489 return getMeasuredHeight();
490 }
491
Adam Cohen410f3cd2013-09-22 12:09:32 -0700492 public int getNormalChildHeight() {
Sunny Goyalce8809a2018-01-18 14:02:47 -0800493 return getExpectedHeight() - getPaddingTop() - getPaddingBottom()
Sunny Goyalac00cba2017-11-13 15:58:01 -0800494 - mInsets.top - mInsets.bottom;
Adam Cohen410f3cd2013-09-22 12:09:32 -0700495 }
496
Sunny Goyalce8809a2018-01-18 14:02:47 -0800497 public int getExpectedWidth() {
498 return getMeasuredWidth();
499 }
500
Sunny Goyalbc683e92017-12-06 10:25:07 -0800501 public int getNormalChildWidth() {
Sunny Goyalce8809a2018-01-18 14:02:47 -0800502 return getExpectedWidth() - getPaddingLeft() - getPaddingRight()
Sunny Goyalbc683e92017-12-06 10:25:07 -0800503 - mInsets.left - mInsets.right;
504 }
505
Winson Chung321e9ee2010-08-09 13:37:56 -0700506 @Override
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800507 public void requestLayout() {
508 mIsLayoutValid = false;
509 super.requestLayout();
510 }
511
512 @Override
513 public void forceLayout() {
514 mIsLayoutValid = false;
515 super.forceLayout();
516 }
517
518 @Override
Winson Chung321e9ee2010-08-09 13:37:56 -0700519 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
Sunny Goyal8e2133b2015-05-06 13:39:07 -0700520 if (getChildCount() == 0) {
Winson Chungf0ea4d32011-06-06 14:27:16 -0700521 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
522 return;
523 }
524
Adam Cohen7d30a372013-07-01 17:03:59 -0700525 // We measure the dimensions of the PagedView to be larger than the pages so that when we
526 // zoom out (and scale down), the view is still contained in the parent
Adam Cohen7d30a372013-07-01 17:03:59 -0700527 int widthMode = MeasureSpec.getMode(widthMeasureSpec);
528 int widthSize = MeasureSpec.getSize(widthMeasureSpec);
529 int heightMode = MeasureSpec.getMode(heightMeasureSpec);
Winson Chung8aad6102012-05-11 16:27:49 -0700530 int heightSize = MeasureSpec.getSize(heightMeasureSpec);
Adam Cohen410f3cd2013-09-22 12:09:32 -0700531
Adam Cohen7d30a372013-07-01 17:03:59 -0700532 if (widthMode == MeasureSpec.UNSPECIFIED || heightMode == MeasureSpec.UNSPECIFIED) {
533 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
534 return;
Winson Chung321e9ee2010-08-09 13:37:56 -0700535 }
536
Winson Chung8aad6102012-05-11 16:27:49 -0700537 // Return early if we aren't given a proper dimension
538 if (widthSize <= 0 || heightSize <= 0) {
539 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
540 return;
541 }
542
Winson Chung321e9ee2010-08-09 13:37:56 -0700543 // The children are given the same width and height as the workspace
Michael Jurka5f1c5092010-09-03 14:15:02 -0700544 // unless they were set to WRAP_CONTENT
Winson Chung785d2eb2011-04-14 16:08:02 -0700545 if (DEBUG) Log.d(TAG, "PagedView.onMeasure(): " + widthSize + ", " + heightSize);
Michael Jurka5f1c5092010-09-03 14:15:02 -0700546
Sunny Goyalac00cba2017-11-13 15:58:01 -0800547 int myWidthSpec = MeasureSpec.makeMeasureSpec(
Sunny Goyal228153d2018-01-04 15:35:22 -0800548 widthSize - mInsets.left - mInsets.right, MeasureSpec.EXACTLY);
Sunny Goyalac00cba2017-11-13 15:58:01 -0800549 int myHeightSpec = MeasureSpec.makeMeasureSpec(
Sunny Goyal228153d2018-01-04 15:35:22 -0800550 heightSize - mInsets.top - mInsets.bottom, MeasureSpec.EXACTLY);
Adam Cohen96d30a12013-07-16 18:13:21 -0700551
Sunny Goyalac00cba2017-11-13 15:58:01 -0800552 // measureChildren takes accounts for content padding, we only need to care about extra
553 // space due to insets.
554 measureChildren(myWidthSpec, myHeightSpec);
555 setMeasuredDimension(widthSize, heightSize);
Adam Cohen60b07122011-11-14 17:26:06 -0800556 }
557
Sunny Goyalcf25b522015-07-09 00:01:18 -0700558 @SuppressLint("DrawAllocation")
Winson Chung321e9ee2010-08-09 13:37:56 -0700559 @Override
Michael Jurka28750fb2010-09-24 17:43:49 -0700560 protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800561 mIsLayoutValid = true;
Vadim Trysheveb701c62018-05-14 16:00:15 -0700562 final int childCount = getChildCount();
563 boolean pageScrollChanged = false;
564 if (mPageScrolls == null || childCount != mPageScrolls.length) {
565 mPageScrolls = new int[childCount];
566 pageScrollChanged = true;
567 }
568
569 if (childCount == 0) {
Winson Chungf0ea4d32011-06-06 14:27:16 -0700570 return;
571 }
572
Winson Chung785d2eb2011-04-14 16:08:02 -0700573 if (DEBUG) Log.d(TAG, "PagedView.onLayout()");
Winson Chung321e9ee2010-08-09 13:37:56 -0700574
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700575 if (getPageScrolls(mPageScrolls, true, SIMPLE_SCROLL_LOGIC)) {
576 pageScrollChanged = true;
Winson Chung321e9ee2010-08-09 13:37:56 -0700577 }
Winson Chungc3665fa2011-09-14 17:56:27 -0700578
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700579 final LayoutTransition transition = getLayoutTransition();
580 // If the transition is running defer updating max scroll, as some empty pages could
581 // still be present, and a max scroll change could cause sudden jumps in scroll.
582 if (transition != null && transition.isRunning()) {
583 transition.addTransitionListener(new LayoutTransition.TransitionListener() {
584
585 @Override
586 public void startTransition(LayoutTransition transition, ViewGroup container,
587 View view, int transitionType) { }
588
589 @Override
590 public void endTransition(LayoutTransition transition, ViewGroup container,
591 View view, int transitionType) {
592 // Wait until all transitions are complete.
593 if (!transition.isRunning()) {
594 transition.removeTransitionListener(this);
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700595 updateMinAndMaxScrollX();
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700596 }
597 }
598 });
Adam Cohenf698c6e2013-07-17 18:44:25 -0700599 } else {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700600 updateMinAndMaxScrollX();
Adam Cohenf698c6e2013-07-17 18:44:25 -0700601 }
602
Sunny Goyalcb037ee2015-07-08 16:41:21 -0700603 if (mFirstLayout && mCurrentPage >= 0 && mCurrentPage < childCount) {
604 updateCurrentPageScroll();
605 mFirstLayout = false;
606 }
607
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800608 if (mScroller.isFinished() && pageScrollChanged) {
Sunny Goyalc82c6392018-06-06 15:39:13 -0700609 setCurrentPage(getNextPage());
Adam Cohenf698c6e2013-07-17 18:44:25 -0700610 }
Winson Chunge3193b92010-09-10 11:44:42 -0700611 }
612
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700613 /**
614 * Initializes {@code outPageScrolls} with scroll positions for view at that index. The length
615 * of {@code outPageScrolls} should be same as the the childCount
616 *
617 */
618 protected boolean getPageScrolls(int[] outPageScrolls, boolean layoutChildren,
619 ComputePageScrollsLogic scrollLogic) {
620 final int childCount = getChildCount();
621
622 final int startIndex = mIsRtl ? childCount - 1 : 0;
623 final int endIndex = mIsRtl ? -1 : childCount;
624 final int delta = mIsRtl ? -1 : 1;
625
Vadim Tryshev84b46f02018-04-27 17:45:10 -0700626 final int verticalCenter = (getPaddingTop() + getMeasuredHeight() + mInsets.top
627 - mInsets.bottom - getPaddingBottom()) / 2;
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700628
Vadim Tryshevcc0c98a2018-04-26 10:47:05 -0700629 final int scrollOffsetLeft = mInsets.left + getPaddingLeft();
Sunny Goyalc82c6392018-06-06 15:39:13 -0700630 final int scrollOffsetRight = getWidth() - getPaddingRight() - mInsets.right;
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700631 boolean pageScrollChanged = false;
632
Sunny Goyalc82c6392018-06-06 15:39:13 -0700633 for (int i = startIndex, childLeft = scrollOffsetLeft; i != endIndex; i += delta) {
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700634 final View child = getPageAt(i);
635 if (scrollLogic.shouldIncludeView(child)) {
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700636 final int childWidth = child.getMeasuredWidth();
Sunny Goyalc82c6392018-06-06 15:39:13 -0700637 final int childRight = childLeft + childWidth;
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700638
639 if (layoutChildren) {
640 final int childHeight = child.getMeasuredHeight();
Sunny Goyalc82c6392018-06-06 15:39:13 -0700641 final int childTop = verticalCenter - childHeight / 2;
642 child.layout(childLeft, childTop, childRight, childTop + childHeight);
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700643 }
644
Sunny Goyalc82c6392018-06-06 15:39:13 -0700645 // In case the pages are of different width, align the page to left or right edge
646 // based on the orientation.
647 final int pageScroll = mIsRtl
648 ? (childLeft - scrollOffsetLeft)
649 : Math.max(0, childRight - scrollOffsetRight);
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700650 if (outPageScrolls[i] != pageScroll) {
651 pageScrollChanged = true;
652 outPageScrolls[i] = pageScroll;
653 }
654
655 childLeft += childWidth + mPageSpacing + getChildGap();
656 }
657 }
658 return pageScrollChanged;
659 }
660
Sunny Goyala1fbd842015-05-20 13:40:27 -0700661 protected int getChildGap() {
662 return 0;
663 }
664
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700665 protected void updateMinAndMaxScrollX() {
666 mMinScrollX = computeMinScrollX();
Tony Wickhamf549dab2016-05-16 09:54:06 -0700667 mMaxScrollX = computeMaxScrollX();
668 }
669
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700670 protected int computeMinScrollX() {
671 return 0;
Tony50876bf2018-09-19 23:09:14 -0400672 }
673
Tony Wickhamf549dab2016-05-16 09:54:06 -0700674 protected int computeMaxScrollX() {
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700675 int childCount = getChildCount();
676 if (childCount > 0) {
Sunny Goyal70660032015-05-14 00:07:08 -0700677 final int index = mIsRtl ? 0 : childCount - 1;
Tony Wickhamf549dab2016-05-16 09:54:06 -0700678 return getScrollForPage(index);
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700679 } else {
Tony Wickhamf549dab2016-05-16 09:54:06 -0700680 return 0;
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700681 }
682 }
683
Adam Cohen3b185e22013-10-29 14:45:58 -0700684 public void setPageSpacing(int pageSpacing) {
685 mPageSpacing = pageSpacing;
686 requestLayout();
687 }
688
Tony50876bf2018-09-19 23:09:14 -0400689 public int getPageSpacing() {
690 return mPageSpacing;
691 }
692
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800693 private void dispatchPageCountChanged() {
694 if (mPageIndicator != null) {
695 mPageIndicator.setMarkersCount(getChildCount());
Winson Chungd2be3812013-07-16 11:11:32 -0700696 }
Adam Cohen2591f6a2011-10-25 14:36:40 -0700697 // This ensures that when children are added, they get the correct transforms / alphas
698 // in accordance with any scroll effects.
Adam Cohen2591f6a2011-10-25 14:36:40 -0700699 invalidate();
700 }
701
Michael Jurka8b805b12012-04-18 14:23:14 -0700702 @Override
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800703 public void onViewAdded(View child) {
Winson Chungc7c51582018-02-23 17:58:36 -0800704 super.onViewAdded(child);
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800705 dispatchPageCountChanged();
706 }
707
708 @Override
709 public void onViewRemoved(View child) {
Winson Chungc7c51582018-02-23 17:58:36 -0800710 super.onViewRemoved(child);
Tonya361c722017-07-04 09:43:06 -0700711 mCurrentPage = validateNewPage(mCurrentPage);
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800712 dispatchPageCountChanged();
Winson Chungd2be3812013-07-16 11:11:32 -0700713 }
714
Adam Cohen73894962011-10-31 13:17:17 -0700715 protected int getChildOffset(int index) {
Adam Cohen7d30a372013-07-01 17:03:59 -0700716 if (index < 0 || index > getChildCount() - 1) return 0;
Sunny Goyal228153d2018-01-04 15:35:22 -0800717 return getPageAt(index).getLeft();
Adam Cohen73894962011-10-31 13:17:17 -0700718 }
719
Winson Chung321e9ee2010-08-09 13:37:56 -0700720 @Override
721 public boolean requestChildRectangleOnScreen(View child, Rect rectangle, boolean immediate) {
Adam Cohenae4f1552011-10-20 00:15:42 -0700722 int page = indexToPage(indexOfChild(child));
Winson Chung86f77532010-08-24 11:08:22 -0700723 if (page != mCurrentPage || !mScroller.isFinished()) {
Vadim Trysheveeaa8ee2018-04-11 12:23:42 -0700724 if (immediate) {
725 setCurrentPage(page);
726 } else {
727 snapToPage(page);
728 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700729 return true;
730 }
731 return false;
732 }
733
734 @Override
735 protected boolean onRequestFocusInDescendants(int direction, Rect previouslyFocusedRect) {
Winson Chung86f77532010-08-24 11:08:22 -0700736 int focusablePage;
737 if (mNextPage != INVALID_PAGE) {
738 focusablePage = mNextPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700739 } else {
Winson Chung86f77532010-08-24 11:08:22 -0700740 focusablePage = mCurrentPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700741 }
Winson Chung86f77532010-08-24 11:08:22 -0700742 View v = getPageAt(focusablePage);
Winson Chung321e9ee2010-08-09 13:37:56 -0700743 if (v != null) {
Adam Cohen76fc0852011-06-17 13:26:23 -0700744 return v.requestFocus(direction, previouslyFocusedRect);
Winson Chung321e9ee2010-08-09 13:37:56 -0700745 }
746 return false;
747 }
748
749 @Override
750 public boolean dispatchUnhandledMove(View focused, int direction) {
Sunny Goyal0c4e3722015-12-01 13:21:49 -0800751 if (super.dispatchUnhandledMove(focused, direction)) {
752 return true;
753 }
754
755 if (mIsRtl) {
756 if (direction == View.FOCUS_LEFT) {
757 direction = View.FOCUS_RIGHT;
758 } else if (direction == View.FOCUS_RIGHT) {
759 direction = View.FOCUS_LEFT;
760 }
761 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700762 if (direction == View.FOCUS_LEFT) {
Winson Chung86f77532010-08-24 11:08:22 -0700763 if (getCurrentPage() > 0) {
764 snapToPage(getCurrentPage() - 1);
Sunny Goyalc82c6392018-06-06 15:39:13 -0700765 getChildAt(getCurrentPage() - 1).requestFocus(direction);
Winson Chung321e9ee2010-08-09 13:37:56 -0700766 return true;
767 }
768 } else if (direction == View.FOCUS_RIGHT) {
Winson Chung86f77532010-08-24 11:08:22 -0700769 if (getCurrentPage() < getPageCount() - 1) {
770 snapToPage(getCurrentPage() + 1);
Sunny Goyalc82c6392018-06-06 15:39:13 -0700771 getChildAt(getCurrentPage() + 1).requestFocus(direction);
Winson Chung321e9ee2010-08-09 13:37:56 -0700772 return true;
773 }
774 }
Sunny Goyal0c4e3722015-12-01 13:21:49 -0800775 return false;
Winson Chung321e9ee2010-08-09 13:37:56 -0700776 }
777
778 @Override
779 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) {
Jon Miranda6a858172016-10-25 16:19:17 -0700780 if (getDescendantFocusability() == FOCUS_BLOCK_DESCENDANTS) {
781 return;
782 }
783
Adam Cohen0ffac432013-07-10 11:19:26 -0700784 // XXX-RTL: This will be fixed in a future CL
Winson Chung86f77532010-08-24 11:08:22 -0700785 if (mCurrentPage >= 0 && mCurrentPage < getPageCount()) {
alanvaf519952012-05-07 17:33:22 -0700786 getPageAt(mCurrentPage).addFocusables(views, direction, focusableMode);
Winson Chung321e9ee2010-08-09 13:37:56 -0700787 }
788 if (direction == View.FOCUS_LEFT) {
Winson Chung86f77532010-08-24 11:08:22 -0700789 if (mCurrentPage > 0) {
alanvaf519952012-05-07 17:33:22 -0700790 getPageAt(mCurrentPage - 1).addFocusables(views, direction, focusableMode);
Winson Chung321e9ee2010-08-09 13:37:56 -0700791 }
792 } else if (direction == View.FOCUS_RIGHT){
Winson Chung86f77532010-08-24 11:08:22 -0700793 if (mCurrentPage < getPageCount() - 1) {
alanvaf519952012-05-07 17:33:22 -0700794 getPageAt(mCurrentPage + 1).addFocusables(views, direction, focusableMode);
Winson Chung321e9ee2010-08-09 13:37:56 -0700795 }
796 }
797 }
798
799 /**
800 * If one of our descendant views decides that it could be focused now, only
Winson Chung86f77532010-08-24 11:08:22 -0700801 * pass that along if it's on the current page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700802 *
Winson Chung86f77532010-08-24 11:08:22 -0700803 * This happens when live folders requery, and if they're off page, they
804 * end up calling requestFocus, which pulls it on page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700805 */
806 @Override
807 public void focusableViewAvailable(View focused) {
Winson Chung86f77532010-08-24 11:08:22 -0700808 View current = getPageAt(mCurrentPage);
Winson Chung321e9ee2010-08-09 13:37:56 -0700809 View v = focused;
810 while (true) {
811 if (v == current) {
812 super.focusableViewAvailable(focused);
813 return;
814 }
815 if (v == this) {
816 return;
817 }
818 ViewParent parent = v.getParent();
819 if (parent instanceof View) {
820 v = (View)v.getParent();
821 } else {
822 return;
823 }
824 }
825 }
826
827 /**
828 * {@inheritDoc}
829 */
830 @Override
831 public void requestDisallowInterceptTouchEvent(boolean disallowIntercept) {
832 if (disallowIntercept) {
833 // We need to make sure to cancel our long press if
834 // a scrollable widget takes over touch events
Adam Cohen22f823d2011-09-01 17:22:18 -0700835 final View currentPage = getPageAt(mCurrentPage);
Winson Chung86f77532010-08-24 11:08:22 -0700836 currentPage.cancelLongPress();
Winson Chung321e9ee2010-08-09 13:37:56 -0700837 }
838 super.requestDisallowInterceptTouchEvent(disallowIntercept);
839 }
840
841 @Override
842 public boolean onInterceptTouchEvent(MotionEvent ev) {
843 /*
844 * This method JUST determines whether we want to intercept the motion.
845 * If we return true, onTouchEvent will be called and we do the actual
846 * scrolling there.
847 */
848
Winson Chung45e1d6e2010-11-09 17:19:49 -0800849 // Skip touch handling if there are no pages to swipe
Sunny Goyalc4bb3732019-06-20 11:34:14 -0700850 if (getChildCount() <= 0 || shouldDisableGestures(ev)) return false;
851
852 acquireVelocityTrackerAndAddMovement(ev);
Winson Chung45e1d6e2010-11-09 17:19:49 -0800853
Winson Chung321e9ee2010-08-09 13:37:56 -0700854 /*
855 * Shortcut the most recurring case: the user is in the dragging
856 * state and he is moving his finger. We want to intercept this
857 * motion.
858 */
859 final int action = ev.getAction();
Sunny Goyalaad33592018-08-07 17:20:35 -0700860 if ((action == MotionEvent.ACTION_MOVE) && mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -0700861 return true;
862 }
863
Winson Chung321e9ee2010-08-09 13:37:56 -0700864 switch (action & MotionEvent.ACTION_MASK) {
865 case MotionEvent.ACTION_MOVE: {
866 /*
867 * mIsBeingDragged == false, otherwise the shortcut would have caught it. Check
868 * whether the user has moved far enough from his original down touch.
869 */
Michael Jurka1ff706b2010-09-14 17:35:20 -0700870 if (mActivePointerId != INVALID_POINTER) {
871 determineScrollingStart(ev);
Michael Jurka1ff706b2010-09-14 17:35:20 -0700872 }
873 // if mActivePointerId is INVALID_POINTER, then we must have missed an ACTION_DOWN
874 // event. in that case, treat the first occurence of a move event as a ACTION_DOWN
875 // i.e. fall through to the next case (don't break)
876 // (We sometimes miss ACTION_DOWN events in Workspace because it ignores all events
877 // while it's small- this was causing a crash before we checked for INVALID_POINTER)
Adam Cohen93c97562013-09-26 13:48:01 -0700878 break;
Winson Chung321e9ee2010-08-09 13:37:56 -0700879 }
880
881 case MotionEvent.ACTION_DOWN: {
882 final float x = ev.getX();
883 final float y = ev.getY();
884 // Remember location of down touch
885 mDownMotionX = x;
Adam Cohen7d30a372013-07-01 17:03:59 -0700886 mDownMotionY = y;
Winson Chung321e9ee2010-08-09 13:37:56 -0700887 mLastMotionX = x;
Winson Chungc0844aa2011-02-02 15:25:58 -0800888 mLastMotionXRemainder = 0;
Adam Cohenaefd4e12011-02-14 16:39:38 -0800889 mTotalMotionX = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -0700890 mActivePointerId = ev.getPointerId(0);
Adam Cohen7d30a372013-07-01 17:03:59 -0700891
Winson Chung321e9ee2010-08-09 13:37:56 -0700892 /*
893 * If being flinged and user touches the screen, initiate drag;
894 * otherwise don't. mScroller.isFinished should be false when
895 * being flinged.
896 */
Sunny Goyalb7b01352018-08-09 12:31:20 -0700897 final int xDist = Math.abs(mScroller.getFinalPos() - mScroller.getCurrPos());
Adam Cohena7652152013-11-18 20:06:55 +0000898 final boolean finishedScrolling = (mScroller.isFinished() || xDist < mTouchSlop / 3);
Adam Cohen2da0a052013-11-08 06:28:17 -0800899
Winson Chung5f2aa4e2010-08-20 14:49:25 -0700900 if (finishedScrolling) {
Sunny Goyalaad33592018-08-07 17:20:35 -0700901 mIsBeingDragged = false;
Adam Cohen59b5c792013-12-04 16:09:07 -0800902 if (!mScroller.isFinished() && !mFreeScroll) {
Adam Cohena7652152013-11-18 20:06:55 +0000903 setCurrentPage(getNextPage());
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700904 pageEndTransition();
Adam Cohen2da0a052013-11-08 06:28:17 -0800905 }
Winson Chung5f2aa4e2010-08-20 14:49:25 -0700906 } else {
Tony Wickham44a58882019-04-09 14:24:33 -0700907 mIsBeingDragged = true;
Winson Chung5f2aa4e2010-08-20 14:49:25 -0700908 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700909
Winson Chung321e9ee2010-08-09 13:37:56 -0700910 break;
911 }
912
Winson Chung321e9ee2010-08-09 13:37:56 -0700913 case MotionEvent.ACTION_UP:
Jeff Brown1d0867c2010-12-02 18:27:39 -0800914 case MotionEvent.ACTION_CANCEL:
Adam Cohen7d30a372013-07-01 17:03:59 -0700915 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -0700916 break;
917
918 case MotionEvent.ACTION_POINTER_UP:
919 onSecondaryPointerUp(ev);
Adam Cohen6342bba2011-03-10 11:33:35 -0800920 releaseVelocityTracker();
Winson Chung321e9ee2010-08-09 13:37:56 -0700921 break;
922 }
923
924 /*
925 * The only time we want to intercept motion events is if we are in the
926 * drag mode.
927 */
Sunny Goyalaad33592018-08-07 17:20:35 -0700928 return mIsBeingDragged;
Winson Chung321e9ee2010-08-09 13:37:56 -0700929 }
930
Sunny Goyal7c7be8c2018-03-07 19:58:07 -0800931 public boolean isHandlingTouch() {
Sunny Goyalaad33592018-08-07 17:20:35 -0700932 return mIsBeingDragged;
Sunny Goyal7c7be8c2018-03-07 19:58:07 -0800933 }
934
Adam Cohenf8d28232011-02-01 21:47:00 -0800935 protected void determineScrollingStart(MotionEvent ev) {
936 determineScrollingStart(ev, 1.0f);
937 }
938
Winson Chung321e9ee2010-08-09 13:37:56 -0700939 /*
940 * Determines if we should change the touch state to start scrolling after the
941 * user moves their touch point too far.
942 */
Adam Cohenf8d28232011-02-01 21:47:00 -0800943 protected void determineScrollingStart(MotionEvent ev, float touchSlopScale) {
Adam Cohen7d30a372013-07-01 17:03:59 -0700944 // Disallow scrolling if we don't have a valid pointer index
Winson Chung321e9ee2010-08-09 13:37:56 -0700945 final int pointerIndex = ev.findPointerIndex(mActivePointerId);
Adam Cohen7d30a372013-07-01 17:03:59 -0700946 if (pointerIndex == -1) return;
947
Winson Chung321e9ee2010-08-09 13:37:56 -0700948 final float x = ev.getX(pointerIndex);
Winson Chung321e9ee2010-08-09 13:37:56 -0700949 final int xDiff = (int) Math.abs(x - mLastMotionX);
Adam Cohenf8d28232011-02-01 21:47:00 -0800950 final int touchSlop = Math.round(touchSlopScale * mTouchSlop);
Winson Chung321e9ee2010-08-09 13:37:56 -0700951 boolean xMoved = xDiff > touchSlop;
Winson Chung321e9ee2010-08-09 13:37:56 -0700952
Sunny Goyal5a1f53b2015-05-27 10:24:24 -0700953 if (xMoved) {
954 // Scroll if the user moved far enough along the X axis
Sunny Goyalaad33592018-08-07 17:20:35 -0700955 mIsBeingDragged = true;
Sunny Goyal5a1f53b2015-05-27 10:24:24 -0700956 mTotalMotionX += Math.abs(mLastMotionX - x);
957 mLastMotionX = x;
958 mLastMotionXRemainder = 0;
Sunny Goyal5a1f53b2015-05-27 10:24:24 -0700959 onScrollInteractionBegin();
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700960 pageBeginTransition();
Tony Wickhamdadb3042016-02-24 11:07:00 -0800961 // Stop listening for things like pinches.
962 requestDisallowInterceptTouchEvent(true);
Adam Cohenf8d28232011-02-01 21:47:00 -0800963 }
964 }
965
966 protected void cancelCurrentPageLongPress() {
Sunny Goyal8e2133b2015-05-06 13:39:07 -0700967 // Try canceling the long press. It could also have been scheduled
968 // by a distant descendant, so use the mAllowLongPress flag to block
969 // everything
970 final View currentPage = getPageAt(mCurrentPage);
971 if (currentPage != null) {
972 currentPage.cancelLongPress();
Winson Chung321e9ee2010-08-09 13:37:56 -0700973 }
974 }
975
Adam Cohenb5ba0972011-09-07 18:02:31 -0700976 protected float getScrollProgress(int screenCenter, View v, int page) {
Sunny Goyal228153d2018-01-04 15:35:22 -0800977 final int halfScreenSize = getMeasuredWidth() / 2;
Adam Cohenb5ba0972011-09-07 18:02:31 -0700978
Adam Cohenedb40762013-07-18 16:45:45 -0700979 int delta = screenCenter - (getScrollForPage(page) + halfScreenSize);
Adam Cohen3b185e22013-10-29 14:45:58 -0700980 int count = getChildCount();
981
982 final int totalDistance;
983
984 int adjacentPage = page + 1;
Sunny Goyal70660032015-05-14 00:07:08 -0700985 if ((delta < 0 && !mIsRtl) || (delta > 0 && mIsRtl)) {
Adam Cohen3b185e22013-10-29 14:45:58 -0700986 adjacentPage = page - 1;
987 }
988
989 if (adjacentPage < 0 || adjacentPage > count - 1) {
990 totalDistance = v.getMeasuredWidth() + mPageSpacing;
991 } else {
992 totalDistance = Math.abs(getScrollForPage(adjacentPage) - getScrollForPage(page));
993 }
Adam Cohenb5ba0972011-09-07 18:02:31 -0700994
995 float scrollProgress = delta / (totalDistance * 1.0f);
Sunny Goyal8e2133b2015-05-06 13:39:07 -0700996 scrollProgress = Math.min(scrollProgress, MAX_SCROLL_PROGRESS);
997 scrollProgress = Math.max(scrollProgress, - MAX_SCROLL_PROGRESS);
Adam Cohenb5ba0972011-09-07 18:02:31 -0700998 return scrollProgress;
999 }
1000
Adam Cohenedb40762013-07-18 16:45:45 -07001001 public int getScrollForPage(int index) {
Adam Cohen1f1f45d2013-10-02 09:40:18 -07001002 if (mPageScrolls == null || index >= mPageScrolls.length || index < 0) {
Adam Cohenedb40762013-07-18 16:45:45 -07001003 return 0;
1004 } else {
1005 return mPageScrolls[index];
1006 }
1007 }
1008
Adam Cohen564a2e72013-10-09 14:47:32 -07001009 // While layout transitions are occurring, a child's position may stray from its baseline
1010 // position. This method returns the magnitude of this stray at any given time.
1011 public int getLayoutTransitionOffsetForPage(int index) {
1012 if (mPageScrolls == null || index >= mPageScrolls.length || index < 0) {
1013 return 0;
1014 } else {
1015 View child = getChildAt(index);
Adam Cohen3b185e22013-10-29 14:45:58 -07001016
Sunny Goyal228153d2018-01-04 15:35:22 -08001017 int scrollOffset = mIsRtl ? getPaddingRight() : getPaddingLeft();
1018 int baselineX = mPageScrolls[index] + scrollOffset;
Adam Cohen564a2e72013-10-09 14:47:32 -07001019 return (int) (child.getX() - baselineX);
1020 }
1021 }
1022
Jon Miranda71cb80c2019-01-24 21:25:13 -08001023 @Override
1024 protected void dispatchDraw(Canvas canvas) {
1025 if (mScroller.isSpringing() && mSpringOverScrollX != 0) {
1026 int saveCount = canvas.save();
1027
1028 canvas.translate(-mSpringOverScrollX, 0);
1029 super.dispatchDraw(canvas);
1030
1031 canvas.restoreToCount(saveCount);
1032 } else {
1033 super.dispatchDraw(canvas);
1034 }
1035 }
1036
Sunny Goyalb7b01352018-08-09 12:31:20 -07001037 protected void dampedOverScroll(int amount) {
Jon Miranda71cb80c2019-01-24 21:25:13 -08001038 mSpringOverScrollX = amount;
1039 if (amount == 0) {
1040 return;
1041 }
Adam Cohen8d769d62017-06-23 17:27:38 -07001042
Sunny Goyal228153d2018-01-04 15:35:22 -08001043 int overScrollAmount = OverScroll.dampedScroll(amount, getMeasuredWidth());
Jon Miranda71cb80c2019-01-24 21:25:13 -08001044 mSpringOverScrollX = overScrollAmount;
1045 if (mScroller.isSpringing()) {
1046 invalidate();
1047 return;
1048 }
1049
Tony Wickham66d1c2f2019-04-24 11:32:59 -07001050 int x = Utilities.boundToRange(getScrollX(), mMinScrollX, mMaxScrollX);
1051 super.scrollTo(x + overScrollAmount, getScrollY());
Adam Cohen68d73932010-11-15 10:50:58 -08001052 invalidate();
1053 }
1054
Sunny Goyalb7b01352018-08-09 12:31:20 -07001055 protected void overScroll(int amount) {
Jon Miranda71cb80c2019-01-24 21:25:13 -08001056 mSpringOverScrollX = amount;
1057 if (mScroller.isSpringing()) {
1058 invalidate();
1059 return;
1060 }
1061
Sunny Goyalb7b01352018-08-09 12:31:20 -07001062 if (amount == 0) return;
1063
1064 if (mFreeScroll && !mScroller.isFinished()) {
1065 if (amount < 0) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -07001066 super.scrollTo(mMinScrollX + amount, getScrollY());
Sunny Goyalb7b01352018-08-09 12:31:20 -07001067 } else {
1068 super.scrollTo(mMaxScrollX + amount, getScrollY());
1069 }
1070 } else {
1071 dampedOverScroll(amount);
1072 }
Adam Cohenb5ba0972011-09-07 18:02:31 -07001073 }
1074
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001075
Tony Wickham023f4042019-01-29 10:52:31 -08001076 public void setEnableFreeScroll(boolean freeScroll) {
Winson Chung0e449002019-04-26 11:09:58 -07001077 if (mFreeScroll == freeScroll) {
1078 return;
1079 }
1080
Tony Wickham8f7ead32016-04-07 18:46:44 -07001081 boolean wasFreeScroll = mFreeScroll;
Adam Cohenf358a4b2013-07-23 16:47:31 -07001082 mFreeScroll = freeScroll;
1083
Adam Cohenf9618852013-11-08 06:45:03 -08001084 if (mFreeScroll) {
Sunny Goyal4d519f22017-10-24 10:32:40 -07001085 setCurrentPage(getNextPage());
Tony Wickham8f7ead32016-04-07 18:46:44 -07001086 } else if (wasFreeScroll) {
1087 snapToPage(getNextPage());
Adam Cohenf358a4b2013-07-23 16:47:31 -07001088 }
Adam Cohenf358a4b2013-07-23 16:47:31 -07001089 }
1090
Sunny Goyal2f0ec852015-03-26 13:38:27 -07001091 protected void setEnableOverscroll(boolean enable) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001092 mAllowOverScroll = enable;
1093 }
1094
Winson Chung321e9ee2010-08-09 13:37:56 -07001095 @Override
1096 public boolean onTouchEvent(MotionEvent ev) {
Winson Chung45e1d6e2010-11-09 17:19:49 -08001097 // Skip touch handling if there are no pages to swipe
Sunny Goyalc4bb3732019-06-20 11:34:14 -07001098 if (getChildCount() <= 0 || shouldDisableGestures(ev)) return false;
Winson Chung45e1d6e2010-11-09 17:19:49 -08001099
Michael Jurkab8f06722010-10-10 15:58:46 -07001100 acquireVelocityTrackerAndAddMovement(ev);
Winson Chung321e9ee2010-08-09 13:37:56 -07001101
1102 final int action = ev.getAction();
1103
1104 switch (action & MotionEvent.ACTION_MASK) {
1105 case MotionEvent.ACTION_DOWN:
1106 /*
1107 * If being flinged and user touches, stop the fling. isFinished
1108 * will be false if being flinged.
1109 */
1110 if (!mScroller.isFinished()) {
Adam Cohen8bdbaab2013-10-29 15:25:02 -07001111 abortScrollerAnimation(false);
Winson Chung321e9ee2010-08-09 13:37:56 -07001112 }
1113
1114 // Remember where the motion event started
1115 mDownMotionX = mLastMotionX = ev.getX();
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001116 mDownMotionY = ev.getY();
Winson Chungc0844aa2011-02-02 15:25:58 -08001117 mLastMotionXRemainder = 0;
Adam Cohenaefd4e12011-02-14 16:39:38 -08001118 mTotalMotionX = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -07001119 mActivePointerId = ev.getPointerId(0);
Adam Cohen7d30a372013-07-01 17:03:59 -07001120
Sunny Goyalaad33592018-08-07 17:20:35 -07001121 if (mIsBeingDragged) {
Adam Cohenc2d6e892014-10-16 09:49:24 -07001122 onScrollInteractionBegin();
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001123 pageBeginTransition();
Michael Jurka0142d492010-08-25 17:46:15 -07001124 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001125 break;
1126
1127 case MotionEvent.ACTION_MOVE:
Sunny Goyalaad33592018-08-07 17:20:35 -07001128 if (mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001129 // Scroll to follow the motion event
1130 final int pointerIndex = ev.findPointerIndex(mActivePointerId);
Adam Cohen7d30a372013-07-01 17:03:59 -07001131
1132 if (pointerIndex == -1) return true;
1133
Winson Chung321e9ee2010-08-09 13:37:56 -07001134 final float x = ev.getX(pointerIndex);
Winson Chungc0844aa2011-02-02 15:25:58 -08001135 final float deltaX = mLastMotionX + mLastMotionXRemainder - x;
Winson Chung321e9ee2010-08-09 13:37:56 -07001136
Adam Cohenaefd4e12011-02-14 16:39:38 -08001137 mTotalMotionX += Math.abs(deltaX);
1138
Winson Chungc0844aa2011-02-02 15:25:58 -08001139 // Only scroll and update mLastMotionX if we have moved some discrete amount. We
1140 // keep the remainder because we are actually testing if we've moved from the last
1141 // scrolled position (which is discrete).
1142 if (Math.abs(deltaX) >= 1.0f) {
Sunny Goyal5a1f53b2015-05-27 10:24:24 -07001143 scrollBy((int) deltaX, 0);
Winson Chungc0844aa2011-02-02 15:25:58 -08001144 mLastMotionX = x;
1145 mLastMotionXRemainder = deltaX - (int) deltaX;
Winson Chung321e9ee2010-08-09 13:37:56 -07001146 } else {
1147 awakenScrollBars();
1148 }
Adam Cohen564976a2010-10-13 18:52:07 -07001149 } else {
Winson Chung321e9ee2010-08-09 13:37:56 -07001150 determineScrollingStart(ev);
1151 }
1152 break;
1153
1154 case MotionEvent.ACTION_UP:
Sunny Goyalaad33592018-08-07 17:20:35 -07001155 if (mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001156 final int activePointerId = mActivePointerId;
1157 final int pointerIndex = ev.findPointerIndex(activePointerId);
1158 final float x = ev.getX(pointerIndex);
Sunny Goyal4bb8b062019-02-19 16:37:38 -08001159 final VelocityTracker velocityTracker = mVelocityTracker;
1160 velocityTracker.computeCurrentVelocity(1000, mMaximumVelocity);
1161 int velocityX = (int) velocityTracker.getXVelocity(mActivePointerId);
Winson Chung9cfd25f2010-10-24 16:09:28 -07001162 final int deltaX = (int) (x - mDownMotionX);
Adam Cohen96d30a12013-07-16 18:13:21 -07001163 final int pageWidth = getPageAt(mCurrentPage).getMeasuredWidth();
Adam Cohen00481b32011-11-18 12:03:48 -08001164 boolean isSignificantMove = Math.abs(deltaX) > pageWidth *
1165 SIGNIFICANT_MOVE_THRESHOLD;
Adam Cohenaefd4e12011-02-14 16:39:38 -08001166
Adam Cohenb64cb5a2011-02-15 13:53:42 -08001167 mTotalMotionX += Math.abs(mLastMotionX + mLastMotionXRemainder - x);
Tony Makc25afd02018-02-27 14:43:47 +00001168 boolean isFling = mTotalMotionX > mTouchSlop && shouldFlingForVelocity(velocityX);
Sunny Goyalb7b01352018-08-09 12:31:20 -07001169 boolean isDeltaXLeft = mIsRtl ? deltaX > 0 : deltaX < 0;
1170 boolean isVelocityXLeft = mIsRtl ? velocityX > 0 : velocityX < 0;
Adam Cohen00481b32011-11-18 12:03:48 -08001171
Adam Cohenf358a4b2013-07-23 16:47:31 -07001172 if (!mFreeScroll) {
1173 // In the case that the page is moved far to one direction and then is flung
1174 // in the opposite direction, we use a threshold to determine whether we should
1175 // just return to the starting page, or if we should skip one further.
1176 boolean returnToOriginalPage = false;
1177 if (Math.abs(deltaX) > pageWidth * RETURN_TO_ORIGINAL_PAGE_THRESHOLD &&
1178 Math.signum(velocityX) != Math.signum(deltaX) && isFling) {
1179 returnToOriginalPage = true;
1180 }
Adam Cohenaefd4e12011-02-14 16:39:38 -08001181
Adam Cohenf358a4b2013-07-23 16:47:31 -07001182 int finalPage;
1183 // We give flings precedence over large moves, which is why we short-circuit our
1184 // test for a large move if a fling has been registered. That is, a large
1185 // move to the left and fling to the right will register as a fling to the right.
Sunny Goyalb7b01352018-08-09 12:31:20 -07001186
Adam Cohenf358a4b2013-07-23 16:47:31 -07001187 if (((isSignificantMove && !isDeltaXLeft && !isFling) ||
1188 (isFling && !isVelocityXLeft)) && mCurrentPage > 0) {
1189 finalPage = returnToOriginalPage ? mCurrentPage : mCurrentPage - 1;
1190 snapToPageWithVelocity(finalPage, velocityX);
1191 } else if (((isSignificantMove && isDeltaXLeft && !isFling) ||
1192 (isFling && isVelocityXLeft)) &&
1193 mCurrentPage < getChildCount() - 1) {
1194 finalPage = returnToOriginalPage ? mCurrentPage : mCurrentPage + 1;
1195 snapToPageWithVelocity(finalPage, velocityX);
1196 } else {
1197 snapToDestination();
Adam Cohenf358a4b2013-07-23 16:47:31 -07001198 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001199 } else {
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001200 if (!mScroller.isFinished()) {
1201 abortScrollerAnimation(true);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001202 }
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001203
Sunny Goyalb7b01352018-08-09 12:31:20 -07001204 int initialScrollX = getScrollX();
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001205
Sunny Goyalb7b01352018-08-09 12:31:20 -07001206 if (((initialScrollX >= mMaxScrollX) && (isVelocityXLeft || !isFling)) ||
Tony Wickham66d1c2f2019-04-24 11:32:59 -07001207 ((initialScrollX <= mMinScrollX) && (!isVelocityXLeft || !isFling))) {
1208 mScroller.springBack(getScrollX(), mMinScrollX, mMaxScrollX);
Tony Wickham312209b2019-06-18 15:54:29 -07001209 mNextPage = getPageNearestToCenterOfScreen();
Sunny Goyalb7b01352018-08-09 12:31:20 -07001210 } else {
1211 mScroller.setInterpolator(mDefaultInterpolator);
1212 mScroller.fling(initialScrollX, -velocityX,
Tony Wickham66d1c2f2019-04-24 11:32:59 -07001213 mMinScrollX, mMaxScrollX,
Sunny Goyalb7b01352018-08-09 12:31:20 -07001214 Math.round(getWidth() * 0.5f * OVERSCROLL_DAMP_FACTOR));
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001215
Sunny Goyalb7b01352018-08-09 12:31:20 -07001216 int finalX = mScroller.getFinalPos();
1217 mNextPage = getPageNearestToCenterOfScreen(finalX);
1218
1219 int firstPageScroll = getScrollForPage(!mIsRtl ? 0 : getPageCount() - 1);
1220 int lastPageScroll = getScrollForPage(!mIsRtl ? getPageCount() - 1 : 0);
Tony Wickham66d1c2f2019-04-24 11:32:59 -07001221 if (finalX > mMinScrollX && finalX < mMaxScrollX) {
Sunny Goyalb7b01352018-08-09 12:31:20 -07001222 // If scrolling ends in the half of the added space that is closer to
1223 // the end, settle to the end. Otherwise snap to the nearest page.
1224 // If flinging past one of the ends, don't change the velocity as it
1225 // will get stopped at the end anyway.
Tony Wickham66d1c2f2019-04-24 11:32:59 -07001226 int pageSnappedX = finalX < (firstPageScroll + mMinScrollX) / 2
1227 ? mMinScrollX
Sunny Goyalb7b01352018-08-09 12:31:20 -07001228 : finalX > (lastPageScroll + mMaxScrollX) / 2
1229 ? mMaxScrollX
1230 : getScrollForPage(mNextPage);
1231
1232 mScroller.setFinalPos(pageSnappedX);
1233 // Ensure the scroll/snap doesn't happen too fast;
1234 int extraScrollDuration = OVERSCROLL_PAGE_SNAP_ANIMATION_DURATION
1235 - mScroller.getDuration();
1236 if (extraScrollDuration > 0) {
1237 mScroller.extendDuration(extraScrollDuration);
1238 }
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001239 }
1240 }
1241 invalidate();
Winson Chung321e9ee2010-08-09 13:37:56 -07001242 }
Adam Cohenc2d6e892014-10-16 09:49:24 -07001243 onScrollInteractionEnd();
Winson Chung321e9ee2010-08-09 13:37:56 -07001244 }
Adam Cohen7d30a372013-07-01 17:03:59 -07001245
Adam Cohen7d30a372013-07-01 17:03:59 -07001246 // End any intermediate reordering states
1247 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001248 break;
1249
1250 case MotionEvent.ACTION_CANCEL:
Sunny Goyalaad33592018-08-07 17:20:35 -07001251 if (mIsBeingDragged) {
Michael Jurkab8f06722010-10-10 15:58:46 -07001252 snapToDestination();
Sunny Goyal4ff424a2016-08-12 12:46:01 -07001253 onScrollInteractionEnd();
Michael Jurkab8f06722010-10-10 15:58:46 -07001254 }
Adam Cohen7d30a372013-07-01 17:03:59 -07001255 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001256 break;
1257
1258 case MotionEvent.ACTION_POINTER_UP:
1259 onSecondaryPointerUp(ev);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001260 releaseVelocityTracker();
Winson Chung321e9ee2010-08-09 13:37:56 -07001261 break;
1262 }
1263
1264 return true;
1265 }
1266
Sunny Goyal65d9ceb2017-05-08 09:17:42 -07001267 protected boolean shouldFlingForVelocity(int velocityX) {
1268 return Math.abs(velocityX) > mFlingThresholdVelocity;
1269 }
1270
Adam Cohen7d30a372013-07-01 17:03:59 -07001271 private void resetTouchState() {
1272 releaseVelocityTracker();
Sunny Goyalaad33592018-08-07 17:20:35 -07001273 mIsBeingDragged = false;
Adam Cohen7d30a372013-07-01 17:03:59 -07001274 mActivePointerId = INVALID_POINTER;
Adam Cohen7d30a372013-07-01 17:03:59 -07001275 }
1276
Adam Cohenc2d6e892014-10-16 09:49:24 -07001277 /**
1278 * Triggered by scrolling via touch
1279 */
1280 protected void onScrollInteractionBegin() {
1281 }
1282
1283 protected void onScrollInteractionEnd() {
1284 }
1285
Winson Chung185d7162011-02-28 13:47:29 -08001286 @Override
1287 public boolean onGenericMotionEvent(MotionEvent event) {
1288 if ((event.getSource() & InputDevice.SOURCE_CLASS_POINTER) != 0) {
1289 switch (event.getAction()) {
1290 case MotionEvent.ACTION_SCROLL: {
1291 // Handle mouse (or ext. device) by shifting the page depending on the scroll
1292 final float vscroll;
1293 final float hscroll;
1294 if ((event.getMetaState() & KeyEvent.META_SHIFT_ON) != 0) {
1295 vscroll = 0;
1296 hscroll = event.getAxisValue(MotionEvent.AXIS_VSCROLL);
1297 } else {
1298 vscroll = -event.getAxisValue(MotionEvent.AXIS_VSCROLL);
1299 hscroll = event.getAxisValue(MotionEvent.AXIS_HSCROLL);
1300 }
1301 if (hscroll != 0 || vscroll != 0) {
Sunny Goyal70660032015-05-14 00:07:08 -07001302 boolean isForwardScroll = mIsRtl ? (hscroll < 0 || vscroll < 0)
Adam Cohen0ffac432013-07-10 11:19:26 -07001303 : (hscroll > 0 || vscroll > 0);
1304 if (isForwardScroll) {
Winson Chung185d7162011-02-28 13:47:29 -08001305 scrollRight();
1306 } else {
1307 scrollLeft();
1308 }
1309 return true;
1310 }
1311 }
1312 }
1313 }
1314 return super.onGenericMotionEvent(event);
1315 }
1316
Michael Jurkab8f06722010-10-10 15:58:46 -07001317 private void acquireVelocityTrackerAndAddMovement(MotionEvent ev) {
1318 if (mVelocityTracker == null) {
1319 mVelocityTracker = VelocityTracker.obtain();
1320 }
1321 mVelocityTracker.addMovement(ev);
1322 }
1323
1324 private void releaseVelocityTracker() {
1325 if (mVelocityTracker != null) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001326 mVelocityTracker.clear();
Michael Jurkab8f06722010-10-10 15:58:46 -07001327 mVelocityTracker.recycle();
1328 mVelocityTracker = null;
1329 }
1330 }
1331
Winson Chung321e9ee2010-08-09 13:37:56 -07001332 private void onSecondaryPointerUp(MotionEvent ev) {
1333 final int pointerIndex = (ev.getAction() & MotionEvent.ACTION_POINTER_INDEX_MASK) >>
1334 MotionEvent.ACTION_POINTER_INDEX_SHIFT;
1335 final int pointerId = ev.getPointerId(pointerIndex);
1336 if (pointerId == mActivePointerId) {
1337 // This was our active pointer going up. Choose a new
1338 // active pointer and adjust accordingly.
1339 // TODO: Make this decision more intelligent.
1340 final int newPointerIndex = pointerIndex == 0 ? 1 : 0;
1341 mLastMotionX = mDownMotionX = ev.getX(newPointerIndex);
Winson Chungc0844aa2011-02-02 15:25:58 -08001342 mLastMotionXRemainder = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -07001343 mActivePointerId = ev.getPointerId(newPointerIndex);
1344 if (mVelocityTracker != null) {
1345 mVelocityTracker.clear();
1346 }
1347 }
Jeff Brown1d0867c2010-12-02 18:27:39 -08001348 }
1349
Winson Chung321e9ee2010-08-09 13:37:56 -07001350 @Override
1351 public void requestChildFocus(View child, View focused) {
1352 super.requestChildFocus(child, focused);
Adam Cohenae4f1552011-10-20 00:15:42 -07001353 int page = indexToPage(indexOfChild(child));
Winson Chung97d85d22011-04-13 11:27:36 -07001354 if (page >= 0 && page != getCurrentPage() && !isInTouchMode()) {
Winson Chung86f77532010-08-24 11:08:22 -07001355 snapToPage(page);
Winson Chung321e9ee2010-08-09 13:37:56 -07001356 }
1357 }
1358
Sunny Goyal228153d2018-01-04 15:35:22 -08001359 public int getPageNearestToCenterOfScreen() {
Tony Wickham8f7ead32016-04-07 18:46:44 -07001360 return getPageNearestToCenterOfScreen(getScrollX());
1361 }
1362
1363 private int getPageNearestToCenterOfScreen(int scaledScrollX) {
Sunny Goyal228153d2018-01-04 15:35:22 -08001364 int screenCenter = scaledScrollX + (getMeasuredWidth() / 2);
Adam Cohen22f823d2011-09-01 17:22:18 -07001365 int minDistanceFromScreenCenter = Integer.MAX_VALUE;
Winson Chung321e9ee2010-08-09 13:37:56 -07001366 int minDistanceFromScreenCenterIndex = -1;
Winson Chung321e9ee2010-08-09 13:37:56 -07001367 final int childCount = getChildCount();
1368 for (int i = 0; i < childCount; ++i) {
Sunny Goyal228153d2018-01-04 15:35:22 -08001369 View layout = getPageAt(i);
Adam Cohen96d30a12013-07-16 18:13:21 -07001370 int childWidth = layout.getMeasuredWidth();
Winson Chung321e9ee2010-08-09 13:37:56 -07001371 int halfChildWidth = (childWidth / 2);
Sunny Goyal228153d2018-01-04 15:35:22 -08001372 int childCenter = getChildOffset(i) + halfChildWidth;
Winson Chung321e9ee2010-08-09 13:37:56 -07001373 int distanceFromScreenCenter = Math.abs(childCenter - screenCenter);
1374 if (distanceFromScreenCenter < minDistanceFromScreenCenter) {
1375 minDistanceFromScreenCenter = distanceFromScreenCenter;
1376 minDistanceFromScreenCenterIndex = i;
1377 }
1378 }
Adam Cohend19d3ca2010-09-15 14:43:42 -07001379 return minDistanceFromScreenCenterIndex;
1380 }
1381
1382 protected void snapToDestination() {
Adam Cohen8d769d62017-06-23 17:27:38 -07001383 snapToPage(getPageNearestToCenterOfScreen(), getPageSnapDuration());
1384 }
1385
1386 protected boolean isInOverScroll() {
Tony Wickham66d1c2f2019-04-24 11:32:59 -07001387 return (getScrollX() > mMaxScrollX || getScrollX() < mMinScrollX);
Adam Cohen8d769d62017-06-23 17:27:38 -07001388 }
1389
1390 protected int getPageSnapDuration() {
1391 if (isInOverScroll()) {
1392 return OVERSCROLL_PAGE_SNAP_ANIMATION_DURATION;
1393 }
1394 return PAGE_SNAP_ANIMATION_DURATION;
Winson Chung321e9ee2010-08-09 13:37:56 -07001395 }
1396
Adam Cohene0f66b52010-11-23 15:06:07 -08001397 // We want the duration of the page snap animation to be influenced by the distance that
1398 // the screen has to travel, however, we don't want this duration to be effected in a
1399 // purely linear fashion. Instead, we use this method to moderate the effect that the distance
1400 // of travel has on the overall snap duration.
Sunny Goyal4d113a52015-05-27 10:05:28 -07001401 private float distanceInfluenceForSnapDuration(float f) {
Adam Cohene0f66b52010-11-23 15:06:07 -08001402 f -= 0.5f; // center the values about 0.
1403 f *= 0.3f * Math.PI / 2.0f;
1404 return (float) Math.sin(f);
1405 }
1406
Winson Chung05a31ed2018-02-08 17:08:43 -08001407 protected boolean snapToPageWithVelocity(int whichPage, int velocity) {
Adam Cohen6f127a62014-06-12 14:54:41 -07001408 whichPage = validateNewPage(whichPage);
Sunny Goyal228153d2018-01-04 15:35:22 -08001409 int halfScreenSize = getMeasuredWidth() / 2;
Adam Cohene0f66b52010-11-23 15:06:07 -08001410
Adam Cohenedb40762013-07-18 16:45:45 -07001411 final int newX = getScrollForPage(whichPage);
Sunny Goyalc86df472016-02-25 09:19:38 -08001412 int delta = newX - getUnboundedScrollX();
Adam Cohene0f66b52010-11-23 15:06:07 -08001413 int duration = 0;
1414
Sunny Goyal4d113a52015-05-27 10:05:28 -07001415 if (Math.abs(velocity) < mMinFlingVelocity) {
Adam Cohene0f66b52010-11-23 15:06:07 -08001416 // If the velocity is low enough, then treat this more as an automatic page advance
1417 // as opposed to an apparent physical response to flinging
Winson Chung05a31ed2018-02-08 17:08:43 -08001418 return snapToPage(whichPage, PAGE_SNAP_ANIMATION_DURATION);
Adam Cohene0f66b52010-11-23 15:06:07 -08001419 }
1420
1421 // Here we compute a "distance" that will be used in the computation of the overall
1422 // snap duration. This is a function of the actual distance that needs to be traveled;
1423 // we keep this value close to half screen size in order to reduce the variance in snap
1424 // duration as a function of the distance the page needs to travel.
Michael Jurka20b7ca92011-06-07 20:09:16 -07001425 float distanceRatio = Math.min(1f, 1.0f * Math.abs(delta) / (2 * halfScreenSize));
Adam Cohene0f66b52010-11-23 15:06:07 -08001426 float distance = halfScreenSize + halfScreenSize *
1427 distanceInfluenceForSnapDuration(distanceRatio);
1428
1429 velocity = Math.abs(velocity);
Adam Cohen265b9a62011-12-07 14:37:18 -08001430 velocity = Math.max(mMinSnapVelocity, velocity);
Adam Cohene0f66b52010-11-23 15:06:07 -08001431
1432 // we want the page's snap velocity to approximately match the velocity at which the
1433 // user flings, so we scale the duration by a value near to the derivative of the scroll
Michael Jurka20b7ca92011-06-07 20:09:16 -07001434 // interpolator at zero, ie. 5. We use 4 to make it a little slower.
1435 duration = 4 * Math.round(1000 * Math.abs(distance / velocity));
Adam Cohene0f66b52010-11-23 15:06:07 -08001436
Jon Miranda71cb80c2019-01-24 21:25:13 -08001437 if (QUICKSTEP_SPRINGS.get()) {
1438 return snapToPage(whichPage, delta, duration, false, null,
1439 velocity * Math.signum(newX - getUnboundedScrollX()), true);
1440 } else {
1441 return snapToPage(whichPage, delta, duration);
1442 }
Michael Jurka0142d492010-08-25 17:46:15 -07001443 }
1444
Winson Chung05a31ed2018-02-08 17:08:43 -08001445 public boolean snapToPage(int whichPage) {
1446 return snapToPage(whichPage, PAGE_SNAP_ANIMATION_DURATION);
Winson Chung321e9ee2010-08-09 13:37:56 -07001447 }
1448
Winson Chung05a31ed2018-02-08 17:08:43 -08001449 public boolean snapToPageImmediately(int whichPage) {
1450 return snapToPage(whichPage, PAGE_SNAP_ANIMATION_DURATION, true, null);
Adam Cohen7d30a372013-07-01 17:03:59 -07001451 }
1452
Winson Chung05a31ed2018-02-08 17:08:43 -08001453 public boolean snapToPage(int whichPage, int duration) {
1454 return snapToPage(whichPage, duration, false, null);
Adam Cohen7d30a372013-07-01 17:03:59 -07001455 }
1456
Tony Wickhamd58c2d52018-05-04 12:10:55 -07001457 public boolean snapToPage(int whichPage, int duration, TimeInterpolator interpolator) {
Winson Chung05a31ed2018-02-08 17:08:43 -08001458 return snapToPage(whichPage, duration, false, interpolator);
Adam Cohenf9618852013-11-08 06:45:03 -08001459 }
1460
Winson Chung05a31ed2018-02-08 17:08:43 -08001461 protected boolean snapToPage(int whichPage, int duration, boolean immediate,
Adam Cohenf9618852013-11-08 06:45:03 -08001462 TimeInterpolator interpolator) {
Adam Cohen6f127a62014-06-12 14:54:41 -07001463 whichPage = validateNewPage(whichPage);
Winson Chung321e9ee2010-08-09 13:37:56 -07001464
Adam Cohenedb40762013-07-18 16:45:45 -07001465 int newX = getScrollForPage(whichPage);
Sunny Goyalc86df472016-02-25 09:19:38 -08001466 final int delta = newX - getUnboundedScrollX();
Jon Miranda71cb80c2019-01-24 21:25:13 -08001467 return snapToPage(whichPage, delta, duration, immediate, interpolator, 0, false);
Michael Jurka0142d492010-08-25 17:46:15 -07001468 }
1469
Winson Chung05a31ed2018-02-08 17:08:43 -08001470 protected boolean snapToPage(int whichPage, int delta, int duration) {
Jon Miranda71cb80c2019-01-24 21:25:13 -08001471 return snapToPage(whichPage, delta, duration, false, null, 0, false);
Adam Cohen7d30a372013-07-01 17:03:59 -07001472 }
Michael Jurka0142d492010-08-25 17:46:15 -07001473
Winson Chung05a31ed2018-02-08 17:08:43 -08001474 protected boolean snapToPage(int whichPage, int delta, int duration, boolean immediate,
Jon Miranda71cb80c2019-01-24 21:25:13 -08001475 TimeInterpolator interpolator, float velocity, boolean spring) {
Sunny Goyal9bb8ffb2018-05-24 17:11:16 -07001476 if (mFirstLayout) {
1477 setCurrentPage(whichPage);
1478 return false;
1479 }
Tony Wickhamd58c2d52018-05-04 12:10:55 -07001480
1481 if (FeatureFlags.IS_DOGFOOD_BUILD) {
Tony Wickhamcb3f8702018-08-27 17:36:03 -07001482 duration *= Settings.Global.getFloat(getContext().getContentResolver(),
1483 Settings.Global.WINDOW_ANIMATION_SCALE, 1);
Tony Wickhamd58c2d52018-05-04 12:10:55 -07001484 }
1485
Adam Cohen6f127a62014-06-12 14:54:41 -07001486 whichPage = validateNewPage(whichPage);
1487
Adam Cohen7d30a372013-07-01 17:03:59 -07001488 mNextPage = whichPage;
Michael Jurka0142d492010-08-25 17:46:15 -07001489
Winson Chung321e9ee2010-08-09 13:37:56 -07001490 awakenScrollBars(duration);
Adam Cohen7d30a372013-07-01 17:03:59 -07001491 if (immediate) {
1492 duration = 0;
1493 } else if (duration == 0) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001494 duration = Math.abs(delta);
1495 }
1496
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001497 if (duration != 0) {
1498 pageBeginTransition();
1499 }
1500
Adam Cohenf358a4b2013-07-23 16:47:31 -07001501 if (!mScroller.isFinished()) {
Adam Cohenf9618852013-11-08 06:45:03 -08001502 abortScrollerAnimation(false);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001503 }
Adam Cohenf9618852013-11-08 06:45:03 -08001504
1505 if (interpolator != null) {
1506 mScroller.setInterpolator(interpolator);
1507 } else {
1508 mScroller.setInterpolator(mDefaultInterpolator);
1509 }
1510
Jon Miranda71cb80c2019-01-24 21:25:13 -08001511 if (spring && QUICKSTEP_SPRINGS.get()) {
1512 mScroller.startScrollSpring(getUnboundedScrollX(), delta, duration, velocity);
1513 } else {
1514 mScroller.startScroll(getUnboundedScrollX(), delta, duration);
1515 }
Winson Chung80baf5a2010-08-09 16:03:15 -07001516
Adam Cohen674531f2013-12-13 15:07:14 -08001517 updatePageIndicator();
Adam Cohen7d30a372013-07-01 17:03:59 -07001518
1519 // Trigger a compute() to finish switching pages if necessary
1520 if (immediate) {
1521 computeScroll();
Sunny Goyal76dbf6f2017-01-03 14:55:47 -08001522 pageEndTransition();
Adam Cohen7d30a372013-07-01 17:03:59 -07001523 }
1524
Winson Chung321e9ee2010-08-09 13:37:56 -07001525 invalidate();
Winson Chung05a31ed2018-02-08 17:08:43 -08001526 return Math.abs(delta) > 0;
Winson Chung321e9ee2010-08-09 13:37:56 -07001527 }
1528
Vadim Tryshev98913d02018-05-18 18:41:34 -07001529 public boolean scrollLeft() {
1530 if (getNextPage() > 0) {
1531 snapToPage(getNextPage() - 1);
1532 return true;
1533 }
1534 return false;
Winson Chung321e9ee2010-08-09 13:37:56 -07001535 }
1536
Vadim Tryshev98913d02018-05-18 18:41:34 -07001537 public boolean scrollRight() {
1538 if (getNextPage() < getChildCount() - 1) {
1539 snapToPage(getNextPage() + 1);
1540 return true;
1541 }
1542 return false;
Winson Chung321e9ee2010-08-09 13:37:56 -07001543 }
1544
Vadim Trysheve6bbefb2018-04-03 13:38:06 -07001545 @Override
1546 public CharSequence getAccessibilityClassName() {
1547 // Some accessibility services have special logic for ScrollView. Since we provide same
1548 // accessibility info as ScrollView, inform the service to handle use the same way.
1549 return ScrollView.class.getName();
1550 }
1551
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001552 protected boolean isPageOrderFlipped() {
1553 return false;
1554 }
1555
Winson Chung6a0f57d2011-06-29 20:10:49 -07001556 /* Accessibility */
Sunny Goyalcf25b522015-07-09 00:01:18 -07001557 @SuppressWarnings("deprecation")
Winson Chung6a0f57d2011-06-29 20:10:49 -07001558 @Override
1559 public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) {
1560 super.onInitializeAccessibilityNodeInfo(info);
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001561 final boolean pagesFlipped = isPageOrderFlipped();
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001562 info.setScrollable(getPageCount() > 1);
1563 if (getCurrentPage() < getPageCount() - 1) {
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001564 info.addAction(pagesFlipped ? AccessibilityNodeInfo.ACTION_SCROLL_BACKWARD
1565 : AccessibilityNodeInfo.ACTION_SCROLL_FORWARD);
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001566 }
1567 if (getCurrentPage() > 0) {
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001568 info.addAction(pagesFlipped ? AccessibilityNodeInfo.ACTION_SCROLL_FORWARD
1569 : AccessibilityNodeInfo.ACTION_SCROLL_BACKWARD);
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001570 }
Vadim Tryshev7af0d442015-05-15 08:48:11 -07001571
1572 // Accessibility-wise, PagedView doesn't support long click, so disabling it.
1573 // Besides disabling the accessibility long-click, this also prevents this view from getting
1574 // accessibility focus.
1575 info.setLongClickable(false);
Sunny Goyala52ecb02016-12-16 15:04:51 -08001576 info.removeAction(AccessibilityNodeInfo.AccessibilityAction.ACTION_LONG_CLICK);
Winson Chung6a0f57d2011-06-29 20:10:49 -07001577 }
1578
1579 @Override
Alan Viverette254139a2013-10-08 13:13:46 -07001580 public void sendAccessibilityEvent(int eventType) {
1581 // Don't let the view send real scroll events.
1582 if (eventType != AccessibilityEvent.TYPE_VIEW_SCROLLED) {
1583 super.sendAccessibilityEvent(eventType);
1584 }
1585 }
1586
1587 @Override
Winson Chung6a0f57d2011-06-29 20:10:49 -07001588 public void onInitializeAccessibilityEvent(AccessibilityEvent event) {
1589 super.onInitializeAccessibilityEvent(event);
Vadim Tryshev7066c122015-05-21 14:06:35 -07001590 event.setScrollable(getPageCount() > 1);
Winson Chung6a0f57d2011-06-29 20:10:49 -07001591 }
1592
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001593 @Override
1594 public boolean performAccessibilityAction(int action, Bundle arguments) {
1595 if (super.performAccessibilityAction(action, arguments)) {
1596 return true;
1597 }
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001598 final boolean pagesFlipped = isPageOrderFlipped();
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001599 switch (action) {
1600 case AccessibilityNodeInfo.ACTION_SCROLL_FORWARD: {
Vadim Tryshev98913d02018-05-18 18:41:34 -07001601 if (pagesFlipped ? scrollLeft() : scrollRight()) {
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001602 return true;
1603 }
1604 } break;
1605 case AccessibilityNodeInfo.ACTION_SCROLL_BACKWARD: {
Vadim Tryshev98913d02018-05-18 18:41:34 -07001606 if (pagesFlipped ? scrollRight() : scrollLeft()) {
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001607 return true;
1608 }
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001609 }
1610 break;
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001611 }
1612 return false;
1613 }
1614
Vadim Tryshev2c430b32018-04-04 14:45:21 -07001615 protected boolean canAnnouncePageDescription() {
1616 return true;
1617 }
1618
Adam Cohen0ffac432013-07-10 11:19:26 -07001619 protected String getCurrentPageDescription() {
Sunny Goyalf4f89ef2015-09-02 15:06:12 -07001620 return getContext().getString(R.string.default_scroll_format,
Adam Cohen0ffac432013-07-10 11:19:26 -07001621 getNextPage() + 1, getChildCount());
1622 }
1623
Tony Mak2e564402018-02-27 17:19:34 +00001624 protected float getDownMotionX() {
1625 return mDownMotionX;
1626 }
1627
1628 protected float getDownMotionY() {
1629 return mDownMotionY;
1630 }
1631
Sunny Goyal20a13ff2018-03-13 16:44:00 -07001632 protected interface ComputePageScrollsLogic {
1633
1634 boolean shouldIncludeView(View view);
1635 }
Vadim Tryshev528b9e02018-05-24 18:22:03 -07001636
1637 public int[] getVisibleChildrenRange() {
1638 float visibleLeft = 0;
1639 float visibleRight = visibleLeft + getMeasuredWidth();
1640 float scaleX = getScaleX();
1641 if (scaleX < 1 && scaleX > 0) {
1642 float mid = getMeasuredWidth() / 2;
1643 visibleLeft = mid - ((mid - visibleLeft) / scaleX);
1644 visibleRight = mid + ((visibleRight - mid) / scaleX);
1645 }
1646
1647 int leftChild = -1;
1648 int rightChild = -1;
1649 final int childCount = getChildCount();
1650 for (int i = 0; i < childCount; i++) {
1651 final View child = getPageAt(i);
1652
1653 float left = child.getLeft() + child.getTranslationX() - getScrollX();
1654 if (left <= visibleRight && (left + child.getMeasuredWidth()) >= visibleLeft) {
1655 if (leftChild == -1) {
1656 leftChild = i;
1657 }
1658 rightChild = i;
1659 }
1660 }
1661 mTmpIntPair[0] = leftChild;
1662 mTmpIntPair[1] = rightChild;
1663 return mTmpIntPair;
1664 }
Adam Cohen5084cba2013-09-03 12:01:16 -07001665}