blob: f8e4c9dfc775b83e42fe48809bbd164f1e88a826 [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 Goyald0030b02017-12-08 15:07:24 -080019import static com.android.launcher3.compat.AccessibilityManagerCompat.isAccessibilityEnabled;
20import static com.android.launcher3.compat.AccessibilityManagerCompat.isObservedEventType;
Jon Miranda71cb80c2019-01-24 21:25:13 -080021import static com.android.launcher3.config.FeatureFlags.QUICKSTEP_SPRINGS;
Sunny Goyalb7b01352018-08-09 12:31:20 -070022import static com.android.launcher3.touch.OverScroll.OVERSCROLL_DAMP_FACTOR;
Sunny Goyald0030b02017-12-08 15:07:24 -080023
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -070024import android.animation.LayoutTransition;
Adam Cohen7d30a372013-07-01 17:03:59 -070025import android.animation.TimeInterpolator;
Sunny Goyalcf25b522015-07-09 00:01:18 -070026import android.annotation.SuppressLint;
Winson Chung321e9ee2010-08-09 13:37:56 -070027import android.content.Context;
Adam Cohen9c4949e2010-10-05 12:27:22 -070028import android.content.res.TypedArray;
Jon Miranda71cb80c2019-01-24 21:25:13 -080029import android.graphics.Canvas;
Winson Chung321e9ee2010-08-09 13:37:56 -070030import android.graphics.Rect;
Svetoslav Ganov08055f62012-05-15 11:06:36 -070031import android.os.Bundle;
Tony Wickhamd58c2d52018-05-04 12:10:55 -070032import android.provider.Settings;
Winson Chung321e9ee2010-08-09 13:37:56 -070033import android.util.AttributeSet;
Winson Chung785d2eb2011-04-14 16:08:02 -070034import android.util.Log;
Winson Chung185d7162011-02-28 13:47:29 -080035import android.view.InputDevice;
36import android.view.KeyEvent;
Winson Chung321e9ee2010-08-09 13:37:56 -070037import android.view.MotionEvent;
38import android.view.VelocityTracker;
39import android.view.View;
40import android.view.ViewConfiguration;
Sunny Goyal4ffec482016-02-09 11:28:52 -080041import android.view.ViewDebug;
Winson Chung321e9ee2010-08-09 13:37:56 -070042import android.view.ViewGroup;
43import android.view.ViewParent;
Winson Chung6a0f57d2011-06-29 20:10:49 -070044import android.view.accessibility.AccessibilityEvent;
45import android.view.accessibility.AccessibilityNodeInfo;
Adam Cohene0f66b52010-11-23 15:06:07 -080046import android.view.animation.Interpolator;
Vadim Trysheve6bbefb2018-04-03 13:38:06 -070047import android.widget.ScrollView;
Tony Wickhamf549dab2016-05-16 09:54:06 -070048
Sunny Goyal5bc6b6f2017-10-26 15:36:10 -070049import com.android.launcher3.anim.Interpolators;
Tony Wickhamd58c2d52018-05-04 12:10:55 -070050import com.android.launcher3.config.FeatureFlags;
Tony Wickhamf549dab2016-05-16 09:54:06 -070051import com.android.launcher3.pageindicators.PageIndicator;
Sunny Goyalb72d8b22017-07-14 00:02:27 -070052import com.android.launcher3.touch.OverScroll;
Sunny Goyalb7b01352018-08-09 12:31:20 -070053import com.android.launcher3.util.OverScroller;
Adam Cohen091440a2015-03-18 14:16:05 -070054import com.android.launcher3.util.Thunk;
Tony Wickhamf549dab2016-05-16 09:54:06 -070055
Winson Chung6a0f57d2011-06-29 20:10:49 -070056import java.util.ArrayList;
57
Winson Chung321e9ee2010-08-09 13:37:56 -070058/**
59 * An abstraction of the original Workspace which supports browsing through a
Michael Jurka0142d492010-08-25 17:46:15 -070060 * sequential list of "pages"
Winson Chung321e9ee2010-08-09 13:37:56 -070061 */
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -080062public abstract class PagedView<T extends View & PageIndicator> extends ViewGroup {
Winson Chung321e9ee2010-08-09 13:37:56 -070063 private static final String TAG = "PagedView";
Winson Chung785d2eb2011-04-14 16:08:02 -070064 private static final boolean DEBUG = false;
Sunny Goyal20a13ff2018-03-13 16:44:00 -070065
Michael Jurka0142d492010-08-25 17:46:15 -070066 protected static final int INVALID_PAGE = -1;
Sunny Goyal20a13ff2018-03-13 16:44:00 -070067 protected static final ComputePageScrollsLogic SIMPLE_SCROLL_LOGIC = (v) -> v.getVisibility() != GONE;
Winson Chung321e9ee2010-08-09 13:37:56 -070068
Vadim Tryshevfedca432015-08-19 17:55:02 -070069 public static final int PAGE_SNAP_ANIMATION_DURATION = 750;
Winson Chung321e9ee2010-08-09 13:37:56 -070070
Sunny Goyalb72d8b22017-07-14 00:02:27 -070071 // OverScroll constants
Adam Cohen8d769d62017-06-23 17:27:38 -070072 private final static int OVERSCROLL_PAGE_SNAP_ANIMATION_DURATION = 270;
Adam Cohen8d769d62017-06-23 17:27:38 -070073
Adam Cohenb64cb5a2011-02-15 13:53:42 -080074 private static final float RETURN_TO_ORIGINAL_PAGE_THRESHOLD = 0.33f;
Adam Cohen00481b32011-11-18 12:03:48 -080075 // The page is moved more than halfway, automatically move to the next page on touch up.
76 private static final float SIGNIFICANT_MOVE_THRESHOLD = 0.4f;
Adam Cohen68d73932010-11-15 10:50:58 -080077
Sunny Goyal8e2133b2015-05-06 13:39:07 -070078 private static final float MAX_SCROLL_PROGRESS = 1.0f;
79
Adam Cohen265b9a62011-12-07 14:37:18 -080080 // The following constants need to be scaled based on density. The scaled versions will be
81 // assigned to the corresponding member variables below.
82 private static final int FLING_THRESHOLD_VELOCITY = 500;
83 private static final int MIN_SNAP_VELOCITY = 1500;
84 private static final int MIN_FLING_VELOCITY = 250;
85
Adam Cohen21cd0022013-10-09 18:57:02 -070086 public static final int INVALID_RESTORE_PAGE = -1001;
87
Adam Cohenf358a4b2013-07-23 16:47:31 -070088 private boolean mFreeScroll = false;
Adam Cohenf358a4b2013-07-23 16:47:31 -070089
Adam Cohen265b9a62011-12-07 14:37:18 -080090 protected int mFlingThresholdVelocity;
91 protected int mMinFlingVelocity;
92 protected int mMinSnapVelocity;
Michael Jurka0142d492010-08-25 17:46:15 -070093
Michael Jurka0142d492010-08-25 17:46:15 -070094 protected boolean mFirstLayout = true;
95
Sunny Goyal4ffec482016-02-09 11:28:52 -080096 @ViewDebug.ExportedProperty(category = "launcher")
Michael Jurka0142d492010-08-25 17:46:15 -070097 protected int mCurrentPage;
Adam Cohene61a9a22013-06-11 15:45:31 -070098
Sunny Goyal4ffec482016-02-09 11:28:52 -080099 @ViewDebug.ExportedProperty(category = "launcher")
Michael Jurka0142d492010-08-25 17:46:15 -0700100 protected int mNextPage = INVALID_PAGE;
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700101 protected int mMinScrollX;
Sunny Goyalc86df472016-02-25 09:19:38 -0800102 protected int mMaxScrollX;
Sunny Goyalb7b01352018-08-09 12:31:20 -0700103 protected OverScroller mScroller;
Adam Cohenf9618852013-11-08 06:45:03 -0800104 private Interpolator mDefaultInterpolator;
Winson Chung321e9ee2010-08-09 13:37:56 -0700105 private VelocityTracker mVelocityTracker;
Sunny Goyale15e2a82017-12-15 13:05:42 -0800106 protected int mPageSpacing = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -0700107
108 private float mDownMotionX;
Adam Cohen7d30a372013-07-01 17:03:59 -0700109 private float mDownMotionY;
Sunny Goyalcf25b522015-07-09 00:01:18 -0700110 private float mLastMotionX;
111 private float mLastMotionXRemainder;
Sunny Goyalcf25b522015-07-09 00:01:18 -0700112 private float mTotalMotionX;
Adam Cohenedb40762013-07-18 16:45:45 -0700113
Vadim Trysheve628c472018-05-16 14:28:18 -0700114 protected int[] mPageScrolls;
Sunny Goyalaad33592018-08-07 17:20:35 -0700115 private boolean mIsBeingDragged;
Adam Cohencae7f572013-11-04 14:42:52 -0800116
Michael Jurka7426c422010-11-11 15:23:47 -0800117 protected int mTouchSlop;
Winson Chung321e9ee2010-08-09 13:37:56 -0700118 private int mMaximumVelocity;
Adam Cohen68d73932010-11-15 10:50:58 -0800119 protected boolean mAllowOverScroll = true;
Winson Chung321e9ee2010-08-09 13:37:56 -0700120
Michael Jurka5f1c5092010-09-03 14:15:02 -0700121 protected static final int INVALID_POINTER = -1;
Winson Chung321e9ee2010-08-09 13:37:56 -0700122
Michael Jurka5f1c5092010-09-03 14:15:02 -0700123 protected int mActivePointerId = INVALID_POINTER;
Winson Chung321e9ee2010-08-09 13:37:56 -0700124
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700125 protected boolean mIsPageInTransition = false;
Patrick Dubroy1262e362010-10-06 15:49:50 -0700126
Jon Miranda71cb80c2019-01-24 21:25:13 -0800127 protected float mSpringOverScrollX;
128
Sunny Goyal061380a2016-02-29 15:15:03 -0800129 protected boolean mWasInOverscroll = false;
Adam Cohenc2d6e892014-10-16 09:49:24 -0700130
Adam Cohen8d769d62017-06-23 17:27:38 -0700131 protected int mUnboundedScrollX;
132
Winson Chungd2be3812013-07-16 11:11:32 -0700133 // Page Indicator
Adam Cohen091440a2015-03-18 14:16:05 -0700134 @Thunk int mPageIndicatorViewId;
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800135 protected T mPageIndicator;
Adam Cohen7d30a372013-07-01 17:03:59 -0700136
John Spurlock77e1f472013-09-11 10:09:51 -0400137 protected final Rect mInsets = new Rect();
Tony Wickhamdfb5cc92018-02-26 16:41:57 -0800138 protected boolean mIsRtl;
John Spurlock77e1f472013-09-11 10:09:51 -0400139
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800140 // Similar to the platform implementation of isLayoutValid();
141 protected boolean mIsLayoutValid;
142
Vadim Tryshev528b9e02018-05-24 18:22:03 -0700143 private int[] mTmpIntPair = new int[2];
144
Winson Chung321e9ee2010-08-09 13:37:56 -0700145 public PagedView(Context context) {
146 this(context, null);
147 }
148
149 public PagedView(Context context, AttributeSet attrs) {
150 this(context, attrs, 0);
151 }
152
153 public PagedView(Context context, AttributeSet attrs, int defStyle) {
154 super(context, attrs, defStyle);
Winson Chungc9ca2982013-07-19 12:07:38 -0700155
Adam Cohen9c4949e2010-10-05 12:27:22 -0700156 TypedArray a = context.obtainStyledAttributes(attrs,
157 R.styleable.PagedView, defStyle, 0);
Winson Chungd2be3812013-07-16 11:11:32 -0700158 mPageIndicatorViewId = a.getResourceId(R.styleable.PagedView_pageIndicator, -1);
Adam Cohen9c4949e2010-10-05 12:27:22 -0700159 a.recycle();
160
Winson Chung321e9ee2010-08-09 13:37:56 -0700161 setHapticFeedbackEnabled(false);
Sunny Goyal70660032015-05-14 00:07:08 -0700162 mIsRtl = Utilities.isRtl(getResources());
Michael Jurka0142d492010-08-25 17:46:15 -0700163 init();
Winson Chung321e9ee2010-08-09 13:37:56 -0700164 }
165
166 /**
167 * Initializes various states for this workspace.
168 */
Michael Jurka0142d492010-08-25 17:46:15 -0700169 protected void init() {
Sunny Goyalb7b01352018-08-09 12:31:20 -0700170 mScroller = new OverScroller(getContext());
Sunny Goyal5bc6b6f2017-10-26 15:36:10 -0700171 setDefaultInterpolator(Interpolators.SCROLL);
Winson Chung86f77532010-08-24 11:08:22 -0700172 mCurrentPage = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -0700173
174 final ViewConfiguration configuration = ViewConfiguration.get(getContext());
Adam Cohen7d30a372013-07-01 17:03:59 -0700175 mTouchSlop = configuration.getScaledPagingTouchSlop();
Winson Chung321e9ee2010-08-09 13:37:56 -0700176 mMaximumVelocity = configuration.getScaledMaximumFlingVelocity();
Adam Cohen265b9a62011-12-07 14:37:18 -0800177
Sunny Goyalcf25b522015-07-09 00:01:18 -0700178 float density = getResources().getDisplayMetrics().density;
179 mFlingThresholdVelocity = (int) (FLING_THRESHOLD_VELOCITY * density);
180 mMinFlingVelocity = (int) (MIN_FLING_VELOCITY * density);
181 mMinSnapVelocity = (int) (MIN_SNAP_VELOCITY * density);
Sunny Goyala9f55462018-03-25 18:15:15 -0700182
183 if (Utilities.ATLEAST_OREO) {
184 setDefaultFocusHighlightEnabled(false);
185 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700186 }
187
Adam Cohenf9618852013-11-08 06:45:03 -0800188 protected void setDefaultInterpolator(Interpolator interpolator) {
189 mDefaultInterpolator = interpolator;
190 mScroller.setInterpolator(mDefaultInterpolator);
191 }
192
Sunny Goyald0a6ae72016-06-16 12:29:03 -0700193 public void initParentViews(View parent) {
194 if (mPageIndicatorViewId > -1) {
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800195 mPageIndicator = parent.findViewById(mPageIndicatorViewId);
Sunny Goyalc64cfdd2016-05-18 14:12:02 -0700196 mPageIndicator.setMarkersCount(getChildCount());
Winson Chungd2be3812013-07-16 11:11:32 -0700197 }
198 }
199
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800200 public T getPageIndicator() {
Adam Cohenedb40762013-07-18 16:45:45 -0700201 return mPageIndicator;
202 }
203
Adam Cohen674531f2013-12-13 15:07:14 -0800204 /**
Tony Wickham29d853c2015-09-08 10:35:56 -0700205 * Returns the index of the currently displayed page. When in free scroll mode, this is the page
206 * that the user was on before entering free scroll mode (e.g. the home screen page they
207 * long-pressed on to enter the overview). Try using {@link #getPageNearestToCenterOfScreen()}
208 * to get the page the user is currently scrolling over.
Winson Chung321e9ee2010-08-09 13:37:56 -0700209 */
Sunny Goyal83a8f042015-05-19 12:52:12 -0700210 public int getCurrentPage() {
Winson Chung86f77532010-08-24 11:08:22 -0700211 return mCurrentPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700212 }
Adam Cohen7d30a372013-07-01 17:03:59 -0700213
Hyunyoung Songb76cd622015-04-16 14:34:09 -0700214 /**
215 * Returns the index of page to be shown immediately afterwards.
216 */
Vadim Tryshevfedca432015-08-19 17:55:02 -0700217 public int getNextPage() {
Winson Chung360e63f2012-04-27 13:48:05 -0700218 return (mNextPage != INVALID_PAGE) ? mNextPage : mCurrentPage;
219 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700220
Adam Cohenf9c184a2016-01-15 16:47:43 -0800221 public int getPageCount() {
Winson Chung321e9ee2010-08-09 13:37:56 -0700222 return getChildCount();
223 }
224
Sunny Goyal83a8f042015-05-19 12:52:12 -0700225 public View getPageAt(int index) {
Winson Chung321e9ee2010-08-09 13:37:56 -0700226 return getChildAt(index);
227 }
228
Adam Cohenae4f1552011-10-20 00:15:42 -0700229 protected int indexToPage(int index) {
230 return index;
231 }
232
Winson Chung321e9ee2010-08-09 13:37:56 -0700233 /**
Winson Chungbbc60d82010-11-11 16:34:41 -0800234 * Updates the scroll of the current page immediately to its final scroll position. We use this
235 * in CustomizePagedView to allow tabs to share the same PagedView while resetting the scroll of
236 * the previous tab page.
237 */
238 protected void updateCurrentPageScroll() {
Adam Cohen0ffac432013-07-10 11:19:26 -0700239 // If the current page is invalid, just reset the scroll position to zero
240 int newX = 0;
241 if (0 <= mCurrentPage && mCurrentPage < getPageCount()) {
Adam Cohenedb40762013-07-18 16:45:45 -0700242 newX = getScrollForPage(mCurrentPage);
Adam Cohen0ffac432013-07-10 11:19:26 -0700243 }
Sunny Goyalc82c6392018-06-06 15:39:13 -0700244 scrollTo(newX, 0);
Sunny Goyalb7b01352018-08-09 12:31:20 -0700245 mScroller.startScroll(mScroller.getCurrPos(), newX - mScroller.getCurrPos());
Sunny Goyalc82c6392018-06-06 15:39:13 -0700246 forceFinishScroller(true);
Winson Chungbbc60d82010-11-11 16:34:41 -0800247 }
248
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700249 private void abortScrollerAnimation(boolean resetNextPage) {
Adam Cohen4fe4c932013-10-28 16:02:34 -0700250 mScroller.abortAnimation();
251 // We need to clean up the next page here to avoid computeScrollHelper from
252 // updating current page on the pass.
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700253 if (resetNextPage) {
254 mNextPage = INVALID_PAGE;
Sunny Goyal857b1b92018-03-05 10:49:05 -0800255 pageEndTransition();
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700256 }
Chet Haasebc2f0822012-10-26 17:59:53 -0700257 }
Adam Cohen4fe4c932013-10-28 16:02:34 -0700258
Tony Wickham8f7ead32016-04-07 18:46:44 -0700259 private void forceFinishScroller(boolean resetNextPage) {
Adam Cohen4fe4c932013-10-28 16:02:34 -0700260 mScroller.forceFinished(true);
261 // We need to clean up the next page here to avoid computeScrollHelper from
262 // updating current page on the pass.
Tony Wickham8f7ead32016-04-07 18:46:44 -0700263 if (resetNextPage) {
264 mNextPage = INVALID_PAGE;
Sunny Goyal857b1b92018-03-05 10:49:05 -0800265 pageEndTransition();
Tony Wickham8f7ead32016-04-07 18:46:44 -0700266 }
Adam Cohen4fe4c932013-10-28 16:02:34 -0700267 }
268
Adam Cohen6f127a62014-06-12 14:54:41 -0700269 private int validateNewPage(int newPage) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700270 newPage = ensureWithinScrollBounds(newPage);
Adam Cohen6f127a62014-06-12 14:54:41 -0700271 // Ensure that it is clamped by the actual set of children in all cases
Sunny Goyal4d519f22017-10-24 10:32:40 -0700272 return Utilities.boundToRange(newPage, 0, getPageCount() - 1);
Adam Cohen6f127a62014-06-12 14:54:41 -0700273 }
274
Chet Haasebc2f0822012-10-26 17:59:53 -0700275 /**
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700276 * @return The closest page to the provided page that is within mMinScrollX and mMaxScrollX.
277 */
278 private int ensureWithinScrollBounds(int page) {
279 int dir = !mIsRtl ? 1 : - 1;
280 int currScroll = getScrollForPage(page);
281 int prevScroll;
282 while (currScroll < mMinScrollX) {
283 page += dir;
284 prevScroll = currScroll;
285 currScroll = getScrollForPage(page);
286 if (currScroll <= prevScroll) {
287 Log.e(TAG, "validateNewPage: failed to find a page > mMinScrollX");
288 break;
289 }
290 }
291 while (currScroll > mMaxScrollX) {
292 page -= dir;
293 prevScroll = currScroll;
294 currScroll = getScrollForPage(page);
295 if (currScroll >= prevScroll) {
296 Log.e(TAG, "validateNewPage: failed to find a page < mMaxScrollX");
297 break;
298 }
299 }
300 return page;
301 }
302
Tony Wickham03f27012019-04-25 14:22:54 -0700303 public void setCurrentPage(int currentPage) {
304 setCurrentPage(currentPage, INVALID_PAGE);
305 }
306
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700307 /**
Winson Chung86f77532010-08-24 11:08:22 -0700308 * Sets the current page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700309 */
Tony Wickham03f27012019-04-25 14:22:54 -0700310 public void setCurrentPage(int currentPage, int overridePrevPage) {
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800311 if (!mScroller.isFinished()) {
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700312 abortScrollerAnimation(true);
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800313 }
Michael Jurkad3ef3062010-11-23 16:23:58 -0800314 // don't introduce any checks like mCurrentPage == currentPage here-- if we change the
315 // the default
316 if (getChildCount() == 0) {
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800317 return;
318 }
Tony Wickham03f27012019-04-25 14:22:54 -0700319 int prevPage = overridePrevPage != INVALID_PAGE ? overridePrevPage : mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700320 mCurrentPage = validateNewPage(currentPage);
Winson Chung181c3dc2013-07-17 15:36:20 -0700321 updateCurrentPageScroll();
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700322 notifyPageSwitchListener(prevPage);
Winson Chunga12a2502010-12-20 14:41:35 -0800323 invalidate();
Winson Chung321e9ee2010-08-09 13:37:56 -0700324 }
325
Winson Chung8c87cd82013-07-23 16:20:10 -0700326 /**
Adam Cohen674531f2013-12-13 15:07:14 -0800327 * Should be called whenever the page changes. In the case of a scroll, we wait until the page
328 * has settled.
329 */
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700330 protected void notifyPageSwitchListener(int prevPage) {
Adam Cohen674531f2013-12-13 15:07:14 -0800331 updatePageIndicator();
332 }
333
334 private void updatePageIndicator() {
Sunny Goyal4cbf0462014-08-28 16:19:39 -0700335 if (mPageIndicator != null) {
Tony Mak4f521af2018-03-15 16:37:34 +0000336 mPageIndicator.setActiveMarker(getNextPage());
Winson Chungd2be3812013-07-16 11:11:32 -0700337 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700338 }
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700339 protected void pageBeginTransition() {
340 if (!mIsPageInTransition) {
341 mIsPageInTransition = true;
342 onPageBeginTransition();
Michael Jurkad74c9842011-07-10 12:44:21 -0700343 }
Patrick Dubroy1262e362010-10-06 15:49:50 -0700344 }
345
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700346 protected void pageEndTransition() {
347 if (mIsPageInTransition) {
348 mIsPageInTransition = false;
349 onPageEndTransition();
Michael Jurkad74c9842011-07-10 12:44:21 -0700350 }
Michael Jurka0142d492010-08-25 17:46:15 -0700351 }
352
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700353 protected boolean isPageInTransition() {
354 return mIsPageInTransition;
Adam Cohen26976d92011-03-22 15:33:33 -0700355 }
356
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700357 /**
358 * Called when the page starts moving as part of the scroll. Subclasses can override this
359 * to provide custom behavior during animation.
360 */
361 protected void onPageBeginTransition() {
Patrick Dubroy1262e362010-10-06 15:49:50 -0700362 }
363
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700364 /**
365 * Called when the page ends moving as part of the scroll. Subclasses can override this
366 * to provide custom behavior during animation.
367 */
368 protected void onPageEndTransition() {
Adam Cohenc2d6e892014-10-16 09:49:24 -0700369 mWasInOverscroll = false;
Michael Jurka0142d492010-08-25 17:46:15 -0700370 }
371
Sunny Goyalc86df472016-02-25 09:19:38 -0800372 protected int getUnboundedScrollX() {
Adam Cohen8d769d62017-06-23 17:27:38 -0700373 return mUnboundedScrollX;
Sunny Goyalc86df472016-02-25 09:19:38 -0800374 }
375
Winson Chung321e9ee2010-08-09 13:37:56 -0700376 @Override
Adam Cohen68d73932010-11-15 10:50:58 -0800377 public void scrollBy(int x, int y) {
Sunny Goyalc86df472016-02-25 09:19:38 -0800378 scrollTo(getUnboundedScrollX() + x, getScrollY() + y);
Adam Cohen68d73932010-11-15 10:50:58 -0800379 }
380
381 @Override
Michael Jurka0142d492010-08-25 17:46:15 -0700382 public void scrollTo(int x, int y) {
Adam Cohen8d769d62017-06-23 17:27:38 -0700383 mUnboundedScrollX = x;
384
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700385 boolean isXBeforeFirstPage = mIsRtl ? (x > mMaxScrollX) : (x < mMinScrollX);
386 boolean isXAfterLastPage = mIsRtl ? (x < mMinScrollX) : (x > mMaxScrollX);
Jon Miranda71cb80c2019-01-24 21:25:13 -0800387
388 if (!isXBeforeFirstPage && !isXAfterLastPage) {
389 mSpringOverScrollX = 0;
390 }
391
Adam Cohen0ffac432013-07-10 11:19:26 -0700392 if (isXBeforeFirstPage) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700393 super.scrollTo(mIsRtl ? mMaxScrollX : mMinScrollX, y);
Adam Cohen68d73932010-11-15 10:50:58 -0800394 if (mAllowOverScroll) {
Adam Cohenc2d6e892014-10-16 09:49:24 -0700395 mWasInOverscroll = true;
Sunny Goyal70660032015-05-14 00:07:08 -0700396 if (mIsRtl) {
Adam Cohen0ffac432013-07-10 11:19:26 -0700397 overScroll(x - mMaxScrollX);
398 } else {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700399 overScroll(x - mMinScrollX);
Adam Cohen0ffac432013-07-10 11:19:26 -0700400 }
Adam Cohen68d73932010-11-15 10:50:58 -0800401 }
Adam Cohen0ffac432013-07-10 11:19:26 -0700402 } else if (isXAfterLastPage) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700403 super.scrollTo(mIsRtl ? mMinScrollX : mMaxScrollX, y);
Adam Cohen68d73932010-11-15 10:50:58 -0800404 if (mAllowOverScroll) {
Adam Cohenc2d6e892014-10-16 09:49:24 -0700405 mWasInOverscroll = true;
Sunny Goyal70660032015-05-14 00:07:08 -0700406 if (mIsRtl) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700407 overScroll(x - mMinScrollX);
Adam Cohen0ffac432013-07-10 11:19:26 -0700408 } else {
409 overScroll(x - mMaxScrollX);
410 }
Adam Cohen68d73932010-11-15 10:50:58 -0800411 }
412 } else {
Adam Cohenc2d6e892014-10-16 09:49:24 -0700413 if (mWasInOverscroll) {
414 overScroll(0);
415 mWasInOverscroll = false;
416 }
Adam Cohen68d73932010-11-15 10:50:58 -0800417 super.scrollTo(x, y);
418 }
Sunny Goyalb7b01352018-08-09 12:31:20 -0700419
Michael Jurka0142d492010-08-25 17:46:15 -0700420 }
421
Adam Cohen53805212013-10-01 10:39:23 -0700422 private void sendScrollAccessibilityEvent() {
Sunny Goyald0030b02017-12-08 15:07:24 -0800423 if (isObservedEventType(getContext(), AccessibilityEvent.TYPE_VIEW_SCROLLED)) {
Vadim Tryshevf4715972015-05-08 17:21:03 -0700424 if (mCurrentPage != getNextPage()) {
425 AccessibilityEvent ev =
426 AccessibilityEvent.obtain(AccessibilityEvent.TYPE_VIEW_SCROLLED);
Vadim Tryshev7066c122015-05-21 14:06:35 -0700427 ev.setScrollable(true);
428 ev.setScrollX(getScrollX());
429 ev.setScrollY(getScrollY());
430 ev.setMaxScrollX(mMaxScrollX);
431 ev.setMaxScrollY(0);
Adam Cohen53805212013-10-01 10:39:23 -0700432
Vadim Tryshevf4715972015-05-08 17:21:03 -0700433 sendAccessibilityEventUnchecked(ev);
Adam Cohen53805212013-10-01 10:39:23 -0700434 }
Adam Cohen53805212013-10-01 10:39:23 -0700435 }
436 }
437
Michael Jurka0142d492010-08-25 17:46:15 -0700438 // we moved this functionality to a helper function so SmoothPagedView can reuse it
439 protected boolean computeScrollHelper() {
Tony Wickham95cdb3a2016-02-18 14:37:07 -0800440 return computeScrollHelper(true);
441 }
442
Vadim Tryshev2c430b32018-04-04 14:45:21 -0700443 protected void announcePageForAccessibility() {
444 if (isAccessibilityEnabled(getContext())) {
445 // Notify the user when the page changes
446 announceForAccessibility(getCurrentPageDescription());
447 }
448 }
449
Tony Wickham95cdb3a2016-02-18 14:37:07 -0800450 protected boolean computeScrollHelper(boolean shouldInvalidate) {
Winson Chung321e9ee2010-08-09 13:37:56 -0700451 if (mScroller.computeScrollOffset()) {
Winson Chung557d6ed2011-07-08 15:34:52 -0700452 // Don't bother scrolling if the page does not need to be moved
Sunny Goyalb7b01352018-08-09 12:31:20 -0700453 if (getUnboundedScrollX() != mScroller.getCurrPos()
454 || getScrollX() != mScroller.getCurrPos()) {
455 scrollTo(mScroller.getCurrPos(), 0);
Winson Chung557d6ed2011-07-08 15:34:52 -0700456 }
Tony Wickham95cdb3a2016-02-18 14:37:07 -0800457 if (shouldInvalidate) {
458 invalidate();
459 }
Michael Jurka0142d492010-08-25 17:46:15 -0700460 return true;
Tony Wickham95cdb3a2016-02-18 14:37:07 -0800461 } else if (mNextPage != INVALID_PAGE && shouldInvalidate) {
Adam Cohen53805212013-10-01 10:39:23 -0700462 sendScrollAccessibilityEvent();
463
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700464 int prevPage = mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700465 mCurrentPage = validateNewPage(mNextPage);
Winson Chung86f77532010-08-24 11:08:22 -0700466 mNextPage = INVALID_PAGE;
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700467 notifyPageSwitchListener(prevPage);
Winson Chungb44b5242011-06-13 11:32:14 -0700468
Adam Cohen73aa9752010-11-24 16:26:58 -0800469 // We don't want to trigger a page end moving unless the page has settled
470 // and the user has stopped scrolling
Sunny Goyalaad33592018-08-07 17:20:35 -0700471 if (!mIsBeingDragged) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700472 pageEndTransition();
Adam Cohen73aa9752010-11-24 16:26:58 -0800473 }
Winson Chungc27d1bb2011-09-29 12:07:42 -0700474
Vadim Tryshev2c430b32018-04-04 14:45:21 -0700475 if (canAnnouncePageDescription()) {
476 announcePageForAccessibility();
Adam Cohen0ffac432013-07-10 11:19:26 -0700477 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700478 }
Michael Jurka0142d492010-08-25 17:46:15 -0700479 return false;
480 }
481
482 @Override
483 public void computeScroll() {
484 computeScrollHelper();
Winson Chung321e9ee2010-08-09 13:37:56 -0700485 }
486
Sunny Goyalce8809a2018-01-18 14:02:47 -0800487 public int getExpectedHeight() {
488 return getMeasuredHeight();
489 }
490
Adam Cohen410f3cd2013-09-22 12:09:32 -0700491 public int getNormalChildHeight() {
Sunny Goyalce8809a2018-01-18 14:02:47 -0800492 return getExpectedHeight() - getPaddingTop() - getPaddingBottom()
Sunny Goyalac00cba2017-11-13 15:58:01 -0800493 - mInsets.top - mInsets.bottom;
Adam Cohen410f3cd2013-09-22 12:09:32 -0700494 }
495
Sunny Goyalce8809a2018-01-18 14:02:47 -0800496 public int getExpectedWidth() {
497 return getMeasuredWidth();
498 }
499
Sunny Goyalbc683e92017-12-06 10:25:07 -0800500 public int getNormalChildWidth() {
Sunny Goyalce8809a2018-01-18 14:02:47 -0800501 return getExpectedWidth() - getPaddingLeft() - getPaddingRight()
Sunny Goyalbc683e92017-12-06 10:25:07 -0800502 - mInsets.left - mInsets.right;
503 }
504
Winson Chung321e9ee2010-08-09 13:37:56 -0700505 @Override
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800506 public void requestLayout() {
507 mIsLayoutValid = false;
508 super.requestLayout();
509 }
510
511 @Override
512 public void forceLayout() {
513 mIsLayoutValid = false;
514 super.forceLayout();
515 }
516
517 @Override
Winson Chung321e9ee2010-08-09 13:37:56 -0700518 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
Sunny Goyal8e2133b2015-05-06 13:39:07 -0700519 if (getChildCount() == 0) {
Winson Chungf0ea4d32011-06-06 14:27:16 -0700520 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
521 return;
522 }
523
Adam Cohen7d30a372013-07-01 17:03:59 -0700524 // We measure the dimensions of the PagedView to be larger than the pages so that when we
525 // zoom out (and scale down), the view is still contained in the parent
Adam Cohen7d30a372013-07-01 17:03:59 -0700526 int widthMode = MeasureSpec.getMode(widthMeasureSpec);
527 int widthSize = MeasureSpec.getSize(widthMeasureSpec);
528 int heightMode = MeasureSpec.getMode(heightMeasureSpec);
Winson Chung8aad6102012-05-11 16:27:49 -0700529 int heightSize = MeasureSpec.getSize(heightMeasureSpec);
Adam Cohen410f3cd2013-09-22 12:09:32 -0700530
Adam Cohen7d30a372013-07-01 17:03:59 -0700531 if (widthMode == MeasureSpec.UNSPECIFIED || heightMode == MeasureSpec.UNSPECIFIED) {
532 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
533 return;
Winson Chung321e9ee2010-08-09 13:37:56 -0700534 }
535
Winson Chung8aad6102012-05-11 16:27:49 -0700536 // Return early if we aren't given a proper dimension
537 if (widthSize <= 0 || heightSize <= 0) {
538 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
539 return;
540 }
541
Winson Chung321e9ee2010-08-09 13:37:56 -0700542 // The children are given the same width and height as the workspace
Michael Jurka5f1c5092010-09-03 14:15:02 -0700543 // unless they were set to WRAP_CONTENT
Winson Chung785d2eb2011-04-14 16:08:02 -0700544 if (DEBUG) Log.d(TAG, "PagedView.onMeasure(): " + widthSize + ", " + heightSize);
Michael Jurka5f1c5092010-09-03 14:15:02 -0700545
Sunny Goyalac00cba2017-11-13 15:58:01 -0800546 int myWidthSpec = MeasureSpec.makeMeasureSpec(
Sunny Goyal228153d2018-01-04 15:35:22 -0800547 widthSize - mInsets.left - mInsets.right, MeasureSpec.EXACTLY);
Sunny Goyalac00cba2017-11-13 15:58:01 -0800548 int myHeightSpec = MeasureSpec.makeMeasureSpec(
Sunny Goyal228153d2018-01-04 15:35:22 -0800549 heightSize - mInsets.top - mInsets.bottom, MeasureSpec.EXACTLY);
Adam Cohen96d30a12013-07-16 18:13:21 -0700550
Sunny Goyalac00cba2017-11-13 15:58:01 -0800551 // measureChildren takes accounts for content padding, we only need to care about extra
552 // space due to insets.
553 measureChildren(myWidthSpec, myHeightSpec);
554 setMeasuredDimension(widthSize, heightSize);
Adam Cohen60b07122011-11-14 17:26:06 -0800555 }
556
Sunny Goyalcf25b522015-07-09 00:01:18 -0700557 @SuppressLint("DrawAllocation")
Winson Chung321e9ee2010-08-09 13:37:56 -0700558 @Override
Michael Jurka28750fb2010-09-24 17:43:49 -0700559 protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800560 mIsLayoutValid = true;
Vadim Trysheveb701c62018-05-14 16:00:15 -0700561 final int childCount = getChildCount();
562 boolean pageScrollChanged = false;
563 if (mPageScrolls == null || childCount != mPageScrolls.length) {
564 mPageScrolls = new int[childCount];
565 pageScrollChanged = true;
566 }
567
568 if (childCount == 0) {
Winson Chungf0ea4d32011-06-06 14:27:16 -0700569 return;
570 }
571
Winson Chung785d2eb2011-04-14 16:08:02 -0700572 if (DEBUG) Log.d(TAG, "PagedView.onLayout()");
Winson Chung321e9ee2010-08-09 13:37:56 -0700573
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700574 if (getPageScrolls(mPageScrolls, true, SIMPLE_SCROLL_LOGIC)) {
575 pageScrollChanged = true;
Winson Chung321e9ee2010-08-09 13:37:56 -0700576 }
Winson Chungc3665fa2011-09-14 17:56:27 -0700577
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700578 final LayoutTransition transition = getLayoutTransition();
579 // If the transition is running defer updating max scroll, as some empty pages could
580 // still be present, and a max scroll change could cause sudden jumps in scroll.
581 if (transition != null && transition.isRunning()) {
582 transition.addTransitionListener(new LayoutTransition.TransitionListener() {
583
584 @Override
585 public void startTransition(LayoutTransition transition, ViewGroup container,
586 View view, int transitionType) { }
587
588 @Override
589 public void endTransition(LayoutTransition transition, ViewGroup container,
590 View view, int transitionType) {
591 // Wait until all transitions are complete.
592 if (!transition.isRunning()) {
593 transition.removeTransitionListener(this);
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700594 updateMinAndMaxScrollX();
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700595 }
596 }
597 });
Adam Cohenf698c6e2013-07-17 18:44:25 -0700598 } else {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700599 updateMinAndMaxScrollX();
Adam Cohenf698c6e2013-07-17 18:44:25 -0700600 }
601
Sunny Goyalcb037ee2015-07-08 16:41:21 -0700602 if (mFirstLayout && mCurrentPage >= 0 && mCurrentPage < childCount) {
603 updateCurrentPageScroll();
604 mFirstLayout = false;
605 }
606
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800607 if (mScroller.isFinished() && pageScrollChanged) {
Sunny Goyalc82c6392018-06-06 15:39:13 -0700608 setCurrentPage(getNextPage());
Adam Cohenf698c6e2013-07-17 18:44:25 -0700609 }
Winson Chunge3193b92010-09-10 11:44:42 -0700610 }
611
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700612 /**
613 * Initializes {@code outPageScrolls} with scroll positions for view at that index. The length
614 * of {@code outPageScrolls} should be same as the the childCount
615 *
616 */
617 protected boolean getPageScrolls(int[] outPageScrolls, boolean layoutChildren,
618 ComputePageScrollsLogic scrollLogic) {
619 final int childCount = getChildCount();
620
621 final int startIndex = mIsRtl ? childCount - 1 : 0;
622 final int endIndex = mIsRtl ? -1 : childCount;
623 final int delta = mIsRtl ? -1 : 1;
624
Vadim Tryshev84b46f02018-04-27 17:45:10 -0700625 final int verticalCenter = (getPaddingTop() + getMeasuredHeight() + mInsets.top
626 - mInsets.bottom - getPaddingBottom()) / 2;
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700627
Vadim Tryshevcc0c98a2018-04-26 10:47:05 -0700628 final int scrollOffsetLeft = mInsets.left + getPaddingLeft();
Sunny Goyalc82c6392018-06-06 15:39:13 -0700629 final int scrollOffsetRight = getWidth() - getPaddingRight() - mInsets.right;
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700630 boolean pageScrollChanged = false;
631
Sunny Goyalc82c6392018-06-06 15:39:13 -0700632 for (int i = startIndex, childLeft = scrollOffsetLeft; i != endIndex; i += delta) {
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700633 final View child = getPageAt(i);
634 if (scrollLogic.shouldIncludeView(child)) {
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700635 final int childWidth = child.getMeasuredWidth();
Sunny Goyalc82c6392018-06-06 15:39:13 -0700636 final int childRight = childLeft + childWidth;
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700637
638 if (layoutChildren) {
639 final int childHeight = child.getMeasuredHeight();
Sunny Goyalc82c6392018-06-06 15:39:13 -0700640 final int childTop = verticalCenter - childHeight / 2;
641 child.layout(childLeft, childTop, childRight, childTop + childHeight);
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700642 }
643
Sunny Goyalc82c6392018-06-06 15:39:13 -0700644 // In case the pages are of different width, align the page to left or right edge
645 // based on the orientation.
646 final int pageScroll = mIsRtl
647 ? (childLeft - scrollOffsetLeft)
648 : Math.max(0, childRight - scrollOffsetRight);
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700649 if (outPageScrolls[i] != pageScroll) {
650 pageScrollChanged = true;
651 outPageScrolls[i] = pageScroll;
652 }
653
654 childLeft += childWidth + mPageSpacing + getChildGap();
655 }
656 }
657 return pageScrollChanged;
658 }
659
Sunny Goyala1fbd842015-05-20 13:40:27 -0700660 protected int getChildGap() {
661 return 0;
662 }
663
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700664 protected void updateMinAndMaxScrollX() {
665 mMinScrollX = computeMinScrollX();
Tony Wickhamf549dab2016-05-16 09:54:06 -0700666 mMaxScrollX = computeMaxScrollX();
667 }
668
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700669 protected int computeMinScrollX() {
670 return 0;
Tony50876bf2018-09-19 23:09:14 -0400671 }
672
Tony Wickhamf549dab2016-05-16 09:54:06 -0700673 protected int computeMaxScrollX() {
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700674 int childCount = getChildCount();
675 if (childCount > 0) {
Sunny Goyal70660032015-05-14 00:07:08 -0700676 final int index = mIsRtl ? 0 : childCount - 1;
Tony Wickhamf549dab2016-05-16 09:54:06 -0700677 return getScrollForPage(index);
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700678 } else {
Tony Wickhamf549dab2016-05-16 09:54:06 -0700679 return 0;
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700680 }
681 }
682
Adam Cohen3b185e22013-10-29 14:45:58 -0700683 public void setPageSpacing(int pageSpacing) {
684 mPageSpacing = pageSpacing;
685 requestLayout();
686 }
687
Tony50876bf2018-09-19 23:09:14 -0400688 public int getPageSpacing() {
689 return mPageSpacing;
690 }
691
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800692 private void dispatchPageCountChanged() {
693 if (mPageIndicator != null) {
694 mPageIndicator.setMarkersCount(getChildCount());
Winson Chungd2be3812013-07-16 11:11:32 -0700695 }
Adam Cohen2591f6a2011-10-25 14:36:40 -0700696 // This ensures that when children are added, they get the correct transforms / alphas
697 // in accordance with any scroll effects.
Adam Cohen2591f6a2011-10-25 14:36:40 -0700698 invalidate();
699 }
700
Michael Jurka8b805b12012-04-18 14:23:14 -0700701 @Override
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800702 public void onViewAdded(View child) {
Winson Chungc7c51582018-02-23 17:58:36 -0800703 super.onViewAdded(child);
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800704 dispatchPageCountChanged();
705 }
706
707 @Override
708 public void onViewRemoved(View child) {
Winson Chungc7c51582018-02-23 17:58:36 -0800709 super.onViewRemoved(child);
Tonya361c722017-07-04 09:43:06 -0700710 mCurrentPage = validateNewPage(mCurrentPage);
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800711 dispatchPageCountChanged();
Winson Chungd2be3812013-07-16 11:11:32 -0700712 }
713
Adam Cohen73894962011-10-31 13:17:17 -0700714 protected int getChildOffset(int index) {
Adam Cohen7d30a372013-07-01 17:03:59 -0700715 if (index < 0 || index > getChildCount() - 1) return 0;
Sunny Goyal228153d2018-01-04 15:35:22 -0800716 return getPageAt(index).getLeft();
Adam Cohen73894962011-10-31 13:17:17 -0700717 }
718
Winson Chung321e9ee2010-08-09 13:37:56 -0700719 @Override
720 public boolean requestChildRectangleOnScreen(View child, Rect rectangle, boolean immediate) {
Adam Cohenae4f1552011-10-20 00:15:42 -0700721 int page = indexToPage(indexOfChild(child));
Winson Chung86f77532010-08-24 11:08:22 -0700722 if (page != mCurrentPage || !mScroller.isFinished()) {
Vadim Trysheveeaa8ee2018-04-11 12:23:42 -0700723 if (immediate) {
724 setCurrentPage(page);
725 } else {
726 snapToPage(page);
727 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700728 return true;
729 }
730 return false;
731 }
732
733 @Override
734 protected boolean onRequestFocusInDescendants(int direction, Rect previouslyFocusedRect) {
Winson Chung86f77532010-08-24 11:08:22 -0700735 int focusablePage;
736 if (mNextPage != INVALID_PAGE) {
737 focusablePage = mNextPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700738 } else {
Winson Chung86f77532010-08-24 11:08:22 -0700739 focusablePage = mCurrentPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700740 }
Winson Chung86f77532010-08-24 11:08:22 -0700741 View v = getPageAt(focusablePage);
Winson Chung321e9ee2010-08-09 13:37:56 -0700742 if (v != null) {
Adam Cohen76fc0852011-06-17 13:26:23 -0700743 return v.requestFocus(direction, previouslyFocusedRect);
Winson Chung321e9ee2010-08-09 13:37:56 -0700744 }
745 return false;
746 }
747
748 @Override
749 public boolean dispatchUnhandledMove(View focused, int direction) {
Sunny Goyal0c4e3722015-12-01 13:21:49 -0800750 if (super.dispatchUnhandledMove(focused, direction)) {
751 return true;
752 }
753
754 if (mIsRtl) {
755 if (direction == View.FOCUS_LEFT) {
756 direction = View.FOCUS_RIGHT;
757 } else if (direction == View.FOCUS_RIGHT) {
758 direction = View.FOCUS_LEFT;
759 }
760 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700761 if (direction == View.FOCUS_LEFT) {
Winson Chung86f77532010-08-24 11:08:22 -0700762 if (getCurrentPage() > 0) {
763 snapToPage(getCurrentPage() - 1);
Sunny Goyalc82c6392018-06-06 15:39:13 -0700764 getChildAt(getCurrentPage() - 1).requestFocus(direction);
Winson Chung321e9ee2010-08-09 13:37:56 -0700765 return true;
766 }
767 } else if (direction == View.FOCUS_RIGHT) {
Winson Chung86f77532010-08-24 11:08:22 -0700768 if (getCurrentPage() < getPageCount() - 1) {
769 snapToPage(getCurrentPage() + 1);
Sunny Goyalc82c6392018-06-06 15:39:13 -0700770 getChildAt(getCurrentPage() + 1).requestFocus(direction);
Winson Chung321e9ee2010-08-09 13:37:56 -0700771 return true;
772 }
773 }
Sunny Goyal0c4e3722015-12-01 13:21:49 -0800774 return false;
Winson Chung321e9ee2010-08-09 13:37:56 -0700775 }
776
777 @Override
778 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) {
Jon Miranda6a858172016-10-25 16:19:17 -0700779 if (getDescendantFocusability() == FOCUS_BLOCK_DESCENDANTS) {
780 return;
781 }
782
Adam Cohen0ffac432013-07-10 11:19:26 -0700783 // XXX-RTL: This will be fixed in a future CL
Winson Chung86f77532010-08-24 11:08:22 -0700784 if (mCurrentPage >= 0 && mCurrentPage < getPageCount()) {
alanvaf519952012-05-07 17:33:22 -0700785 getPageAt(mCurrentPage).addFocusables(views, direction, focusableMode);
Winson Chung321e9ee2010-08-09 13:37:56 -0700786 }
787 if (direction == View.FOCUS_LEFT) {
Winson Chung86f77532010-08-24 11:08:22 -0700788 if (mCurrentPage > 0) {
alanvaf519952012-05-07 17:33:22 -0700789 getPageAt(mCurrentPage - 1).addFocusables(views, direction, focusableMode);
Winson Chung321e9ee2010-08-09 13:37:56 -0700790 }
791 } else if (direction == View.FOCUS_RIGHT){
Winson Chung86f77532010-08-24 11:08:22 -0700792 if (mCurrentPage < getPageCount() - 1) {
alanvaf519952012-05-07 17:33:22 -0700793 getPageAt(mCurrentPage + 1).addFocusables(views, direction, focusableMode);
Winson Chung321e9ee2010-08-09 13:37:56 -0700794 }
795 }
796 }
797
798 /**
799 * If one of our descendant views decides that it could be focused now, only
Winson Chung86f77532010-08-24 11:08:22 -0700800 * pass that along if it's on the current page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700801 *
Winson Chung86f77532010-08-24 11:08:22 -0700802 * This happens when live folders requery, and if they're off page, they
803 * end up calling requestFocus, which pulls it on page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700804 */
805 @Override
806 public void focusableViewAvailable(View focused) {
Winson Chung86f77532010-08-24 11:08:22 -0700807 View current = getPageAt(mCurrentPage);
Winson Chung321e9ee2010-08-09 13:37:56 -0700808 View v = focused;
809 while (true) {
810 if (v == current) {
811 super.focusableViewAvailable(focused);
812 return;
813 }
814 if (v == this) {
815 return;
816 }
817 ViewParent parent = v.getParent();
818 if (parent instanceof View) {
819 v = (View)v.getParent();
820 } else {
821 return;
822 }
823 }
824 }
825
826 /**
827 * {@inheritDoc}
828 */
829 @Override
830 public void requestDisallowInterceptTouchEvent(boolean disallowIntercept) {
831 if (disallowIntercept) {
832 // We need to make sure to cancel our long press if
833 // a scrollable widget takes over touch events
Adam Cohen22f823d2011-09-01 17:22:18 -0700834 final View currentPage = getPageAt(mCurrentPage);
Winson Chung86f77532010-08-24 11:08:22 -0700835 currentPage.cancelLongPress();
Winson Chung321e9ee2010-08-09 13:37:56 -0700836 }
837 super.requestDisallowInterceptTouchEvent(disallowIntercept);
838 }
839
840 @Override
841 public boolean onInterceptTouchEvent(MotionEvent ev) {
842 /*
843 * This method JUST determines whether we want to intercept the motion.
844 * If we return true, onTouchEvent will be called and we do the actual
845 * scrolling there.
846 */
847
Winson Chung45e1d6e2010-11-09 17:19:49 -0800848 // Skip touch handling if there are no pages to swipe
Adam Cohenab6be312019-07-06 13:24:59 +0900849 if (getChildCount() <= 0 || shouldBlockGestures(ev)) return false;
Sunny Goyalc4bb3732019-06-20 11:34:14 -0700850
851 acquireVelocityTrackerAndAddMovement(ev);
Winson Chung45e1d6e2010-11-09 17:19:49 -0800852
Winson Chung321e9ee2010-08-09 13:37:56 -0700853 /*
854 * Shortcut the most recurring case: the user is in the dragging
855 * state and he is moving his finger. We want to intercept this
856 * motion.
857 */
858 final int action = ev.getAction();
Sunny Goyalaad33592018-08-07 17:20:35 -0700859 if ((action == MotionEvent.ACTION_MOVE) && mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -0700860 return true;
861 }
862
Winson Chung321e9ee2010-08-09 13:37:56 -0700863 switch (action & MotionEvent.ACTION_MASK) {
864 case MotionEvent.ACTION_MOVE: {
865 /*
866 * mIsBeingDragged == false, otherwise the shortcut would have caught it. Check
867 * whether the user has moved far enough from his original down touch.
868 */
Michael Jurka1ff706b2010-09-14 17:35:20 -0700869 if (mActivePointerId != INVALID_POINTER) {
870 determineScrollingStart(ev);
Michael Jurka1ff706b2010-09-14 17:35:20 -0700871 }
872 // if mActivePointerId is INVALID_POINTER, then we must have missed an ACTION_DOWN
873 // event. in that case, treat the first occurence of a move event as a ACTION_DOWN
874 // i.e. fall through to the next case (don't break)
875 // (We sometimes miss ACTION_DOWN events in Workspace because it ignores all events
876 // while it's small- this was causing a crash before we checked for INVALID_POINTER)
Adam Cohen93c97562013-09-26 13:48:01 -0700877 break;
Winson Chung321e9ee2010-08-09 13:37:56 -0700878 }
879
880 case MotionEvent.ACTION_DOWN: {
881 final float x = ev.getX();
882 final float y = ev.getY();
883 // Remember location of down touch
884 mDownMotionX = x;
Adam Cohen7d30a372013-07-01 17:03:59 -0700885 mDownMotionY = y;
Winson Chung321e9ee2010-08-09 13:37:56 -0700886 mLastMotionX = x;
Winson Chungc0844aa2011-02-02 15:25:58 -0800887 mLastMotionXRemainder = 0;
Adam Cohenaefd4e12011-02-14 16:39:38 -0800888 mTotalMotionX = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -0700889 mActivePointerId = ev.getPointerId(0);
Adam Cohen7d30a372013-07-01 17:03:59 -0700890
Winson Chung321e9ee2010-08-09 13:37:56 -0700891 /*
892 * If being flinged and user touches the screen, initiate drag;
893 * otherwise don't. mScroller.isFinished should be false when
894 * being flinged.
895 */
Sunny Goyalb7b01352018-08-09 12:31:20 -0700896 final int xDist = Math.abs(mScroller.getFinalPos() - mScroller.getCurrPos());
Adam Cohena7652152013-11-18 20:06:55 +0000897 final boolean finishedScrolling = (mScroller.isFinished() || xDist < mTouchSlop / 3);
Adam Cohen2da0a052013-11-08 06:28:17 -0800898
Winson Chung5f2aa4e2010-08-20 14:49:25 -0700899 if (finishedScrolling) {
Sunny Goyalaad33592018-08-07 17:20:35 -0700900 mIsBeingDragged = false;
Adam Cohen59b5c792013-12-04 16:09:07 -0800901 if (!mScroller.isFinished() && !mFreeScroll) {
Adam Cohena7652152013-11-18 20:06:55 +0000902 setCurrentPage(getNextPage());
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700903 pageEndTransition();
Adam Cohen2da0a052013-11-08 06:28:17 -0800904 }
Winson Chung5f2aa4e2010-08-20 14:49:25 -0700905 } else {
Tony Wickham44a58882019-04-09 14:24:33 -0700906 mIsBeingDragged = true;
Winson Chung5f2aa4e2010-08-20 14:49:25 -0700907 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700908
Winson Chung321e9ee2010-08-09 13:37:56 -0700909 break;
910 }
911
Winson Chung321e9ee2010-08-09 13:37:56 -0700912 case MotionEvent.ACTION_UP:
Jeff Brown1d0867c2010-12-02 18:27:39 -0800913 case MotionEvent.ACTION_CANCEL:
Adam Cohen7d30a372013-07-01 17:03:59 -0700914 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -0700915 break;
916
917 case MotionEvent.ACTION_POINTER_UP:
918 onSecondaryPointerUp(ev);
Adam Cohen6342bba2011-03-10 11:33:35 -0800919 releaseVelocityTracker();
Winson Chung321e9ee2010-08-09 13:37:56 -0700920 break;
921 }
922
923 /*
924 * The only time we want to intercept motion events is if we are in the
925 * drag mode.
926 */
Sunny Goyalaad33592018-08-07 17:20:35 -0700927 return mIsBeingDragged;
Winson Chung321e9ee2010-08-09 13:37:56 -0700928 }
929
Sunny Goyal7c7be8c2018-03-07 19:58:07 -0800930 public boolean isHandlingTouch() {
Sunny Goyalaad33592018-08-07 17:20:35 -0700931 return mIsBeingDragged;
Sunny Goyal7c7be8c2018-03-07 19:58:07 -0800932 }
933
Adam Cohenf8d28232011-02-01 21:47:00 -0800934 protected void determineScrollingStart(MotionEvent ev) {
935 determineScrollingStart(ev, 1.0f);
936 }
937
Winson Chung321e9ee2010-08-09 13:37:56 -0700938 /*
939 * Determines if we should change the touch state to start scrolling after the
940 * user moves their touch point too far.
941 */
Adam Cohenf8d28232011-02-01 21:47:00 -0800942 protected void determineScrollingStart(MotionEvent ev, float touchSlopScale) {
Adam Cohen7d30a372013-07-01 17:03:59 -0700943 // Disallow scrolling if we don't have a valid pointer index
Winson Chung321e9ee2010-08-09 13:37:56 -0700944 final int pointerIndex = ev.findPointerIndex(mActivePointerId);
Adam Cohen7d30a372013-07-01 17:03:59 -0700945 if (pointerIndex == -1) return;
946
Winson Chung321e9ee2010-08-09 13:37:56 -0700947 final float x = ev.getX(pointerIndex);
Winson Chung321e9ee2010-08-09 13:37:56 -0700948 final int xDiff = (int) Math.abs(x - mLastMotionX);
Adam Cohenf8d28232011-02-01 21:47:00 -0800949 final int touchSlop = Math.round(touchSlopScale * mTouchSlop);
Winson Chung321e9ee2010-08-09 13:37:56 -0700950 boolean xMoved = xDiff > touchSlop;
Winson Chung321e9ee2010-08-09 13:37:56 -0700951
Sunny Goyal5a1f53b2015-05-27 10:24:24 -0700952 if (xMoved) {
953 // Scroll if the user moved far enough along the X axis
Sunny Goyalaad33592018-08-07 17:20:35 -0700954 mIsBeingDragged = true;
Sunny Goyal5a1f53b2015-05-27 10:24:24 -0700955 mTotalMotionX += Math.abs(mLastMotionX - x);
956 mLastMotionX = x;
957 mLastMotionXRemainder = 0;
Sunny Goyal5a1f53b2015-05-27 10:24:24 -0700958 onScrollInteractionBegin();
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700959 pageBeginTransition();
Tony Wickhamdadb3042016-02-24 11:07:00 -0800960 // Stop listening for things like pinches.
961 requestDisallowInterceptTouchEvent(true);
Adam Cohenf8d28232011-02-01 21:47:00 -0800962 }
963 }
964
965 protected void cancelCurrentPageLongPress() {
Sunny Goyal8e2133b2015-05-06 13:39:07 -0700966 // Try canceling the long press. It could also have been scheduled
967 // by a distant descendant, so use the mAllowLongPress flag to block
968 // everything
969 final View currentPage = getPageAt(mCurrentPage);
970 if (currentPage != null) {
971 currentPage.cancelLongPress();
Winson Chung321e9ee2010-08-09 13:37:56 -0700972 }
973 }
974
Adam Cohenb5ba0972011-09-07 18:02:31 -0700975 protected float getScrollProgress(int screenCenter, View v, int page) {
Sunny Goyal228153d2018-01-04 15:35:22 -0800976 final int halfScreenSize = getMeasuredWidth() / 2;
Adam Cohenb5ba0972011-09-07 18:02:31 -0700977
Adam Cohenedb40762013-07-18 16:45:45 -0700978 int delta = screenCenter - (getScrollForPage(page) + halfScreenSize);
Adam Cohen3b185e22013-10-29 14:45:58 -0700979 int count = getChildCount();
980
981 final int totalDistance;
982
983 int adjacentPage = page + 1;
Sunny Goyal70660032015-05-14 00:07:08 -0700984 if ((delta < 0 && !mIsRtl) || (delta > 0 && mIsRtl)) {
Adam Cohen3b185e22013-10-29 14:45:58 -0700985 adjacentPage = page - 1;
986 }
987
988 if (adjacentPage < 0 || adjacentPage > count - 1) {
989 totalDistance = v.getMeasuredWidth() + mPageSpacing;
990 } else {
991 totalDistance = Math.abs(getScrollForPage(adjacentPage) - getScrollForPage(page));
992 }
Adam Cohenb5ba0972011-09-07 18:02:31 -0700993
994 float scrollProgress = delta / (totalDistance * 1.0f);
Sunny Goyal8e2133b2015-05-06 13:39:07 -0700995 scrollProgress = Math.min(scrollProgress, MAX_SCROLL_PROGRESS);
996 scrollProgress = Math.max(scrollProgress, - MAX_SCROLL_PROGRESS);
Adam Cohenb5ba0972011-09-07 18:02:31 -0700997 return scrollProgress;
998 }
999
Adam Cohenedb40762013-07-18 16:45:45 -07001000 public int getScrollForPage(int index) {
Adam Cohen1f1f45d2013-10-02 09:40:18 -07001001 if (mPageScrolls == null || index >= mPageScrolls.length || index < 0) {
Adam Cohenedb40762013-07-18 16:45:45 -07001002 return 0;
1003 } else {
1004 return mPageScrolls[index];
1005 }
1006 }
1007
Adam Cohen564a2e72013-10-09 14:47:32 -07001008 // While layout transitions are occurring, a child's position may stray from its baseline
1009 // position. This method returns the magnitude of this stray at any given time.
1010 public int getLayoutTransitionOffsetForPage(int index) {
1011 if (mPageScrolls == null || index >= mPageScrolls.length || index < 0) {
1012 return 0;
1013 } else {
1014 View child = getChildAt(index);
Adam Cohen3b185e22013-10-29 14:45:58 -07001015
Sunny Goyal228153d2018-01-04 15:35:22 -08001016 int scrollOffset = mIsRtl ? getPaddingRight() : getPaddingLeft();
1017 int baselineX = mPageScrolls[index] + scrollOffset;
Adam Cohen564a2e72013-10-09 14:47:32 -07001018 return (int) (child.getX() - baselineX);
1019 }
1020 }
1021
Jon Miranda71cb80c2019-01-24 21:25:13 -08001022 @Override
1023 protected void dispatchDraw(Canvas canvas) {
1024 if (mScroller.isSpringing() && mSpringOverScrollX != 0) {
1025 int saveCount = canvas.save();
1026
1027 canvas.translate(-mSpringOverScrollX, 0);
1028 super.dispatchDraw(canvas);
1029
1030 canvas.restoreToCount(saveCount);
1031 } else {
1032 super.dispatchDraw(canvas);
1033 }
1034 }
1035
Sunny Goyalb7b01352018-08-09 12:31:20 -07001036 protected void dampedOverScroll(int amount) {
Jon Miranda71cb80c2019-01-24 21:25:13 -08001037 mSpringOverScrollX = amount;
1038 if (amount == 0) {
1039 return;
1040 }
Adam Cohen8d769d62017-06-23 17:27:38 -07001041
Sunny Goyal228153d2018-01-04 15:35:22 -08001042 int overScrollAmount = OverScroll.dampedScroll(amount, getMeasuredWidth());
Jon Miranda71cb80c2019-01-24 21:25:13 -08001043 mSpringOverScrollX = overScrollAmount;
1044 if (mScroller.isSpringing()) {
1045 invalidate();
1046 return;
1047 }
1048
Tony Wickham66d1c2f2019-04-24 11:32:59 -07001049 int x = Utilities.boundToRange(getScrollX(), mMinScrollX, mMaxScrollX);
1050 super.scrollTo(x + overScrollAmount, getScrollY());
Adam Cohen68d73932010-11-15 10:50:58 -08001051 invalidate();
1052 }
1053
Sunny Goyalb7b01352018-08-09 12:31:20 -07001054 protected void overScroll(int amount) {
Jon Miranda71cb80c2019-01-24 21:25:13 -08001055 mSpringOverScrollX = amount;
1056 if (mScroller.isSpringing()) {
1057 invalidate();
1058 return;
1059 }
1060
Sunny Goyalb7b01352018-08-09 12:31:20 -07001061 if (amount == 0) return;
1062
1063 if (mFreeScroll && !mScroller.isFinished()) {
1064 if (amount < 0) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -07001065 super.scrollTo(mMinScrollX + amount, getScrollY());
Sunny Goyalb7b01352018-08-09 12:31:20 -07001066 } else {
1067 super.scrollTo(mMaxScrollX + amount, getScrollY());
1068 }
1069 } else {
1070 dampedOverScroll(amount);
1071 }
Adam Cohenb5ba0972011-09-07 18:02:31 -07001072 }
1073
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001074
Tony Wickham023f4042019-01-29 10:52:31 -08001075 public void setEnableFreeScroll(boolean freeScroll) {
Winson Chung0e449002019-04-26 11:09:58 -07001076 if (mFreeScroll == freeScroll) {
1077 return;
1078 }
1079
Tony Wickham8f7ead32016-04-07 18:46:44 -07001080 boolean wasFreeScroll = mFreeScroll;
Adam Cohenf358a4b2013-07-23 16:47:31 -07001081 mFreeScroll = freeScroll;
1082
Adam Cohenf9618852013-11-08 06:45:03 -08001083 if (mFreeScroll) {
Sunny Goyal4d519f22017-10-24 10:32:40 -07001084 setCurrentPage(getNextPage());
Tony Wickham8f7ead32016-04-07 18:46:44 -07001085 } else if (wasFreeScroll) {
1086 snapToPage(getNextPage());
Adam Cohenf358a4b2013-07-23 16:47:31 -07001087 }
Adam Cohenf358a4b2013-07-23 16:47:31 -07001088 }
1089
Sunny Goyal2f0ec852015-03-26 13:38:27 -07001090 protected void setEnableOverscroll(boolean enable) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001091 mAllowOverScroll = enable;
1092 }
1093
Adam Cohenab6be312019-07-06 13:24:59 +09001094 protected boolean shouldBlockGestures(MotionEvent ev) {
1095 return false;
1096 }
1097
Winson Chung321e9ee2010-08-09 13:37:56 -07001098 @Override
1099 public boolean onTouchEvent(MotionEvent ev) {
Winson Chung45e1d6e2010-11-09 17:19:49 -08001100 // Skip touch handling if there are no pages to swipe
Adam Cohenab6be312019-07-06 13:24:59 +09001101 if (getChildCount() <= 0 || shouldBlockGestures(ev)) return false;
Winson Chung45e1d6e2010-11-09 17:19:49 -08001102
Michael Jurkab8f06722010-10-10 15:58:46 -07001103 acquireVelocityTrackerAndAddMovement(ev);
Winson Chung321e9ee2010-08-09 13:37:56 -07001104
1105 final int action = ev.getAction();
1106
1107 switch (action & MotionEvent.ACTION_MASK) {
1108 case MotionEvent.ACTION_DOWN:
1109 /*
1110 * If being flinged and user touches, stop the fling. isFinished
1111 * will be false if being flinged.
1112 */
1113 if (!mScroller.isFinished()) {
Adam Cohen8bdbaab2013-10-29 15:25:02 -07001114 abortScrollerAnimation(false);
Winson Chung321e9ee2010-08-09 13:37:56 -07001115 }
1116
1117 // Remember where the motion event started
1118 mDownMotionX = mLastMotionX = ev.getX();
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001119 mDownMotionY = ev.getY();
Winson Chungc0844aa2011-02-02 15:25:58 -08001120 mLastMotionXRemainder = 0;
Adam Cohenaefd4e12011-02-14 16:39:38 -08001121 mTotalMotionX = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -07001122 mActivePointerId = ev.getPointerId(0);
Adam Cohen7d30a372013-07-01 17:03:59 -07001123
Sunny Goyalaad33592018-08-07 17:20:35 -07001124 if (mIsBeingDragged) {
Adam Cohenc2d6e892014-10-16 09:49:24 -07001125 onScrollInteractionBegin();
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001126 pageBeginTransition();
Michael Jurka0142d492010-08-25 17:46:15 -07001127 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001128 break;
1129
1130 case MotionEvent.ACTION_MOVE:
Sunny Goyalaad33592018-08-07 17:20:35 -07001131 if (mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001132 // Scroll to follow the motion event
1133 final int pointerIndex = ev.findPointerIndex(mActivePointerId);
Adam Cohen7d30a372013-07-01 17:03:59 -07001134
1135 if (pointerIndex == -1) return true;
1136
Winson Chung321e9ee2010-08-09 13:37:56 -07001137 final float x = ev.getX(pointerIndex);
Winson Chungc0844aa2011-02-02 15:25:58 -08001138 final float deltaX = mLastMotionX + mLastMotionXRemainder - x;
Winson Chung321e9ee2010-08-09 13:37:56 -07001139
Adam Cohenaefd4e12011-02-14 16:39:38 -08001140 mTotalMotionX += Math.abs(deltaX);
1141
Winson Chungc0844aa2011-02-02 15:25:58 -08001142 // Only scroll and update mLastMotionX if we have moved some discrete amount. We
1143 // keep the remainder because we are actually testing if we've moved from the last
1144 // scrolled position (which is discrete).
1145 if (Math.abs(deltaX) >= 1.0f) {
Sunny Goyal5a1f53b2015-05-27 10:24:24 -07001146 scrollBy((int) deltaX, 0);
Winson Chungc0844aa2011-02-02 15:25:58 -08001147 mLastMotionX = x;
1148 mLastMotionXRemainder = deltaX - (int) deltaX;
Winson Chung321e9ee2010-08-09 13:37:56 -07001149 } else {
1150 awakenScrollBars();
1151 }
Adam Cohen564976a2010-10-13 18:52:07 -07001152 } else {
Winson Chung321e9ee2010-08-09 13:37:56 -07001153 determineScrollingStart(ev);
1154 }
1155 break;
1156
1157 case MotionEvent.ACTION_UP:
Sunny Goyalaad33592018-08-07 17:20:35 -07001158 if (mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001159 final int activePointerId = mActivePointerId;
1160 final int pointerIndex = ev.findPointerIndex(activePointerId);
1161 final float x = ev.getX(pointerIndex);
Sunny Goyal4bb8b062019-02-19 16:37:38 -08001162 final VelocityTracker velocityTracker = mVelocityTracker;
1163 velocityTracker.computeCurrentVelocity(1000, mMaximumVelocity);
1164 int velocityX = (int) velocityTracker.getXVelocity(mActivePointerId);
Winson Chung9cfd25f2010-10-24 16:09:28 -07001165 final int deltaX = (int) (x - mDownMotionX);
Adam Cohen96d30a12013-07-16 18:13:21 -07001166 final int pageWidth = getPageAt(mCurrentPage).getMeasuredWidth();
Adam Cohen00481b32011-11-18 12:03:48 -08001167 boolean isSignificantMove = Math.abs(deltaX) > pageWidth *
1168 SIGNIFICANT_MOVE_THRESHOLD;
Adam Cohenaefd4e12011-02-14 16:39:38 -08001169
Adam Cohenb64cb5a2011-02-15 13:53:42 -08001170 mTotalMotionX += Math.abs(mLastMotionX + mLastMotionXRemainder - x);
Tony Makc25afd02018-02-27 14:43:47 +00001171 boolean isFling = mTotalMotionX > mTouchSlop && shouldFlingForVelocity(velocityX);
Sunny Goyalb7b01352018-08-09 12:31:20 -07001172 boolean isDeltaXLeft = mIsRtl ? deltaX > 0 : deltaX < 0;
1173 boolean isVelocityXLeft = mIsRtl ? velocityX > 0 : velocityX < 0;
Adam Cohen00481b32011-11-18 12:03:48 -08001174
Adam Cohenf358a4b2013-07-23 16:47:31 -07001175 if (!mFreeScroll) {
1176 // In the case that the page is moved far to one direction and then is flung
1177 // in the opposite direction, we use a threshold to determine whether we should
1178 // just return to the starting page, or if we should skip one further.
1179 boolean returnToOriginalPage = false;
1180 if (Math.abs(deltaX) > pageWidth * RETURN_TO_ORIGINAL_PAGE_THRESHOLD &&
1181 Math.signum(velocityX) != Math.signum(deltaX) && isFling) {
1182 returnToOriginalPage = true;
1183 }
Adam Cohenaefd4e12011-02-14 16:39:38 -08001184
Adam Cohenf358a4b2013-07-23 16:47:31 -07001185 int finalPage;
1186 // We give flings precedence over large moves, which is why we short-circuit our
1187 // test for a large move if a fling has been registered. That is, a large
1188 // move to the left and fling to the right will register as a fling to the right.
Sunny Goyalb7b01352018-08-09 12:31:20 -07001189
Adam Cohenf358a4b2013-07-23 16:47:31 -07001190 if (((isSignificantMove && !isDeltaXLeft && !isFling) ||
1191 (isFling && !isVelocityXLeft)) && mCurrentPage > 0) {
1192 finalPage = returnToOriginalPage ? mCurrentPage : mCurrentPage - 1;
1193 snapToPageWithVelocity(finalPage, velocityX);
1194 } else if (((isSignificantMove && isDeltaXLeft && !isFling) ||
1195 (isFling && isVelocityXLeft)) &&
1196 mCurrentPage < getChildCount() - 1) {
1197 finalPage = returnToOriginalPage ? mCurrentPage : mCurrentPage + 1;
1198 snapToPageWithVelocity(finalPage, velocityX);
1199 } else {
1200 snapToDestination();
Adam Cohenf358a4b2013-07-23 16:47:31 -07001201 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001202 } else {
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001203 if (!mScroller.isFinished()) {
1204 abortScrollerAnimation(true);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001205 }
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001206
Sunny Goyalb7b01352018-08-09 12:31:20 -07001207 int initialScrollX = getScrollX();
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001208
Sunny Goyalb7b01352018-08-09 12:31:20 -07001209 if (((initialScrollX >= mMaxScrollX) && (isVelocityXLeft || !isFling)) ||
Tony Wickham66d1c2f2019-04-24 11:32:59 -07001210 ((initialScrollX <= mMinScrollX) && (!isVelocityXLeft || !isFling))) {
1211 mScroller.springBack(getScrollX(), mMinScrollX, mMaxScrollX);
Tony Wickham312209b2019-06-18 15:54:29 -07001212 mNextPage = getPageNearestToCenterOfScreen();
Sunny Goyalb7b01352018-08-09 12:31:20 -07001213 } else {
1214 mScroller.setInterpolator(mDefaultInterpolator);
1215 mScroller.fling(initialScrollX, -velocityX,
Tony Wickham66d1c2f2019-04-24 11:32:59 -07001216 mMinScrollX, mMaxScrollX,
Sunny Goyalb7b01352018-08-09 12:31:20 -07001217 Math.round(getWidth() * 0.5f * OVERSCROLL_DAMP_FACTOR));
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001218
Sunny Goyalb7b01352018-08-09 12:31:20 -07001219 int finalX = mScroller.getFinalPos();
1220 mNextPage = getPageNearestToCenterOfScreen(finalX);
1221
1222 int firstPageScroll = getScrollForPage(!mIsRtl ? 0 : getPageCount() - 1);
1223 int lastPageScroll = getScrollForPage(!mIsRtl ? getPageCount() - 1 : 0);
Tony Wickham66d1c2f2019-04-24 11:32:59 -07001224 if (finalX > mMinScrollX && finalX < mMaxScrollX) {
Sunny Goyalb7b01352018-08-09 12:31:20 -07001225 // If scrolling ends in the half of the added space that is closer to
1226 // the end, settle to the end. Otherwise snap to the nearest page.
1227 // If flinging past one of the ends, don't change the velocity as it
1228 // will get stopped at the end anyway.
Tony Wickham66d1c2f2019-04-24 11:32:59 -07001229 int pageSnappedX = finalX < (firstPageScroll + mMinScrollX) / 2
1230 ? mMinScrollX
Sunny Goyalb7b01352018-08-09 12:31:20 -07001231 : finalX > (lastPageScroll + mMaxScrollX) / 2
1232 ? mMaxScrollX
1233 : getScrollForPage(mNextPage);
1234
1235 mScroller.setFinalPos(pageSnappedX);
1236 // Ensure the scroll/snap doesn't happen too fast;
1237 int extraScrollDuration = OVERSCROLL_PAGE_SNAP_ANIMATION_DURATION
1238 - mScroller.getDuration();
1239 if (extraScrollDuration > 0) {
1240 mScroller.extendDuration(extraScrollDuration);
1241 }
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001242 }
1243 }
1244 invalidate();
Winson Chung321e9ee2010-08-09 13:37:56 -07001245 }
Adam Cohenc2d6e892014-10-16 09:49:24 -07001246 onScrollInteractionEnd();
Winson Chung321e9ee2010-08-09 13:37:56 -07001247 }
Adam Cohen7d30a372013-07-01 17:03:59 -07001248
Adam Cohen7d30a372013-07-01 17:03:59 -07001249 // End any intermediate reordering states
1250 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001251 break;
1252
1253 case MotionEvent.ACTION_CANCEL:
Sunny Goyalaad33592018-08-07 17:20:35 -07001254 if (mIsBeingDragged) {
Michael Jurkab8f06722010-10-10 15:58:46 -07001255 snapToDestination();
Sunny Goyal4ff424a2016-08-12 12:46:01 -07001256 onScrollInteractionEnd();
Michael Jurkab8f06722010-10-10 15:58:46 -07001257 }
Adam Cohen7d30a372013-07-01 17:03:59 -07001258 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001259 break;
1260
1261 case MotionEvent.ACTION_POINTER_UP:
1262 onSecondaryPointerUp(ev);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001263 releaseVelocityTracker();
Winson Chung321e9ee2010-08-09 13:37:56 -07001264 break;
1265 }
1266
1267 return true;
1268 }
1269
Sunny Goyal65d9ceb2017-05-08 09:17:42 -07001270 protected boolean shouldFlingForVelocity(int velocityX) {
1271 return Math.abs(velocityX) > mFlingThresholdVelocity;
1272 }
1273
Adam Cohen7d30a372013-07-01 17:03:59 -07001274 private void resetTouchState() {
1275 releaseVelocityTracker();
Sunny Goyalaad33592018-08-07 17:20:35 -07001276 mIsBeingDragged = false;
Adam Cohen7d30a372013-07-01 17:03:59 -07001277 mActivePointerId = INVALID_POINTER;
Adam Cohen7d30a372013-07-01 17:03:59 -07001278 }
1279
Adam Cohenc2d6e892014-10-16 09:49:24 -07001280 /**
1281 * Triggered by scrolling via touch
1282 */
1283 protected void onScrollInteractionBegin() {
1284 }
1285
1286 protected void onScrollInteractionEnd() {
1287 }
1288
Winson Chung185d7162011-02-28 13:47:29 -08001289 @Override
1290 public boolean onGenericMotionEvent(MotionEvent event) {
1291 if ((event.getSource() & InputDevice.SOURCE_CLASS_POINTER) != 0) {
1292 switch (event.getAction()) {
1293 case MotionEvent.ACTION_SCROLL: {
1294 // Handle mouse (or ext. device) by shifting the page depending on the scroll
1295 final float vscroll;
1296 final float hscroll;
1297 if ((event.getMetaState() & KeyEvent.META_SHIFT_ON) != 0) {
1298 vscroll = 0;
1299 hscroll = event.getAxisValue(MotionEvent.AXIS_VSCROLL);
1300 } else {
1301 vscroll = -event.getAxisValue(MotionEvent.AXIS_VSCROLL);
1302 hscroll = event.getAxisValue(MotionEvent.AXIS_HSCROLL);
1303 }
1304 if (hscroll != 0 || vscroll != 0) {
Sunny Goyal70660032015-05-14 00:07:08 -07001305 boolean isForwardScroll = mIsRtl ? (hscroll < 0 || vscroll < 0)
Adam Cohen0ffac432013-07-10 11:19:26 -07001306 : (hscroll > 0 || vscroll > 0);
1307 if (isForwardScroll) {
Winson Chung185d7162011-02-28 13:47:29 -08001308 scrollRight();
1309 } else {
1310 scrollLeft();
1311 }
1312 return true;
1313 }
1314 }
1315 }
1316 }
1317 return super.onGenericMotionEvent(event);
1318 }
1319
Michael Jurkab8f06722010-10-10 15:58:46 -07001320 private void acquireVelocityTrackerAndAddMovement(MotionEvent ev) {
1321 if (mVelocityTracker == null) {
1322 mVelocityTracker = VelocityTracker.obtain();
1323 }
1324 mVelocityTracker.addMovement(ev);
1325 }
1326
1327 private void releaseVelocityTracker() {
1328 if (mVelocityTracker != null) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001329 mVelocityTracker.clear();
Michael Jurkab8f06722010-10-10 15:58:46 -07001330 mVelocityTracker.recycle();
1331 mVelocityTracker = null;
1332 }
1333 }
1334
Winson Chung321e9ee2010-08-09 13:37:56 -07001335 private void onSecondaryPointerUp(MotionEvent ev) {
1336 final int pointerIndex = (ev.getAction() & MotionEvent.ACTION_POINTER_INDEX_MASK) >>
1337 MotionEvent.ACTION_POINTER_INDEX_SHIFT;
1338 final int pointerId = ev.getPointerId(pointerIndex);
1339 if (pointerId == mActivePointerId) {
1340 // This was our active pointer going up. Choose a new
1341 // active pointer and adjust accordingly.
1342 // TODO: Make this decision more intelligent.
1343 final int newPointerIndex = pointerIndex == 0 ? 1 : 0;
1344 mLastMotionX = mDownMotionX = ev.getX(newPointerIndex);
Winson Chungc0844aa2011-02-02 15:25:58 -08001345 mLastMotionXRemainder = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -07001346 mActivePointerId = ev.getPointerId(newPointerIndex);
1347 if (mVelocityTracker != null) {
1348 mVelocityTracker.clear();
1349 }
1350 }
Jeff Brown1d0867c2010-12-02 18:27:39 -08001351 }
1352
Winson Chung321e9ee2010-08-09 13:37:56 -07001353 @Override
1354 public void requestChildFocus(View child, View focused) {
1355 super.requestChildFocus(child, focused);
Adam Cohenae4f1552011-10-20 00:15:42 -07001356 int page = indexToPage(indexOfChild(child));
Winson Chung97d85d22011-04-13 11:27:36 -07001357 if (page >= 0 && page != getCurrentPage() && !isInTouchMode()) {
Winson Chung86f77532010-08-24 11:08:22 -07001358 snapToPage(page);
Winson Chung321e9ee2010-08-09 13:37:56 -07001359 }
1360 }
1361
Sunny Goyal228153d2018-01-04 15:35:22 -08001362 public int getPageNearestToCenterOfScreen() {
Tony Wickham8f7ead32016-04-07 18:46:44 -07001363 return getPageNearestToCenterOfScreen(getScrollX());
1364 }
1365
1366 private int getPageNearestToCenterOfScreen(int scaledScrollX) {
Sunny Goyal228153d2018-01-04 15:35:22 -08001367 int screenCenter = scaledScrollX + (getMeasuredWidth() / 2);
Adam Cohen22f823d2011-09-01 17:22:18 -07001368 int minDistanceFromScreenCenter = Integer.MAX_VALUE;
Winson Chung321e9ee2010-08-09 13:37:56 -07001369 int minDistanceFromScreenCenterIndex = -1;
Winson Chung321e9ee2010-08-09 13:37:56 -07001370 final int childCount = getChildCount();
1371 for (int i = 0; i < childCount; ++i) {
Sunny Goyal228153d2018-01-04 15:35:22 -08001372 View layout = getPageAt(i);
Adam Cohen96d30a12013-07-16 18:13:21 -07001373 int childWidth = layout.getMeasuredWidth();
Winson Chung321e9ee2010-08-09 13:37:56 -07001374 int halfChildWidth = (childWidth / 2);
Sunny Goyal228153d2018-01-04 15:35:22 -08001375 int childCenter = getChildOffset(i) + halfChildWidth;
Winson Chung321e9ee2010-08-09 13:37:56 -07001376 int distanceFromScreenCenter = Math.abs(childCenter - screenCenter);
1377 if (distanceFromScreenCenter < minDistanceFromScreenCenter) {
1378 minDistanceFromScreenCenter = distanceFromScreenCenter;
1379 minDistanceFromScreenCenterIndex = i;
1380 }
1381 }
Adam Cohend19d3ca2010-09-15 14:43:42 -07001382 return minDistanceFromScreenCenterIndex;
1383 }
1384
1385 protected void snapToDestination() {
Adam Cohen8d769d62017-06-23 17:27:38 -07001386 snapToPage(getPageNearestToCenterOfScreen(), getPageSnapDuration());
1387 }
1388
1389 protected boolean isInOverScroll() {
Tony Wickham66d1c2f2019-04-24 11:32:59 -07001390 return (getScrollX() > mMaxScrollX || getScrollX() < mMinScrollX);
Adam Cohen8d769d62017-06-23 17:27:38 -07001391 }
1392
1393 protected int getPageSnapDuration() {
1394 if (isInOverScroll()) {
1395 return OVERSCROLL_PAGE_SNAP_ANIMATION_DURATION;
1396 }
1397 return PAGE_SNAP_ANIMATION_DURATION;
Winson Chung321e9ee2010-08-09 13:37:56 -07001398 }
1399
Adam Cohene0f66b52010-11-23 15:06:07 -08001400 // We want the duration of the page snap animation to be influenced by the distance that
1401 // the screen has to travel, however, we don't want this duration to be effected in a
1402 // purely linear fashion. Instead, we use this method to moderate the effect that the distance
1403 // of travel has on the overall snap duration.
Sunny Goyal4d113a52015-05-27 10:05:28 -07001404 private float distanceInfluenceForSnapDuration(float f) {
Adam Cohene0f66b52010-11-23 15:06:07 -08001405 f -= 0.5f; // center the values about 0.
1406 f *= 0.3f * Math.PI / 2.0f;
1407 return (float) Math.sin(f);
1408 }
1409
Winson Chung05a31ed2018-02-08 17:08:43 -08001410 protected boolean snapToPageWithVelocity(int whichPage, int velocity) {
Adam Cohen6f127a62014-06-12 14:54:41 -07001411 whichPage = validateNewPage(whichPage);
Sunny Goyal228153d2018-01-04 15:35:22 -08001412 int halfScreenSize = getMeasuredWidth() / 2;
Adam Cohene0f66b52010-11-23 15:06:07 -08001413
Adam Cohenedb40762013-07-18 16:45:45 -07001414 final int newX = getScrollForPage(whichPage);
Sunny Goyalc86df472016-02-25 09:19:38 -08001415 int delta = newX - getUnboundedScrollX();
Adam Cohene0f66b52010-11-23 15:06:07 -08001416 int duration = 0;
1417
Sunny Goyal4d113a52015-05-27 10:05:28 -07001418 if (Math.abs(velocity) < mMinFlingVelocity) {
Adam Cohene0f66b52010-11-23 15:06:07 -08001419 // If the velocity is low enough, then treat this more as an automatic page advance
1420 // as opposed to an apparent physical response to flinging
Winson Chung05a31ed2018-02-08 17:08:43 -08001421 return snapToPage(whichPage, PAGE_SNAP_ANIMATION_DURATION);
Adam Cohene0f66b52010-11-23 15:06:07 -08001422 }
1423
1424 // Here we compute a "distance" that will be used in the computation of the overall
1425 // snap duration. This is a function of the actual distance that needs to be traveled;
1426 // we keep this value close to half screen size in order to reduce the variance in snap
1427 // duration as a function of the distance the page needs to travel.
Michael Jurka20b7ca92011-06-07 20:09:16 -07001428 float distanceRatio = Math.min(1f, 1.0f * Math.abs(delta) / (2 * halfScreenSize));
Adam Cohene0f66b52010-11-23 15:06:07 -08001429 float distance = halfScreenSize + halfScreenSize *
1430 distanceInfluenceForSnapDuration(distanceRatio);
1431
1432 velocity = Math.abs(velocity);
Adam Cohen265b9a62011-12-07 14:37:18 -08001433 velocity = Math.max(mMinSnapVelocity, velocity);
Adam Cohene0f66b52010-11-23 15:06:07 -08001434
1435 // we want the page's snap velocity to approximately match the velocity at which the
1436 // user flings, so we scale the duration by a value near to the derivative of the scroll
Michael Jurka20b7ca92011-06-07 20:09:16 -07001437 // interpolator at zero, ie. 5. We use 4 to make it a little slower.
1438 duration = 4 * Math.round(1000 * Math.abs(distance / velocity));
Adam Cohene0f66b52010-11-23 15:06:07 -08001439
Jon Miranda71cb80c2019-01-24 21:25:13 -08001440 if (QUICKSTEP_SPRINGS.get()) {
1441 return snapToPage(whichPage, delta, duration, false, null,
1442 velocity * Math.signum(newX - getUnboundedScrollX()), true);
1443 } else {
1444 return snapToPage(whichPage, delta, duration);
1445 }
Michael Jurka0142d492010-08-25 17:46:15 -07001446 }
1447
Winson Chung05a31ed2018-02-08 17:08:43 -08001448 public boolean snapToPage(int whichPage) {
1449 return snapToPage(whichPage, PAGE_SNAP_ANIMATION_DURATION);
Winson Chung321e9ee2010-08-09 13:37:56 -07001450 }
1451
Winson Chung05a31ed2018-02-08 17:08:43 -08001452 public boolean snapToPageImmediately(int whichPage) {
1453 return snapToPage(whichPage, PAGE_SNAP_ANIMATION_DURATION, true, null);
Adam Cohen7d30a372013-07-01 17:03:59 -07001454 }
1455
Winson Chung05a31ed2018-02-08 17:08:43 -08001456 public boolean snapToPage(int whichPage, int duration) {
1457 return snapToPage(whichPage, duration, false, null);
Adam Cohen7d30a372013-07-01 17:03:59 -07001458 }
1459
Tony Wickhamd58c2d52018-05-04 12:10:55 -07001460 public boolean snapToPage(int whichPage, int duration, TimeInterpolator interpolator) {
Winson Chung05a31ed2018-02-08 17:08:43 -08001461 return snapToPage(whichPage, duration, false, interpolator);
Adam Cohenf9618852013-11-08 06:45:03 -08001462 }
1463
Winson Chung05a31ed2018-02-08 17:08:43 -08001464 protected boolean snapToPage(int whichPage, int duration, boolean immediate,
Adam Cohenf9618852013-11-08 06:45:03 -08001465 TimeInterpolator interpolator) {
Adam Cohen6f127a62014-06-12 14:54:41 -07001466 whichPage = validateNewPage(whichPage);
Winson Chung321e9ee2010-08-09 13:37:56 -07001467
Adam Cohenedb40762013-07-18 16:45:45 -07001468 int newX = getScrollForPage(whichPage);
Sunny Goyalc86df472016-02-25 09:19:38 -08001469 final int delta = newX - getUnboundedScrollX();
Jon Miranda71cb80c2019-01-24 21:25:13 -08001470 return snapToPage(whichPage, delta, duration, immediate, interpolator, 0, false);
Michael Jurka0142d492010-08-25 17:46:15 -07001471 }
1472
Winson Chung05a31ed2018-02-08 17:08:43 -08001473 protected boolean snapToPage(int whichPage, int delta, int duration) {
Jon Miranda71cb80c2019-01-24 21:25:13 -08001474 return snapToPage(whichPage, delta, duration, false, null, 0, false);
Adam Cohen7d30a372013-07-01 17:03:59 -07001475 }
Michael Jurka0142d492010-08-25 17:46:15 -07001476
Winson Chung05a31ed2018-02-08 17:08:43 -08001477 protected boolean snapToPage(int whichPage, int delta, int duration, boolean immediate,
Jon Miranda71cb80c2019-01-24 21:25:13 -08001478 TimeInterpolator interpolator, float velocity, boolean spring) {
Sunny Goyal9bb8ffb2018-05-24 17:11:16 -07001479 if (mFirstLayout) {
1480 setCurrentPage(whichPage);
1481 return false;
1482 }
Tony Wickhamd58c2d52018-05-04 12:10:55 -07001483
1484 if (FeatureFlags.IS_DOGFOOD_BUILD) {
Tony Wickhamcb3f8702018-08-27 17:36:03 -07001485 duration *= Settings.Global.getFloat(getContext().getContentResolver(),
1486 Settings.Global.WINDOW_ANIMATION_SCALE, 1);
Tony Wickhamd58c2d52018-05-04 12:10:55 -07001487 }
1488
Adam Cohen6f127a62014-06-12 14:54:41 -07001489 whichPage = validateNewPage(whichPage);
1490
Adam Cohen7d30a372013-07-01 17:03:59 -07001491 mNextPage = whichPage;
Michael Jurka0142d492010-08-25 17:46:15 -07001492
Winson Chung321e9ee2010-08-09 13:37:56 -07001493 awakenScrollBars(duration);
Adam Cohen7d30a372013-07-01 17:03:59 -07001494 if (immediate) {
1495 duration = 0;
1496 } else if (duration == 0) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001497 duration = Math.abs(delta);
1498 }
1499
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001500 if (duration != 0) {
1501 pageBeginTransition();
1502 }
1503
Adam Cohenf358a4b2013-07-23 16:47:31 -07001504 if (!mScroller.isFinished()) {
Adam Cohenf9618852013-11-08 06:45:03 -08001505 abortScrollerAnimation(false);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001506 }
Adam Cohenf9618852013-11-08 06:45:03 -08001507
1508 if (interpolator != null) {
1509 mScroller.setInterpolator(interpolator);
1510 } else {
1511 mScroller.setInterpolator(mDefaultInterpolator);
1512 }
1513
Jon Miranda71cb80c2019-01-24 21:25:13 -08001514 if (spring && QUICKSTEP_SPRINGS.get()) {
1515 mScroller.startScrollSpring(getUnboundedScrollX(), delta, duration, velocity);
1516 } else {
1517 mScroller.startScroll(getUnboundedScrollX(), delta, duration);
1518 }
Winson Chung80baf5a2010-08-09 16:03:15 -07001519
Adam Cohen674531f2013-12-13 15:07:14 -08001520 updatePageIndicator();
Adam Cohen7d30a372013-07-01 17:03:59 -07001521
1522 // Trigger a compute() to finish switching pages if necessary
1523 if (immediate) {
1524 computeScroll();
Sunny Goyal76dbf6f2017-01-03 14:55:47 -08001525 pageEndTransition();
Adam Cohen7d30a372013-07-01 17:03:59 -07001526 }
1527
Winson Chung321e9ee2010-08-09 13:37:56 -07001528 invalidate();
Winson Chung05a31ed2018-02-08 17:08:43 -08001529 return Math.abs(delta) > 0;
Winson Chung321e9ee2010-08-09 13:37:56 -07001530 }
1531
Vadim Tryshev98913d02018-05-18 18:41:34 -07001532 public boolean scrollLeft() {
1533 if (getNextPage() > 0) {
1534 snapToPage(getNextPage() - 1);
1535 return true;
1536 }
1537 return false;
Winson Chung321e9ee2010-08-09 13:37:56 -07001538 }
1539
Vadim Tryshev98913d02018-05-18 18:41:34 -07001540 public boolean scrollRight() {
1541 if (getNextPage() < getChildCount() - 1) {
1542 snapToPage(getNextPage() + 1);
1543 return true;
1544 }
1545 return false;
Winson Chung321e9ee2010-08-09 13:37:56 -07001546 }
1547
Vadim Trysheve6bbefb2018-04-03 13:38:06 -07001548 @Override
1549 public CharSequence getAccessibilityClassName() {
1550 // Some accessibility services have special logic for ScrollView. Since we provide same
1551 // accessibility info as ScrollView, inform the service to handle use the same way.
1552 return ScrollView.class.getName();
1553 }
1554
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001555 protected boolean isPageOrderFlipped() {
1556 return false;
1557 }
1558
Winson Chung6a0f57d2011-06-29 20:10:49 -07001559 /* Accessibility */
Sunny Goyalcf25b522015-07-09 00:01:18 -07001560 @SuppressWarnings("deprecation")
Winson Chung6a0f57d2011-06-29 20:10:49 -07001561 @Override
1562 public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) {
1563 super.onInitializeAccessibilityNodeInfo(info);
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001564 final boolean pagesFlipped = isPageOrderFlipped();
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001565 info.setScrollable(getPageCount() > 1);
1566 if (getCurrentPage() < getPageCount() - 1) {
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001567 info.addAction(pagesFlipped ? AccessibilityNodeInfo.ACTION_SCROLL_BACKWARD
1568 : AccessibilityNodeInfo.ACTION_SCROLL_FORWARD);
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001569 }
1570 if (getCurrentPage() > 0) {
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001571 info.addAction(pagesFlipped ? AccessibilityNodeInfo.ACTION_SCROLL_FORWARD
1572 : AccessibilityNodeInfo.ACTION_SCROLL_BACKWARD);
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001573 }
Vadim Tryshev7af0d442015-05-15 08:48:11 -07001574
1575 // Accessibility-wise, PagedView doesn't support long click, so disabling it.
1576 // Besides disabling the accessibility long-click, this also prevents this view from getting
1577 // accessibility focus.
1578 info.setLongClickable(false);
Sunny Goyala52ecb02016-12-16 15:04:51 -08001579 info.removeAction(AccessibilityNodeInfo.AccessibilityAction.ACTION_LONG_CLICK);
Winson Chung6a0f57d2011-06-29 20:10:49 -07001580 }
1581
1582 @Override
Alan Viverette254139a2013-10-08 13:13:46 -07001583 public void sendAccessibilityEvent(int eventType) {
1584 // Don't let the view send real scroll events.
1585 if (eventType != AccessibilityEvent.TYPE_VIEW_SCROLLED) {
1586 super.sendAccessibilityEvent(eventType);
1587 }
1588 }
1589
1590 @Override
Winson Chung6a0f57d2011-06-29 20:10:49 -07001591 public void onInitializeAccessibilityEvent(AccessibilityEvent event) {
1592 super.onInitializeAccessibilityEvent(event);
Vadim Tryshev7066c122015-05-21 14:06:35 -07001593 event.setScrollable(getPageCount() > 1);
Winson Chung6a0f57d2011-06-29 20:10:49 -07001594 }
1595
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001596 @Override
1597 public boolean performAccessibilityAction(int action, Bundle arguments) {
1598 if (super.performAccessibilityAction(action, arguments)) {
1599 return true;
1600 }
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001601 final boolean pagesFlipped = isPageOrderFlipped();
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001602 switch (action) {
1603 case AccessibilityNodeInfo.ACTION_SCROLL_FORWARD: {
Vadim Tryshev98913d02018-05-18 18:41:34 -07001604 if (pagesFlipped ? scrollLeft() : scrollRight()) {
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001605 return true;
1606 }
1607 } break;
1608 case AccessibilityNodeInfo.ACTION_SCROLL_BACKWARD: {
Vadim Tryshev98913d02018-05-18 18:41:34 -07001609 if (pagesFlipped ? scrollRight() : scrollLeft()) {
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001610 return true;
1611 }
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001612 }
1613 break;
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001614 }
1615 return false;
1616 }
1617
Vadim Tryshev2c430b32018-04-04 14:45:21 -07001618 protected boolean canAnnouncePageDescription() {
1619 return true;
1620 }
1621
Adam Cohen0ffac432013-07-10 11:19:26 -07001622 protected String getCurrentPageDescription() {
Sunny Goyalf4f89ef2015-09-02 15:06:12 -07001623 return getContext().getString(R.string.default_scroll_format,
Adam Cohen0ffac432013-07-10 11:19:26 -07001624 getNextPage() + 1, getChildCount());
1625 }
1626
Tony Mak2e564402018-02-27 17:19:34 +00001627 protected float getDownMotionX() {
1628 return mDownMotionX;
1629 }
1630
1631 protected float getDownMotionY() {
1632 return mDownMotionY;
1633 }
1634
Sunny Goyal20a13ff2018-03-13 16:44:00 -07001635 protected interface ComputePageScrollsLogic {
1636
1637 boolean shouldIncludeView(View view);
1638 }
Vadim Tryshev528b9e02018-05-24 18:22:03 -07001639
1640 public int[] getVisibleChildrenRange() {
1641 float visibleLeft = 0;
1642 float visibleRight = visibleLeft + getMeasuredWidth();
1643 float scaleX = getScaleX();
1644 if (scaleX < 1 && scaleX > 0) {
1645 float mid = getMeasuredWidth() / 2;
1646 visibleLeft = mid - ((mid - visibleLeft) / scaleX);
1647 visibleRight = mid + ((visibleRight - mid) / scaleX);
1648 }
1649
1650 int leftChild = -1;
1651 int rightChild = -1;
1652 final int childCount = getChildCount();
1653 for (int i = 0; i < childCount; i++) {
1654 final View child = getPageAt(i);
1655
1656 float left = child.getLeft() + child.getTranslationX() - getScrollX();
1657 if (left <= visibleRight && (left + child.getMeasuredWidth()) >= visibleLeft) {
1658 if (leftChild == -1) {
1659 leftChild = i;
1660 }
1661 rightChild = i;
1662 }
1663 }
1664 mTmpIntPair[0] = leftChild;
1665 mTmpIntPair[1] = rightChild;
1666 return mTmpIntPair;
1667 }
Adam Cohen5084cba2013-09-03 12:01:16 -07001668}