blob: f355ae71284f8e8fad3c1a167072cbeebe6a99f2 [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;
Sunny Goyalacd17df2020-04-03 15:58:45 -0700121 protected PagedOrientationHandler mOrientationHandler = PagedOrientationHandler.PORTRAIT;
Adam Cohenedb40762013-07-18 16:45:45 -0700122
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700123 private final ArrayList<Runnable> mOnPageScrollsInitializedCallbacks = new ArrayList<>();
124
125 // We should always check pageScrollsInitialized() is true when using mPageScrolls.
126 @Nullable protected int[] mPageScrolls = null;
Sunny Goyalaad33592018-08-07 17:20:35 -0700127 private boolean mIsBeingDragged;
Adam Cohencae7f572013-11-04 14:42:52 -0800128
Winson Chung4941f652020-06-18 15:11:53 -0700129 // The amount of movement to begin scrolling
Michael Jurka7426c422010-11-11 15:23:47 -0800130 protected int mTouchSlop;
Winson Chung4941f652020-06-18 15:11:53 -0700131 // The amount of movement to begin paging
132 protected int mPageSlop;
Winson Chung321e9ee2010-08-09 13:37:56 -0700133 private int mMaximumVelocity;
Adam Cohen68d73932010-11-15 10:50:58 -0800134 protected boolean mAllowOverScroll = true;
Winson Chung321e9ee2010-08-09 13:37:56 -0700135
Michael Jurka5f1c5092010-09-03 14:15:02 -0700136 protected static final int INVALID_POINTER = -1;
Winson Chung321e9ee2010-08-09 13:37:56 -0700137
Michael Jurka5f1c5092010-09-03 14:15:02 -0700138 protected int mActivePointerId = INVALID_POINTER;
Winson Chung321e9ee2010-08-09 13:37:56 -0700139
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700140 protected boolean mIsPageInTransition = false;
Tony Wickham62117d72020-03-26 16:56:26 -0700141 private Runnable mOnPageTransitionEndCallback;
Patrick Dubroy1262e362010-10-06 15:49:50 -0700142
Winson Chungd2be3812013-07-16 11:11:32 -0700143 // Page Indicator
Adam Cohen091440a2015-03-18 14:16:05 -0700144 @Thunk int mPageIndicatorViewId;
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800145 protected T mPageIndicator;
Adam Cohen7d30a372013-07-01 17:03:59 -0700146
John Spurlock77e1f472013-09-11 10:09:51 -0400147 protected final Rect mInsets = new Rect();
Tony Wickhamdfb5cc92018-02-26 16:41:57 -0800148 protected boolean mIsRtl;
John Spurlock77e1f472013-09-11 10:09:51 -0400149
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800150 // Similar to the platform implementation of isLayoutValid();
151 protected boolean mIsLayoutValid;
152
Vadim Tryshev528b9e02018-05-24 18:22:03 -0700153 private int[] mTmpIntPair = new int[2];
154
Sunny Goyalc39db732021-04-03 01:20:21 -0700155 protected EdgeEffectCompat mEdgeGlowLeft;
156 protected EdgeEffectCompat mEdgeGlowRight;
157
Winson Chung321e9ee2010-08-09 13:37:56 -0700158 public PagedView(Context context) {
159 this(context, null);
160 }
161
162 public PagedView(Context context, AttributeSet attrs) {
163 this(context, attrs, 0);
164 }
165
166 public PagedView(Context context, AttributeSet attrs, int defStyle) {
167 super(context, attrs, defStyle);
Winson Chungc9ca2982013-07-19 12:07:38 -0700168
Adam Cohen9c4949e2010-10-05 12:27:22 -0700169 TypedArray a = context.obtainStyledAttributes(attrs,
170 R.styleable.PagedView, defStyle, 0);
Winson Chungd2be3812013-07-16 11:11:32 -0700171 mPageIndicatorViewId = a.getResourceId(R.styleable.PagedView_pageIndicator, -1);
Adam Cohen9c4949e2010-10-05 12:27:22 -0700172 a.recycle();
173
Winson Chung321e9ee2010-08-09 13:37:56 -0700174 setHapticFeedbackEnabled(false);
Sunny Goyal70660032015-05-14 00:07:08 -0700175 mIsRtl = Utilities.isRtl(getResources());
Winson Chung321e9ee2010-08-09 13:37:56 -0700176
Sunny Goyalc39db732021-04-03 01:20:21 -0700177 mScroller = new OverScroller(context, SCROLL);
Winson Chung86f77532010-08-24 11:08:22 -0700178 mCurrentPage = 0;
Lais Andradecc5c8842021-06-04 18:20:30 +0100179 mCurrentScrollOverPage = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -0700180
Vinit Nayaka406f722019-12-19 11:50:55 -0800181 final ViewConfiguration configuration = ViewConfiguration.get(context);
Winson Chung4941f652020-06-18 15:11:53 -0700182 mTouchSlop = configuration.getScaledTouchSlop();
183 mPageSlop = configuration.getScaledPagingTouchSlop();
Winson Chung321e9ee2010-08-09 13:37:56 -0700184 mMaximumVelocity = configuration.getScaledMaximumFlingVelocity();
Adam Cohen265b9a62011-12-07 14:37:18 -0800185
Andras Kloczlc2bd15f2022-03-30 18:06:13 +0100186 updateVelocityValues();
Sunny Goyala9f55462018-03-25 18:15:15 -0700187
Sunny Goyalc39db732021-04-03 01:20:21 -0700188 initEdgeEffect();
Sunny Goyaleaf7a952020-07-29 16:54:20 -0700189 setDefaultFocusHighlightEnabled(false);
Sunny Goyalc39db732021-04-03 01:20:21 -0700190 setWillNotDraw(false);
Winson Chung321e9ee2010-08-09 13:37:56 -0700191 }
192
Sunny Goyalc39db732021-04-03 01:20:21 -0700193 protected void initEdgeEffect() {
194 mEdgeGlowLeft = new EdgeEffectCompat(getContext());
195 mEdgeGlowRight = new EdgeEffectCompat(getContext());
Adam Cohenf9618852013-11-08 06:45:03 -0800196 }
197
Sunny Goyald0a6ae72016-06-16 12:29:03 -0700198 public void initParentViews(View parent) {
199 if (mPageIndicatorViewId > -1) {
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800200 mPageIndicator = parent.findViewById(mPageIndicatorViewId);
Tony Wickhambab101c2021-09-20 15:12:44 -0700201 mPageIndicator.setMarkersCount(getChildCount() / getPanelCount());
Winson Chungd2be3812013-07-16 11:11:32 -0700202 }
203 }
204
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800205 public T getPageIndicator() {
Adam Cohenedb40762013-07-18 16:45:45 -0700206 return mPageIndicator;
207 }
208
Adam Cohen674531f2013-12-13 15:07:14 -0800209 /**
Tony Wickham29d853c2015-09-08 10:35:56 -0700210 * Returns the index of the currently displayed page. When in free scroll mode, this is the page
211 * that the user was on before entering free scroll mode (e.g. the home screen page they
Alex Chaub794ea62021-02-03 18:00:30 +0000212 * long-pressed on to enter the overview). Try using {@link #getDestinationPage()}
Tony Wickham29d853c2015-09-08 10:35:56 -0700213 * to get the page the user is currently scrolling over.
Winson Chung321e9ee2010-08-09 13:37:56 -0700214 */
Sunny Goyal83a8f042015-05-19 12:52:12 -0700215 public int getCurrentPage() {
Winson Chung86f77532010-08-24 11:08:22 -0700216 return mCurrentPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700217 }
Adam Cohen7d30a372013-07-01 17:03:59 -0700218
Hyunyoung Songb76cd622015-04-16 14:34:09 -0700219 /**
220 * Returns the index of page to be shown immediately afterwards.
221 */
Vadim Tryshevfedca432015-08-19 17:55:02 -0700222 public int getNextPage() {
Winson Chung360e63f2012-04-27 13:48:05 -0700223 return (mNextPage != INVALID_PAGE) ? mNextPage : mCurrentPage;
224 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700225
Adam Cohenf9c184a2016-01-15 16:47:43 -0800226 public int getPageCount() {
Winson Chung321e9ee2010-08-09 13:37:56 -0700227 return getChildCount();
228 }
229
Sunny Goyal83a8f042015-05-19 12:52:12 -0700230 public View getPageAt(int index) {
Winson Chung321e9ee2010-08-09 13:37:56 -0700231 return getChildAt(index);
232 }
233
Winson Chung321e9ee2010-08-09 13:37:56 -0700234 /**
Winson Chungbbc60d82010-11-11 16:34:41 -0800235 * Updates the scroll of the current page immediately to its final scroll position. We use this
236 * in CustomizePagedView to allow tabs to share the same PagedView while resetting the scroll of
237 * the previous tab page.
238 */
239 protected void updateCurrentPageScroll() {
Adam Cohen0ffac432013-07-10 11:19:26 -0700240 // If the current page is invalid, just reset the scroll position to zero
Vinit Nayaka406f722019-12-19 11:50:55 -0800241 int newPosition = 0;
Adam Cohen0ffac432013-07-10 11:19:26 -0700242 if (0 <= mCurrentPage && mCurrentPage < getPageCount()) {
Alex Chauba61b982021-06-15 16:29:19 +0100243 newPosition = getScrollForPage(mCurrentPage) + mCurrentPageScrollDiff;
Adam Cohen0ffac432013-07-10 11:19:26 -0700244 }
Alex Chau6499e832021-11-19 14:35:46 +0000245 mOrientationHandler.setPrimary(this, VIEW_SCROLL_TO, newPosition);
Sunny Goyalc39db732021-04-03 01:20:21 -0700246 mScroller.startScroll(mScroller.getCurrX(), 0, newPosition - mScroller.getCurrX(), 0);
Tony Wickhamd5521322021-09-14 14:26:50 -0700247 forceFinishScroller();
Winson Chungbbc60d82010-11-11 16:34:41 -0800248 }
249
Tony Wickhamf8d731a2021-05-26 14:58:13 -0700250 /**
251 * Immediately finishes any overscroll effect and jumps to the end of the scroller animation.
252 */
253 public void abortScrollerAnimation() {
254 mEdgeGlowLeft.finish();
255 mEdgeGlowRight.finish();
256 abortScrollerAnimation(true);
257 }
258
Schneider Victor-tuliasa602a0a2022-09-06 13:34:00 -0700259 protected void onScrollerAnimationAborted() {
260 // No-Op
261 }
262
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700263 private void abortScrollerAnimation(boolean resetNextPage) {
Adam Cohen4fe4c932013-10-28 16:02:34 -0700264 mScroller.abortAnimation();
Schneider Victor-tuliasa602a0a2022-09-06 13:34:00 -0700265 onScrollerAnimationAborted();
Adam Cohen4fe4c932013-10-28 16:02:34 -0700266 // We need to clean up the next page here to avoid computeScrollHelper from
267 // updating current page on the pass.
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700268 if (resetNextPage) {
269 mNextPage = INVALID_PAGE;
Sunny Goyal857b1b92018-03-05 10:49:05 -0800270 pageEndTransition();
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700271 }
Chet Haasebc2f0822012-10-26 17:59:53 -0700272 }
Adam Cohen4fe4c932013-10-28 16:02:34 -0700273
Tony Wickhamd5521322021-09-14 14:26:50 -0700274 /**
275 * Immediately finishes any in-progress scroll, maintaining the current position. Also sets
276 * mNextPage = INVALID_PAGE and calls pageEndTransition().
277 */
278 public void forceFinishScroller() {
Adam Cohen4fe4c932013-10-28 16:02:34 -0700279 mScroller.forceFinished(true);
280 // We need to clean up the next page here to avoid computeScrollHelper from
281 // updating current page on the pass.
Tony Wickhamd5521322021-09-14 14:26:50 -0700282 mNextPage = INVALID_PAGE;
283 pageEndTransition();
Adam Cohen4fe4c932013-10-28 16:02:34 -0700284 }
285
Adam Cohen6f127a62014-06-12 14:54:41 -0700286 private int validateNewPage(int newPage) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700287 newPage = ensureWithinScrollBounds(newPage);
Adam Cohen6f127a62014-06-12 14:54:41 -0700288 // Ensure that it is clamped by the actual set of children in all cases
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100289 newPage = Utilities.boundToRange(newPage, 0, getPageCount() - 1);
290
291 if (getPanelCount() > 1) {
Alex Chau1e448462021-08-13 21:48:35 +0100292 // Always return left most panel as new page
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100293 newPage = getLeftmostVisiblePageForIndex(newPage);
294 }
295 return newPage;
296 }
297
Andras Kloczl55edfe52021-05-14 12:21:30 +0200298 /**
299 * In most cases where panelCount is 1, this method will just return the page index that was
300 * passed in.
301 * But for example when two panel home is enabled we might need the leftmost visible page index
302 * because that page is the current page.
303 */
304 public int getLeftmostVisiblePageForIndex(int pageIndex) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100305 int panelCount = getPanelCount();
Andras Kloczl55edfe52021-05-14 12:21:30 +0200306 return pageIndex - pageIndex % panelCount;
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100307 }
308
309 /**
310 * Returns the number of pages that are shown at the same time.
311 */
312 protected int getPanelCount() {
313 return 1;
314 }
315
316 /**
Andras Kloczl55edfe52021-05-14 12:21:30 +0200317 * Returns an IntSet with the indices of the currently visible pages
318 */
Andras Kloczl55edfe52021-05-14 12:21:30 +0200319 public IntSet getVisiblePageIndices() {
Andras Kloczl7e912442021-05-06 12:50:28 +0200320 return getPageIndices(mCurrentPage);
321 }
322
323 /**
324 * In case the panelCount is 1 this just returns the same page index in an IntSet.
325 * But in cases where the panelCount > 1 this will return all the page indices that belong
326 * together, i.e. on the Workspace they are next to each other and shown at the same time.
327 */
328 private IntSet getPageIndices(int pageIndex) {
329 // we want to make sure the pageIndex is the leftmost page
330 pageIndex = getLeftmostVisiblePageForIndex(pageIndex);
331
332 IntSet pageIndices = new IntSet();
Andras Kloczl55edfe52021-05-14 12:21:30 +0200333 int panelCount = getPanelCount();
334 int pageCount = getPageCount();
Andras Kloczl7e912442021-05-06 12:50:28 +0200335 for (int page = pageIndex; page < pageIndex + panelCount && page < pageCount; page++) {
336 pageIndices.add(page);
Andras Kloczl55edfe52021-05-14 12:21:30 +0200337 }
Andras Kloczl7e912442021-05-06 12:50:28 +0200338 return pageIndices;
339 }
340
341 /**
342 * Returns an IntSet with the indices of the neighbour pages that are in the focus direction.
343 */
344 private IntSet getNeighbourPageIndices(int focus) {
345 int panelCount = getPanelCount();
346 // getNextPage is more reliable than getCurrentPage
347 int currentPage = getNextPage();
348
349 int nextPage;
350 if (focus == View.FOCUS_LEFT) {
351 nextPage = currentPage - panelCount;
352 } else if (focus == View.FOCUS_RIGHT) {
353 nextPage = currentPage + panelCount;
354 } else {
Andras Kloczlb0632942021-08-03 14:03:58 +0200355 // no neighbours to other directions
Andras Kloczl7e912442021-05-06 12:50:28 +0200356 return new IntSet();
357 }
358 nextPage = validateNewPage(nextPage);
359 if (nextPage == currentPage) {
360 // We reached the end of the pages
361 return new IntSet();
362 }
363
Andras Kloczlb0632942021-08-03 14:03:58 +0200364 return getPageIndices(nextPage);
Andras Kloczl55edfe52021-05-14 12:21:30 +0200365 }
366
367 /**
Sunny Goyal59969372021-05-06 12:11:44 -0700368 * Executes the callback against each visible page
Andras Kloczl2bb51342021-03-20 01:13:45 +0100369 */
Sunny Goyal59969372021-05-06 12:11:44 -0700370 public void forEachVisiblePage(Consumer<View> callback) {
Andras Kloczl55edfe52021-05-14 12:21:30 +0200371 getVisiblePageIndices().forEach(pageIndex -> {
372 View page = getPageAt(pageIndex);
Andras Kloczl2bb51342021-03-20 01:13:45 +0100373 if (page != null) {
Sunny Goyal59969372021-05-06 12:11:44 -0700374 callback.accept(page);
Andras Kloczl2bb51342021-03-20 01:13:45 +0100375 }
Andras Kloczl55edfe52021-05-14 12:21:30 +0200376 });
Andras Kloczl2bb51342021-03-20 01:13:45 +0100377 }
378
379 /**
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100380 * Returns true if the view is on one of the current pages, false otherwise.
381 */
382 public boolean isVisible(View child) {
Andras Kloczl7e912442021-05-06 12:50:28 +0200383 return isVisible(indexOfChild(child));
384 }
385
386 /**
387 * Returns true if the page with the given index is currently visible, false otherwise.
388 */
389 private boolean isVisible(int pageIndex) {
390 return getLeftmostVisiblePageForIndex(pageIndex) == mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700391 }
392
Chet Haasebc2f0822012-10-26 17:59:53 -0700393 /**
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700394 * @return The closest page to the provided page that is within mMinScrollX and mMaxScrollX.
395 */
396 private int ensureWithinScrollBounds(int page) {
397 int dir = !mIsRtl ? 1 : - 1;
398 int currScroll = getScrollForPage(page);
399 int prevScroll;
Vinit Nayaka406f722019-12-19 11:50:55 -0800400 while (currScroll < mMinScroll) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700401 page += dir;
402 prevScroll = currScroll;
403 currScroll = getScrollForPage(page);
404 if (currScroll <= prevScroll) {
405 Log.e(TAG, "validateNewPage: failed to find a page > mMinScrollX");
406 break;
407 }
408 }
Vinit Nayaka406f722019-12-19 11:50:55 -0800409 while (currScroll > mMaxScroll) {
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 < mMaxScrollX");
415 break;
416 }
417 }
418 return page;
419 }
420
Tony Wickham03f27012019-04-25 14:22:54 -0700421 public void setCurrentPage(int currentPage) {
422 setCurrentPage(currentPage, INVALID_PAGE);
423 }
424
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700425 /**
Winson Chung86f77532010-08-24 11:08:22 -0700426 * Sets the current page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700427 */
Tony Wickham03f27012019-04-25 14:22:54 -0700428 public void setCurrentPage(int currentPage, int overridePrevPage) {
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800429 if (!mScroller.isFinished()) {
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700430 abortScrollerAnimation(true);
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800431 }
Michael Jurkad3ef3062010-11-23 16:23:58 -0800432 // don't introduce any checks like mCurrentPage == currentPage here-- if we change the
433 // the default
434 if (getChildCount() == 0) {
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800435 return;
436 }
Tony Wickham03f27012019-04-25 14:22:54 -0700437 int prevPage = overridePrevPage != INVALID_PAGE ? overridePrevPage : mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700438 mCurrentPage = validateNewPage(currentPage);
Lais Andradecc5c8842021-06-04 18:20:30 +0100439 mCurrentScrollOverPage = mCurrentPage;
Winson Chung181c3dc2013-07-17 15:36:20 -0700440 updateCurrentPageScroll();
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700441 notifyPageSwitchListener(prevPage);
Winson Chunga12a2502010-12-20 14:41:35 -0800442 invalidate();
Winson Chung321e9ee2010-08-09 13:37:56 -0700443 }
444
Winson Chung8c87cd82013-07-23 16:20:10 -0700445 /**
Adam Cohen674531f2013-12-13 15:07:14 -0800446 * Should be called whenever the page changes. In the case of a scroll, we wait until the page
447 * has settled.
448 */
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700449 protected void notifyPageSwitchListener(int prevPage) {
Adam Cohen674531f2013-12-13 15:07:14 -0800450 updatePageIndicator();
451 }
452
453 private void updatePageIndicator() {
Sunny Goyal4cbf0462014-08-28 16:19:39 -0700454 if (mPageIndicator != null) {
Tony Mak4f521af2018-03-15 16:37:34 +0000455 mPageIndicator.setActiveMarker(getNextPage());
Winson Chungd2be3812013-07-16 11:11:32 -0700456 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700457 }
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700458 protected void pageBeginTransition() {
459 if (!mIsPageInTransition) {
460 mIsPageInTransition = true;
461 onPageBeginTransition();
Michael Jurkad74c9842011-07-10 12:44:21 -0700462 }
Patrick Dubroy1262e362010-10-06 15:49:50 -0700463 }
464
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700465 protected void pageEndTransition() {
Sunny Goyal05b59c02021-04-29 13:55:40 -0700466 if (mIsPageInTransition && !mIsBeingDragged && mScroller.isFinished()
Sunny Goyalb745a2a2021-04-30 13:38:22 -0700467 && (!isShown() || (mEdgeGlowLeft.isFinished() && mEdgeGlowRight.isFinished()))) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700468 mIsPageInTransition = false;
469 onPageEndTransition();
Michael Jurkad74c9842011-07-10 12:44:21 -0700470 }
Michael Jurka0142d492010-08-25 17:46:15 -0700471 }
472
Sunny Goyalb745a2a2021-04-30 13:38:22 -0700473 @Override
474 public void onVisibilityAggregated(boolean isVisible) {
475 pageEndTransition();
476 super.onVisibilityAggregated(isVisible);
477 }
478
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700479 protected boolean isPageInTransition() {
480 return mIsPageInTransition;
Adam Cohen26976d92011-03-22 15:33:33 -0700481 }
482
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700483 /**
484 * Called when the page starts moving as part of the scroll. Subclasses can override this
485 * to provide custom behavior during animation.
486 */
487 protected void onPageBeginTransition() {
Patrick Dubroy1262e362010-10-06 15:49:50 -0700488 }
489
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700490 /**
491 * Called when the page ends moving as part of the scroll. Subclasses can override this
492 * to provide custom behavior during animation.
493 */
494 protected void onPageEndTransition() {
Alex Chauba61b982021-06-15 16:29:19 +0100495 mCurrentPageScrollDiff = 0;
Jagrut Desai311d5192023-09-13 10:18:02 -0700496 AccessibilityManagerCompat.sendTestProtocolEventToTest(getContext(),
497 SCROLL_FINISHED_MESSAGE);
Tony Wickham619daaf2020-02-07 12:29:06 -0800498 AccessibilityManagerCompat.sendCustomAccessibilityEvent(getPageAt(mCurrentPage),
499 AccessibilityEvent.TYPE_VIEW_FOCUSED, null);
Tony Wickham62117d72020-03-26 16:56:26 -0700500 if (mOnPageTransitionEndCallback != null) {
501 mOnPageTransitionEndCallback.run();
502 mOnPageTransitionEndCallback = null;
503 }
504 }
505
506 /**
507 * Sets a callback to run once when the scrolling finishes. If there is currently
508 * no page in transition, then the callback is called immediately.
509 */
510 public void setOnPageTransitionEndCallback(@Nullable Runnable callback) {
511 if (mIsPageInTransition || callback == null) {
512 mOnPageTransitionEndCallback = callback;
513 } else {
514 callback.run();
515 }
Michael Jurka0142d492010-08-25 17:46:15 -0700516 }
517
Adam Cohen68d73932010-11-15 10:50:58 -0800518 @Override
Michael Jurka0142d492010-08-25 17:46:15 -0700519 public void scrollTo(int x, int y) {
Sunny Goyalc39db732021-04-03 01:20:21 -0700520 x = Utilities.boundToRange(x,
521 mOrientationHandler.getPrimaryValue(mMinScroll, 0), mMaxScroll);
522 y = Utilities.boundToRange(y,
523 mOrientationHandler.getPrimaryValue(0, mMinScroll), mMaxScroll);
Vinit Nayaka406f722019-12-19 11:50:55 -0800524 super.scrollTo(x, y);
Michael Jurka0142d492010-08-25 17:46:15 -0700525 }
526
Adam Cohen53805212013-10-01 10:39:23 -0700527 private void sendScrollAccessibilityEvent() {
Sunny Goyald0030b02017-12-08 15:07:24 -0800528 if (isObservedEventType(getContext(), AccessibilityEvent.TYPE_VIEW_SCROLLED)) {
Vadim Tryshevf4715972015-05-08 17:21:03 -0700529 if (mCurrentPage != getNextPage()) {
530 AccessibilityEvent ev =
531 AccessibilityEvent.obtain(AccessibilityEvent.TYPE_VIEW_SCROLLED);
Vadim Tryshev7066c122015-05-21 14:06:35 -0700532 ev.setScrollable(true);
533 ev.setScrollX(getScrollX());
534 ev.setScrollY(getScrollY());
Vinit Nayaka406f722019-12-19 11:50:55 -0800535 mOrientationHandler.setMaxScroll(ev, mMaxScroll);
Vadim Tryshevf4715972015-05-08 17:21:03 -0700536 sendAccessibilityEventUnchecked(ev);
Adam Cohen53805212013-10-01 10:39:23 -0700537 }
Adam Cohen53805212013-10-01 10:39:23 -0700538 }
539 }
540
Vadim Tryshev2c430b32018-04-04 14:45:21 -0700541 protected void announcePageForAccessibility() {
542 if (isAccessibilityEnabled(getContext())) {
543 // Notify the user when the page changes
544 announceForAccessibility(getCurrentPageDescription());
545 }
546 }
547
Winson Chung85425412021-05-10 16:24:14 -0700548 protected boolean computeScrollHelper() {
Winson Chung321e9ee2010-08-09 13:37:56 -0700549 if (mScroller.computeScrollOffset()) {
Winson Chung557d6ed2011-07-08 15:34:52 -0700550 // Don't bother scrolling if the page does not need to be moved
Sunny Goyalc39db732021-04-03 01:20:21 -0700551 int oldPos = mOrientationHandler.getPrimaryScroll(this);
552 int newPos = mScroller.getCurrX();
553 if (oldPos != newPos) {
Alex Chau6499e832021-11-19 14:35:46 +0000554 mOrientationHandler.setPrimary(this, VIEW_SCROLL_TO, mScroller.getCurrX());
Winson Chung557d6ed2011-07-08 15:34:52 -0700555 }
Winson Chung85425412021-05-10 16:24:14 -0700556
557 if (mAllowOverScroll) {
558 if (newPos < mMinScroll && oldPos >= mMinScroll) {
559 mEdgeGlowLeft.onAbsorb((int) mScroller.getCurrVelocity());
Schneider Victor-tuliasa602a0a2022-09-06 13:34:00 -0700560 abortScrollerAnimation(false);
Lais Andradecc5c8842021-06-04 18:20:30 +0100561 onEdgeAbsorbingScroll();
Winson Chung85425412021-05-10 16:24:14 -0700562 } else if (newPos > mMaxScroll && oldPos <= mMaxScroll) {
563 mEdgeGlowRight.onAbsorb((int) mScroller.getCurrVelocity());
Schneider Victor-tuliasa602a0a2022-09-06 13:34:00 -0700564 abortScrollerAnimation(false);
Lais Andradecc5c8842021-06-04 18:20:30 +0100565 onEdgeAbsorbingScroll();
Sunny Goyalc39db732021-04-03 01:20:21 -0700566 }
Tony Wickham95cdb3a2016-02-18 14:37:07 -0800567 }
Adam Cohen53805212013-10-01 10:39:23 -0700568
Winson Chung85425412021-05-10 16:24:14 -0700569 // If the scroller has scrolled to the final position and there is no edge effect, then
570 // finish the scroller to skip waiting for additional settling
571 int finalPos = mOrientationHandler.getPrimaryValue(mScroller.getFinalX(),
572 mScroller.getFinalY());
573 if (newPos == finalPos && mEdgeGlowLeft.isFinished() && mEdgeGlowRight.isFinished()) {
Schneider Victor-tuliasa602a0a2022-09-06 13:34:00 -0700574 abortScrollerAnimation(false);
Winson Chung85425412021-05-10 16:24:14 -0700575 }
576
577 invalidate();
578 return true;
579 } else if (mNextPage != INVALID_PAGE) {
580 sendScrollAccessibilityEvent();
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700581 int prevPage = mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700582 mCurrentPage = validateNewPage(mNextPage);
Lais Andradecc5c8842021-06-04 18:20:30 +0100583 mCurrentScrollOverPage = mCurrentPage;
Winson Chung86f77532010-08-24 11:08:22 -0700584 mNextPage = INVALID_PAGE;
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700585 notifyPageSwitchListener(prevPage);
Winson Chungb44b5242011-06-13 11:32:14 -0700586
Adam Cohen73aa9752010-11-24 16:26:58 -0800587 // We don't want to trigger a page end moving unless the page has settled
588 // and the user has stopped scrolling
Sunny Goyalaad33592018-08-07 17:20:35 -0700589 if (!mIsBeingDragged) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700590 pageEndTransition();
Adam Cohen73aa9752010-11-24 16:26:58 -0800591 }
Winson Chungc27d1bb2011-09-29 12:07:42 -0700592
Vadim Tryshev2c430b32018-04-04 14:45:21 -0700593 if (canAnnouncePageDescription()) {
594 announcePageForAccessibility();
Adam Cohen0ffac432013-07-10 11:19:26 -0700595 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700596 }
Michael Jurka0142d492010-08-25 17:46:15 -0700597 return false;
598 }
599
600 @Override
601 public void computeScroll() {
602 computeScrollHelper();
Winson Chung321e9ee2010-08-09 13:37:56 -0700603 }
604
Sunny Goyalce8809a2018-01-18 14:02:47 -0800605 public int getExpectedHeight() {
606 return getMeasuredHeight();
607 }
608
Adam Cohen410f3cd2013-09-22 12:09:32 -0700609 public int getNormalChildHeight() {
Sunny Goyalce8809a2018-01-18 14:02:47 -0800610 return getExpectedHeight() - getPaddingTop() - getPaddingBottom()
Sunny Goyalac00cba2017-11-13 15:58:01 -0800611 - mInsets.top - mInsets.bottom;
Adam Cohen410f3cd2013-09-22 12:09:32 -0700612 }
613
Sunny Goyalce8809a2018-01-18 14:02:47 -0800614 public int getExpectedWidth() {
615 return getMeasuredWidth();
616 }
617
Sunny Goyalbc683e92017-12-06 10:25:07 -0800618 public int getNormalChildWidth() {
Sunny Goyalce8809a2018-01-18 14:02:47 -0800619 return getExpectedWidth() - getPaddingLeft() - getPaddingRight()
Sunny Goyalbc683e92017-12-06 10:25:07 -0800620 - mInsets.left - mInsets.right;
621 }
622
Andras Kloczlc2bd15f2022-03-30 18:06:13 +0100623 private void updateVelocityValues() {
624 Resources res = getResources();
625 mFlingThresholdVelocity = res.getDimensionPixelSize(R.dimen.fling_threshold_velocity);
626 mEasyFlingThresholdVelocity =
627 res.getDimensionPixelSize(R.dimen.easy_fling_threshold_velocity);
628 mMinFlingVelocity = res.getDimensionPixelSize(R.dimen.min_fling_velocity);
629 mMinSnapVelocity = res.getDimensionPixelSize(R.dimen.min_page_snap_velocity);
630 mPageSnapAnimationDuration = res.getInteger(R.integer.config_pageSnapAnimationDuration);
631 }
632
633 @Override
634 protected void onConfigurationChanged(Configuration newConfig) {
635 super.onConfigurationChanged(newConfig);
636 updateVelocityValues();
637 }
638
Winson Chung321e9ee2010-08-09 13:37:56 -0700639 @Override
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800640 public void requestLayout() {
641 mIsLayoutValid = false;
642 super.requestLayout();
643 }
644
645 @Override
646 public void forceLayout() {
647 mIsLayoutValid = false;
648 super.forceLayout();
649 }
650
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100651 private int getPageWidthSize(int widthSize) {
Thales Lima7a6752d2021-09-23 14:31:00 +0100652 // It's necessary to add the padding back because it is remove when measuring children,
653 // like when MeasureSpec.getSize in CellLayout.
654 return (widthSize - mInsets.left - mInsets.right - getPaddingLeft() - getPaddingRight())
655 / getPanelCount() + getPaddingLeft() + getPaddingRight();
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100656 }
657
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800658 @Override
Winson Chung321e9ee2010-08-09 13:37:56 -0700659 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
Sunny Goyal8e2133b2015-05-06 13:39:07 -0700660 if (getChildCount() == 0) {
Winson Chungf0ea4d32011-06-06 14:27:16 -0700661 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
662 return;
663 }
664
Adam Cohen7d30a372013-07-01 17:03:59 -0700665 // We measure the dimensions of the PagedView to be larger than the pages so that when we
666 // zoom out (and scale down), the view is still contained in the parent
Adam Cohen7d30a372013-07-01 17:03:59 -0700667 int widthMode = MeasureSpec.getMode(widthMeasureSpec);
668 int widthSize = MeasureSpec.getSize(widthMeasureSpec);
669 int heightMode = MeasureSpec.getMode(heightMeasureSpec);
Winson Chung8aad6102012-05-11 16:27:49 -0700670 int heightSize = MeasureSpec.getSize(heightMeasureSpec);
Adam Cohen410f3cd2013-09-22 12:09:32 -0700671
Adam Cohen7d30a372013-07-01 17:03:59 -0700672 if (widthMode == MeasureSpec.UNSPECIFIED || heightMode == MeasureSpec.UNSPECIFIED) {
673 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
674 return;
Winson Chung321e9ee2010-08-09 13:37:56 -0700675 }
676
Winson Chung8aad6102012-05-11 16:27:49 -0700677 // Return early if we aren't given a proper dimension
678 if (widthSize <= 0 || heightSize <= 0) {
679 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
680 return;
681 }
682
Winson Chung321e9ee2010-08-09 13:37:56 -0700683 // The children are given the same width and height as the workspace
Michael Jurka5f1c5092010-09-03 14:15:02 -0700684 // unless they were set to WRAP_CONTENT
Winson Chung785d2eb2011-04-14 16:08:02 -0700685 if (DEBUG) Log.d(TAG, "PagedView.onMeasure(): " + widthSize + ", " + heightSize);
Michael Jurka5f1c5092010-09-03 14:15:02 -0700686
Sunny Goyalac00cba2017-11-13 15:58:01 -0800687 int myWidthSpec = MeasureSpec.makeMeasureSpec(
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100688 getPageWidthSize(widthSize), MeasureSpec.EXACTLY);
Sunny Goyalac00cba2017-11-13 15:58:01 -0800689 int myHeightSpec = MeasureSpec.makeMeasureSpec(
Sunny Goyal228153d2018-01-04 15:35:22 -0800690 heightSize - mInsets.top - mInsets.bottom, MeasureSpec.EXACTLY);
Adam Cohen96d30a12013-07-16 18:13:21 -0700691
Sunny Goyalac00cba2017-11-13 15:58:01 -0800692 // measureChildren takes accounts for content padding, we only need to care about extra
693 // space due to insets.
694 measureChildren(myWidthSpec, myHeightSpec);
695 setMeasuredDimension(widthSize, heightSize);
Adam Cohen60b07122011-11-14 17:26:06 -0800696 }
697
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700698 /** Returns true iff this PagedView's scroll amounts are initialized to each page index. */
Schneider Victor-tulias7bb558a2022-12-15 05:42:53 -0800699 protected boolean isPageScrollsInitialized() {
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700700 return mPageScrolls != null && mPageScrolls.length == getChildCount();
701 }
702
703 /**
704 * Queues the given callback to be run once {@code mPageScrolls} has been initialized.
705 */
706 public void runOnPageScrollsInitialized(Runnable callback) {
707 mOnPageScrollsInitializedCallbacks.add(callback);
Schneider Victor-tulias7bb558a2022-12-15 05:42:53 -0800708 if (isPageScrollsInitialized()) {
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700709 onPageScrollsInitialized();
710 }
711 }
712
Schneider Victor-tulias7bb558a2022-12-15 05:42:53 -0800713 protected void onPageScrollsInitialized() {
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700714 for (Runnable callback : mOnPageScrollsInitializedCallbacks) {
715 callback.run();
716 }
717 mOnPageScrollsInitializedCallbacks.clear();
718 }
719
Sunny Goyalcf25b522015-07-09 00:01:18 -0700720 @SuppressLint("DrawAllocation")
Winson Chung321e9ee2010-08-09 13:37:56 -0700721 @Override
Michael Jurka28750fb2010-09-24 17:43:49 -0700722 protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800723 mIsLayoutValid = true;
Vadim Trysheveb701c62018-05-14 16:00:15 -0700724 final int childCount = getChildCount();
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700725 int[] pageScrolls = mPageScrolls;
Vadim Trysheveb701c62018-05-14 16:00:15 -0700726 boolean pageScrollChanged = false;
Schneider Victor-tulias7bb558a2022-12-15 05:42:53 -0800727 if (!isPageScrollsInitialized()) {
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700728 pageScrolls = new int[childCount];
Vadim Trysheveb701c62018-05-14 16:00:15 -0700729 pageScrollChanged = true;
730 }
731
Winson Chung785d2eb2011-04-14 16:08:02 -0700732 if (DEBUG) Log.d(TAG, "PagedView.onLayout()");
Winson Chung321e9ee2010-08-09 13:37:56 -0700733
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700734 pageScrollChanged |= getPageScrolls(pageScrolls, true, SIMPLE_SCROLL_LOGIC);
735 mPageScrolls = pageScrolls;
Winson Chungc3665fa2011-09-14 17:56:27 -0700736
Winson Chung359cb5d2022-05-26 23:38:48 +0000737 if (childCount == 0) {
738 onPageScrollsInitialized();
739 return;
740 }
741
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700742 final LayoutTransition transition = getLayoutTransition();
743 // If the transition is running defer updating max scroll, as some empty pages could
744 // still be present, and a max scroll change could cause sudden jumps in scroll.
745 if (transition != null && transition.isRunning()) {
746 transition.addTransitionListener(new LayoutTransition.TransitionListener() {
747
748 @Override
749 public void startTransition(LayoutTransition transition, ViewGroup container,
750 View view, int transitionType) { }
751
752 @Override
753 public void endTransition(LayoutTransition transition, ViewGroup container,
754 View view, int transitionType) {
755 // Wait until all transitions are complete.
756 if (!transition.isRunning()) {
757 transition.removeTransitionListener(this);
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700758 updateMinAndMaxScrollX();
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700759 }
760 }
761 });
Adam Cohenf698c6e2013-07-17 18:44:25 -0700762 } else {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700763 updateMinAndMaxScrollX();
Adam Cohenf698c6e2013-07-17 18:44:25 -0700764 }
765
Sunny Goyalcb037ee2015-07-08 16:41:21 -0700766 if (mFirstLayout && mCurrentPage >= 0 && mCurrentPage < childCount) {
767 updateCurrentPageScroll();
768 mFirstLayout = false;
769 }
770
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800771 if (mScroller.isFinished() && pageScrollChanged) {
Alex Chau0733ebd2022-10-07 15:11:09 +0100772 // TODO(b/246283207): Remove logging once root cause of flake detected.
Brian Isganitisfdd044e2023-03-02 19:45:23 +0000773 if (Utilities.isRunningInTestHarness() && !(this instanceof Workspace)) {
Alex Chau0733ebd2022-10-07 15:11:09 +0100774 Log.d("b/246283207", this.getClass().getSimpleName() + "#onLayout() -> "
Pat Manning24b95542022-08-09 18:06:58 +0100775 + "if(mScroller.isFinished() && pageScrollChanged) -> getNextPage(): "
776 + getNextPage() + ", getScrollForPage(getNextPage()): "
777 + getScrollForPage(getNextPage()));
778 }
Sunny Goyalc82c6392018-06-06 15:39:13 -0700779 setCurrentPage(getNextPage());
Adam Cohenf698c6e2013-07-17 18:44:25 -0700780 }
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700781 onPageScrollsInitialized();
Winson Chunge3193b92010-09-10 11:44:42 -0700782 }
783
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700784 /**
785 * Initializes {@code outPageScrolls} with scroll positions for view at that index. The length
786 * of {@code outPageScrolls} should be same as the the childCount
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700787 */
788 protected boolean getPageScrolls(int[] outPageScrolls, boolean layoutChildren,
789 ComputePageScrollsLogic scrollLogic) {
790 final int childCount = getChildCount();
791
792 final int startIndex = mIsRtl ? childCount - 1 : 0;
793 final int endIndex = mIsRtl ? -1 : childCount;
794 final int delta = mIsRtl ? -1 : 1;
795
Vinit Nayaka406f722019-12-19 11:50:55 -0800796 final int pageCenter = mOrientationHandler.getCenterForPage(this, mInsets);
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700797
Vinit Nayaka406f722019-12-19 11:50:55 -0800798 final int scrollOffsetStart = mOrientationHandler.getScrollOffsetStart(this, mInsets);
799 final int scrollOffsetEnd = mOrientationHandler.getScrollOffsetEnd(this, mInsets);
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700800 boolean pageScrollChanged = false;
Thales Limae4457742021-07-20 16:46:38 +0100801 int panelCount = getPanelCount();
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700802
Vinit Nayaka406f722019-12-19 11:50:55 -0800803 for (int i = startIndex, childStart = scrollOffsetStart; i != endIndex; i += delta) {
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700804 final View child = getPageAt(i);
805 if (scrollLogic.shouldIncludeView(child)) {
Vinit Nayaka406f722019-12-19 11:50:55 -0800806 ChildBounds bounds = mOrientationHandler.getChildBounds(child, childStart,
807 pageCenter, layoutChildren);
808 final int primaryDimension = bounds.primaryDimension;
809 final int childPrimaryEnd = bounds.childPrimaryEnd;
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700810
Alex Chaub5c4d112021-03-29 17:37:53 +0100811 // In case the pages are of different width, align the page to left edge for non-RTL
812 // or right edge for RTL.
813 final int pageScroll =
814 mIsRtl ? childPrimaryEnd - scrollOffsetEnd : childStart - scrollOffsetStart;
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700815 if (outPageScrolls[i] != pageScroll) {
816 pageScrollChanged = true;
817 outPageScrolls[i] = pageScroll;
818 }
Alex Chau2e487602022-03-15 19:34:08 +0000819 childStart += primaryDimension + getChildGap(i, i + delta);
Thales Limae4457742021-07-20 16:46:38 +0100820
821 // This makes sure that the space is added after the page, not after each panel
Thales Limac2a6f6f2021-09-09 17:06:22 +0100822 int lastPanel = mIsRtl ? 0 : panelCount - 1;
823 if (i % panelCount == lastPanel) {
Thales Limae4457742021-07-20 16:46:38 +0100824 childStart += mPageSpacing;
825 }
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700826 }
827 }
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100828
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100829 if (panelCount > 1) {
830 for (int i = 0; i < childCount; i++) {
Alex Chau1e448462021-08-13 21:48:35 +0100831 // In case we have multiple panels, always use left most panel's page scroll for all
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100832 // panels on the screen.
833 int adjustedScroll = outPageScrolls[getLeftmostVisiblePageForIndex(i)];
834 if (outPageScrolls[i] != adjustedScroll) {
835 outPageScrolls[i] = adjustedScroll;
836 pageScrollChanged = true;
837 }
838 }
839 }
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700840 return pageScrollChanged;
841 }
842
Alex Chau2e487602022-03-15 19:34:08 +0000843 protected int getChildGap(int fromIndex, int toIndex) {
Sunny Goyala1fbd842015-05-20 13:40:27 -0700844 return 0;
845 }
846
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700847 protected void updateMinAndMaxScrollX() {
Vinit Nayaka406f722019-12-19 11:50:55 -0800848 mMinScroll = computeMinScroll();
849 mMaxScroll = computeMaxScroll();
Tony Wickhamf549dab2016-05-16 09:54:06 -0700850 }
851
Vinit Nayaka406f722019-12-19 11:50:55 -0800852 protected int computeMinScroll() {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700853 return 0;
Tony50876bf2018-09-19 23:09:14 -0400854 }
855
Vinit Nayaka406f722019-12-19 11:50:55 -0800856 protected int computeMaxScroll() {
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700857 int childCount = getChildCount();
858 if (childCount > 0) {
Sunny Goyal70660032015-05-14 00:07:08 -0700859 final int index = mIsRtl ? 0 : childCount - 1;
Tony Wickhamf549dab2016-05-16 09:54:06 -0700860 return getScrollForPage(index);
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700861 } else {
Tony Wickhamf549dab2016-05-16 09:54:06 -0700862 return 0;
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700863 }
864 }
865
Adam Cohen3b185e22013-10-29 14:45:58 -0700866 public void setPageSpacing(int pageSpacing) {
867 mPageSpacing = pageSpacing;
868 requestLayout();
869 }
870
Tony50876bf2018-09-19 23:09:14 -0400871 public int getPageSpacing() {
872 return mPageSpacing;
873 }
874
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800875 private void dispatchPageCountChanged() {
876 if (mPageIndicator != null) {
Tony Wickhambab101c2021-09-20 15:12:44 -0700877 mPageIndicator.setMarkersCount(getChildCount() / getPanelCount());
Winson Chungd2be3812013-07-16 11:11:32 -0700878 }
Adam Cohen2591f6a2011-10-25 14:36:40 -0700879 // This ensures that when children are added, they get the correct transforms / alphas
880 // in accordance with any scroll effects.
Adam Cohen2591f6a2011-10-25 14:36:40 -0700881 invalidate();
882 }
883
Michael Jurka8b805b12012-04-18 14:23:14 -0700884 @Override
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800885 public void onViewAdded(View child) {
Winson Chungc7c51582018-02-23 17:58:36 -0800886 super.onViewAdded(child);
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800887 dispatchPageCountChanged();
888 }
889
890 @Override
891 public void onViewRemoved(View child) {
Winson Chungc7c51582018-02-23 17:58:36 -0800892 super.onViewRemoved(child);
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700893 runOnPageScrollsInitialized(() -> {
894 mCurrentPage = validateNewPage(mCurrentPage);
895 mCurrentScrollOverPage = mCurrentPage;
896 });
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800897 dispatchPageCountChanged();
Winson Chungd2be3812013-07-16 11:11:32 -0700898 }
899
Adam Cohen73894962011-10-31 13:17:17 -0700900 protected int getChildOffset(int index) {
Adam Cohen7d30a372013-07-01 17:03:59 -0700901 if (index < 0 || index > getChildCount() - 1) return 0;
Vinit Nayaka406f722019-12-19 11:50:55 -0800902 View pageAtIndex = getPageAt(index);
903 return mOrientationHandler.getChildStart(pageAtIndex);
Adam Cohen73894962011-10-31 13:17:17 -0700904 }
905
Alex Chau7944ee52021-01-08 19:07:25 +0000906 protected int getChildVisibleSize(int index) {
907 View layout = getPageAt(index);
908 return mOrientationHandler.getMeasuredSize(layout);
909 }
910
Winson Chung321e9ee2010-08-09 13:37:56 -0700911 @Override
912 public boolean requestChildRectangleOnScreen(View child, Rect rectangle, boolean immediate) {
Andras Kloczl7e912442021-05-06 12:50:28 +0200913 int page = indexOfChild(child);
914 if (!isVisible(page) || !mScroller.isFinished()) {
Vadim Trysheveeaa8ee2018-04-11 12:23:42 -0700915 if (immediate) {
916 setCurrentPage(page);
917 } else {
918 snapToPage(page);
919 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700920 return true;
921 }
922 return false;
923 }
924
925 @Override
926 protected boolean onRequestFocusInDescendants(int direction, Rect previouslyFocusedRect) {
Winson Chung86f77532010-08-24 11:08:22 -0700927 int focusablePage;
928 if (mNextPage != INVALID_PAGE) {
929 focusablePage = mNextPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700930 } else {
Winson Chung86f77532010-08-24 11:08:22 -0700931 focusablePage = mCurrentPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700932 }
Winson Chung86f77532010-08-24 11:08:22 -0700933 View v = getPageAt(focusablePage);
Winson Chung321e9ee2010-08-09 13:37:56 -0700934 if (v != null) {
Adam Cohen76fc0852011-06-17 13:26:23 -0700935 return v.requestFocus(direction, previouslyFocusedRect);
Winson Chung321e9ee2010-08-09 13:37:56 -0700936 }
937 return false;
938 }
939
940 @Override
941 public boolean dispatchUnhandledMove(View focused, int direction) {
Sunny Goyal0c4e3722015-12-01 13:21:49 -0800942 if (super.dispatchUnhandledMove(focused, direction)) {
943 return true;
944 }
945
946 if (mIsRtl) {
947 if (direction == View.FOCUS_LEFT) {
948 direction = View.FOCUS_RIGHT;
949 } else if (direction == View.FOCUS_RIGHT) {
950 direction = View.FOCUS_LEFT;
951 }
952 }
Andras Kloczl7e912442021-05-06 12:50:28 +0200953
954 int currentPage = getNextPage();
955 int closestNeighbourIndex = -1;
956 int closestNeighbourDistance = Integer.MAX_VALUE;
957 // Find the closest neighbour page
958 for (int neighbourPageIndex : getNeighbourPageIndices(direction)) {
959 int distance = Math.abs(neighbourPageIndex - currentPage);
960 if (closestNeighbourDistance > distance) {
961 closestNeighbourDistance = distance;
962 closestNeighbourIndex = neighbourPageIndex;
Winson Chung321e9ee2010-08-09 13:37:56 -0700963 }
964 }
Andras Kloczl7e912442021-05-06 12:50:28 +0200965 if (closestNeighbourIndex != -1) {
966 View page = getPageAt(closestNeighbourIndex);
967 snapToPage(closestNeighbourIndex);
968 page.requestFocus(direction);
969 return true;
970 }
971
Sunny Goyal0c4e3722015-12-01 13:21:49 -0800972 return false;
Winson Chung321e9ee2010-08-09 13:37:56 -0700973 }
974
975 @Override
976 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) {
Jon Miranda6a858172016-10-25 16:19:17 -0700977 if (getDescendantFocusability() == FOCUS_BLOCK_DESCENDANTS) {
978 return;
979 }
980
Andras Kloczl7e912442021-05-06 12:50:28 +0200981 // nextPage is more reliable when multiple control movements have been done in a short
982 // period of time
983 getPageIndices(getNextPage())
984 .addAll(getNeighbourPageIndices(direction))
985 .forEach(pageIndex ->
986 getPageAt(pageIndex).addFocusables(views, direction, focusableMode));
Winson Chung321e9ee2010-08-09 13:37:56 -0700987 }
988
989 /**
990 * If one of our descendant views decides that it could be focused now, only
Winson Chung86f77532010-08-24 11:08:22 -0700991 * pass that along if it's on the current page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700992 *
Winson Chung86f77532010-08-24 11:08:22 -0700993 * This happens when live folders requery, and if they're off page, they
994 * end up calling requestFocus, which pulls it on page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700995 */
996 @Override
997 public void focusableViewAvailable(View focused) {
Winson Chung86f77532010-08-24 11:08:22 -0700998 View current = getPageAt(mCurrentPage);
Winson Chung321e9ee2010-08-09 13:37:56 -0700999 View v = focused;
1000 while (true) {
1001 if (v == current) {
1002 super.focusableViewAvailable(focused);
1003 return;
1004 }
1005 if (v == this) {
1006 return;
1007 }
1008 ViewParent parent = v.getParent();
1009 if (parent instanceof View) {
1010 v = (View)v.getParent();
1011 } else {
1012 return;
1013 }
1014 }
1015 }
1016
1017 /**
1018 * {@inheritDoc}
1019 */
1020 @Override
1021 public void requestDisallowInterceptTouchEvent(boolean disallowIntercept) {
1022 if (disallowIntercept) {
1023 // We need to make sure to cancel our long press if
1024 // a scrollable widget takes over touch events
Andras Kloczl7a1ca0b2021-04-08 16:08:16 +02001025 cancelCurrentPageLongPress();
Winson Chung321e9ee2010-08-09 13:37:56 -07001026 }
1027 super.requestDisallowInterceptTouchEvent(disallowIntercept);
1028 }
1029
1030 @Override
1031 public boolean onInterceptTouchEvent(MotionEvent ev) {
1032 /*
1033 * This method JUST determines whether we want to intercept the motion.
1034 * If we return true, onTouchEvent will be called and we do the actual
1035 * scrolling there.
1036 */
1037
Winson Chung45e1d6e2010-11-09 17:19:49 -08001038 // Skip touch handling if there are no pages to swipe
Tony Wickhamb6841ac2019-07-22 12:39:59 -07001039 if (getChildCount() <= 0) return false;
Sunny Goyalc4bb3732019-06-20 11:34:14 -07001040
1041 acquireVelocityTrackerAndAddMovement(ev);
Winson Chung45e1d6e2010-11-09 17:19:49 -08001042
Winson Chung321e9ee2010-08-09 13:37:56 -07001043 /*
1044 * Shortcut the most recurring case: the user is in the dragging
1045 * state and he is moving his finger. We want to intercept this
1046 * motion.
1047 */
1048 final int action = ev.getAction();
Sunny Goyalaad33592018-08-07 17:20:35 -07001049 if ((action == MotionEvent.ACTION_MOVE) && mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001050 return true;
1051 }
1052
Winson Chung321e9ee2010-08-09 13:37:56 -07001053 switch (action & MotionEvent.ACTION_MASK) {
1054 case MotionEvent.ACTION_MOVE: {
1055 /*
1056 * mIsBeingDragged == false, otherwise the shortcut would have caught it. Check
Vinit Nayaka406f722019-12-19 11:50:55 -08001057 * whether the user has moved far enough from their original down touch.
Winson Chung321e9ee2010-08-09 13:37:56 -07001058 */
Michael Jurka1ff706b2010-09-14 17:35:20 -07001059 if (mActivePointerId != INVALID_POINTER) {
1060 determineScrollingStart(ev);
Michael Jurka1ff706b2010-09-14 17:35:20 -07001061 }
1062 // if mActivePointerId is INVALID_POINTER, then we must have missed an ACTION_DOWN
Vinit Nayaka406f722019-12-19 11:50:55 -08001063 // event. in that case, treat the first occurrence of a move event as a ACTION_DOWN
Michael Jurka1ff706b2010-09-14 17:35:20 -07001064 // i.e. fall through to the next case (don't break)
1065 // (We sometimes miss ACTION_DOWN events in Workspace because it ignores all events
1066 // while it's small- this was causing a crash before we checked for INVALID_POINTER)
Adam Cohen93c97562013-09-26 13:48:01 -07001067 break;
Winson Chung321e9ee2010-08-09 13:37:56 -07001068 }
1069
1070 case MotionEvent.ACTION_DOWN: {
1071 final float x = ev.getX();
1072 final float y = ev.getY();
1073 // Remember location of down touch
1074 mDownMotionX = x;
Adam Cohen7d30a372013-07-01 17:03:59 -07001075 mDownMotionY = y;
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001076 mDownMotionPrimary = mOrientationHandler.getPrimaryDirection(ev, 0);
1077 mLastMotion = (int) mDownMotionPrimary;
Vinit Nayaka406f722019-12-19 11:50:55 -08001078 mTotalMotion = 0;
Winson Chung4941f652020-06-18 15:11:53 -07001079 mAllowEasyFling = false;
Winson Chung321e9ee2010-08-09 13:37:56 -07001080 mActivePointerId = ev.getPointerId(0);
Sunny Goyalc39db732021-04-03 01:20:21 -07001081 updateIsBeingDraggedOnTouchDown(ev);
Winson Chung321e9ee2010-08-09 13:37:56 -07001082 break;
1083 }
1084
Winson Chung321e9ee2010-08-09 13:37:56 -07001085 case MotionEvent.ACTION_UP:
Jeff Brown1d0867c2010-12-02 18:27:39 -08001086 case MotionEvent.ACTION_CANCEL:
Adam Cohen7d30a372013-07-01 17:03:59 -07001087 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001088 break;
1089
1090 case MotionEvent.ACTION_POINTER_UP:
1091 onSecondaryPointerUp(ev);
Adam Cohen6342bba2011-03-10 11:33:35 -08001092 releaseVelocityTracker();
Winson Chung321e9ee2010-08-09 13:37:56 -07001093 break;
1094 }
1095
1096 /*
1097 * The only time we want to intercept motion events is if we are in the
1098 * drag mode.
1099 */
Sunny Goyalaad33592018-08-07 17:20:35 -07001100 return mIsBeingDragged;
Winson Chung321e9ee2010-08-09 13:37:56 -07001101 }
1102
Tony Wickhama0aee212019-09-18 09:24:03 -07001103 /**
1104 * If being flinged and user touches the screen, initiate drag; otherwise don't.
1105 */
Sunny Goyalbb030562021-07-19 16:28:39 -07001106 protected void updateIsBeingDraggedOnTouchDown(MotionEvent ev) {
Tony Wickhama0aee212019-09-18 09:24:03 -07001107 // mScroller.isFinished should be false when being flinged.
Sunny Goyalc39db732021-04-03 01:20:21 -07001108 final int xDist = Math.abs(mScroller.getFinalX() - mScroller.getCurrX());
Winson Chung4941f652020-06-18 15:11:53 -07001109 final boolean finishedScrolling = (mScroller.isFinished() || xDist < mPageSlop / 3);
Tony Wickhama0aee212019-09-18 09:24:03 -07001110
1111 if (finishedScrolling) {
1112 mIsBeingDragged = false;
1113 if (!mScroller.isFinished() && !mFreeScroll) {
1114 setCurrentPage(getNextPage());
1115 pageEndTransition();
1116 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001117 mIsBeingDragged = !mEdgeGlowLeft.isFinished() || !mEdgeGlowRight.isFinished();
Tony Wickhama0aee212019-09-18 09:24:03 -07001118 } else {
1119 mIsBeingDragged = true;
1120 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001121
1122 // Catch the edge effect if it is active.
1123 float displacement = mOrientationHandler.getSecondaryValue(ev.getX(), ev.getY())
1124 / mOrientationHandler.getSecondaryValue(getWidth(), getHeight());
1125 if (!mEdgeGlowLeft.isFinished()) {
1126 mEdgeGlowLeft.onPullDistance(0f, 1f - displacement);
1127 }
1128 if (!mEdgeGlowRight.isFinished()) {
1129 mEdgeGlowRight.onPullDistance(0f, displacement);
1130 }
Tony Wickhama0aee212019-09-18 09:24:03 -07001131 }
1132
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001133 public boolean isHandlingTouch() {
Sunny Goyalaad33592018-08-07 17:20:35 -07001134 return mIsBeingDragged;
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001135 }
1136
Adam Cohenf8d28232011-02-01 21:47:00 -08001137 protected void determineScrollingStart(MotionEvent ev) {
1138 determineScrollingStart(ev, 1.0f);
1139 }
1140
Winson Chung321e9ee2010-08-09 13:37:56 -07001141 /*
1142 * Determines if we should change the touch state to start scrolling after the
1143 * user moves their touch point too far.
1144 */
Adam Cohenf8d28232011-02-01 21:47:00 -08001145 protected void determineScrollingStart(MotionEvent ev, float touchSlopScale) {
Adam Cohen7d30a372013-07-01 17:03:59 -07001146 // Disallow scrolling if we don't have a valid pointer index
Winson Chung321e9ee2010-08-09 13:37:56 -07001147 final int pointerIndex = ev.findPointerIndex(mActivePointerId);
Adam Cohen7d30a372013-07-01 17:03:59 -07001148 if (pointerIndex == -1) return;
1149
Vinit Nayaka406f722019-12-19 11:50:55 -08001150 final float primaryDirection = mOrientationHandler.getPrimaryDirection(ev, pointerIndex);
1151 final int diff = (int) Math.abs(primaryDirection - mLastMotion);
Adam Cohenf8d28232011-02-01 21:47:00 -08001152 final int touchSlop = Math.round(touchSlopScale * mTouchSlop);
Winson Chung4941f652020-06-18 15:11:53 -07001153 boolean moved = diff > touchSlop || ev.getAction() == ACTION_MOVE_ALLOW_EASY_FLING;
Winson Chung321e9ee2010-08-09 13:37:56 -07001154
Vinit Nayaka406f722019-12-19 11:50:55 -08001155 if (moved) {
Sunny Goyal5a1f53b2015-05-27 10:24:24 -07001156 // Scroll if the user moved far enough along the X axis
Sunny Goyalaad33592018-08-07 17:20:35 -07001157 mIsBeingDragged = true;
Vinit Nayaka406f722019-12-19 11:50:55 -08001158 mTotalMotion += Math.abs(mLastMotion - primaryDirection);
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001159 mLastMotion = (int) primaryDirection;
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001160 pageBeginTransition();
Tony Wickhamdadb3042016-02-24 11:07:00 -08001161 // Stop listening for things like pinches.
1162 requestDisallowInterceptTouchEvent(true);
Adam Cohenf8d28232011-02-01 21:47:00 -08001163 }
1164 }
1165
1166 protected void cancelCurrentPageLongPress() {
Sunny Goyal8e2133b2015-05-06 13:39:07 -07001167 // Try canceling the long press. It could also have been scheduled
1168 // by a distant descendant, so use the mAllowLongPress flag to block
1169 // everything
Sunny Goyal59969372021-05-06 12:11:44 -07001170 forEachVisiblePage(View::cancelLongPress);
Winson Chung321e9ee2010-08-09 13:37:56 -07001171 }
1172
Adam Cohenb5ba0972011-09-07 18:02:31 -07001173 protected float getScrollProgress(int screenCenter, View v, int page) {
Sunny Goyal228153d2018-01-04 15:35:22 -08001174 final int halfScreenSize = getMeasuredWidth() / 2;
Adam Cohenedb40762013-07-18 16:45:45 -07001175 int delta = screenCenter - (getScrollForPage(page) + halfScreenSize);
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001176 int panelCount = getPanelCount();
1177 int pageCount = getChildCount();
Adam Cohen3b185e22013-10-29 14:45:58 -07001178
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001179 int adjacentPage = page + panelCount;
Sunny Goyal70660032015-05-14 00:07:08 -07001180 if ((delta < 0 && !mIsRtl) || (delta > 0 && mIsRtl)) {
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001181 adjacentPage = page - panelCount;
Adam Cohen3b185e22013-10-29 14:45:58 -07001182 }
1183
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001184 final int totalDistance;
1185 if (adjacentPage < 0 || adjacentPage > pageCount - 1) {
1186 totalDistance = (v.getMeasuredWidth() + mPageSpacing) * panelCount;
Adam Cohen3b185e22013-10-29 14:45:58 -07001187 } else {
1188 totalDistance = Math.abs(getScrollForPage(adjacentPage) - getScrollForPage(page));
1189 }
Adam Cohenb5ba0972011-09-07 18:02:31 -07001190
1191 float scrollProgress = delta / (totalDistance * 1.0f);
Sunny Goyal8e2133b2015-05-06 13:39:07 -07001192 scrollProgress = Math.min(scrollProgress, MAX_SCROLL_PROGRESS);
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001193 scrollProgress = Math.max(scrollProgress, -MAX_SCROLL_PROGRESS);
Adam Cohenb5ba0972011-09-07 18:02:31 -07001194 return scrollProgress;
1195 }
1196
Adam Cohenedb40762013-07-18 16:45:45 -07001197 public int getScrollForPage(int index) {
Schneider Victor-tulias7bb558a2022-12-15 05:42:53 -08001198 if (!isPageScrollsInitialized() || index >= mPageScrolls.length || index < 0) {
Adam Cohenedb40762013-07-18 16:45:45 -07001199 return 0;
1200 } else {
1201 return mPageScrolls[index];
1202 }
1203 }
1204
Adam Cohen564a2e72013-10-09 14:47:32 -07001205 // While layout transitions are occurring, a child's position may stray from its baseline
1206 // position. This method returns the magnitude of this stray at any given time.
1207 public int getLayoutTransitionOffsetForPage(int index) {
Schneider Victor-tulias7bb558a2022-12-15 05:42:53 -08001208 if (!isPageScrollsInitialized() || index >= mPageScrolls.length || index < 0) {
Adam Cohen564a2e72013-10-09 14:47:32 -07001209 return 0;
1210 } else {
1211 View child = getChildAt(index);
Adam Cohen3b185e22013-10-29 14:45:58 -07001212
Sunny Goyal228153d2018-01-04 15:35:22 -08001213 int scrollOffset = mIsRtl ? getPaddingRight() : getPaddingLeft();
1214 int baselineX = mPageScrolls[index] + scrollOffset;
Adam Cohen564a2e72013-10-09 14:47:32 -07001215 return (int) (child.getX() - baselineX);
1216 }
1217 }
1218
Tony Wickham023f4042019-01-29 10:52:31 -08001219 public void setEnableFreeScroll(boolean freeScroll) {
Winson Chung0e449002019-04-26 11:09:58 -07001220 if (mFreeScroll == freeScroll) {
1221 return;
1222 }
1223
Tony Wickham8f7ead32016-04-07 18:46:44 -07001224 boolean wasFreeScroll = mFreeScroll;
Adam Cohenf358a4b2013-07-23 16:47:31 -07001225 mFreeScroll = freeScroll;
1226
Adam Cohenf9618852013-11-08 06:45:03 -08001227 if (mFreeScroll) {
Sunny Goyal4d519f22017-10-24 10:32:40 -07001228 setCurrentPage(getNextPage());
Tony Wickham8f7ead32016-04-07 18:46:44 -07001229 } else if (wasFreeScroll) {
Tony Wickhamaf33f2c2019-10-04 12:55:22 -07001230 if (getScrollForPage(getNextPage()) != getScrollX()) {
1231 snapToPage(getNextPage());
1232 }
Adam Cohenf358a4b2013-07-23 16:47:31 -07001233 }
Adam Cohenf358a4b2013-07-23 16:47:31 -07001234 }
1235
Sunny Goyal2f0ec852015-03-26 13:38:27 -07001236 protected void setEnableOverscroll(boolean enable) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001237 mAllowOverScroll = enable;
1238 }
1239
Andras Kloczl07111f22022-03-30 17:25:54 +01001240 protected boolean isSignificantMove(float absoluteDelta, int pageOrientedSize) {
1241 return absoluteDelta > pageOrientedSize * SIGNIFICANT_MOVE_THRESHOLD;
Alex Chau822acf42021-06-03 11:35:05 +01001242 }
1243
Winson Chung321e9ee2010-08-09 13:37:56 -07001244 @Override
1245 public boolean onTouchEvent(MotionEvent ev) {
Winson Chung45e1d6e2010-11-09 17:19:49 -08001246 // Skip touch handling if there are no pages to swipe
Tony Wickhamb6841ac2019-07-22 12:39:59 -07001247 if (getChildCount() <= 0) return false;
Winson Chung45e1d6e2010-11-09 17:19:49 -08001248
Michael Jurkab8f06722010-10-10 15:58:46 -07001249 acquireVelocityTrackerAndAddMovement(ev);
Winson Chung321e9ee2010-08-09 13:37:56 -07001250
1251 final int action = ev.getAction();
1252
1253 switch (action & MotionEvent.ACTION_MASK) {
1254 case MotionEvent.ACTION_DOWN:
Sunny Goyalc39db732021-04-03 01:20:21 -07001255 updateIsBeingDraggedOnTouchDown(ev);
Tony Wickhama0aee212019-09-18 09:24:03 -07001256
Winson Chung321e9ee2010-08-09 13:37:56 -07001257 /*
1258 * If being flinged and user touches, stop the fling. isFinished
1259 * will be false if being flinged.
1260 */
1261 if (!mScroller.isFinished()) {
Adam Cohen8bdbaab2013-10-29 15:25:02 -07001262 abortScrollerAnimation(false);
Winson Chung321e9ee2010-08-09 13:37:56 -07001263 }
1264
1265 // Remember where the motion event started
Vinit Nayaka406f722019-12-19 11:50:55 -08001266 mDownMotionX = ev.getX();
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001267 mDownMotionY = ev.getY();
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001268 mDownMotionPrimary = mOrientationHandler.getPrimaryDirection(ev, 0);
1269 mLastMotion = (int) mDownMotionPrimary;
Vinit Nayaka406f722019-12-19 11:50:55 -08001270 mTotalMotion = 0;
Winson Chung4941f652020-06-18 15:11:53 -07001271 mAllowEasyFling = false;
Winson Chung321e9ee2010-08-09 13:37:56 -07001272 mActivePointerId = ev.getPointerId(0);
Sunny Goyalaad33592018-08-07 17:20:35 -07001273 if (mIsBeingDragged) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001274 pageBeginTransition();
Michael Jurka0142d492010-08-25 17:46:15 -07001275 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001276 break;
1277
Winson Chung4941f652020-06-18 15:11:53 -07001278 case ACTION_MOVE_ALLOW_EASY_FLING:
1279 // Start scrolling immediately
1280 determineScrollingStart(ev);
1281 mAllowEasyFling = true;
1282 break;
1283
1284 case MotionEvent.ACTION_MOVE:
1285 if (mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001286 // Scroll to follow the motion event
1287 final int pointerIndex = ev.findPointerIndex(mActivePointerId);
Adam Cohen7d30a372013-07-01 17:03:59 -07001288
1289 if (pointerIndex == -1) return true;
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001290 int oldScroll = mOrientationHandler.getPrimaryScroll(this);
1291 int dx = (int) ev.getX(pointerIndex);
1292 int dy = (int) ev.getY(pointerIndex);
Adam Cohen7d30a372013-07-01 17:03:59 -07001293
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001294 int direction = mOrientationHandler.getPrimaryValue(dx, dy);
1295 int delta = mLastMotion - direction;
Sunny Goyalc39db732021-04-03 01:20:21 -07001296
1297 int width = getWidth();
1298 int height = getHeight();
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001299 float size = mOrientationHandler.getPrimaryValue(width, height);
1300 float displacement = (width == 0 || height == 0) ? 0
1301 : (float) mOrientationHandler.getSecondaryValue(dx, dy)
1302 / mOrientationHandler.getSecondaryValue(width, height);
Vinit Nayaka406f722019-12-19 11:50:55 -08001303 mTotalMotion += Math.abs(delta);
Adam Cohenaefd4e12011-02-14 16:39:38 -08001304
Sunny Goyalc39db732021-04-03 01:20:21 -07001305 if (mAllowOverScroll) {
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001306 int consumed = 0;
Sunny Goyalc39db732021-04-03 01:20:21 -07001307 if (delta < 0 && mEdgeGlowRight.getDistance() != 0f) {
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001308 consumed = Math.round(size *
1309 mEdgeGlowRight.onPullDistance(delta / size, displacement));
Sunny Goyalc39db732021-04-03 01:20:21 -07001310 } else if (delta > 0 && mEdgeGlowLeft.getDistance() != 0f) {
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001311 consumed = Math.round(-size *
1312 mEdgeGlowLeft.onPullDistance(-delta / size, 1 - displacement));
Sunny Goyalc39db732021-04-03 01:20:21 -07001313 }
1314 delta -= consumed;
1315 }
Alex Chau822acf42021-06-03 11:35:05 +01001316 delta /= mOrientationHandler.getPrimaryScale(this);
Sunny Goyalc39db732021-04-03 01:20:21 -07001317
Winson Chungc0844aa2011-02-02 15:25:58 -08001318 // Only scroll and update mLastMotionX if we have moved some discrete amount. We
1319 // keep the remainder because we are actually testing if we've moved from the last
1320 // scrolled position (which is discrete).
Sunny Goyalc39db732021-04-03 01:20:21 -07001321 mLastMotion = direction;
Vinit Nayaka406f722019-12-19 11:50:55 -08001322
Sunny Goyalc39db732021-04-03 01:20:21 -07001323 if (delta != 0) {
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001324 mOrientationHandler.setPrimary(this, VIEW_SCROLL_BY, delta);
Sunny Goyalc39db732021-04-03 01:20:21 -07001325
1326 if (mAllowOverScroll) {
1327 final float pulledToX = oldScroll + delta;
1328
1329 if (pulledToX < mMinScroll) {
1330 mEdgeGlowLeft.onPullDistance(-delta / size, 1.f - displacement);
1331 if (!mEdgeGlowRight.isFinished()) {
1332 mEdgeGlowRight.onRelease();
1333 }
1334 } else if (pulledToX > mMaxScroll) {
1335 mEdgeGlowRight.onPullDistance(delta / size, displacement);
1336 if (!mEdgeGlowLeft.isFinished()) {
1337 mEdgeGlowLeft.onRelease();
1338 }
1339 }
1340
1341 if (!mEdgeGlowLeft.isFinished() || !mEdgeGlowRight.isFinished()) {
1342 postInvalidateOnAnimation();
1343 }
1344 }
1345
Winson Chung321e9ee2010-08-09 13:37:56 -07001346 } else {
1347 awakenScrollBars();
1348 }
Adam Cohen564976a2010-10-13 18:52:07 -07001349 } else {
Winson Chung321e9ee2010-08-09 13:37:56 -07001350 determineScrollingStart(ev);
1351 }
1352 break;
1353
1354 case MotionEvent.ACTION_UP:
Sunny Goyalaad33592018-08-07 17:20:35 -07001355 if (mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001356 final int activePointerId = mActivePointerId;
1357 final int pointerIndex = ev.findPointerIndex(activePointerId);
Vinit Nayak93bf1fe2020-05-26 17:22:13 -07001358 if (pointerIndex == -1) return true;
1359
Vinit Nayaka406f722019-12-19 11:50:55 -08001360 final float primaryDirection = mOrientationHandler.getPrimaryDirection(ev,
1361 pointerIndex);
Sunny Goyal4bb8b062019-02-19 16:37:38 -08001362 final VelocityTracker velocityTracker = mVelocityTracker;
1363 velocityTracker.computeCurrentVelocity(1000, mMaximumVelocity);
Adam Cohenaefd4e12011-02-14 16:39:38 -08001364
Vinit Nayaka406f722019-12-19 11:50:55 -08001365 int velocity = (int) mOrientationHandler.getPrimaryVelocity(velocityTracker,
Andras Kloczl07111f22022-03-30 17:25:54 +01001366 mActivePointerId);
Alex Chau822acf42021-06-03 11:35:05 +01001367 float delta = primaryDirection - mDownMotionPrimary;
Randy Pfohl583241e2023-03-02 03:26:56 +00001368
1369 View current = getPageAt(mCurrentPage);
1370 if (current == null) {
1371 Log.e(TAG, "current page was null. this should not happen.");
1372 return true;
1373 }
1374
1375 int pageOrientedSize = (int) (mOrientationHandler.getMeasuredSize(current)
Andras Kloczl07111f22022-03-30 17:25:54 +01001376 * mOrientationHandler.getPrimaryScale(this));
1377 boolean isSignificantMove = isSignificantMove(Math.abs(delta), pageOrientedSize);
Vinit Nayaka406f722019-12-19 11:50:55 -08001378
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001379 mTotalMotion += Math.abs(mLastMotion - primaryDirection);
Winson Chung4941f652020-06-18 15:11:53 -07001380 boolean passedSlop = mAllowEasyFling || mTotalMotion > mPageSlop;
1381 boolean isFling = passedSlop && shouldFlingForVelocity(velocity);
Vinit Nayaka406f722019-12-19 11:50:55 -08001382 boolean isDeltaLeft = mIsRtl ? delta > 0 : delta < 0;
1383 boolean isVelocityLeft = mIsRtl ? velocity > 0 : velocity < 0;
Winson Chung4941f652020-06-18 15:11:53 -07001384 if (DEBUG_FAILED_QUICKSWITCH && !isFling && mAllowEasyFling) {
1385 Log.d("Quickswitch", "isFling=false vel=" + velocity
1386 + " threshold=" + mEasyFlingThresholdVelocity);
1387 }
Adam Cohen00481b32011-11-18 12:03:48 -08001388
Adam Cohenf358a4b2013-07-23 16:47:31 -07001389 if (!mFreeScroll) {
1390 // In the case that the page is moved far to one direction and then is flung
1391 // in the opposite direction, we use a threshold to determine whether we should
1392 // just return to the starting page, or if we should skip one further.
1393 boolean returnToOriginalPage = false;
Vinit Nayaka406f722019-12-19 11:50:55 -08001394 if (Math.abs(delta) > pageOrientedSize * RETURN_TO_ORIGINAL_PAGE_THRESHOLD &&
1395 Math.signum(velocity) != Math.signum(delta) && isFling) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001396 returnToOriginalPage = true;
1397 }
Adam Cohenaefd4e12011-02-14 16:39:38 -08001398
Adam Cohenf358a4b2013-07-23 16:47:31 -07001399 int finalPage;
1400 // We give flings precedence over large moves, which is why we short-circuit our
1401 // test for a large move if a fling has been registered. That is, a large
1402 // move to the left and fling to the right will register as a fling to the right.
Sunny Goyalb7b01352018-08-09 12:31:20 -07001403
Vinit Nayaka406f722019-12-19 11:50:55 -08001404 if (((isSignificantMove && !isDeltaLeft && !isFling) ||
1405 (isFling && !isVelocityLeft)) && mCurrentPage > 0) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +01001406 finalPage = returnToOriginalPage
1407 ? mCurrentPage : mCurrentPage - getPanelCount();
Schneider Victor-tulias50f66512022-12-14 02:53:38 -08001408 runOnPageScrollsInitialized(
1409 () -> snapToPageWithVelocity(finalPage, velocity));
Vinit Nayaka406f722019-12-19 11:50:55 -08001410 } else if (((isSignificantMove && isDeltaLeft && !isFling) ||
1411 (isFling && isVelocityLeft)) &&
Adam Cohenf358a4b2013-07-23 16:47:31 -07001412 mCurrentPage < getChildCount() - 1) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +01001413 finalPage = returnToOriginalPage
1414 ? mCurrentPage : mCurrentPage + getPanelCount();
Schneider Victor-tulias50f66512022-12-14 02:53:38 -08001415 runOnPageScrollsInitialized(
1416 () -> snapToPageWithVelocity(finalPage, velocity));
Adam Cohenf358a4b2013-07-23 16:47:31 -07001417 } else {
Schneider Victor-tulias50f66512022-12-14 02:53:38 -08001418 runOnPageScrollsInitialized(this::snapToDestination);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001419 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001420 } else {
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001421 if (!mScroller.isFinished()) {
1422 abortScrollerAnimation(true);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001423 }
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001424
Vinit Nayaka406f722019-12-19 11:50:55 -08001425 int initialScroll = mOrientationHandler.getPrimaryScroll(this);
1426 int maxScroll = mMaxScroll;
1427 int minScroll = mMinScroll;
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001428
Vinit Nayaka406f722019-12-19 11:50:55 -08001429 if (((initialScroll >= maxScroll) && (isVelocityLeft || !isFling)) ||
1430 ((initialScroll <= minScroll) && (!isVelocityLeft || !isFling))) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001431 mScroller.springBack(initialScroll, 0, minScroll, maxScroll, 0, 0);
Alex Chaub794ea62021-02-03 18:00:30 +00001432 mNextPage = getDestinationPage();
Sunny Goyalb7b01352018-08-09 12:31:20 -07001433 } else {
Sunny Goyalc39db732021-04-03 01:20:21 -07001434 int velocity1 = -velocity;
1435 // Continue a scroll or fling in progress
1436 mScroller.fling(initialScroll, 0, velocity1, 0, minScroll, maxScroll, 0, 0,
1437 Math.round(getWidth() * 0.5f * OVERSCROLL_DAMP_FACTOR), 0);
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001438
Sunny Goyalc39db732021-04-03 01:20:21 -07001439 int finalPos = mScroller.getFinalX();
Alex Chaub794ea62021-02-03 18:00:30 +00001440 mNextPage = getDestinationPage(finalPos);
Schneider Victor-tulias50f66512022-12-14 02:53:38 -08001441 runOnPageScrollsInitialized(this::onNotSnappingToPageInFreeScroll);
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001442 }
1443 invalidate();
Winson Chung321e9ee2010-08-09 13:37:56 -07001444 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001445 }
Adam Cohen7d30a372013-07-01 17:03:59 -07001446
Sunny Goyalc39db732021-04-03 01:20:21 -07001447 mEdgeGlowLeft.onRelease();
1448 mEdgeGlowRight.onRelease();
Adam Cohen7d30a372013-07-01 17:03:59 -07001449 // End any intermediate reordering states
1450 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001451 break;
1452
1453 case MotionEvent.ACTION_CANCEL:
Sunny Goyalaad33592018-08-07 17:20:35 -07001454 if (mIsBeingDragged) {
Schneider Victor-tulias50f66512022-12-14 02:53:38 -08001455 runOnPageScrollsInitialized(this::snapToDestination);
Michael Jurkab8f06722010-10-10 15:58:46 -07001456 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001457 mEdgeGlowLeft.onRelease();
1458 mEdgeGlowRight.onRelease();
Adam Cohen7d30a372013-07-01 17:03:59 -07001459 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001460 break;
1461
1462 case MotionEvent.ACTION_POINTER_UP:
1463 onSecondaryPointerUp(ev);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001464 releaseVelocityTracker();
Winson Chung321e9ee2010-08-09 13:37:56 -07001465 break;
1466 }
1467
1468 return true;
1469 }
1470
Sunny Goyalc39db732021-04-03 01:20:21 -07001471 protected void onNotSnappingToPageInFreeScroll() { }
Alex Chaub794ea62021-02-03 18:00:30 +00001472
Lais Andradecc5c8842021-06-04 18:20:30 +01001473 /**
1474 * Called when the view edges absorb part of the scroll. Subclasses can override this
1475 * to provide custom behavior during animation.
1476 */
1477 protected void onEdgeAbsorbingScroll() {
1478 }
1479
1480 /**
1481 * Called when the current page closest to the center of the screen changes as part of the
1482 * scroll. Subclasses can override this to provide custom behavior during scroll.
1483 */
1484 protected void onScrollOverPageChanged() {
1485 }
1486
Vinit Nayaka406f722019-12-19 11:50:55 -08001487 protected boolean shouldFlingForVelocity(int velocity) {
Winson Chung4941f652020-06-18 15:11:53 -07001488 float threshold = mAllowEasyFling ? mEasyFlingThresholdVelocity : mFlingThresholdVelocity;
1489 return Math.abs(velocity) > threshold;
Sunny Goyal65d9ceb2017-05-08 09:17:42 -07001490 }
1491
Alex Chau9d8eeab2022-04-05 17:13:56 +01001492 protected void resetTouchState() {
Adam Cohen7d30a372013-07-01 17:03:59 -07001493 releaseVelocityTracker();
Sunny Goyalaad33592018-08-07 17:20:35 -07001494 mIsBeingDragged = false;
Adam Cohen7d30a372013-07-01 17:03:59 -07001495 mActivePointerId = INVALID_POINTER;
Adam Cohen7d30a372013-07-01 17:03:59 -07001496 }
1497
Winson Chung185d7162011-02-28 13:47:29 -08001498 @Override
1499 public boolean onGenericMotionEvent(MotionEvent event) {
1500 if ((event.getSource() & InputDevice.SOURCE_CLASS_POINTER) != 0) {
1501 switch (event.getAction()) {
1502 case MotionEvent.ACTION_SCROLL: {
1503 // Handle mouse (or ext. device) by shifting the page depending on the scroll
1504 final float vscroll;
1505 final float hscroll;
1506 if ((event.getMetaState() & KeyEvent.META_SHIFT_ON) != 0) {
1507 vscroll = 0;
1508 hscroll = event.getAxisValue(MotionEvent.AXIS_VSCROLL);
1509 } else {
1510 vscroll = -event.getAxisValue(MotionEvent.AXIS_VSCROLL);
1511 hscroll = event.getAxisValue(MotionEvent.AXIS_HSCROLL);
1512 }
Sunny Goyal8b37c572020-03-31 12:12:14 -07001513 if (!canScroll(Math.abs(vscroll), Math.abs(hscroll))) {
1514 return false;
Samuel Fufa59cba192019-08-22 18:31:34 -07001515 }
Winson Chung185d7162011-02-28 13:47:29 -08001516 if (hscroll != 0 || vscroll != 0) {
Sunny Goyal70660032015-05-14 00:07:08 -07001517 boolean isForwardScroll = mIsRtl ? (hscroll < 0 || vscroll < 0)
Adam Cohen0ffac432013-07-10 11:19:26 -07001518 : (hscroll > 0 || vscroll > 0);
1519 if (isForwardScroll) {
Winson Chung185d7162011-02-28 13:47:29 -08001520 scrollRight();
1521 } else {
1522 scrollLeft();
1523 }
1524 return true;
1525 }
1526 }
1527 }
1528 }
1529 return super.onGenericMotionEvent(event);
1530 }
1531
Sunny Goyal8b37c572020-03-31 12:12:14 -07001532 /**
1533 * Returns true if the paged view can scroll for the provided vertical and horizontal
1534 * scroll values
1535 */
1536 protected boolean canScroll(float absVScroll, float absHScroll) {
1537 ActivityContext ac = ActivityContext.lookupContext(getContext());
1538 return (ac == null || AbstractFloatingView.getTopOpenView(ac) == null);
Samuel Fufa59cba192019-08-22 18:31:34 -07001539 }
1540
Michael Jurkab8f06722010-10-10 15:58:46 -07001541 private void acquireVelocityTrackerAndAddMovement(MotionEvent ev) {
1542 if (mVelocityTracker == null) {
1543 mVelocityTracker = VelocityTracker.obtain();
1544 }
1545 mVelocityTracker.addMovement(ev);
1546 }
1547
1548 private void releaseVelocityTracker() {
1549 if (mVelocityTracker != null) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001550 mVelocityTracker.clear();
Michael Jurkab8f06722010-10-10 15:58:46 -07001551 mVelocityTracker.recycle();
1552 mVelocityTracker = null;
1553 }
1554 }
1555
Winson Chung321e9ee2010-08-09 13:37:56 -07001556 private void onSecondaryPointerUp(MotionEvent ev) {
Winson Chung4941f652020-06-18 15:11:53 -07001557 final int pointerIndex = ev.getActionIndex();
Winson Chung321e9ee2010-08-09 13:37:56 -07001558 final int pointerId = ev.getPointerId(pointerIndex);
1559 if (pointerId == mActivePointerId) {
1560 // This was our active pointer going up. Choose a new
1561 // active pointer and adjust accordingly.
1562 // TODO: Make this decision more intelligent.
1563 final int newPointerIndex = pointerIndex == 0 ? 1 : 0;
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001564 mDownMotionPrimary = mOrientationHandler.getPrimaryDirection(ev, newPointerIndex);
1565 mLastMotion = (int) mDownMotionPrimary;
Winson Chung321e9ee2010-08-09 13:37:56 -07001566 mActivePointerId = ev.getPointerId(newPointerIndex);
1567 if (mVelocityTracker != null) {
1568 mVelocityTracker.clear();
1569 }
1570 }
Jeff Brown1d0867c2010-12-02 18:27:39 -08001571 }
1572
Winson Chung321e9ee2010-08-09 13:37:56 -07001573 @Override
1574 public void requestChildFocus(View child, View focused) {
1575 super.requestChildFocus(child, focused);
Schneider Victor-tuliasbdae57c2023-10-10 11:16:54 -04001576 if (!shouldHandleRequestChildFocus()) {
1577 return;
1578 }
Andras Kloczl359d1ae2021-05-04 22:25:27 +02001579 // In case the device is controlled by a controller, mCurrentPage isn't updated properly
1580 // which results in incorrect navigation
1581 int nextPage = getNextPage();
1582 if (nextPage != mCurrentPage) {
1583 setCurrentPage(nextPage);
1584 }
1585
Andras Kloczl7e912442021-05-06 12:50:28 +02001586 int page = indexOfChild(child);
1587 if (page >= 0 && !isVisible(page) && !isInTouchMode()) {
Winson Chung86f77532010-08-24 11:08:22 -07001588 snapToPage(page);
Winson Chung321e9ee2010-08-09 13:37:56 -07001589 }
1590 }
1591
Schneider Victor-tuliasbdae57c2023-10-10 11:16:54 -04001592 protected boolean shouldHandleRequestChildFocus() {
1593 return true;
1594 }
1595
Alex Chaub794ea62021-02-03 18:00:30 +00001596 public int getDestinationPage() {
1597 return getDestinationPage(mOrientationHandler.getPrimaryScroll(this));
1598 }
1599
Alex Chaudedbc8a2021-03-17 16:53:26 +00001600 protected int getDestinationPage(int primaryScroll) {
1601 return getPageNearestToCenterOfScreen(primaryScroll);
Alex Chaub794ea62021-02-03 18:00:30 +00001602 }
1603
Sunny Goyal228153d2018-01-04 15:35:22 -08001604 public int getPageNearestToCenterOfScreen() {
Vinit Nayaka406f722019-12-19 11:50:55 -08001605 return getPageNearestToCenterOfScreen(mOrientationHandler.getPrimaryScroll(this));
Tony Wickham8f7ead32016-04-07 18:46:44 -07001606 }
1607
Alex Chaudedbc8a2021-03-17 16:53:26 +00001608 private int getPageNearestToCenterOfScreen(int primaryScroll) {
1609 int screenCenter = getScreenCenter(primaryScroll);
Adam Cohen22f823d2011-09-01 17:22:18 -07001610 int minDistanceFromScreenCenter = Integer.MAX_VALUE;
Winson Chung321e9ee2010-08-09 13:37:56 -07001611 int minDistanceFromScreenCenterIndex = -1;
Winson Chung321e9ee2010-08-09 13:37:56 -07001612 final int childCount = getChildCount();
1613 for (int i = 0; i < childCount; ++i) {
Tony Wickham7383d4e2020-07-07 19:25:25 -07001614 int distanceFromScreenCenter = Math.abs(
1615 getDisplacementFromScreenCenter(i, screenCenter));
Winson Chung321e9ee2010-08-09 13:37:56 -07001616 if (distanceFromScreenCenter < minDistanceFromScreenCenter) {
1617 minDistanceFromScreenCenter = distanceFromScreenCenter;
1618 minDistanceFromScreenCenterIndex = i;
1619 }
1620 }
Adam Cohend19d3ca2010-09-15 14:43:42 -07001621 return minDistanceFromScreenCenterIndex;
1622 }
1623
Tony Wickham7383d4e2020-07-07 19:25:25 -07001624 private int getDisplacementFromScreenCenter(int childIndex, int screenCenter) {
Cole Faust50ec4af2022-10-15 21:33:28 -07001625 int childSize = getChildVisibleSize(childIndex);
Tony Wickham7383d4e2020-07-07 19:25:25 -07001626 int halfChildSize = (childSize / 2);
1627 int childCenter = getChildOffset(childIndex) + halfChildSize;
1628 return childCenter - screenCenter;
1629 }
1630
1631 protected int getDisplacementFromScreenCenter(int childIndex) {
Alex Chaudedbc8a2021-03-17 16:53:26 +00001632 int primaryScroll = mOrientationHandler.getPrimaryScroll(this);
1633 int screenCenter = getScreenCenter(primaryScroll);
Tony Wickham7383d4e2020-07-07 19:25:25 -07001634 return getDisplacementFromScreenCenter(childIndex, screenCenter);
1635 }
1636
Andras Kloczl9732df12021-09-09 19:40:42 +01001637 protected int getScreenCenter(int primaryScroll) {
Alex Chaudedbc8a2021-03-17 16:53:26 +00001638 float primaryScale = mOrientationHandler.getPrimaryScale(this);
1639 float primaryPivot = mOrientationHandler.getPrimaryValue(getPivotX(), getPivotY());
1640 int pageOrientationSize = mOrientationHandler.getMeasuredSize(this);
1641 return Math.round(primaryScroll + (pageOrientationSize / 2f - primaryPivot) / primaryScale
1642 + primaryPivot);
1643 }
1644
Adam Cohend19d3ca2010-09-15 14:43:42 -07001645 protected void snapToDestination() {
Andras Kloczlc2bd15f2022-03-30 18:06:13 +01001646 snapToPage(getDestinationPage(), mPageSnapAnimationDuration);
Winson Chung321e9ee2010-08-09 13:37:56 -07001647 }
1648
Adam Cohene0f66b52010-11-23 15:06:07 -08001649 // We want the duration of the page snap animation to be influenced by the distance that
1650 // the screen has to travel, however, we don't want this duration to be effected in a
1651 // purely linear fashion. Instead, we use this method to moderate the effect that the distance
1652 // of travel has on the overall snap duration.
Sunny Goyal4d113a52015-05-27 10:05:28 -07001653 private float distanceInfluenceForSnapDuration(float f) {
Adam Cohene0f66b52010-11-23 15:06:07 -08001654 f -= 0.5f; // center the values about 0.
1655 f *= 0.3f * Math.PI / 2.0f;
1656 return (float) Math.sin(f);
1657 }
1658
Winson Chung05a31ed2018-02-08 17:08:43 -08001659 protected boolean snapToPageWithVelocity(int whichPage, int velocity) {
Adam Cohen6f127a62014-06-12 14:54:41 -07001660 whichPage = validateNewPage(whichPage);
Vinit Nayaka406f722019-12-19 11:50:55 -08001661 int halfScreenSize = mOrientationHandler.getMeasuredSize(this) / 2;
Adam Cohene0f66b52010-11-23 15:06:07 -08001662
Vinit Nayaka406f722019-12-19 11:50:55 -08001663 final int newLoc = getScrollForPage(whichPage);
Sunny Goyalc39db732021-04-03 01:20:21 -07001664 int delta = newLoc - mOrientationHandler.getPrimaryScroll(this);
Adam Cohene0f66b52010-11-23 15:06:07 -08001665 int duration = 0;
1666
Sunny Goyal4d113a52015-05-27 10:05:28 -07001667 if (Math.abs(velocity) < mMinFlingVelocity) {
Adam Cohene0f66b52010-11-23 15:06:07 -08001668 // If the velocity is low enough, then treat this more as an automatic page advance
1669 // as opposed to an apparent physical response to flinging
Andras Kloczlc2bd15f2022-03-30 18:06:13 +01001670 return snapToPage(whichPage, mPageSnapAnimationDuration);
Adam Cohene0f66b52010-11-23 15:06:07 -08001671 }
1672
1673 // Here we compute a "distance" that will be used in the computation of the overall
1674 // snap duration. This is a function of the actual distance that needs to be traveled;
1675 // we keep this value close to half screen size in order to reduce the variance in snap
1676 // duration as a function of the distance the page needs to travel.
Michael Jurka20b7ca92011-06-07 20:09:16 -07001677 float distanceRatio = Math.min(1f, 1.0f * Math.abs(delta) / (2 * halfScreenSize));
Adam Cohene0f66b52010-11-23 15:06:07 -08001678 float distance = halfScreenSize + halfScreenSize *
1679 distanceInfluenceForSnapDuration(distanceRatio);
1680
1681 velocity = Math.abs(velocity);
Adam Cohen265b9a62011-12-07 14:37:18 -08001682 velocity = Math.max(mMinSnapVelocity, velocity);
Adam Cohene0f66b52010-11-23 15:06:07 -08001683
1684 // we want the page's snap velocity to approximately match the velocity at which the
1685 // user flings, so we scale the duration by a value near to the derivative of the scroll
Michael Jurka20b7ca92011-06-07 20:09:16 -07001686 // interpolator at zero, ie. 5. We use 4 to make it a little slower.
1687 duration = 4 * Math.round(1000 * Math.abs(distance / velocity));
Adam Cohene0f66b52010-11-23 15:06:07 -08001688
Sunny Goyalc39db732021-04-03 01:20:21 -07001689 return snapToPage(whichPage, delta, duration);
Michael Jurka0142d492010-08-25 17:46:15 -07001690 }
1691
Winson Chung05a31ed2018-02-08 17:08:43 -08001692 public boolean snapToPage(int whichPage) {
Andras Kloczlc2bd15f2022-03-30 18:06:13 +01001693 return snapToPage(whichPage, mPageSnapAnimationDuration);
Winson Chung321e9ee2010-08-09 13:37:56 -07001694 }
1695
Winson Chung05a31ed2018-02-08 17:08:43 -08001696 public boolean snapToPageImmediately(int whichPage) {
Andras Kloczlc2bd15f2022-03-30 18:06:13 +01001697 return snapToPage(whichPage, mPageSnapAnimationDuration, true);
Adam Cohen7d30a372013-07-01 17:03:59 -07001698 }
1699
Winson Chung05a31ed2018-02-08 17:08:43 -08001700 public boolean snapToPage(int whichPage, int duration) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001701 return snapToPage(whichPage, duration, false);
Adam Cohen7d30a372013-07-01 17:03:59 -07001702 }
1703
Sunny Goyalc39db732021-04-03 01:20:21 -07001704 protected boolean snapToPage(int whichPage, int duration, boolean immediate) {
Adam Cohen6f127a62014-06-12 14:54:41 -07001705 whichPage = validateNewPage(whichPage);
Winson Chung321e9ee2010-08-09 13:37:56 -07001706
Vinit Nayaka406f722019-12-19 11:50:55 -08001707 int newLoc = getScrollForPage(whichPage);
Sunny Goyalc39db732021-04-03 01:20:21 -07001708 final int delta = newLoc - mOrientationHandler.getPrimaryScroll(this);
1709 return snapToPage(whichPage, delta, duration, immediate);
Michael Jurka0142d492010-08-25 17:46:15 -07001710 }
1711
Winson Chung05a31ed2018-02-08 17:08:43 -08001712 protected boolean snapToPage(int whichPage, int delta, int duration) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001713 return snapToPage(whichPage, delta, duration, false);
Adam Cohen7d30a372013-07-01 17:03:59 -07001714 }
Michael Jurka0142d492010-08-25 17:46:15 -07001715
Sunny Goyalc39db732021-04-03 01:20:21 -07001716 protected boolean snapToPage(int whichPage, int delta, int duration, boolean immediate) {
Sunny Goyal9bb8ffb2018-05-24 17:11:16 -07001717 if (mFirstLayout) {
1718 setCurrentPage(whichPage);
1719 return false;
1720 }
Tony Wickhamd58c2d52018-05-04 12:10:55 -07001721
Brian Isganitisfdd044e2023-03-02 19:45:23 +00001722 if (FeatureFlags.IS_STUDIO_BUILD && !Utilities.isRunningInTestHarness()) {
Tony Wickhamcb3f8702018-08-27 17:36:03 -07001723 duration *= Settings.Global.getFloat(getContext().getContentResolver(),
1724 Settings.Global.WINDOW_ANIMATION_SCALE, 1);
Tony Wickhamd58c2d52018-05-04 12:10:55 -07001725 }
1726
Adam Cohen6f127a62014-06-12 14:54:41 -07001727 whichPage = validateNewPage(whichPage);
1728
Adam Cohen7d30a372013-07-01 17:03:59 -07001729 mNextPage = whichPage;
Michael Jurka0142d492010-08-25 17:46:15 -07001730
Winson Chung321e9ee2010-08-09 13:37:56 -07001731 awakenScrollBars(duration);
Adam Cohen7d30a372013-07-01 17:03:59 -07001732 if (immediate) {
1733 duration = 0;
1734 } else if (duration == 0) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001735 duration = Math.abs(delta);
1736 }
1737
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001738 if (duration != 0) {
1739 pageBeginTransition();
1740 }
1741
Adam Cohenf358a4b2013-07-23 16:47:31 -07001742 if (!mScroller.isFinished()) {
Adam Cohenf9618852013-11-08 06:45:03 -08001743 abortScrollerAnimation(false);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001744 }
Adam Cohenf9618852013-11-08 06:45:03 -08001745
Sunny Goyalc39db732021-04-03 01:20:21 -07001746 mScroller.startScroll(mOrientationHandler.getPrimaryScroll(this), 0, delta, 0, duration);
Adam Cohen674531f2013-12-13 15:07:14 -08001747 updatePageIndicator();
Adam Cohen7d30a372013-07-01 17:03:59 -07001748
1749 // Trigger a compute() to finish switching pages if necessary
1750 if (immediate) {
1751 computeScroll();
Sunny Goyal76dbf6f2017-01-03 14:55:47 -08001752 pageEndTransition();
Adam Cohen7d30a372013-07-01 17:03:59 -07001753 }
1754
Winson Chung321e9ee2010-08-09 13:37:56 -07001755 invalidate();
Winson Chung05a31ed2018-02-08 17:08:43 -08001756 return Math.abs(delta) > 0;
Winson Chung321e9ee2010-08-09 13:37:56 -07001757 }
1758
Vadim Tryshev98913d02018-05-18 18:41:34 -07001759 public boolean scrollLeft() {
1760 if (getNextPage() > 0) {
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001761 snapToPage(getNextPage() - getPanelCount());
Vadim Tryshev98913d02018-05-18 18:41:34 -07001762 return true;
1763 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001764 return mAllowOverScroll;
Winson Chung321e9ee2010-08-09 13:37:56 -07001765 }
1766
Vadim Tryshev98913d02018-05-18 18:41:34 -07001767 public boolean scrollRight() {
1768 if (getNextPage() < getChildCount() - 1) {
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001769 snapToPage(getNextPage() + getPanelCount());
Vadim Tryshev98913d02018-05-18 18:41:34 -07001770 return true;
1771 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001772 return mAllowOverScroll;
Winson Chung321e9ee2010-08-09 13:37:56 -07001773 }
1774
Vadim Trysheve6bbefb2018-04-03 13:38:06 -07001775 @Override
Lais Andradecc5c8842021-06-04 18:20:30 +01001776 protected void onScrollChanged(int l, int t, int oldl, int oldt) {
Lais Andradef6e31b12021-10-27 12:04:28 +01001777 if (mScroller.isFinished()) {
1778 // This was not caused by the scroller, skip it.
1779 return;
1780 }
Lais Andradecc5c8842021-06-04 18:20:30 +01001781 int newDestinationPage = getDestinationPage();
1782 if (newDestinationPage >= 0 && newDestinationPage != mCurrentScrollOverPage) {
1783 mCurrentScrollOverPage = newDestinationPage;
1784 onScrollOverPageChanged();
1785 }
1786 }
1787
1788 @Override
Vadim Trysheve6bbefb2018-04-03 13:38:06 -07001789 public CharSequence getAccessibilityClassName() {
1790 // Some accessibility services have special logic for ScrollView. Since we provide same
1791 // accessibility info as ScrollView, inform the service to handle use the same way.
1792 return ScrollView.class.getName();
1793 }
1794
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001795 protected boolean isPageOrderFlipped() {
1796 return false;
1797 }
1798
Winson Chung6a0f57d2011-06-29 20:10:49 -07001799 /* Accessibility */
Sunny Goyalcf25b522015-07-09 00:01:18 -07001800 @SuppressWarnings("deprecation")
Winson Chung6a0f57d2011-06-29 20:10:49 -07001801 @Override
1802 public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) {
1803 super.onInitializeAccessibilityNodeInfo(info);
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001804 final boolean pagesFlipped = isPageOrderFlipped();
Alex Chau9ead9ca2021-11-26 16:22:49 +00001805 info.setScrollable(getPageCount() > 0);
1806 int primaryScroll = mOrientationHandler.getPrimaryScroll(this);
1807 if (getCurrentPage() < getPageCount() - getPanelCount()
1808 || (getCurrentPage() == getPageCount() - getPanelCount()
1809 && primaryScroll != getScrollForPage(getPageCount() - getPanelCount()))) {
yingleiw02cc8482019-08-02 16:14:27 -07001810 info.addAction(pagesFlipped ?
Alex Chau9ead9ca2021-11-26 16:22:49 +00001811 AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_BACKWARD
1812 : AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_FORWARD);
yingleiw02cc8482019-08-02 16:14:27 -07001813 info.addAction(mIsRtl ?
1814 AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_LEFT
1815 : AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_RIGHT);
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001816 }
Alex Chau9ead9ca2021-11-26 16:22:49 +00001817 if (getCurrentPage() > 0
1818 || (getCurrentPage() == 0 && primaryScroll != getScrollForPage(0))) {
yingleiw02cc8482019-08-02 16:14:27 -07001819 info.addAction(pagesFlipped ?
Alex Chau9ead9ca2021-11-26 16:22:49 +00001820 AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_FORWARD
1821 : AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_BACKWARD);
yingleiw02cc8482019-08-02 16:14:27 -07001822 info.addAction(mIsRtl ?
1823 AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_RIGHT
1824 : AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_LEFT);
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001825 }
Vadim Tryshev7af0d442015-05-15 08:48:11 -07001826 // Accessibility-wise, PagedView doesn't support long click, so disabling it.
1827 // Besides disabling the accessibility long-click, this also prevents this view from getting
1828 // accessibility focus.
1829 info.setLongClickable(false);
Sunny Goyala52ecb02016-12-16 15:04:51 -08001830 info.removeAction(AccessibilityNodeInfo.AccessibilityAction.ACTION_LONG_CLICK);
Winson Chung6a0f57d2011-06-29 20:10:49 -07001831 }
1832
1833 @Override
Alan Viverette254139a2013-10-08 13:13:46 -07001834 public void sendAccessibilityEvent(int eventType) {
1835 // Don't let the view send real scroll events.
1836 if (eventType != AccessibilityEvent.TYPE_VIEW_SCROLLED) {
1837 super.sendAccessibilityEvent(eventType);
1838 }
1839 }
1840
1841 @Override
Winson Chung6a0f57d2011-06-29 20:10:49 -07001842 public void onInitializeAccessibilityEvent(AccessibilityEvent event) {
1843 super.onInitializeAccessibilityEvent(event);
Pinyao Tingaf6daa22019-09-18 22:18:03 +00001844 event.setScrollable(mAllowOverScroll || getPageCount() > 1);
Winson Chung6a0f57d2011-06-29 20:10:49 -07001845 }
1846
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001847 @Override
1848 public boolean performAccessibilityAction(int action, Bundle arguments) {
1849 if (super.performAccessibilityAction(action, arguments)) {
1850 return true;
1851 }
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001852 final boolean pagesFlipped = isPageOrderFlipped();
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001853 switch (action) {
1854 case AccessibilityNodeInfo.ACTION_SCROLL_FORWARD: {
Vadim Tryshev98913d02018-05-18 18:41:34 -07001855 if (pagesFlipped ? scrollLeft() : scrollRight()) {
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001856 return true;
1857 }
1858 } break;
1859 case AccessibilityNodeInfo.ACTION_SCROLL_BACKWARD: {
Vadim Tryshev98913d02018-05-18 18:41:34 -07001860 if (pagesFlipped ? scrollRight() : scrollLeft()) {
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001861 return true;
1862 }
yingleiw02cc8482019-08-02 16:14:27 -07001863 } break;
1864 case android.R.id.accessibilityActionPageRight: {
1865 if (!mIsRtl) {
Alex Chau9ead9ca2021-11-26 16:22:49 +00001866 return scrollRight();
yingleiw02cc8482019-08-02 16:14:27 -07001867 } else {
Alex Chau9ead9ca2021-11-26 16:22:49 +00001868 return scrollLeft();
yingleiw02cc8482019-08-02 16:14:27 -07001869 }
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001870 }
yingleiw02cc8482019-08-02 16:14:27 -07001871 case android.R.id.accessibilityActionPageLeft: {
1872 if (!mIsRtl) {
Alex Chau9ead9ca2021-11-26 16:22:49 +00001873 return scrollLeft();
yingleiw02cc8482019-08-02 16:14:27 -07001874 } else {
Alex Chau9ead9ca2021-11-26 16:22:49 +00001875 return scrollRight();
yingleiw02cc8482019-08-02 16:14:27 -07001876 }
1877 }
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001878 }
1879 return false;
1880 }
1881
Vadim Tryshev2c430b32018-04-04 14:45:21 -07001882 protected boolean canAnnouncePageDescription() {
1883 return true;
1884 }
1885
Adam Cohen0ffac432013-07-10 11:19:26 -07001886 protected String getCurrentPageDescription() {
Sunny Goyalf4f89ef2015-09-02 15:06:12 -07001887 return getContext().getString(R.string.default_scroll_format,
Adam Cohen0ffac432013-07-10 11:19:26 -07001888 getNextPage() + 1, getChildCount());
1889 }
1890
Tony Mak2e564402018-02-27 17:19:34 +00001891 protected float getDownMotionX() {
1892 return mDownMotionX;
1893 }
1894
1895 protected float getDownMotionY() {
1896 return mDownMotionY;
1897 }
1898
Sunny Goyal20a13ff2018-03-13 16:44:00 -07001899 protected interface ComputePageScrollsLogic {
1900
1901 boolean shouldIncludeView(View view);
1902 }
Vadim Tryshev528b9e02018-05-24 18:22:03 -07001903
1904 public int[] getVisibleChildrenRange() {
1905 float visibleLeft = 0;
1906 float visibleRight = visibleLeft + getMeasuredWidth();
1907 float scaleX = getScaleX();
1908 if (scaleX < 1 && scaleX > 0) {
1909 float mid = getMeasuredWidth() / 2;
1910 visibleLeft = mid - ((mid - visibleLeft) / scaleX);
1911 visibleRight = mid + ((visibleRight - mid) / scaleX);
1912 }
1913
1914 int leftChild = -1;
1915 int rightChild = -1;
1916 final int childCount = getChildCount();
1917 for (int i = 0; i < childCount; i++) {
1918 final View child = getPageAt(i);
1919
1920 float left = child.getLeft() + child.getTranslationX() - getScrollX();
1921 if (left <= visibleRight && (left + child.getMeasuredWidth()) >= visibleLeft) {
1922 if (leftChild == -1) {
1923 leftChild = i;
1924 }
1925 rightChild = i;
1926 }
1927 }
1928 mTmpIntPair[0] = leftChild;
1929 mTmpIntPair[1] = rightChild;
1930 return mTmpIntPair;
1931 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001932
1933 @Override
1934 public void draw(Canvas canvas) {
1935 super.draw(canvas);
1936 drawEdgeEffect(canvas);
Sunny Goyal05b59c02021-04-29 13:55:40 -07001937 pageEndTransition();
Sunny Goyalc39db732021-04-03 01:20:21 -07001938 }
1939
1940 protected void drawEdgeEffect(Canvas canvas) {
1941 if (mAllowOverScroll && (!mEdgeGlowRight.isFinished() || !mEdgeGlowLeft.isFinished())) {
1942 final int width = getWidth();
1943 final int height = getHeight();
1944 if (!mEdgeGlowLeft.isFinished()) {
1945 final int restoreCount = canvas.save();
1946 canvas.rotate(-90);
1947 canvas.translate(-height, Math.min(mMinScroll, getScrollX()));
1948 mEdgeGlowLeft.setSize(height, width);
1949 if (mEdgeGlowLeft.draw(canvas)) {
1950 postInvalidateOnAnimation();
1951 }
1952 canvas.restoreToCount(restoreCount);
1953 }
1954 if (!mEdgeGlowRight.isFinished()) {
1955 final int restoreCount = canvas.save();
1956 canvas.rotate(90, width, 0);
1957 canvas.translate(width, -(Math.max(mMaxScroll, getScrollX())));
1958
1959 mEdgeGlowRight.setSize(height, width);
1960 if (mEdgeGlowRight.draw(canvas)) {
1961 postInvalidateOnAnimation();
1962 }
1963 canvas.restoreToCount(restoreCount);
1964 }
1965 }
1966 }
Adam Cohen5084cba2013-09-03 12:01:16 -07001967}