blob: 43dca5cedecb57998f36bfe67fb794ad6763d9cd [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
Kateryna Ivanova71203732023-05-24 15:09:00 +000019import static com.android.app.animation.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;
Jagrut Desai311d5192023-09-13 10:18:02 -070022import static com.android.launcher3.testing.shared.TestProtocol.SCROLL_FINISHED_MESSAGE;
Sunny Goyal8b37c572020-03-31 12:12:14 -070023import static com.android.launcher3.touch.OverScroll.OVERSCROLL_DAMP_FACTOR;
Sunny Goyal8b37c572020-03-31 12:12:14 -070024import static com.android.launcher3.touch.PagedOrientationHandler.VIEW_SCROLL_BY;
25import static com.android.launcher3.touch.PagedOrientationHandler.VIEW_SCROLL_TO;
26
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -070027import android.animation.LayoutTransition;
Sunny Goyalcf25b522015-07-09 00:01:18 -070028import android.annotation.SuppressLint;
Winson Chung321e9ee2010-08-09 13:37:56 -070029import android.content.Context;
Andras Kloczlc2bd15f2022-03-30 18:06:13 +010030import android.content.res.Configuration;
31import android.content.res.Resources;
Adam Cohen9c4949e2010-10-05 12:27:22 -070032import android.content.res.TypedArray;
Jon Miranda71cb80c2019-01-24 21:25:13 -080033import android.graphics.Canvas;
Winson Chung321e9ee2010-08-09 13:37:56 -070034import android.graphics.Rect;
Svetoslav Ganov08055f62012-05-15 11:06:36 -070035import android.os.Bundle;
Tony Wickhamd58c2d52018-05-04 12:10:55 -070036import android.provider.Settings;
Winson Chung321e9ee2010-08-09 13:37:56 -070037import android.util.AttributeSet;
Winson Chung785d2eb2011-04-14 16:08:02 -070038import android.util.Log;
Winson Chung185d7162011-02-28 13:47:29 -080039import android.view.InputDevice;
40import android.view.KeyEvent;
Winson Chung321e9ee2010-08-09 13:37:56 -070041import android.view.MotionEvent;
42import android.view.VelocityTracker;
43import android.view.View;
44import android.view.ViewConfiguration;
Sunny Goyal4ffec482016-02-09 11:28:52 -080045import android.view.ViewDebug;
Winson Chung321e9ee2010-08-09 13:37:56 -070046import android.view.ViewGroup;
47import android.view.ViewParent;
Winson Chung6a0f57d2011-06-29 20:10:49 -070048import android.view.accessibility.AccessibilityEvent;
49import android.view.accessibility.AccessibilityNodeInfo;
Sunny Goyalc39db732021-04-03 01:20:21 -070050import android.widget.OverScroller;
Vadim Trysheve6bbefb2018-04-03 13:38:06 -070051import android.widget.ScrollView;
Tony Wickhamf549dab2016-05-16 09:54:06 -070052
Tony Wickham62117d72020-03-26 16:56:26 -070053import androidx.annotation.Nullable;
54
Jon Miranda9e198662020-03-11 14:42:02 -070055import com.android.launcher3.compat.AccessibilityManagerCompat;
56import com.android.launcher3.config.FeatureFlags;
Jon Miranda9e198662020-03-11 14:42:02 -070057import com.android.launcher3.pageindicators.PageIndicator;
Jon Miranda9e198662020-03-11 14:42:02 -070058import com.android.launcher3.touch.PagedOrientationHandler;
59import com.android.launcher3.touch.PagedOrientationHandler.ChildBounds;
Sunny Goyalc39db732021-04-03 01:20:21 -070060import com.android.launcher3.util.EdgeEffectCompat;
Andras Kloczl55edfe52021-05-14 12:21:30 +020061import com.android.launcher3.util.IntSet;
Jon Miranda9e198662020-03-11 14:42:02 -070062import com.android.launcher3.util.Thunk;
Sunny Goyal8b37c572020-03-31 12:12:14 -070063import com.android.launcher3.views.ActivityContext;
Jon Miranda9e198662020-03-11 14:42:02 -070064
65import java.util.ArrayList;
Sunny Goyal59969372021-05-06 12:11:44 -070066import java.util.function.Consumer;
Jon Miranda9e198662020-03-11 14:42:02 -070067
Winson Chung321e9ee2010-08-09 13:37:56 -070068/**
69 * An abstraction of the original Workspace which supports browsing through a
Michael Jurka0142d492010-08-25 17:46:15 -070070 * sequential list of "pages"
Winson Chung321e9ee2010-08-09 13:37:56 -070071 */
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -080072public abstract class PagedView<T extends View & PageIndicator> extends ViewGroup {
Winson Chung321e9ee2010-08-09 13:37:56 -070073 private static final String TAG = "PagedView";
Winson Chung785d2eb2011-04-14 16:08:02 -070074 private static final boolean DEBUG = false;
Winson Chung4941f652020-06-18 15:11:53 -070075 public static final boolean DEBUG_FAILED_QUICKSWITCH = false;
Sunny Goyal20a13ff2018-03-13 16:44:00 -070076
Winson Chung4941f652020-06-18 15:11:53 -070077 public static final int ACTION_MOVE_ALLOW_EASY_FLING = MotionEvent.ACTION_MASK - 1;
Sunny Goyala7a5bf32020-01-05 15:35:29 +053078 public static final int INVALID_PAGE = -1;
Sunny Goyal20a13ff2018-03-13 16:44:00 -070079 protected static final ComputePageScrollsLogic SIMPLE_SCROLL_LOGIC = (v) -> v.getVisibility() != GONE;
Winson Chung321e9ee2010-08-09 13:37:56 -070080
Adam Cohenb64cb5a2011-02-15 13:53:42 -080081 private static final float RETURN_TO_ORIGINAL_PAGE_THRESHOLD = 0.33f;
Adam Cohen00481b32011-11-18 12:03:48 -080082 // The page is moved more than halfway, automatically move to the next page on touch up.
83 private static final float SIGNIFICANT_MOVE_THRESHOLD = 0.4f;
Adam Cohen68d73932010-11-15 10:50:58 -080084
Sunny Goyal8e2133b2015-05-06 13:39:07 -070085 private static final float MAX_SCROLL_PROGRESS = 1.0f;
86
Adam Cohenf358a4b2013-07-23 16:47:31 -070087 private boolean mFreeScroll = false;
Adam Cohenf358a4b2013-07-23 16:47:31 -070088
Andras Kloczlc2bd15f2022-03-30 18:06:13 +010089 private int mFlingThresholdVelocity;
90 private int mEasyFlingThresholdVelocity;
91 private int mMinFlingVelocity;
92 private int mMinSnapVelocity;
93 private int mPageSnapAnimationDuration;
Michael Jurka0142d492010-08-25 17:46:15 -070094
Michael Jurka0142d492010-08-25 17:46:15 -070095 protected boolean mFirstLayout = true;
96
Sunny Goyal4ffec482016-02-09 11:28:52 -080097 @ViewDebug.ExportedProperty(category = "launcher")
Michael Jurka0142d492010-08-25 17:46:15 -070098 protected int mCurrentPage;
Alex Chauba61b982021-06-15 16:29:19 +010099 // Difference between current scroll position and mCurrentPage's page scroll. Used to maintain
100 // relative scroll position unchanged in updateCurrentPageScroll. Cleared when snapping to a
101 // page.
102 protected int mCurrentPageScrollDiff;
Lais Andradecc5c8842021-06-04 18:20:30 +0100103 // The current page the PagedView is scrolling over on it's way to the destination page.
104 protected int mCurrentScrollOverPage;
Adam Cohene61a9a22013-06-11 15:45:31 -0700105
Sunny Goyal4ffec482016-02-09 11:28:52 -0800106 @ViewDebug.ExportedProperty(category = "launcher")
Michael Jurka0142d492010-08-25 17:46:15 -0700107 protected int mNextPage = INVALID_PAGE;
Vinit Nayaka406f722019-12-19 11:50:55 -0800108 protected int mMaxScroll;
109 protected int mMinScroll;
Sunny Goyalb7b01352018-08-09 12:31:20 -0700110 protected OverScroller mScroller;
Winson Chung321e9ee2010-08-09 13:37:56 -0700111 private VelocityTracker mVelocityTracker;
Sunny Goyale15e2a82017-12-15 13:05:42 -0800112 protected int mPageSpacing = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -0700113
114 private float mDownMotionX;
Adam Cohen7d30a372013-07-01 17:03:59 -0700115 private float mDownMotionY;
Vinit Nayaka406f722019-12-19 11:50:55 -0800116 private float mDownMotionPrimary;
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -0700117 private int mLastMotion;
Vinit Nayaka406f722019-12-19 11:50:55 -0800118 private float mTotalMotion;
Winson Chung4941f652020-06-18 15:11:53 -0700119 // Used in special cases where the fling checks can be relaxed for an intentional gesture
120 private boolean mAllowEasyFling;
Jordan Silva715e25a2024-01-30 18:02:27 +0000121 private PagedOrientationHandler mOrientationHandler =
122 PagedOrientationHandler.DEFAULT;
Adam Cohenedb40762013-07-18 16:45:45 -0700123
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700124 private final ArrayList<Runnable> mOnPageScrollsInitializedCallbacks = new ArrayList<>();
125
126 // We should always check pageScrollsInitialized() is true when using mPageScrolls.
127 @Nullable protected int[] mPageScrolls = null;
Sunny Goyalaad33592018-08-07 17:20:35 -0700128 private boolean mIsBeingDragged;
Adam Cohencae7f572013-11-04 14:42:52 -0800129
Winson Chung4941f652020-06-18 15:11:53 -0700130 // The amount of movement to begin scrolling
Michael Jurka7426c422010-11-11 15:23:47 -0800131 protected int mTouchSlop;
Winson Chung4941f652020-06-18 15:11:53 -0700132 // The amount of movement to begin paging
133 protected int mPageSlop;
Winson Chung321e9ee2010-08-09 13:37:56 -0700134 private int mMaximumVelocity;
Adam Cohen68d73932010-11-15 10:50:58 -0800135 protected boolean mAllowOverScroll = true;
Winson Chung321e9ee2010-08-09 13:37:56 -0700136
Michael Jurka5f1c5092010-09-03 14:15:02 -0700137 protected static final int INVALID_POINTER = -1;
Winson Chung321e9ee2010-08-09 13:37:56 -0700138
Michael Jurka5f1c5092010-09-03 14:15:02 -0700139 protected int mActivePointerId = INVALID_POINTER;
Winson Chung321e9ee2010-08-09 13:37:56 -0700140
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700141 protected boolean mIsPageInTransition = false;
Tony Wickham62117d72020-03-26 16:56:26 -0700142 private Runnable mOnPageTransitionEndCallback;
Patrick Dubroy1262e362010-10-06 15:49:50 -0700143
Winson Chungd2be3812013-07-16 11:11:32 -0700144 // Page Indicator
Adam Cohen091440a2015-03-18 14:16:05 -0700145 @Thunk int mPageIndicatorViewId;
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800146 protected T mPageIndicator;
Adam Cohen7d30a372013-07-01 17:03:59 -0700147
John Spurlock77e1f472013-09-11 10:09:51 -0400148 protected final Rect mInsets = new Rect();
Tony Wickhamdfb5cc92018-02-26 16:41:57 -0800149 protected boolean mIsRtl;
John Spurlock77e1f472013-09-11 10:09:51 -0400150
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800151 // Similar to the platform implementation of isLayoutValid();
152 protected boolean mIsLayoutValid;
153
Vadim Tryshev528b9e02018-05-24 18:22:03 -0700154 private int[] mTmpIntPair = new int[2];
155
Sunny Goyalc39db732021-04-03 01:20:21 -0700156 protected EdgeEffectCompat mEdgeGlowLeft;
157 protected EdgeEffectCompat mEdgeGlowRight;
158
Winson Chung321e9ee2010-08-09 13:37:56 -0700159 public PagedView(Context context) {
160 this(context, null);
161 }
162
163 public PagedView(Context context, AttributeSet attrs) {
164 this(context, attrs, 0);
165 }
166
167 public PagedView(Context context, AttributeSet attrs, int defStyle) {
168 super(context, attrs, defStyle);
Winson Chungc9ca2982013-07-19 12:07:38 -0700169
Adam Cohen9c4949e2010-10-05 12:27:22 -0700170 TypedArray a = context.obtainStyledAttributes(attrs,
171 R.styleable.PagedView, defStyle, 0);
Winson Chungd2be3812013-07-16 11:11:32 -0700172 mPageIndicatorViewId = a.getResourceId(R.styleable.PagedView_pageIndicator, -1);
Adam Cohen9c4949e2010-10-05 12:27:22 -0700173 a.recycle();
174
Winson Chung321e9ee2010-08-09 13:37:56 -0700175 setHapticFeedbackEnabled(false);
Sunny Goyal70660032015-05-14 00:07:08 -0700176 mIsRtl = Utilities.isRtl(getResources());
Winson Chung321e9ee2010-08-09 13:37:56 -0700177
Sunny Goyalc39db732021-04-03 01:20:21 -0700178 mScroller = new OverScroller(context, SCROLL);
Winson Chung86f77532010-08-24 11:08:22 -0700179 mCurrentPage = 0;
Lais Andradecc5c8842021-06-04 18:20:30 +0100180 mCurrentScrollOverPage = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -0700181
Vinit Nayaka406f722019-12-19 11:50:55 -0800182 final ViewConfiguration configuration = ViewConfiguration.get(context);
Winson Chung4941f652020-06-18 15:11:53 -0700183 mTouchSlop = configuration.getScaledTouchSlop();
184 mPageSlop = configuration.getScaledPagingTouchSlop();
Winson Chung321e9ee2010-08-09 13:37:56 -0700185 mMaximumVelocity = configuration.getScaledMaximumFlingVelocity();
Adam Cohen265b9a62011-12-07 14:37:18 -0800186
Andras Kloczlc2bd15f2022-03-30 18:06:13 +0100187 updateVelocityValues();
Sunny Goyala9f55462018-03-25 18:15:15 -0700188
Sunny Goyalc39db732021-04-03 01:20:21 -0700189 initEdgeEffect();
Sunny Goyaleaf7a952020-07-29 16:54:20 -0700190 setDefaultFocusHighlightEnabled(false);
Sunny Goyalc39db732021-04-03 01:20:21 -0700191 setWillNotDraw(false);
Winson Chung321e9ee2010-08-09 13:37:56 -0700192 }
193
Sunny Goyalc39db732021-04-03 01:20:21 -0700194 protected void initEdgeEffect() {
195 mEdgeGlowLeft = new EdgeEffectCompat(getContext());
196 mEdgeGlowRight = new EdgeEffectCompat(getContext());
Adam Cohenf9618852013-11-08 06:45:03 -0800197 }
198
Sunny Goyald0a6ae72016-06-16 12:29:03 -0700199 public void initParentViews(View parent) {
200 if (mPageIndicatorViewId > -1) {
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800201 mPageIndicator = parent.findViewById(mPageIndicatorViewId);
Tony Wickhambab101c2021-09-20 15:12:44 -0700202 mPageIndicator.setMarkersCount(getChildCount() / getPanelCount());
Winson Chungd2be3812013-07-16 11:11:32 -0700203 }
204 }
205
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800206 public T getPageIndicator() {
Adam Cohenedb40762013-07-18 16:45:45 -0700207 return mPageIndicator;
208 }
209
Adam Cohen674531f2013-12-13 15:07:14 -0800210 /**
Tony Wickham29d853c2015-09-08 10:35:56 -0700211 * Returns the index of the currently displayed page. When in free scroll mode, this is the page
212 * that the user was on before entering free scroll mode (e.g. the home screen page they
Alex Chaub794ea62021-02-03 18:00:30 +0000213 * long-pressed on to enter the overview). Try using {@link #getDestinationPage()}
Tony Wickham29d853c2015-09-08 10:35:56 -0700214 * to get the page the user is currently scrolling over.
Winson Chung321e9ee2010-08-09 13:37:56 -0700215 */
Sunny Goyal83a8f042015-05-19 12:52:12 -0700216 public int getCurrentPage() {
Winson Chung86f77532010-08-24 11:08:22 -0700217 return mCurrentPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700218 }
Adam Cohen7d30a372013-07-01 17:03:59 -0700219
Hyunyoung Songb76cd622015-04-16 14:34:09 -0700220 /**
221 * Returns the index of page to be shown immediately afterwards.
222 */
Vadim Tryshevfedca432015-08-19 17:55:02 -0700223 public int getNextPage() {
Winson Chung360e63f2012-04-27 13:48:05 -0700224 return (mNextPage != INVALID_PAGE) ? mNextPage : mCurrentPage;
225 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700226
Adam Cohenf9c184a2016-01-15 16:47:43 -0800227 public int getPageCount() {
Winson Chung321e9ee2010-08-09 13:37:56 -0700228 return getChildCount();
229 }
230
Sunny Goyal83a8f042015-05-19 12:52:12 -0700231 public View getPageAt(int index) {
Winson Chung321e9ee2010-08-09 13:37:56 -0700232 return getChildAt(index);
233 }
234
Jordan Silva715e25a2024-01-30 18:02:27 +0000235 protected PagedOrientationHandler getPagedOrientationHandler() {
236 return mOrientationHandler;
237 }
238
239 protected void setOrientationHandler(PagedOrientationHandler orientationHandler) {
240 this.mOrientationHandler = orientationHandler;
241 }
242
Winson Chung321e9ee2010-08-09 13:37:56 -0700243 /**
Winson Chungbbc60d82010-11-11 16:34:41 -0800244 * Updates the scroll of the current page immediately to its final scroll position. We use this
245 * in CustomizePagedView to allow tabs to share the same PagedView while resetting the scroll of
246 * the previous tab page.
247 */
248 protected void updateCurrentPageScroll() {
Adam Cohen0ffac432013-07-10 11:19:26 -0700249 // If the current page is invalid, just reset the scroll position to zero
Vinit Nayaka406f722019-12-19 11:50:55 -0800250 int newPosition = 0;
Adam Cohen0ffac432013-07-10 11:19:26 -0700251 if (0 <= mCurrentPage && mCurrentPage < getPageCount()) {
Alex Chauba61b982021-06-15 16:29:19 +0100252 newPosition = getScrollForPage(mCurrentPage) + mCurrentPageScrollDiff;
Adam Cohen0ffac432013-07-10 11:19:26 -0700253 }
Alex Chau6499e832021-11-19 14:35:46 +0000254 mOrientationHandler.setPrimary(this, VIEW_SCROLL_TO, newPosition);
Sunny Goyalc39db732021-04-03 01:20:21 -0700255 mScroller.startScroll(mScroller.getCurrX(), 0, newPosition - mScroller.getCurrX(), 0);
Tony Wickhamd5521322021-09-14 14:26:50 -0700256 forceFinishScroller();
Winson Chungbbc60d82010-11-11 16:34:41 -0800257 }
258
Tony Wickhamf8d731a2021-05-26 14:58:13 -0700259 /**
260 * Immediately finishes any overscroll effect and jumps to the end of the scroller animation.
261 */
262 public void abortScrollerAnimation() {
263 mEdgeGlowLeft.finish();
264 mEdgeGlowRight.finish();
265 abortScrollerAnimation(true);
266 }
267
Schneider Victor-tuliasa602a0a2022-09-06 13:34:00 -0700268 protected void onScrollerAnimationAborted() {
269 // No-Op
270 }
271
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700272 private void abortScrollerAnimation(boolean resetNextPage) {
Adam Cohen4fe4c932013-10-28 16:02:34 -0700273 mScroller.abortAnimation();
Schneider Victor-tuliasa602a0a2022-09-06 13:34:00 -0700274 onScrollerAnimationAborted();
Adam Cohen4fe4c932013-10-28 16:02:34 -0700275 // We need to clean up the next page here to avoid computeScrollHelper from
276 // updating current page on the pass.
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700277 if (resetNextPage) {
278 mNextPage = INVALID_PAGE;
Sunny Goyal857b1b92018-03-05 10:49:05 -0800279 pageEndTransition();
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700280 }
Chet Haasebc2f0822012-10-26 17:59:53 -0700281 }
Adam Cohen4fe4c932013-10-28 16:02:34 -0700282
Tony Wickhamd5521322021-09-14 14:26:50 -0700283 /**
284 * Immediately finishes any in-progress scroll, maintaining the current position. Also sets
285 * mNextPage = INVALID_PAGE and calls pageEndTransition().
286 */
287 public void forceFinishScroller() {
Adam Cohen4fe4c932013-10-28 16:02:34 -0700288 mScroller.forceFinished(true);
289 // We need to clean up the next page here to avoid computeScrollHelper from
290 // updating current page on the pass.
Tony Wickhamd5521322021-09-14 14:26:50 -0700291 mNextPage = INVALID_PAGE;
292 pageEndTransition();
Adam Cohen4fe4c932013-10-28 16:02:34 -0700293 }
294
Adam Cohen6f127a62014-06-12 14:54:41 -0700295 private int validateNewPage(int newPage) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700296 newPage = ensureWithinScrollBounds(newPage);
Adam Cohen6f127a62014-06-12 14:54:41 -0700297 // Ensure that it is clamped by the actual set of children in all cases
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100298 newPage = Utilities.boundToRange(newPage, 0, getPageCount() - 1);
299
300 if (getPanelCount() > 1) {
Alex Chau1e448462021-08-13 21:48:35 +0100301 // Always return left most panel as new page
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100302 newPage = getLeftmostVisiblePageForIndex(newPage);
303 }
304 return newPage;
305 }
306
Andras Kloczl55edfe52021-05-14 12:21:30 +0200307 /**
308 * In most cases where panelCount is 1, this method will just return the page index that was
309 * passed in.
310 * But for example when two panel home is enabled we might need the leftmost visible page index
311 * because that page is the current page.
312 */
313 public int getLeftmostVisiblePageForIndex(int pageIndex) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100314 int panelCount = getPanelCount();
Andras Kloczl55edfe52021-05-14 12:21:30 +0200315 return pageIndex - pageIndex % panelCount;
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100316 }
317
318 /**
319 * Returns the number of pages that are shown at the same time.
320 */
321 protected int getPanelCount() {
322 return 1;
323 }
324
325 /**
Andras Kloczl55edfe52021-05-14 12:21:30 +0200326 * Returns an IntSet with the indices of the currently visible pages
327 */
Andras Kloczl55edfe52021-05-14 12:21:30 +0200328 public IntSet getVisiblePageIndices() {
Andras Kloczl7e912442021-05-06 12:50:28 +0200329 return getPageIndices(mCurrentPage);
330 }
331
332 /**
333 * In case the panelCount is 1 this just returns the same page index in an IntSet.
334 * But in cases where the panelCount > 1 this will return all the page indices that belong
335 * together, i.e. on the Workspace they are next to each other and shown at the same time.
336 */
337 private IntSet getPageIndices(int pageIndex) {
338 // we want to make sure the pageIndex is the leftmost page
339 pageIndex = getLeftmostVisiblePageForIndex(pageIndex);
340
341 IntSet pageIndices = new IntSet();
Andras Kloczl55edfe52021-05-14 12:21:30 +0200342 int panelCount = getPanelCount();
343 int pageCount = getPageCount();
Andras Kloczl7e912442021-05-06 12:50:28 +0200344 for (int page = pageIndex; page < pageIndex + panelCount && page < pageCount; page++) {
345 pageIndices.add(page);
Andras Kloczl55edfe52021-05-14 12:21:30 +0200346 }
Andras Kloczl7e912442021-05-06 12:50:28 +0200347 return pageIndices;
348 }
349
350 /**
351 * Returns an IntSet with the indices of the neighbour pages that are in the focus direction.
352 */
353 private IntSet getNeighbourPageIndices(int focus) {
354 int panelCount = getPanelCount();
355 // getNextPage is more reliable than getCurrentPage
356 int currentPage = getNextPage();
357
358 int nextPage;
359 if (focus == View.FOCUS_LEFT) {
360 nextPage = currentPage - panelCount;
361 } else if (focus == View.FOCUS_RIGHT) {
362 nextPage = currentPage + panelCount;
363 } else {
Andras Kloczlb0632942021-08-03 14:03:58 +0200364 // no neighbours to other directions
Andras Kloczl7e912442021-05-06 12:50:28 +0200365 return new IntSet();
366 }
367 nextPage = validateNewPage(nextPage);
368 if (nextPage == currentPage) {
369 // We reached the end of the pages
370 return new IntSet();
371 }
372
Andras Kloczlb0632942021-08-03 14:03:58 +0200373 return getPageIndices(nextPage);
Andras Kloczl55edfe52021-05-14 12:21:30 +0200374 }
375
376 /**
Sunny Goyal59969372021-05-06 12:11:44 -0700377 * Executes the callback against each visible page
Andras Kloczl2bb51342021-03-20 01:13:45 +0100378 */
Sunny Goyal59969372021-05-06 12:11:44 -0700379 public void forEachVisiblePage(Consumer<View> callback) {
Andras Kloczl55edfe52021-05-14 12:21:30 +0200380 getVisiblePageIndices().forEach(pageIndex -> {
381 View page = getPageAt(pageIndex);
Andras Kloczl2bb51342021-03-20 01:13:45 +0100382 if (page != null) {
Sunny Goyal59969372021-05-06 12:11:44 -0700383 callback.accept(page);
Andras Kloczl2bb51342021-03-20 01:13:45 +0100384 }
Andras Kloczl55edfe52021-05-14 12:21:30 +0200385 });
Andras Kloczl2bb51342021-03-20 01:13:45 +0100386 }
387
388 /**
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100389 * Returns true if the view is on one of the current pages, false otherwise.
390 */
391 public boolean isVisible(View child) {
Andras Kloczl7e912442021-05-06 12:50:28 +0200392 return isVisible(indexOfChild(child));
393 }
394
395 /**
396 * Returns true if the page with the given index is currently visible, false otherwise.
397 */
398 private boolean isVisible(int pageIndex) {
399 return getLeftmostVisiblePageForIndex(pageIndex) == mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700400 }
401
Chet Haasebc2f0822012-10-26 17:59:53 -0700402 /**
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700403 * @return The closest page to the provided page that is within mMinScrollX and mMaxScrollX.
404 */
405 private int ensureWithinScrollBounds(int page) {
406 int dir = !mIsRtl ? 1 : - 1;
407 int currScroll = getScrollForPage(page);
408 int prevScroll;
Vinit Nayaka406f722019-12-19 11:50:55 -0800409 while (currScroll < mMinScroll) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700410 page += dir;
411 prevScroll = currScroll;
412 currScroll = getScrollForPage(page);
413 if (currScroll <= prevScroll) {
414 Log.e(TAG, "validateNewPage: failed to find a page > mMinScrollX");
415 break;
416 }
417 }
Vinit Nayaka406f722019-12-19 11:50:55 -0800418 while (currScroll > mMaxScroll) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700419 page -= dir;
420 prevScroll = currScroll;
421 currScroll = getScrollForPage(page);
422 if (currScroll >= prevScroll) {
423 Log.e(TAG, "validateNewPage: failed to find a page < mMaxScrollX");
424 break;
425 }
426 }
427 return page;
428 }
429
Tony Wickham03f27012019-04-25 14:22:54 -0700430 public void setCurrentPage(int currentPage) {
431 setCurrentPage(currentPage, INVALID_PAGE);
432 }
433
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700434 /**
Winson Chung86f77532010-08-24 11:08:22 -0700435 * Sets the current page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700436 */
Tony Wickham03f27012019-04-25 14:22:54 -0700437 public void setCurrentPage(int currentPage, int overridePrevPage) {
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800438 if (!mScroller.isFinished()) {
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700439 abortScrollerAnimation(true);
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800440 }
Michael Jurkad3ef3062010-11-23 16:23:58 -0800441 // don't introduce any checks like mCurrentPage == currentPage here-- if we change the
442 // the default
443 if (getChildCount() == 0) {
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800444 return;
445 }
Tony Wickham03f27012019-04-25 14:22:54 -0700446 int prevPage = overridePrevPage != INVALID_PAGE ? overridePrevPage : mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700447 mCurrentPage = validateNewPage(currentPage);
Lais Andradecc5c8842021-06-04 18:20:30 +0100448 mCurrentScrollOverPage = mCurrentPage;
Winson Chung181c3dc2013-07-17 15:36:20 -0700449 updateCurrentPageScroll();
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700450 notifyPageSwitchListener(prevPage);
Winson Chunga12a2502010-12-20 14:41:35 -0800451 invalidate();
Winson Chung321e9ee2010-08-09 13:37:56 -0700452 }
453
Winson Chung8c87cd82013-07-23 16:20:10 -0700454 /**
Adam Cohen674531f2013-12-13 15:07:14 -0800455 * Should be called whenever the page changes. In the case of a scroll, we wait until the page
456 * has settled.
457 */
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700458 protected void notifyPageSwitchListener(int prevPage) {
Adam Cohen674531f2013-12-13 15:07:14 -0800459 updatePageIndicator();
460 }
461
462 private void updatePageIndicator() {
Sunny Goyal4cbf0462014-08-28 16:19:39 -0700463 if (mPageIndicator != null) {
Tony Mak4f521af2018-03-15 16:37:34 +0000464 mPageIndicator.setActiveMarker(getNextPage());
Winson Chungd2be3812013-07-16 11:11:32 -0700465 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700466 }
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700467 protected void pageBeginTransition() {
468 if (!mIsPageInTransition) {
469 mIsPageInTransition = true;
470 onPageBeginTransition();
Michael Jurkad74c9842011-07-10 12:44:21 -0700471 }
Patrick Dubroy1262e362010-10-06 15:49:50 -0700472 }
473
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700474 protected void pageEndTransition() {
Sunny Goyal05b59c02021-04-29 13:55:40 -0700475 if (mIsPageInTransition && !mIsBeingDragged && mScroller.isFinished()
Sunny Goyalb745a2a2021-04-30 13:38:22 -0700476 && (!isShown() || (mEdgeGlowLeft.isFinished() && mEdgeGlowRight.isFinished()))) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700477 mIsPageInTransition = false;
478 onPageEndTransition();
Michael Jurkad74c9842011-07-10 12:44:21 -0700479 }
Michael Jurka0142d492010-08-25 17:46:15 -0700480 }
481
Sunny Goyalb745a2a2021-04-30 13:38:22 -0700482 @Override
483 public void onVisibilityAggregated(boolean isVisible) {
484 pageEndTransition();
485 super.onVisibilityAggregated(isVisible);
486 }
487
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700488 protected boolean isPageInTransition() {
489 return mIsPageInTransition;
Adam Cohen26976d92011-03-22 15:33:33 -0700490 }
491
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700492 /**
493 * Called when the page starts moving as part of the scroll. Subclasses can override this
494 * to provide custom behavior during animation.
495 */
496 protected void onPageBeginTransition() {
Patrick Dubroy1262e362010-10-06 15:49:50 -0700497 }
498
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700499 /**
500 * Called when the page ends moving as part of the scroll. Subclasses can override this
501 * to provide custom behavior during animation.
502 */
503 protected void onPageEndTransition() {
Alex Chauba61b982021-06-15 16:29:19 +0100504 mCurrentPageScrollDiff = 0;
Jagrut Desai311d5192023-09-13 10:18:02 -0700505 AccessibilityManagerCompat.sendTestProtocolEventToTest(getContext(),
506 SCROLL_FINISHED_MESSAGE);
Tony Wickham619daaf2020-02-07 12:29:06 -0800507 AccessibilityManagerCompat.sendCustomAccessibilityEvent(getPageAt(mCurrentPage),
508 AccessibilityEvent.TYPE_VIEW_FOCUSED, null);
Tony Wickham62117d72020-03-26 16:56:26 -0700509 if (mOnPageTransitionEndCallback != null) {
510 mOnPageTransitionEndCallback.run();
511 mOnPageTransitionEndCallback = null;
512 }
513 }
514
515 /**
516 * Sets a callback to run once when the scrolling finishes. If there is currently
517 * no page in transition, then the callback is called immediately.
518 */
519 public void setOnPageTransitionEndCallback(@Nullable Runnable callback) {
520 if (mIsPageInTransition || callback == null) {
521 mOnPageTransitionEndCallback = callback;
522 } else {
523 callback.run();
524 }
Michael Jurka0142d492010-08-25 17:46:15 -0700525 }
526
Adam Cohen68d73932010-11-15 10:50:58 -0800527 @Override
Michael Jurka0142d492010-08-25 17:46:15 -0700528 public void scrollTo(int x, int y) {
Sunny Goyalc39db732021-04-03 01:20:21 -0700529 x = Utilities.boundToRange(x,
530 mOrientationHandler.getPrimaryValue(mMinScroll, 0), mMaxScroll);
531 y = Utilities.boundToRange(y,
532 mOrientationHandler.getPrimaryValue(0, mMinScroll), mMaxScroll);
Vinit Nayaka406f722019-12-19 11:50:55 -0800533 super.scrollTo(x, y);
Michael Jurka0142d492010-08-25 17:46:15 -0700534 }
535
Adam Cohen53805212013-10-01 10:39:23 -0700536 private void sendScrollAccessibilityEvent() {
Sunny Goyald0030b02017-12-08 15:07:24 -0800537 if (isObservedEventType(getContext(), AccessibilityEvent.TYPE_VIEW_SCROLLED)) {
Vadim Tryshevf4715972015-05-08 17:21:03 -0700538 if (mCurrentPage != getNextPage()) {
539 AccessibilityEvent ev =
540 AccessibilityEvent.obtain(AccessibilityEvent.TYPE_VIEW_SCROLLED);
Vadim Tryshev7066c122015-05-21 14:06:35 -0700541 ev.setScrollable(true);
542 ev.setScrollX(getScrollX());
543 ev.setScrollY(getScrollY());
Vinit Nayaka406f722019-12-19 11:50:55 -0800544 mOrientationHandler.setMaxScroll(ev, mMaxScroll);
Vadim Tryshevf4715972015-05-08 17:21:03 -0700545 sendAccessibilityEventUnchecked(ev);
Adam Cohen53805212013-10-01 10:39:23 -0700546 }
Adam Cohen53805212013-10-01 10:39:23 -0700547 }
548 }
549
Vadim Tryshev2c430b32018-04-04 14:45:21 -0700550 protected void announcePageForAccessibility() {
551 if (isAccessibilityEnabled(getContext())) {
552 // Notify the user when the page changes
553 announceForAccessibility(getCurrentPageDescription());
554 }
555 }
556
Winson Chung85425412021-05-10 16:24:14 -0700557 protected boolean computeScrollHelper() {
Winson Chung321e9ee2010-08-09 13:37:56 -0700558 if (mScroller.computeScrollOffset()) {
Winson Chung557d6ed2011-07-08 15:34:52 -0700559 // Don't bother scrolling if the page does not need to be moved
Sunny Goyalc39db732021-04-03 01:20:21 -0700560 int oldPos = mOrientationHandler.getPrimaryScroll(this);
561 int newPos = mScroller.getCurrX();
562 if (oldPos != newPos) {
Alex Chau6499e832021-11-19 14:35:46 +0000563 mOrientationHandler.setPrimary(this, VIEW_SCROLL_TO, mScroller.getCurrX());
Winson Chung557d6ed2011-07-08 15:34:52 -0700564 }
Winson Chung85425412021-05-10 16:24:14 -0700565
566 if (mAllowOverScroll) {
567 if (newPos < mMinScroll && oldPos >= mMinScroll) {
568 mEdgeGlowLeft.onAbsorb((int) mScroller.getCurrVelocity());
Schneider Victor-tuliasa602a0a2022-09-06 13:34:00 -0700569 abortScrollerAnimation(false);
Lais Andradecc5c8842021-06-04 18:20:30 +0100570 onEdgeAbsorbingScroll();
Winson Chung85425412021-05-10 16:24:14 -0700571 } else if (newPos > mMaxScroll && oldPos <= mMaxScroll) {
572 mEdgeGlowRight.onAbsorb((int) mScroller.getCurrVelocity());
Schneider Victor-tuliasa602a0a2022-09-06 13:34:00 -0700573 abortScrollerAnimation(false);
Lais Andradecc5c8842021-06-04 18:20:30 +0100574 onEdgeAbsorbingScroll();
Sunny Goyalc39db732021-04-03 01:20:21 -0700575 }
Tony Wickham95cdb3a2016-02-18 14:37:07 -0800576 }
Adam Cohen53805212013-10-01 10:39:23 -0700577
Winson Chung85425412021-05-10 16:24:14 -0700578 // If the scroller has scrolled to the final position and there is no edge effect, then
579 // finish the scroller to skip waiting for additional settling
580 int finalPos = mOrientationHandler.getPrimaryValue(mScroller.getFinalX(),
581 mScroller.getFinalY());
582 if (newPos == finalPos && mEdgeGlowLeft.isFinished() && mEdgeGlowRight.isFinished()) {
Schneider Victor-tuliasa602a0a2022-09-06 13:34:00 -0700583 abortScrollerAnimation(false);
Winson Chung85425412021-05-10 16:24:14 -0700584 }
585
586 invalidate();
587 return true;
588 } else if (mNextPage != INVALID_PAGE) {
589 sendScrollAccessibilityEvent();
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700590 int prevPage = mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700591 mCurrentPage = validateNewPage(mNextPage);
Lais Andradecc5c8842021-06-04 18:20:30 +0100592 mCurrentScrollOverPage = mCurrentPage;
Winson Chung86f77532010-08-24 11:08:22 -0700593 mNextPage = INVALID_PAGE;
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700594 notifyPageSwitchListener(prevPage);
Winson Chungb44b5242011-06-13 11:32:14 -0700595
Adam Cohen73aa9752010-11-24 16:26:58 -0800596 // We don't want to trigger a page end moving unless the page has settled
597 // and the user has stopped scrolling
Sunny Goyalaad33592018-08-07 17:20:35 -0700598 if (!mIsBeingDragged) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700599 pageEndTransition();
Adam Cohen73aa9752010-11-24 16:26:58 -0800600 }
Winson Chungc27d1bb2011-09-29 12:07:42 -0700601
Vadim Tryshev2c430b32018-04-04 14:45:21 -0700602 if (canAnnouncePageDescription()) {
603 announcePageForAccessibility();
Adam Cohen0ffac432013-07-10 11:19:26 -0700604 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700605 }
Michael Jurka0142d492010-08-25 17:46:15 -0700606 return false;
607 }
608
609 @Override
610 public void computeScroll() {
611 computeScrollHelper();
Winson Chung321e9ee2010-08-09 13:37:56 -0700612 }
613
Sunny Goyalce8809a2018-01-18 14:02:47 -0800614 public int getExpectedHeight() {
615 return getMeasuredHeight();
616 }
617
Adam Cohen410f3cd2013-09-22 12:09:32 -0700618 public int getNormalChildHeight() {
Sunny Goyalce8809a2018-01-18 14:02:47 -0800619 return getExpectedHeight() - getPaddingTop() - getPaddingBottom()
Sunny Goyalac00cba2017-11-13 15:58:01 -0800620 - mInsets.top - mInsets.bottom;
Adam Cohen410f3cd2013-09-22 12:09:32 -0700621 }
622
Sunny Goyalce8809a2018-01-18 14:02:47 -0800623 public int getExpectedWidth() {
624 return getMeasuredWidth();
625 }
626
Sunny Goyalbc683e92017-12-06 10:25:07 -0800627 public int getNormalChildWidth() {
Sunny Goyalce8809a2018-01-18 14:02:47 -0800628 return getExpectedWidth() - getPaddingLeft() - getPaddingRight()
Sunny Goyalbc683e92017-12-06 10:25:07 -0800629 - mInsets.left - mInsets.right;
630 }
631
Andras Kloczlc2bd15f2022-03-30 18:06:13 +0100632 private void updateVelocityValues() {
633 Resources res = getResources();
634 mFlingThresholdVelocity = res.getDimensionPixelSize(R.dimen.fling_threshold_velocity);
635 mEasyFlingThresholdVelocity =
636 res.getDimensionPixelSize(R.dimen.easy_fling_threshold_velocity);
637 mMinFlingVelocity = res.getDimensionPixelSize(R.dimen.min_fling_velocity);
638 mMinSnapVelocity = res.getDimensionPixelSize(R.dimen.min_page_snap_velocity);
639 mPageSnapAnimationDuration = res.getInteger(R.integer.config_pageSnapAnimationDuration);
640 }
641
642 @Override
643 protected void onConfigurationChanged(Configuration newConfig) {
644 super.onConfigurationChanged(newConfig);
645 updateVelocityValues();
646 }
647
Winson Chung321e9ee2010-08-09 13:37:56 -0700648 @Override
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800649 public void requestLayout() {
650 mIsLayoutValid = false;
651 super.requestLayout();
652 }
653
654 @Override
655 public void forceLayout() {
656 mIsLayoutValid = false;
657 super.forceLayout();
658 }
659
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100660 private int getPageWidthSize(int widthSize) {
Thales Lima7a6752d2021-09-23 14:31:00 +0100661 // It's necessary to add the padding back because it is remove when measuring children,
662 // like when MeasureSpec.getSize in CellLayout.
663 return (widthSize - mInsets.left - mInsets.right - getPaddingLeft() - getPaddingRight())
664 / getPanelCount() + getPaddingLeft() + getPaddingRight();
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100665 }
666
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800667 @Override
Winson Chung321e9ee2010-08-09 13:37:56 -0700668 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
Sunny Goyal8e2133b2015-05-06 13:39:07 -0700669 if (getChildCount() == 0) {
Winson Chungf0ea4d32011-06-06 14:27:16 -0700670 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
671 return;
672 }
673
Adam Cohen7d30a372013-07-01 17:03:59 -0700674 // We measure the dimensions of the PagedView to be larger than the pages so that when we
675 // zoom out (and scale down), the view is still contained in the parent
Adam Cohen7d30a372013-07-01 17:03:59 -0700676 int widthMode = MeasureSpec.getMode(widthMeasureSpec);
677 int widthSize = MeasureSpec.getSize(widthMeasureSpec);
678 int heightMode = MeasureSpec.getMode(heightMeasureSpec);
Winson Chung8aad6102012-05-11 16:27:49 -0700679 int heightSize = MeasureSpec.getSize(heightMeasureSpec);
Adam Cohen410f3cd2013-09-22 12:09:32 -0700680
Adam Cohen7d30a372013-07-01 17:03:59 -0700681 if (widthMode == MeasureSpec.UNSPECIFIED || heightMode == MeasureSpec.UNSPECIFIED) {
682 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
683 return;
Winson Chung321e9ee2010-08-09 13:37:56 -0700684 }
685
Winson Chung8aad6102012-05-11 16:27:49 -0700686 // Return early if we aren't given a proper dimension
687 if (widthSize <= 0 || heightSize <= 0) {
688 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
689 return;
690 }
691
Winson Chung321e9ee2010-08-09 13:37:56 -0700692 // The children are given the same width and height as the workspace
Michael Jurka5f1c5092010-09-03 14:15:02 -0700693 // unless they were set to WRAP_CONTENT
Winson Chung785d2eb2011-04-14 16:08:02 -0700694 if (DEBUG) Log.d(TAG, "PagedView.onMeasure(): " + widthSize + ", " + heightSize);
Michael Jurka5f1c5092010-09-03 14:15:02 -0700695
Sunny Goyalac00cba2017-11-13 15:58:01 -0800696 int myWidthSpec = MeasureSpec.makeMeasureSpec(
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100697 getPageWidthSize(widthSize), MeasureSpec.EXACTLY);
Sunny Goyalac00cba2017-11-13 15:58:01 -0800698 int myHeightSpec = MeasureSpec.makeMeasureSpec(
Sunny Goyal228153d2018-01-04 15:35:22 -0800699 heightSize - mInsets.top - mInsets.bottom, MeasureSpec.EXACTLY);
Adam Cohen96d30a12013-07-16 18:13:21 -0700700
Sunny Goyalac00cba2017-11-13 15:58:01 -0800701 // measureChildren takes accounts for content padding, we only need to care about extra
702 // space due to insets.
703 measureChildren(myWidthSpec, myHeightSpec);
704 setMeasuredDimension(widthSize, heightSize);
Adam Cohen60b07122011-11-14 17:26:06 -0800705 }
706
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700707 /** Returns true iff this PagedView's scroll amounts are initialized to each page index. */
Schneider Victor-tulias7bb558a2022-12-15 05:42:53 -0800708 protected boolean isPageScrollsInitialized() {
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700709 return mPageScrolls != null && mPageScrolls.length == getChildCount();
710 }
711
712 /**
713 * Queues the given callback to be run once {@code mPageScrolls} has been initialized.
714 */
715 public void runOnPageScrollsInitialized(Runnable callback) {
716 mOnPageScrollsInitializedCallbacks.add(callback);
Schneider Victor-tulias7bb558a2022-12-15 05:42:53 -0800717 if (isPageScrollsInitialized()) {
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700718 onPageScrollsInitialized();
719 }
720 }
721
Schneider Victor-tulias7bb558a2022-12-15 05:42:53 -0800722 protected void onPageScrollsInitialized() {
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700723 for (Runnable callback : mOnPageScrollsInitializedCallbacks) {
724 callback.run();
725 }
726 mOnPageScrollsInitializedCallbacks.clear();
727 }
728
Sunny Goyalcf25b522015-07-09 00:01:18 -0700729 @SuppressLint("DrawAllocation")
Winson Chung321e9ee2010-08-09 13:37:56 -0700730 @Override
Michael Jurka28750fb2010-09-24 17:43:49 -0700731 protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800732 mIsLayoutValid = true;
Vadim Trysheveb701c62018-05-14 16:00:15 -0700733 final int childCount = getChildCount();
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700734 int[] pageScrolls = mPageScrolls;
Vadim Trysheveb701c62018-05-14 16:00:15 -0700735 boolean pageScrollChanged = false;
Schneider Victor-tulias7bb558a2022-12-15 05:42:53 -0800736 if (!isPageScrollsInitialized()) {
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700737 pageScrolls = new int[childCount];
Vadim Trysheveb701c62018-05-14 16:00:15 -0700738 pageScrollChanged = true;
739 }
740
Winson Chung785d2eb2011-04-14 16:08:02 -0700741 if (DEBUG) Log.d(TAG, "PagedView.onLayout()");
Winson Chung321e9ee2010-08-09 13:37:56 -0700742
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700743 pageScrollChanged |= getPageScrolls(pageScrolls, true, SIMPLE_SCROLL_LOGIC);
744 mPageScrolls = pageScrolls;
Winson Chungc3665fa2011-09-14 17:56:27 -0700745
Winson Chung359cb5d2022-05-26 23:38:48 +0000746 if (childCount == 0) {
747 onPageScrollsInitialized();
748 return;
749 }
750
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700751 final LayoutTransition transition = getLayoutTransition();
752 // If the transition is running defer updating max scroll, as some empty pages could
753 // still be present, and a max scroll change could cause sudden jumps in scroll.
754 if (transition != null && transition.isRunning()) {
755 transition.addTransitionListener(new LayoutTransition.TransitionListener() {
756
757 @Override
758 public void startTransition(LayoutTransition transition, ViewGroup container,
759 View view, int transitionType) { }
760
761 @Override
762 public void endTransition(LayoutTransition transition, ViewGroup container,
763 View view, int transitionType) {
764 // Wait until all transitions are complete.
765 if (!transition.isRunning()) {
766 transition.removeTransitionListener(this);
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700767 updateMinAndMaxScrollX();
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700768 }
769 }
770 });
Adam Cohenf698c6e2013-07-17 18:44:25 -0700771 } else {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700772 updateMinAndMaxScrollX();
Adam Cohenf698c6e2013-07-17 18:44:25 -0700773 }
774
Sunny Goyalcb037ee2015-07-08 16:41:21 -0700775 if (mFirstLayout && mCurrentPage >= 0 && mCurrentPage < childCount) {
776 updateCurrentPageScroll();
777 mFirstLayout = false;
778 }
779
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800780 if (mScroller.isFinished() && pageScrollChanged) {
Alex Chau0733ebd2022-10-07 15:11:09 +0100781 // TODO(b/246283207): Remove logging once root cause of flake detected.
Brian Isganitisfdd044e2023-03-02 19:45:23 +0000782 if (Utilities.isRunningInTestHarness() && !(this instanceof Workspace)) {
Alex Chau0733ebd2022-10-07 15:11:09 +0100783 Log.d("b/246283207", this.getClass().getSimpleName() + "#onLayout() -> "
Pat Manning24b95542022-08-09 18:06:58 +0100784 + "if(mScroller.isFinished() && pageScrollChanged) -> getNextPage(): "
785 + getNextPage() + ", getScrollForPage(getNextPage()): "
786 + getScrollForPage(getNextPage()));
787 }
Sunny Goyalc82c6392018-06-06 15:39:13 -0700788 setCurrentPage(getNextPage());
Adam Cohenf698c6e2013-07-17 18:44:25 -0700789 }
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700790 onPageScrollsInitialized();
Winson Chunge3193b92010-09-10 11:44:42 -0700791 }
792
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700793 /**
794 * Initializes {@code outPageScrolls} with scroll positions for view at that index. The length
795 * of {@code outPageScrolls} should be same as the the childCount
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700796 */
797 protected boolean getPageScrolls(int[] outPageScrolls, boolean layoutChildren,
798 ComputePageScrollsLogic scrollLogic) {
799 final int childCount = getChildCount();
800
801 final int startIndex = mIsRtl ? childCount - 1 : 0;
802 final int endIndex = mIsRtl ? -1 : childCount;
803 final int delta = mIsRtl ? -1 : 1;
804
Vinit Nayaka406f722019-12-19 11:50:55 -0800805 final int pageCenter = mOrientationHandler.getCenterForPage(this, mInsets);
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700806
Vinit Nayaka406f722019-12-19 11:50:55 -0800807 final int scrollOffsetStart = mOrientationHandler.getScrollOffsetStart(this, mInsets);
808 final int scrollOffsetEnd = mOrientationHandler.getScrollOffsetEnd(this, mInsets);
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700809 boolean pageScrollChanged = false;
Thales Limae4457742021-07-20 16:46:38 +0100810 int panelCount = getPanelCount();
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700811
Vinit Nayaka406f722019-12-19 11:50:55 -0800812 for (int i = startIndex, childStart = scrollOffsetStart; i != endIndex; i += delta) {
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700813 final View child = getPageAt(i);
814 if (scrollLogic.shouldIncludeView(child)) {
Vinit Nayaka406f722019-12-19 11:50:55 -0800815 ChildBounds bounds = mOrientationHandler.getChildBounds(child, childStart,
816 pageCenter, layoutChildren);
817 final int primaryDimension = bounds.primaryDimension;
818 final int childPrimaryEnd = bounds.childPrimaryEnd;
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700819
Alex Chaub5c4d112021-03-29 17:37:53 +0100820 // In case the pages are of different width, align the page to left edge for non-RTL
821 // or right edge for RTL.
822 final int pageScroll =
823 mIsRtl ? childPrimaryEnd - scrollOffsetEnd : childStart - scrollOffsetStart;
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700824 if (outPageScrolls[i] != pageScroll) {
825 pageScrollChanged = true;
826 outPageScrolls[i] = pageScroll;
827 }
Alex Chau2e487602022-03-15 19:34:08 +0000828 childStart += primaryDimension + getChildGap(i, i + delta);
Thales Limae4457742021-07-20 16:46:38 +0100829
830 // This makes sure that the space is added after the page, not after each panel
Thales Limac2a6f6f2021-09-09 17:06:22 +0100831 int lastPanel = mIsRtl ? 0 : panelCount - 1;
832 if (i % panelCount == lastPanel) {
Thales Limae4457742021-07-20 16:46:38 +0100833 childStart += mPageSpacing;
834 }
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700835 }
836 }
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100837
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100838 if (panelCount > 1) {
839 for (int i = 0; i < childCount; i++) {
Alex Chau1e448462021-08-13 21:48:35 +0100840 // In case we have multiple panels, always use left most panel's page scroll for all
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100841 // panels on the screen.
842 int adjustedScroll = outPageScrolls[getLeftmostVisiblePageForIndex(i)];
843 if (outPageScrolls[i] != adjustedScroll) {
844 outPageScrolls[i] = adjustedScroll;
845 pageScrollChanged = true;
846 }
847 }
848 }
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700849 return pageScrollChanged;
850 }
851
Alex Chau2e487602022-03-15 19:34:08 +0000852 protected int getChildGap(int fromIndex, int toIndex) {
Sunny Goyala1fbd842015-05-20 13:40:27 -0700853 return 0;
854 }
855
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700856 protected void updateMinAndMaxScrollX() {
Vinit Nayaka406f722019-12-19 11:50:55 -0800857 mMinScroll = computeMinScroll();
858 mMaxScroll = computeMaxScroll();
Tony Wickhamf549dab2016-05-16 09:54:06 -0700859 }
860
Vinit Nayaka406f722019-12-19 11:50:55 -0800861 protected int computeMinScroll() {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700862 return 0;
Tony50876bf2018-09-19 23:09:14 -0400863 }
864
Vinit Nayaka406f722019-12-19 11:50:55 -0800865 protected int computeMaxScroll() {
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700866 int childCount = getChildCount();
867 if (childCount > 0) {
Sunny Goyal70660032015-05-14 00:07:08 -0700868 final int index = mIsRtl ? 0 : childCount - 1;
Tony Wickhamf549dab2016-05-16 09:54:06 -0700869 return getScrollForPage(index);
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700870 } else {
Tony Wickhamf549dab2016-05-16 09:54:06 -0700871 return 0;
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700872 }
873 }
874
Adam Cohen3b185e22013-10-29 14:45:58 -0700875 public void setPageSpacing(int pageSpacing) {
876 mPageSpacing = pageSpacing;
877 requestLayout();
878 }
879
Tony50876bf2018-09-19 23:09:14 -0400880 public int getPageSpacing() {
881 return mPageSpacing;
882 }
883
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800884 private void dispatchPageCountChanged() {
885 if (mPageIndicator != null) {
Tony Wickhambab101c2021-09-20 15:12:44 -0700886 mPageIndicator.setMarkersCount(getChildCount() / getPanelCount());
Winson Chungd2be3812013-07-16 11:11:32 -0700887 }
Adam Cohen2591f6a2011-10-25 14:36:40 -0700888 // This ensures that when children are added, they get the correct transforms / alphas
889 // in accordance with any scroll effects.
Adam Cohen2591f6a2011-10-25 14:36:40 -0700890 invalidate();
891 }
892
Michael Jurka8b805b12012-04-18 14:23:14 -0700893 @Override
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800894 public void onViewAdded(View child) {
Winson Chungc7c51582018-02-23 17:58:36 -0800895 super.onViewAdded(child);
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800896 dispatchPageCountChanged();
897 }
898
899 @Override
900 public void onViewRemoved(View child) {
Winson Chungc7c51582018-02-23 17:58:36 -0800901 super.onViewRemoved(child);
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700902 runOnPageScrollsInitialized(() -> {
903 mCurrentPage = validateNewPage(mCurrentPage);
904 mCurrentScrollOverPage = mCurrentPage;
905 });
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800906 dispatchPageCountChanged();
Winson Chungd2be3812013-07-16 11:11:32 -0700907 }
908
Adam Cohen73894962011-10-31 13:17:17 -0700909 protected int getChildOffset(int index) {
Adam Cohen7d30a372013-07-01 17:03:59 -0700910 if (index < 0 || index > getChildCount() - 1) return 0;
Vinit Nayaka406f722019-12-19 11:50:55 -0800911 View pageAtIndex = getPageAt(index);
912 return mOrientationHandler.getChildStart(pageAtIndex);
Adam Cohen73894962011-10-31 13:17:17 -0700913 }
914
Alex Chau7944ee52021-01-08 19:07:25 +0000915 protected int getChildVisibleSize(int index) {
916 View layout = getPageAt(index);
917 return mOrientationHandler.getMeasuredSize(layout);
918 }
919
Winson Chung321e9ee2010-08-09 13:37:56 -0700920 @Override
921 public boolean requestChildRectangleOnScreen(View child, Rect rectangle, boolean immediate) {
Andras Kloczl7e912442021-05-06 12:50:28 +0200922 int page = indexOfChild(child);
923 if (!isVisible(page) || !mScroller.isFinished()) {
Vadim Trysheveeaa8ee2018-04-11 12:23:42 -0700924 if (immediate) {
925 setCurrentPage(page);
926 } else {
927 snapToPage(page);
928 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700929 return true;
930 }
931 return false;
932 }
933
934 @Override
935 protected boolean onRequestFocusInDescendants(int direction, Rect previouslyFocusedRect) {
Winson Chung86f77532010-08-24 11:08:22 -0700936 int focusablePage;
937 if (mNextPage != INVALID_PAGE) {
938 focusablePage = mNextPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700939 } else {
Winson Chung86f77532010-08-24 11:08:22 -0700940 focusablePage = mCurrentPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700941 }
Winson Chung86f77532010-08-24 11:08:22 -0700942 View v = getPageAt(focusablePage);
Winson Chung321e9ee2010-08-09 13:37:56 -0700943 if (v != null) {
Adam Cohen76fc0852011-06-17 13:26:23 -0700944 return v.requestFocus(direction, previouslyFocusedRect);
Winson Chung321e9ee2010-08-09 13:37:56 -0700945 }
946 return false;
947 }
948
949 @Override
950 public boolean dispatchUnhandledMove(View focused, int direction) {
Sunny Goyal0c4e3722015-12-01 13:21:49 -0800951 if (super.dispatchUnhandledMove(focused, direction)) {
952 return true;
953 }
954
955 if (mIsRtl) {
956 if (direction == View.FOCUS_LEFT) {
957 direction = View.FOCUS_RIGHT;
958 } else if (direction == View.FOCUS_RIGHT) {
959 direction = View.FOCUS_LEFT;
960 }
961 }
Andras Kloczl7e912442021-05-06 12:50:28 +0200962
963 int currentPage = getNextPage();
964 int closestNeighbourIndex = -1;
965 int closestNeighbourDistance = Integer.MAX_VALUE;
966 // Find the closest neighbour page
967 for (int neighbourPageIndex : getNeighbourPageIndices(direction)) {
968 int distance = Math.abs(neighbourPageIndex - currentPage);
969 if (closestNeighbourDistance > distance) {
970 closestNeighbourDistance = distance;
971 closestNeighbourIndex = neighbourPageIndex;
Winson Chung321e9ee2010-08-09 13:37:56 -0700972 }
973 }
Andras Kloczl7e912442021-05-06 12:50:28 +0200974 if (closestNeighbourIndex != -1) {
975 View page = getPageAt(closestNeighbourIndex);
976 snapToPage(closestNeighbourIndex);
977 page.requestFocus(direction);
978 return true;
979 }
980
Sunny Goyal0c4e3722015-12-01 13:21:49 -0800981 return false;
Winson Chung321e9ee2010-08-09 13:37:56 -0700982 }
983
984 @Override
985 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) {
Jon Miranda6a858172016-10-25 16:19:17 -0700986 if (getDescendantFocusability() == FOCUS_BLOCK_DESCENDANTS) {
987 return;
988 }
989
Andras Kloczl7e912442021-05-06 12:50:28 +0200990 // nextPage is more reliable when multiple control movements have been done in a short
991 // period of time
992 getPageIndices(getNextPage())
993 .addAll(getNeighbourPageIndices(direction))
994 .forEach(pageIndex ->
995 getPageAt(pageIndex).addFocusables(views, direction, focusableMode));
Winson Chung321e9ee2010-08-09 13:37:56 -0700996 }
997
998 /**
999 * If one of our descendant views decides that it could be focused now, only
Winson Chung86f77532010-08-24 11:08:22 -07001000 * pass that along if it's on the current page.
Winson Chung321e9ee2010-08-09 13:37:56 -07001001 *
Winson Chung86f77532010-08-24 11:08:22 -07001002 * This happens when live folders requery, and if they're off page, they
1003 * end up calling requestFocus, which pulls it on page.
Winson Chung321e9ee2010-08-09 13:37:56 -07001004 */
1005 @Override
1006 public void focusableViewAvailable(View focused) {
Winson Chung86f77532010-08-24 11:08:22 -07001007 View current = getPageAt(mCurrentPage);
Winson Chung321e9ee2010-08-09 13:37:56 -07001008 View v = focused;
1009 while (true) {
1010 if (v == current) {
1011 super.focusableViewAvailable(focused);
1012 return;
1013 }
1014 if (v == this) {
1015 return;
1016 }
1017 ViewParent parent = v.getParent();
1018 if (parent instanceof View) {
1019 v = (View)v.getParent();
1020 } else {
1021 return;
1022 }
1023 }
1024 }
1025
1026 /**
1027 * {@inheritDoc}
1028 */
1029 @Override
1030 public void requestDisallowInterceptTouchEvent(boolean disallowIntercept) {
1031 if (disallowIntercept) {
1032 // We need to make sure to cancel our long press if
1033 // a scrollable widget takes over touch events
Andras Kloczl7a1ca0b2021-04-08 16:08:16 +02001034 cancelCurrentPageLongPress();
Winson Chung321e9ee2010-08-09 13:37:56 -07001035 }
1036 super.requestDisallowInterceptTouchEvent(disallowIntercept);
1037 }
1038
1039 @Override
1040 public boolean onInterceptTouchEvent(MotionEvent ev) {
1041 /*
1042 * This method JUST determines whether we want to intercept the motion.
1043 * If we return true, onTouchEvent will be called and we do the actual
1044 * scrolling there.
1045 */
1046
Winson Chung45e1d6e2010-11-09 17:19:49 -08001047 // Skip touch handling if there are no pages to swipe
Tony Wickhamb6841ac2019-07-22 12:39:59 -07001048 if (getChildCount() <= 0) return false;
Sunny Goyalc4bb3732019-06-20 11:34:14 -07001049
1050 acquireVelocityTrackerAndAddMovement(ev);
Winson Chung45e1d6e2010-11-09 17:19:49 -08001051
Winson Chung321e9ee2010-08-09 13:37:56 -07001052 /*
1053 * Shortcut the most recurring case: the user is in the dragging
1054 * state and he is moving his finger. We want to intercept this
1055 * motion.
1056 */
1057 final int action = ev.getAction();
Sunny Goyalaad33592018-08-07 17:20:35 -07001058 if ((action == MotionEvent.ACTION_MOVE) && mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001059 return true;
1060 }
1061
Winson Chung321e9ee2010-08-09 13:37:56 -07001062 switch (action & MotionEvent.ACTION_MASK) {
1063 case MotionEvent.ACTION_MOVE: {
1064 /*
1065 * mIsBeingDragged == false, otherwise the shortcut would have caught it. Check
Vinit Nayaka406f722019-12-19 11:50:55 -08001066 * whether the user has moved far enough from their original down touch.
Winson Chung321e9ee2010-08-09 13:37:56 -07001067 */
Michael Jurka1ff706b2010-09-14 17:35:20 -07001068 if (mActivePointerId != INVALID_POINTER) {
1069 determineScrollingStart(ev);
Michael Jurka1ff706b2010-09-14 17:35:20 -07001070 }
1071 // if mActivePointerId is INVALID_POINTER, then we must have missed an ACTION_DOWN
Vinit Nayaka406f722019-12-19 11:50:55 -08001072 // event. in that case, treat the first occurrence of a move event as a ACTION_DOWN
Michael Jurka1ff706b2010-09-14 17:35:20 -07001073 // i.e. fall through to the next case (don't break)
1074 // (We sometimes miss ACTION_DOWN events in Workspace because it ignores all events
1075 // while it's small- this was causing a crash before we checked for INVALID_POINTER)
Adam Cohen93c97562013-09-26 13:48:01 -07001076 break;
Winson Chung321e9ee2010-08-09 13:37:56 -07001077 }
1078
1079 case MotionEvent.ACTION_DOWN: {
1080 final float x = ev.getX();
1081 final float y = ev.getY();
1082 // Remember location of down touch
1083 mDownMotionX = x;
Adam Cohen7d30a372013-07-01 17:03:59 -07001084 mDownMotionY = y;
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001085 mDownMotionPrimary = mOrientationHandler.getPrimaryDirection(ev, 0);
1086 mLastMotion = (int) mDownMotionPrimary;
Vinit Nayaka406f722019-12-19 11:50:55 -08001087 mTotalMotion = 0;
Winson Chung4941f652020-06-18 15:11:53 -07001088 mAllowEasyFling = false;
Winson Chung321e9ee2010-08-09 13:37:56 -07001089 mActivePointerId = ev.getPointerId(0);
Sunny Goyalc39db732021-04-03 01:20:21 -07001090 updateIsBeingDraggedOnTouchDown(ev);
Winson Chung321e9ee2010-08-09 13:37:56 -07001091 break;
1092 }
1093
Winson Chung321e9ee2010-08-09 13:37:56 -07001094 case MotionEvent.ACTION_UP:
Jeff Brown1d0867c2010-12-02 18:27:39 -08001095 case MotionEvent.ACTION_CANCEL:
Adam Cohen7d30a372013-07-01 17:03:59 -07001096 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001097 break;
1098
1099 case MotionEvent.ACTION_POINTER_UP:
1100 onSecondaryPointerUp(ev);
Adam Cohen6342bba2011-03-10 11:33:35 -08001101 releaseVelocityTracker();
Winson Chung321e9ee2010-08-09 13:37:56 -07001102 break;
1103 }
1104
1105 /*
1106 * The only time we want to intercept motion events is if we are in the
1107 * drag mode.
1108 */
Sunny Goyalaad33592018-08-07 17:20:35 -07001109 return mIsBeingDragged;
Winson Chung321e9ee2010-08-09 13:37:56 -07001110 }
1111
Tony Wickhama0aee212019-09-18 09:24:03 -07001112 /**
1113 * If being flinged and user touches the screen, initiate drag; otherwise don't.
1114 */
Sunny Goyalbb030562021-07-19 16:28:39 -07001115 protected void updateIsBeingDraggedOnTouchDown(MotionEvent ev) {
Tony Wickhama0aee212019-09-18 09:24:03 -07001116 // mScroller.isFinished should be false when being flinged.
Sunny Goyalc39db732021-04-03 01:20:21 -07001117 final int xDist = Math.abs(mScroller.getFinalX() - mScroller.getCurrX());
Winson Chung4941f652020-06-18 15:11:53 -07001118 final boolean finishedScrolling = (mScroller.isFinished() || xDist < mPageSlop / 3);
Tony Wickhama0aee212019-09-18 09:24:03 -07001119
1120 if (finishedScrolling) {
1121 mIsBeingDragged = false;
1122 if (!mScroller.isFinished() && !mFreeScroll) {
1123 setCurrentPage(getNextPage());
1124 pageEndTransition();
1125 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001126 mIsBeingDragged = !mEdgeGlowLeft.isFinished() || !mEdgeGlowRight.isFinished();
Tony Wickhama0aee212019-09-18 09:24:03 -07001127 } else {
1128 mIsBeingDragged = true;
1129 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001130
1131 // Catch the edge effect if it is active.
1132 float displacement = mOrientationHandler.getSecondaryValue(ev.getX(), ev.getY())
1133 / mOrientationHandler.getSecondaryValue(getWidth(), getHeight());
1134 if (!mEdgeGlowLeft.isFinished()) {
1135 mEdgeGlowLeft.onPullDistance(0f, 1f - displacement);
1136 }
1137 if (!mEdgeGlowRight.isFinished()) {
1138 mEdgeGlowRight.onPullDistance(0f, displacement);
1139 }
Tony Wickhama0aee212019-09-18 09:24:03 -07001140 }
1141
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001142 public boolean isHandlingTouch() {
Sunny Goyalaad33592018-08-07 17:20:35 -07001143 return mIsBeingDragged;
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001144 }
1145
Adam Cohenf8d28232011-02-01 21:47:00 -08001146 protected void determineScrollingStart(MotionEvent ev) {
1147 determineScrollingStart(ev, 1.0f);
1148 }
1149
Winson Chung321e9ee2010-08-09 13:37:56 -07001150 /*
1151 * Determines if we should change the touch state to start scrolling after the
1152 * user moves their touch point too far.
1153 */
Adam Cohenf8d28232011-02-01 21:47:00 -08001154 protected void determineScrollingStart(MotionEvent ev, float touchSlopScale) {
Adam Cohen7d30a372013-07-01 17:03:59 -07001155 // Disallow scrolling if we don't have a valid pointer index
Winson Chung321e9ee2010-08-09 13:37:56 -07001156 final int pointerIndex = ev.findPointerIndex(mActivePointerId);
Adam Cohen7d30a372013-07-01 17:03:59 -07001157 if (pointerIndex == -1) return;
1158
Vinit Nayaka406f722019-12-19 11:50:55 -08001159 final float primaryDirection = mOrientationHandler.getPrimaryDirection(ev, pointerIndex);
1160 final int diff = (int) Math.abs(primaryDirection - mLastMotion);
Adam Cohenf8d28232011-02-01 21:47:00 -08001161 final int touchSlop = Math.round(touchSlopScale * mTouchSlop);
Winson Chung4941f652020-06-18 15:11:53 -07001162 boolean moved = diff > touchSlop || ev.getAction() == ACTION_MOVE_ALLOW_EASY_FLING;
Winson Chung321e9ee2010-08-09 13:37:56 -07001163
Vinit Nayaka406f722019-12-19 11:50:55 -08001164 if (moved) {
Sunny Goyal5a1f53b2015-05-27 10:24:24 -07001165 // Scroll if the user moved far enough along the X axis
Sunny Goyalaad33592018-08-07 17:20:35 -07001166 mIsBeingDragged = true;
Vinit Nayaka406f722019-12-19 11:50:55 -08001167 mTotalMotion += Math.abs(mLastMotion - primaryDirection);
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001168 mLastMotion = (int) primaryDirection;
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001169 pageBeginTransition();
Tony Wickhamdadb3042016-02-24 11:07:00 -08001170 // Stop listening for things like pinches.
1171 requestDisallowInterceptTouchEvent(true);
Adam Cohenf8d28232011-02-01 21:47:00 -08001172 }
1173 }
1174
1175 protected void cancelCurrentPageLongPress() {
Sunny Goyal8e2133b2015-05-06 13:39:07 -07001176 // Try canceling the long press. It could also have been scheduled
1177 // by a distant descendant, so use the mAllowLongPress flag to block
1178 // everything
Sunny Goyal59969372021-05-06 12:11:44 -07001179 forEachVisiblePage(View::cancelLongPress);
Winson Chung321e9ee2010-08-09 13:37:56 -07001180 }
1181
Adam Cohenb5ba0972011-09-07 18:02:31 -07001182 protected float getScrollProgress(int screenCenter, View v, int page) {
Sunny Goyal228153d2018-01-04 15:35:22 -08001183 final int halfScreenSize = getMeasuredWidth() / 2;
Adam Cohenedb40762013-07-18 16:45:45 -07001184 int delta = screenCenter - (getScrollForPage(page) + halfScreenSize);
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001185 int panelCount = getPanelCount();
1186 int pageCount = getChildCount();
Adam Cohen3b185e22013-10-29 14:45:58 -07001187
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001188 int adjacentPage = page + panelCount;
Sunny Goyal70660032015-05-14 00:07:08 -07001189 if ((delta < 0 && !mIsRtl) || (delta > 0 && mIsRtl)) {
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001190 adjacentPage = page - panelCount;
Adam Cohen3b185e22013-10-29 14:45:58 -07001191 }
1192
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001193 final int totalDistance;
1194 if (adjacentPage < 0 || adjacentPage > pageCount - 1) {
1195 totalDistance = (v.getMeasuredWidth() + mPageSpacing) * panelCount;
Adam Cohen3b185e22013-10-29 14:45:58 -07001196 } else {
1197 totalDistance = Math.abs(getScrollForPage(adjacentPage) - getScrollForPage(page));
1198 }
Adam Cohenb5ba0972011-09-07 18:02:31 -07001199
1200 float scrollProgress = delta / (totalDistance * 1.0f);
Sunny Goyal8e2133b2015-05-06 13:39:07 -07001201 scrollProgress = Math.min(scrollProgress, MAX_SCROLL_PROGRESS);
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001202 scrollProgress = Math.max(scrollProgress, -MAX_SCROLL_PROGRESS);
Adam Cohenb5ba0972011-09-07 18:02:31 -07001203 return scrollProgress;
1204 }
1205
Adam Cohenedb40762013-07-18 16:45:45 -07001206 public int getScrollForPage(int index) {
Schneider Victor-tulias7bb558a2022-12-15 05:42:53 -08001207 if (!isPageScrollsInitialized() || index >= mPageScrolls.length || index < 0) {
Adam Cohenedb40762013-07-18 16:45:45 -07001208 return 0;
1209 } else {
1210 return mPageScrolls[index];
1211 }
1212 }
1213
Adam Cohen564a2e72013-10-09 14:47:32 -07001214 // While layout transitions are occurring, a child's position may stray from its baseline
1215 // position. This method returns the magnitude of this stray at any given time.
1216 public int getLayoutTransitionOffsetForPage(int index) {
Schneider Victor-tulias7bb558a2022-12-15 05:42:53 -08001217 if (!isPageScrollsInitialized() || index >= mPageScrolls.length || index < 0) {
Adam Cohen564a2e72013-10-09 14:47:32 -07001218 return 0;
1219 } else {
1220 View child = getChildAt(index);
Adam Cohen3b185e22013-10-29 14:45:58 -07001221
Sunny Goyal228153d2018-01-04 15:35:22 -08001222 int scrollOffset = mIsRtl ? getPaddingRight() : getPaddingLeft();
1223 int baselineX = mPageScrolls[index] + scrollOffset;
Adam Cohen564a2e72013-10-09 14:47:32 -07001224 return (int) (child.getX() - baselineX);
1225 }
1226 }
1227
Tony Wickham023f4042019-01-29 10:52:31 -08001228 public void setEnableFreeScroll(boolean freeScroll) {
Winson Chung0e449002019-04-26 11:09:58 -07001229 if (mFreeScroll == freeScroll) {
1230 return;
1231 }
1232
Tony Wickham8f7ead32016-04-07 18:46:44 -07001233 boolean wasFreeScroll = mFreeScroll;
Adam Cohenf358a4b2013-07-23 16:47:31 -07001234 mFreeScroll = freeScroll;
1235
Adam Cohenf9618852013-11-08 06:45:03 -08001236 if (mFreeScroll) {
Sunny Goyal4d519f22017-10-24 10:32:40 -07001237 setCurrentPage(getNextPage());
Tony Wickham8f7ead32016-04-07 18:46:44 -07001238 } else if (wasFreeScroll) {
Tony Wickhamaf33f2c2019-10-04 12:55:22 -07001239 if (getScrollForPage(getNextPage()) != getScrollX()) {
1240 snapToPage(getNextPage());
1241 }
Adam Cohenf358a4b2013-07-23 16:47:31 -07001242 }
Adam Cohenf358a4b2013-07-23 16:47:31 -07001243 }
1244
Sunny Goyal2f0ec852015-03-26 13:38:27 -07001245 protected void setEnableOverscroll(boolean enable) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001246 mAllowOverScroll = enable;
1247 }
1248
Andras Kloczl07111f22022-03-30 17:25:54 +01001249 protected boolean isSignificantMove(float absoluteDelta, int pageOrientedSize) {
1250 return absoluteDelta > pageOrientedSize * SIGNIFICANT_MOVE_THRESHOLD;
Alex Chau822acf42021-06-03 11:35:05 +01001251 }
1252
Winson Chung321e9ee2010-08-09 13:37:56 -07001253 @Override
1254 public boolean onTouchEvent(MotionEvent ev) {
Winson Chung45e1d6e2010-11-09 17:19:49 -08001255 // Skip touch handling if there are no pages to swipe
Tony Wickhamb6841ac2019-07-22 12:39:59 -07001256 if (getChildCount() <= 0) return false;
Winson Chung45e1d6e2010-11-09 17:19:49 -08001257
Michael Jurkab8f06722010-10-10 15:58:46 -07001258 acquireVelocityTrackerAndAddMovement(ev);
Winson Chung321e9ee2010-08-09 13:37:56 -07001259
1260 final int action = ev.getAction();
1261
1262 switch (action & MotionEvent.ACTION_MASK) {
1263 case MotionEvent.ACTION_DOWN:
Sunny Goyalc39db732021-04-03 01:20:21 -07001264 updateIsBeingDraggedOnTouchDown(ev);
Tony Wickhama0aee212019-09-18 09:24:03 -07001265
Winson Chung321e9ee2010-08-09 13:37:56 -07001266 /*
1267 * If being flinged and user touches, stop the fling. isFinished
1268 * will be false if being flinged.
1269 */
1270 if (!mScroller.isFinished()) {
Adam Cohen8bdbaab2013-10-29 15:25:02 -07001271 abortScrollerAnimation(false);
Winson Chung321e9ee2010-08-09 13:37:56 -07001272 }
1273
1274 // Remember where the motion event started
Vinit Nayaka406f722019-12-19 11:50:55 -08001275 mDownMotionX = ev.getX();
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001276 mDownMotionY = ev.getY();
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001277 mDownMotionPrimary = mOrientationHandler.getPrimaryDirection(ev, 0);
1278 mLastMotion = (int) mDownMotionPrimary;
Vinit Nayaka406f722019-12-19 11:50:55 -08001279 mTotalMotion = 0;
Winson Chung4941f652020-06-18 15:11:53 -07001280 mAllowEasyFling = false;
Winson Chung321e9ee2010-08-09 13:37:56 -07001281 mActivePointerId = ev.getPointerId(0);
Sunny Goyalaad33592018-08-07 17:20:35 -07001282 if (mIsBeingDragged) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001283 pageBeginTransition();
Michael Jurka0142d492010-08-25 17:46:15 -07001284 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001285 break;
1286
Winson Chung4941f652020-06-18 15:11:53 -07001287 case ACTION_MOVE_ALLOW_EASY_FLING:
1288 // Start scrolling immediately
1289 determineScrollingStart(ev);
1290 mAllowEasyFling = true;
1291 break;
1292
1293 case MotionEvent.ACTION_MOVE:
1294 if (mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001295 // Scroll to follow the motion event
1296 final int pointerIndex = ev.findPointerIndex(mActivePointerId);
Adam Cohen7d30a372013-07-01 17:03:59 -07001297
1298 if (pointerIndex == -1) return true;
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001299 int oldScroll = mOrientationHandler.getPrimaryScroll(this);
1300 int dx = (int) ev.getX(pointerIndex);
1301 int dy = (int) ev.getY(pointerIndex);
Adam Cohen7d30a372013-07-01 17:03:59 -07001302
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001303 int direction = mOrientationHandler.getPrimaryValue(dx, dy);
1304 int delta = mLastMotion - direction;
Sunny Goyalc39db732021-04-03 01:20:21 -07001305
1306 int width = getWidth();
1307 int height = getHeight();
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001308 float size = mOrientationHandler.getPrimaryValue(width, height);
1309 float displacement = (width == 0 || height == 0) ? 0
1310 : (float) mOrientationHandler.getSecondaryValue(dx, dy)
1311 / mOrientationHandler.getSecondaryValue(width, height);
Vinit Nayaka406f722019-12-19 11:50:55 -08001312 mTotalMotion += Math.abs(delta);
Adam Cohenaefd4e12011-02-14 16:39:38 -08001313
Sunny Goyalc39db732021-04-03 01:20:21 -07001314 if (mAllowOverScroll) {
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001315 int consumed = 0;
Sunny Goyalc39db732021-04-03 01:20:21 -07001316 if (delta < 0 && mEdgeGlowRight.getDistance() != 0f) {
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001317 consumed = Math.round(size *
1318 mEdgeGlowRight.onPullDistance(delta / size, displacement));
Sunny Goyalc39db732021-04-03 01:20:21 -07001319 } else if (delta > 0 && mEdgeGlowLeft.getDistance() != 0f) {
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001320 consumed = Math.round(-size *
1321 mEdgeGlowLeft.onPullDistance(-delta / size, 1 - displacement));
Sunny Goyalc39db732021-04-03 01:20:21 -07001322 }
1323 delta -= consumed;
1324 }
Alex Chau822acf42021-06-03 11:35:05 +01001325 delta /= mOrientationHandler.getPrimaryScale(this);
Sunny Goyalc39db732021-04-03 01:20:21 -07001326
Winson Chungc0844aa2011-02-02 15:25:58 -08001327 // Only scroll and update mLastMotionX if we have moved some discrete amount. We
1328 // keep the remainder because we are actually testing if we've moved from the last
1329 // scrolled position (which is discrete).
Sunny Goyalc39db732021-04-03 01:20:21 -07001330 mLastMotion = direction;
Vinit Nayaka406f722019-12-19 11:50:55 -08001331
Sunny Goyalc39db732021-04-03 01:20:21 -07001332 if (delta != 0) {
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001333 mOrientationHandler.setPrimary(this, VIEW_SCROLL_BY, delta);
Sunny Goyalc39db732021-04-03 01:20:21 -07001334
1335 if (mAllowOverScroll) {
1336 final float pulledToX = oldScroll + delta;
1337
1338 if (pulledToX < mMinScroll) {
1339 mEdgeGlowLeft.onPullDistance(-delta / size, 1.f - displacement);
1340 if (!mEdgeGlowRight.isFinished()) {
1341 mEdgeGlowRight.onRelease();
1342 }
1343 } else if (pulledToX > mMaxScroll) {
1344 mEdgeGlowRight.onPullDistance(delta / size, displacement);
1345 if (!mEdgeGlowLeft.isFinished()) {
1346 mEdgeGlowLeft.onRelease();
1347 }
1348 }
1349
1350 if (!mEdgeGlowLeft.isFinished() || !mEdgeGlowRight.isFinished()) {
1351 postInvalidateOnAnimation();
1352 }
1353 }
1354
Winson Chung321e9ee2010-08-09 13:37:56 -07001355 } else {
1356 awakenScrollBars();
1357 }
Adam Cohen564976a2010-10-13 18:52:07 -07001358 } else {
Winson Chung321e9ee2010-08-09 13:37:56 -07001359 determineScrollingStart(ev);
1360 }
1361 break;
1362
1363 case MotionEvent.ACTION_UP:
Sunny Goyalaad33592018-08-07 17:20:35 -07001364 if (mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001365 final int activePointerId = mActivePointerId;
1366 final int pointerIndex = ev.findPointerIndex(activePointerId);
Vinit Nayak93bf1fe2020-05-26 17:22:13 -07001367 if (pointerIndex == -1) return true;
1368
Vinit Nayaka406f722019-12-19 11:50:55 -08001369 final float primaryDirection = mOrientationHandler.getPrimaryDirection(ev,
1370 pointerIndex);
Sunny Goyal4bb8b062019-02-19 16:37:38 -08001371 final VelocityTracker velocityTracker = mVelocityTracker;
1372 velocityTracker.computeCurrentVelocity(1000, mMaximumVelocity);
Adam Cohenaefd4e12011-02-14 16:39:38 -08001373
Vinit Nayaka406f722019-12-19 11:50:55 -08001374 int velocity = (int) mOrientationHandler.getPrimaryVelocity(velocityTracker,
Andras Kloczl07111f22022-03-30 17:25:54 +01001375 mActivePointerId);
Alex Chau822acf42021-06-03 11:35:05 +01001376 float delta = primaryDirection - mDownMotionPrimary;
Randy Pfohl583241e2023-03-02 03:26:56 +00001377
1378 View current = getPageAt(mCurrentPage);
1379 if (current == null) {
1380 Log.e(TAG, "current page was null. this should not happen.");
1381 return true;
1382 }
1383
1384 int pageOrientedSize = (int) (mOrientationHandler.getMeasuredSize(current)
Andras Kloczl07111f22022-03-30 17:25:54 +01001385 * mOrientationHandler.getPrimaryScale(this));
1386 boolean isSignificantMove = isSignificantMove(Math.abs(delta), pageOrientedSize);
Vinit Nayaka406f722019-12-19 11:50:55 -08001387
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001388 mTotalMotion += Math.abs(mLastMotion - primaryDirection);
Winson Chung4941f652020-06-18 15:11:53 -07001389 boolean passedSlop = mAllowEasyFling || mTotalMotion > mPageSlop;
1390 boolean isFling = passedSlop && shouldFlingForVelocity(velocity);
Vinit Nayaka406f722019-12-19 11:50:55 -08001391 boolean isDeltaLeft = mIsRtl ? delta > 0 : delta < 0;
1392 boolean isVelocityLeft = mIsRtl ? velocity > 0 : velocity < 0;
Winson Chung4941f652020-06-18 15:11:53 -07001393 if (DEBUG_FAILED_QUICKSWITCH && !isFling && mAllowEasyFling) {
1394 Log.d("Quickswitch", "isFling=false vel=" + velocity
1395 + " threshold=" + mEasyFlingThresholdVelocity);
1396 }
Adam Cohen00481b32011-11-18 12:03:48 -08001397
Adam Cohenf358a4b2013-07-23 16:47:31 -07001398 if (!mFreeScroll) {
1399 // In the case that the page is moved far to one direction and then is flung
1400 // in the opposite direction, we use a threshold to determine whether we should
1401 // just return to the starting page, or if we should skip one further.
1402 boolean returnToOriginalPage = false;
Vinit Nayaka406f722019-12-19 11:50:55 -08001403 if (Math.abs(delta) > pageOrientedSize * RETURN_TO_ORIGINAL_PAGE_THRESHOLD &&
1404 Math.signum(velocity) != Math.signum(delta) && isFling) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001405 returnToOriginalPage = true;
1406 }
Adam Cohenaefd4e12011-02-14 16:39:38 -08001407
Adam Cohenf358a4b2013-07-23 16:47:31 -07001408 int finalPage;
1409 // We give flings precedence over large moves, which is why we short-circuit our
1410 // test for a large move if a fling has been registered. That is, a large
1411 // move to the left and fling to the right will register as a fling to the right.
Sunny Goyalb7b01352018-08-09 12:31:20 -07001412
Vinit Nayaka406f722019-12-19 11:50:55 -08001413 if (((isSignificantMove && !isDeltaLeft && !isFling) ||
1414 (isFling && !isVelocityLeft)) && mCurrentPage > 0) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +01001415 finalPage = returnToOriginalPage
1416 ? mCurrentPage : mCurrentPage - getPanelCount();
Schneider Victor-tulias50f66512022-12-14 02:53:38 -08001417 runOnPageScrollsInitialized(
1418 () -> snapToPageWithVelocity(finalPage, velocity));
Vinit Nayaka406f722019-12-19 11:50:55 -08001419 } else if (((isSignificantMove && isDeltaLeft && !isFling) ||
1420 (isFling && isVelocityLeft)) &&
Adam Cohenf358a4b2013-07-23 16:47:31 -07001421 mCurrentPage < getChildCount() - 1) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +01001422 finalPage = returnToOriginalPage
1423 ? mCurrentPage : mCurrentPage + getPanelCount();
Schneider Victor-tulias50f66512022-12-14 02:53:38 -08001424 runOnPageScrollsInitialized(
1425 () -> snapToPageWithVelocity(finalPage, velocity));
Adam Cohenf358a4b2013-07-23 16:47:31 -07001426 } else {
Schneider Victor-tulias50f66512022-12-14 02:53:38 -08001427 runOnPageScrollsInitialized(this::snapToDestination);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001428 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001429 } else {
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001430 if (!mScroller.isFinished()) {
1431 abortScrollerAnimation(true);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001432 }
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001433
Vinit Nayaka406f722019-12-19 11:50:55 -08001434 int initialScroll = mOrientationHandler.getPrimaryScroll(this);
1435 int maxScroll = mMaxScroll;
1436 int minScroll = mMinScroll;
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001437
Vinit Nayaka406f722019-12-19 11:50:55 -08001438 if (((initialScroll >= maxScroll) && (isVelocityLeft || !isFling)) ||
1439 ((initialScroll <= minScroll) && (!isVelocityLeft || !isFling))) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001440 mScroller.springBack(initialScroll, 0, minScroll, maxScroll, 0, 0);
Alex Chaub794ea62021-02-03 18:00:30 +00001441 mNextPage = getDestinationPage();
Sunny Goyalb7b01352018-08-09 12:31:20 -07001442 } else {
Sunny Goyalc39db732021-04-03 01:20:21 -07001443 int velocity1 = -velocity;
1444 // Continue a scroll or fling in progress
1445 mScroller.fling(initialScroll, 0, velocity1, 0, minScroll, maxScroll, 0, 0,
1446 Math.round(getWidth() * 0.5f * OVERSCROLL_DAMP_FACTOR), 0);
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001447
Sunny Goyalc39db732021-04-03 01:20:21 -07001448 int finalPos = mScroller.getFinalX();
Alex Chaub794ea62021-02-03 18:00:30 +00001449 mNextPage = getDestinationPage(finalPos);
Schneider Victor-tulias50f66512022-12-14 02:53:38 -08001450 runOnPageScrollsInitialized(this::onNotSnappingToPageInFreeScroll);
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001451 }
1452 invalidate();
Winson Chung321e9ee2010-08-09 13:37:56 -07001453 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001454 }
Adam Cohen7d30a372013-07-01 17:03:59 -07001455
Sunny Goyalc39db732021-04-03 01:20:21 -07001456 mEdgeGlowLeft.onRelease();
1457 mEdgeGlowRight.onRelease();
Adam Cohen7d30a372013-07-01 17:03:59 -07001458 // End any intermediate reordering states
1459 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001460 break;
1461
1462 case MotionEvent.ACTION_CANCEL:
Sunny Goyalaad33592018-08-07 17:20:35 -07001463 if (mIsBeingDragged) {
Schneider Victor-tulias50f66512022-12-14 02:53:38 -08001464 runOnPageScrollsInitialized(this::snapToDestination);
Michael Jurkab8f06722010-10-10 15:58:46 -07001465 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001466 mEdgeGlowLeft.onRelease();
1467 mEdgeGlowRight.onRelease();
Adam Cohen7d30a372013-07-01 17:03:59 -07001468 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001469 break;
1470
1471 case MotionEvent.ACTION_POINTER_UP:
1472 onSecondaryPointerUp(ev);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001473 releaseVelocityTracker();
Winson Chung321e9ee2010-08-09 13:37:56 -07001474 break;
1475 }
1476
1477 return true;
1478 }
1479
Sunny Goyalc39db732021-04-03 01:20:21 -07001480 protected void onNotSnappingToPageInFreeScroll() { }
Alex Chaub794ea62021-02-03 18:00:30 +00001481
Lais Andradecc5c8842021-06-04 18:20:30 +01001482 /**
1483 * Called when the view edges absorb part of the scroll. Subclasses can override this
1484 * to provide custom behavior during animation.
1485 */
1486 protected void onEdgeAbsorbingScroll() {
1487 }
1488
1489 /**
1490 * Called when the current page closest to the center of the screen changes as part of the
1491 * scroll. Subclasses can override this to provide custom behavior during scroll.
1492 */
1493 protected void onScrollOverPageChanged() {
1494 }
1495
Vinit Nayaka406f722019-12-19 11:50:55 -08001496 protected boolean shouldFlingForVelocity(int velocity) {
Winson Chung4941f652020-06-18 15:11:53 -07001497 float threshold = mAllowEasyFling ? mEasyFlingThresholdVelocity : mFlingThresholdVelocity;
1498 return Math.abs(velocity) > threshold;
Sunny Goyal65d9ceb2017-05-08 09:17:42 -07001499 }
1500
Alex Chau9d8eeab2022-04-05 17:13:56 +01001501 protected void resetTouchState() {
Adam Cohen7d30a372013-07-01 17:03:59 -07001502 releaseVelocityTracker();
Sunny Goyalaad33592018-08-07 17:20:35 -07001503 mIsBeingDragged = false;
Adam Cohen7d30a372013-07-01 17:03:59 -07001504 mActivePointerId = INVALID_POINTER;
Adam Cohen7d30a372013-07-01 17:03:59 -07001505 }
1506
Winson Chung185d7162011-02-28 13:47:29 -08001507 @Override
1508 public boolean onGenericMotionEvent(MotionEvent event) {
1509 if ((event.getSource() & InputDevice.SOURCE_CLASS_POINTER) != 0) {
1510 switch (event.getAction()) {
1511 case MotionEvent.ACTION_SCROLL: {
1512 // Handle mouse (or ext. device) by shifting the page depending on the scroll
1513 final float vscroll;
1514 final float hscroll;
1515 if ((event.getMetaState() & KeyEvent.META_SHIFT_ON) != 0) {
1516 vscroll = 0;
1517 hscroll = event.getAxisValue(MotionEvent.AXIS_VSCROLL);
1518 } else {
1519 vscroll = -event.getAxisValue(MotionEvent.AXIS_VSCROLL);
1520 hscroll = event.getAxisValue(MotionEvent.AXIS_HSCROLL);
1521 }
Sunny Goyal8b37c572020-03-31 12:12:14 -07001522 if (!canScroll(Math.abs(vscroll), Math.abs(hscroll))) {
1523 return false;
Samuel Fufa59cba192019-08-22 18:31:34 -07001524 }
Winson Chung185d7162011-02-28 13:47:29 -08001525 if (hscroll != 0 || vscroll != 0) {
Sunny Goyal70660032015-05-14 00:07:08 -07001526 boolean isForwardScroll = mIsRtl ? (hscroll < 0 || vscroll < 0)
Adam Cohen0ffac432013-07-10 11:19:26 -07001527 : (hscroll > 0 || vscroll > 0);
1528 if (isForwardScroll) {
Winson Chung185d7162011-02-28 13:47:29 -08001529 scrollRight();
1530 } else {
1531 scrollLeft();
1532 }
1533 return true;
1534 }
1535 }
1536 }
1537 }
1538 return super.onGenericMotionEvent(event);
1539 }
1540
Sunny Goyal8b37c572020-03-31 12:12:14 -07001541 /**
1542 * Returns true if the paged view can scroll for the provided vertical and horizontal
1543 * scroll values
1544 */
1545 protected boolean canScroll(float absVScroll, float absHScroll) {
1546 ActivityContext ac = ActivityContext.lookupContext(getContext());
1547 return (ac == null || AbstractFloatingView.getTopOpenView(ac) == null);
Samuel Fufa59cba192019-08-22 18:31:34 -07001548 }
1549
Michael Jurkab8f06722010-10-10 15:58:46 -07001550 private void acquireVelocityTrackerAndAddMovement(MotionEvent ev) {
1551 if (mVelocityTracker == null) {
1552 mVelocityTracker = VelocityTracker.obtain();
1553 }
1554 mVelocityTracker.addMovement(ev);
1555 }
1556
1557 private void releaseVelocityTracker() {
1558 if (mVelocityTracker != null) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001559 mVelocityTracker.clear();
Michael Jurkab8f06722010-10-10 15:58:46 -07001560 mVelocityTracker.recycle();
1561 mVelocityTracker = null;
1562 }
1563 }
1564
Winson Chung321e9ee2010-08-09 13:37:56 -07001565 private void onSecondaryPointerUp(MotionEvent ev) {
Winson Chung4941f652020-06-18 15:11:53 -07001566 final int pointerIndex = ev.getActionIndex();
Winson Chung321e9ee2010-08-09 13:37:56 -07001567 final int pointerId = ev.getPointerId(pointerIndex);
1568 if (pointerId == mActivePointerId) {
1569 // This was our active pointer going up. Choose a new
1570 // active pointer and adjust accordingly.
1571 // TODO: Make this decision more intelligent.
1572 final int newPointerIndex = pointerIndex == 0 ? 1 : 0;
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001573 mDownMotionPrimary = mOrientationHandler.getPrimaryDirection(ev, newPointerIndex);
1574 mLastMotion = (int) mDownMotionPrimary;
Winson Chung321e9ee2010-08-09 13:37:56 -07001575 mActivePointerId = ev.getPointerId(newPointerIndex);
1576 if (mVelocityTracker != null) {
1577 mVelocityTracker.clear();
1578 }
1579 }
Jeff Brown1d0867c2010-12-02 18:27:39 -08001580 }
1581
Winson Chung321e9ee2010-08-09 13:37:56 -07001582 @Override
1583 public void requestChildFocus(View child, View focused) {
1584 super.requestChildFocus(child, focused);
Schneider Victor-tuliasbdae57c2023-10-10 11:16:54 -04001585 if (!shouldHandleRequestChildFocus()) {
1586 return;
1587 }
Andras Kloczl359d1ae2021-05-04 22:25:27 +02001588 // In case the device is controlled by a controller, mCurrentPage isn't updated properly
1589 // which results in incorrect navigation
1590 int nextPage = getNextPage();
1591 if (nextPage != mCurrentPage) {
1592 setCurrentPage(nextPage);
1593 }
1594
Andras Kloczl7e912442021-05-06 12:50:28 +02001595 int page = indexOfChild(child);
1596 if (page >= 0 && !isVisible(page) && !isInTouchMode()) {
Winson Chung86f77532010-08-24 11:08:22 -07001597 snapToPage(page);
Winson Chung321e9ee2010-08-09 13:37:56 -07001598 }
1599 }
1600
Schneider Victor-tuliasbdae57c2023-10-10 11:16:54 -04001601 protected boolean shouldHandleRequestChildFocus() {
1602 return true;
1603 }
1604
Alex Chaub794ea62021-02-03 18:00:30 +00001605 public int getDestinationPage() {
1606 return getDestinationPage(mOrientationHandler.getPrimaryScroll(this));
1607 }
1608
Alex Chaudedbc8a2021-03-17 16:53:26 +00001609 protected int getDestinationPage(int primaryScroll) {
1610 return getPageNearestToCenterOfScreen(primaryScroll);
Alex Chaub794ea62021-02-03 18:00:30 +00001611 }
1612
Sunny Goyal228153d2018-01-04 15:35:22 -08001613 public int getPageNearestToCenterOfScreen() {
Vinit Nayaka406f722019-12-19 11:50:55 -08001614 return getPageNearestToCenterOfScreen(mOrientationHandler.getPrimaryScroll(this));
Tony Wickham8f7ead32016-04-07 18:46:44 -07001615 }
1616
Alex Chaudedbc8a2021-03-17 16:53:26 +00001617 private int getPageNearestToCenterOfScreen(int primaryScroll) {
1618 int screenCenter = getScreenCenter(primaryScroll);
Adam Cohen22f823d2011-09-01 17:22:18 -07001619 int minDistanceFromScreenCenter = Integer.MAX_VALUE;
Winson Chung321e9ee2010-08-09 13:37:56 -07001620 int minDistanceFromScreenCenterIndex = -1;
Winson Chung321e9ee2010-08-09 13:37:56 -07001621 final int childCount = getChildCount();
1622 for (int i = 0; i < childCount; ++i) {
Tony Wickham7383d4e2020-07-07 19:25:25 -07001623 int distanceFromScreenCenter = Math.abs(
1624 getDisplacementFromScreenCenter(i, screenCenter));
Winson Chung321e9ee2010-08-09 13:37:56 -07001625 if (distanceFromScreenCenter < minDistanceFromScreenCenter) {
1626 minDistanceFromScreenCenter = distanceFromScreenCenter;
1627 minDistanceFromScreenCenterIndex = i;
1628 }
1629 }
Adam Cohend19d3ca2010-09-15 14:43:42 -07001630 return minDistanceFromScreenCenterIndex;
1631 }
1632
Tony Wickham7383d4e2020-07-07 19:25:25 -07001633 private int getDisplacementFromScreenCenter(int childIndex, int screenCenter) {
Cole Faust50ec4af2022-10-15 21:33:28 -07001634 int childSize = getChildVisibleSize(childIndex);
Tony Wickham7383d4e2020-07-07 19:25:25 -07001635 int halfChildSize = (childSize / 2);
1636 int childCenter = getChildOffset(childIndex) + halfChildSize;
1637 return childCenter - screenCenter;
1638 }
1639
1640 protected int getDisplacementFromScreenCenter(int childIndex) {
Alex Chaudedbc8a2021-03-17 16:53:26 +00001641 int primaryScroll = mOrientationHandler.getPrimaryScroll(this);
1642 int screenCenter = getScreenCenter(primaryScroll);
Tony Wickham7383d4e2020-07-07 19:25:25 -07001643 return getDisplacementFromScreenCenter(childIndex, screenCenter);
1644 }
1645
Andras Kloczl9732df12021-09-09 19:40:42 +01001646 protected int getScreenCenter(int primaryScroll) {
Alex Chaudedbc8a2021-03-17 16:53:26 +00001647 float primaryScale = mOrientationHandler.getPrimaryScale(this);
1648 float primaryPivot = mOrientationHandler.getPrimaryValue(getPivotX(), getPivotY());
1649 int pageOrientationSize = mOrientationHandler.getMeasuredSize(this);
1650 return Math.round(primaryScroll + (pageOrientationSize / 2f - primaryPivot) / primaryScale
1651 + primaryPivot);
1652 }
1653
Adam Cohend19d3ca2010-09-15 14:43:42 -07001654 protected void snapToDestination() {
Andras Kloczlc2bd15f2022-03-30 18:06:13 +01001655 snapToPage(getDestinationPage(), mPageSnapAnimationDuration);
Winson Chung321e9ee2010-08-09 13:37:56 -07001656 }
1657
Adam Cohene0f66b52010-11-23 15:06:07 -08001658 // We want the duration of the page snap animation to be influenced by the distance that
1659 // the screen has to travel, however, we don't want this duration to be effected in a
1660 // purely linear fashion. Instead, we use this method to moderate the effect that the distance
1661 // of travel has on the overall snap duration.
Sunny Goyal4d113a52015-05-27 10:05:28 -07001662 private float distanceInfluenceForSnapDuration(float f) {
Adam Cohene0f66b52010-11-23 15:06:07 -08001663 f -= 0.5f; // center the values about 0.
1664 f *= 0.3f * Math.PI / 2.0f;
1665 return (float) Math.sin(f);
1666 }
1667
Winson Chung05a31ed2018-02-08 17:08:43 -08001668 protected boolean snapToPageWithVelocity(int whichPage, int velocity) {
Adam Cohen6f127a62014-06-12 14:54:41 -07001669 whichPage = validateNewPage(whichPage);
Vinit Nayaka406f722019-12-19 11:50:55 -08001670 int halfScreenSize = mOrientationHandler.getMeasuredSize(this) / 2;
Adam Cohene0f66b52010-11-23 15:06:07 -08001671
Vinit Nayaka406f722019-12-19 11:50:55 -08001672 final int newLoc = getScrollForPage(whichPage);
Sunny Goyalc39db732021-04-03 01:20:21 -07001673 int delta = newLoc - mOrientationHandler.getPrimaryScroll(this);
Adam Cohene0f66b52010-11-23 15:06:07 -08001674 int duration = 0;
1675
Sunny Goyal4d113a52015-05-27 10:05:28 -07001676 if (Math.abs(velocity) < mMinFlingVelocity) {
Adam Cohene0f66b52010-11-23 15:06:07 -08001677 // If the velocity is low enough, then treat this more as an automatic page advance
1678 // as opposed to an apparent physical response to flinging
Andras Kloczlc2bd15f2022-03-30 18:06:13 +01001679 return snapToPage(whichPage, mPageSnapAnimationDuration);
Adam Cohene0f66b52010-11-23 15:06:07 -08001680 }
1681
1682 // Here we compute a "distance" that will be used in the computation of the overall
1683 // snap duration. This is a function of the actual distance that needs to be traveled;
1684 // we keep this value close to half screen size in order to reduce the variance in snap
1685 // duration as a function of the distance the page needs to travel.
Michael Jurka20b7ca92011-06-07 20:09:16 -07001686 float distanceRatio = Math.min(1f, 1.0f * Math.abs(delta) / (2 * halfScreenSize));
Adam Cohene0f66b52010-11-23 15:06:07 -08001687 float distance = halfScreenSize + halfScreenSize *
1688 distanceInfluenceForSnapDuration(distanceRatio);
1689
1690 velocity = Math.abs(velocity);
Adam Cohen265b9a62011-12-07 14:37:18 -08001691 velocity = Math.max(mMinSnapVelocity, velocity);
Adam Cohene0f66b52010-11-23 15:06:07 -08001692
1693 // we want the page's snap velocity to approximately match the velocity at which the
1694 // user flings, so we scale the duration by a value near to the derivative of the scroll
Michael Jurka20b7ca92011-06-07 20:09:16 -07001695 // interpolator at zero, ie. 5. We use 4 to make it a little slower.
1696 duration = 4 * Math.round(1000 * Math.abs(distance / velocity));
Adam Cohene0f66b52010-11-23 15:06:07 -08001697
Sunny Goyalc39db732021-04-03 01:20:21 -07001698 return snapToPage(whichPage, delta, duration);
Michael Jurka0142d492010-08-25 17:46:15 -07001699 }
1700
Winson Chung05a31ed2018-02-08 17:08:43 -08001701 public boolean snapToPage(int whichPage) {
Andras Kloczlc2bd15f2022-03-30 18:06:13 +01001702 return snapToPage(whichPage, mPageSnapAnimationDuration);
Winson Chung321e9ee2010-08-09 13:37:56 -07001703 }
1704
Winson Chung05a31ed2018-02-08 17:08:43 -08001705 public boolean snapToPageImmediately(int whichPage) {
Andras Kloczlc2bd15f2022-03-30 18:06:13 +01001706 return snapToPage(whichPage, mPageSnapAnimationDuration, true);
Adam Cohen7d30a372013-07-01 17:03:59 -07001707 }
1708
Winson Chung05a31ed2018-02-08 17:08:43 -08001709 public boolean snapToPage(int whichPage, int duration) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001710 return snapToPage(whichPage, duration, false);
Adam Cohen7d30a372013-07-01 17:03:59 -07001711 }
1712
Sunny Goyalc39db732021-04-03 01:20:21 -07001713 protected boolean snapToPage(int whichPage, int duration, boolean immediate) {
Adam Cohen6f127a62014-06-12 14:54:41 -07001714 whichPage = validateNewPage(whichPage);
Winson Chung321e9ee2010-08-09 13:37:56 -07001715
Vinit Nayaka406f722019-12-19 11:50:55 -08001716 int newLoc = getScrollForPage(whichPage);
Sunny Goyalc39db732021-04-03 01:20:21 -07001717 final int delta = newLoc - mOrientationHandler.getPrimaryScroll(this);
1718 return snapToPage(whichPage, delta, duration, immediate);
Michael Jurka0142d492010-08-25 17:46:15 -07001719 }
1720
Winson Chung05a31ed2018-02-08 17:08:43 -08001721 protected boolean snapToPage(int whichPage, int delta, int duration) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001722 return snapToPage(whichPage, delta, duration, false);
Adam Cohen7d30a372013-07-01 17:03:59 -07001723 }
Michael Jurka0142d492010-08-25 17:46:15 -07001724
Sunny Goyalc39db732021-04-03 01:20:21 -07001725 protected boolean snapToPage(int whichPage, int delta, int duration, boolean immediate) {
Sunny Goyal9bb8ffb2018-05-24 17:11:16 -07001726 if (mFirstLayout) {
1727 setCurrentPage(whichPage);
1728 return false;
1729 }
Tony Wickhamd58c2d52018-05-04 12:10:55 -07001730
Brian Isganitisfdd044e2023-03-02 19:45:23 +00001731 if (FeatureFlags.IS_STUDIO_BUILD && !Utilities.isRunningInTestHarness()) {
Tony Wickhamcb3f8702018-08-27 17:36:03 -07001732 duration *= Settings.Global.getFloat(getContext().getContentResolver(),
1733 Settings.Global.WINDOW_ANIMATION_SCALE, 1);
Tony Wickhamd58c2d52018-05-04 12:10:55 -07001734 }
1735
Adam Cohen6f127a62014-06-12 14:54:41 -07001736 whichPage = validateNewPage(whichPage);
1737
Adam Cohen7d30a372013-07-01 17:03:59 -07001738 mNextPage = whichPage;
Michael Jurka0142d492010-08-25 17:46:15 -07001739
Winson Chung321e9ee2010-08-09 13:37:56 -07001740 awakenScrollBars(duration);
Adam Cohen7d30a372013-07-01 17:03:59 -07001741 if (immediate) {
1742 duration = 0;
1743 } else if (duration == 0) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001744 duration = Math.abs(delta);
1745 }
1746
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001747 if (duration != 0) {
1748 pageBeginTransition();
1749 }
1750
Adam Cohenf358a4b2013-07-23 16:47:31 -07001751 if (!mScroller.isFinished()) {
Adam Cohenf9618852013-11-08 06:45:03 -08001752 abortScrollerAnimation(false);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001753 }
Adam Cohenf9618852013-11-08 06:45:03 -08001754
Sunny Goyalc39db732021-04-03 01:20:21 -07001755 mScroller.startScroll(mOrientationHandler.getPrimaryScroll(this), 0, delta, 0, duration);
Adam Cohen674531f2013-12-13 15:07:14 -08001756 updatePageIndicator();
Adam Cohen7d30a372013-07-01 17:03:59 -07001757
1758 // Trigger a compute() to finish switching pages if necessary
1759 if (immediate) {
1760 computeScroll();
Sunny Goyal76dbf6f2017-01-03 14:55:47 -08001761 pageEndTransition();
Adam Cohen7d30a372013-07-01 17:03:59 -07001762 }
1763
Winson Chung321e9ee2010-08-09 13:37:56 -07001764 invalidate();
Winson Chung05a31ed2018-02-08 17:08:43 -08001765 return Math.abs(delta) > 0;
Winson Chung321e9ee2010-08-09 13:37:56 -07001766 }
1767
Vadim Tryshev98913d02018-05-18 18:41:34 -07001768 public boolean scrollLeft() {
1769 if (getNextPage() > 0) {
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001770 snapToPage(getNextPage() - getPanelCount());
Vadim Tryshev98913d02018-05-18 18:41:34 -07001771 return true;
1772 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001773 return mAllowOverScroll;
Winson Chung321e9ee2010-08-09 13:37:56 -07001774 }
1775
Vadim Tryshev98913d02018-05-18 18:41:34 -07001776 public boolean scrollRight() {
1777 if (getNextPage() < getChildCount() - 1) {
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001778 snapToPage(getNextPage() + getPanelCount());
Vadim Tryshev98913d02018-05-18 18:41:34 -07001779 return true;
1780 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001781 return mAllowOverScroll;
Winson Chung321e9ee2010-08-09 13:37:56 -07001782 }
1783
Vadim Trysheve6bbefb2018-04-03 13:38:06 -07001784 @Override
Lais Andradecc5c8842021-06-04 18:20:30 +01001785 protected void onScrollChanged(int l, int t, int oldl, int oldt) {
Lais Andradef6e31b12021-10-27 12:04:28 +01001786 if (mScroller.isFinished()) {
1787 // This was not caused by the scroller, skip it.
1788 return;
1789 }
Lais Andradecc5c8842021-06-04 18:20:30 +01001790 int newDestinationPage = getDestinationPage();
1791 if (newDestinationPage >= 0 && newDestinationPage != mCurrentScrollOverPage) {
1792 mCurrentScrollOverPage = newDestinationPage;
1793 onScrollOverPageChanged();
1794 }
1795 }
1796
1797 @Override
Vadim Trysheve6bbefb2018-04-03 13:38:06 -07001798 public CharSequence getAccessibilityClassName() {
1799 // Some accessibility services have special logic for ScrollView. Since we provide same
1800 // accessibility info as ScrollView, inform the service to handle use the same way.
1801 return ScrollView.class.getName();
1802 }
1803
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001804 protected boolean isPageOrderFlipped() {
1805 return false;
1806 }
1807
Winson Chung6a0f57d2011-06-29 20:10:49 -07001808 /* Accessibility */
Sunny Goyalcf25b522015-07-09 00:01:18 -07001809 @SuppressWarnings("deprecation")
Winson Chung6a0f57d2011-06-29 20:10:49 -07001810 @Override
1811 public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) {
1812 super.onInitializeAccessibilityNodeInfo(info);
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001813 final boolean pagesFlipped = isPageOrderFlipped();
Alex Chau9ead9ca2021-11-26 16:22:49 +00001814 info.setScrollable(getPageCount() > 0);
1815 int primaryScroll = mOrientationHandler.getPrimaryScroll(this);
1816 if (getCurrentPage() < getPageCount() - getPanelCount()
1817 || (getCurrentPage() == getPageCount() - getPanelCount()
1818 && primaryScroll != getScrollForPage(getPageCount() - getPanelCount()))) {
yingleiw02cc8482019-08-02 16:14:27 -07001819 info.addAction(pagesFlipped ?
Alex Chau9ead9ca2021-11-26 16:22:49 +00001820 AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_BACKWARD
1821 : AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_FORWARD);
yingleiw02cc8482019-08-02 16:14:27 -07001822 info.addAction(mIsRtl ?
1823 AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_LEFT
1824 : AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_RIGHT);
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001825 }
Alex Chau9ead9ca2021-11-26 16:22:49 +00001826 if (getCurrentPage() > 0
1827 || (getCurrentPage() == 0 && primaryScroll != getScrollForPage(0))) {
yingleiw02cc8482019-08-02 16:14:27 -07001828 info.addAction(pagesFlipped ?
Alex Chau9ead9ca2021-11-26 16:22:49 +00001829 AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_FORWARD
1830 : AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_BACKWARD);
yingleiw02cc8482019-08-02 16:14:27 -07001831 info.addAction(mIsRtl ?
1832 AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_RIGHT
1833 : AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_LEFT);
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001834 }
Vadim Tryshev7af0d442015-05-15 08:48:11 -07001835 // Accessibility-wise, PagedView doesn't support long click, so disabling it.
1836 // Besides disabling the accessibility long-click, this also prevents this view from getting
1837 // accessibility focus.
1838 info.setLongClickable(false);
Sunny Goyala52ecb02016-12-16 15:04:51 -08001839 info.removeAction(AccessibilityNodeInfo.AccessibilityAction.ACTION_LONG_CLICK);
Winson Chung6a0f57d2011-06-29 20:10:49 -07001840 }
1841
1842 @Override
Alan Viverette254139a2013-10-08 13:13:46 -07001843 public void sendAccessibilityEvent(int eventType) {
1844 // Don't let the view send real scroll events.
1845 if (eventType != AccessibilityEvent.TYPE_VIEW_SCROLLED) {
1846 super.sendAccessibilityEvent(eventType);
1847 }
1848 }
1849
1850 @Override
Winson Chung6a0f57d2011-06-29 20:10:49 -07001851 public void onInitializeAccessibilityEvent(AccessibilityEvent event) {
1852 super.onInitializeAccessibilityEvent(event);
Pinyao Tingaf6daa22019-09-18 22:18:03 +00001853 event.setScrollable(mAllowOverScroll || getPageCount() > 1);
Winson Chung6a0f57d2011-06-29 20:10:49 -07001854 }
1855
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001856 @Override
1857 public boolean performAccessibilityAction(int action, Bundle arguments) {
1858 if (super.performAccessibilityAction(action, arguments)) {
1859 return true;
1860 }
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001861 final boolean pagesFlipped = isPageOrderFlipped();
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001862 switch (action) {
1863 case AccessibilityNodeInfo.ACTION_SCROLL_FORWARD: {
Vadim Tryshev98913d02018-05-18 18:41:34 -07001864 if (pagesFlipped ? scrollLeft() : scrollRight()) {
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001865 return true;
1866 }
1867 } break;
1868 case AccessibilityNodeInfo.ACTION_SCROLL_BACKWARD: {
Vadim Tryshev98913d02018-05-18 18:41:34 -07001869 if (pagesFlipped ? scrollRight() : scrollLeft()) {
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001870 return true;
1871 }
yingleiw02cc8482019-08-02 16:14:27 -07001872 } break;
1873 case android.R.id.accessibilityActionPageRight: {
1874 if (!mIsRtl) {
Alex Chau9ead9ca2021-11-26 16:22:49 +00001875 return scrollRight();
yingleiw02cc8482019-08-02 16:14:27 -07001876 } else {
Alex Chau9ead9ca2021-11-26 16:22:49 +00001877 return scrollLeft();
yingleiw02cc8482019-08-02 16:14:27 -07001878 }
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001879 }
yingleiw02cc8482019-08-02 16:14:27 -07001880 case android.R.id.accessibilityActionPageLeft: {
1881 if (!mIsRtl) {
Alex Chau9ead9ca2021-11-26 16:22:49 +00001882 return scrollLeft();
yingleiw02cc8482019-08-02 16:14:27 -07001883 } else {
Alex Chau9ead9ca2021-11-26 16:22:49 +00001884 return scrollRight();
yingleiw02cc8482019-08-02 16:14:27 -07001885 }
1886 }
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001887 }
1888 return false;
1889 }
1890
Vadim Tryshev2c430b32018-04-04 14:45:21 -07001891 protected boolean canAnnouncePageDescription() {
1892 return true;
1893 }
1894
Adam Cohen0ffac432013-07-10 11:19:26 -07001895 protected String getCurrentPageDescription() {
Sunny Goyalf4f89ef2015-09-02 15:06:12 -07001896 return getContext().getString(R.string.default_scroll_format,
Adam Cohen0ffac432013-07-10 11:19:26 -07001897 getNextPage() + 1, getChildCount());
1898 }
1899
Tony Mak2e564402018-02-27 17:19:34 +00001900 protected float getDownMotionX() {
1901 return mDownMotionX;
1902 }
1903
1904 protected float getDownMotionY() {
1905 return mDownMotionY;
1906 }
1907
Sunny Goyal20a13ff2018-03-13 16:44:00 -07001908 protected interface ComputePageScrollsLogic {
1909
1910 boolean shouldIncludeView(View view);
1911 }
Vadim Tryshev528b9e02018-05-24 18:22:03 -07001912
1913 public int[] getVisibleChildrenRange() {
1914 float visibleLeft = 0;
1915 float visibleRight = visibleLeft + getMeasuredWidth();
1916 float scaleX = getScaleX();
1917 if (scaleX < 1 && scaleX > 0) {
1918 float mid = getMeasuredWidth() / 2;
1919 visibleLeft = mid - ((mid - visibleLeft) / scaleX);
1920 visibleRight = mid + ((visibleRight - mid) / scaleX);
1921 }
1922
1923 int leftChild = -1;
1924 int rightChild = -1;
1925 final int childCount = getChildCount();
1926 for (int i = 0; i < childCount; i++) {
1927 final View child = getPageAt(i);
1928
1929 float left = child.getLeft() + child.getTranslationX() - getScrollX();
1930 if (left <= visibleRight && (left + child.getMeasuredWidth()) >= visibleLeft) {
1931 if (leftChild == -1) {
1932 leftChild = i;
1933 }
1934 rightChild = i;
1935 }
1936 }
1937 mTmpIntPair[0] = leftChild;
1938 mTmpIntPair[1] = rightChild;
1939 return mTmpIntPair;
1940 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001941
1942 @Override
1943 public void draw(Canvas canvas) {
1944 super.draw(canvas);
1945 drawEdgeEffect(canvas);
Sunny Goyal05b59c02021-04-29 13:55:40 -07001946 pageEndTransition();
Sunny Goyalc39db732021-04-03 01:20:21 -07001947 }
1948
1949 protected void drawEdgeEffect(Canvas canvas) {
1950 if (mAllowOverScroll && (!mEdgeGlowRight.isFinished() || !mEdgeGlowLeft.isFinished())) {
1951 final int width = getWidth();
1952 final int height = getHeight();
1953 if (!mEdgeGlowLeft.isFinished()) {
1954 final int restoreCount = canvas.save();
1955 canvas.rotate(-90);
1956 canvas.translate(-height, Math.min(mMinScroll, getScrollX()));
1957 mEdgeGlowLeft.setSize(height, width);
1958 if (mEdgeGlowLeft.draw(canvas)) {
1959 postInvalidateOnAnimation();
1960 }
1961 canvas.restoreToCount(restoreCount);
1962 }
1963 if (!mEdgeGlowRight.isFinished()) {
1964 final int restoreCount = canvas.save();
1965 canvas.rotate(90, width, 0);
1966 canvas.translate(width, -(Math.max(mMaxScroll, getScrollX())));
1967
1968 mEdgeGlowRight.setSize(height, width);
1969 if (mEdgeGlowRight.draw(canvas)) {
1970 postInvalidateOnAnimation();
1971 }
1972 canvas.restoreToCount(restoreCount);
1973 }
1974 }
1975 }
Adam Cohen5084cba2013-09-03 12:01:16 -07001976}