blob: af64b3b0eeb4204880f8a8c10ff994e326a07fec [file] [log] [blame]
Winson Chung321e9ee2010-08-09 13:37:56 -07001/*
Adam Cohen7d30a372013-07-01 17:03:59 -07002 * Copyright (C) 2012 The Android Open Source Project
Winson Chung321e9ee2010-08-09 13:37:56 -07003 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Daniel Sandler325dc232013-06-05 22:57:57 -040017package com.android.launcher3;
Winson Chung321e9ee2010-08-09 13:37:56 -070018
Sunny Goyalc39db732021-04-03 01:20:21 -070019import static com.android.launcher3.anim.Interpolators.SCROLL;
Sunny Goyal8b37c572020-03-31 12:12:14 -070020import static com.android.launcher3.compat.AccessibilityManagerCompat.isAccessibilityEnabled;
21import static com.android.launcher3.compat.AccessibilityManagerCompat.isObservedEventType;
Sunny Goyal8b37c572020-03-31 12:12:14 -070022import static com.android.launcher3.touch.OverScroll.OVERSCROLL_DAMP_FACTOR;
Sunny Goyal8b37c572020-03-31 12:12:14 -070023import static com.android.launcher3.touch.PagedOrientationHandler.VIEW_SCROLL_BY;
24import static com.android.launcher3.touch.PagedOrientationHandler.VIEW_SCROLL_TO;
25
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -070026import android.animation.LayoutTransition;
Sunny Goyalcf25b522015-07-09 00:01:18 -070027import android.annotation.SuppressLint;
Winson Chung321e9ee2010-08-09 13:37:56 -070028import android.content.Context;
Andras Kloczlc2bd15f2022-03-30 18:06:13 +010029import android.content.res.Configuration;
30import android.content.res.Resources;
Adam Cohen9c4949e2010-10-05 12:27:22 -070031import android.content.res.TypedArray;
Jon Miranda71cb80c2019-01-24 21:25:13 -080032import android.graphics.Canvas;
Winson Chung321e9ee2010-08-09 13:37:56 -070033import android.graphics.Rect;
Svetoslav Ganov08055f62012-05-15 11:06:36 -070034import android.os.Bundle;
Tony Wickhamd58c2d52018-05-04 12:10:55 -070035import android.provider.Settings;
Winson Chung321e9ee2010-08-09 13:37:56 -070036import android.util.AttributeSet;
Winson Chung785d2eb2011-04-14 16:08:02 -070037import android.util.Log;
Winson Chung185d7162011-02-28 13:47:29 -080038import android.view.InputDevice;
39import android.view.KeyEvent;
Winson Chung321e9ee2010-08-09 13:37:56 -070040import android.view.MotionEvent;
41import android.view.VelocityTracker;
42import android.view.View;
43import android.view.ViewConfiguration;
Sunny Goyal4ffec482016-02-09 11:28:52 -080044import android.view.ViewDebug;
Winson Chung321e9ee2010-08-09 13:37:56 -070045import android.view.ViewGroup;
46import android.view.ViewParent;
Winson Chung6a0f57d2011-06-29 20:10:49 -070047import android.view.accessibility.AccessibilityEvent;
48import android.view.accessibility.AccessibilityNodeInfo;
Sunny Goyalc39db732021-04-03 01:20:21 -070049import android.widget.OverScroller;
Vadim Trysheve6bbefb2018-04-03 13:38:06 -070050import android.widget.ScrollView;
Tony Wickhamf549dab2016-05-16 09:54:06 -070051
Tony Wickham62117d72020-03-26 16:56:26 -070052import androidx.annotation.Nullable;
53
Jon Miranda9e198662020-03-11 14:42:02 -070054import com.android.launcher3.compat.AccessibilityManagerCompat;
55import com.android.launcher3.config.FeatureFlags;
Jon Miranda9e198662020-03-11 14:42:02 -070056import com.android.launcher3.pageindicators.PageIndicator;
Jon Miranda9e198662020-03-11 14:42:02 -070057import com.android.launcher3.touch.PagedOrientationHandler;
58import com.android.launcher3.touch.PagedOrientationHandler.ChildBounds;
Sunny Goyalc39db732021-04-03 01:20:21 -070059import com.android.launcher3.util.EdgeEffectCompat;
Andras Kloczl55edfe52021-05-14 12:21:30 +020060import com.android.launcher3.util.IntSet;
Jon Miranda9e198662020-03-11 14:42:02 -070061import com.android.launcher3.util.Thunk;
Sunny Goyal8b37c572020-03-31 12:12:14 -070062import com.android.launcher3.views.ActivityContext;
Jon Miranda9e198662020-03-11 14:42:02 -070063
64import java.util.ArrayList;
Sunny Goyal59969372021-05-06 12:11:44 -070065import java.util.function.Consumer;
Jon Miranda9e198662020-03-11 14:42:02 -070066
Winson Chung321e9ee2010-08-09 13:37:56 -070067/**
68 * An abstraction of the original Workspace which supports browsing through a
Michael Jurka0142d492010-08-25 17:46:15 -070069 * sequential list of "pages"
Winson Chung321e9ee2010-08-09 13:37:56 -070070 */
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -080071public abstract class PagedView<T extends View & PageIndicator> extends ViewGroup {
Winson Chung321e9ee2010-08-09 13:37:56 -070072 private static final String TAG = "PagedView";
Winson Chung785d2eb2011-04-14 16:08:02 -070073 private static final boolean DEBUG = false;
Winson Chung4941f652020-06-18 15:11:53 -070074 public static final boolean DEBUG_FAILED_QUICKSWITCH = false;
Sunny Goyal20a13ff2018-03-13 16:44:00 -070075
Winson Chung4941f652020-06-18 15:11:53 -070076 public static final int ACTION_MOVE_ALLOW_EASY_FLING = MotionEvent.ACTION_MASK - 1;
Sunny Goyala7a5bf32020-01-05 15:35:29 +053077 public static final int INVALID_PAGE = -1;
Sunny Goyal20a13ff2018-03-13 16:44:00 -070078 protected static final ComputePageScrollsLogic SIMPLE_SCROLL_LOGIC = (v) -> v.getVisibility() != GONE;
Winson Chung321e9ee2010-08-09 13:37:56 -070079
Adam Cohenb64cb5a2011-02-15 13:53:42 -080080 private static final float RETURN_TO_ORIGINAL_PAGE_THRESHOLD = 0.33f;
Adam Cohen00481b32011-11-18 12:03:48 -080081 // The page is moved more than halfway, automatically move to the next page on touch up.
82 private static final float SIGNIFICANT_MOVE_THRESHOLD = 0.4f;
Adam Cohen68d73932010-11-15 10:50:58 -080083
Sunny Goyal8e2133b2015-05-06 13:39:07 -070084 private static final float MAX_SCROLL_PROGRESS = 1.0f;
85
Adam Cohenf358a4b2013-07-23 16:47:31 -070086 private boolean mFreeScroll = false;
Adam Cohenf358a4b2013-07-23 16:47:31 -070087
Andras Kloczlc2bd15f2022-03-30 18:06:13 +010088 private int mFlingThresholdVelocity;
89 private int mEasyFlingThresholdVelocity;
90 private int mMinFlingVelocity;
91 private int mMinSnapVelocity;
92 private int mPageSnapAnimationDuration;
Michael Jurka0142d492010-08-25 17:46:15 -070093
Michael Jurka0142d492010-08-25 17:46:15 -070094 protected boolean mFirstLayout = true;
95
Sunny Goyal4ffec482016-02-09 11:28:52 -080096 @ViewDebug.ExportedProperty(category = "launcher")
Michael Jurka0142d492010-08-25 17:46:15 -070097 protected int mCurrentPage;
Alex Chauba61b982021-06-15 16:29:19 +010098 // Difference between current scroll position and mCurrentPage's page scroll. Used to maintain
99 // relative scroll position unchanged in updateCurrentPageScroll. Cleared when snapping to a
100 // page.
101 protected int mCurrentPageScrollDiff;
Lais Andradecc5c8842021-06-04 18:20:30 +0100102 // The current page the PagedView is scrolling over on it's way to the destination page.
103 protected int mCurrentScrollOverPage;
Adam Cohene61a9a22013-06-11 15:45:31 -0700104
Sunny Goyal4ffec482016-02-09 11:28:52 -0800105 @ViewDebug.ExportedProperty(category = "launcher")
Michael Jurka0142d492010-08-25 17:46:15 -0700106 protected int mNextPage = INVALID_PAGE;
Vinit Nayaka406f722019-12-19 11:50:55 -0800107 protected int mMaxScroll;
108 protected int mMinScroll;
Sunny Goyalb7b01352018-08-09 12:31:20 -0700109 protected OverScroller mScroller;
Winson Chung321e9ee2010-08-09 13:37:56 -0700110 private VelocityTracker mVelocityTracker;
Sunny Goyale15e2a82017-12-15 13:05:42 -0800111 protected int mPageSpacing = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -0700112
113 private float mDownMotionX;
Adam Cohen7d30a372013-07-01 17:03:59 -0700114 private float mDownMotionY;
Vinit Nayaka406f722019-12-19 11:50:55 -0800115 private float mDownMotionPrimary;
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -0700116 private int mLastMotion;
Vinit Nayaka406f722019-12-19 11:50:55 -0800117 private float mTotalMotion;
Winson Chung4941f652020-06-18 15:11:53 -0700118 // Used in special cases where the fling checks can be relaxed for an intentional gesture
119 private boolean mAllowEasyFling;
Sunny Goyalacd17df2020-04-03 15:58:45 -0700120 protected PagedOrientationHandler mOrientationHandler = PagedOrientationHandler.PORTRAIT;
Adam Cohenedb40762013-07-18 16:45:45 -0700121
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700122 private final ArrayList<Runnable> mOnPageScrollsInitializedCallbacks = new ArrayList<>();
123
124 // We should always check pageScrollsInitialized() is true when using mPageScrolls.
125 @Nullable protected int[] mPageScrolls = null;
Sunny Goyalaad33592018-08-07 17:20:35 -0700126 private boolean mIsBeingDragged;
Adam Cohencae7f572013-11-04 14:42:52 -0800127
Winson Chung4941f652020-06-18 15:11:53 -0700128 // The amount of movement to begin scrolling
Michael Jurka7426c422010-11-11 15:23:47 -0800129 protected int mTouchSlop;
Winson Chung4941f652020-06-18 15:11:53 -0700130 // The amount of movement to begin paging
131 protected int mPageSlop;
Winson Chung321e9ee2010-08-09 13:37:56 -0700132 private int mMaximumVelocity;
Adam Cohen68d73932010-11-15 10:50:58 -0800133 protected boolean mAllowOverScroll = true;
Winson Chung321e9ee2010-08-09 13:37:56 -0700134
Michael Jurka5f1c5092010-09-03 14:15:02 -0700135 protected static final int INVALID_POINTER = -1;
Winson Chung321e9ee2010-08-09 13:37:56 -0700136
Michael Jurka5f1c5092010-09-03 14:15:02 -0700137 protected int mActivePointerId = INVALID_POINTER;
Winson Chung321e9ee2010-08-09 13:37:56 -0700138
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700139 protected boolean mIsPageInTransition = false;
Tony Wickham62117d72020-03-26 16:56:26 -0700140 private Runnable mOnPageTransitionEndCallback;
Patrick Dubroy1262e362010-10-06 15:49:50 -0700141
Winson Chungd2be3812013-07-16 11:11:32 -0700142 // Page Indicator
Adam Cohen091440a2015-03-18 14:16:05 -0700143 @Thunk int mPageIndicatorViewId;
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800144 protected T mPageIndicator;
Adam Cohen7d30a372013-07-01 17:03:59 -0700145
John Spurlock77e1f472013-09-11 10:09:51 -0400146 protected final Rect mInsets = new Rect();
Tony Wickhamdfb5cc92018-02-26 16:41:57 -0800147 protected boolean mIsRtl;
John Spurlock77e1f472013-09-11 10:09:51 -0400148
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800149 // Similar to the platform implementation of isLayoutValid();
150 protected boolean mIsLayoutValid;
151
Vadim Tryshev528b9e02018-05-24 18:22:03 -0700152 private int[] mTmpIntPair = new int[2];
153
Sunny Goyalc39db732021-04-03 01:20:21 -0700154 protected EdgeEffectCompat mEdgeGlowLeft;
155 protected EdgeEffectCompat mEdgeGlowRight;
156
Winson Chung321e9ee2010-08-09 13:37:56 -0700157 public PagedView(Context context) {
158 this(context, null);
159 }
160
161 public PagedView(Context context, AttributeSet attrs) {
162 this(context, attrs, 0);
163 }
164
165 public PagedView(Context context, AttributeSet attrs, int defStyle) {
166 super(context, attrs, defStyle);
Winson Chungc9ca2982013-07-19 12:07:38 -0700167
Adam Cohen9c4949e2010-10-05 12:27:22 -0700168 TypedArray a = context.obtainStyledAttributes(attrs,
169 R.styleable.PagedView, defStyle, 0);
Winson Chungd2be3812013-07-16 11:11:32 -0700170 mPageIndicatorViewId = a.getResourceId(R.styleable.PagedView_pageIndicator, -1);
Adam Cohen9c4949e2010-10-05 12:27:22 -0700171 a.recycle();
172
Winson Chung321e9ee2010-08-09 13:37:56 -0700173 setHapticFeedbackEnabled(false);
Sunny Goyal70660032015-05-14 00:07:08 -0700174 mIsRtl = Utilities.isRtl(getResources());
Winson Chung321e9ee2010-08-09 13:37:56 -0700175
Sunny Goyalc39db732021-04-03 01:20:21 -0700176 mScroller = new OverScroller(context, SCROLL);
Winson Chung86f77532010-08-24 11:08:22 -0700177 mCurrentPage = 0;
Lais Andradecc5c8842021-06-04 18:20:30 +0100178 mCurrentScrollOverPage = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -0700179
Vinit Nayaka406f722019-12-19 11:50:55 -0800180 final ViewConfiguration configuration = ViewConfiguration.get(context);
Winson Chung4941f652020-06-18 15:11:53 -0700181 mTouchSlop = configuration.getScaledTouchSlop();
182 mPageSlop = configuration.getScaledPagingTouchSlop();
Winson Chung321e9ee2010-08-09 13:37:56 -0700183 mMaximumVelocity = configuration.getScaledMaximumFlingVelocity();
Adam Cohen265b9a62011-12-07 14:37:18 -0800184
Andras Kloczlc2bd15f2022-03-30 18:06:13 +0100185 updateVelocityValues();
Sunny Goyala9f55462018-03-25 18:15:15 -0700186
Sunny Goyalc39db732021-04-03 01:20:21 -0700187 initEdgeEffect();
Sunny Goyaleaf7a952020-07-29 16:54:20 -0700188 setDefaultFocusHighlightEnabled(false);
Sunny Goyalc39db732021-04-03 01:20:21 -0700189 setWillNotDraw(false);
Winson Chung321e9ee2010-08-09 13:37:56 -0700190 }
191
Sunny Goyalc39db732021-04-03 01:20:21 -0700192 protected void initEdgeEffect() {
193 mEdgeGlowLeft = new EdgeEffectCompat(getContext());
194 mEdgeGlowRight = new EdgeEffectCompat(getContext());
Adam Cohenf9618852013-11-08 06:45:03 -0800195 }
196
Sunny Goyald0a6ae72016-06-16 12:29:03 -0700197 public void initParentViews(View parent) {
198 if (mPageIndicatorViewId > -1) {
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800199 mPageIndicator = parent.findViewById(mPageIndicatorViewId);
Tony Wickhambab101c2021-09-20 15:12:44 -0700200 mPageIndicator.setMarkersCount(getChildCount() / getPanelCount());
Winson Chungd2be3812013-07-16 11:11:32 -0700201 }
202 }
203
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800204 public T getPageIndicator() {
Adam Cohenedb40762013-07-18 16:45:45 -0700205 return mPageIndicator;
206 }
207
Adam Cohen674531f2013-12-13 15:07:14 -0800208 /**
Tony Wickham29d853c2015-09-08 10:35:56 -0700209 * Returns the index of the currently displayed page. When in free scroll mode, this is the page
210 * that the user was on before entering free scroll mode (e.g. the home screen page they
Alex Chaub794ea62021-02-03 18:00:30 +0000211 * long-pressed on to enter the overview). Try using {@link #getDestinationPage()}
Tony Wickham29d853c2015-09-08 10:35:56 -0700212 * to get the page the user is currently scrolling over.
Winson Chung321e9ee2010-08-09 13:37:56 -0700213 */
Sunny Goyal83a8f042015-05-19 12:52:12 -0700214 public int getCurrentPage() {
Winson Chung86f77532010-08-24 11:08:22 -0700215 return mCurrentPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700216 }
Adam Cohen7d30a372013-07-01 17:03:59 -0700217
Hyunyoung Songb76cd622015-04-16 14:34:09 -0700218 /**
219 * Returns the index of page to be shown immediately afterwards.
220 */
Vadim Tryshevfedca432015-08-19 17:55:02 -0700221 public int getNextPage() {
Winson Chung360e63f2012-04-27 13:48:05 -0700222 return (mNextPage != INVALID_PAGE) ? mNextPage : mCurrentPage;
223 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700224
Adam Cohenf9c184a2016-01-15 16:47:43 -0800225 public int getPageCount() {
Winson Chung321e9ee2010-08-09 13:37:56 -0700226 return getChildCount();
227 }
228
Sunny Goyal83a8f042015-05-19 12:52:12 -0700229 public View getPageAt(int index) {
Winson Chung321e9ee2010-08-09 13:37:56 -0700230 return getChildAt(index);
231 }
232
Winson Chung321e9ee2010-08-09 13:37:56 -0700233 /**
Winson Chungbbc60d82010-11-11 16:34:41 -0800234 * Updates the scroll of the current page immediately to its final scroll position. We use this
235 * in CustomizePagedView to allow tabs to share the same PagedView while resetting the scroll of
236 * the previous tab page.
237 */
238 protected void updateCurrentPageScroll() {
Adam Cohen0ffac432013-07-10 11:19:26 -0700239 // If the current page is invalid, just reset the scroll position to zero
Vinit Nayaka406f722019-12-19 11:50:55 -0800240 int newPosition = 0;
Adam Cohen0ffac432013-07-10 11:19:26 -0700241 if (0 <= mCurrentPage && mCurrentPage < getPageCount()) {
Alex Chauba61b982021-06-15 16:29:19 +0100242 newPosition = getScrollForPage(mCurrentPage) + mCurrentPageScrollDiff;
Adam Cohen0ffac432013-07-10 11:19:26 -0700243 }
Alex Chau6499e832021-11-19 14:35:46 +0000244 mOrientationHandler.setPrimary(this, VIEW_SCROLL_TO, newPosition);
Sunny Goyalc39db732021-04-03 01:20:21 -0700245 mScroller.startScroll(mScroller.getCurrX(), 0, newPosition - mScroller.getCurrX(), 0);
Tony Wickhamd5521322021-09-14 14:26:50 -0700246 forceFinishScroller();
Winson Chungbbc60d82010-11-11 16:34:41 -0800247 }
248
Tony Wickhamf8d731a2021-05-26 14:58:13 -0700249 /**
250 * Immediately finishes any overscroll effect and jumps to the end of the scroller animation.
251 */
252 public void abortScrollerAnimation() {
253 mEdgeGlowLeft.finish();
254 mEdgeGlowRight.finish();
255 abortScrollerAnimation(true);
256 }
257
Schneider Victor-tuliasa602a0a2022-09-06 13:34:00 -0700258 protected void onScrollerAnimationAborted() {
259 // No-Op
260 }
261
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700262 private void abortScrollerAnimation(boolean resetNextPage) {
Adam Cohen4fe4c932013-10-28 16:02:34 -0700263 mScroller.abortAnimation();
Schneider Victor-tuliasa602a0a2022-09-06 13:34:00 -0700264 onScrollerAnimationAborted();
Adam Cohen4fe4c932013-10-28 16:02:34 -0700265 // We need to clean up the next page here to avoid computeScrollHelper from
266 // updating current page on the pass.
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700267 if (resetNextPage) {
268 mNextPage = INVALID_PAGE;
Sunny Goyal857b1b92018-03-05 10:49:05 -0800269 pageEndTransition();
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700270 }
Chet Haasebc2f0822012-10-26 17:59:53 -0700271 }
Adam Cohen4fe4c932013-10-28 16:02:34 -0700272
Tony Wickhamd5521322021-09-14 14:26:50 -0700273 /**
274 * Immediately finishes any in-progress scroll, maintaining the current position. Also sets
275 * mNextPage = INVALID_PAGE and calls pageEndTransition().
276 */
277 public void forceFinishScroller() {
Adam Cohen4fe4c932013-10-28 16:02:34 -0700278 mScroller.forceFinished(true);
279 // We need to clean up the next page here to avoid computeScrollHelper from
280 // updating current page on the pass.
Tony Wickhamd5521322021-09-14 14:26:50 -0700281 mNextPage = INVALID_PAGE;
282 pageEndTransition();
Adam Cohen4fe4c932013-10-28 16:02:34 -0700283 }
284
Adam Cohen6f127a62014-06-12 14:54:41 -0700285 private int validateNewPage(int newPage) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700286 newPage = ensureWithinScrollBounds(newPage);
Adam Cohen6f127a62014-06-12 14:54:41 -0700287 // Ensure that it is clamped by the actual set of children in all cases
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100288 newPage = Utilities.boundToRange(newPage, 0, getPageCount() - 1);
289
290 if (getPanelCount() > 1) {
Alex Chau1e448462021-08-13 21:48:35 +0100291 // Always return left most panel as new page
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100292 newPage = getLeftmostVisiblePageForIndex(newPage);
293 }
294 return newPage;
295 }
296
Andras Kloczl55edfe52021-05-14 12:21:30 +0200297 /**
298 * In most cases where panelCount is 1, this method will just return the page index that was
299 * passed in.
300 * But for example when two panel home is enabled we might need the leftmost visible page index
301 * because that page is the current page.
302 */
303 public int getLeftmostVisiblePageForIndex(int pageIndex) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100304 int panelCount = getPanelCount();
Andras Kloczl55edfe52021-05-14 12:21:30 +0200305 return pageIndex - pageIndex % panelCount;
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100306 }
307
308 /**
309 * Returns the number of pages that are shown at the same time.
310 */
311 protected int getPanelCount() {
312 return 1;
313 }
314
315 /**
Andras Kloczl55edfe52021-05-14 12:21:30 +0200316 * Returns an IntSet with the indices of the currently visible pages
317 */
Andras Kloczl55edfe52021-05-14 12:21:30 +0200318 public IntSet getVisiblePageIndices() {
Andras Kloczl7e912442021-05-06 12:50:28 +0200319 return getPageIndices(mCurrentPage);
320 }
321
322 /**
323 * In case the panelCount is 1 this just returns the same page index in an IntSet.
324 * But in cases where the panelCount > 1 this will return all the page indices that belong
325 * together, i.e. on the Workspace they are next to each other and shown at the same time.
326 */
327 private IntSet getPageIndices(int pageIndex) {
328 // we want to make sure the pageIndex is the leftmost page
329 pageIndex = getLeftmostVisiblePageForIndex(pageIndex);
330
331 IntSet pageIndices = new IntSet();
Andras Kloczl55edfe52021-05-14 12:21:30 +0200332 int panelCount = getPanelCount();
333 int pageCount = getPageCount();
Andras Kloczl7e912442021-05-06 12:50:28 +0200334 for (int page = pageIndex; page < pageIndex + panelCount && page < pageCount; page++) {
335 pageIndices.add(page);
Andras Kloczl55edfe52021-05-14 12:21:30 +0200336 }
Andras Kloczl7e912442021-05-06 12:50:28 +0200337 return pageIndices;
338 }
339
340 /**
341 * Returns an IntSet with the indices of the neighbour pages that are in the focus direction.
342 */
343 private IntSet getNeighbourPageIndices(int focus) {
344 int panelCount = getPanelCount();
345 // getNextPage is more reliable than getCurrentPage
346 int currentPage = getNextPage();
347
348 int nextPage;
349 if (focus == View.FOCUS_LEFT) {
350 nextPage = currentPage - panelCount;
351 } else if (focus == View.FOCUS_RIGHT) {
352 nextPage = currentPage + panelCount;
353 } else {
Andras Kloczlb0632942021-08-03 14:03:58 +0200354 // no neighbours to other directions
Andras Kloczl7e912442021-05-06 12:50:28 +0200355 return new IntSet();
356 }
357 nextPage = validateNewPage(nextPage);
358 if (nextPage == currentPage) {
359 // We reached the end of the pages
360 return new IntSet();
361 }
362
Andras Kloczlb0632942021-08-03 14:03:58 +0200363 return getPageIndices(nextPage);
Andras Kloczl55edfe52021-05-14 12:21:30 +0200364 }
365
366 /**
Sunny Goyal59969372021-05-06 12:11:44 -0700367 * Executes the callback against each visible page
Andras Kloczl2bb51342021-03-20 01:13:45 +0100368 */
Sunny Goyal59969372021-05-06 12:11:44 -0700369 public void forEachVisiblePage(Consumer<View> callback) {
Andras Kloczl55edfe52021-05-14 12:21:30 +0200370 getVisiblePageIndices().forEach(pageIndex -> {
371 View page = getPageAt(pageIndex);
Andras Kloczl2bb51342021-03-20 01:13:45 +0100372 if (page != null) {
Sunny Goyal59969372021-05-06 12:11:44 -0700373 callback.accept(page);
Andras Kloczl2bb51342021-03-20 01:13:45 +0100374 }
Andras Kloczl55edfe52021-05-14 12:21:30 +0200375 });
Andras Kloczl2bb51342021-03-20 01:13:45 +0100376 }
377
378 /**
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100379 * Returns true if the view is on one of the current pages, false otherwise.
380 */
381 public boolean isVisible(View child) {
Andras Kloczl7e912442021-05-06 12:50:28 +0200382 return isVisible(indexOfChild(child));
383 }
384
385 /**
386 * Returns true if the page with the given index is currently visible, false otherwise.
387 */
388 private boolean isVisible(int pageIndex) {
389 return getLeftmostVisiblePageForIndex(pageIndex) == mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700390 }
391
Chet Haasebc2f0822012-10-26 17:59:53 -0700392 /**
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700393 * @return The closest page to the provided page that is within mMinScrollX and mMaxScrollX.
394 */
395 private int ensureWithinScrollBounds(int page) {
396 int dir = !mIsRtl ? 1 : - 1;
397 int currScroll = getScrollForPage(page);
398 int prevScroll;
Vinit Nayaka406f722019-12-19 11:50:55 -0800399 while (currScroll < mMinScroll) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700400 page += dir;
401 prevScroll = currScroll;
402 currScroll = getScrollForPage(page);
403 if (currScroll <= prevScroll) {
404 Log.e(TAG, "validateNewPage: failed to find a page > mMinScrollX");
405 break;
406 }
407 }
Vinit Nayaka406f722019-12-19 11:50:55 -0800408 while (currScroll > mMaxScroll) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700409 page -= dir;
410 prevScroll = currScroll;
411 currScroll = getScrollForPage(page);
412 if (currScroll >= prevScroll) {
413 Log.e(TAG, "validateNewPage: failed to find a page < mMaxScrollX");
414 break;
415 }
416 }
417 return page;
418 }
419
Tony Wickham03f27012019-04-25 14:22:54 -0700420 public void setCurrentPage(int currentPage) {
421 setCurrentPage(currentPage, INVALID_PAGE);
422 }
423
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700424 /**
Winson Chung86f77532010-08-24 11:08:22 -0700425 * Sets the current page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700426 */
Tony Wickham03f27012019-04-25 14:22:54 -0700427 public void setCurrentPage(int currentPage, int overridePrevPage) {
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800428 if (!mScroller.isFinished()) {
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700429 abortScrollerAnimation(true);
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800430 }
Michael Jurkad3ef3062010-11-23 16:23:58 -0800431 // don't introduce any checks like mCurrentPage == currentPage here-- if we change the
432 // the default
433 if (getChildCount() == 0) {
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800434 return;
435 }
Tony Wickham03f27012019-04-25 14:22:54 -0700436 int prevPage = overridePrevPage != INVALID_PAGE ? overridePrevPage : mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700437 mCurrentPage = validateNewPage(currentPage);
Lais Andradecc5c8842021-06-04 18:20:30 +0100438 mCurrentScrollOverPage = mCurrentPage;
Winson Chung181c3dc2013-07-17 15:36:20 -0700439 updateCurrentPageScroll();
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700440 notifyPageSwitchListener(prevPage);
Winson Chunga12a2502010-12-20 14:41:35 -0800441 invalidate();
Winson Chung321e9ee2010-08-09 13:37:56 -0700442 }
443
Winson Chung8c87cd82013-07-23 16:20:10 -0700444 /**
Adam Cohen674531f2013-12-13 15:07:14 -0800445 * Should be called whenever the page changes. In the case of a scroll, we wait until the page
446 * has settled.
447 */
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700448 protected void notifyPageSwitchListener(int prevPage) {
Adam Cohen674531f2013-12-13 15:07:14 -0800449 updatePageIndicator();
450 }
451
452 private void updatePageIndicator() {
Sunny Goyal4cbf0462014-08-28 16:19:39 -0700453 if (mPageIndicator != null) {
Tony Mak4f521af2018-03-15 16:37:34 +0000454 mPageIndicator.setActiveMarker(getNextPage());
Winson Chungd2be3812013-07-16 11:11:32 -0700455 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700456 }
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700457 protected void pageBeginTransition() {
458 if (!mIsPageInTransition) {
459 mIsPageInTransition = true;
460 onPageBeginTransition();
Michael Jurkad74c9842011-07-10 12:44:21 -0700461 }
Patrick Dubroy1262e362010-10-06 15:49:50 -0700462 }
463
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700464 protected void pageEndTransition() {
Sunny Goyal05b59c02021-04-29 13:55:40 -0700465 if (mIsPageInTransition && !mIsBeingDragged && mScroller.isFinished()
Sunny Goyalb745a2a2021-04-30 13:38:22 -0700466 && (!isShown() || (mEdgeGlowLeft.isFinished() && mEdgeGlowRight.isFinished()))) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700467 mIsPageInTransition = false;
468 onPageEndTransition();
Michael Jurkad74c9842011-07-10 12:44:21 -0700469 }
Michael Jurka0142d492010-08-25 17:46:15 -0700470 }
471
Sunny Goyalb745a2a2021-04-30 13:38:22 -0700472 @Override
473 public void onVisibilityAggregated(boolean isVisible) {
474 pageEndTransition();
475 super.onVisibilityAggregated(isVisible);
476 }
477
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700478 protected boolean isPageInTransition() {
479 return mIsPageInTransition;
Adam Cohen26976d92011-03-22 15:33:33 -0700480 }
481
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700482 /**
483 * Called when the page starts moving as part of the scroll. Subclasses can override this
484 * to provide custom behavior during animation.
485 */
486 protected void onPageBeginTransition() {
Patrick Dubroy1262e362010-10-06 15:49:50 -0700487 }
488
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700489 /**
490 * Called when the page ends moving as part of the scroll. Subclasses can override this
491 * to provide custom behavior during animation.
492 */
493 protected void onPageEndTransition() {
Alex Chauba61b982021-06-15 16:29:19 +0100494 mCurrentPageScrollDiff = 0;
vadimt4d93df52019-07-10 17:32:58 -0700495 AccessibilityManagerCompat.sendScrollFinishedEventToTest(getContext());
Tony Wickham619daaf2020-02-07 12:29:06 -0800496 AccessibilityManagerCompat.sendCustomAccessibilityEvent(getPageAt(mCurrentPage),
497 AccessibilityEvent.TYPE_VIEW_FOCUSED, null);
Tony Wickham62117d72020-03-26 16:56:26 -0700498 if (mOnPageTransitionEndCallback != null) {
499 mOnPageTransitionEndCallback.run();
500 mOnPageTransitionEndCallback = null;
501 }
502 }
503
504 /**
505 * Sets a callback to run once when the scrolling finishes. If there is currently
506 * no page in transition, then the callback is called immediately.
507 */
508 public void setOnPageTransitionEndCallback(@Nullable Runnable callback) {
509 if (mIsPageInTransition || callback == null) {
510 mOnPageTransitionEndCallback = callback;
511 } else {
512 callback.run();
513 }
Michael Jurka0142d492010-08-25 17:46:15 -0700514 }
515
Adam Cohen68d73932010-11-15 10:50:58 -0800516 @Override
Michael Jurka0142d492010-08-25 17:46:15 -0700517 public void scrollTo(int x, int y) {
Sunny Goyalc39db732021-04-03 01:20:21 -0700518 x = Utilities.boundToRange(x,
519 mOrientationHandler.getPrimaryValue(mMinScroll, 0), mMaxScroll);
520 y = Utilities.boundToRange(y,
521 mOrientationHandler.getPrimaryValue(0, mMinScroll), mMaxScroll);
Vinit Nayaka406f722019-12-19 11:50:55 -0800522 super.scrollTo(x, y);
Michael Jurka0142d492010-08-25 17:46:15 -0700523 }
524
Adam Cohen53805212013-10-01 10:39:23 -0700525 private void sendScrollAccessibilityEvent() {
Sunny Goyald0030b02017-12-08 15:07:24 -0800526 if (isObservedEventType(getContext(), AccessibilityEvent.TYPE_VIEW_SCROLLED)) {
Vadim Tryshevf4715972015-05-08 17:21:03 -0700527 if (mCurrentPage != getNextPage()) {
528 AccessibilityEvent ev =
529 AccessibilityEvent.obtain(AccessibilityEvent.TYPE_VIEW_SCROLLED);
Vadim Tryshev7066c122015-05-21 14:06:35 -0700530 ev.setScrollable(true);
531 ev.setScrollX(getScrollX());
532 ev.setScrollY(getScrollY());
Vinit Nayaka406f722019-12-19 11:50:55 -0800533 mOrientationHandler.setMaxScroll(ev, mMaxScroll);
Vadim Tryshevf4715972015-05-08 17:21:03 -0700534 sendAccessibilityEventUnchecked(ev);
Adam Cohen53805212013-10-01 10:39:23 -0700535 }
Adam Cohen53805212013-10-01 10:39:23 -0700536 }
537 }
538
Vadim Tryshev2c430b32018-04-04 14:45:21 -0700539 protected void announcePageForAccessibility() {
540 if (isAccessibilityEnabled(getContext())) {
541 // Notify the user when the page changes
542 announceForAccessibility(getCurrentPageDescription());
543 }
544 }
545
Winson Chung85425412021-05-10 16:24:14 -0700546 protected boolean computeScrollHelper() {
Winson Chung321e9ee2010-08-09 13:37:56 -0700547 if (mScroller.computeScrollOffset()) {
Winson Chung557d6ed2011-07-08 15:34:52 -0700548 // Don't bother scrolling if the page does not need to be moved
Sunny Goyalc39db732021-04-03 01:20:21 -0700549 int oldPos = mOrientationHandler.getPrimaryScroll(this);
550 int newPos = mScroller.getCurrX();
551 if (oldPos != newPos) {
Alex Chau6499e832021-11-19 14:35:46 +0000552 mOrientationHandler.setPrimary(this, VIEW_SCROLL_TO, mScroller.getCurrX());
Winson Chung557d6ed2011-07-08 15:34:52 -0700553 }
Winson Chung85425412021-05-10 16:24:14 -0700554
555 if (mAllowOverScroll) {
556 if (newPos < mMinScroll && oldPos >= mMinScroll) {
557 mEdgeGlowLeft.onAbsorb((int) mScroller.getCurrVelocity());
Schneider Victor-tuliasa602a0a2022-09-06 13:34:00 -0700558 abortScrollerAnimation(false);
Lais Andradecc5c8842021-06-04 18:20:30 +0100559 onEdgeAbsorbingScroll();
Winson Chung85425412021-05-10 16:24:14 -0700560 } else if (newPos > mMaxScroll && oldPos <= mMaxScroll) {
561 mEdgeGlowRight.onAbsorb((int) mScroller.getCurrVelocity());
Schneider Victor-tuliasa602a0a2022-09-06 13:34:00 -0700562 abortScrollerAnimation(false);
Lais Andradecc5c8842021-06-04 18:20:30 +0100563 onEdgeAbsorbingScroll();
Sunny Goyalc39db732021-04-03 01:20:21 -0700564 }
Tony Wickham95cdb3a2016-02-18 14:37:07 -0800565 }
Adam Cohen53805212013-10-01 10:39:23 -0700566
Winson Chung85425412021-05-10 16:24:14 -0700567 // If the scroller has scrolled to the final position and there is no edge effect, then
568 // finish the scroller to skip waiting for additional settling
569 int finalPos = mOrientationHandler.getPrimaryValue(mScroller.getFinalX(),
570 mScroller.getFinalY());
571 if (newPos == finalPos && mEdgeGlowLeft.isFinished() && mEdgeGlowRight.isFinished()) {
Schneider Victor-tuliasa602a0a2022-09-06 13:34:00 -0700572 abortScrollerAnimation(false);
Winson Chung85425412021-05-10 16:24:14 -0700573 }
574
575 invalidate();
576 return true;
577 } else if (mNextPage != INVALID_PAGE) {
578 sendScrollAccessibilityEvent();
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700579 int prevPage = mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700580 mCurrentPage = validateNewPage(mNextPage);
Lais Andradecc5c8842021-06-04 18:20:30 +0100581 mCurrentScrollOverPage = mCurrentPage;
Winson Chung86f77532010-08-24 11:08:22 -0700582 mNextPage = INVALID_PAGE;
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700583 notifyPageSwitchListener(prevPage);
Winson Chungb44b5242011-06-13 11:32:14 -0700584
Adam Cohen73aa9752010-11-24 16:26:58 -0800585 // We don't want to trigger a page end moving unless the page has settled
586 // and the user has stopped scrolling
Sunny Goyalaad33592018-08-07 17:20:35 -0700587 if (!mIsBeingDragged) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700588 pageEndTransition();
Adam Cohen73aa9752010-11-24 16:26:58 -0800589 }
Winson Chungc27d1bb2011-09-29 12:07:42 -0700590
Vadim Tryshev2c430b32018-04-04 14:45:21 -0700591 if (canAnnouncePageDescription()) {
592 announcePageForAccessibility();
Adam Cohen0ffac432013-07-10 11:19:26 -0700593 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700594 }
Michael Jurka0142d492010-08-25 17:46:15 -0700595 return false;
596 }
597
598 @Override
599 public void computeScroll() {
600 computeScrollHelper();
Winson Chung321e9ee2010-08-09 13:37:56 -0700601 }
602
Sunny Goyalce8809a2018-01-18 14:02:47 -0800603 public int getExpectedHeight() {
604 return getMeasuredHeight();
605 }
606
Adam Cohen410f3cd2013-09-22 12:09:32 -0700607 public int getNormalChildHeight() {
Sunny Goyalce8809a2018-01-18 14:02:47 -0800608 return getExpectedHeight() - getPaddingTop() - getPaddingBottom()
Sunny Goyalac00cba2017-11-13 15:58:01 -0800609 - mInsets.top - mInsets.bottom;
Adam Cohen410f3cd2013-09-22 12:09:32 -0700610 }
611
Sunny Goyalce8809a2018-01-18 14:02:47 -0800612 public int getExpectedWidth() {
613 return getMeasuredWidth();
614 }
615
Sunny Goyalbc683e92017-12-06 10:25:07 -0800616 public int getNormalChildWidth() {
Sunny Goyalce8809a2018-01-18 14:02:47 -0800617 return getExpectedWidth() - getPaddingLeft() - getPaddingRight()
Sunny Goyalbc683e92017-12-06 10:25:07 -0800618 - mInsets.left - mInsets.right;
619 }
620
Andras Kloczlc2bd15f2022-03-30 18:06:13 +0100621 private void updateVelocityValues() {
622 Resources res = getResources();
623 mFlingThresholdVelocity = res.getDimensionPixelSize(R.dimen.fling_threshold_velocity);
624 mEasyFlingThresholdVelocity =
625 res.getDimensionPixelSize(R.dimen.easy_fling_threshold_velocity);
626 mMinFlingVelocity = res.getDimensionPixelSize(R.dimen.min_fling_velocity);
627 mMinSnapVelocity = res.getDimensionPixelSize(R.dimen.min_page_snap_velocity);
628 mPageSnapAnimationDuration = res.getInteger(R.integer.config_pageSnapAnimationDuration);
629 }
630
631 @Override
632 protected void onConfigurationChanged(Configuration newConfig) {
633 super.onConfigurationChanged(newConfig);
634 updateVelocityValues();
635 }
636
Winson Chung321e9ee2010-08-09 13:37:56 -0700637 @Override
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800638 public void requestLayout() {
639 mIsLayoutValid = false;
640 super.requestLayout();
641 }
642
643 @Override
644 public void forceLayout() {
645 mIsLayoutValid = false;
646 super.forceLayout();
647 }
648
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100649 private int getPageWidthSize(int widthSize) {
Thales Lima7a6752d2021-09-23 14:31:00 +0100650 // It's necessary to add the padding back because it is remove when measuring children,
651 // like when MeasureSpec.getSize in CellLayout.
652 return (widthSize - mInsets.left - mInsets.right - getPaddingLeft() - getPaddingRight())
653 / getPanelCount() + getPaddingLeft() + getPaddingRight();
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100654 }
655
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800656 @Override
Winson Chung321e9ee2010-08-09 13:37:56 -0700657 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
Sunny Goyal8e2133b2015-05-06 13:39:07 -0700658 if (getChildCount() == 0) {
Winson Chungf0ea4d32011-06-06 14:27:16 -0700659 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
660 return;
661 }
662
Adam Cohen7d30a372013-07-01 17:03:59 -0700663 // We measure the dimensions of the PagedView to be larger than the pages so that when we
664 // zoom out (and scale down), the view is still contained in the parent
Adam Cohen7d30a372013-07-01 17:03:59 -0700665 int widthMode = MeasureSpec.getMode(widthMeasureSpec);
666 int widthSize = MeasureSpec.getSize(widthMeasureSpec);
667 int heightMode = MeasureSpec.getMode(heightMeasureSpec);
Winson Chung8aad6102012-05-11 16:27:49 -0700668 int heightSize = MeasureSpec.getSize(heightMeasureSpec);
Adam Cohen410f3cd2013-09-22 12:09:32 -0700669
Adam Cohen7d30a372013-07-01 17:03:59 -0700670 if (widthMode == MeasureSpec.UNSPECIFIED || heightMode == MeasureSpec.UNSPECIFIED) {
671 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
672 return;
Winson Chung321e9ee2010-08-09 13:37:56 -0700673 }
674
Winson Chung8aad6102012-05-11 16:27:49 -0700675 // Return early if we aren't given a proper dimension
676 if (widthSize <= 0 || heightSize <= 0) {
677 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
678 return;
679 }
680
Winson Chung321e9ee2010-08-09 13:37:56 -0700681 // The children are given the same width and height as the workspace
Michael Jurka5f1c5092010-09-03 14:15:02 -0700682 // unless they were set to WRAP_CONTENT
Winson Chung785d2eb2011-04-14 16:08:02 -0700683 if (DEBUG) Log.d(TAG, "PagedView.onMeasure(): " + widthSize + ", " + heightSize);
Michael Jurka5f1c5092010-09-03 14:15:02 -0700684
Sunny Goyalac00cba2017-11-13 15:58:01 -0800685 int myWidthSpec = MeasureSpec.makeMeasureSpec(
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100686 getPageWidthSize(widthSize), MeasureSpec.EXACTLY);
Sunny Goyalac00cba2017-11-13 15:58:01 -0800687 int myHeightSpec = MeasureSpec.makeMeasureSpec(
Sunny Goyal228153d2018-01-04 15:35:22 -0800688 heightSize - mInsets.top - mInsets.bottom, MeasureSpec.EXACTLY);
Adam Cohen96d30a12013-07-16 18:13:21 -0700689
Sunny Goyalac00cba2017-11-13 15:58:01 -0800690 // measureChildren takes accounts for content padding, we only need to care about extra
691 // space due to insets.
692 measureChildren(myWidthSpec, myHeightSpec);
693 setMeasuredDimension(widthSize, heightSize);
Adam Cohen60b07122011-11-14 17:26:06 -0800694 }
695
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700696 /** Returns true iff this PagedView's scroll amounts are initialized to each page index. */
Schneider Victor-tulias7bb558a2022-12-15 05:42:53 -0800697 protected boolean isPageScrollsInitialized() {
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700698 return mPageScrolls != null && mPageScrolls.length == getChildCount();
699 }
700
701 /**
702 * Queues the given callback to be run once {@code mPageScrolls} has been initialized.
703 */
704 public void runOnPageScrollsInitialized(Runnable callback) {
705 mOnPageScrollsInitializedCallbacks.add(callback);
Schneider Victor-tulias7bb558a2022-12-15 05:42:53 -0800706 if (isPageScrollsInitialized()) {
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700707 onPageScrollsInitialized();
708 }
709 }
710
Schneider Victor-tulias7bb558a2022-12-15 05:42:53 -0800711 protected void onPageScrollsInitialized() {
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700712 for (Runnable callback : mOnPageScrollsInitializedCallbacks) {
713 callback.run();
714 }
715 mOnPageScrollsInitializedCallbacks.clear();
716 }
717
Sunny Goyalcf25b522015-07-09 00:01:18 -0700718 @SuppressLint("DrawAllocation")
Winson Chung321e9ee2010-08-09 13:37:56 -0700719 @Override
Michael Jurka28750fb2010-09-24 17:43:49 -0700720 protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800721 mIsLayoutValid = true;
Vadim Trysheveb701c62018-05-14 16:00:15 -0700722 final int childCount = getChildCount();
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700723 int[] pageScrolls = mPageScrolls;
Vadim Trysheveb701c62018-05-14 16:00:15 -0700724 boolean pageScrollChanged = false;
Schneider Victor-tulias7bb558a2022-12-15 05:42:53 -0800725 if (!isPageScrollsInitialized()) {
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700726 pageScrolls = new int[childCount];
Vadim Trysheveb701c62018-05-14 16:00:15 -0700727 pageScrollChanged = true;
728 }
729
Winson Chung785d2eb2011-04-14 16:08:02 -0700730 if (DEBUG) Log.d(TAG, "PagedView.onLayout()");
Winson Chung321e9ee2010-08-09 13:37:56 -0700731
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700732 pageScrollChanged |= getPageScrolls(pageScrolls, true, SIMPLE_SCROLL_LOGIC);
733 mPageScrolls = pageScrolls;
Winson Chungc3665fa2011-09-14 17:56:27 -0700734
Winson Chung359cb5d2022-05-26 23:38:48 +0000735 if (childCount == 0) {
736 onPageScrollsInitialized();
737 return;
738 }
739
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700740 final LayoutTransition transition = getLayoutTransition();
741 // If the transition is running defer updating max scroll, as some empty pages could
742 // still be present, and a max scroll change could cause sudden jumps in scroll.
743 if (transition != null && transition.isRunning()) {
744 transition.addTransitionListener(new LayoutTransition.TransitionListener() {
745
746 @Override
747 public void startTransition(LayoutTransition transition, ViewGroup container,
748 View view, int transitionType) { }
749
750 @Override
751 public void endTransition(LayoutTransition transition, ViewGroup container,
752 View view, int transitionType) {
753 // Wait until all transitions are complete.
754 if (!transition.isRunning()) {
755 transition.removeTransitionListener(this);
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700756 updateMinAndMaxScrollX();
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700757 }
758 }
759 });
Adam Cohenf698c6e2013-07-17 18:44:25 -0700760 } else {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700761 updateMinAndMaxScrollX();
Adam Cohenf698c6e2013-07-17 18:44:25 -0700762 }
763
Sunny Goyalcb037ee2015-07-08 16:41:21 -0700764 if (mFirstLayout && mCurrentPage >= 0 && mCurrentPage < childCount) {
765 updateCurrentPageScroll();
766 mFirstLayout = false;
767 }
768
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800769 if (mScroller.isFinished() && pageScrollChanged) {
Alex Chau0733ebd2022-10-07 15:11:09 +0100770 // TODO(b/246283207): Remove logging once root cause of flake detected.
Brian Isganitisfdd044e2023-03-02 19:45:23 +0000771 if (Utilities.isRunningInTestHarness() && !(this instanceof Workspace)) {
Alex Chau0733ebd2022-10-07 15:11:09 +0100772 Log.d("b/246283207", this.getClass().getSimpleName() + "#onLayout() -> "
Pat Manning24b95542022-08-09 18:06:58 +0100773 + "if(mScroller.isFinished() && pageScrollChanged) -> getNextPage(): "
774 + getNextPage() + ", getScrollForPage(getNextPage()): "
775 + getScrollForPage(getNextPage()));
776 }
Sunny Goyalc82c6392018-06-06 15:39:13 -0700777 setCurrentPage(getNextPage());
Adam Cohenf698c6e2013-07-17 18:44:25 -0700778 }
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700779 onPageScrollsInitialized();
Winson Chunge3193b92010-09-10 11:44:42 -0700780 }
781
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700782 /**
783 * Initializes {@code outPageScrolls} with scroll positions for view at that index. The length
784 * of {@code outPageScrolls} should be same as the the childCount
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700785 */
786 protected boolean getPageScrolls(int[] outPageScrolls, boolean layoutChildren,
787 ComputePageScrollsLogic scrollLogic) {
788 final int childCount = getChildCount();
789
790 final int startIndex = mIsRtl ? childCount - 1 : 0;
791 final int endIndex = mIsRtl ? -1 : childCount;
792 final int delta = mIsRtl ? -1 : 1;
793
Vinit Nayaka406f722019-12-19 11:50:55 -0800794 final int pageCenter = mOrientationHandler.getCenterForPage(this, mInsets);
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700795
Vinit Nayaka406f722019-12-19 11:50:55 -0800796 final int scrollOffsetStart = mOrientationHandler.getScrollOffsetStart(this, mInsets);
797 final int scrollOffsetEnd = mOrientationHandler.getScrollOffsetEnd(this, mInsets);
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700798 boolean pageScrollChanged = false;
Thales Limae4457742021-07-20 16:46:38 +0100799 int panelCount = getPanelCount();
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700800
Vinit Nayaka406f722019-12-19 11:50:55 -0800801 for (int i = startIndex, childStart = scrollOffsetStart; i != endIndex; i += delta) {
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700802 final View child = getPageAt(i);
803 if (scrollLogic.shouldIncludeView(child)) {
Vinit Nayaka406f722019-12-19 11:50:55 -0800804 ChildBounds bounds = mOrientationHandler.getChildBounds(child, childStart,
805 pageCenter, layoutChildren);
806 final int primaryDimension = bounds.primaryDimension;
807 final int childPrimaryEnd = bounds.childPrimaryEnd;
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700808
Alex Chaub5c4d112021-03-29 17:37:53 +0100809 // In case the pages are of different width, align the page to left edge for non-RTL
810 // or right edge for RTL.
811 final int pageScroll =
812 mIsRtl ? childPrimaryEnd - scrollOffsetEnd : childStart - scrollOffsetStart;
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700813 if (outPageScrolls[i] != pageScroll) {
814 pageScrollChanged = true;
815 outPageScrolls[i] = pageScroll;
816 }
Alex Chau2e487602022-03-15 19:34:08 +0000817 childStart += primaryDimension + getChildGap(i, i + delta);
Thales Limae4457742021-07-20 16:46:38 +0100818
819 // This makes sure that the space is added after the page, not after each panel
Thales Limac2a6f6f2021-09-09 17:06:22 +0100820 int lastPanel = mIsRtl ? 0 : panelCount - 1;
821 if (i % panelCount == lastPanel) {
Thales Limae4457742021-07-20 16:46:38 +0100822 childStart += mPageSpacing;
823 }
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700824 }
825 }
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100826
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100827 if (panelCount > 1) {
828 for (int i = 0; i < childCount; i++) {
Alex Chau1e448462021-08-13 21:48:35 +0100829 // In case we have multiple panels, always use left most panel's page scroll for all
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100830 // panels on the screen.
831 int adjustedScroll = outPageScrolls[getLeftmostVisiblePageForIndex(i)];
832 if (outPageScrolls[i] != adjustedScroll) {
833 outPageScrolls[i] = adjustedScroll;
834 pageScrollChanged = true;
835 }
836 }
837 }
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700838 return pageScrollChanged;
839 }
840
Alex Chau2e487602022-03-15 19:34:08 +0000841 protected int getChildGap(int fromIndex, int toIndex) {
Sunny Goyala1fbd842015-05-20 13:40:27 -0700842 return 0;
843 }
844
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700845 protected void updateMinAndMaxScrollX() {
Vinit Nayaka406f722019-12-19 11:50:55 -0800846 mMinScroll = computeMinScroll();
847 mMaxScroll = computeMaxScroll();
Tony Wickhamf549dab2016-05-16 09:54:06 -0700848 }
849
Vinit Nayaka406f722019-12-19 11:50:55 -0800850 protected int computeMinScroll() {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700851 return 0;
Tony50876bf2018-09-19 23:09:14 -0400852 }
853
Vinit Nayaka406f722019-12-19 11:50:55 -0800854 protected int computeMaxScroll() {
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700855 int childCount = getChildCount();
856 if (childCount > 0) {
Sunny Goyal70660032015-05-14 00:07:08 -0700857 final int index = mIsRtl ? 0 : childCount - 1;
Tony Wickhamf549dab2016-05-16 09:54:06 -0700858 return getScrollForPage(index);
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700859 } else {
Tony Wickhamf549dab2016-05-16 09:54:06 -0700860 return 0;
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700861 }
862 }
863
Adam Cohen3b185e22013-10-29 14:45:58 -0700864 public void setPageSpacing(int pageSpacing) {
865 mPageSpacing = pageSpacing;
866 requestLayout();
867 }
868
Tony50876bf2018-09-19 23:09:14 -0400869 public int getPageSpacing() {
870 return mPageSpacing;
871 }
872
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800873 private void dispatchPageCountChanged() {
874 if (mPageIndicator != null) {
Tony Wickhambab101c2021-09-20 15:12:44 -0700875 mPageIndicator.setMarkersCount(getChildCount() / getPanelCount());
Winson Chungd2be3812013-07-16 11:11:32 -0700876 }
Adam Cohen2591f6a2011-10-25 14:36:40 -0700877 // This ensures that when children are added, they get the correct transforms / alphas
878 // in accordance with any scroll effects.
Adam Cohen2591f6a2011-10-25 14:36:40 -0700879 invalidate();
880 }
881
Michael Jurka8b805b12012-04-18 14:23:14 -0700882 @Override
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800883 public void onViewAdded(View child) {
Winson Chungc7c51582018-02-23 17:58:36 -0800884 super.onViewAdded(child);
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800885 dispatchPageCountChanged();
886 }
887
888 @Override
889 public void onViewRemoved(View child) {
Winson Chungc7c51582018-02-23 17:58:36 -0800890 super.onViewRemoved(child);
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700891 runOnPageScrollsInitialized(() -> {
892 mCurrentPage = validateNewPage(mCurrentPage);
893 mCurrentScrollOverPage = mCurrentPage;
894 });
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800895 dispatchPageCountChanged();
Winson Chungd2be3812013-07-16 11:11:32 -0700896 }
897
Adam Cohen73894962011-10-31 13:17:17 -0700898 protected int getChildOffset(int index) {
Adam Cohen7d30a372013-07-01 17:03:59 -0700899 if (index < 0 || index > getChildCount() - 1) return 0;
Vinit Nayaka406f722019-12-19 11:50:55 -0800900 View pageAtIndex = getPageAt(index);
901 return mOrientationHandler.getChildStart(pageAtIndex);
Adam Cohen73894962011-10-31 13:17:17 -0700902 }
903
Alex Chau7944ee52021-01-08 19:07:25 +0000904 protected int getChildVisibleSize(int index) {
905 View layout = getPageAt(index);
906 return mOrientationHandler.getMeasuredSize(layout);
907 }
908
Winson Chung321e9ee2010-08-09 13:37:56 -0700909 @Override
910 public boolean requestChildRectangleOnScreen(View child, Rect rectangle, boolean immediate) {
Andras Kloczl7e912442021-05-06 12:50:28 +0200911 int page = indexOfChild(child);
912 if (!isVisible(page) || !mScroller.isFinished()) {
Vadim Trysheveeaa8ee2018-04-11 12:23:42 -0700913 if (immediate) {
914 setCurrentPage(page);
915 } else {
916 snapToPage(page);
917 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700918 return true;
919 }
920 return false;
921 }
922
923 @Override
924 protected boolean onRequestFocusInDescendants(int direction, Rect previouslyFocusedRect) {
Winson Chung86f77532010-08-24 11:08:22 -0700925 int focusablePage;
926 if (mNextPage != INVALID_PAGE) {
927 focusablePage = mNextPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700928 } else {
Winson Chung86f77532010-08-24 11:08:22 -0700929 focusablePage = mCurrentPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700930 }
Winson Chung86f77532010-08-24 11:08:22 -0700931 View v = getPageAt(focusablePage);
Winson Chung321e9ee2010-08-09 13:37:56 -0700932 if (v != null) {
Adam Cohen76fc0852011-06-17 13:26:23 -0700933 return v.requestFocus(direction, previouslyFocusedRect);
Winson Chung321e9ee2010-08-09 13:37:56 -0700934 }
935 return false;
936 }
937
938 @Override
939 public boolean dispatchUnhandledMove(View focused, int direction) {
Sunny Goyal0c4e3722015-12-01 13:21:49 -0800940 if (super.dispatchUnhandledMove(focused, direction)) {
941 return true;
942 }
943
944 if (mIsRtl) {
945 if (direction == View.FOCUS_LEFT) {
946 direction = View.FOCUS_RIGHT;
947 } else if (direction == View.FOCUS_RIGHT) {
948 direction = View.FOCUS_LEFT;
949 }
950 }
Andras Kloczl7e912442021-05-06 12:50:28 +0200951
952 int currentPage = getNextPage();
953 int closestNeighbourIndex = -1;
954 int closestNeighbourDistance = Integer.MAX_VALUE;
955 // Find the closest neighbour page
956 for (int neighbourPageIndex : getNeighbourPageIndices(direction)) {
957 int distance = Math.abs(neighbourPageIndex - currentPage);
958 if (closestNeighbourDistance > distance) {
959 closestNeighbourDistance = distance;
960 closestNeighbourIndex = neighbourPageIndex;
Winson Chung321e9ee2010-08-09 13:37:56 -0700961 }
962 }
Andras Kloczl7e912442021-05-06 12:50:28 +0200963 if (closestNeighbourIndex != -1) {
964 View page = getPageAt(closestNeighbourIndex);
965 snapToPage(closestNeighbourIndex);
966 page.requestFocus(direction);
967 return true;
968 }
969
Sunny Goyal0c4e3722015-12-01 13:21:49 -0800970 return false;
Winson Chung321e9ee2010-08-09 13:37:56 -0700971 }
972
973 @Override
974 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) {
Jon Miranda6a858172016-10-25 16:19:17 -0700975 if (getDescendantFocusability() == FOCUS_BLOCK_DESCENDANTS) {
976 return;
977 }
978
Andras Kloczl7e912442021-05-06 12:50:28 +0200979 // nextPage is more reliable when multiple control movements have been done in a short
980 // period of time
981 getPageIndices(getNextPage())
982 .addAll(getNeighbourPageIndices(direction))
983 .forEach(pageIndex ->
984 getPageAt(pageIndex).addFocusables(views, direction, focusableMode));
Winson Chung321e9ee2010-08-09 13:37:56 -0700985 }
986
987 /**
988 * If one of our descendant views decides that it could be focused now, only
Winson Chung86f77532010-08-24 11:08:22 -0700989 * pass that along if it's on the current page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700990 *
Winson Chung86f77532010-08-24 11:08:22 -0700991 * This happens when live folders requery, and if they're off page, they
992 * end up calling requestFocus, which pulls it on page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700993 */
994 @Override
995 public void focusableViewAvailable(View focused) {
Winson Chung86f77532010-08-24 11:08:22 -0700996 View current = getPageAt(mCurrentPage);
Winson Chung321e9ee2010-08-09 13:37:56 -0700997 View v = focused;
998 while (true) {
999 if (v == current) {
1000 super.focusableViewAvailable(focused);
1001 return;
1002 }
1003 if (v == this) {
1004 return;
1005 }
1006 ViewParent parent = v.getParent();
1007 if (parent instanceof View) {
1008 v = (View)v.getParent();
1009 } else {
1010 return;
1011 }
1012 }
1013 }
1014
1015 /**
1016 * {@inheritDoc}
1017 */
1018 @Override
1019 public void requestDisallowInterceptTouchEvent(boolean disallowIntercept) {
1020 if (disallowIntercept) {
1021 // We need to make sure to cancel our long press if
1022 // a scrollable widget takes over touch events
Andras Kloczl7a1ca0b2021-04-08 16:08:16 +02001023 cancelCurrentPageLongPress();
Winson Chung321e9ee2010-08-09 13:37:56 -07001024 }
1025 super.requestDisallowInterceptTouchEvent(disallowIntercept);
1026 }
1027
1028 @Override
1029 public boolean onInterceptTouchEvent(MotionEvent ev) {
1030 /*
1031 * This method JUST determines whether we want to intercept the motion.
1032 * If we return true, onTouchEvent will be called and we do the actual
1033 * scrolling there.
1034 */
1035
Winson Chung45e1d6e2010-11-09 17:19:49 -08001036 // Skip touch handling if there are no pages to swipe
Tony Wickhamb6841ac2019-07-22 12:39:59 -07001037 if (getChildCount() <= 0) return false;
Sunny Goyalc4bb3732019-06-20 11:34:14 -07001038
1039 acquireVelocityTrackerAndAddMovement(ev);
Winson Chung45e1d6e2010-11-09 17:19:49 -08001040
Winson Chung321e9ee2010-08-09 13:37:56 -07001041 /*
1042 * Shortcut the most recurring case: the user is in the dragging
1043 * state and he is moving his finger. We want to intercept this
1044 * motion.
1045 */
1046 final int action = ev.getAction();
Sunny Goyalaad33592018-08-07 17:20:35 -07001047 if ((action == MotionEvent.ACTION_MOVE) && mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001048 return true;
1049 }
1050
Winson Chung321e9ee2010-08-09 13:37:56 -07001051 switch (action & MotionEvent.ACTION_MASK) {
1052 case MotionEvent.ACTION_MOVE: {
1053 /*
1054 * mIsBeingDragged == false, otherwise the shortcut would have caught it. Check
Vinit Nayaka406f722019-12-19 11:50:55 -08001055 * whether the user has moved far enough from their original down touch.
Winson Chung321e9ee2010-08-09 13:37:56 -07001056 */
Michael Jurka1ff706b2010-09-14 17:35:20 -07001057 if (mActivePointerId != INVALID_POINTER) {
1058 determineScrollingStart(ev);
Michael Jurka1ff706b2010-09-14 17:35:20 -07001059 }
1060 // if mActivePointerId is INVALID_POINTER, then we must have missed an ACTION_DOWN
Vinit Nayaka406f722019-12-19 11:50:55 -08001061 // event. in that case, treat the first occurrence of a move event as a ACTION_DOWN
Michael Jurka1ff706b2010-09-14 17:35:20 -07001062 // i.e. fall through to the next case (don't break)
1063 // (We sometimes miss ACTION_DOWN events in Workspace because it ignores all events
1064 // while it's small- this was causing a crash before we checked for INVALID_POINTER)
Adam Cohen93c97562013-09-26 13:48:01 -07001065 break;
Winson Chung321e9ee2010-08-09 13:37:56 -07001066 }
1067
1068 case MotionEvent.ACTION_DOWN: {
1069 final float x = ev.getX();
1070 final float y = ev.getY();
1071 // Remember location of down touch
1072 mDownMotionX = x;
Adam Cohen7d30a372013-07-01 17:03:59 -07001073 mDownMotionY = y;
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001074 mDownMotionPrimary = mOrientationHandler.getPrimaryDirection(ev, 0);
1075 mLastMotion = (int) mDownMotionPrimary;
Vinit Nayaka406f722019-12-19 11:50:55 -08001076 mTotalMotion = 0;
Winson Chung4941f652020-06-18 15:11:53 -07001077 mAllowEasyFling = false;
Winson Chung321e9ee2010-08-09 13:37:56 -07001078 mActivePointerId = ev.getPointerId(0);
Sunny Goyalc39db732021-04-03 01:20:21 -07001079 updateIsBeingDraggedOnTouchDown(ev);
Winson Chung321e9ee2010-08-09 13:37:56 -07001080 break;
1081 }
1082
Winson Chung321e9ee2010-08-09 13:37:56 -07001083 case MotionEvent.ACTION_UP:
Jeff Brown1d0867c2010-12-02 18:27:39 -08001084 case MotionEvent.ACTION_CANCEL:
Adam Cohen7d30a372013-07-01 17:03:59 -07001085 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001086 break;
1087
1088 case MotionEvent.ACTION_POINTER_UP:
1089 onSecondaryPointerUp(ev);
Adam Cohen6342bba2011-03-10 11:33:35 -08001090 releaseVelocityTracker();
Winson Chung321e9ee2010-08-09 13:37:56 -07001091 break;
1092 }
1093
1094 /*
1095 * The only time we want to intercept motion events is if we are in the
1096 * drag mode.
1097 */
Sunny Goyalaad33592018-08-07 17:20:35 -07001098 return mIsBeingDragged;
Winson Chung321e9ee2010-08-09 13:37:56 -07001099 }
1100
Tony Wickhama0aee212019-09-18 09:24:03 -07001101 /**
1102 * If being flinged and user touches the screen, initiate drag; otherwise don't.
1103 */
Sunny Goyalbb030562021-07-19 16:28:39 -07001104 protected void updateIsBeingDraggedOnTouchDown(MotionEvent ev) {
Tony Wickhama0aee212019-09-18 09:24:03 -07001105 // mScroller.isFinished should be false when being flinged.
Sunny Goyalc39db732021-04-03 01:20:21 -07001106 final int xDist = Math.abs(mScroller.getFinalX() - mScroller.getCurrX());
Winson Chung4941f652020-06-18 15:11:53 -07001107 final boolean finishedScrolling = (mScroller.isFinished() || xDist < mPageSlop / 3);
Tony Wickhama0aee212019-09-18 09:24:03 -07001108
1109 if (finishedScrolling) {
1110 mIsBeingDragged = false;
1111 if (!mScroller.isFinished() && !mFreeScroll) {
1112 setCurrentPage(getNextPage());
1113 pageEndTransition();
1114 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001115 mIsBeingDragged = !mEdgeGlowLeft.isFinished() || !mEdgeGlowRight.isFinished();
Tony Wickhama0aee212019-09-18 09:24:03 -07001116 } else {
1117 mIsBeingDragged = true;
1118 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001119
1120 // Catch the edge effect if it is active.
1121 float displacement = mOrientationHandler.getSecondaryValue(ev.getX(), ev.getY())
1122 / mOrientationHandler.getSecondaryValue(getWidth(), getHeight());
1123 if (!mEdgeGlowLeft.isFinished()) {
1124 mEdgeGlowLeft.onPullDistance(0f, 1f - displacement);
1125 }
1126 if (!mEdgeGlowRight.isFinished()) {
1127 mEdgeGlowRight.onPullDistance(0f, displacement);
1128 }
Tony Wickhama0aee212019-09-18 09:24:03 -07001129 }
1130
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001131 public boolean isHandlingTouch() {
Sunny Goyalaad33592018-08-07 17:20:35 -07001132 return mIsBeingDragged;
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001133 }
1134
Adam Cohenf8d28232011-02-01 21:47:00 -08001135 protected void determineScrollingStart(MotionEvent ev) {
1136 determineScrollingStart(ev, 1.0f);
1137 }
1138
Winson Chung321e9ee2010-08-09 13:37:56 -07001139 /*
1140 * Determines if we should change the touch state to start scrolling after the
1141 * user moves their touch point too far.
1142 */
Adam Cohenf8d28232011-02-01 21:47:00 -08001143 protected void determineScrollingStart(MotionEvent ev, float touchSlopScale) {
Adam Cohen7d30a372013-07-01 17:03:59 -07001144 // Disallow scrolling if we don't have a valid pointer index
Winson Chung321e9ee2010-08-09 13:37:56 -07001145 final int pointerIndex = ev.findPointerIndex(mActivePointerId);
Adam Cohen7d30a372013-07-01 17:03:59 -07001146 if (pointerIndex == -1) return;
1147
Vinit Nayaka406f722019-12-19 11:50:55 -08001148 final float primaryDirection = mOrientationHandler.getPrimaryDirection(ev, pointerIndex);
1149 final int diff = (int) Math.abs(primaryDirection - mLastMotion);
Adam Cohenf8d28232011-02-01 21:47:00 -08001150 final int touchSlop = Math.round(touchSlopScale * mTouchSlop);
Winson Chung4941f652020-06-18 15:11:53 -07001151 boolean moved = diff > touchSlop || ev.getAction() == ACTION_MOVE_ALLOW_EASY_FLING;
Winson Chung321e9ee2010-08-09 13:37:56 -07001152
Vinit Nayaka406f722019-12-19 11:50:55 -08001153 if (moved) {
Sunny Goyal5a1f53b2015-05-27 10:24:24 -07001154 // Scroll if the user moved far enough along the X axis
Sunny Goyalaad33592018-08-07 17:20:35 -07001155 mIsBeingDragged = true;
Vinit Nayaka406f722019-12-19 11:50:55 -08001156 mTotalMotion += Math.abs(mLastMotion - primaryDirection);
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001157 mLastMotion = (int) primaryDirection;
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001158 pageBeginTransition();
Tony Wickhamdadb3042016-02-24 11:07:00 -08001159 // Stop listening for things like pinches.
1160 requestDisallowInterceptTouchEvent(true);
Adam Cohenf8d28232011-02-01 21:47:00 -08001161 }
1162 }
1163
1164 protected void cancelCurrentPageLongPress() {
Sunny Goyal8e2133b2015-05-06 13:39:07 -07001165 // Try canceling the long press. It could also have been scheduled
1166 // by a distant descendant, so use the mAllowLongPress flag to block
1167 // everything
Sunny Goyal59969372021-05-06 12:11:44 -07001168 forEachVisiblePage(View::cancelLongPress);
Winson Chung321e9ee2010-08-09 13:37:56 -07001169 }
1170
Adam Cohenb5ba0972011-09-07 18:02:31 -07001171 protected float getScrollProgress(int screenCenter, View v, int page) {
Sunny Goyal228153d2018-01-04 15:35:22 -08001172 final int halfScreenSize = getMeasuredWidth() / 2;
Adam Cohenedb40762013-07-18 16:45:45 -07001173 int delta = screenCenter - (getScrollForPage(page) + halfScreenSize);
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001174 int panelCount = getPanelCount();
1175 int pageCount = getChildCount();
Adam Cohen3b185e22013-10-29 14:45:58 -07001176
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001177 int adjacentPage = page + panelCount;
Sunny Goyal70660032015-05-14 00:07:08 -07001178 if ((delta < 0 && !mIsRtl) || (delta > 0 && mIsRtl)) {
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001179 adjacentPage = page - panelCount;
Adam Cohen3b185e22013-10-29 14:45:58 -07001180 }
1181
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001182 final int totalDistance;
1183 if (adjacentPage < 0 || adjacentPage > pageCount - 1) {
1184 totalDistance = (v.getMeasuredWidth() + mPageSpacing) * panelCount;
Adam Cohen3b185e22013-10-29 14:45:58 -07001185 } else {
1186 totalDistance = Math.abs(getScrollForPage(adjacentPage) - getScrollForPage(page));
1187 }
Adam Cohenb5ba0972011-09-07 18:02:31 -07001188
1189 float scrollProgress = delta / (totalDistance * 1.0f);
Sunny Goyal8e2133b2015-05-06 13:39:07 -07001190 scrollProgress = Math.min(scrollProgress, MAX_SCROLL_PROGRESS);
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001191 scrollProgress = Math.max(scrollProgress, -MAX_SCROLL_PROGRESS);
Adam Cohenb5ba0972011-09-07 18:02:31 -07001192 return scrollProgress;
1193 }
1194
Adam Cohenedb40762013-07-18 16:45:45 -07001195 public int getScrollForPage(int index) {
Schneider Victor-tulias7bb558a2022-12-15 05:42:53 -08001196 if (!isPageScrollsInitialized() || index >= mPageScrolls.length || index < 0) {
Adam Cohenedb40762013-07-18 16:45:45 -07001197 return 0;
1198 } else {
1199 return mPageScrolls[index];
1200 }
1201 }
1202
Adam Cohen564a2e72013-10-09 14:47:32 -07001203 // While layout transitions are occurring, a child's position may stray from its baseline
1204 // position. This method returns the magnitude of this stray at any given time.
1205 public int getLayoutTransitionOffsetForPage(int index) {
Schneider Victor-tulias7bb558a2022-12-15 05:42:53 -08001206 if (!isPageScrollsInitialized() || index >= mPageScrolls.length || index < 0) {
Adam Cohen564a2e72013-10-09 14:47:32 -07001207 return 0;
1208 } else {
1209 View child = getChildAt(index);
Adam Cohen3b185e22013-10-29 14:45:58 -07001210
Sunny Goyal228153d2018-01-04 15:35:22 -08001211 int scrollOffset = mIsRtl ? getPaddingRight() : getPaddingLeft();
1212 int baselineX = mPageScrolls[index] + scrollOffset;
Adam Cohen564a2e72013-10-09 14:47:32 -07001213 return (int) (child.getX() - baselineX);
1214 }
1215 }
1216
Tony Wickham023f4042019-01-29 10:52:31 -08001217 public void setEnableFreeScroll(boolean freeScroll) {
Winson Chung0e449002019-04-26 11:09:58 -07001218 if (mFreeScroll == freeScroll) {
1219 return;
1220 }
1221
Tony Wickham8f7ead32016-04-07 18:46:44 -07001222 boolean wasFreeScroll = mFreeScroll;
Adam Cohenf358a4b2013-07-23 16:47:31 -07001223 mFreeScroll = freeScroll;
1224
Adam Cohenf9618852013-11-08 06:45:03 -08001225 if (mFreeScroll) {
Sunny Goyal4d519f22017-10-24 10:32:40 -07001226 setCurrentPage(getNextPage());
Tony Wickham8f7ead32016-04-07 18:46:44 -07001227 } else if (wasFreeScroll) {
Tony Wickhamaf33f2c2019-10-04 12:55:22 -07001228 if (getScrollForPage(getNextPage()) != getScrollX()) {
1229 snapToPage(getNextPage());
1230 }
Adam Cohenf358a4b2013-07-23 16:47:31 -07001231 }
Adam Cohenf358a4b2013-07-23 16:47:31 -07001232 }
1233
Sunny Goyal2f0ec852015-03-26 13:38:27 -07001234 protected void setEnableOverscroll(boolean enable) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001235 mAllowOverScroll = enable;
1236 }
1237
Andras Kloczl07111f22022-03-30 17:25:54 +01001238 protected boolean isSignificantMove(float absoluteDelta, int pageOrientedSize) {
1239 return absoluteDelta > pageOrientedSize * SIGNIFICANT_MOVE_THRESHOLD;
Alex Chau822acf42021-06-03 11:35:05 +01001240 }
1241
Winson Chung321e9ee2010-08-09 13:37:56 -07001242 @Override
1243 public boolean onTouchEvent(MotionEvent ev) {
Winson Chung45e1d6e2010-11-09 17:19:49 -08001244 // Skip touch handling if there are no pages to swipe
Tony Wickhamb6841ac2019-07-22 12:39:59 -07001245 if (getChildCount() <= 0) return false;
Winson Chung45e1d6e2010-11-09 17:19:49 -08001246
Michael Jurkab8f06722010-10-10 15:58:46 -07001247 acquireVelocityTrackerAndAddMovement(ev);
Winson Chung321e9ee2010-08-09 13:37:56 -07001248
1249 final int action = ev.getAction();
1250
1251 switch (action & MotionEvent.ACTION_MASK) {
1252 case MotionEvent.ACTION_DOWN:
Sunny Goyalc39db732021-04-03 01:20:21 -07001253 updateIsBeingDraggedOnTouchDown(ev);
Tony Wickhama0aee212019-09-18 09:24:03 -07001254
Winson Chung321e9ee2010-08-09 13:37:56 -07001255 /*
1256 * If being flinged and user touches, stop the fling. isFinished
1257 * will be false if being flinged.
1258 */
1259 if (!mScroller.isFinished()) {
Adam Cohen8bdbaab2013-10-29 15:25:02 -07001260 abortScrollerAnimation(false);
Winson Chung321e9ee2010-08-09 13:37:56 -07001261 }
1262
1263 // Remember where the motion event started
Vinit Nayaka406f722019-12-19 11:50:55 -08001264 mDownMotionX = ev.getX();
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001265 mDownMotionY = ev.getY();
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001266 mDownMotionPrimary = mOrientationHandler.getPrimaryDirection(ev, 0);
1267 mLastMotion = (int) mDownMotionPrimary;
Vinit Nayaka406f722019-12-19 11:50:55 -08001268 mTotalMotion = 0;
Winson Chung4941f652020-06-18 15:11:53 -07001269 mAllowEasyFling = false;
Winson Chung321e9ee2010-08-09 13:37:56 -07001270 mActivePointerId = ev.getPointerId(0);
Sunny Goyalaad33592018-08-07 17:20:35 -07001271 if (mIsBeingDragged) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001272 pageBeginTransition();
Michael Jurka0142d492010-08-25 17:46:15 -07001273 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001274 break;
1275
Winson Chung4941f652020-06-18 15:11:53 -07001276 case ACTION_MOVE_ALLOW_EASY_FLING:
1277 // Start scrolling immediately
1278 determineScrollingStart(ev);
1279 mAllowEasyFling = true;
1280 break;
1281
1282 case MotionEvent.ACTION_MOVE:
1283 if (mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001284 // Scroll to follow the motion event
1285 final int pointerIndex = ev.findPointerIndex(mActivePointerId);
Adam Cohen7d30a372013-07-01 17:03:59 -07001286
1287 if (pointerIndex == -1) return true;
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001288 int oldScroll = mOrientationHandler.getPrimaryScroll(this);
1289 int dx = (int) ev.getX(pointerIndex);
1290 int dy = (int) ev.getY(pointerIndex);
Adam Cohen7d30a372013-07-01 17:03:59 -07001291
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001292 int direction = mOrientationHandler.getPrimaryValue(dx, dy);
1293 int delta = mLastMotion - direction;
Sunny Goyalc39db732021-04-03 01:20:21 -07001294
1295 int width = getWidth();
1296 int height = getHeight();
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001297 float size = mOrientationHandler.getPrimaryValue(width, height);
1298 float displacement = (width == 0 || height == 0) ? 0
1299 : (float) mOrientationHandler.getSecondaryValue(dx, dy)
1300 / mOrientationHandler.getSecondaryValue(width, height);
Vinit Nayaka406f722019-12-19 11:50:55 -08001301 mTotalMotion += Math.abs(delta);
Adam Cohenaefd4e12011-02-14 16:39:38 -08001302
Sunny Goyalc39db732021-04-03 01:20:21 -07001303 if (mAllowOverScroll) {
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001304 int consumed = 0;
Sunny Goyalc39db732021-04-03 01:20:21 -07001305 if (delta < 0 && mEdgeGlowRight.getDistance() != 0f) {
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001306 consumed = Math.round(size *
1307 mEdgeGlowRight.onPullDistance(delta / size, displacement));
Sunny Goyalc39db732021-04-03 01:20:21 -07001308 } else if (delta > 0 && mEdgeGlowLeft.getDistance() != 0f) {
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001309 consumed = Math.round(-size *
1310 mEdgeGlowLeft.onPullDistance(-delta / size, 1 - displacement));
Sunny Goyalc39db732021-04-03 01:20:21 -07001311 }
1312 delta -= consumed;
1313 }
Alex Chau822acf42021-06-03 11:35:05 +01001314 delta /= mOrientationHandler.getPrimaryScale(this);
Sunny Goyalc39db732021-04-03 01:20:21 -07001315
Winson Chungc0844aa2011-02-02 15:25:58 -08001316 // Only scroll and update mLastMotionX if we have moved some discrete amount. We
1317 // keep the remainder because we are actually testing if we've moved from the last
1318 // scrolled position (which is discrete).
Sunny Goyalc39db732021-04-03 01:20:21 -07001319 mLastMotion = direction;
Vinit Nayaka406f722019-12-19 11:50:55 -08001320
Sunny Goyalc39db732021-04-03 01:20:21 -07001321 if (delta != 0) {
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001322 mOrientationHandler.setPrimary(this, VIEW_SCROLL_BY, delta);
Sunny Goyalc39db732021-04-03 01:20:21 -07001323
1324 if (mAllowOverScroll) {
1325 final float pulledToX = oldScroll + delta;
1326
1327 if (pulledToX < mMinScroll) {
1328 mEdgeGlowLeft.onPullDistance(-delta / size, 1.f - displacement);
1329 if (!mEdgeGlowRight.isFinished()) {
1330 mEdgeGlowRight.onRelease();
1331 }
1332 } else if (pulledToX > mMaxScroll) {
1333 mEdgeGlowRight.onPullDistance(delta / size, displacement);
1334 if (!mEdgeGlowLeft.isFinished()) {
1335 mEdgeGlowLeft.onRelease();
1336 }
1337 }
1338
1339 if (!mEdgeGlowLeft.isFinished() || !mEdgeGlowRight.isFinished()) {
1340 postInvalidateOnAnimation();
1341 }
1342 }
1343
Winson Chung321e9ee2010-08-09 13:37:56 -07001344 } else {
1345 awakenScrollBars();
1346 }
Adam Cohen564976a2010-10-13 18:52:07 -07001347 } else {
Winson Chung321e9ee2010-08-09 13:37:56 -07001348 determineScrollingStart(ev);
1349 }
1350 break;
1351
1352 case MotionEvent.ACTION_UP:
Sunny Goyalaad33592018-08-07 17:20:35 -07001353 if (mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001354 final int activePointerId = mActivePointerId;
1355 final int pointerIndex = ev.findPointerIndex(activePointerId);
Vinit Nayak93bf1fe2020-05-26 17:22:13 -07001356 if (pointerIndex == -1) return true;
1357
Vinit Nayaka406f722019-12-19 11:50:55 -08001358 final float primaryDirection = mOrientationHandler.getPrimaryDirection(ev,
1359 pointerIndex);
Sunny Goyal4bb8b062019-02-19 16:37:38 -08001360 final VelocityTracker velocityTracker = mVelocityTracker;
1361 velocityTracker.computeCurrentVelocity(1000, mMaximumVelocity);
Adam Cohenaefd4e12011-02-14 16:39:38 -08001362
Vinit Nayaka406f722019-12-19 11:50:55 -08001363 int velocity = (int) mOrientationHandler.getPrimaryVelocity(velocityTracker,
Andras Kloczl07111f22022-03-30 17:25:54 +01001364 mActivePointerId);
Alex Chau822acf42021-06-03 11:35:05 +01001365 float delta = primaryDirection - mDownMotionPrimary;
Randy Pfohl583241e2023-03-02 03:26:56 +00001366
1367 View current = getPageAt(mCurrentPage);
1368 if (current == null) {
1369 Log.e(TAG, "current page was null. this should not happen.");
1370 return true;
1371 }
1372
1373 int pageOrientedSize = (int) (mOrientationHandler.getMeasuredSize(current)
Andras Kloczl07111f22022-03-30 17:25:54 +01001374 * mOrientationHandler.getPrimaryScale(this));
1375 boolean isSignificantMove = isSignificantMove(Math.abs(delta), pageOrientedSize);
Vinit Nayaka406f722019-12-19 11:50:55 -08001376
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001377 mTotalMotion += Math.abs(mLastMotion - primaryDirection);
Winson Chung4941f652020-06-18 15:11:53 -07001378 boolean passedSlop = mAllowEasyFling || mTotalMotion > mPageSlop;
1379 boolean isFling = passedSlop && shouldFlingForVelocity(velocity);
Vinit Nayaka406f722019-12-19 11:50:55 -08001380 boolean isDeltaLeft = mIsRtl ? delta > 0 : delta < 0;
1381 boolean isVelocityLeft = mIsRtl ? velocity > 0 : velocity < 0;
Winson Chung4941f652020-06-18 15:11:53 -07001382 if (DEBUG_FAILED_QUICKSWITCH && !isFling && mAllowEasyFling) {
1383 Log.d("Quickswitch", "isFling=false vel=" + velocity
1384 + " threshold=" + mEasyFlingThresholdVelocity);
1385 }
Adam Cohen00481b32011-11-18 12:03:48 -08001386
Adam Cohenf358a4b2013-07-23 16:47:31 -07001387 if (!mFreeScroll) {
1388 // In the case that the page is moved far to one direction and then is flung
1389 // in the opposite direction, we use a threshold to determine whether we should
1390 // just return to the starting page, or if we should skip one further.
1391 boolean returnToOriginalPage = false;
Vinit Nayaka406f722019-12-19 11:50:55 -08001392 if (Math.abs(delta) > pageOrientedSize * RETURN_TO_ORIGINAL_PAGE_THRESHOLD &&
1393 Math.signum(velocity) != Math.signum(delta) && isFling) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001394 returnToOriginalPage = true;
1395 }
Adam Cohenaefd4e12011-02-14 16:39:38 -08001396
Adam Cohenf358a4b2013-07-23 16:47:31 -07001397 int finalPage;
1398 // We give flings precedence over large moves, which is why we short-circuit our
1399 // test for a large move if a fling has been registered. That is, a large
1400 // move to the left and fling to the right will register as a fling to the right.
Sunny Goyalb7b01352018-08-09 12:31:20 -07001401
Vinit Nayaka406f722019-12-19 11:50:55 -08001402 if (((isSignificantMove && !isDeltaLeft && !isFling) ||
1403 (isFling && !isVelocityLeft)) && mCurrentPage > 0) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +01001404 finalPage = returnToOriginalPage
1405 ? mCurrentPage : mCurrentPage - getPanelCount();
Schneider Victor-tulias50f66512022-12-14 02:53:38 -08001406 runOnPageScrollsInitialized(
1407 () -> snapToPageWithVelocity(finalPage, velocity));
Vinit Nayaka406f722019-12-19 11:50:55 -08001408 } else if (((isSignificantMove && isDeltaLeft && !isFling) ||
1409 (isFling && isVelocityLeft)) &&
Adam Cohenf358a4b2013-07-23 16:47:31 -07001410 mCurrentPage < getChildCount() - 1) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +01001411 finalPage = returnToOriginalPage
1412 ? mCurrentPage : mCurrentPage + getPanelCount();
Schneider Victor-tulias50f66512022-12-14 02:53:38 -08001413 runOnPageScrollsInitialized(
1414 () -> snapToPageWithVelocity(finalPage, velocity));
Adam Cohenf358a4b2013-07-23 16:47:31 -07001415 } else {
Schneider Victor-tulias50f66512022-12-14 02:53:38 -08001416 runOnPageScrollsInitialized(this::snapToDestination);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001417 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001418 } else {
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001419 if (!mScroller.isFinished()) {
1420 abortScrollerAnimation(true);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001421 }
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001422
Vinit Nayaka406f722019-12-19 11:50:55 -08001423 int initialScroll = mOrientationHandler.getPrimaryScroll(this);
1424 int maxScroll = mMaxScroll;
1425 int minScroll = mMinScroll;
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001426
Vinit Nayaka406f722019-12-19 11:50:55 -08001427 if (((initialScroll >= maxScroll) && (isVelocityLeft || !isFling)) ||
1428 ((initialScroll <= minScroll) && (!isVelocityLeft || !isFling))) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001429 mScroller.springBack(initialScroll, 0, minScroll, maxScroll, 0, 0);
Alex Chaub794ea62021-02-03 18:00:30 +00001430 mNextPage = getDestinationPage();
Sunny Goyalb7b01352018-08-09 12:31:20 -07001431 } else {
Sunny Goyalc39db732021-04-03 01:20:21 -07001432 int velocity1 = -velocity;
1433 // Continue a scroll or fling in progress
1434 mScroller.fling(initialScroll, 0, velocity1, 0, minScroll, maxScroll, 0, 0,
1435 Math.round(getWidth() * 0.5f * OVERSCROLL_DAMP_FACTOR), 0);
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001436
Sunny Goyalc39db732021-04-03 01:20:21 -07001437 int finalPos = mScroller.getFinalX();
Alex Chaub794ea62021-02-03 18:00:30 +00001438 mNextPage = getDestinationPage(finalPos);
Schneider Victor-tulias50f66512022-12-14 02:53:38 -08001439 runOnPageScrollsInitialized(this::onNotSnappingToPageInFreeScroll);
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001440 }
1441 invalidate();
Winson Chung321e9ee2010-08-09 13:37:56 -07001442 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001443 }
Adam Cohen7d30a372013-07-01 17:03:59 -07001444
Sunny Goyalc39db732021-04-03 01:20:21 -07001445 mEdgeGlowLeft.onRelease();
1446 mEdgeGlowRight.onRelease();
Adam Cohen7d30a372013-07-01 17:03:59 -07001447 // End any intermediate reordering states
1448 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001449 break;
1450
1451 case MotionEvent.ACTION_CANCEL:
Sunny Goyalaad33592018-08-07 17:20:35 -07001452 if (mIsBeingDragged) {
Schneider Victor-tulias50f66512022-12-14 02:53:38 -08001453 runOnPageScrollsInitialized(this::snapToDestination);
Michael Jurkab8f06722010-10-10 15:58:46 -07001454 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001455 mEdgeGlowLeft.onRelease();
1456 mEdgeGlowRight.onRelease();
Adam Cohen7d30a372013-07-01 17:03:59 -07001457 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001458 break;
1459
1460 case MotionEvent.ACTION_POINTER_UP:
1461 onSecondaryPointerUp(ev);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001462 releaseVelocityTracker();
Winson Chung321e9ee2010-08-09 13:37:56 -07001463 break;
1464 }
1465
1466 return true;
1467 }
1468
Sunny Goyalc39db732021-04-03 01:20:21 -07001469 protected void onNotSnappingToPageInFreeScroll() { }
Alex Chaub794ea62021-02-03 18:00:30 +00001470
Lais Andradecc5c8842021-06-04 18:20:30 +01001471 /**
1472 * Called when the view edges absorb part of the scroll. Subclasses can override this
1473 * to provide custom behavior during animation.
1474 */
1475 protected void onEdgeAbsorbingScroll() {
1476 }
1477
1478 /**
1479 * Called when the current page closest to the center of the screen changes as part of the
1480 * scroll. Subclasses can override this to provide custom behavior during scroll.
1481 */
1482 protected void onScrollOverPageChanged() {
1483 }
1484
Vinit Nayaka406f722019-12-19 11:50:55 -08001485 protected boolean shouldFlingForVelocity(int velocity) {
Winson Chung4941f652020-06-18 15:11:53 -07001486 float threshold = mAllowEasyFling ? mEasyFlingThresholdVelocity : mFlingThresholdVelocity;
1487 return Math.abs(velocity) > threshold;
Sunny Goyal65d9ceb2017-05-08 09:17:42 -07001488 }
1489
Alex Chau9d8eeab2022-04-05 17:13:56 +01001490 protected void resetTouchState() {
Adam Cohen7d30a372013-07-01 17:03:59 -07001491 releaseVelocityTracker();
Sunny Goyalaad33592018-08-07 17:20:35 -07001492 mIsBeingDragged = false;
Adam Cohen7d30a372013-07-01 17:03:59 -07001493 mActivePointerId = INVALID_POINTER;
Adam Cohen7d30a372013-07-01 17:03:59 -07001494 }
1495
Winson Chung185d7162011-02-28 13:47:29 -08001496 @Override
1497 public boolean onGenericMotionEvent(MotionEvent event) {
1498 if ((event.getSource() & InputDevice.SOURCE_CLASS_POINTER) != 0) {
1499 switch (event.getAction()) {
1500 case MotionEvent.ACTION_SCROLL: {
1501 // Handle mouse (or ext. device) by shifting the page depending on the scroll
1502 final float vscroll;
1503 final float hscroll;
1504 if ((event.getMetaState() & KeyEvent.META_SHIFT_ON) != 0) {
1505 vscroll = 0;
1506 hscroll = event.getAxisValue(MotionEvent.AXIS_VSCROLL);
1507 } else {
1508 vscroll = -event.getAxisValue(MotionEvent.AXIS_VSCROLL);
1509 hscroll = event.getAxisValue(MotionEvent.AXIS_HSCROLL);
1510 }
Sunny Goyal8b37c572020-03-31 12:12:14 -07001511 if (!canScroll(Math.abs(vscroll), Math.abs(hscroll))) {
1512 return false;
Samuel Fufa59cba192019-08-22 18:31:34 -07001513 }
Winson Chung185d7162011-02-28 13:47:29 -08001514 if (hscroll != 0 || vscroll != 0) {
Sunny Goyal70660032015-05-14 00:07:08 -07001515 boolean isForwardScroll = mIsRtl ? (hscroll < 0 || vscroll < 0)
Adam Cohen0ffac432013-07-10 11:19:26 -07001516 : (hscroll > 0 || vscroll > 0);
1517 if (isForwardScroll) {
Winson Chung185d7162011-02-28 13:47:29 -08001518 scrollRight();
1519 } else {
1520 scrollLeft();
1521 }
1522 return true;
1523 }
1524 }
1525 }
1526 }
1527 return super.onGenericMotionEvent(event);
1528 }
1529
Sunny Goyal8b37c572020-03-31 12:12:14 -07001530 /**
1531 * Returns true if the paged view can scroll for the provided vertical and horizontal
1532 * scroll values
1533 */
1534 protected boolean canScroll(float absVScroll, float absHScroll) {
1535 ActivityContext ac = ActivityContext.lookupContext(getContext());
1536 return (ac == null || AbstractFloatingView.getTopOpenView(ac) == null);
Samuel Fufa59cba192019-08-22 18:31:34 -07001537 }
1538
Michael Jurkab8f06722010-10-10 15:58:46 -07001539 private void acquireVelocityTrackerAndAddMovement(MotionEvent ev) {
1540 if (mVelocityTracker == null) {
1541 mVelocityTracker = VelocityTracker.obtain();
1542 }
1543 mVelocityTracker.addMovement(ev);
1544 }
1545
1546 private void releaseVelocityTracker() {
1547 if (mVelocityTracker != null) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001548 mVelocityTracker.clear();
Michael Jurkab8f06722010-10-10 15:58:46 -07001549 mVelocityTracker.recycle();
1550 mVelocityTracker = null;
1551 }
1552 }
1553
Winson Chung321e9ee2010-08-09 13:37:56 -07001554 private void onSecondaryPointerUp(MotionEvent ev) {
Winson Chung4941f652020-06-18 15:11:53 -07001555 final int pointerIndex = ev.getActionIndex();
Winson Chung321e9ee2010-08-09 13:37:56 -07001556 final int pointerId = ev.getPointerId(pointerIndex);
1557 if (pointerId == mActivePointerId) {
1558 // This was our active pointer going up. Choose a new
1559 // active pointer and adjust accordingly.
1560 // TODO: Make this decision more intelligent.
1561 final int newPointerIndex = pointerIndex == 0 ? 1 : 0;
Sunny Goyalb7c0f3c2023-03-15 17:21:57 -07001562 mDownMotionPrimary = mOrientationHandler.getPrimaryDirection(ev, newPointerIndex);
1563 mLastMotion = (int) mDownMotionPrimary;
Winson Chung321e9ee2010-08-09 13:37:56 -07001564 mActivePointerId = ev.getPointerId(newPointerIndex);
1565 if (mVelocityTracker != null) {
1566 mVelocityTracker.clear();
1567 }
1568 }
Jeff Brown1d0867c2010-12-02 18:27:39 -08001569 }
1570
Winson Chung321e9ee2010-08-09 13:37:56 -07001571 @Override
1572 public void requestChildFocus(View child, View focused) {
1573 super.requestChildFocus(child, focused);
Andras Kloczl359d1ae2021-05-04 22:25:27 +02001574
1575 // In case the device is controlled by a controller, mCurrentPage isn't updated properly
1576 // which results in incorrect navigation
1577 int nextPage = getNextPage();
1578 if (nextPage != mCurrentPage) {
1579 setCurrentPage(nextPage);
1580 }
1581
Andras Kloczl7e912442021-05-06 12:50:28 +02001582 int page = indexOfChild(child);
1583 if (page >= 0 && !isVisible(page) && !isInTouchMode()) {
Winson Chung86f77532010-08-24 11:08:22 -07001584 snapToPage(page);
Winson Chung321e9ee2010-08-09 13:37:56 -07001585 }
1586 }
1587
Alex Chaub794ea62021-02-03 18:00:30 +00001588 public int getDestinationPage() {
1589 return getDestinationPage(mOrientationHandler.getPrimaryScroll(this));
1590 }
1591
Alex Chaudedbc8a2021-03-17 16:53:26 +00001592 protected int getDestinationPage(int primaryScroll) {
1593 return getPageNearestToCenterOfScreen(primaryScroll);
Alex Chaub794ea62021-02-03 18:00:30 +00001594 }
1595
Sunny Goyal228153d2018-01-04 15:35:22 -08001596 public int getPageNearestToCenterOfScreen() {
Vinit Nayaka406f722019-12-19 11:50:55 -08001597 return getPageNearestToCenterOfScreen(mOrientationHandler.getPrimaryScroll(this));
Tony Wickham8f7ead32016-04-07 18:46:44 -07001598 }
1599
Alex Chaudedbc8a2021-03-17 16:53:26 +00001600 private int getPageNearestToCenterOfScreen(int primaryScroll) {
1601 int screenCenter = getScreenCenter(primaryScroll);
Adam Cohen22f823d2011-09-01 17:22:18 -07001602 int minDistanceFromScreenCenter = Integer.MAX_VALUE;
Winson Chung321e9ee2010-08-09 13:37:56 -07001603 int minDistanceFromScreenCenterIndex = -1;
Winson Chung321e9ee2010-08-09 13:37:56 -07001604 final int childCount = getChildCount();
1605 for (int i = 0; i < childCount; ++i) {
Tony Wickham7383d4e2020-07-07 19:25:25 -07001606 int distanceFromScreenCenter = Math.abs(
1607 getDisplacementFromScreenCenter(i, screenCenter));
Winson Chung321e9ee2010-08-09 13:37:56 -07001608 if (distanceFromScreenCenter < minDistanceFromScreenCenter) {
1609 minDistanceFromScreenCenter = distanceFromScreenCenter;
1610 minDistanceFromScreenCenterIndex = i;
1611 }
1612 }
Adam Cohend19d3ca2010-09-15 14:43:42 -07001613 return minDistanceFromScreenCenterIndex;
1614 }
1615
Tony Wickham7383d4e2020-07-07 19:25:25 -07001616 private int getDisplacementFromScreenCenter(int childIndex, int screenCenter) {
Cole Faust50ec4af2022-10-15 21:33:28 -07001617 int childSize = getChildVisibleSize(childIndex);
Tony Wickham7383d4e2020-07-07 19:25:25 -07001618 int halfChildSize = (childSize / 2);
1619 int childCenter = getChildOffset(childIndex) + halfChildSize;
1620 return childCenter - screenCenter;
1621 }
1622
1623 protected int getDisplacementFromScreenCenter(int childIndex) {
Alex Chaudedbc8a2021-03-17 16:53:26 +00001624 int primaryScroll = mOrientationHandler.getPrimaryScroll(this);
1625 int screenCenter = getScreenCenter(primaryScroll);
Tony Wickham7383d4e2020-07-07 19:25:25 -07001626 return getDisplacementFromScreenCenter(childIndex, screenCenter);
1627 }
1628
Andras Kloczl9732df12021-09-09 19:40:42 +01001629 protected int getScreenCenter(int primaryScroll) {
Alex Chaudedbc8a2021-03-17 16:53:26 +00001630 float primaryScale = mOrientationHandler.getPrimaryScale(this);
1631 float primaryPivot = mOrientationHandler.getPrimaryValue(getPivotX(), getPivotY());
1632 int pageOrientationSize = mOrientationHandler.getMeasuredSize(this);
1633 return Math.round(primaryScroll + (pageOrientationSize / 2f - primaryPivot) / primaryScale
1634 + primaryPivot);
1635 }
1636
Adam Cohend19d3ca2010-09-15 14:43:42 -07001637 protected void snapToDestination() {
Andras Kloczlc2bd15f2022-03-30 18:06:13 +01001638 snapToPage(getDestinationPage(), mPageSnapAnimationDuration);
Winson Chung321e9ee2010-08-09 13:37:56 -07001639 }
1640
Adam Cohene0f66b52010-11-23 15:06:07 -08001641 // We want the duration of the page snap animation to be influenced by the distance that
1642 // the screen has to travel, however, we don't want this duration to be effected in a
1643 // purely linear fashion. Instead, we use this method to moderate the effect that the distance
1644 // of travel has on the overall snap duration.
Sunny Goyal4d113a52015-05-27 10:05:28 -07001645 private float distanceInfluenceForSnapDuration(float f) {
Adam Cohene0f66b52010-11-23 15:06:07 -08001646 f -= 0.5f; // center the values about 0.
1647 f *= 0.3f * Math.PI / 2.0f;
1648 return (float) Math.sin(f);
1649 }
1650
Winson Chung05a31ed2018-02-08 17:08:43 -08001651 protected boolean snapToPageWithVelocity(int whichPage, int velocity) {
Adam Cohen6f127a62014-06-12 14:54:41 -07001652 whichPage = validateNewPage(whichPage);
Vinit Nayaka406f722019-12-19 11:50:55 -08001653 int halfScreenSize = mOrientationHandler.getMeasuredSize(this) / 2;
Adam Cohene0f66b52010-11-23 15:06:07 -08001654
Vinit Nayaka406f722019-12-19 11:50:55 -08001655 final int newLoc = getScrollForPage(whichPage);
Sunny Goyalc39db732021-04-03 01:20:21 -07001656 int delta = newLoc - mOrientationHandler.getPrimaryScroll(this);
Adam Cohene0f66b52010-11-23 15:06:07 -08001657 int duration = 0;
1658
Sunny Goyal4d113a52015-05-27 10:05:28 -07001659 if (Math.abs(velocity) < mMinFlingVelocity) {
Adam Cohene0f66b52010-11-23 15:06:07 -08001660 // If the velocity is low enough, then treat this more as an automatic page advance
1661 // as opposed to an apparent physical response to flinging
Andras Kloczlc2bd15f2022-03-30 18:06:13 +01001662 return snapToPage(whichPage, mPageSnapAnimationDuration);
Adam Cohene0f66b52010-11-23 15:06:07 -08001663 }
1664
1665 // Here we compute a "distance" that will be used in the computation of the overall
1666 // snap duration. This is a function of the actual distance that needs to be traveled;
1667 // we keep this value close to half screen size in order to reduce the variance in snap
1668 // duration as a function of the distance the page needs to travel.
Michael Jurka20b7ca92011-06-07 20:09:16 -07001669 float distanceRatio = Math.min(1f, 1.0f * Math.abs(delta) / (2 * halfScreenSize));
Adam Cohene0f66b52010-11-23 15:06:07 -08001670 float distance = halfScreenSize + halfScreenSize *
1671 distanceInfluenceForSnapDuration(distanceRatio);
1672
1673 velocity = Math.abs(velocity);
Adam Cohen265b9a62011-12-07 14:37:18 -08001674 velocity = Math.max(mMinSnapVelocity, velocity);
Adam Cohene0f66b52010-11-23 15:06:07 -08001675
1676 // we want the page's snap velocity to approximately match the velocity at which the
1677 // user flings, so we scale the duration by a value near to the derivative of the scroll
Michael Jurka20b7ca92011-06-07 20:09:16 -07001678 // interpolator at zero, ie. 5. We use 4 to make it a little slower.
1679 duration = 4 * Math.round(1000 * Math.abs(distance / velocity));
Adam Cohene0f66b52010-11-23 15:06:07 -08001680
Sunny Goyalc39db732021-04-03 01:20:21 -07001681 return snapToPage(whichPage, delta, duration);
Michael Jurka0142d492010-08-25 17:46:15 -07001682 }
1683
Winson Chung05a31ed2018-02-08 17:08:43 -08001684 public boolean snapToPage(int whichPage) {
Andras Kloczlc2bd15f2022-03-30 18:06:13 +01001685 return snapToPage(whichPage, mPageSnapAnimationDuration);
Winson Chung321e9ee2010-08-09 13:37:56 -07001686 }
1687
Winson Chung05a31ed2018-02-08 17:08:43 -08001688 public boolean snapToPageImmediately(int whichPage) {
Andras Kloczlc2bd15f2022-03-30 18:06:13 +01001689 return snapToPage(whichPage, mPageSnapAnimationDuration, true);
Adam Cohen7d30a372013-07-01 17:03:59 -07001690 }
1691
Winson Chung05a31ed2018-02-08 17:08:43 -08001692 public boolean snapToPage(int whichPage, int duration) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001693 return snapToPage(whichPage, duration, false);
Adam Cohen7d30a372013-07-01 17:03:59 -07001694 }
1695
Sunny Goyalc39db732021-04-03 01:20:21 -07001696 protected boolean snapToPage(int whichPage, int duration, boolean immediate) {
Adam Cohen6f127a62014-06-12 14:54:41 -07001697 whichPage = validateNewPage(whichPage);
Winson Chung321e9ee2010-08-09 13:37:56 -07001698
Vinit Nayaka406f722019-12-19 11:50:55 -08001699 int newLoc = getScrollForPage(whichPage);
Sunny Goyalc39db732021-04-03 01:20:21 -07001700 final int delta = newLoc - mOrientationHandler.getPrimaryScroll(this);
1701 return snapToPage(whichPage, delta, duration, immediate);
Michael Jurka0142d492010-08-25 17:46:15 -07001702 }
1703
Winson Chung05a31ed2018-02-08 17:08:43 -08001704 protected boolean snapToPage(int whichPage, int delta, int duration) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001705 return snapToPage(whichPage, delta, duration, false);
Adam Cohen7d30a372013-07-01 17:03:59 -07001706 }
Michael Jurka0142d492010-08-25 17:46:15 -07001707
Sunny Goyalc39db732021-04-03 01:20:21 -07001708 protected boolean snapToPage(int whichPage, int delta, int duration, boolean immediate) {
Sunny Goyal9bb8ffb2018-05-24 17:11:16 -07001709 if (mFirstLayout) {
1710 setCurrentPage(whichPage);
1711 return false;
1712 }
Tony Wickhamd58c2d52018-05-04 12:10:55 -07001713
Brian Isganitisfdd044e2023-03-02 19:45:23 +00001714 if (FeatureFlags.IS_STUDIO_BUILD && !Utilities.isRunningInTestHarness()) {
Tony Wickhamcb3f8702018-08-27 17:36:03 -07001715 duration *= Settings.Global.getFloat(getContext().getContentResolver(),
1716 Settings.Global.WINDOW_ANIMATION_SCALE, 1);
Tony Wickhamd58c2d52018-05-04 12:10:55 -07001717 }
1718
Adam Cohen6f127a62014-06-12 14:54:41 -07001719 whichPage = validateNewPage(whichPage);
1720
Adam Cohen7d30a372013-07-01 17:03:59 -07001721 mNextPage = whichPage;
Michael Jurka0142d492010-08-25 17:46:15 -07001722
Winson Chung321e9ee2010-08-09 13:37:56 -07001723 awakenScrollBars(duration);
Adam Cohen7d30a372013-07-01 17:03:59 -07001724 if (immediate) {
1725 duration = 0;
1726 } else if (duration == 0) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001727 duration = Math.abs(delta);
1728 }
1729
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001730 if (duration != 0) {
1731 pageBeginTransition();
1732 }
1733
Adam Cohenf358a4b2013-07-23 16:47:31 -07001734 if (!mScroller.isFinished()) {
Adam Cohenf9618852013-11-08 06:45:03 -08001735 abortScrollerAnimation(false);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001736 }
Adam Cohenf9618852013-11-08 06:45:03 -08001737
Sunny Goyalc39db732021-04-03 01:20:21 -07001738 mScroller.startScroll(mOrientationHandler.getPrimaryScroll(this), 0, delta, 0, duration);
Adam Cohen674531f2013-12-13 15:07:14 -08001739 updatePageIndicator();
Adam Cohen7d30a372013-07-01 17:03:59 -07001740
1741 // Trigger a compute() to finish switching pages if necessary
1742 if (immediate) {
1743 computeScroll();
Sunny Goyal76dbf6f2017-01-03 14:55:47 -08001744 pageEndTransition();
Adam Cohen7d30a372013-07-01 17:03:59 -07001745 }
1746
Winson Chung321e9ee2010-08-09 13:37:56 -07001747 invalidate();
Winson Chung05a31ed2018-02-08 17:08:43 -08001748 return Math.abs(delta) > 0;
Winson Chung321e9ee2010-08-09 13:37:56 -07001749 }
1750
Vadim Tryshev98913d02018-05-18 18:41:34 -07001751 public boolean scrollLeft() {
1752 if (getNextPage() > 0) {
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001753 snapToPage(getNextPage() - getPanelCount());
Vadim Tryshev98913d02018-05-18 18:41:34 -07001754 return true;
1755 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001756 return mAllowOverScroll;
Winson Chung321e9ee2010-08-09 13:37:56 -07001757 }
1758
Vadim Tryshev98913d02018-05-18 18:41:34 -07001759 public boolean scrollRight() {
1760 if (getNextPage() < getChildCount() - 1) {
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 Trysheve6bbefb2018-04-03 13:38:06 -07001767 @Override
Lais Andradecc5c8842021-06-04 18:20:30 +01001768 protected void onScrollChanged(int l, int t, int oldl, int oldt) {
Lais Andradef6e31b12021-10-27 12:04:28 +01001769 if (mScroller.isFinished()) {
1770 // This was not caused by the scroller, skip it.
1771 return;
1772 }
Lais Andradecc5c8842021-06-04 18:20:30 +01001773 int newDestinationPage = getDestinationPage();
1774 if (newDestinationPage >= 0 && newDestinationPage != mCurrentScrollOverPage) {
1775 mCurrentScrollOverPage = newDestinationPage;
1776 onScrollOverPageChanged();
1777 }
1778 }
1779
1780 @Override
Vadim Trysheve6bbefb2018-04-03 13:38:06 -07001781 public CharSequence getAccessibilityClassName() {
1782 // Some accessibility services have special logic for ScrollView. Since we provide same
1783 // accessibility info as ScrollView, inform the service to handle use the same way.
1784 return ScrollView.class.getName();
1785 }
1786
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001787 protected boolean isPageOrderFlipped() {
1788 return false;
1789 }
1790
Winson Chung6a0f57d2011-06-29 20:10:49 -07001791 /* Accessibility */
Sunny Goyalcf25b522015-07-09 00:01:18 -07001792 @SuppressWarnings("deprecation")
Winson Chung6a0f57d2011-06-29 20:10:49 -07001793 @Override
1794 public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) {
1795 super.onInitializeAccessibilityNodeInfo(info);
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001796 final boolean pagesFlipped = isPageOrderFlipped();
Alex Chau9ead9ca2021-11-26 16:22:49 +00001797 info.setScrollable(getPageCount() > 0);
1798 int primaryScroll = mOrientationHandler.getPrimaryScroll(this);
1799 if (getCurrentPage() < getPageCount() - getPanelCount()
1800 || (getCurrentPage() == getPageCount() - getPanelCount()
1801 && primaryScroll != getScrollForPage(getPageCount() - getPanelCount()))) {
yingleiw02cc8482019-08-02 16:14:27 -07001802 info.addAction(pagesFlipped ?
Alex Chau9ead9ca2021-11-26 16:22:49 +00001803 AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_BACKWARD
1804 : AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_FORWARD);
yingleiw02cc8482019-08-02 16:14:27 -07001805 info.addAction(mIsRtl ?
1806 AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_LEFT
1807 : AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_RIGHT);
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001808 }
Alex Chau9ead9ca2021-11-26 16:22:49 +00001809 if (getCurrentPage() > 0
1810 || (getCurrentPage() == 0 && primaryScroll != getScrollForPage(0))) {
yingleiw02cc8482019-08-02 16:14:27 -07001811 info.addAction(pagesFlipped ?
Alex Chau9ead9ca2021-11-26 16:22:49 +00001812 AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_FORWARD
1813 : AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_BACKWARD);
yingleiw02cc8482019-08-02 16:14:27 -07001814 info.addAction(mIsRtl ?
1815 AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_RIGHT
1816 : AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_LEFT);
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001817 }
Vadim Tryshev7af0d442015-05-15 08:48:11 -07001818 // Accessibility-wise, PagedView doesn't support long click, so disabling it.
1819 // Besides disabling the accessibility long-click, this also prevents this view from getting
1820 // accessibility focus.
1821 info.setLongClickable(false);
Sunny Goyala52ecb02016-12-16 15:04:51 -08001822 info.removeAction(AccessibilityNodeInfo.AccessibilityAction.ACTION_LONG_CLICK);
Winson Chung6a0f57d2011-06-29 20:10:49 -07001823 }
1824
1825 @Override
Alan Viverette254139a2013-10-08 13:13:46 -07001826 public void sendAccessibilityEvent(int eventType) {
1827 // Don't let the view send real scroll events.
1828 if (eventType != AccessibilityEvent.TYPE_VIEW_SCROLLED) {
1829 super.sendAccessibilityEvent(eventType);
1830 }
1831 }
1832
1833 @Override
Winson Chung6a0f57d2011-06-29 20:10:49 -07001834 public void onInitializeAccessibilityEvent(AccessibilityEvent event) {
1835 super.onInitializeAccessibilityEvent(event);
Pinyao Tingaf6daa22019-09-18 22:18:03 +00001836 event.setScrollable(mAllowOverScroll || getPageCount() > 1);
Winson Chung6a0f57d2011-06-29 20:10:49 -07001837 }
1838
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001839 @Override
1840 public boolean performAccessibilityAction(int action, Bundle arguments) {
1841 if (super.performAccessibilityAction(action, arguments)) {
1842 return true;
1843 }
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001844 final boolean pagesFlipped = isPageOrderFlipped();
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001845 switch (action) {
1846 case AccessibilityNodeInfo.ACTION_SCROLL_FORWARD: {
Vadim Tryshev98913d02018-05-18 18:41:34 -07001847 if (pagesFlipped ? scrollLeft() : scrollRight()) {
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001848 return true;
1849 }
1850 } break;
1851 case AccessibilityNodeInfo.ACTION_SCROLL_BACKWARD: {
Vadim Tryshev98913d02018-05-18 18:41:34 -07001852 if (pagesFlipped ? scrollRight() : scrollLeft()) {
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001853 return true;
1854 }
yingleiw02cc8482019-08-02 16:14:27 -07001855 } break;
1856 case android.R.id.accessibilityActionPageRight: {
1857 if (!mIsRtl) {
Alex Chau9ead9ca2021-11-26 16:22:49 +00001858 return scrollRight();
yingleiw02cc8482019-08-02 16:14:27 -07001859 } else {
Alex Chau9ead9ca2021-11-26 16:22:49 +00001860 return scrollLeft();
yingleiw02cc8482019-08-02 16:14:27 -07001861 }
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001862 }
yingleiw02cc8482019-08-02 16:14:27 -07001863 case android.R.id.accessibilityActionPageLeft: {
1864 if (!mIsRtl) {
Alex Chau9ead9ca2021-11-26 16:22:49 +00001865 return scrollLeft();
yingleiw02cc8482019-08-02 16:14:27 -07001866 } else {
Alex Chau9ead9ca2021-11-26 16:22:49 +00001867 return scrollRight();
yingleiw02cc8482019-08-02 16:14:27 -07001868 }
1869 }
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001870 }
1871 return false;
1872 }
1873
Vadim Tryshev2c430b32018-04-04 14:45:21 -07001874 protected boolean canAnnouncePageDescription() {
1875 return true;
1876 }
1877
Adam Cohen0ffac432013-07-10 11:19:26 -07001878 protected String getCurrentPageDescription() {
Sunny Goyalf4f89ef2015-09-02 15:06:12 -07001879 return getContext().getString(R.string.default_scroll_format,
Adam Cohen0ffac432013-07-10 11:19:26 -07001880 getNextPage() + 1, getChildCount());
1881 }
1882
Tony Mak2e564402018-02-27 17:19:34 +00001883 protected float getDownMotionX() {
1884 return mDownMotionX;
1885 }
1886
1887 protected float getDownMotionY() {
1888 return mDownMotionY;
1889 }
1890
Sunny Goyal20a13ff2018-03-13 16:44:00 -07001891 protected interface ComputePageScrollsLogic {
1892
1893 boolean shouldIncludeView(View view);
1894 }
Vadim Tryshev528b9e02018-05-24 18:22:03 -07001895
1896 public int[] getVisibleChildrenRange() {
1897 float visibleLeft = 0;
1898 float visibleRight = visibleLeft + getMeasuredWidth();
1899 float scaleX = getScaleX();
1900 if (scaleX < 1 && scaleX > 0) {
1901 float mid = getMeasuredWidth() / 2;
1902 visibleLeft = mid - ((mid - visibleLeft) / scaleX);
1903 visibleRight = mid + ((visibleRight - mid) / scaleX);
1904 }
1905
1906 int leftChild = -1;
1907 int rightChild = -1;
1908 final int childCount = getChildCount();
1909 for (int i = 0; i < childCount; i++) {
1910 final View child = getPageAt(i);
1911
1912 float left = child.getLeft() + child.getTranslationX() - getScrollX();
1913 if (left <= visibleRight && (left + child.getMeasuredWidth()) >= visibleLeft) {
1914 if (leftChild == -1) {
1915 leftChild = i;
1916 }
1917 rightChild = i;
1918 }
1919 }
1920 mTmpIntPair[0] = leftChild;
1921 mTmpIntPair[1] = rightChild;
1922 return mTmpIntPair;
1923 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001924
1925 @Override
1926 public void draw(Canvas canvas) {
1927 super.draw(canvas);
1928 drawEdgeEffect(canvas);
Sunny Goyal05b59c02021-04-29 13:55:40 -07001929 pageEndTransition();
Sunny Goyalc39db732021-04-03 01:20:21 -07001930 }
1931
1932 protected void drawEdgeEffect(Canvas canvas) {
1933 if (mAllowOverScroll && (!mEdgeGlowRight.isFinished() || !mEdgeGlowLeft.isFinished())) {
1934 final int width = getWidth();
1935 final int height = getHeight();
1936 if (!mEdgeGlowLeft.isFinished()) {
1937 final int restoreCount = canvas.save();
1938 canvas.rotate(-90);
1939 canvas.translate(-height, Math.min(mMinScroll, getScrollX()));
1940 mEdgeGlowLeft.setSize(height, width);
1941 if (mEdgeGlowLeft.draw(canvas)) {
1942 postInvalidateOnAnimation();
1943 }
1944 canvas.restoreToCount(restoreCount);
1945 }
1946 if (!mEdgeGlowRight.isFinished()) {
1947 final int restoreCount = canvas.save();
1948 canvas.rotate(90, width, 0);
1949 canvas.translate(width, -(Math.max(mMaxScroll, getScrollX())));
1950
1951 mEdgeGlowRight.setSize(height, width);
1952 if (mEdgeGlowRight.draw(canvas)) {
1953 postInvalidateOnAnimation();
1954 }
1955 canvas.restoreToCount(restoreCount);
1956 }
1957 }
1958 }
Adam Cohen5084cba2013-09-03 12:01:16 -07001959}