blob: b42387125978d4dcd0c6e491a527c29acc12b2a1 [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 Goyalc39db732021-04-03 01:20:21 -070019import static com.android.launcher3.anim.Interpolators.SCROLL;
Sunny Goyal8b37c572020-03-31 12:12:14 -070020import static com.android.launcher3.compat.AccessibilityManagerCompat.isAccessibilityEnabled;
21import static com.android.launcher3.compat.AccessibilityManagerCompat.isObservedEventType;
Sunny Goyal8b37c572020-03-31 12:12:14 -070022import static com.android.launcher3.touch.OverScroll.OVERSCROLL_DAMP_FACTOR;
Sunny Goyal8b37c572020-03-31 12:12:14 -070023import static com.android.launcher3.touch.PagedOrientationHandler.VIEW_SCROLL_BY;
24import static com.android.launcher3.touch.PagedOrientationHandler.VIEW_SCROLL_TO;
25
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -070026import android.animation.LayoutTransition;
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;
Sunny Goyalc39db732021-04-03 01:20:21 -070047import android.widget.OverScroller;
Vadim Trysheve6bbefb2018-04-03 13:38:06 -070048import android.widget.ScrollView;
Tony Wickhamf549dab2016-05-16 09:54:06 -070049
Tony Wickham62117d72020-03-26 16:56:26 -070050import androidx.annotation.Nullable;
51
Jon Miranda9e198662020-03-11 14:42:02 -070052import com.android.launcher3.compat.AccessibilityManagerCompat;
53import com.android.launcher3.config.FeatureFlags;
Jon Miranda9e198662020-03-11 14:42:02 -070054import com.android.launcher3.pageindicators.PageIndicator;
Jon Miranda9e198662020-03-11 14:42:02 -070055import com.android.launcher3.touch.PagedOrientationHandler;
56import com.android.launcher3.touch.PagedOrientationHandler.ChildBounds;
Sunny Goyalc39db732021-04-03 01:20:21 -070057import com.android.launcher3.util.EdgeEffectCompat;
Jon Miranda9e198662020-03-11 14:42:02 -070058import com.android.launcher3.util.Thunk;
Sunny Goyal8b37c572020-03-31 12:12:14 -070059import com.android.launcher3.views.ActivityContext;
Jon Miranda9e198662020-03-11 14:42:02 -070060
61import java.util.ArrayList;
Sunny Goyal59969372021-05-06 12:11:44 -070062import java.util.function.Consumer;
Jon Miranda9e198662020-03-11 14:42:02 -070063
Winson Chung321e9ee2010-08-09 13:37:56 -070064/**
65 * An abstraction of the original Workspace which supports browsing through a
Michael Jurka0142d492010-08-25 17:46:15 -070066 * sequential list of "pages"
Winson Chung321e9ee2010-08-09 13:37:56 -070067 */
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -080068public abstract class PagedView<T extends View & PageIndicator> extends ViewGroup {
Winson Chung321e9ee2010-08-09 13:37:56 -070069 private static final String TAG = "PagedView";
Winson Chung785d2eb2011-04-14 16:08:02 -070070 private static final boolean DEBUG = false;
Winson Chung4941f652020-06-18 15:11:53 -070071 public static final boolean DEBUG_FAILED_QUICKSWITCH = false;
Sunny Goyal20a13ff2018-03-13 16:44:00 -070072
Winson Chung4941f652020-06-18 15:11:53 -070073 public static final int ACTION_MOVE_ALLOW_EASY_FLING = MotionEvent.ACTION_MASK - 1;
Sunny Goyala7a5bf32020-01-05 15:35:29 +053074 public static final int INVALID_PAGE = -1;
Sunny Goyal20a13ff2018-03-13 16:44:00 -070075 protected static final ComputePageScrollsLogic SIMPLE_SCROLL_LOGIC = (v) -> v.getVisibility() != GONE;
Winson Chung321e9ee2010-08-09 13:37:56 -070076
Vadim Tryshevfedca432015-08-19 17:55:02 -070077 public static final int PAGE_SNAP_ANIMATION_DURATION = 750;
Winson Chung321e9ee2010-08-09 13:37:56 -070078
Adam Cohenb64cb5a2011-02-15 13:53:42 -080079 private static final float RETURN_TO_ORIGINAL_PAGE_THRESHOLD = 0.33f;
Adam Cohen00481b32011-11-18 12:03:48 -080080 // The page is moved more than halfway, automatically move to the next page on touch up.
81 private static final float SIGNIFICANT_MOVE_THRESHOLD = 0.4f;
Adam Cohen68d73932010-11-15 10:50:58 -080082
Sunny Goyal8e2133b2015-05-06 13:39:07 -070083 private static final float MAX_SCROLL_PROGRESS = 1.0f;
84
Adam Cohen265b9a62011-12-07 14:37:18 -080085 // The following constants need to be scaled based on density. The scaled versions will be
86 // assigned to the corresponding member variables below.
87 private static final int FLING_THRESHOLD_VELOCITY = 500;
Winson Chung4941f652020-06-18 15:11:53 -070088 private static final int EASY_FLING_THRESHOLD_VELOCITY = 400;
Adam Cohen265b9a62011-12-07 14:37:18 -080089 private static final int MIN_SNAP_VELOCITY = 1500;
90 private static final int MIN_FLING_VELOCITY = 250;
91
Adam Cohenf358a4b2013-07-23 16:47:31 -070092 private boolean mFreeScroll = false;
Adam Cohenf358a4b2013-07-23 16:47:31 -070093
Winson Chung4941f652020-06-18 15:11:53 -070094 protected final int mFlingThresholdVelocity;
95 protected final int mEasyFlingThresholdVelocity;
96 protected final int mMinFlingVelocity;
97 protected final int mMinSnapVelocity;
Michael Jurka0142d492010-08-25 17:46:15 -070098
Michael Jurka0142d492010-08-25 17:46:15 -070099 protected boolean mFirstLayout = true;
100
Sunny Goyal4ffec482016-02-09 11:28:52 -0800101 @ViewDebug.ExportedProperty(category = "launcher")
Michael Jurka0142d492010-08-25 17:46:15 -0700102 protected int mCurrentPage;
Adam Cohene61a9a22013-06-11 15:45:31 -0700103
Sunny Goyal4ffec482016-02-09 11:28:52 -0800104 @ViewDebug.ExportedProperty(category = "launcher")
Michael Jurka0142d492010-08-25 17:46:15 -0700105 protected int mNextPage = INVALID_PAGE;
Vinit Nayaka406f722019-12-19 11:50:55 -0800106 protected int mMaxScroll;
107 protected int mMinScroll;
Sunny Goyalb7b01352018-08-09 12:31:20 -0700108 protected OverScroller mScroller;
Winson Chung321e9ee2010-08-09 13:37:56 -0700109 private VelocityTracker mVelocityTracker;
Sunny Goyale15e2a82017-12-15 13:05:42 -0800110 protected int mPageSpacing = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -0700111
112 private float mDownMotionX;
Adam Cohen7d30a372013-07-01 17:03:59 -0700113 private float mDownMotionY;
Vinit Nayaka406f722019-12-19 11:50:55 -0800114 private float mDownMotionPrimary;
115 private float mLastMotion;
116 private float mLastMotionRemainder;
117 private float mTotalMotion;
Winson Chung4941f652020-06-18 15:11:53 -0700118 // Used in special cases where the fling checks can be relaxed for an intentional gesture
119 private boolean mAllowEasyFling;
Sunny Goyalacd17df2020-04-03 15:58:45 -0700120 protected PagedOrientationHandler mOrientationHandler = PagedOrientationHandler.PORTRAIT;
Adam Cohenedb40762013-07-18 16:45:45 -0700121
Vadim Trysheve628c472018-05-16 14:28:18 -0700122 protected int[] mPageScrolls;
Sunny Goyalaad33592018-08-07 17:20:35 -0700123 private boolean mIsBeingDragged;
Adam Cohencae7f572013-11-04 14:42:52 -0800124
Winson Chung4941f652020-06-18 15:11:53 -0700125 // The amount of movement to begin scrolling
Michael Jurka7426c422010-11-11 15:23:47 -0800126 protected int mTouchSlop;
Winson Chung4941f652020-06-18 15:11:53 -0700127 // The amount of movement to begin paging
128 protected int mPageSlop;
Winson Chung321e9ee2010-08-09 13:37:56 -0700129 private int mMaximumVelocity;
Adam Cohen68d73932010-11-15 10:50:58 -0800130 protected boolean mAllowOverScroll = true;
Winson Chung321e9ee2010-08-09 13:37:56 -0700131
Michael Jurka5f1c5092010-09-03 14:15:02 -0700132 protected static final int INVALID_POINTER = -1;
Winson Chung321e9ee2010-08-09 13:37:56 -0700133
Michael Jurka5f1c5092010-09-03 14:15:02 -0700134 protected int mActivePointerId = INVALID_POINTER;
Winson Chung321e9ee2010-08-09 13:37:56 -0700135
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700136 protected boolean mIsPageInTransition = false;
Tony Wickham62117d72020-03-26 16:56:26 -0700137 private Runnable mOnPageTransitionEndCallback;
Patrick Dubroy1262e362010-10-06 15:49:50 -0700138
Winson Chungd2be3812013-07-16 11:11:32 -0700139 // Page Indicator
Adam Cohen091440a2015-03-18 14:16:05 -0700140 @Thunk int mPageIndicatorViewId;
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800141 protected T mPageIndicator;
Adam Cohen7d30a372013-07-01 17:03:59 -0700142
John Spurlock77e1f472013-09-11 10:09:51 -0400143 protected final Rect mInsets = new Rect();
Tony Wickhamdfb5cc92018-02-26 16:41:57 -0800144 protected boolean mIsRtl;
John Spurlock77e1f472013-09-11 10:09:51 -0400145
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800146 // Similar to the platform implementation of isLayoutValid();
147 protected boolean mIsLayoutValid;
148
Vadim Tryshev528b9e02018-05-24 18:22:03 -0700149 private int[] mTmpIntPair = new int[2];
150
Sunny Goyalc39db732021-04-03 01:20:21 -0700151 protected EdgeEffectCompat mEdgeGlowLeft;
152 protected EdgeEffectCompat mEdgeGlowRight;
153
Winson Chung321e9ee2010-08-09 13:37:56 -0700154 public PagedView(Context context) {
155 this(context, null);
156 }
157
158 public PagedView(Context context, AttributeSet attrs) {
159 this(context, attrs, 0);
160 }
161
162 public PagedView(Context context, AttributeSet attrs, int defStyle) {
163 super(context, attrs, defStyle);
Winson Chungc9ca2982013-07-19 12:07:38 -0700164
Adam Cohen9c4949e2010-10-05 12:27:22 -0700165 TypedArray a = context.obtainStyledAttributes(attrs,
166 R.styleable.PagedView, defStyle, 0);
Winson Chungd2be3812013-07-16 11:11:32 -0700167 mPageIndicatorViewId = a.getResourceId(R.styleable.PagedView_pageIndicator, -1);
Adam Cohen9c4949e2010-10-05 12:27:22 -0700168 a.recycle();
169
Winson Chung321e9ee2010-08-09 13:37:56 -0700170 setHapticFeedbackEnabled(false);
Sunny Goyal70660032015-05-14 00:07:08 -0700171 mIsRtl = Utilities.isRtl(getResources());
Winson Chung321e9ee2010-08-09 13:37:56 -0700172
Sunny Goyalc39db732021-04-03 01:20:21 -0700173 mScroller = new OverScroller(context, SCROLL);
Winson Chung86f77532010-08-24 11:08:22 -0700174 mCurrentPage = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -0700175
Vinit Nayaka406f722019-12-19 11:50:55 -0800176 final ViewConfiguration configuration = ViewConfiguration.get(context);
Winson Chung4941f652020-06-18 15:11:53 -0700177 mTouchSlop = configuration.getScaledTouchSlop();
178 mPageSlop = configuration.getScaledPagingTouchSlop();
Winson Chung321e9ee2010-08-09 13:37:56 -0700179 mMaximumVelocity = configuration.getScaledMaximumFlingVelocity();
Adam Cohen265b9a62011-12-07 14:37:18 -0800180
Sunny Goyalcf25b522015-07-09 00:01:18 -0700181 float density = getResources().getDisplayMetrics().density;
182 mFlingThresholdVelocity = (int) (FLING_THRESHOLD_VELOCITY * density);
Winson Chung4941f652020-06-18 15:11:53 -0700183 mEasyFlingThresholdVelocity = (int) (EASY_FLING_THRESHOLD_VELOCITY * density);
Sunny Goyalcf25b522015-07-09 00:01:18 -0700184 mMinFlingVelocity = (int) (MIN_FLING_VELOCITY * density);
185 mMinSnapVelocity = (int) (MIN_SNAP_VELOCITY * density);
Sunny Goyala9f55462018-03-25 18:15:15 -0700186
Sunny Goyalc39db732021-04-03 01:20:21 -0700187 initEdgeEffect();
Sunny Goyaleaf7a952020-07-29 16:54:20 -0700188 setDefaultFocusHighlightEnabled(false);
Sunny Goyalc39db732021-04-03 01:20:21 -0700189 setWillNotDraw(false);
Winson Chung321e9ee2010-08-09 13:37:56 -0700190 }
191
Sunny Goyalc39db732021-04-03 01:20:21 -0700192 protected void initEdgeEffect() {
193 mEdgeGlowLeft = new EdgeEffectCompat(getContext());
194 mEdgeGlowRight = new EdgeEffectCompat(getContext());
Adam Cohenf9618852013-11-08 06:45:03 -0800195 }
196
Sunny Goyald0a6ae72016-06-16 12:29:03 -0700197 public void initParentViews(View parent) {
198 if (mPageIndicatorViewId > -1) {
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800199 mPageIndicator = parent.findViewById(mPageIndicatorViewId);
Sunny Goyalc64cfdd2016-05-18 14:12:02 -0700200 mPageIndicator.setMarkersCount(getChildCount());
Winson Chungd2be3812013-07-16 11:11:32 -0700201 }
202 }
203
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800204 public T getPageIndicator() {
Adam Cohenedb40762013-07-18 16:45:45 -0700205 return mPageIndicator;
206 }
207
Adam Cohen674531f2013-12-13 15:07:14 -0800208 /**
Tony Wickham29d853c2015-09-08 10:35:56 -0700209 * Returns the index of the currently displayed page. When in free scroll mode, this is the page
210 * that the user was on before entering free scroll mode (e.g. the home screen page they
Alex Chaub794ea62021-02-03 18:00:30 +0000211 * long-pressed on to enter the overview). Try using {@link #getDestinationPage()}
Tony Wickham29d853c2015-09-08 10:35:56 -0700212 * to get the page the user is currently scrolling over.
Winson Chung321e9ee2010-08-09 13:37:56 -0700213 */
Sunny Goyal83a8f042015-05-19 12:52:12 -0700214 public int getCurrentPage() {
Winson Chung86f77532010-08-24 11:08:22 -0700215 return mCurrentPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700216 }
Adam Cohen7d30a372013-07-01 17:03:59 -0700217
Hyunyoung Songb76cd622015-04-16 14:34:09 -0700218 /**
219 * Returns the index of page to be shown immediately afterwards.
220 */
Vadim Tryshevfedca432015-08-19 17:55:02 -0700221 public int getNextPage() {
Winson Chung360e63f2012-04-27 13:48:05 -0700222 return (mNextPage != INVALID_PAGE) ? mNextPage : mCurrentPage;
223 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700224
Adam Cohenf9c184a2016-01-15 16:47:43 -0800225 public int getPageCount() {
Winson Chung321e9ee2010-08-09 13:37:56 -0700226 return getChildCount();
227 }
228
Sunny Goyal83a8f042015-05-19 12:52:12 -0700229 public View getPageAt(int index) {
Winson Chung321e9ee2010-08-09 13:37:56 -0700230 return getChildAt(index);
231 }
232
Adam Cohenae4f1552011-10-20 00:15:42 -0700233 protected int indexToPage(int index) {
234 return index;
235 }
236
Winson Chung321e9ee2010-08-09 13:37:56 -0700237 /**
Winson Chungbbc60d82010-11-11 16:34:41 -0800238 * Updates the scroll of the current page immediately to its final scroll position. We use this
239 * in CustomizePagedView to allow tabs to share the same PagedView while resetting the scroll of
240 * the previous tab page.
241 */
242 protected void updateCurrentPageScroll() {
Adam Cohen0ffac432013-07-10 11:19:26 -0700243 // If the current page is invalid, just reset the scroll position to zero
Vinit Nayaka406f722019-12-19 11:50:55 -0800244 int newPosition = 0;
Adam Cohen0ffac432013-07-10 11:19:26 -0700245 if (0 <= mCurrentPage && mCurrentPage < getPageCount()) {
Vinit Nayaka406f722019-12-19 11:50:55 -0800246 newPosition = getScrollForPage(mCurrentPage);
Adam Cohen0ffac432013-07-10 11:19:26 -0700247 }
Vinit Nayaka406f722019-12-19 11:50:55 -0800248 mOrientationHandler.set(this, VIEW_SCROLL_TO, newPosition);
Sunny Goyalc39db732021-04-03 01:20:21 -0700249 mScroller.startScroll(mScroller.getCurrX(), 0, newPosition - mScroller.getCurrX(), 0);
Sunny Goyalc82c6392018-06-06 15:39:13 -0700250 forceFinishScroller(true);
Winson Chungbbc60d82010-11-11 16:34:41 -0800251 }
252
Tony Wickhamf8d731a2021-05-26 14:58:13 -0700253 /**
254 * Immediately finishes any overscroll effect and jumps to the end of the scroller animation.
255 */
256 public void abortScrollerAnimation() {
257 mEdgeGlowLeft.finish();
258 mEdgeGlowRight.finish();
259 abortScrollerAnimation(true);
260 }
261
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700262 private void abortScrollerAnimation(boolean resetNextPage) {
Adam Cohen4fe4c932013-10-28 16:02:34 -0700263 mScroller.abortAnimation();
264 // We need to clean up the next page here to avoid computeScrollHelper from
265 // updating current page on the pass.
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700266 if (resetNextPage) {
267 mNextPage = INVALID_PAGE;
Sunny Goyal857b1b92018-03-05 10:49:05 -0800268 pageEndTransition();
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700269 }
Chet Haasebc2f0822012-10-26 17:59:53 -0700270 }
Adam Cohen4fe4c932013-10-28 16:02:34 -0700271
Tony Wickham8f7ead32016-04-07 18:46:44 -0700272 private void forceFinishScroller(boolean resetNextPage) {
Adam Cohen4fe4c932013-10-28 16:02:34 -0700273 mScroller.forceFinished(true);
274 // We need to clean up the next page here to avoid computeScrollHelper from
275 // updating current page on the pass.
Tony Wickham8f7ead32016-04-07 18:46:44 -0700276 if (resetNextPage) {
277 mNextPage = INVALID_PAGE;
Sunny Goyal857b1b92018-03-05 10:49:05 -0800278 pageEndTransition();
Tony Wickham8f7ead32016-04-07 18:46:44 -0700279 }
Adam Cohen4fe4c932013-10-28 16:02:34 -0700280 }
281
Adam Cohen6f127a62014-06-12 14:54:41 -0700282 private int validateNewPage(int newPage) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700283 newPage = ensureWithinScrollBounds(newPage);
Adam Cohen6f127a62014-06-12 14:54:41 -0700284 // Ensure that it is clamped by the actual set of children in all cases
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100285 newPage = Utilities.boundToRange(newPage, 0, getPageCount() - 1);
286
287 if (getPanelCount() > 1) {
288 // Always return left panel as new page
289 newPage = getLeftmostVisiblePageForIndex(newPage);
290 }
291 return newPage;
292 }
293
294 private int getLeftmostVisiblePageForIndex(int pageIndex) {
295 int panelCount = getPanelCount();
296 return (pageIndex / panelCount) * panelCount;
297 }
298
299 /**
300 * Returns the number of pages that are shown at the same time.
301 */
302 protected int getPanelCount() {
303 return 1;
304 }
305
306 /**
Sunny Goyal59969372021-05-06 12:11:44 -0700307 * Executes the callback against each visible page
Andras Kloczl2bb51342021-03-20 01:13:45 +0100308 */
Sunny Goyal59969372021-05-06 12:11:44 -0700309 public void forEachVisiblePage(Consumer<View> callback) {
Andras Kloczl2bb51342021-03-20 01:13:45 +0100310 int panelCount = getPanelCount();
Andras Kloczl2bb51342021-03-20 01:13:45 +0100311 for (int i = mCurrentPage; i < mCurrentPage + panelCount; i++) {
312 View page = getPageAt(i);
313 if (page != null) {
Sunny Goyal59969372021-05-06 12:11:44 -0700314 callback.accept(page);
Andras Kloczl2bb51342021-03-20 01:13:45 +0100315 }
316 }
Andras Kloczl2bb51342021-03-20 01:13:45 +0100317 }
318
319 /**
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100320 * Returns true if the view is on one of the current pages, false otherwise.
321 */
322 public boolean isVisible(View child) {
323 return getLeftmostVisiblePageForIndex(indexOfChild(child)) == mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700324 }
325
Chet Haasebc2f0822012-10-26 17:59:53 -0700326 /**
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700327 * @return The closest page to the provided page that is within mMinScrollX and mMaxScrollX.
328 */
329 private int ensureWithinScrollBounds(int page) {
330 int dir = !mIsRtl ? 1 : - 1;
331 int currScroll = getScrollForPage(page);
332 int prevScroll;
Vinit Nayaka406f722019-12-19 11:50:55 -0800333 while (currScroll < mMinScroll) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700334 page += dir;
335 prevScroll = currScroll;
336 currScroll = getScrollForPage(page);
337 if (currScroll <= prevScroll) {
338 Log.e(TAG, "validateNewPage: failed to find a page > mMinScrollX");
339 break;
340 }
341 }
Vinit Nayaka406f722019-12-19 11:50:55 -0800342 while (currScroll > mMaxScroll) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700343 page -= dir;
344 prevScroll = currScroll;
345 currScroll = getScrollForPage(page);
346 if (currScroll >= prevScroll) {
347 Log.e(TAG, "validateNewPage: failed to find a page < mMaxScrollX");
348 break;
349 }
350 }
351 return page;
352 }
353
Tony Wickham03f27012019-04-25 14:22:54 -0700354 public void setCurrentPage(int currentPage) {
355 setCurrentPage(currentPage, INVALID_PAGE);
356 }
357
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700358 /**
Winson Chung86f77532010-08-24 11:08:22 -0700359 * Sets the current page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700360 */
Tony Wickham03f27012019-04-25 14:22:54 -0700361 public void setCurrentPage(int currentPage, int overridePrevPage) {
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800362 if (!mScroller.isFinished()) {
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700363 abortScrollerAnimation(true);
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800364 }
Michael Jurkad3ef3062010-11-23 16:23:58 -0800365 // don't introduce any checks like mCurrentPage == currentPage here-- if we change the
366 // the default
367 if (getChildCount() == 0) {
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800368 return;
369 }
Tony Wickham03f27012019-04-25 14:22:54 -0700370 int prevPage = overridePrevPage != INVALID_PAGE ? overridePrevPage : mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700371 mCurrentPage = validateNewPage(currentPage);
Winson Chung181c3dc2013-07-17 15:36:20 -0700372 updateCurrentPageScroll();
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700373 notifyPageSwitchListener(prevPage);
Winson Chunga12a2502010-12-20 14:41:35 -0800374 invalidate();
Winson Chung321e9ee2010-08-09 13:37:56 -0700375 }
376
Winson Chung8c87cd82013-07-23 16:20:10 -0700377 /**
Adam Cohen674531f2013-12-13 15:07:14 -0800378 * Should be called whenever the page changes. In the case of a scroll, we wait until the page
379 * has settled.
380 */
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700381 protected void notifyPageSwitchListener(int prevPage) {
Adam Cohen674531f2013-12-13 15:07:14 -0800382 updatePageIndicator();
383 }
384
385 private void updatePageIndicator() {
Sunny Goyal4cbf0462014-08-28 16:19:39 -0700386 if (mPageIndicator != null) {
Tony Mak4f521af2018-03-15 16:37:34 +0000387 mPageIndicator.setActiveMarker(getNextPage());
Winson Chungd2be3812013-07-16 11:11:32 -0700388 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700389 }
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700390 protected void pageBeginTransition() {
391 if (!mIsPageInTransition) {
392 mIsPageInTransition = true;
393 onPageBeginTransition();
Michael Jurkad74c9842011-07-10 12:44:21 -0700394 }
Patrick Dubroy1262e362010-10-06 15:49:50 -0700395 }
396
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700397 protected void pageEndTransition() {
Sunny Goyal05b59c02021-04-29 13:55:40 -0700398 if (mIsPageInTransition && !mIsBeingDragged && mScroller.isFinished()
Sunny Goyalb745a2a2021-04-30 13:38:22 -0700399 && (!isShown() || (mEdgeGlowLeft.isFinished() && mEdgeGlowRight.isFinished()))) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700400 mIsPageInTransition = false;
401 onPageEndTransition();
Michael Jurkad74c9842011-07-10 12:44:21 -0700402 }
Michael Jurka0142d492010-08-25 17:46:15 -0700403 }
404
Sunny Goyalb745a2a2021-04-30 13:38:22 -0700405 @Override
406 public void onVisibilityAggregated(boolean isVisible) {
407 pageEndTransition();
408 super.onVisibilityAggregated(isVisible);
409 }
410
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700411 protected boolean isPageInTransition() {
412 return mIsPageInTransition;
Adam Cohen26976d92011-03-22 15:33:33 -0700413 }
414
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700415 /**
416 * Called when the page starts moving as part of the scroll. Subclasses can override this
417 * to provide custom behavior during animation.
418 */
419 protected void onPageBeginTransition() {
Patrick Dubroy1262e362010-10-06 15:49:50 -0700420 }
421
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700422 /**
423 * Called when the page ends moving as part of the scroll. Subclasses can override this
424 * to provide custom behavior during animation.
425 */
426 protected void onPageEndTransition() {
vadimt4d93df52019-07-10 17:32:58 -0700427 AccessibilityManagerCompat.sendScrollFinishedEventToTest(getContext());
Tony Wickham619daaf2020-02-07 12:29:06 -0800428 AccessibilityManagerCompat.sendCustomAccessibilityEvent(getPageAt(mCurrentPage),
429 AccessibilityEvent.TYPE_VIEW_FOCUSED, null);
Tony Wickham62117d72020-03-26 16:56:26 -0700430 if (mOnPageTransitionEndCallback != null) {
431 mOnPageTransitionEndCallback.run();
432 mOnPageTransitionEndCallback = null;
433 }
434 }
435
436 /**
437 * Sets a callback to run once when the scrolling finishes. If there is currently
438 * no page in transition, then the callback is called immediately.
439 */
440 public void setOnPageTransitionEndCallback(@Nullable Runnable callback) {
441 if (mIsPageInTransition || callback == null) {
442 mOnPageTransitionEndCallback = callback;
443 } else {
444 callback.run();
445 }
Michael Jurka0142d492010-08-25 17:46:15 -0700446 }
447
Adam Cohen68d73932010-11-15 10:50:58 -0800448 @Override
Michael Jurka0142d492010-08-25 17:46:15 -0700449 public void scrollTo(int x, int y) {
Sunny Goyalc39db732021-04-03 01:20:21 -0700450 x = Utilities.boundToRange(x,
451 mOrientationHandler.getPrimaryValue(mMinScroll, 0), mMaxScroll);
452 y = Utilities.boundToRange(y,
453 mOrientationHandler.getPrimaryValue(0, mMinScroll), mMaxScroll);
Vinit Nayaka406f722019-12-19 11:50:55 -0800454 super.scrollTo(x, y);
Michael Jurka0142d492010-08-25 17:46:15 -0700455 }
456
Adam Cohen53805212013-10-01 10:39:23 -0700457 private void sendScrollAccessibilityEvent() {
Sunny Goyald0030b02017-12-08 15:07:24 -0800458 if (isObservedEventType(getContext(), AccessibilityEvent.TYPE_VIEW_SCROLLED)) {
Vadim Tryshevf4715972015-05-08 17:21:03 -0700459 if (mCurrentPage != getNextPage()) {
460 AccessibilityEvent ev =
461 AccessibilityEvent.obtain(AccessibilityEvent.TYPE_VIEW_SCROLLED);
Vadim Tryshev7066c122015-05-21 14:06:35 -0700462 ev.setScrollable(true);
463 ev.setScrollX(getScrollX());
464 ev.setScrollY(getScrollY());
Vinit Nayaka406f722019-12-19 11:50:55 -0800465 mOrientationHandler.setMaxScroll(ev, mMaxScroll);
Vadim Tryshevf4715972015-05-08 17:21:03 -0700466 sendAccessibilityEventUnchecked(ev);
Adam Cohen53805212013-10-01 10:39:23 -0700467 }
Adam Cohen53805212013-10-01 10:39:23 -0700468 }
469 }
470
Vadim Tryshev2c430b32018-04-04 14:45:21 -0700471 protected void announcePageForAccessibility() {
472 if (isAccessibilityEnabled(getContext())) {
473 // Notify the user when the page changes
474 announceForAccessibility(getCurrentPageDescription());
475 }
476 }
477
Winson Chung85425412021-05-10 16:24:14 -0700478 protected boolean computeScrollHelper() {
Winson Chung321e9ee2010-08-09 13:37:56 -0700479 if (mScroller.computeScrollOffset()) {
Winson Chung557d6ed2011-07-08 15:34:52 -0700480 // Don't bother scrolling if the page does not need to be moved
Sunny Goyalc39db732021-04-03 01:20:21 -0700481 int oldPos = mOrientationHandler.getPrimaryScroll(this);
482 int newPos = mScroller.getCurrX();
483 if (oldPos != newPos) {
484 mOrientationHandler.set(this, VIEW_SCROLL_TO, mScroller.getCurrX());
Winson Chung557d6ed2011-07-08 15:34:52 -0700485 }
Winson Chung85425412021-05-10 16:24:14 -0700486
487 if (mAllowOverScroll) {
488 if (newPos < mMinScroll && oldPos >= mMinScroll) {
489 mEdgeGlowLeft.onAbsorb((int) mScroller.getCurrVelocity());
490 mScroller.abortAnimation();
491 } else if (newPos > mMaxScroll && oldPos <= mMaxScroll) {
492 mEdgeGlowRight.onAbsorb((int) mScroller.getCurrVelocity());
493 mScroller.abortAnimation();
Sunny Goyalc39db732021-04-03 01:20:21 -0700494 }
Tony Wickham95cdb3a2016-02-18 14:37:07 -0800495 }
Adam Cohen53805212013-10-01 10:39:23 -0700496
Winson Chung85425412021-05-10 16:24:14 -0700497 // If the scroller has scrolled to the final position and there is no edge effect, then
498 // finish the scroller to skip waiting for additional settling
499 int finalPos = mOrientationHandler.getPrimaryValue(mScroller.getFinalX(),
500 mScroller.getFinalY());
501 if (newPos == finalPos && mEdgeGlowLeft.isFinished() && mEdgeGlowRight.isFinished()) {
502 mScroller.abortAnimation();
503 }
504
505 invalidate();
506 return true;
507 } else if (mNextPage != INVALID_PAGE) {
508 sendScrollAccessibilityEvent();
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700509 int prevPage = mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700510 mCurrentPage = validateNewPage(mNextPage);
Winson Chung86f77532010-08-24 11:08:22 -0700511 mNextPage = INVALID_PAGE;
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700512 notifyPageSwitchListener(prevPage);
Winson Chungb44b5242011-06-13 11:32:14 -0700513
Adam Cohen73aa9752010-11-24 16:26:58 -0800514 // We don't want to trigger a page end moving unless the page has settled
515 // and the user has stopped scrolling
Sunny Goyalaad33592018-08-07 17:20:35 -0700516 if (!mIsBeingDragged) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700517 pageEndTransition();
Adam Cohen73aa9752010-11-24 16:26:58 -0800518 }
Winson Chungc27d1bb2011-09-29 12:07:42 -0700519
Vadim Tryshev2c430b32018-04-04 14:45:21 -0700520 if (canAnnouncePageDescription()) {
521 announcePageForAccessibility();
Adam Cohen0ffac432013-07-10 11:19:26 -0700522 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700523 }
Michael Jurka0142d492010-08-25 17:46:15 -0700524 return false;
525 }
526
527 @Override
528 public void computeScroll() {
529 computeScrollHelper();
Winson Chung321e9ee2010-08-09 13:37:56 -0700530 }
531
Sunny Goyalce8809a2018-01-18 14:02:47 -0800532 public int getExpectedHeight() {
533 return getMeasuredHeight();
534 }
535
Adam Cohen410f3cd2013-09-22 12:09:32 -0700536 public int getNormalChildHeight() {
Sunny Goyalce8809a2018-01-18 14:02:47 -0800537 return getExpectedHeight() - getPaddingTop() - getPaddingBottom()
Sunny Goyalac00cba2017-11-13 15:58:01 -0800538 - mInsets.top - mInsets.bottom;
Adam Cohen410f3cd2013-09-22 12:09:32 -0700539 }
540
Sunny Goyalce8809a2018-01-18 14:02:47 -0800541 public int getExpectedWidth() {
542 return getMeasuredWidth();
543 }
544
Sunny Goyalbc683e92017-12-06 10:25:07 -0800545 public int getNormalChildWidth() {
Sunny Goyalce8809a2018-01-18 14:02:47 -0800546 return getExpectedWidth() - getPaddingLeft() - getPaddingRight()
Sunny Goyalbc683e92017-12-06 10:25:07 -0800547 - mInsets.left - mInsets.right;
548 }
549
Winson Chung321e9ee2010-08-09 13:37:56 -0700550 @Override
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800551 public void requestLayout() {
552 mIsLayoutValid = false;
553 super.requestLayout();
554 }
555
556 @Override
557 public void forceLayout() {
558 mIsLayoutValid = false;
559 super.forceLayout();
560 }
561
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100562 private int getPageWidthSize(int widthSize) {
563 return (widthSize - mInsets.left - mInsets.right) / getPanelCount();
564 }
565
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800566 @Override
Winson Chung321e9ee2010-08-09 13:37:56 -0700567 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
Sunny Goyal8e2133b2015-05-06 13:39:07 -0700568 if (getChildCount() == 0) {
Winson Chungf0ea4d32011-06-06 14:27:16 -0700569 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
570 return;
571 }
572
Adam Cohen7d30a372013-07-01 17:03:59 -0700573 // We measure the dimensions of the PagedView to be larger than the pages so that when we
574 // zoom out (and scale down), the view is still contained in the parent
Adam Cohen7d30a372013-07-01 17:03:59 -0700575 int widthMode = MeasureSpec.getMode(widthMeasureSpec);
576 int widthSize = MeasureSpec.getSize(widthMeasureSpec);
577 int heightMode = MeasureSpec.getMode(heightMeasureSpec);
Winson Chung8aad6102012-05-11 16:27:49 -0700578 int heightSize = MeasureSpec.getSize(heightMeasureSpec);
Adam Cohen410f3cd2013-09-22 12:09:32 -0700579
Adam Cohen7d30a372013-07-01 17:03:59 -0700580 if (widthMode == MeasureSpec.UNSPECIFIED || heightMode == MeasureSpec.UNSPECIFIED) {
581 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
582 return;
Winson Chung321e9ee2010-08-09 13:37:56 -0700583 }
584
Winson Chung8aad6102012-05-11 16:27:49 -0700585 // Return early if we aren't given a proper dimension
586 if (widthSize <= 0 || heightSize <= 0) {
587 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
588 return;
589 }
590
Winson Chung321e9ee2010-08-09 13:37:56 -0700591 // The children are given the same width and height as the workspace
Michael Jurka5f1c5092010-09-03 14:15:02 -0700592 // unless they were set to WRAP_CONTENT
Winson Chung785d2eb2011-04-14 16:08:02 -0700593 if (DEBUG) Log.d(TAG, "PagedView.onMeasure(): " + widthSize + ", " + heightSize);
Michael Jurka5f1c5092010-09-03 14:15:02 -0700594
Sunny Goyalac00cba2017-11-13 15:58:01 -0800595 int myWidthSpec = MeasureSpec.makeMeasureSpec(
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100596 getPageWidthSize(widthSize), MeasureSpec.EXACTLY);
Sunny Goyalac00cba2017-11-13 15:58:01 -0800597 int myHeightSpec = MeasureSpec.makeMeasureSpec(
Sunny Goyal228153d2018-01-04 15:35:22 -0800598 heightSize - mInsets.top - mInsets.bottom, MeasureSpec.EXACTLY);
Adam Cohen96d30a12013-07-16 18:13:21 -0700599
Sunny Goyalac00cba2017-11-13 15:58:01 -0800600 // measureChildren takes accounts for content padding, we only need to care about extra
601 // space due to insets.
602 measureChildren(myWidthSpec, myHeightSpec);
603 setMeasuredDimension(widthSize, heightSize);
Adam Cohen60b07122011-11-14 17:26:06 -0800604 }
605
Sunny Goyalcf25b522015-07-09 00:01:18 -0700606 @SuppressLint("DrawAllocation")
Winson Chung321e9ee2010-08-09 13:37:56 -0700607 @Override
Michael Jurka28750fb2010-09-24 17:43:49 -0700608 protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800609 mIsLayoutValid = true;
Vadim Trysheveb701c62018-05-14 16:00:15 -0700610 final int childCount = getChildCount();
611 boolean pageScrollChanged = false;
612 if (mPageScrolls == null || childCount != mPageScrolls.length) {
613 mPageScrolls = new int[childCount];
614 pageScrollChanged = true;
615 }
616
617 if (childCount == 0) {
Winson Chungf0ea4d32011-06-06 14:27:16 -0700618 return;
619 }
620
Winson Chung785d2eb2011-04-14 16:08:02 -0700621 if (DEBUG) Log.d(TAG, "PagedView.onLayout()");
Winson Chung321e9ee2010-08-09 13:37:56 -0700622
Vinit Nayaka406f722019-12-19 11:50:55 -0800623 boolean isScrollChanged = getPageScrolls(mPageScrolls, true, SIMPLE_SCROLL_LOGIC);
624 if (isScrollChanged) {
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700625 pageScrollChanged = true;
Winson Chung321e9ee2010-08-09 13:37:56 -0700626 }
Winson Chungc3665fa2011-09-14 17:56:27 -0700627
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700628 final LayoutTransition transition = getLayoutTransition();
629 // If the transition is running defer updating max scroll, as some empty pages could
630 // still be present, and a max scroll change could cause sudden jumps in scroll.
631 if (transition != null && transition.isRunning()) {
632 transition.addTransitionListener(new LayoutTransition.TransitionListener() {
633
634 @Override
635 public void startTransition(LayoutTransition transition, ViewGroup container,
636 View view, int transitionType) { }
637
638 @Override
639 public void endTransition(LayoutTransition transition, ViewGroup container,
640 View view, int transitionType) {
641 // Wait until all transitions are complete.
642 if (!transition.isRunning()) {
643 transition.removeTransitionListener(this);
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700644 updateMinAndMaxScrollX();
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700645 }
646 }
647 });
Adam Cohenf698c6e2013-07-17 18:44:25 -0700648 } else {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700649 updateMinAndMaxScrollX();
Adam Cohenf698c6e2013-07-17 18:44:25 -0700650 }
651
Sunny Goyalcb037ee2015-07-08 16:41:21 -0700652 if (mFirstLayout && mCurrentPage >= 0 && mCurrentPage < childCount) {
653 updateCurrentPageScroll();
654 mFirstLayout = false;
655 }
656
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800657 if (mScroller.isFinished() && pageScrollChanged) {
Sunny Goyalc82c6392018-06-06 15:39:13 -0700658 setCurrentPage(getNextPage());
Adam Cohenf698c6e2013-07-17 18:44:25 -0700659 }
Winson Chunge3193b92010-09-10 11:44:42 -0700660 }
661
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700662 /**
663 * Initializes {@code outPageScrolls} with scroll positions for view at that index. The length
664 * of {@code outPageScrolls} should be same as the the childCount
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700665 */
666 protected boolean getPageScrolls(int[] outPageScrolls, boolean layoutChildren,
667 ComputePageScrollsLogic scrollLogic) {
668 final int childCount = getChildCount();
669
670 final int startIndex = mIsRtl ? childCount - 1 : 0;
671 final int endIndex = mIsRtl ? -1 : childCount;
672 final int delta = mIsRtl ? -1 : 1;
673
Vinit Nayaka406f722019-12-19 11:50:55 -0800674 final int pageCenter = mOrientationHandler.getCenterForPage(this, mInsets);
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700675
Vinit Nayaka406f722019-12-19 11:50:55 -0800676 final int scrollOffsetStart = mOrientationHandler.getScrollOffsetStart(this, mInsets);
677 final int scrollOffsetEnd = mOrientationHandler.getScrollOffsetEnd(this, mInsets);
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700678 boolean pageScrollChanged = false;
679
Vinit Nayaka406f722019-12-19 11:50:55 -0800680 for (int i = startIndex, childStart = scrollOffsetStart; i != endIndex; i += delta) {
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700681 final View child = getPageAt(i);
682 if (scrollLogic.shouldIncludeView(child)) {
Vinit Nayaka406f722019-12-19 11:50:55 -0800683 ChildBounds bounds = mOrientationHandler.getChildBounds(child, childStart,
684 pageCenter, layoutChildren);
685 final int primaryDimension = bounds.primaryDimension;
686 final int childPrimaryEnd = bounds.childPrimaryEnd;
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700687
Alex Chaub5c4d112021-03-29 17:37:53 +0100688 // In case the pages are of different width, align the page to left edge for non-RTL
689 // or right edge for RTL.
690 final int pageScroll =
691 mIsRtl ? childPrimaryEnd - scrollOffsetEnd : childStart - scrollOffsetStart;
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700692 if (outPageScrolls[i] != pageScroll) {
693 pageScrollChanged = true;
694 outPageScrolls[i] = pageScroll;
695 }
Vinit Nayaka406f722019-12-19 11:50:55 -0800696 childStart += primaryDimension + mPageSpacing + getChildGap();
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700697 }
698 }
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100699
700 int panelCount = getPanelCount();
701 if (panelCount > 1) {
702 for (int i = 0; i < childCount; i++) {
703 // In case we have multiple panels, always use left panel's page scroll for all
704 // panels on the screen.
705 int adjustedScroll = outPageScrolls[getLeftmostVisiblePageForIndex(i)];
706 if (outPageScrolls[i] != adjustedScroll) {
707 outPageScrolls[i] = adjustedScroll;
708 pageScrollChanged = true;
709 }
710 }
711 }
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700712 return pageScrollChanged;
713 }
714
Sunny Goyala1fbd842015-05-20 13:40:27 -0700715 protected int getChildGap() {
716 return 0;
717 }
718
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700719 protected void updateMinAndMaxScrollX() {
Vinit Nayaka406f722019-12-19 11:50:55 -0800720 mMinScroll = computeMinScroll();
721 mMaxScroll = computeMaxScroll();
Tony Wickhamf549dab2016-05-16 09:54:06 -0700722 }
723
Vinit Nayaka406f722019-12-19 11:50:55 -0800724 protected int computeMinScroll() {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700725 return 0;
Tony50876bf2018-09-19 23:09:14 -0400726 }
727
Vinit Nayaka406f722019-12-19 11:50:55 -0800728 protected int computeMaxScroll() {
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700729 int childCount = getChildCount();
730 if (childCount > 0) {
Sunny Goyal70660032015-05-14 00:07:08 -0700731 final int index = mIsRtl ? 0 : childCount - 1;
Tony Wickhamf549dab2016-05-16 09:54:06 -0700732 return getScrollForPage(index);
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700733 } else {
Tony Wickhamf549dab2016-05-16 09:54:06 -0700734 return 0;
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700735 }
736 }
737
Adam Cohen3b185e22013-10-29 14:45:58 -0700738 public void setPageSpacing(int pageSpacing) {
739 mPageSpacing = pageSpacing;
740 requestLayout();
741 }
742
Tony50876bf2018-09-19 23:09:14 -0400743 public int getPageSpacing() {
744 return mPageSpacing;
745 }
746
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800747 private void dispatchPageCountChanged() {
748 if (mPageIndicator != null) {
749 mPageIndicator.setMarkersCount(getChildCount());
Winson Chungd2be3812013-07-16 11:11:32 -0700750 }
Adam Cohen2591f6a2011-10-25 14:36:40 -0700751 // This ensures that when children are added, they get the correct transforms / alphas
752 // in accordance with any scroll effects.
Adam Cohen2591f6a2011-10-25 14:36:40 -0700753 invalidate();
754 }
755
Michael Jurka8b805b12012-04-18 14:23:14 -0700756 @Override
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800757 public void onViewAdded(View child) {
Winson Chungc7c51582018-02-23 17:58:36 -0800758 super.onViewAdded(child);
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800759 dispatchPageCountChanged();
760 }
761
762 @Override
763 public void onViewRemoved(View child) {
Winson Chungc7c51582018-02-23 17:58:36 -0800764 super.onViewRemoved(child);
Tonya361c722017-07-04 09:43:06 -0700765 mCurrentPage = validateNewPage(mCurrentPage);
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800766 dispatchPageCountChanged();
Winson Chungd2be3812013-07-16 11:11:32 -0700767 }
768
Adam Cohen73894962011-10-31 13:17:17 -0700769 protected int getChildOffset(int index) {
Adam Cohen7d30a372013-07-01 17:03:59 -0700770 if (index < 0 || index > getChildCount() - 1) return 0;
Vinit Nayaka406f722019-12-19 11:50:55 -0800771 View pageAtIndex = getPageAt(index);
772 return mOrientationHandler.getChildStart(pageAtIndex);
Adam Cohen73894962011-10-31 13:17:17 -0700773 }
774
Alex Chau7944ee52021-01-08 19:07:25 +0000775 protected int getChildVisibleSize(int index) {
776 View layout = getPageAt(index);
777 return mOrientationHandler.getMeasuredSize(layout);
778 }
779
Winson Chung321e9ee2010-08-09 13:37:56 -0700780 @Override
781 public boolean requestChildRectangleOnScreen(View child, Rect rectangle, boolean immediate) {
Adam Cohenae4f1552011-10-20 00:15:42 -0700782 int page = indexToPage(indexOfChild(child));
Winson Chung86f77532010-08-24 11:08:22 -0700783 if (page != mCurrentPage || !mScroller.isFinished()) {
Vadim Trysheveeaa8ee2018-04-11 12:23:42 -0700784 if (immediate) {
785 setCurrentPage(page);
786 } else {
787 snapToPage(page);
788 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700789 return true;
790 }
791 return false;
792 }
793
794 @Override
795 protected boolean onRequestFocusInDescendants(int direction, Rect previouslyFocusedRect) {
Winson Chung86f77532010-08-24 11:08:22 -0700796 int focusablePage;
797 if (mNextPage != INVALID_PAGE) {
798 focusablePage = mNextPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700799 } else {
Winson Chung86f77532010-08-24 11:08:22 -0700800 focusablePage = mCurrentPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700801 }
Winson Chung86f77532010-08-24 11:08:22 -0700802 View v = getPageAt(focusablePage);
Winson Chung321e9ee2010-08-09 13:37:56 -0700803 if (v != null) {
Adam Cohen76fc0852011-06-17 13:26:23 -0700804 return v.requestFocus(direction, previouslyFocusedRect);
Winson Chung321e9ee2010-08-09 13:37:56 -0700805 }
806 return false;
807 }
808
809 @Override
810 public boolean dispatchUnhandledMove(View focused, int direction) {
Sunny Goyal0c4e3722015-12-01 13:21:49 -0800811 if (super.dispatchUnhandledMove(focused, direction)) {
812 return true;
813 }
814
815 if (mIsRtl) {
816 if (direction == View.FOCUS_LEFT) {
817 direction = View.FOCUS_RIGHT;
818 } else if (direction == View.FOCUS_RIGHT) {
819 direction = View.FOCUS_LEFT;
820 }
821 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700822 if (direction == View.FOCUS_LEFT) {
Winson Chung86f77532010-08-24 11:08:22 -0700823 if (getCurrentPage() > 0) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100824 int nextPage = validateNewPage(getCurrentPage() - 1);
825 snapToPage(nextPage);
826 getChildAt(nextPage).requestFocus(direction);
Winson Chung321e9ee2010-08-09 13:37:56 -0700827 return true;
828 }
829 } else if (direction == View.FOCUS_RIGHT) {
Winson Chung86f77532010-08-24 11:08:22 -0700830 if (getCurrentPage() < getPageCount() - 1) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100831 int nextPage = validateNewPage(getCurrentPage() + 1);
832 snapToPage(nextPage);
833 getChildAt(nextPage).requestFocus(direction);
Winson Chung321e9ee2010-08-09 13:37:56 -0700834 return true;
835 }
836 }
Sunny Goyal0c4e3722015-12-01 13:21:49 -0800837 return false;
Winson Chung321e9ee2010-08-09 13:37:56 -0700838 }
839
840 @Override
841 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) {
Jon Miranda6a858172016-10-25 16:19:17 -0700842 if (getDescendantFocusability() == FOCUS_BLOCK_DESCENDANTS) {
843 return;
844 }
845
Andras Kloczl359d1ae2021-05-04 22:25:27 +0200846 // Add the current page's views as focusable and the next possible page's too. If the
847 // last focus change action was left then the left neighbour's views will be added, and
848 // if it was right then the right neighbour's views will be added.
849 // Unfortunately mCurrentPage can be outdated if there were multiple control actions in a
850 // short period of time, but mNextPage is up to date because it is always updated by
851 // method snapToPage.
852 int nextPage = getNextPage();
Adam Cohen0ffac432013-07-10 11:19:26 -0700853 // XXX-RTL: This will be fixed in a future CL
Andras Kloczl359d1ae2021-05-04 22:25:27 +0200854 if (nextPage >= 0 && nextPage < getPageCount()) {
855 getPageAt(nextPage).addFocusables(views, direction, focusableMode);
Winson Chung321e9ee2010-08-09 13:37:56 -0700856 }
857 if (direction == View.FOCUS_LEFT) {
Andras Kloczl359d1ae2021-05-04 22:25:27 +0200858 if (nextPage > 0) {
859 nextPage = validateNewPage(nextPage - 1);
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100860 getPageAt(nextPage).addFocusables(views, direction, focusableMode);
Winson Chung321e9ee2010-08-09 13:37:56 -0700861 }
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100862 } else if (direction == View.FOCUS_RIGHT) {
Andras Kloczl359d1ae2021-05-04 22:25:27 +0200863 if (nextPage < getPageCount() - 1) {
864 nextPage = validateNewPage(nextPage + 1);
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100865 getPageAt(nextPage).addFocusables(views, direction, focusableMode);
Winson Chung321e9ee2010-08-09 13:37:56 -0700866 }
867 }
868 }
869
870 /**
871 * If one of our descendant views decides that it could be focused now, only
Winson Chung86f77532010-08-24 11:08:22 -0700872 * pass that along if it's on the current page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700873 *
Winson Chung86f77532010-08-24 11:08:22 -0700874 * This happens when live folders requery, and if they're off page, they
875 * end up calling requestFocus, which pulls it on page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700876 */
877 @Override
878 public void focusableViewAvailable(View focused) {
Winson Chung86f77532010-08-24 11:08:22 -0700879 View current = getPageAt(mCurrentPage);
Winson Chung321e9ee2010-08-09 13:37:56 -0700880 View v = focused;
881 while (true) {
882 if (v == current) {
883 super.focusableViewAvailable(focused);
884 return;
885 }
886 if (v == this) {
887 return;
888 }
889 ViewParent parent = v.getParent();
890 if (parent instanceof View) {
891 v = (View)v.getParent();
892 } else {
893 return;
894 }
895 }
896 }
897
898 /**
899 * {@inheritDoc}
900 */
901 @Override
902 public void requestDisallowInterceptTouchEvent(boolean disallowIntercept) {
903 if (disallowIntercept) {
904 // We need to make sure to cancel our long press if
905 // a scrollable widget takes over touch events
Andras Kloczl7a1ca0b2021-04-08 16:08:16 +0200906 cancelCurrentPageLongPress();
Winson Chung321e9ee2010-08-09 13:37:56 -0700907 }
908 super.requestDisallowInterceptTouchEvent(disallowIntercept);
909 }
910
911 @Override
912 public boolean onInterceptTouchEvent(MotionEvent ev) {
913 /*
914 * This method JUST determines whether we want to intercept the motion.
915 * If we return true, onTouchEvent will be called and we do the actual
916 * scrolling there.
917 */
918
Winson Chung45e1d6e2010-11-09 17:19:49 -0800919 // Skip touch handling if there are no pages to swipe
Tony Wickhamb6841ac2019-07-22 12:39:59 -0700920 if (getChildCount() <= 0) return false;
Sunny Goyalc4bb3732019-06-20 11:34:14 -0700921
922 acquireVelocityTrackerAndAddMovement(ev);
Winson Chung45e1d6e2010-11-09 17:19:49 -0800923
Winson Chung321e9ee2010-08-09 13:37:56 -0700924 /*
925 * Shortcut the most recurring case: the user is in the dragging
926 * state and he is moving his finger. We want to intercept this
927 * motion.
928 */
929 final int action = ev.getAction();
Sunny Goyalaad33592018-08-07 17:20:35 -0700930 if ((action == MotionEvent.ACTION_MOVE) && mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -0700931 return true;
932 }
933
Winson Chung321e9ee2010-08-09 13:37:56 -0700934 switch (action & MotionEvent.ACTION_MASK) {
935 case MotionEvent.ACTION_MOVE: {
936 /*
937 * mIsBeingDragged == false, otherwise the shortcut would have caught it. Check
Vinit Nayaka406f722019-12-19 11:50:55 -0800938 * whether the user has moved far enough from their original down touch.
Winson Chung321e9ee2010-08-09 13:37:56 -0700939 */
Michael Jurka1ff706b2010-09-14 17:35:20 -0700940 if (mActivePointerId != INVALID_POINTER) {
941 determineScrollingStart(ev);
Michael Jurka1ff706b2010-09-14 17:35:20 -0700942 }
943 // if mActivePointerId is INVALID_POINTER, then we must have missed an ACTION_DOWN
Vinit Nayaka406f722019-12-19 11:50:55 -0800944 // event. in that case, treat the first occurrence of a move event as a ACTION_DOWN
Michael Jurka1ff706b2010-09-14 17:35:20 -0700945 // i.e. fall through to the next case (don't break)
946 // (We sometimes miss ACTION_DOWN events in Workspace because it ignores all events
947 // while it's small- this was causing a crash before we checked for INVALID_POINTER)
Adam Cohen93c97562013-09-26 13:48:01 -0700948 break;
Winson Chung321e9ee2010-08-09 13:37:56 -0700949 }
950
951 case MotionEvent.ACTION_DOWN: {
952 final float x = ev.getX();
953 final float y = ev.getY();
954 // Remember location of down touch
955 mDownMotionX = x;
Adam Cohen7d30a372013-07-01 17:03:59 -0700956 mDownMotionY = y;
Jon Mirandaf52af432020-04-10 17:25:57 -0700957 mDownMotionPrimary = mLastMotion = mOrientationHandler.getPrimaryDirection(ev, 0);
Vinit Nayaka406f722019-12-19 11:50:55 -0800958 mLastMotionRemainder = 0;
959 mTotalMotion = 0;
Winson Chung4941f652020-06-18 15:11:53 -0700960 mAllowEasyFling = false;
Winson Chung321e9ee2010-08-09 13:37:56 -0700961 mActivePointerId = ev.getPointerId(0);
Sunny Goyalc39db732021-04-03 01:20:21 -0700962 updateIsBeingDraggedOnTouchDown(ev);
Winson Chung321e9ee2010-08-09 13:37:56 -0700963 break;
964 }
965
Winson Chung321e9ee2010-08-09 13:37:56 -0700966 case MotionEvent.ACTION_UP:
Jeff Brown1d0867c2010-12-02 18:27:39 -0800967 case MotionEvent.ACTION_CANCEL:
Adam Cohen7d30a372013-07-01 17:03:59 -0700968 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -0700969 break;
970
971 case MotionEvent.ACTION_POINTER_UP:
972 onSecondaryPointerUp(ev);
Adam Cohen6342bba2011-03-10 11:33:35 -0800973 releaseVelocityTracker();
Winson Chung321e9ee2010-08-09 13:37:56 -0700974 break;
975 }
976
977 /*
978 * The only time we want to intercept motion events is if we are in the
979 * drag mode.
980 */
Sunny Goyalaad33592018-08-07 17:20:35 -0700981 return mIsBeingDragged;
Winson Chung321e9ee2010-08-09 13:37:56 -0700982 }
983
Tony Wickhama0aee212019-09-18 09:24:03 -0700984 /**
985 * If being flinged and user touches the screen, initiate drag; otherwise don't.
986 */
Sunny Goyalc39db732021-04-03 01:20:21 -0700987 private void updateIsBeingDraggedOnTouchDown(MotionEvent ev) {
Tony Wickhama0aee212019-09-18 09:24:03 -0700988 // mScroller.isFinished should be false when being flinged.
Sunny Goyalc39db732021-04-03 01:20:21 -0700989 final int xDist = Math.abs(mScroller.getFinalX() - mScroller.getCurrX());
Winson Chung4941f652020-06-18 15:11:53 -0700990 final boolean finishedScrolling = (mScroller.isFinished() || xDist < mPageSlop / 3);
Tony Wickhama0aee212019-09-18 09:24:03 -0700991
992 if (finishedScrolling) {
993 mIsBeingDragged = false;
994 if (!mScroller.isFinished() && !mFreeScroll) {
995 setCurrentPage(getNextPage());
996 pageEndTransition();
997 }
Sunny Goyalc39db732021-04-03 01:20:21 -0700998 mIsBeingDragged = !mEdgeGlowLeft.isFinished() || !mEdgeGlowRight.isFinished();
Tony Wickhama0aee212019-09-18 09:24:03 -0700999 } else {
1000 mIsBeingDragged = true;
1001 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001002
1003 // Catch the edge effect if it is active.
1004 float displacement = mOrientationHandler.getSecondaryValue(ev.getX(), ev.getY())
1005 / mOrientationHandler.getSecondaryValue(getWidth(), getHeight());
1006 if (!mEdgeGlowLeft.isFinished()) {
1007 mEdgeGlowLeft.onPullDistance(0f, 1f - displacement);
1008 }
1009 if (!mEdgeGlowRight.isFinished()) {
1010 mEdgeGlowRight.onPullDistance(0f, displacement);
1011 }
Tony Wickhama0aee212019-09-18 09:24:03 -07001012 }
1013
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001014 public boolean isHandlingTouch() {
Sunny Goyalaad33592018-08-07 17:20:35 -07001015 return mIsBeingDragged;
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001016 }
1017
Adam Cohenf8d28232011-02-01 21:47:00 -08001018 protected void determineScrollingStart(MotionEvent ev) {
1019 determineScrollingStart(ev, 1.0f);
1020 }
1021
Winson Chung321e9ee2010-08-09 13:37:56 -07001022 /*
1023 * Determines if we should change the touch state to start scrolling after the
1024 * user moves their touch point too far.
1025 */
Adam Cohenf8d28232011-02-01 21:47:00 -08001026 protected void determineScrollingStart(MotionEvent ev, float touchSlopScale) {
Adam Cohen7d30a372013-07-01 17:03:59 -07001027 // Disallow scrolling if we don't have a valid pointer index
Winson Chung321e9ee2010-08-09 13:37:56 -07001028 final int pointerIndex = ev.findPointerIndex(mActivePointerId);
Adam Cohen7d30a372013-07-01 17:03:59 -07001029 if (pointerIndex == -1) return;
1030
Vinit Nayaka406f722019-12-19 11:50:55 -08001031 final float primaryDirection = mOrientationHandler.getPrimaryDirection(ev, pointerIndex);
1032 final int diff = (int) Math.abs(primaryDirection - mLastMotion);
Adam Cohenf8d28232011-02-01 21:47:00 -08001033 final int touchSlop = Math.round(touchSlopScale * mTouchSlop);
Winson Chung4941f652020-06-18 15:11:53 -07001034 boolean moved = diff > touchSlop || ev.getAction() == ACTION_MOVE_ALLOW_EASY_FLING;
Winson Chung321e9ee2010-08-09 13:37:56 -07001035
Vinit Nayaka406f722019-12-19 11:50:55 -08001036 if (moved) {
Sunny Goyal5a1f53b2015-05-27 10:24:24 -07001037 // Scroll if the user moved far enough along the X axis
Sunny Goyalaad33592018-08-07 17:20:35 -07001038 mIsBeingDragged = true;
Vinit Nayaka406f722019-12-19 11:50:55 -08001039 mTotalMotion += Math.abs(mLastMotion - primaryDirection);
1040 mLastMotion = primaryDirection;
1041 mLastMotionRemainder = 0;
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001042 pageBeginTransition();
Tony Wickhamdadb3042016-02-24 11:07:00 -08001043 // Stop listening for things like pinches.
1044 requestDisallowInterceptTouchEvent(true);
Adam Cohenf8d28232011-02-01 21:47:00 -08001045 }
1046 }
1047
1048 protected void cancelCurrentPageLongPress() {
Sunny Goyal8e2133b2015-05-06 13:39:07 -07001049 // Try canceling the long press. It could also have been scheduled
1050 // by a distant descendant, so use the mAllowLongPress flag to block
1051 // everything
Sunny Goyal59969372021-05-06 12:11:44 -07001052 forEachVisiblePage(View::cancelLongPress);
Winson Chung321e9ee2010-08-09 13:37:56 -07001053 }
1054
Adam Cohenb5ba0972011-09-07 18:02:31 -07001055 protected float getScrollProgress(int screenCenter, View v, int page) {
Sunny Goyal228153d2018-01-04 15:35:22 -08001056 final int halfScreenSize = getMeasuredWidth() / 2;
Adam Cohenb5ba0972011-09-07 18:02:31 -07001057
Adam Cohenedb40762013-07-18 16:45:45 -07001058 int delta = screenCenter - (getScrollForPage(page) + halfScreenSize);
Adam Cohen3b185e22013-10-29 14:45:58 -07001059 int count = getChildCount();
1060
1061 final int totalDistance;
1062
1063 int adjacentPage = page + 1;
Sunny Goyal70660032015-05-14 00:07:08 -07001064 if ((delta < 0 && !mIsRtl) || (delta > 0 && mIsRtl)) {
Adam Cohen3b185e22013-10-29 14:45:58 -07001065 adjacentPage = page - 1;
1066 }
1067
1068 if (adjacentPage < 0 || adjacentPage > count - 1) {
1069 totalDistance = v.getMeasuredWidth() + mPageSpacing;
1070 } else {
1071 totalDistance = Math.abs(getScrollForPage(adjacentPage) - getScrollForPage(page));
1072 }
Adam Cohenb5ba0972011-09-07 18:02:31 -07001073
1074 float scrollProgress = delta / (totalDistance * 1.0f);
Sunny Goyal8e2133b2015-05-06 13:39:07 -07001075 scrollProgress = Math.min(scrollProgress, MAX_SCROLL_PROGRESS);
1076 scrollProgress = Math.max(scrollProgress, - MAX_SCROLL_PROGRESS);
Adam Cohenb5ba0972011-09-07 18:02:31 -07001077 return scrollProgress;
1078 }
1079
Adam Cohenedb40762013-07-18 16:45:45 -07001080 public int getScrollForPage(int index) {
Adam Cohen1f1f45d2013-10-02 09:40:18 -07001081 if (mPageScrolls == null || index >= mPageScrolls.length || index < 0) {
Adam Cohenedb40762013-07-18 16:45:45 -07001082 return 0;
1083 } else {
1084 return mPageScrolls[index];
1085 }
1086 }
1087
Adam Cohen564a2e72013-10-09 14:47:32 -07001088 // While layout transitions are occurring, a child's position may stray from its baseline
1089 // position. This method returns the magnitude of this stray at any given time.
1090 public int getLayoutTransitionOffsetForPage(int index) {
1091 if (mPageScrolls == null || index >= mPageScrolls.length || index < 0) {
1092 return 0;
1093 } else {
1094 View child = getChildAt(index);
Adam Cohen3b185e22013-10-29 14:45:58 -07001095
Sunny Goyal228153d2018-01-04 15:35:22 -08001096 int scrollOffset = mIsRtl ? getPaddingRight() : getPaddingLeft();
1097 int baselineX = mPageScrolls[index] + scrollOffset;
Adam Cohen564a2e72013-10-09 14:47:32 -07001098 return (int) (child.getX() - baselineX);
1099 }
1100 }
1101
Tony Wickham023f4042019-01-29 10:52:31 -08001102 public void setEnableFreeScroll(boolean freeScroll) {
Winson Chung0e449002019-04-26 11:09:58 -07001103 if (mFreeScroll == freeScroll) {
1104 return;
1105 }
1106
Tony Wickham8f7ead32016-04-07 18:46:44 -07001107 boolean wasFreeScroll = mFreeScroll;
Adam Cohenf358a4b2013-07-23 16:47:31 -07001108 mFreeScroll = freeScroll;
1109
Adam Cohenf9618852013-11-08 06:45:03 -08001110 if (mFreeScroll) {
Sunny Goyal4d519f22017-10-24 10:32:40 -07001111 setCurrentPage(getNextPage());
Tony Wickham8f7ead32016-04-07 18:46:44 -07001112 } else if (wasFreeScroll) {
Tony Wickhamaf33f2c2019-10-04 12:55:22 -07001113 if (getScrollForPage(getNextPage()) != getScrollX()) {
1114 snapToPage(getNextPage());
1115 }
Adam Cohenf358a4b2013-07-23 16:47:31 -07001116 }
Adam Cohenf358a4b2013-07-23 16:47:31 -07001117 }
1118
Sunny Goyal2f0ec852015-03-26 13:38:27 -07001119 protected void setEnableOverscroll(boolean enable) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001120 mAllowOverScroll = enable;
1121 }
1122
Winson Chung321e9ee2010-08-09 13:37:56 -07001123 @Override
1124 public boolean onTouchEvent(MotionEvent ev) {
Winson Chung45e1d6e2010-11-09 17:19:49 -08001125 // Skip touch handling if there are no pages to swipe
Tony Wickhamb6841ac2019-07-22 12:39:59 -07001126 if (getChildCount() <= 0) return false;
Winson Chung45e1d6e2010-11-09 17:19:49 -08001127
Michael Jurkab8f06722010-10-10 15:58:46 -07001128 acquireVelocityTrackerAndAddMovement(ev);
Winson Chung321e9ee2010-08-09 13:37:56 -07001129
1130 final int action = ev.getAction();
1131
1132 switch (action & MotionEvent.ACTION_MASK) {
1133 case MotionEvent.ACTION_DOWN:
Sunny Goyalc39db732021-04-03 01:20:21 -07001134 updateIsBeingDraggedOnTouchDown(ev);
Tony Wickhama0aee212019-09-18 09:24:03 -07001135
Winson Chung321e9ee2010-08-09 13:37:56 -07001136 /*
1137 * If being flinged and user touches, stop the fling. isFinished
1138 * will be false if being flinged.
1139 */
1140 if (!mScroller.isFinished()) {
Adam Cohen8bdbaab2013-10-29 15:25:02 -07001141 abortScrollerAnimation(false);
Winson Chung321e9ee2010-08-09 13:37:56 -07001142 }
1143
1144 // Remember where the motion event started
Vinit Nayaka406f722019-12-19 11:50:55 -08001145 mDownMotionX = ev.getX();
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001146 mDownMotionY = ev.getY();
Vinit Nayaka406f722019-12-19 11:50:55 -08001147 mDownMotionPrimary = mLastMotion = mOrientationHandler.getPrimaryDirection(ev, 0);
1148 mLastMotionRemainder = 0;
1149 mTotalMotion = 0;
Winson Chung4941f652020-06-18 15:11:53 -07001150 mAllowEasyFling = false;
Winson Chung321e9ee2010-08-09 13:37:56 -07001151 mActivePointerId = ev.getPointerId(0);
Sunny Goyalaad33592018-08-07 17:20:35 -07001152 if (mIsBeingDragged) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001153 pageBeginTransition();
Michael Jurka0142d492010-08-25 17:46:15 -07001154 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001155 break;
1156
Winson Chung4941f652020-06-18 15:11:53 -07001157 case ACTION_MOVE_ALLOW_EASY_FLING:
1158 // Start scrolling immediately
1159 determineScrollingStart(ev);
1160 mAllowEasyFling = true;
1161 break;
1162
1163 case MotionEvent.ACTION_MOVE:
1164 if (mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001165 // Scroll to follow the motion event
1166 final int pointerIndex = ev.findPointerIndex(mActivePointerId);
Adam Cohen7d30a372013-07-01 17:03:59 -07001167
1168 if (pointerIndex == -1) return true;
Sunny Goyalc39db732021-04-03 01:20:21 -07001169 float oldScroll = mOrientationHandler.getPrimaryScroll(this);
1170 float dx = ev.getX(pointerIndex);
1171 float dy = ev.getY(pointerIndex);
Adam Cohen7d30a372013-07-01 17:03:59 -07001172
Sunny Goyalc39db732021-04-03 01:20:21 -07001173 float direction = mOrientationHandler.getPrimaryValue(dx, dy);
Vinit Nayaka406f722019-12-19 11:50:55 -08001174 float delta = mLastMotion + mLastMotionRemainder - direction;
Sunny Goyalc39db732021-04-03 01:20:21 -07001175
1176 int width = getWidth();
1177 int height = getHeight();
1178 int size = mOrientationHandler.getPrimaryValue(width, height);
1179
1180 final float displacement = mOrientationHandler.getSecondaryValue(dx, dy)
1181 / mOrientationHandler.getSecondaryValue(width, height);
Vinit Nayaka406f722019-12-19 11:50:55 -08001182 mTotalMotion += Math.abs(delta);
Adam Cohenaefd4e12011-02-14 16:39:38 -08001183
Sunny Goyalc39db732021-04-03 01:20:21 -07001184 if (mAllowOverScroll) {
1185 float consumed = 0;
1186 if (delta < 0 && mEdgeGlowRight.getDistance() != 0f) {
1187 consumed = size * mEdgeGlowRight.onPullDistance(delta / size, displacement);
1188 } else if (delta > 0 && mEdgeGlowLeft.getDistance() != 0f) {
1189 consumed = -size * mEdgeGlowLeft.onPullDistance(
1190 -delta / size, 1 - displacement);
1191 }
1192 delta -= consumed;
1193 }
1194
Winson Chungc0844aa2011-02-02 15:25:58 -08001195 // Only scroll and update mLastMotionX if we have moved some discrete amount. We
1196 // keep the remainder because we are actually testing if we've moved from the last
1197 // scrolled position (which is discrete).
Sunny Goyalc39db732021-04-03 01:20:21 -07001198 mLastMotion = direction;
1199 int movedDelta = (int) delta;
1200 mLastMotionRemainder = delta - movedDelta;
Vinit Nayaka406f722019-12-19 11:50:55 -08001201
Sunny Goyalc39db732021-04-03 01:20:21 -07001202 if (delta != 0) {
1203 mOrientationHandler.set(this, VIEW_SCROLL_BY, movedDelta);
1204
1205 if (mAllowOverScroll) {
1206 final float pulledToX = oldScroll + delta;
1207
1208 if (pulledToX < mMinScroll) {
1209 mEdgeGlowLeft.onPullDistance(-delta / size, 1.f - displacement);
1210 if (!mEdgeGlowRight.isFinished()) {
1211 mEdgeGlowRight.onRelease();
1212 }
1213 } else if (pulledToX > mMaxScroll) {
1214 mEdgeGlowRight.onPullDistance(delta / size, displacement);
1215 if (!mEdgeGlowLeft.isFinished()) {
1216 mEdgeGlowLeft.onRelease();
1217 }
1218 }
1219
1220 if (!mEdgeGlowLeft.isFinished() || !mEdgeGlowRight.isFinished()) {
1221 postInvalidateOnAnimation();
1222 }
1223 }
1224
Winson Chung321e9ee2010-08-09 13:37:56 -07001225 } else {
1226 awakenScrollBars();
1227 }
Adam Cohen564976a2010-10-13 18:52:07 -07001228 } else {
Winson Chung321e9ee2010-08-09 13:37:56 -07001229 determineScrollingStart(ev);
1230 }
1231 break;
1232
1233 case MotionEvent.ACTION_UP:
Sunny Goyalaad33592018-08-07 17:20:35 -07001234 if (mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001235 final int activePointerId = mActivePointerId;
1236 final int pointerIndex = ev.findPointerIndex(activePointerId);
Vinit Nayak93bf1fe2020-05-26 17:22:13 -07001237 if (pointerIndex == -1) return true;
1238
Vinit Nayaka406f722019-12-19 11:50:55 -08001239 final float primaryDirection = mOrientationHandler.getPrimaryDirection(ev,
1240 pointerIndex);
Sunny Goyal4bb8b062019-02-19 16:37:38 -08001241 final VelocityTracker velocityTracker = mVelocityTracker;
1242 velocityTracker.computeCurrentVelocity(1000, mMaximumVelocity);
Adam Cohenaefd4e12011-02-14 16:39:38 -08001243
Vinit Nayaka406f722019-12-19 11:50:55 -08001244 int velocity = (int) mOrientationHandler.getPrimaryVelocity(velocityTracker,
1245 mActivePointerId);
1246 int delta = (int) (primaryDirection - mDownMotionPrimary);
1247 int pageOrientedSize = mOrientationHandler.getMeasuredSize(getPageAt(mCurrentPage));
1248
1249 boolean isSignificantMove = Math.abs(delta) > pageOrientedSize *
1250 SIGNIFICANT_MOVE_THRESHOLD;
1251
1252 mTotalMotion += Math.abs(mLastMotion + mLastMotionRemainder - primaryDirection);
Winson Chung4941f652020-06-18 15:11:53 -07001253 boolean passedSlop = mAllowEasyFling || mTotalMotion > mPageSlop;
1254 boolean isFling = passedSlop && shouldFlingForVelocity(velocity);
Vinit Nayaka406f722019-12-19 11:50:55 -08001255 boolean isDeltaLeft = mIsRtl ? delta > 0 : delta < 0;
1256 boolean isVelocityLeft = mIsRtl ? velocity > 0 : velocity < 0;
Winson Chung4941f652020-06-18 15:11:53 -07001257 if (DEBUG_FAILED_QUICKSWITCH && !isFling && mAllowEasyFling) {
1258 Log.d("Quickswitch", "isFling=false vel=" + velocity
1259 + " threshold=" + mEasyFlingThresholdVelocity);
1260 }
Adam Cohen00481b32011-11-18 12:03:48 -08001261
Adam Cohenf358a4b2013-07-23 16:47:31 -07001262 if (!mFreeScroll) {
1263 // In the case that the page is moved far to one direction and then is flung
1264 // in the opposite direction, we use a threshold to determine whether we should
1265 // just return to the starting page, or if we should skip one further.
1266 boolean returnToOriginalPage = false;
Vinit Nayaka406f722019-12-19 11:50:55 -08001267 if (Math.abs(delta) > pageOrientedSize * RETURN_TO_ORIGINAL_PAGE_THRESHOLD &&
1268 Math.signum(velocity) != Math.signum(delta) && isFling) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001269 returnToOriginalPage = true;
1270 }
Adam Cohenaefd4e12011-02-14 16:39:38 -08001271
Adam Cohenf358a4b2013-07-23 16:47:31 -07001272 int finalPage;
1273 // We give flings precedence over large moves, which is why we short-circuit our
1274 // test for a large move if a fling has been registered. That is, a large
1275 // move to the left and fling to the right will register as a fling to the right.
Sunny Goyalb7b01352018-08-09 12:31:20 -07001276
Vinit Nayaka406f722019-12-19 11:50:55 -08001277 if (((isSignificantMove && !isDeltaLeft && !isFling) ||
1278 (isFling && !isVelocityLeft)) && mCurrentPage > 0) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +01001279 finalPage = returnToOriginalPage
1280 ? mCurrentPage : mCurrentPage - getPanelCount();
Vinit Nayaka406f722019-12-19 11:50:55 -08001281 snapToPageWithVelocity(finalPage, velocity);
1282 } else if (((isSignificantMove && isDeltaLeft && !isFling) ||
1283 (isFling && isVelocityLeft)) &&
Adam Cohenf358a4b2013-07-23 16:47:31 -07001284 mCurrentPage < getChildCount() - 1) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +01001285 finalPage = returnToOriginalPage
1286 ? mCurrentPage : mCurrentPage + getPanelCount();
Vinit Nayaka406f722019-12-19 11:50:55 -08001287 snapToPageWithVelocity(finalPage, velocity);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001288 } else {
1289 snapToDestination();
Adam Cohenf358a4b2013-07-23 16:47:31 -07001290 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001291 } else {
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001292 if (!mScroller.isFinished()) {
1293 abortScrollerAnimation(true);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001294 }
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001295
Vinit Nayaka406f722019-12-19 11:50:55 -08001296 int initialScroll = mOrientationHandler.getPrimaryScroll(this);
1297 int maxScroll = mMaxScroll;
1298 int minScroll = mMinScroll;
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001299
Vinit Nayaka406f722019-12-19 11:50:55 -08001300 if (((initialScroll >= maxScroll) && (isVelocityLeft || !isFling)) ||
1301 ((initialScroll <= minScroll) && (!isVelocityLeft || !isFling))) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001302 mScroller.springBack(initialScroll, 0, minScroll, maxScroll, 0, 0);
Alex Chaub794ea62021-02-03 18:00:30 +00001303 mNextPage = getDestinationPage();
Sunny Goyalb7b01352018-08-09 12:31:20 -07001304 } else {
Sunny Goyalc39db732021-04-03 01:20:21 -07001305 int velocity1 = -velocity;
1306 // Continue a scroll or fling in progress
1307 mScroller.fling(initialScroll, 0, velocity1, 0, minScroll, maxScroll, 0, 0,
1308 Math.round(getWidth() * 0.5f * OVERSCROLL_DAMP_FACTOR), 0);
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001309
Sunny Goyalc39db732021-04-03 01:20:21 -07001310 int finalPos = mScroller.getFinalX();
Alex Chaub794ea62021-02-03 18:00:30 +00001311 mNextPage = getDestinationPage(finalPos);
Sunny Goyalc39db732021-04-03 01:20:21 -07001312 onNotSnappingToPageInFreeScroll();
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001313 }
1314 invalidate();
Winson Chung321e9ee2010-08-09 13:37:56 -07001315 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001316 }
Adam Cohen7d30a372013-07-01 17:03:59 -07001317
Sunny Goyalc39db732021-04-03 01:20:21 -07001318 mEdgeGlowLeft.onRelease();
1319 mEdgeGlowRight.onRelease();
Adam Cohen7d30a372013-07-01 17:03:59 -07001320 // End any intermediate reordering states
1321 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001322 break;
1323
1324 case MotionEvent.ACTION_CANCEL:
Sunny Goyalaad33592018-08-07 17:20:35 -07001325 if (mIsBeingDragged) {
Michael Jurkab8f06722010-10-10 15:58:46 -07001326 snapToDestination();
1327 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001328 mEdgeGlowLeft.onRelease();
1329 mEdgeGlowRight.onRelease();
Adam Cohen7d30a372013-07-01 17:03:59 -07001330 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001331 break;
1332
1333 case MotionEvent.ACTION_POINTER_UP:
1334 onSecondaryPointerUp(ev);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001335 releaseVelocityTracker();
Winson Chung321e9ee2010-08-09 13:37:56 -07001336 break;
1337 }
1338
1339 return true;
1340 }
1341
Sunny Goyalc39db732021-04-03 01:20:21 -07001342 protected void onNotSnappingToPageInFreeScroll() { }
Alex Chaub794ea62021-02-03 18:00:30 +00001343
Vinit Nayaka406f722019-12-19 11:50:55 -08001344 protected boolean shouldFlingForVelocity(int velocity) {
Winson Chung4941f652020-06-18 15:11:53 -07001345 float threshold = mAllowEasyFling ? mEasyFlingThresholdVelocity : mFlingThresholdVelocity;
1346 return Math.abs(velocity) > threshold;
Sunny Goyal65d9ceb2017-05-08 09:17:42 -07001347 }
1348
Adam Cohen7d30a372013-07-01 17:03:59 -07001349 private void resetTouchState() {
1350 releaseVelocityTracker();
Sunny Goyalaad33592018-08-07 17:20:35 -07001351 mIsBeingDragged = false;
Adam Cohen7d30a372013-07-01 17:03:59 -07001352 mActivePointerId = INVALID_POINTER;
Adam Cohen7d30a372013-07-01 17:03:59 -07001353 }
1354
Winson Chung185d7162011-02-28 13:47:29 -08001355 @Override
1356 public boolean onGenericMotionEvent(MotionEvent event) {
1357 if ((event.getSource() & InputDevice.SOURCE_CLASS_POINTER) != 0) {
1358 switch (event.getAction()) {
1359 case MotionEvent.ACTION_SCROLL: {
1360 // Handle mouse (or ext. device) by shifting the page depending on the scroll
1361 final float vscroll;
1362 final float hscroll;
1363 if ((event.getMetaState() & KeyEvent.META_SHIFT_ON) != 0) {
1364 vscroll = 0;
1365 hscroll = event.getAxisValue(MotionEvent.AXIS_VSCROLL);
1366 } else {
1367 vscroll = -event.getAxisValue(MotionEvent.AXIS_VSCROLL);
1368 hscroll = event.getAxisValue(MotionEvent.AXIS_HSCROLL);
1369 }
Sunny Goyal8b37c572020-03-31 12:12:14 -07001370 if (!canScroll(Math.abs(vscroll), Math.abs(hscroll))) {
1371 return false;
Samuel Fufa59cba192019-08-22 18:31:34 -07001372 }
Winson Chung185d7162011-02-28 13:47:29 -08001373 if (hscroll != 0 || vscroll != 0) {
Sunny Goyal70660032015-05-14 00:07:08 -07001374 boolean isForwardScroll = mIsRtl ? (hscroll < 0 || vscroll < 0)
Adam Cohen0ffac432013-07-10 11:19:26 -07001375 : (hscroll > 0 || vscroll > 0);
1376 if (isForwardScroll) {
Winson Chung185d7162011-02-28 13:47:29 -08001377 scrollRight();
1378 } else {
1379 scrollLeft();
1380 }
1381 return true;
1382 }
1383 }
1384 }
1385 }
1386 return super.onGenericMotionEvent(event);
1387 }
1388
Sunny Goyal8b37c572020-03-31 12:12:14 -07001389 /**
1390 * Returns true if the paged view can scroll for the provided vertical and horizontal
1391 * scroll values
1392 */
1393 protected boolean canScroll(float absVScroll, float absHScroll) {
1394 ActivityContext ac = ActivityContext.lookupContext(getContext());
1395 return (ac == null || AbstractFloatingView.getTopOpenView(ac) == null);
Samuel Fufa59cba192019-08-22 18:31:34 -07001396 }
1397
Michael Jurkab8f06722010-10-10 15:58:46 -07001398 private void acquireVelocityTrackerAndAddMovement(MotionEvent ev) {
1399 if (mVelocityTracker == null) {
1400 mVelocityTracker = VelocityTracker.obtain();
1401 }
1402 mVelocityTracker.addMovement(ev);
1403 }
1404
1405 private void releaseVelocityTracker() {
1406 if (mVelocityTracker != null) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001407 mVelocityTracker.clear();
Michael Jurkab8f06722010-10-10 15:58:46 -07001408 mVelocityTracker.recycle();
1409 mVelocityTracker = null;
1410 }
1411 }
1412
Winson Chung321e9ee2010-08-09 13:37:56 -07001413 private void onSecondaryPointerUp(MotionEvent ev) {
Winson Chung4941f652020-06-18 15:11:53 -07001414 final int pointerIndex = ev.getActionIndex();
Winson Chung321e9ee2010-08-09 13:37:56 -07001415 final int pointerId = ev.getPointerId(pointerIndex);
1416 if (pointerId == mActivePointerId) {
1417 // This was our active pointer going up. Choose a new
1418 // active pointer and adjust accordingly.
1419 // TODO: Make this decision more intelligent.
1420 final int newPointerIndex = pointerIndex == 0 ? 1 : 0;
Vinit Nayaka406f722019-12-19 11:50:55 -08001421 mLastMotion = mDownMotionPrimary = mOrientationHandler.getPrimaryDirection(ev,
1422 newPointerIndex);
1423 mLastMotionRemainder = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -07001424 mActivePointerId = ev.getPointerId(newPointerIndex);
1425 if (mVelocityTracker != null) {
1426 mVelocityTracker.clear();
1427 }
1428 }
Jeff Brown1d0867c2010-12-02 18:27:39 -08001429 }
1430
Winson Chung321e9ee2010-08-09 13:37:56 -07001431 @Override
1432 public void requestChildFocus(View child, View focused) {
1433 super.requestChildFocus(child, focused);
Andras Kloczl359d1ae2021-05-04 22:25:27 +02001434
1435 // In case the device is controlled by a controller, mCurrentPage isn't updated properly
1436 // which results in incorrect navigation
1437 int nextPage = getNextPage();
1438 if (nextPage != mCurrentPage) {
1439 setCurrentPage(nextPage);
1440 }
1441
Adam Cohenae4f1552011-10-20 00:15:42 -07001442 int page = indexToPage(indexOfChild(child));
Winson Chung97d85d22011-04-13 11:27:36 -07001443 if (page >= 0 && page != getCurrentPage() && !isInTouchMode()) {
Winson Chung86f77532010-08-24 11:08:22 -07001444 snapToPage(page);
Winson Chung321e9ee2010-08-09 13:37:56 -07001445 }
1446 }
1447
Alex Chaub794ea62021-02-03 18:00:30 +00001448 public int getDestinationPage() {
1449 return getDestinationPage(mOrientationHandler.getPrimaryScroll(this));
1450 }
1451
Alex Chaudedbc8a2021-03-17 16:53:26 +00001452 protected int getDestinationPage(int primaryScroll) {
1453 return getPageNearestToCenterOfScreen(primaryScroll);
Alex Chaub794ea62021-02-03 18:00:30 +00001454 }
1455
Sunny Goyal228153d2018-01-04 15:35:22 -08001456 public int getPageNearestToCenterOfScreen() {
Vinit Nayaka406f722019-12-19 11:50:55 -08001457 return getPageNearestToCenterOfScreen(mOrientationHandler.getPrimaryScroll(this));
Tony Wickham8f7ead32016-04-07 18:46:44 -07001458 }
1459
Alex Chaudedbc8a2021-03-17 16:53:26 +00001460 private int getPageNearestToCenterOfScreen(int primaryScroll) {
1461 int screenCenter = getScreenCenter(primaryScroll);
Adam Cohen22f823d2011-09-01 17:22:18 -07001462 int minDistanceFromScreenCenter = Integer.MAX_VALUE;
Winson Chung321e9ee2010-08-09 13:37:56 -07001463 int minDistanceFromScreenCenterIndex = -1;
Winson Chung321e9ee2010-08-09 13:37:56 -07001464 final int childCount = getChildCount();
1465 for (int i = 0; i < childCount; ++i) {
Tony Wickham7383d4e2020-07-07 19:25:25 -07001466 int distanceFromScreenCenter = Math.abs(
1467 getDisplacementFromScreenCenter(i, screenCenter));
Winson Chung321e9ee2010-08-09 13:37:56 -07001468 if (distanceFromScreenCenter < minDistanceFromScreenCenter) {
1469 minDistanceFromScreenCenter = distanceFromScreenCenter;
1470 minDistanceFromScreenCenterIndex = i;
1471 }
1472 }
Adam Cohend19d3ca2010-09-15 14:43:42 -07001473 return minDistanceFromScreenCenterIndex;
1474 }
1475
Tony Wickham7383d4e2020-07-07 19:25:25 -07001476 private int getDisplacementFromScreenCenter(int childIndex, int screenCenter) {
Alex Chaudedbc8a2021-03-17 16:53:26 +00001477 int childSize = Math.round(getChildVisibleSize(childIndex));
Tony Wickham7383d4e2020-07-07 19:25:25 -07001478 int halfChildSize = (childSize / 2);
1479 int childCenter = getChildOffset(childIndex) + halfChildSize;
1480 return childCenter - screenCenter;
1481 }
1482
1483 protected int getDisplacementFromScreenCenter(int childIndex) {
Alex Chaudedbc8a2021-03-17 16:53:26 +00001484 int primaryScroll = mOrientationHandler.getPrimaryScroll(this);
1485 int screenCenter = getScreenCenter(primaryScroll);
Tony Wickham7383d4e2020-07-07 19:25:25 -07001486 return getDisplacementFromScreenCenter(childIndex, screenCenter);
1487 }
1488
Alex Chaudedbc8a2021-03-17 16:53:26 +00001489 private int getScreenCenter(int primaryScroll) {
1490 float primaryScale = mOrientationHandler.getPrimaryScale(this);
1491 float primaryPivot = mOrientationHandler.getPrimaryValue(getPivotX(), getPivotY());
1492 int pageOrientationSize = mOrientationHandler.getMeasuredSize(this);
1493 return Math.round(primaryScroll + (pageOrientationSize / 2f - primaryPivot) / primaryScale
1494 + primaryPivot);
1495 }
1496
Adam Cohend19d3ca2010-09-15 14:43:42 -07001497 protected void snapToDestination() {
Sunny Goyalc39db732021-04-03 01:20:21 -07001498 snapToPage(getDestinationPage(), PAGE_SNAP_ANIMATION_DURATION);
Winson Chung321e9ee2010-08-09 13:37:56 -07001499 }
1500
Adam Cohene0f66b52010-11-23 15:06:07 -08001501 // We want the duration of the page snap animation to be influenced by the distance that
1502 // the screen has to travel, however, we don't want this duration to be effected in a
1503 // purely linear fashion. Instead, we use this method to moderate the effect that the distance
1504 // of travel has on the overall snap duration.
Sunny Goyal4d113a52015-05-27 10:05:28 -07001505 private float distanceInfluenceForSnapDuration(float f) {
Adam Cohene0f66b52010-11-23 15:06:07 -08001506 f -= 0.5f; // center the values about 0.
1507 f *= 0.3f * Math.PI / 2.0f;
1508 return (float) Math.sin(f);
1509 }
1510
Winson Chung05a31ed2018-02-08 17:08:43 -08001511 protected boolean snapToPageWithVelocity(int whichPage, int velocity) {
Adam Cohen6f127a62014-06-12 14:54:41 -07001512 whichPage = validateNewPage(whichPage);
Vinit Nayaka406f722019-12-19 11:50:55 -08001513 int halfScreenSize = mOrientationHandler.getMeasuredSize(this) / 2;
Adam Cohene0f66b52010-11-23 15:06:07 -08001514
Vinit Nayaka406f722019-12-19 11:50:55 -08001515 final int newLoc = getScrollForPage(whichPage);
Sunny Goyalc39db732021-04-03 01:20:21 -07001516 int delta = newLoc - mOrientationHandler.getPrimaryScroll(this);
Adam Cohene0f66b52010-11-23 15:06:07 -08001517 int duration = 0;
1518
Sunny Goyal4d113a52015-05-27 10:05:28 -07001519 if (Math.abs(velocity) < mMinFlingVelocity) {
Adam Cohene0f66b52010-11-23 15:06:07 -08001520 // If the velocity is low enough, then treat this more as an automatic page advance
1521 // as opposed to an apparent physical response to flinging
Winson Chung05a31ed2018-02-08 17:08:43 -08001522 return snapToPage(whichPage, PAGE_SNAP_ANIMATION_DURATION);
Adam Cohene0f66b52010-11-23 15:06:07 -08001523 }
1524
1525 // Here we compute a "distance" that will be used in the computation of the overall
1526 // snap duration. This is a function of the actual distance that needs to be traveled;
1527 // we keep this value close to half screen size in order to reduce the variance in snap
1528 // duration as a function of the distance the page needs to travel.
Michael Jurka20b7ca92011-06-07 20:09:16 -07001529 float distanceRatio = Math.min(1f, 1.0f * Math.abs(delta) / (2 * halfScreenSize));
Adam Cohene0f66b52010-11-23 15:06:07 -08001530 float distance = halfScreenSize + halfScreenSize *
1531 distanceInfluenceForSnapDuration(distanceRatio);
1532
1533 velocity = Math.abs(velocity);
Adam Cohen265b9a62011-12-07 14:37:18 -08001534 velocity = Math.max(mMinSnapVelocity, velocity);
Adam Cohene0f66b52010-11-23 15:06:07 -08001535
1536 // we want the page's snap velocity to approximately match the velocity at which the
1537 // user flings, so we scale the duration by a value near to the derivative of the scroll
Michael Jurka20b7ca92011-06-07 20:09:16 -07001538 // interpolator at zero, ie. 5. We use 4 to make it a little slower.
1539 duration = 4 * Math.round(1000 * Math.abs(distance / velocity));
Adam Cohene0f66b52010-11-23 15:06:07 -08001540
Sunny Goyalc39db732021-04-03 01:20:21 -07001541 return snapToPage(whichPage, delta, duration);
Michael Jurka0142d492010-08-25 17:46:15 -07001542 }
1543
Winson Chung05a31ed2018-02-08 17:08:43 -08001544 public boolean snapToPage(int whichPage) {
1545 return snapToPage(whichPage, PAGE_SNAP_ANIMATION_DURATION);
Winson Chung321e9ee2010-08-09 13:37:56 -07001546 }
1547
Winson Chung05a31ed2018-02-08 17:08:43 -08001548 public boolean snapToPageImmediately(int whichPage) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001549 return snapToPage(whichPage, PAGE_SNAP_ANIMATION_DURATION, true);
Adam Cohen7d30a372013-07-01 17:03:59 -07001550 }
1551
Winson Chung05a31ed2018-02-08 17:08:43 -08001552 public boolean snapToPage(int whichPage, int duration) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001553 return snapToPage(whichPage, duration, false);
Adam Cohen7d30a372013-07-01 17:03:59 -07001554 }
1555
Sunny Goyalc39db732021-04-03 01:20:21 -07001556 protected boolean snapToPage(int whichPage, int duration, boolean immediate) {
Adam Cohen6f127a62014-06-12 14:54:41 -07001557 whichPage = validateNewPage(whichPage);
Winson Chung321e9ee2010-08-09 13:37:56 -07001558
Vinit Nayaka406f722019-12-19 11:50:55 -08001559 int newLoc = getScrollForPage(whichPage);
Sunny Goyalc39db732021-04-03 01:20:21 -07001560 final int delta = newLoc - mOrientationHandler.getPrimaryScroll(this);
1561 return snapToPage(whichPage, delta, duration, immediate);
Michael Jurka0142d492010-08-25 17:46:15 -07001562 }
1563
Winson Chung05a31ed2018-02-08 17:08:43 -08001564 protected boolean snapToPage(int whichPage, int delta, int duration) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001565 return snapToPage(whichPage, delta, duration, false);
Adam Cohen7d30a372013-07-01 17:03:59 -07001566 }
Michael Jurka0142d492010-08-25 17:46:15 -07001567
Sunny Goyalc39db732021-04-03 01:20:21 -07001568 protected boolean snapToPage(int whichPage, int delta, int duration, boolean immediate) {
Sunny Goyal9bb8ffb2018-05-24 17:11:16 -07001569 if (mFirstLayout) {
1570 setCurrentPage(whichPage);
1571 return false;
1572 }
Tony Wickhamd58c2d52018-05-04 12:10:55 -07001573
Zak Cohen3eeb41d2020-02-14 14:15:13 -08001574 if (FeatureFlags.IS_STUDIO_BUILD) {
Tony Wickhamcb3f8702018-08-27 17:36:03 -07001575 duration *= Settings.Global.getFloat(getContext().getContentResolver(),
1576 Settings.Global.WINDOW_ANIMATION_SCALE, 1);
Tony Wickhamd58c2d52018-05-04 12:10:55 -07001577 }
1578
Adam Cohen6f127a62014-06-12 14:54:41 -07001579 whichPage = validateNewPage(whichPage);
1580
Adam Cohen7d30a372013-07-01 17:03:59 -07001581 mNextPage = whichPage;
Michael Jurka0142d492010-08-25 17:46:15 -07001582
Winson Chung321e9ee2010-08-09 13:37:56 -07001583 awakenScrollBars(duration);
Adam Cohen7d30a372013-07-01 17:03:59 -07001584 if (immediate) {
1585 duration = 0;
1586 } else if (duration == 0) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001587 duration = Math.abs(delta);
1588 }
1589
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001590 if (duration != 0) {
1591 pageBeginTransition();
1592 }
1593
Adam Cohenf358a4b2013-07-23 16:47:31 -07001594 if (!mScroller.isFinished()) {
Adam Cohenf9618852013-11-08 06:45:03 -08001595 abortScrollerAnimation(false);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001596 }
Adam Cohenf9618852013-11-08 06:45:03 -08001597
Sunny Goyalc39db732021-04-03 01:20:21 -07001598 mScroller.startScroll(mOrientationHandler.getPrimaryScroll(this), 0, delta, 0, duration);
Adam Cohen674531f2013-12-13 15:07:14 -08001599 updatePageIndicator();
Adam Cohen7d30a372013-07-01 17:03:59 -07001600
1601 // Trigger a compute() to finish switching pages if necessary
1602 if (immediate) {
1603 computeScroll();
Sunny Goyal76dbf6f2017-01-03 14:55:47 -08001604 pageEndTransition();
Adam Cohen7d30a372013-07-01 17:03:59 -07001605 }
1606
Winson Chung321e9ee2010-08-09 13:37:56 -07001607 invalidate();
Winson Chung05a31ed2018-02-08 17:08:43 -08001608 return Math.abs(delta) > 0;
Winson Chung321e9ee2010-08-09 13:37:56 -07001609 }
1610
Vadim Tryshev98913d02018-05-18 18:41:34 -07001611 public boolean scrollLeft() {
1612 if (getNextPage() > 0) {
1613 snapToPage(getNextPage() - 1);
1614 return true;
1615 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001616 return mAllowOverScroll;
Winson Chung321e9ee2010-08-09 13:37:56 -07001617 }
1618
Vadim Tryshev98913d02018-05-18 18:41:34 -07001619 public boolean scrollRight() {
1620 if (getNextPage() < getChildCount() - 1) {
1621 snapToPage(getNextPage() + 1);
1622 return true;
1623 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001624 return mAllowOverScroll;
Winson Chung321e9ee2010-08-09 13:37:56 -07001625 }
1626
Vadim Trysheve6bbefb2018-04-03 13:38:06 -07001627 @Override
1628 public CharSequence getAccessibilityClassName() {
1629 // Some accessibility services have special logic for ScrollView. Since we provide same
1630 // accessibility info as ScrollView, inform the service to handle use the same way.
1631 return ScrollView.class.getName();
1632 }
1633
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001634 protected boolean isPageOrderFlipped() {
1635 return false;
1636 }
1637
Winson Chung6a0f57d2011-06-29 20:10:49 -07001638 /* Accessibility */
Sunny Goyalcf25b522015-07-09 00:01:18 -07001639 @SuppressWarnings("deprecation")
Winson Chung6a0f57d2011-06-29 20:10:49 -07001640 @Override
1641 public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) {
1642 super.onInitializeAccessibilityNodeInfo(info);
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001643 final boolean pagesFlipped = isPageOrderFlipped();
Pinyao Tingaf6daa22019-09-18 22:18:03 +00001644 int offset = (mAllowOverScroll ? 0 : 1);
1645 info.setScrollable(getPageCount() > offset);
1646 if (getCurrentPage() < getPageCount() - offset) {
yingleiw02cc8482019-08-02 16:14:27 -07001647 info.addAction(pagesFlipped ?
1648 AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_BACKWARD
1649 : AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_FORWARD);
1650 info.addAction(mIsRtl ?
1651 AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_LEFT
1652 : AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_RIGHT);
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001653 }
Pinyao Tingaf6daa22019-09-18 22:18:03 +00001654 if (getCurrentPage() >= offset) {
yingleiw02cc8482019-08-02 16:14:27 -07001655 info.addAction(pagesFlipped ?
1656 AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_FORWARD
1657 : AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_BACKWARD);
1658 info.addAction(mIsRtl ?
1659 AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_RIGHT
1660 : AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_LEFT);
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001661 }
Vadim Tryshev7af0d442015-05-15 08:48:11 -07001662 // Accessibility-wise, PagedView doesn't support long click, so disabling it.
1663 // Besides disabling the accessibility long-click, this also prevents this view from getting
1664 // accessibility focus.
1665 info.setLongClickable(false);
Sunny Goyala52ecb02016-12-16 15:04:51 -08001666 info.removeAction(AccessibilityNodeInfo.AccessibilityAction.ACTION_LONG_CLICK);
Winson Chung6a0f57d2011-06-29 20:10:49 -07001667 }
1668
1669 @Override
Alan Viverette254139a2013-10-08 13:13:46 -07001670 public void sendAccessibilityEvent(int eventType) {
1671 // Don't let the view send real scroll events.
1672 if (eventType != AccessibilityEvent.TYPE_VIEW_SCROLLED) {
1673 super.sendAccessibilityEvent(eventType);
1674 }
1675 }
1676
1677 @Override
Winson Chung6a0f57d2011-06-29 20:10:49 -07001678 public void onInitializeAccessibilityEvent(AccessibilityEvent event) {
1679 super.onInitializeAccessibilityEvent(event);
Pinyao Tingaf6daa22019-09-18 22:18:03 +00001680 event.setScrollable(mAllowOverScroll || getPageCount() > 1);
Winson Chung6a0f57d2011-06-29 20:10:49 -07001681 }
1682
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001683 @Override
1684 public boolean performAccessibilityAction(int action, Bundle arguments) {
1685 if (super.performAccessibilityAction(action, arguments)) {
1686 return true;
1687 }
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001688 final boolean pagesFlipped = isPageOrderFlipped();
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001689 switch (action) {
1690 case AccessibilityNodeInfo.ACTION_SCROLL_FORWARD: {
Vadim Tryshev98913d02018-05-18 18:41:34 -07001691 if (pagesFlipped ? scrollLeft() : scrollRight()) {
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001692 return true;
1693 }
1694 } break;
1695 case AccessibilityNodeInfo.ACTION_SCROLL_BACKWARD: {
Vadim Tryshev98913d02018-05-18 18:41:34 -07001696 if (pagesFlipped ? scrollRight() : scrollLeft()) {
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001697 return true;
1698 }
yingleiw02cc8482019-08-02 16:14:27 -07001699 } break;
1700 case android.R.id.accessibilityActionPageRight: {
1701 if (!mIsRtl) {
1702 return scrollRight();
1703 } else {
1704 return scrollLeft();
1705 }
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001706 }
yingleiw02cc8482019-08-02 16:14:27 -07001707 case android.R.id.accessibilityActionPageLeft: {
1708 if (!mIsRtl) {
1709 return scrollLeft();
1710 } else {
1711 return scrollRight();
1712 }
1713 }
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001714 }
1715 return false;
1716 }
1717
Vadim Tryshev2c430b32018-04-04 14:45:21 -07001718 protected boolean canAnnouncePageDescription() {
1719 return true;
1720 }
1721
Adam Cohen0ffac432013-07-10 11:19:26 -07001722 protected String getCurrentPageDescription() {
Sunny Goyalf4f89ef2015-09-02 15:06:12 -07001723 return getContext().getString(R.string.default_scroll_format,
Adam Cohen0ffac432013-07-10 11:19:26 -07001724 getNextPage() + 1, getChildCount());
1725 }
1726
Tony Mak2e564402018-02-27 17:19:34 +00001727 protected float getDownMotionX() {
1728 return mDownMotionX;
1729 }
1730
1731 protected float getDownMotionY() {
1732 return mDownMotionY;
1733 }
1734
Sunny Goyal20a13ff2018-03-13 16:44:00 -07001735 protected interface ComputePageScrollsLogic {
1736
1737 boolean shouldIncludeView(View view);
1738 }
Vadim Tryshev528b9e02018-05-24 18:22:03 -07001739
1740 public int[] getVisibleChildrenRange() {
1741 float visibleLeft = 0;
1742 float visibleRight = visibleLeft + getMeasuredWidth();
1743 float scaleX = getScaleX();
1744 if (scaleX < 1 && scaleX > 0) {
1745 float mid = getMeasuredWidth() / 2;
1746 visibleLeft = mid - ((mid - visibleLeft) / scaleX);
1747 visibleRight = mid + ((visibleRight - mid) / scaleX);
1748 }
1749
1750 int leftChild = -1;
1751 int rightChild = -1;
1752 final int childCount = getChildCount();
1753 for (int i = 0; i < childCount; i++) {
1754 final View child = getPageAt(i);
1755
1756 float left = child.getLeft() + child.getTranslationX() - getScrollX();
1757 if (left <= visibleRight && (left + child.getMeasuredWidth()) >= visibleLeft) {
1758 if (leftChild == -1) {
1759 leftChild = i;
1760 }
1761 rightChild = i;
1762 }
1763 }
1764 mTmpIntPair[0] = leftChild;
1765 mTmpIntPair[1] = rightChild;
1766 return mTmpIntPair;
1767 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001768
1769 @Override
1770 public void draw(Canvas canvas) {
1771 super.draw(canvas);
1772 drawEdgeEffect(canvas);
Sunny Goyal05b59c02021-04-29 13:55:40 -07001773 pageEndTransition();
Sunny Goyalc39db732021-04-03 01:20:21 -07001774 }
1775
1776 protected void drawEdgeEffect(Canvas canvas) {
1777 if (mAllowOverScroll && (!mEdgeGlowRight.isFinished() || !mEdgeGlowLeft.isFinished())) {
1778 final int width = getWidth();
1779 final int height = getHeight();
1780 if (!mEdgeGlowLeft.isFinished()) {
1781 final int restoreCount = canvas.save();
1782 canvas.rotate(-90);
1783 canvas.translate(-height, Math.min(mMinScroll, getScrollX()));
1784 mEdgeGlowLeft.setSize(height, width);
1785 if (mEdgeGlowLeft.draw(canvas)) {
1786 postInvalidateOnAnimation();
1787 }
1788 canvas.restoreToCount(restoreCount);
1789 }
1790 if (!mEdgeGlowRight.isFinished()) {
1791 final int restoreCount = canvas.save();
1792 canvas.rotate(90, width, 0);
1793 canvas.translate(width, -(Math.max(mMaxScroll, getScrollX())));
1794
1795 mEdgeGlowRight.setSize(height, width);
1796 if (mEdgeGlowRight.draw(canvas)) {
1797 postInvalidateOnAnimation();
1798 }
1799 canvas.restoreToCount(restoreCount);
1800 }
1801 }
1802 }
Adam Cohen5084cba2013-09-03 12:01:16 -07001803}