blob: eb68adb3e83d9677a0fc8baa13a740d8ed72cfc3 [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
Andras Kloczl55edfe52021-05-14 12:21:30 +020019import static androidx.annotation.VisibleForTesting.PACKAGE_PRIVATE;
Andras Kloczldbf577a2021-05-26 15:02:52 +020020
Sunny Goyalc39db732021-04-03 01:20:21 -070021import static com.android.launcher3.anim.Interpolators.SCROLL;
Sunny Goyal8b37c572020-03-31 12:12:14 -070022import static com.android.launcher3.compat.AccessibilityManagerCompat.isAccessibilityEnabled;
23import static com.android.launcher3.compat.AccessibilityManagerCompat.isObservedEventType;
Sunny Goyal8b37c572020-03-31 12:12:14 -070024import static com.android.launcher3.touch.OverScroll.OVERSCROLL_DAMP_FACTOR;
Sunny Goyal8b37c572020-03-31 12:12:14 -070025import static com.android.launcher3.touch.PagedOrientationHandler.VIEW_SCROLL_BY;
26import static com.android.launcher3.touch.PagedOrientationHandler.VIEW_SCROLL_TO;
27
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -070028import android.animation.LayoutTransition;
Sunny Goyalcf25b522015-07-09 00:01:18 -070029import android.annotation.SuppressLint;
Winson Chung321e9ee2010-08-09 13:37:56 -070030import android.content.Context;
Andras Kloczlc2bd15f2022-03-30 18:06:13 +010031import android.content.res.Configuration;
32import android.content.res.Resources;
Adam Cohen9c4949e2010-10-05 12:27:22 -070033import android.content.res.TypedArray;
Jon Miranda71cb80c2019-01-24 21:25:13 -080034import android.graphics.Canvas;
Winson Chung321e9ee2010-08-09 13:37:56 -070035import android.graphics.Rect;
Svetoslav Ganov08055f62012-05-15 11:06:36 -070036import android.os.Bundle;
Tony Wickhamd58c2d52018-05-04 12:10:55 -070037import android.provider.Settings;
Winson Chung321e9ee2010-08-09 13:37:56 -070038import android.util.AttributeSet;
Winson Chung785d2eb2011-04-14 16:08:02 -070039import android.util.Log;
Winson Chung185d7162011-02-28 13:47:29 -080040import android.view.InputDevice;
41import android.view.KeyEvent;
Winson Chung321e9ee2010-08-09 13:37:56 -070042import android.view.MotionEvent;
43import android.view.VelocityTracker;
44import android.view.View;
45import android.view.ViewConfiguration;
Sunny Goyal4ffec482016-02-09 11:28:52 -080046import android.view.ViewDebug;
Winson Chung321e9ee2010-08-09 13:37:56 -070047import android.view.ViewGroup;
48import android.view.ViewParent;
Winson Chung6a0f57d2011-06-29 20:10:49 -070049import android.view.accessibility.AccessibilityEvent;
50import android.view.accessibility.AccessibilityNodeInfo;
Sunny Goyalc39db732021-04-03 01:20:21 -070051import android.widget.OverScroller;
Vadim Trysheve6bbefb2018-04-03 13:38:06 -070052import android.widget.ScrollView;
Tony Wickhamf549dab2016-05-16 09:54:06 -070053
Tony Wickham62117d72020-03-26 16:56:26 -070054import androidx.annotation.Nullable;
Andras Kloczl55edfe52021-05-14 12:21:30 +020055import androidx.annotation.VisibleForTesting;
Tony Wickham62117d72020-03-26 16:56:26 -070056
Jon Miranda9e198662020-03-11 14:42:02 -070057import com.android.launcher3.compat.AccessibilityManagerCompat;
58import com.android.launcher3.config.FeatureFlags;
Jon Miranda9e198662020-03-11 14:42:02 -070059import com.android.launcher3.pageindicators.PageIndicator;
Jon Miranda9e198662020-03-11 14:42:02 -070060import com.android.launcher3.touch.PagedOrientationHandler;
61import com.android.launcher3.touch.PagedOrientationHandler.ChildBounds;
Sunny Goyalc39db732021-04-03 01:20:21 -070062import com.android.launcher3.util.EdgeEffectCompat;
Andras Kloczl55edfe52021-05-14 12:21:30 +020063import com.android.launcher3.util.IntSet;
Jon Miranda9e198662020-03-11 14:42:02 -070064import com.android.launcher3.util.Thunk;
Sunny Goyal8b37c572020-03-31 12:12:14 -070065import com.android.launcher3.views.ActivityContext;
Jon Miranda9e198662020-03-11 14:42:02 -070066
67import java.util.ArrayList;
Sunny Goyal59969372021-05-06 12:11:44 -070068import java.util.function.Consumer;
Jon Miranda9e198662020-03-11 14:42:02 -070069
Winson Chung321e9ee2010-08-09 13:37:56 -070070/**
71 * An abstraction of the original Workspace which supports browsing through a
Michael Jurka0142d492010-08-25 17:46:15 -070072 * sequential list of "pages"
Winson Chung321e9ee2010-08-09 13:37:56 -070073 */
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -080074public abstract class PagedView<T extends View & PageIndicator> extends ViewGroup {
Winson Chung321e9ee2010-08-09 13:37:56 -070075 private static final String TAG = "PagedView";
Winson Chung785d2eb2011-04-14 16:08:02 -070076 private static final boolean DEBUG = false;
Winson Chung4941f652020-06-18 15:11:53 -070077 public static final boolean DEBUG_FAILED_QUICKSWITCH = false;
Sunny Goyal20a13ff2018-03-13 16:44:00 -070078
Winson Chung4941f652020-06-18 15:11:53 -070079 public static final int ACTION_MOVE_ALLOW_EASY_FLING = MotionEvent.ACTION_MASK - 1;
Sunny Goyala7a5bf32020-01-05 15:35:29 +053080 public static final int INVALID_PAGE = -1;
Sunny Goyal20a13ff2018-03-13 16:44:00 -070081 protected static final ComputePageScrollsLogic SIMPLE_SCROLL_LOGIC = (v) -> v.getVisibility() != GONE;
Winson Chung321e9ee2010-08-09 13:37:56 -070082
Adam Cohenb64cb5a2011-02-15 13:53:42 -080083 private static final float RETURN_TO_ORIGINAL_PAGE_THRESHOLD = 0.33f;
Adam Cohen00481b32011-11-18 12:03:48 -080084 // The page is moved more than halfway, automatically move to the next page on touch up.
85 private static final float SIGNIFICANT_MOVE_THRESHOLD = 0.4f;
Adam Cohen68d73932010-11-15 10:50:58 -080086
Sunny Goyal8e2133b2015-05-06 13:39:07 -070087 private static final float MAX_SCROLL_PROGRESS = 1.0f;
88
Adam Cohenf358a4b2013-07-23 16:47:31 -070089 private boolean mFreeScroll = false;
Adam Cohenf358a4b2013-07-23 16:47:31 -070090
Andras Kloczlc2bd15f2022-03-30 18:06:13 +010091 private int mFlingThresholdVelocity;
92 private int mEasyFlingThresholdVelocity;
93 private int mMinFlingVelocity;
94 private int mMinSnapVelocity;
95 private int mPageSnapAnimationDuration;
Michael Jurka0142d492010-08-25 17:46:15 -070096
Michael Jurka0142d492010-08-25 17:46:15 -070097 protected boolean mFirstLayout = true;
98
Sunny Goyal4ffec482016-02-09 11:28:52 -080099 @ViewDebug.ExportedProperty(category = "launcher")
Michael Jurka0142d492010-08-25 17:46:15 -0700100 protected int mCurrentPage;
Alex Chauba61b982021-06-15 16:29:19 +0100101 // Difference between current scroll position and mCurrentPage's page scroll. Used to maintain
102 // relative scroll position unchanged in updateCurrentPageScroll. Cleared when snapping to a
103 // page.
104 protected int mCurrentPageScrollDiff;
Lais Andradecc5c8842021-06-04 18:20:30 +0100105 // The current page the PagedView is scrolling over on it's way to the destination page.
106 protected int mCurrentScrollOverPage;
Adam Cohene61a9a22013-06-11 15:45:31 -0700107
Sunny Goyal4ffec482016-02-09 11:28:52 -0800108 @ViewDebug.ExportedProperty(category = "launcher")
Michael Jurka0142d492010-08-25 17:46:15 -0700109 protected int mNextPage = INVALID_PAGE;
Vinit Nayaka406f722019-12-19 11:50:55 -0800110 protected int mMaxScroll;
111 protected int mMinScroll;
Sunny Goyalb7b01352018-08-09 12:31:20 -0700112 protected OverScroller mScroller;
Winson Chung321e9ee2010-08-09 13:37:56 -0700113 private VelocityTracker mVelocityTracker;
Sunny Goyale15e2a82017-12-15 13:05:42 -0800114 protected int mPageSpacing = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -0700115
116 private float mDownMotionX;
Adam Cohen7d30a372013-07-01 17:03:59 -0700117 private float mDownMotionY;
Vinit Nayaka406f722019-12-19 11:50:55 -0800118 private float mDownMotionPrimary;
119 private float mLastMotion;
120 private float mLastMotionRemainder;
121 private float mTotalMotion;
Winson Chung4941f652020-06-18 15:11:53 -0700122 // Used in special cases where the fling checks can be relaxed for an intentional gesture
123 private boolean mAllowEasyFling;
Sunny Goyalacd17df2020-04-03 15:58:45 -0700124 protected PagedOrientationHandler mOrientationHandler = PagedOrientationHandler.PORTRAIT;
Adam Cohenedb40762013-07-18 16:45:45 -0700125
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700126 private final ArrayList<Runnable> mOnPageScrollsInitializedCallbacks = new ArrayList<>();
127
128 // We should always check pageScrollsInitialized() is true when using mPageScrolls.
129 @Nullable protected int[] mPageScrolls = null;
Sunny Goyalaad33592018-08-07 17:20:35 -0700130 private boolean mIsBeingDragged;
Adam Cohencae7f572013-11-04 14:42:52 -0800131
Winson Chung4941f652020-06-18 15:11:53 -0700132 // The amount of movement to begin scrolling
Michael Jurka7426c422010-11-11 15:23:47 -0800133 protected int mTouchSlop;
Winson Chung4941f652020-06-18 15:11:53 -0700134 // The amount of movement to begin paging
135 protected int mPageSlop;
Winson Chung321e9ee2010-08-09 13:37:56 -0700136 private int mMaximumVelocity;
Adam Cohen68d73932010-11-15 10:50:58 -0800137 protected boolean mAllowOverScroll = true;
Winson Chung321e9ee2010-08-09 13:37:56 -0700138
Michael Jurka5f1c5092010-09-03 14:15:02 -0700139 protected static final int INVALID_POINTER = -1;
Winson Chung321e9ee2010-08-09 13:37:56 -0700140
Michael Jurka5f1c5092010-09-03 14:15:02 -0700141 protected int mActivePointerId = INVALID_POINTER;
Winson Chung321e9ee2010-08-09 13:37:56 -0700142
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700143 protected boolean mIsPageInTransition = false;
Tony Wickham62117d72020-03-26 16:56:26 -0700144 private Runnable mOnPageTransitionEndCallback;
Patrick Dubroy1262e362010-10-06 15:49:50 -0700145
Winson Chungd2be3812013-07-16 11:11:32 -0700146 // Page Indicator
Adam Cohen091440a2015-03-18 14:16:05 -0700147 @Thunk int mPageIndicatorViewId;
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800148 protected T mPageIndicator;
Adam Cohen7d30a372013-07-01 17:03:59 -0700149
John Spurlock77e1f472013-09-11 10:09:51 -0400150 protected final Rect mInsets = new Rect();
Tony Wickhamdfb5cc92018-02-26 16:41:57 -0800151 protected boolean mIsRtl;
John Spurlock77e1f472013-09-11 10:09:51 -0400152
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800153 // Similar to the platform implementation of isLayoutValid();
154 protected boolean mIsLayoutValid;
155
Vadim Tryshev528b9e02018-05-24 18:22:03 -0700156 private int[] mTmpIntPair = new int[2];
157
Sunny Goyalc39db732021-04-03 01:20:21 -0700158 protected EdgeEffectCompat mEdgeGlowLeft;
159 protected EdgeEffectCompat mEdgeGlowRight;
160
Winson Chung321e9ee2010-08-09 13:37:56 -0700161 public PagedView(Context context) {
162 this(context, null);
163 }
164
165 public PagedView(Context context, AttributeSet attrs) {
166 this(context, attrs, 0);
167 }
168
169 public PagedView(Context context, AttributeSet attrs, int defStyle) {
170 super(context, attrs, defStyle);
Winson Chungc9ca2982013-07-19 12:07:38 -0700171
Adam Cohen9c4949e2010-10-05 12:27:22 -0700172 TypedArray a = context.obtainStyledAttributes(attrs,
173 R.styleable.PagedView, defStyle, 0);
Winson Chungd2be3812013-07-16 11:11:32 -0700174 mPageIndicatorViewId = a.getResourceId(R.styleable.PagedView_pageIndicator, -1);
Adam Cohen9c4949e2010-10-05 12:27:22 -0700175 a.recycle();
176
Winson Chung321e9ee2010-08-09 13:37:56 -0700177 setHapticFeedbackEnabled(false);
Sunny Goyal70660032015-05-14 00:07:08 -0700178 mIsRtl = Utilities.isRtl(getResources());
Winson Chung321e9ee2010-08-09 13:37:56 -0700179
Sunny Goyalc39db732021-04-03 01:20:21 -0700180 mScroller = new OverScroller(context, SCROLL);
Winson Chung86f77532010-08-24 11:08:22 -0700181 mCurrentPage = 0;
Lais Andradecc5c8842021-06-04 18:20:30 +0100182 mCurrentScrollOverPage = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -0700183
Vinit Nayaka406f722019-12-19 11:50:55 -0800184 final ViewConfiguration configuration = ViewConfiguration.get(context);
Winson Chung4941f652020-06-18 15:11:53 -0700185 mTouchSlop = configuration.getScaledTouchSlop();
186 mPageSlop = configuration.getScaledPagingTouchSlop();
Winson Chung321e9ee2010-08-09 13:37:56 -0700187 mMaximumVelocity = configuration.getScaledMaximumFlingVelocity();
Adam Cohen265b9a62011-12-07 14:37:18 -0800188
Andras Kloczlc2bd15f2022-03-30 18:06:13 +0100189 updateVelocityValues();
Sunny Goyala9f55462018-03-25 18:15:15 -0700190
Sunny Goyalc39db732021-04-03 01:20:21 -0700191 initEdgeEffect();
Sunny Goyaleaf7a952020-07-29 16:54:20 -0700192 setDefaultFocusHighlightEnabled(false);
Sunny Goyalc39db732021-04-03 01:20:21 -0700193 setWillNotDraw(false);
Winson Chung321e9ee2010-08-09 13:37:56 -0700194 }
195
Sunny Goyalc39db732021-04-03 01:20:21 -0700196 protected void initEdgeEffect() {
197 mEdgeGlowLeft = new EdgeEffectCompat(getContext());
198 mEdgeGlowRight = new EdgeEffectCompat(getContext());
Adam Cohenf9618852013-11-08 06:45:03 -0800199 }
200
Sunny Goyald0a6ae72016-06-16 12:29:03 -0700201 public void initParentViews(View parent) {
202 if (mPageIndicatorViewId > -1) {
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800203 mPageIndicator = parent.findViewById(mPageIndicatorViewId);
Tony Wickhambab101c2021-09-20 15:12:44 -0700204 mPageIndicator.setMarkersCount(getChildCount() / getPanelCount());
Winson Chungd2be3812013-07-16 11:11:32 -0700205 }
206 }
207
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800208 public T getPageIndicator() {
Adam Cohenedb40762013-07-18 16:45:45 -0700209 return mPageIndicator;
210 }
211
Adam Cohen674531f2013-12-13 15:07:14 -0800212 /**
Tony Wickham29d853c2015-09-08 10:35:56 -0700213 * Returns the index of the currently displayed page. When in free scroll mode, this is the page
214 * that the user was on before entering free scroll mode (e.g. the home screen page they
Alex Chaub794ea62021-02-03 18:00:30 +0000215 * long-pressed on to enter the overview). Try using {@link #getDestinationPage()}
Tony Wickham29d853c2015-09-08 10:35:56 -0700216 * to get the page the user is currently scrolling over.
Winson Chung321e9ee2010-08-09 13:37:56 -0700217 */
Sunny Goyal83a8f042015-05-19 12:52:12 -0700218 public int getCurrentPage() {
Winson Chung86f77532010-08-24 11:08:22 -0700219 return mCurrentPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700220 }
Adam Cohen7d30a372013-07-01 17:03:59 -0700221
Hyunyoung Songb76cd622015-04-16 14:34:09 -0700222 /**
223 * Returns the index of page to be shown immediately afterwards.
224 */
Vadim Tryshevfedca432015-08-19 17:55:02 -0700225 public int getNextPage() {
Winson Chung360e63f2012-04-27 13:48:05 -0700226 return (mNextPage != INVALID_PAGE) ? mNextPage : mCurrentPage;
227 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700228
Adam Cohenf9c184a2016-01-15 16:47:43 -0800229 public int getPageCount() {
Winson Chung321e9ee2010-08-09 13:37:56 -0700230 return getChildCount();
231 }
232
Sunny Goyal83a8f042015-05-19 12:52:12 -0700233 public View getPageAt(int index) {
Winson Chung321e9ee2010-08-09 13:37:56 -0700234 return getChildAt(index);
235 }
236
Winson Chung321e9ee2010-08-09 13:37:56 -0700237 /**
Winson Chungbbc60d82010-11-11 16:34:41 -0800238 * Updates the scroll of the current page immediately to its final scroll position. We use this
239 * in CustomizePagedView to allow tabs to share the same PagedView while resetting the scroll of
240 * the previous tab page.
241 */
242 protected void updateCurrentPageScroll() {
Adam Cohen0ffac432013-07-10 11:19:26 -0700243 // If the current page is invalid, just reset the scroll position to zero
Vinit Nayaka406f722019-12-19 11:50:55 -0800244 int newPosition = 0;
Adam Cohen0ffac432013-07-10 11:19:26 -0700245 if (0 <= mCurrentPage && mCurrentPage < getPageCount()) {
Alex Chauba61b982021-06-15 16:29:19 +0100246 newPosition = getScrollForPage(mCurrentPage) + mCurrentPageScrollDiff;
Adam Cohen0ffac432013-07-10 11:19:26 -0700247 }
Alex Chau6499e832021-11-19 14:35:46 +0000248 mOrientationHandler.setPrimary(this, VIEW_SCROLL_TO, newPosition);
Sunny Goyalc39db732021-04-03 01:20:21 -0700249 mScroller.startScroll(mScroller.getCurrX(), 0, newPosition - mScroller.getCurrX(), 0);
Tony Wickhamd5521322021-09-14 14:26:50 -0700250 forceFinishScroller();
Winson Chungbbc60d82010-11-11 16:34:41 -0800251 }
252
Tony Wickhamf8d731a2021-05-26 14:58:13 -0700253 /**
254 * Immediately finishes any overscroll effect and jumps to the end of the scroller animation.
255 */
256 public void abortScrollerAnimation() {
257 mEdgeGlowLeft.finish();
258 mEdgeGlowRight.finish();
259 abortScrollerAnimation(true);
260 }
261
Schneider Victor-tuliasa602a0a2022-09-06 13:34:00 -0700262 protected void onScrollerAnimationAborted() {
263 // No-Op
264 }
265
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700266 private void abortScrollerAnimation(boolean resetNextPage) {
Adam Cohen4fe4c932013-10-28 16:02:34 -0700267 mScroller.abortAnimation();
Schneider Victor-tuliasa602a0a2022-09-06 13:34:00 -0700268 onScrollerAnimationAborted();
Adam Cohen4fe4c932013-10-28 16:02:34 -0700269 // We need to clean up the next page here to avoid computeScrollHelper from
270 // updating current page on the pass.
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700271 if (resetNextPage) {
272 mNextPage = INVALID_PAGE;
Sunny Goyal857b1b92018-03-05 10:49:05 -0800273 pageEndTransition();
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700274 }
Chet Haasebc2f0822012-10-26 17:59:53 -0700275 }
Adam Cohen4fe4c932013-10-28 16:02:34 -0700276
Tony Wickhamd5521322021-09-14 14:26:50 -0700277 /**
278 * Immediately finishes any in-progress scroll, maintaining the current position. Also sets
279 * mNextPage = INVALID_PAGE and calls pageEndTransition().
280 */
281 public void forceFinishScroller() {
Adam Cohen4fe4c932013-10-28 16:02:34 -0700282 mScroller.forceFinished(true);
283 // We need to clean up the next page here to avoid computeScrollHelper from
284 // updating current page on the pass.
Tony Wickhamd5521322021-09-14 14:26:50 -0700285 mNextPage = INVALID_PAGE;
286 pageEndTransition();
Adam Cohen4fe4c932013-10-28 16:02:34 -0700287 }
288
Adam Cohen6f127a62014-06-12 14:54:41 -0700289 private int validateNewPage(int newPage) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700290 newPage = ensureWithinScrollBounds(newPage);
Adam Cohen6f127a62014-06-12 14:54:41 -0700291 // Ensure that it is clamped by the actual set of children in all cases
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100292 newPage = Utilities.boundToRange(newPage, 0, getPageCount() - 1);
293
294 if (getPanelCount() > 1) {
Alex Chau1e448462021-08-13 21:48:35 +0100295 // Always return left most panel as new page
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100296 newPage = getLeftmostVisiblePageForIndex(newPage);
297 }
298 return newPage;
299 }
300
Andras Kloczl55edfe52021-05-14 12:21:30 +0200301 /**
302 * In most cases where panelCount is 1, this method will just return the page index that was
303 * passed in.
304 * But for example when two panel home is enabled we might need the leftmost visible page index
305 * because that page is the current page.
306 */
307 public int getLeftmostVisiblePageForIndex(int pageIndex) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100308 int panelCount = getPanelCount();
Andras Kloczl55edfe52021-05-14 12:21:30 +0200309 return pageIndex - pageIndex % panelCount;
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100310 }
311
312 /**
313 * Returns the number of pages that are shown at the same time.
314 */
315 protected int getPanelCount() {
316 return 1;
317 }
318
319 /**
Andras Kloczl55edfe52021-05-14 12:21:30 +0200320 * Returns an IntSet with the indices of the currently visible pages
321 */
322 @VisibleForTesting(otherwise = PACKAGE_PRIVATE)
323 public IntSet getVisiblePageIndices() {
Andras Kloczl7e912442021-05-06 12:50:28 +0200324 return getPageIndices(mCurrentPage);
325 }
326
327 /**
328 * In case the panelCount is 1 this just returns the same page index in an IntSet.
329 * But in cases where the panelCount > 1 this will return all the page indices that belong
330 * together, i.e. on the Workspace they are next to each other and shown at the same time.
331 */
332 private IntSet getPageIndices(int pageIndex) {
333 // we want to make sure the pageIndex is the leftmost page
334 pageIndex = getLeftmostVisiblePageForIndex(pageIndex);
335
336 IntSet pageIndices = new IntSet();
Andras Kloczl55edfe52021-05-14 12:21:30 +0200337 int panelCount = getPanelCount();
338 int pageCount = getPageCount();
Andras Kloczl7e912442021-05-06 12:50:28 +0200339 for (int page = pageIndex; page < pageIndex + panelCount && page < pageCount; page++) {
340 pageIndices.add(page);
Andras Kloczl55edfe52021-05-14 12:21:30 +0200341 }
Andras Kloczl7e912442021-05-06 12:50:28 +0200342 return pageIndices;
343 }
344
345 /**
346 * Returns an IntSet with the indices of the neighbour pages that are in the focus direction.
347 */
348 private IntSet getNeighbourPageIndices(int focus) {
349 int panelCount = getPanelCount();
350 // getNextPage is more reliable than getCurrentPage
351 int currentPage = getNextPage();
352
353 int nextPage;
354 if (focus == View.FOCUS_LEFT) {
355 nextPage = currentPage - panelCount;
356 } else if (focus == View.FOCUS_RIGHT) {
357 nextPage = currentPage + panelCount;
358 } else {
Andras Kloczlb0632942021-08-03 14:03:58 +0200359 // no neighbours to other directions
Andras Kloczl7e912442021-05-06 12:50:28 +0200360 return new IntSet();
361 }
362 nextPage = validateNewPage(nextPage);
363 if (nextPage == currentPage) {
364 // We reached the end of the pages
365 return new IntSet();
366 }
367
Andras Kloczlb0632942021-08-03 14:03:58 +0200368 return getPageIndices(nextPage);
Andras Kloczl55edfe52021-05-14 12:21:30 +0200369 }
370
371 /**
Sunny Goyal59969372021-05-06 12:11:44 -0700372 * Executes the callback against each visible page
Andras Kloczl2bb51342021-03-20 01:13:45 +0100373 */
Sunny Goyal59969372021-05-06 12:11:44 -0700374 public void forEachVisiblePage(Consumer<View> callback) {
Andras Kloczl55edfe52021-05-14 12:21:30 +0200375 getVisiblePageIndices().forEach(pageIndex -> {
376 View page = getPageAt(pageIndex);
Andras Kloczl2bb51342021-03-20 01:13:45 +0100377 if (page != null) {
Sunny Goyal59969372021-05-06 12:11:44 -0700378 callback.accept(page);
Andras Kloczl2bb51342021-03-20 01:13:45 +0100379 }
Andras Kloczl55edfe52021-05-14 12:21:30 +0200380 });
Andras Kloczl2bb51342021-03-20 01:13:45 +0100381 }
382
383 /**
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100384 * Returns true if the view is on one of the current pages, false otherwise.
385 */
386 public boolean isVisible(View child) {
Andras Kloczl7e912442021-05-06 12:50:28 +0200387 return isVisible(indexOfChild(child));
388 }
389
390 /**
391 * Returns true if the page with the given index is currently visible, false otherwise.
392 */
393 private boolean isVisible(int pageIndex) {
394 return getLeftmostVisiblePageForIndex(pageIndex) == mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700395 }
396
Chet Haasebc2f0822012-10-26 17:59:53 -0700397 /**
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700398 * @return The closest page to the provided page that is within mMinScrollX and mMaxScrollX.
399 */
400 private int ensureWithinScrollBounds(int page) {
401 int dir = !mIsRtl ? 1 : - 1;
402 int currScroll = getScrollForPage(page);
403 int prevScroll;
Vinit Nayaka406f722019-12-19 11:50:55 -0800404 while (currScroll < mMinScroll) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700405 page += dir;
406 prevScroll = currScroll;
407 currScroll = getScrollForPage(page);
408 if (currScroll <= prevScroll) {
409 Log.e(TAG, "validateNewPage: failed to find a page > mMinScrollX");
410 break;
411 }
412 }
Vinit Nayaka406f722019-12-19 11:50:55 -0800413 while (currScroll > mMaxScroll) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700414 page -= dir;
415 prevScroll = currScroll;
416 currScroll = getScrollForPage(page);
417 if (currScroll >= prevScroll) {
418 Log.e(TAG, "validateNewPage: failed to find a page < mMaxScrollX");
419 break;
420 }
421 }
422 return page;
423 }
424
Tony Wickham03f27012019-04-25 14:22:54 -0700425 public void setCurrentPage(int currentPage) {
426 setCurrentPage(currentPage, INVALID_PAGE);
427 }
428
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700429 /**
Winson Chung86f77532010-08-24 11:08:22 -0700430 * Sets the current page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700431 */
Tony Wickham03f27012019-04-25 14:22:54 -0700432 public void setCurrentPage(int currentPage, int overridePrevPage) {
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800433 if (!mScroller.isFinished()) {
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700434 abortScrollerAnimation(true);
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800435 }
Michael Jurkad3ef3062010-11-23 16:23:58 -0800436 // don't introduce any checks like mCurrentPage == currentPage here-- if we change the
437 // the default
438 if (getChildCount() == 0) {
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800439 return;
440 }
Tony Wickham03f27012019-04-25 14:22:54 -0700441 int prevPage = overridePrevPage != INVALID_PAGE ? overridePrevPage : mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700442 mCurrentPage = validateNewPage(currentPage);
Lais Andradecc5c8842021-06-04 18:20:30 +0100443 mCurrentScrollOverPage = mCurrentPage;
Winson Chung181c3dc2013-07-17 15:36:20 -0700444 updateCurrentPageScroll();
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700445 notifyPageSwitchListener(prevPage);
Winson Chunga12a2502010-12-20 14:41:35 -0800446 invalidate();
Winson Chung321e9ee2010-08-09 13:37:56 -0700447 }
448
Winson Chung8c87cd82013-07-23 16:20:10 -0700449 /**
Adam Cohen674531f2013-12-13 15:07:14 -0800450 * Should be called whenever the page changes. In the case of a scroll, we wait until the page
451 * has settled.
452 */
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700453 protected void notifyPageSwitchListener(int prevPage) {
Adam Cohen674531f2013-12-13 15:07:14 -0800454 updatePageIndicator();
455 }
456
457 private void updatePageIndicator() {
Sunny Goyal4cbf0462014-08-28 16:19:39 -0700458 if (mPageIndicator != null) {
Tony Mak4f521af2018-03-15 16:37:34 +0000459 mPageIndicator.setActiveMarker(getNextPage());
Winson Chungd2be3812013-07-16 11:11:32 -0700460 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700461 }
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700462 protected void pageBeginTransition() {
463 if (!mIsPageInTransition) {
464 mIsPageInTransition = true;
465 onPageBeginTransition();
Michael Jurkad74c9842011-07-10 12:44:21 -0700466 }
Patrick Dubroy1262e362010-10-06 15:49:50 -0700467 }
468
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700469 protected void pageEndTransition() {
Sunny Goyal05b59c02021-04-29 13:55:40 -0700470 if (mIsPageInTransition && !mIsBeingDragged && mScroller.isFinished()
Sunny Goyalb745a2a2021-04-30 13:38:22 -0700471 && (!isShown() || (mEdgeGlowLeft.isFinished() && mEdgeGlowRight.isFinished()))) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700472 mIsPageInTransition = false;
473 onPageEndTransition();
Michael Jurkad74c9842011-07-10 12:44:21 -0700474 }
Michael Jurka0142d492010-08-25 17:46:15 -0700475 }
476
Sunny Goyalb745a2a2021-04-30 13:38:22 -0700477 @Override
478 public void onVisibilityAggregated(boolean isVisible) {
479 pageEndTransition();
480 super.onVisibilityAggregated(isVisible);
481 }
482
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700483 protected boolean isPageInTransition() {
484 return mIsPageInTransition;
Adam Cohen26976d92011-03-22 15:33:33 -0700485 }
486
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700487 /**
488 * Called when the page starts moving as part of the scroll. Subclasses can override this
489 * to provide custom behavior during animation.
490 */
491 protected void onPageBeginTransition() {
Patrick Dubroy1262e362010-10-06 15:49:50 -0700492 }
493
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700494 /**
495 * Called when the page ends moving as part of the scroll. Subclasses can override this
496 * to provide custom behavior during animation.
497 */
498 protected void onPageEndTransition() {
Alex Chauba61b982021-06-15 16:29:19 +0100499 mCurrentPageScrollDiff = 0;
vadimt4d93df52019-07-10 17:32:58 -0700500 AccessibilityManagerCompat.sendScrollFinishedEventToTest(getContext());
Tony Wickham619daaf2020-02-07 12:29:06 -0800501 AccessibilityManagerCompat.sendCustomAccessibilityEvent(getPageAt(mCurrentPage),
502 AccessibilityEvent.TYPE_VIEW_FOCUSED, null);
Tony Wickham62117d72020-03-26 16:56:26 -0700503 if (mOnPageTransitionEndCallback != null) {
504 mOnPageTransitionEndCallback.run();
505 mOnPageTransitionEndCallback = null;
506 }
507 }
508
509 /**
510 * Sets a callback to run once when the scrolling finishes. If there is currently
511 * no page in transition, then the callback is called immediately.
512 */
513 public void setOnPageTransitionEndCallback(@Nullable Runnable callback) {
514 if (mIsPageInTransition || callback == null) {
515 mOnPageTransitionEndCallback = callback;
516 } else {
517 callback.run();
518 }
Michael Jurka0142d492010-08-25 17:46:15 -0700519 }
520
Adam Cohen68d73932010-11-15 10:50:58 -0800521 @Override
Michael Jurka0142d492010-08-25 17:46:15 -0700522 public void scrollTo(int x, int y) {
Sunny Goyalc39db732021-04-03 01:20:21 -0700523 x = Utilities.boundToRange(x,
524 mOrientationHandler.getPrimaryValue(mMinScroll, 0), mMaxScroll);
525 y = Utilities.boundToRange(y,
526 mOrientationHandler.getPrimaryValue(0, mMinScroll), mMaxScroll);
Vinit Nayaka406f722019-12-19 11:50:55 -0800527 super.scrollTo(x, y);
Michael Jurka0142d492010-08-25 17:46:15 -0700528 }
529
Adam Cohen53805212013-10-01 10:39:23 -0700530 private void sendScrollAccessibilityEvent() {
Sunny Goyald0030b02017-12-08 15:07:24 -0800531 if (isObservedEventType(getContext(), AccessibilityEvent.TYPE_VIEW_SCROLLED)) {
Vadim Tryshevf4715972015-05-08 17:21:03 -0700532 if (mCurrentPage != getNextPage()) {
533 AccessibilityEvent ev =
534 AccessibilityEvent.obtain(AccessibilityEvent.TYPE_VIEW_SCROLLED);
Vadim Tryshev7066c122015-05-21 14:06:35 -0700535 ev.setScrollable(true);
536 ev.setScrollX(getScrollX());
537 ev.setScrollY(getScrollY());
Vinit Nayaka406f722019-12-19 11:50:55 -0800538 mOrientationHandler.setMaxScroll(ev, mMaxScroll);
Vadim Tryshevf4715972015-05-08 17:21:03 -0700539 sendAccessibilityEventUnchecked(ev);
Adam Cohen53805212013-10-01 10:39:23 -0700540 }
Adam Cohen53805212013-10-01 10:39:23 -0700541 }
542 }
543
Vadim Tryshev2c430b32018-04-04 14:45:21 -0700544 protected void announcePageForAccessibility() {
545 if (isAccessibilityEnabled(getContext())) {
546 // Notify the user when the page changes
547 announceForAccessibility(getCurrentPageDescription());
548 }
549 }
550
Winson Chung85425412021-05-10 16:24:14 -0700551 protected boolean computeScrollHelper() {
Winson Chung321e9ee2010-08-09 13:37:56 -0700552 if (mScroller.computeScrollOffset()) {
Winson Chung557d6ed2011-07-08 15:34:52 -0700553 // Don't bother scrolling if the page does not need to be moved
Sunny Goyalc39db732021-04-03 01:20:21 -0700554 int oldPos = mOrientationHandler.getPrimaryScroll(this);
555 int newPos = mScroller.getCurrX();
556 if (oldPos != newPos) {
Alex Chau6499e832021-11-19 14:35:46 +0000557 mOrientationHandler.setPrimary(this, VIEW_SCROLL_TO, mScroller.getCurrX());
Winson Chung557d6ed2011-07-08 15:34:52 -0700558 }
Winson Chung85425412021-05-10 16:24:14 -0700559
560 if (mAllowOverScroll) {
561 if (newPos < mMinScroll && oldPos >= mMinScroll) {
562 mEdgeGlowLeft.onAbsorb((int) mScroller.getCurrVelocity());
Schneider Victor-tuliasa602a0a2022-09-06 13:34:00 -0700563 abortScrollerAnimation(false);
Lais Andradecc5c8842021-06-04 18:20:30 +0100564 onEdgeAbsorbingScroll();
Winson Chung85425412021-05-10 16:24:14 -0700565 } else if (newPos > mMaxScroll && oldPos <= mMaxScroll) {
566 mEdgeGlowRight.onAbsorb((int) mScroller.getCurrVelocity());
Schneider Victor-tuliasa602a0a2022-09-06 13:34:00 -0700567 abortScrollerAnimation(false);
Lais Andradecc5c8842021-06-04 18:20:30 +0100568 onEdgeAbsorbingScroll();
Sunny Goyalc39db732021-04-03 01:20:21 -0700569 }
Tony Wickham95cdb3a2016-02-18 14:37:07 -0800570 }
Adam Cohen53805212013-10-01 10:39:23 -0700571
Winson Chung85425412021-05-10 16:24:14 -0700572 // If the scroller has scrolled to the final position and there is no edge effect, then
573 // finish the scroller to skip waiting for additional settling
574 int finalPos = mOrientationHandler.getPrimaryValue(mScroller.getFinalX(),
575 mScroller.getFinalY());
576 if (newPos == finalPos && mEdgeGlowLeft.isFinished() && mEdgeGlowRight.isFinished()) {
Schneider Victor-tuliasa602a0a2022-09-06 13:34:00 -0700577 abortScrollerAnimation(false);
Winson Chung85425412021-05-10 16:24:14 -0700578 }
579
580 invalidate();
581 return true;
582 } else if (mNextPage != INVALID_PAGE) {
583 sendScrollAccessibilityEvent();
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700584 int prevPage = mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700585 mCurrentPage = validateNewPage(mNextPage);
Lais Andradecc5c8842021-06-04 18:20:30 +0100586 mCurrentScrollOverPage = mCurrentPage;
Winson Chung86f77532010-08-24 11:08:22 -0700587 mNextPage = INVALID_PAGE;
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700588 notifyPageSwitchListener(prevPage);
Winson Chungb44b5242011-06-13 11:32:14 -0700589
Adam Cohen73aa9752010-11-24 16:26:58 -0800590 // We don't want to trigger a page end moving unless the page has settled
591 // and the user has stopped scrolling
Sunny Goyalaad33592018-08-07 17:20:35 -0700592 if (!mIsBeingDragged) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700593 pageEndTransition();
Adam Cohen73aa9752010-11-24 16:26:58 -0800594 }
Winson Chungc27d1bb2011-09-29 12:07:42 -0700595
Vadim Tryshev2c430b32018-04-04 14:45:21 -0700596 if (canAnnouncePageDescription()) {
597 announcePageForAccessibility();
Adam Cohen0ffac432013-07-10 11:19:26 -0700598 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700599 }
Michael Jurka0142d492010-08-25 17:46:15 -0700600 return false;
601 }
602
603 @Override
604 public void computeScroll() {
605 computeScrollHelper();
Winson Chung321e9ee2010-08-09 13:37:56 -0700606 }
607
Sunny Goyalce8809a2018-01-18 14:02:47 -0800608 public int getExpectedHeight() {
609 return getMeasuredHeight();
610 }
611
Adam Cohen410f3cd2013-09-22 12:09:32 -0700612 public int getNormalChildHeight() {
Sunny Goyalce8809a2018-01-18 14:02:47 -0800613 return getExpectedHeight() - getPaddingTop() - getPaddingBottom()
Sunny Goyalac00cba2017-11-13 15:58:01 -0800614 - mInsets.top - mInsets.bottom;
Adam Cohen410f3cd2013-09-22 12:09:32 -0700615 }
616
Sunny Goyalce8809a2018-01-18 14:02:47 -0800617 public int getExpectedWidth() {
618 return getMeasuredWidth();
619 }
620
Sunny Goyalbc683e92017-12-06 10:25:07 -0800621 public int getNormalChildWidth() {
Sunny Goyalce8809a2018-01-18 14:02:47 -0800622 return getExpectedWidth() - getPaddingLeft() - getPaddingRight()
Sunny Goyalbc683e92017-12-06 10:25:07 -0800623 - mInsets.left - mInsets.right;
624 }
625
Andras Kloczlc2bd15f2022-03-30 18:06:13 +0100626 private void updateVelocityValues() {
627 Resources res = getResources();
628 mFlingThresholdVelocity = res.getDimensionPixelSize(R.dimen.fling_threshold_velocity);
629 mEasyFlingThresholdVelocity =
630 res.getDimensionPixelSize(R.dimen.easy_fling_threshold_velocity);
631 mMinFlingVelocity = res.getDimensionPixelSize(R.dimen.min_fling_velocity);
632 mMinSnapVelocity = res.getDimensionPixelSize(R.dimen.min_page_snap_velocity);
633 mPageSnapAnimationDuration = res.getInteger(R.integer.config_pageSnapAnimationDuration);
634 }
635
636 @Override
637 protected void onConfigurationChanged(Configuration newConfig) {
638 super.onConfigurationChanged(newConfig);
639 updateVelocityValues();
640 }
641
Winson Chung321e9ee2010-08-09 13:37:56 -0700642 @Override
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800643 public void requestLayout() {
644 mIsLayoutValid = false;
645 super.requestLayout();
646 }
647
648 @Override
649 public void forceLayout() {
650 mIsLayoutValid = false;
651 super.forceLayout();
652 }
653
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100654 private int getPageWidthSize(int widthSize) {
Thales Lima7a6752d2021-09-23 14:31:00 +0100655 // It's necessary to add the padding back because it is remove when measuring children,
656 // like when MeasureSpec.getSize in CellLayout.
657 return (widthSize - mInsets.left - mInsets.right - getPaddingLeft() - getPaddingRight())
658 / getPanelCount() + getPaddingLeft() + getPaddingRight();
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100659 }
660
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800661 @Override
Winson Chung321e9ee2010-08-09 13:37:56 -0700662 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
Sunny Goyal8e2133b2015-05-06 13:39:07 -0700663 if (getChildCount() == 0) {
Winson Chungf0ea4d32011-06-06 14:27:16 -0700664 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
665 return;
666 }
667
Adam Cohen7d30a372013-07-01 17:03:59 -0700668 // We measure the dimensions of the PagedView to be larger than the pages so that when we
669 // zoom out (and scale down), the view is still contained in the parent
Adam Cohen7d30a372013-07-01 17:03:59 -0700670 int widthMode = MeasureSpec.getMode(widthMeasureSpec);
671 int widthSize = MeasureSpec.getSize(widthMeasureSpec);
672 int heightMode = MeasureSpec.getMode(heightMeasureSpec);
Winson Chung8aad6102012-05-11 16:27:49 -0700673 int heightSize = MeasureSpec.getSize(heightMeasureSpec);
Adam Cohen410f3cd2013-09-22 12:09:32 -0700674
Adam Cohen7d30a372013-07-01 17:03:59 -0700675 if (widthMode == MeasureSpec.UNSPECIFIED || heightMode == MeasureSpec.UNSPECIFIED) {
676 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
677 return;
Winson Chung321e9ee2010-08-09 13:37:56 -0700678 }
679
Winson Chung8aad6102012-05-11 16:27:49 -0700680 // Return early if we aren't given a proper dimension
681 if (widthSize <= 0 || heightSize <= 0) {
682 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
683 return;
684 }
685
Winson Chung321e9ee2010-08-09 13:37:56 -0700686 // The children are given the same width and height as the workspace
Michael Jurka5f1c5092010-09-03 14:15:02 -0700687 // unless they were set to WRAP_CONTENT
Winson Chung785d2eb2011-04-14 16:08:02 -0700688 if (DEBUG) Log.d(TAG, "PagedView.onMeasure(): " + widthSize + ", " + heightSize);
Michael Jurka5f1c5092010-09-03 14:15:02 -0700689
Sunny Goyalac00cba2017-11-13 15:58:01 -0800690 int myWidthSpec = MeasureSpec.makeMeasureSpec(
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100691 getPageWidthSize(widthSize), MeasureSpec.EXACTLY);
Sunny Goyalac00cba2017-11-13 15:58:01 -0800692 int myHeightSpec = MeasureSpec.makeMeasureSpec(
Sunny Goyal228153d2018-01-04 15:35:22 -0800693 heightSize - mInsets.top - mInsets.bottom, MeasureSpec.EXACTLY);
Adam Cohen96d30a12013-07-16 18:13:21 -0700694
Sunny Goyalac00cba2017-11-13 15:58:01 -0800695 // measureChildren takes accounts for content padding, we only need to care about extra
696 // space due to insets.
697 measureChildren(myWidthSpec, myHeightSpec);
698 setMeasuredDimension(widthSize, heightSize);
Adam Cohen60b07122011-11-14 17:26:06 -0800699 }
700
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700701 /** Returns true iff this PagedView's scroll amounts are initialized to each page index. */
702 protected boolean pageScrollsInitialized() {
703 return mPageScrolls != null && mPageScrolls.length == getChildCount();
704 }
705
706 /**
707 * Queues the given callback to be run once {@code mPageScrolls} has been initialized.
708 */
709 public void runOnPageScrollsInitialized(Runnable callback) {
710 mOnPageScrollsInitializedCallbacks.add(callback);
711 if (pageScrollsInitialized()) {
712 onPageScrollsInitialized();
713 }
714 }
715
716 private void onPageScrollsInitialized() {
717 for (Runnable callback : mOnPageScrollsInitializedCallbacks) {
718 callback.run();
719 }
720 mOnPageScrollsInitializedCallbacks.clear();
721 }
722
Sunny Goyalcf25b522015-07-09 00:01:18 -0700723 @SuppressLint("DrawAllocation")
Winson Chung321e9ee2010-08-09 13:37:56 -0700724 @Override
Michael Jurka28750fb2010-09-24 17:43:49 -0700725 protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800726 mIsLayoutValid = true;
Vadim Trysheveb701c62018-05-14 16:00:15 -0700727 final int childCount = getChildCount();
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700728 int[] pageScrolls = mPageScrolls;
Vadim Trysheveb701c62018-05-14 16:00:15 -0700729 boolean pageScrollChanged = false;
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700730 if (!pageScrollsInitialized()) {
731 pageScrolls = new int[childCount];
Vadim Trysheveb701c62018-05-14 16:00:15 -0700732 pageScrollChanged = true;
733 }
734
Winson Chung785d2eb2011-04-14 16:08:02 -0700735 if (DEBUG) Log.d(TAG, "PagedView.onLayout()");
Winson Chung321e9ee2010-08-09 13:37:56 -0700736
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700737 pageScrollChanged |= getPageScrolls(pageScrolls, true, SIMPLE_SCROLL_LOGIC);
738 mPageScrolls = pageScrolls;
Winson Chungc3665fa2011-09-14 17:56:27 -0700739
Winson Chung359cb5d2022-05-26 23:38:48 +0000740 if (childCount == 0) {
741 onPageScrollsInitialized();
742 return;
743 }
744
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700745 final LayoutTransition transition = getLayoutTransition();
746 // If the transition is running defer updating max scroll, as some empty pages could
747 // still be present, and a max scroll change could cause sudden jumps in scroll.
748 if (transition != null && transition.isRunning()) {
749 transition.addTransitionListener(new LayoutTransition.TransitionListener() {
750
751 @Override
752 public void startTransition(LayoutTransition transition, ViewGroup container,
753 View view, int transitionType) { }
754
755 @Override
756 public void endTransition(LayoutTransition transition, ViewGroup container,
757 View view, int transitionType) {
758 // Wait until all transitions are complete.
759 if (!transition.isRunning()) {
760 transition.removeTransitionListener(this);
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700761 updateMinAndMaxScrollX();
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700762 }
763 }
764 });
Adam Cohenf698c6e2013-07-17 18:44:25 -0700765 } else {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700766 updateMinAndMaxScrollX();
Adam Cohenf698c6e2013-07-17 18:44:25 -0700767 }
768
Sunny Goyalcb037ee2015-07-08 16:41:21 -0700769 if (mFirstLayout && mCurrentPage >= 0 && mCurrentPage < childCount) {
770 updateCurrentPageScroll();
771 mFirstLayout = false;
772 }
773
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800774 if (mScroller.isFinished() && pageScrollChanged) {
Alex Chau0733ebd2022-10-07 15:11:09 +0100775 // TODO(b/246283207): Remove logging once root cause of flake detected.
Pat Manning24b95542022-08-09 18:06:58 +0100776 if (Utilities.IS_RUNNING_IN_TEST_HARNESS && !(this instanceof Workspace)) {
Alex Chau0733ebd2022-10-07 15:11:09 +0100777 Log.d("b/246283207", this.getClass().getSimpleName() + "#onLayout() -> "
Pat Manning24b95542022-08-09 18:06:58 +0100778 + "if(mScroller.isFinished() && pageScrollChanged) -> getNextPage(): "
779 + getNextPage() + ", getScrollForPage(getNextPage()): "
780 + getScrollForPage(getNextPage()));
781 }
Sunny Goyalc82c6392018-06-06 15:39:13 -0700782 setCurrentPage(getNextPage());
Adam Cohenf698c6e2013-07-17 18:44:25 -0700783 }
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700784 onPageScrollsInitialized();
Winson Chunge3193b92010-09-10 11:44:42 -0700785 }
786
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700787 /**
788 * Initializes {@code outPageScrolls} with scroll positions for view at that index. The length
789 * of {@code outPageScrolls} should be same as the the childCount
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700790 */
791 protected boolean getPageScrolls(int[] outPageScrolls, boolean layoutChildren,
792 ComputePageScrollsLogic scrollLogic) {
793 final int childCount = getChildCount();
794
795 final int startIndex = mIsRtl ? childCount - 1 : 0;
796 final int endIndex = mIsRtl ? -1 : childCount;
797 final int delta = mIsRtl ? -1 : 1;
798
Vinit Nayaka406f722019-12-19 11:50:55 -0800799 final int pageCenter = mOrientationHandler.getCenterForPage(this, mInsets);
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700800
Vinit Nayaka406f722019-12-19 11:50:55 -0800801 final int scrollOffsetStart = mOrientationHandler.getScrollOffsetStart(this, mInsets);
802 final int scrollOffsetEnd = mOrientationHandler.getScrollOffsetEnd(this, mInsets);
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700803 boolean pageScrollChanged = false;
Thales Limae4457742021-07-20 16:46:38 +0100804 int panelCount = getPanelCount();
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700805
Vinit Nayaka406f722019-12-19 11:50:55 -0800806 for (int i = startIndex, childStart = scrollOffsetStart; i != endIndex; i += delta) {
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700807 final View child = getPageAt(i);
808 if (scrollLogic.shouldIncludeView(child)) {
Vinit Nayaka406f722019-12-19 11:50:55 -0800809 ChildBounds bounds = mOrientationHandler.getChildBounds(child, childStart,
810 pageCenter, layoutChildren);
811 final int primaryDimension = bounds.primaryDimension;
812 final int childPrimaryEnd = bounds.childPrimaryEnd;
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700813
Alex Chaub5c4d112021-03-29 17:37:53 +0100814 // In case the pages are of different width, align the page to left edge for non-RTL
815 // or right edge for RTL.
816 final int pageScroll =
817 mIsRtl ? childPrimaryEnd - scrollOffsetEnd : childStart - scrollOffsetStart;
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700818 if (outPageScrolls[i] != pageScroll) {
819 pageScrollChanged = true;
820 outPageScrolls[i] = pageScroll;
821 }
Alex Chau2e487602022-03-15 19:34:08 +0000822 childStart += primaryDimension + getChildGap(i, i + delta);
Thales Limae4457742021-07-20 16:46:38 +0100823
824 // This makes sure that the space is added after the page, not after each panel
Thales Limac2a6f6f2021-09-09 17:06:22 +0100825 int lastPanel = mIsRtl ? 0 : panelCount - 1;
826 if (i % panelCount == lastPanel) {
Thales Limae4457742021-07-20 16:46:38 +0100827 childStart += mPageSpacing;
828 }
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700829 }
830 }
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100831
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100832 if (panelCount > 1) {
833 for (int i = 0; i < childCount; i++) {
Alex Chau1e448462021-08-13 21:48:35 +0100834 // In case we have multiple panels, always use left most panel's page scroll for all
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100835 // panels on the screen.
836 int adjustedScroll = outPageScrolls[getLeftmostVisiblePageForIndex(i)];
837 if (outPageScrolls[i] != adjustedScroll) {
838 outPageScrolls[i] = adjustedScroll;
839 pageScrollChanged = true;
840 }
841 }
842 }
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700843 return pageScrollChanged;
844 }
845
Alex Chau2e487602022-03-15 19:34:08 +0000846 protected int getChildGap(int fromIndex, int toIndex) {
Sunny Goyala1fbd842015-05-20 13:40:27 -0700847 return 0;
848 }
849
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700850 protected void updateMinAndMaxScrollX() {
Vinit Nayaka406f722019-12-19 11:50:55 -0800851 mMinScroll = computeMinScroll();
852 mMaxScroll = computeMaxScroll();
Tony Wickhamf549dab2016-05-16 09:54:06 -0700853 }
854
Vinit Nayaka406f722019-12-19 11:50:55 -0800855 protected int computeMinScroll() {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700856 return 0;
Tony50876bf2018-09-19 23:09:14 -0400857 }
858
Vinit Nayaka406f722019-12-19 11:50:55 -0800859 protected int computeMaxScroll() {
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700860 int childCount = getChildCount();
861 if (childCount > 0) {
Sunny Goyal70660032015-05-14 00:07:08 -0700862 final int index = mIsRtl ? 0 : childCount - 1;
Tony Wickhamf549dab2016-05-16 09:54:06 -0700863 return getScrollForPage(index);
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700864 } else {
Tony Wickhamf549dab2016-05-16 09:54:06 -0700865 return 0;
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700866 }
867 }
868
Adam Cohen3b185e22013-10-29 14:45:58 -0700869 public void setPageSpacing(int pageSpacing) {
870 mPageSpacing = pageSpacing;
871 requestLayout();
872 }
873
Tony50876bf2018-09-19 23:09:14 -0400874 public int getPageSpacing() {
875 return mPageSpacing;
876 }
877
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800878 private void dispatchPageCountChanged() {
879 if (mPageIndicator != null) {
Tony Wickhambab101c2021-09-20 15:12:44 -0700880 mPageIndicator.setMarkersCount(getChildCount() / getPanelCount());
Winson Chungd2be3812013-07-16 11:11:32 -0700881 }
Adam Cohen2591f6a2011-10-25 14:36:40 -0700882 // This ensures that when children are added, they get the correct transforms / alphas
883 // in accordance with any scroll effects.
Adam Cohen2591f6a2011-10-25 14:36:40 -0700884 invalidate();
885 }
886
Michael Jurka8b805b12012-04-18 14:23:14 -0700887 @Override
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800888 public void onViewAdded(View child) {
Winson Chungc7c51582018-02-23 17:58:36 -0800889 super.onViewAdded(child);
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800890 dispatchPageCountChanged();
891 }
892
893 @Override
894 public void onViewRemoved(View child) {
Winson Chungc7c51582018-02-23 17:58:36 -0800895 super.onViewRemoved(child);
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700896 runOnPageScrollsInitialized(() -> {
897 mCurrentPage = validateNewPage(mCurrentPage);
898 mCurrentScrollOverPage = mCurrentPage;
899 });
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800900 dispatchPageCountChanged();
Winson Chungd2be3812013-07-16 11:11:32 -0700901 }
902
Adam Cohen73894962011-10-31 13:17:17 -0700903 protected int getChildOffset(int index) {
Adam Cohen7d30a372013-07-01 17:03:59 -0700904 if (index < 0 || index > getChildCount() - 1) return 0;
Vinit Nayaka406f722019-12-19 11:50:55 -0800905 View pageAtIndex = getPageAt(index);
906 return mOrientationHandler.getChildStart(pageAtIndex);
Adam Cohen73894962011-10-31 13:17:17 -0700907 }
908
Alex Chau7944ee52021-01-08 19:07:25 +0000909 protected int getChildVisibleSize(int index) {
910 View layout = getPageAt(index);
911 return mOrientationHandler.getMeasuredSize(layout);
912 }
913
Winson Chung321e9ee2010-08-09 13:37:56 -0700914 @Override
915 public boolean requestChildRectangleOnScreen(View child, Rect rectangle, boolean immediate) {
Andras Kloczl7e912442021-05-06 12:50:28 +0200916 int page = indexOfChild(child);
917 if (!isVisible(page) || !mScroller.isFinished()) {
Vadim Trysheveeaa8ee2018-04-11 12:23:42 -0700918 if (immediate) {
919 setCurrentPage(page);
920 } else {
921 snapToPage(page);
922 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700923 return true;
924 }
925 return false;
926 }
927
928 @Override
929 protected boolean onRequestFocusInDescendants(int direction, Rect previouslyFocusedRect) {
Winson Chung86f77532010-08-24 11:08:22 -0700930 int focusablePage;
931 if (mNextPage != INVALID_PAGE) {
932 focusablePage = mNextPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700933 } else {
Winson Chung86f77532010-08-24 11:08:22 -0700934 focusablePage = mCurrentPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700935 }
Winson Chung86f77532010-08-24 11:08:22 -0700936 View v = getPageAt(focusablePage);
Winson Chung321e9ee2010-08-09 13:37:56 -0700937 if (v != null) {
Adam Cohen76fc0852011-06-17 13:26:23 -0700938 return v.requestFocus(direction, previouslyFocusedRect);
Winson Chung321e9ee2010-08-09 13:37:56 -0700939 }
940 return false;
941 }
942
943 @Override
944 public boolean dispatchUnhandledMove(View focused, int direction) {
Sunny Goyal0c4e3722015-12-01 13:21:49 -0800945 if (super.dispatchUnhandledMove(focused, direction)) {
946 return true;
947 }
948
949 if (mIsRtl) {
950 if (direction == View.FOCUS_LEFT) {
951 direction = View.FOCUS_RIGHT;
952 } else if (direction == View.FOCUS_RIGHT) {
953 direction = View.FOCUS_LEFT;
954 }
955 }
Andras Kloczl7e912442021-05-06 12:50:28 +0200956
957 int currentPage = getNextPage();
958 int closestNeighbourIndex = -1;
959 int closestNeighbourDistance = Integer.MAX_VALUE;
960 // Find the closest neighbour page
961 for (int neighbourPageIndex : getNeighbourPageIndices(direction)) {
962 int distance = Math.abs(neighbourPageIndex - currentPage);
963 if (closestNeighbourDistance > distance) {
964 closestNeighbourDistance = distance;
965 closestNeighbourIndex = neighbourPageIndex;
Winson Chung321e9ee2010-08-09 13:37:56 -0700966 }
967 }
Andras Kloczl7e912442021-05-06 12:50:28 +0200968 if (closestNeighbourIndex != -1) {
969 View page = getPageAt(closestNeighbourIndex);
970 snapToPage(closestNeighbourIndex);
971 page.requestFocus(direction);
972 return true;
973 }
974
Sunny Goyal0c4e3722015-12-01 13:21:49 -0800975 return false;
Winson Chung321e9ee2010-08-09 13:37:56 -0700976 }
977
978 @Override
979 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) {
Jon Miranda6a858172016-10-25 16:19:17 -0700980 if (getDescendantFocusability() == FOCUS_BLOCK_DESCENDANTS) {
981 return;
982 }
983
Andras Kloczl7e912442021-05-06 12:50:28 +0200984 // nextPage is more reliable when multiple control movements have been done in a short
985 // period of time
986 getPageIndices(getNextPage())
987 .addAll(getNeighbourPageIndices(direction))
988 .forEach(pageIndex ->
989 getPageAt(pageIndex).addFocusables(views, direction, focusableMode));
Winson Chung321e9ee2010-08-09 13:37:56 -0700990 }
991
992 /**
993 * If one of our descendant views decides that it could be focused now, only
Winson Chung86f77532010-08-24 11:08:22 -0700994 * pass that along if it's on the current page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700995 *
Winson Chung86f77532010-08-24 11:08:22 -0700996 * This happens when live folders requery, and if they're off page, they
997 * end up calling requestFocus, which pulls it on page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700998 */
999 @Override
1000 public void focusableViewAvailable(View focused) {
Winson Chung86f77532010-08-24 11:08:22 -07001001 View current = getPageAt(mCurrentPage);
Winson Chung321e9ee2010-08-09 13:37:56 -07001002 View v = focused;
1003 while (true) {
1004 if (v == current) {
1005 super.focusableViewAvailable(focused);
1006 return;
1007 }
1008 if (v == this) {
1009 return;
1010 }
1011 ViewParent parent = v.getParent();
1012 if (parent instanceof View) {
1013 v = (View)v.getParent();
1014 } else {
1015 return;
1016 }
1017 }
1018 }
1019
1020 /**
1021 * {@inheritDoc}
1022 */
1023 @Override
1024 public void requestDisallowInterceptTouchEvent(boolean disallowIntercept) {
1025 if (disallowIntercept) {
1026 // We need to make sure to cancel our long press if
1027 // a scrollable widget takes over touch events
Andras Kloczl7a1ca0b2021-04-08 16:08:16 +02001028 cancelCurrentPageLongPress();
Winson Chung321e9ee2010-08-09 13:37:56 -07001029 }
1030 super.requestDisallowInterceptTouchEvent(disallowIntercept);
1031 }
1032
1033 @Override
1034 public boolean onInterceptTouchEvent(MotionEvent ev) {
1035 /*
1036 * This method JUST determines whether we want to intercept the motion.
1037 * If we return true, onTouchEvent will be called and we do the actual
1038 * scrolling there.
1039 */
1040
Winson Chung45e1d6e2010-11-09 17:19:49 -08001041 // Skip touch handling if there are no pages to swipe
Tony Wickhamb6841ac2019-07-22 12:39:59 -07001042 if (getChildCount() <= 0) return false;
Sunny Goyalc4bb3732019-06-20 11:34:14 -07001043
1044 acquireVelocityTrackerAndAddMovement(ev);
Winson Chung45e1d6e2010-11-09 17:19:49 -08001045
Winson Chung321e9ee2010-08-09 13:37:56 -07001046 /*
1047 * Shortcut the most recurring case: the user is in the dragging
1048 * state and he is moving his finger. We want to intercept this
1049 * motion.
1050 */
1051 final int action = ev.getAction();
Sunny Goyalaad33592018-08-07 17:20:35 -07001052 if ((action == MotionEvent.ACTION_MOVE) && mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001053 return true;
1054 }
1055
Winson Chung321e9ee2010-08-09 13:37:56 -07001056 switch (action & MotionEvent.ACTION_MASK) {
1057 case MotionEvent.ACTION_MOVE: {
1058 /*
1059 * mIsBeingDragged == false, otherwise the shortcut would have caught it. Check
Vinit Nayaka406f722019-12-19 11:50:55 -08001060 * whether the user has moved far enough from their original down touch.
Winson Chung321e9ee2010-08-09 13:37:56 -07001061 */
Michael Jurka1ff706b2010-09-14 17:35:20 -07001062 if (mActivePointerId != INVALID_POINTER) {
1063 determineScrollingStart(ev);
Michael Jurka1ff706b2010-09-14 17:35:20 -07001064 }
1065 // if mActivePointerId is INVALID_POINTER, then we must have missed an ACTION_DOWN
Vinit Nayaka406f722019-12-19 11:50:55 -08001066 // event. in that case, treat the first occurrence of a move event as a ACTION_DOWN
Michael Jurka1ff706b2010-09-14 17:35:20 -07001067 // i.e. fall through to the next case (don't break)
1068 // (We sometimes miss ACTION_DOWN events in Workspace because it ignores all events
1069 // while it's small- this was causing a crash before we checked for INVALID_POINTER)
Adam Cohen93c97562013-09-26 13:48:01 -07001070 break;
Winson Chung321e9ee2010-08-09 13:37:56 -07001071 }
1072
1073 case MotionEvent.ACTION_DOWN: {
1074 final float x = ev.getX();
1075 final float y = ev.getY();
1076 // Remember location of down touch
1077 mDownMotionX = x;
Adam Cohen7d30a372013-07-01 17:03:59 -07001078 mDownMotionY = y;
Jon Mirandaf52af432020-04-10 17:25:57 -07001079 mDownMotionPrimary = mLastMotion = mOrientationHandler.getPrimaryDirection(ev, 0);
Vinit Nayaka406f722019-12-19 11:50:55 -08001080 mLastMotionRemainder = 0;
1081 mTotalMotion = 0;
Winson Chung4941f652020-06-18 15:11:53 -07001082 mAllowEasyFling = false;
Winson Chung321e9ee2010-08-09 13:37:56 -07001083 mActivePointerId = ev.getPointerId(0);
Sunny Goyalc39db732021-04-03 01:20:21 -07001084 updateIsBeingDraggedOnTouchDown(ev);
Winson Chung321e9ee2010-08-09 13:37:56 -07001085 break;
1086 }
1087
Winson Chung321e9ee2010-08-09 13:37:56 -07001088 case MotionEvent.ACTION_UP:
Jeff Brown1d0867c2010-12-02 18:27:39 -08001089 case MotionEvent.ACTION_CANCEL:
Adam Cohen7d30a372013-07-01 17:03:59 -07001090 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001091 break;
1092
1093 case MotionEvent.ACTION_POINTER_UP:
1094 onSecondaryPointerUp(ev);
Adam Cohen6342bba2011-03-10 11:33:35 -08001095 releaseVelocityTracker();
Winson Chung321e9ee2010-08-09 13:37:56 -07001096 break;
1097 }
1098
1099 /*
1100 * The only time we want to intercept motion events is if we are in the
1101 * drag mode.
1102 */
Sunny Goyalaad33592018-08-07 17:20:35 -07001103 return mIsBeingDragged;
Winson Chung321e9ee2010-08-09 13:37:56 -07001104 }
1105
Tony Wickhama0aee212019-09-18 09:24:03 -07001106 /**
1107 * If being flinged and user touches the screen, initiate drag; otherwise don't.
1108 */
Sunny Goyalbb030562021-07-19 16:28:39 -07001109 protected void updateIsBeingDraggedOnTouchDown(MotionEvent ev) {
Tony Wickhama0aee212019-09-18 09:24:03 -07001110 // mScroller.isFinished should be false when being flinged.
Sunny Goyalc39db732021-04-03 01:20:21 -07001111 final int xDist = Math.abs(mScroller.getFinalX() - mScroller.getCurrX());
Winson Chung4941f652020-06-18 15:11:53 -07001112 final boolean finishedScrolling = (mScroller.isFinished() || xDist < mPageSlop / 3);
Tony Wickhama0aee212019-09-18 09:24:03 -07001113
1114 if (finishedScrolling) {
1115 mIsBeingDragged = false;
1116 if (!mScroller.isFinished() && !mFreeScroll) {
1117 setCurrentPage(getNextPage());
1118 pageEndTransition();
1119 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001120 mIsBeingDragged = !mEdgeGlowLeft.isFinished() || !mEdgeGlowRight.isFinished();
Tony Wickhama0aee212019-09-18 09:24:03 -07001121 } else {
1122 mIsBeingDragged = true;
1123 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001124
1125 // Catch the edge effect if it is active.
1126 float displacement = mOrientationHandler.getSecondaryValue(ev.getX(), ev.getY())
1127 / mOrientationHandler.getSecondaryValue(getWidth(), getHeight());
1128 if (!mEdgeGlowLeft.isFinished()) {
1129 mEdgeGlowLeft.onPullDistance(0f, 1f - displacement);
1130 }
1131 if (!mEdgeGlowRight.isFinished()) {
1132 mEdgeGlowRight.onPullDistance(0f, displacement);
1133 }
Tony Wickhama0aee212019-09-18 09:24:03 -07001134 }
1135
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001136 public boolean isHandlingTouch() {
Sunny Goyalaad33592018-08-07 17:20:35 -07001137 return mIsBeingDragged;
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001138 }
1139
Adam Cohenf8d28232011-02-01 21:47:00 -08001140 protected void determineScrollingStart(MotionEvent ev) {
1141 determineScrollingStart(ev, 1.0f);
1142 }
1143
Winson Chung321e9ee2010-08-09 13:37:56 -07001144 /*
1145 * Determines if we should change the touch state to start scrolling after the
1146 * user moves their touch point too far.
1147 */
Adam Cohenf8d28232011-02-01 21:47:00 -08001148 protected void determineScrollingStart(MotionEvent ev, float touchSlopScale) {
Adam Cohen7d30a372013-07-01 17:03:59 -07001149 // Disallow scrolling if we don't have a valid pointer index
Winson Chung321e9ee2010-08-09 13:37:56 -07001150 final int pointerIndex = ev.findPointerIndex(mActivePointerId);
Adam Cohen7d30a372013-07-01 17:03:59 -07001151 if (pointerIndex == -1) return;
1152
Vinit Nayaka406f722019-12-19 11:50:55 -08001153 final float primaryDirection = mOrientationHandler.getPrimaryDirection(ev, pointerIndex);
1154 final int diff = (int) Math.abs(primaryDirection - mLastMotion);
Adam Cohenf8d28232011-02-01 21:47:00 -08001155 final int touchSlop = Math.round(touchSlopScale * mTouchSlop);
Winson Chung4941f652020-06-18 15:11:53 -07001156 boolean moved = diff > touchSlop || ev.getAction() == ACTION_MOVE_ALLOW_EASY_FLING;
Winson Chung321e9ee2010-08-09 13:37:56 -07001157
Vinit Nayaka406f722019-12-19 11:50:55 -08001158 if (moved) {
Sunny Goyal5a1f53b2015-05-27 10:24:24 -07001159 // Scroll if the user moved far enough along the X axis
Sunny Goyalaad33592018-08-07 17:20:35 -07001160 mIsBeingDragged = true;
Vinit Nayaka406f722019-12-19 11:50:55 -08001161 mTotalMotion += Math.abs(mLastMotion - primaryDirection);
1162 mLastMotion = primaryDirection;
1163 mLastMotionRemainder = 0;
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001164 pageBeginTransition();
Tony Wickhamdadb3042016-02-24 11:07:00 -08001165 // Stop listening for things like pinches.
1166 requestDisallowInterceptTouchEvent(true);
Adam Cohenf8d28232011-02-01 21:47:00 -08001167 }
1168 }
1169
1170 protected void cancelCurrentPageLongPress() {
Sunny Goyal8e2133b2015-05-06 13:39:07 -07001171 // Try canceling the long press. It could also have been scheduled
1172 // by a distant descendant, so use the mAllowLongPress flag to block
1173 // everything
Sunny Goyal59969372021-05-06 12:11:44 -07001174 forEachVisiblePage(View::cancelLongPress);
Winson Chung321e9ee2010-08-09 13:37:56 -07001175 }
1176
Adam Cohenb5ba0972011-09-07 18:02:31 -07001177 protected float getScrollProgress(int screenCenter, View v, int page) {
Sunny Goyal228153d2018-01-04 15:35:22 -08001178 final int halfScreenSize = getMeasuredWidth() / 2;
Adam Cohenedb40762013-07-18 16:45:45 -07001179 int delta = screenCenter - (getScrollForPage(page) + halfScreenSize);
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001180 int panelCount = getPanelCount();
1181 int pageCount = getChildCount();
Adam Cohen3b185e22013-10-29 14:45:58 -07001182
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001183 int adjacentPage = page + panelCount;
Sunny Goyal70660032015-05-14 00:07:08 -07001184 if ((delta < 0 && !mIsRtl) || (delta > 0 && mIsRtl)) {
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001185 adjacentPage = page - panelCount;
Adam Cohen3b185e22013-10-29 14:45:58 -07001186 }
1187
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001188 final int totalDistance;
1189 if (adjacentPage < 0 || adjacentPage > pageCount - 1) {
1190 totalDistance = (v.getMeasuredWidth() + mPageSpacing) * panelCount;
Adam Cohen3b185e22013-10-29 14:45:58 -07001191 } else {
1192 totalDistance = Math.abs(getScrollForPage(adjacentPage) - getScrollForPage(page));
1193 }
Adam Cohenb5ba0972011-09-07 18:02:31 -07001194
1195 float scrollProgress = delta / (totalDistance * 1.0f);
Sunny Goyal8e2133b2015-05-06 13:39:07 -07001196 scrollProgress = Math.min(scrollProgress, MAX_SCROLL_PROGRESS);
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001197 scrollProgress = Math.max(scrollProgress, -MAX_SCROLL_PROGRESS);
Adam Cohenb5ba0972011-09-07 18:02:31 -07001198 return scrollProgress;
1199 }
1200
Adam Cohenedb40762013-07-18 16:45:45 -07001201 public int getScrollForPage(int index) {
Tony Wickhambed0d632022-06-14 15:51:09 -07001202 if (!pageScrollsInitialized() || index >= mPageScrolls.length || index < 0) {
Adam Cohenedb40762013-07-18 16:45:45 -07001203 return 0;
1204 } else {
1205 return mPageScrolls[index];
1206 }
1207 }
1208
Adam Cohen564a2e72013-10-09 14:47:32 -07001209 // While layout transitions are occurring, a child's position may stray from its baseline
1210 // position. This method returns the magnitude of this stray at any given time.
1211 public int getLayoutTransitionOffsetForPage(int index) {
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -07001212 if (!pageScrollsInitialized() || index >= mPageScrolls.length || index < 0) {
Adam Cohen564a2e72013-10-09 14:47:32 -07001213 return 0;
1214 } else {
1215 View child = getChildAt(index);
Adam Cohen3b185e22013-10-29 14:45:58 -07001216
Sunny Goyal228153d2018-01-04 15:35:22 -08001217 int scrollOffset = mIsRtl ? getPaddingRight() : getPaddingLeft();
1218 int baselineX = mPageScrolls[index] + scrollOffset;
Adam Cohen564a2e72013-10-09 14:47:32 -07001219 return (int) (child.getX() - baselineX);
1220 }
1221 }
1222
Tony Wickham023f4042019-01-29 10:52:31 -08001223 public void setEnableFreeScroll(boolean freeScroll) {
Winson Chung0e449002019-04-26 11:09:58 -07001224 if (mFreeScroll == freeScroll) {
1225 return;
1226 }
1227
Tony Wickham8f7ead32016-04-07 18:46:44 -07001228 boolean wasFreeScroll = mFreeScroll;
Adam Cohenf358a4b2013-07-23 16:47:31 -07001229 mFreeScroll = freeScroll;
1230
Adam Cohenf9618852013-11-08 06:45:03 -08001231 if (mFreeScroll) {
Sunny Goyal4d519f22017-10-24 10:32:40 -07001232 setCurrentPage(getNextPage());
Tony Wickham8f7ead32016-04-07 18:46:44 -07001233 } else if (wasFreeScroll) {
Tony Wickhamaf33f2c2019-10-04 12:55:22 -07001234 if (getScrollForPage(getNextPage()) != getScrollX()) {
1235 snapToPage(getNextPage());
1236 }
Adam Cohenf358a4b2013-07-23 16:47:31 -07001237 }
Adam Cohenf358a4b2013-07-23 16:47:31 -07001238 }
1239
Sunny Goyal2f0ec852015-03-26 13:38:27 -07001240 protected void setEnableOverscroll(boolean enable) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001241 mAllowOverScroll = enable;
1242 }
1243
Andras Kloczl07111f22022-03-30 17:25:54 +01001244 protected boolean isSignificantMove(float absoluteDelta, int pageOrientedSize) {
1245 return absoluteDelta > pageOrientedSize * SIGNIFICANT_MOVE_THRESHOLD;
Alex Chau822acf42021-06-03 11:35:05 +01001246 }
1247
Winson Chung321e9ee2010-08-09 13:37:56 -07001248 @Override
1249 public boolean onTouchEvent(MotionEvent ev) {
Winson Chung45e1d6e2010-11-09 17:19:49 -08001250 // Skip touch handling if there are no pages to swipe
Tony Wickhamb6841ac2019-07-22 12:39:59 -07001251 if (getChildCount() <= 0) return false;
Winson Chung45e1d6e2010-11-09 17:19:49 -08001252
Michael Jurkab8f06722010-10-10 15:58:46 -07001253 acquireVelocityTrackerAndAddMovement(ev);
Winson Chung321e9ee2010-08-09 13:37:56 -07001254
1255 final int action = ev.getAction();
1256
1257 switch (action & MotionEvent.ACTION_MASK) {
1258 case MotionEvent.ACTION_DOWN:
Sunny Goyalc39db732021-04-03 01:20:21 -07001259 updateIsBeingDraggedOnTouchDown(ev);
Tony Wickhama0aee212019-09-18 09:24:03 -07001260
Winson Chung321e9ee2010-08-09 13:37:56 -07001261 /*
1262 * If being flinged and user touches, stop the fling. isFinished
1263 * will be false if being flinged.
1264 */
1265 if (!mScroller.isFinished()) {
Adam Cohen8bdbaab2013-10-29 15:25:02 -07001266 abortScrollerAnimation(false);
Winson Chung321e9ee2010-08-09 13:37:56 -07001267 }
1268
1269 // Remember where the motion event started
Vinit Nayaka406f722019-12-19 11:50:55 -08001270 mDownMotionX = ev.getX();
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001271 mDownMotionY = ev.getY();
Vinit Nayaka406f722019-12-19 11:50:55 -08001272 mDownMotionPrimary = mLastMotion = mOrientationHandler.getPrimaryDirection(ev, 0);
1273 mLastMotionRemainder = 0;
1274 mTotalMotion = 0;
Winson Chung4941f652020-06-18 15:11:53 -07001275 mAllowEasyFling = false;
Winson Chung321e9ee2010-08-09 13:37:56 -07001276 mActivePointerId = ev.getPointerId(0);
Sunny Goyalaad33592018-08-07 17:20:35 -07001277 if (mIsBeingDragged) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001278 pageBeginTransition();
Michael Jurka0142d492010-08-25 17:46:15 -07001279 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001280 break;
1281
Winson Chung4941f652020-06-18 15:11:53 -07001282 case ACTION_MOVE_ALLOW_EASY_FLING:
1283 // Start scrolling immediately
1284 determineScrollingStart(ev);
1285 mAllowEasyFling = true;
1286 break;
1287
1288 case MotionEvent.ACTION_MOVE:
1289 if (mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001290 // Scroll to follow the motion event
1291 final int pointerIndex = ev.findPointerIndex(mActivePointerId);
Adam Cohen7d30a372013-07-01 17:03:59 -07001292
1293 if (pointerIndex == -1) return true;
Sunny Goyalc39db732021-04-03 01:20:21 -07001294 float oldScroll = mOrientationHandler.getPrimaryScroll(this);
1295 float dx = ev.getX(pointerIndex);
1296 float dy = ev.getY(pointerIndex);
Adam Cohen7d30a372013-07-01 17:03:59 -07001297
Sunny Goyalc39db732021-04-03 01:20:21 -07001298 float direction = mOrientationHandler.getPrimaryValue(dx, dy);
Vinit Nayaka406f722019-12-19 11:50:55 -08001299 float delta = mLastMotion + mLastMotionRemainder - direction;
Sunny Goyalc39db732021-04-03 01:20:21 -07001300
1301 int width = getWidth();
1302 int height = getHeight();
1303 int size = mOrientationHandler.getPrimaryValue(width, height);
1304
1305 final float displacement = mOrientationHandler.getSecondaryValue(dx, dy)
1306 / mOrientationHandler.getSecondaryValue(width, height);
Vinit Nayaka406f722019-12-19 11:50:55 -08001307 mTotalMotion += Math.abs(delta);
Adam Cohenaefd4e12011-02-14 16:39:38 -08001308
Sunny Goyalc39db732021-04-03 01:20:21 -07001309 if (mAllowOverScroll) {
1310 float consumed = 0;
1311 if (delta < 0 && mEdgeGlowRight.getDistance() != 0f) {
1312 consumed = size * mEdgeGlowRight.onPullDistance(delta / size, displacement);
1313 } else if (delta > 0 && mEdgeGlowLeft.getDistance() != 0f) {
1314 consumed = -size * mEdgeGlowLeft.onPullDistance(
1315 -delta / size, 1 - displacement);
1316 }
1317 delta -= consumed;
1318 }
Alex Chau822acf42021-06-03 11:35:05 +01001319 delta /= mOrientationHandler.getPrimaryScale(this);
Sunny Goyalc39db732021-04-03 01:20:21 -07001320
Winson Chungc0844aa2011-02-02 15:25:58 -08001321 // Only scroll and update mLastMotionX if we have moved some discrete amount. We
1322 // keep the remainder because we are actually testing if we've moved from the last
1323 // scrolled position (which is discrete).
Sunny Goyalc39db732021-04-03 01:20:21 -07001324 mLastMotion = direction;
1325 int movedDelta = (int) delta;
1326 mLastMotionRemainder = delta - movedDelta;
Vinit Nayaka406f722019-12-19 11:50:55 -08001327
Sunny Goyalc39db732021-04-03 01:20:21 -07001328 if (delta != 0) {
Alex Chau6499e832021-11-19 14:35:46 +00001329 mOrientationHandler.setPrimary(this, VIEW_SCROLL_BY, movedDelta);
Sunny Goyalc39db732021-04-03 01:20:21 -07001330
1331 if (mAllowOverScroll) {
1332 final float pulledToX = oldScroll + delta;
1333
1334 if (pulledToX < mMinScroll) {
1335 mEdgeGlowLeft.onPullDistance(-delta / size, 1.f - displacement);
1336 if (!mEdgeGlowRight.isFinished()) {
1337 mEdgeGlowRight.onRelease();
1338 }
1339 } else if (pulledToX > mMaxScroll) {
1340 mEdgeGlowRight.onPullDistance(delta / size, displacement);
1341 if (!mEdgeGlowLeft.isFinished()) {
1342 mEdgeGlowLeft.onRelease();
1343 }
1344 }
1345
1346 if (!mEdgeGlowLeft.isFinished() || !mEdgeGlowRight.isFinished()) {
1347 postInvalidateOnAnimation();
1348 }
1349 }
1350
Winson Chung321e9ee2010-08-09 13:37:56 -07001351 } else {
1352 awakenScrollBars();
1353 }
Adam Cohen564976a2010-10-13 18:52:07 -07001354 } else {
Winson Chung321e9ee2010-08-09 13:37:56 -07001355 determineScrollingStart(ev);
1356 }
1357 break;
1358
1359 case MotionEvent.ACTION_UP:
Sunny Goyalaad33592018-08-07 17:20:35 -07001360 if (mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001361 final int activePointerId = mActivePointerId;
1362 final int pointerIndex = ev.findPointerIndex(activePointerId);
Vinit Nayak93bf1fe2020-05-26 17:22:13 -07001363 if (pointerIndex == -1) return true;
1364
Vinit Nayaka406f722019-12-19 11:50:55 -08001365 final float primaryDirection = mOrientationHandler.getPrimaryDirection(ev,
1366 pointerIndex);
Sunny Goyal4bb8b062019-02-19 16:37:38 -08001367 final VelocityTracker velocityTracker = mVelocityTracker;
1368 velocityTracker.computeCurrentVelocity(1000, mMaximumVelocity);
Adam Cohenaefd4e12011-02-14 16:39:38 -08001369
Vinit Nayaka406f722019-12-19 11:50:55 -08001370 int velocity = (int) mOrientationHandler.getPrimaryVelocity(velocityTracker,
Andras Kloczl07111f22022-03-30 17:25:54 +01001371 mActivePointerId);
Alex Chau822acf42021-06-03 11:35:05 +01001372 float delta = primaryDirection - mDownMotionPrimary;
Andras Kloczl07111f22022-03-30 17:25:54 +01001373 int pageOrientedSize = (int) (mOrientationHandler.getMeasuredSize(
1374 getPageAt(mCurrentPage))
1375 * mOrientationHandler.getPrimaryScale(this));
1376 boolean isSignificantMove = isSignificantMove(Math.abs(delta), pageOrientedSize);
Vinit Nayaka406f722019-12-19 11:50:55 -08001377
1378 mTotalMotion += Math.abs(mLastMotion + mLastMotionRemainder - primaryDirection);
Winson Chung4941f652020-06-18 15:11:53 -07001379 boolean passedSlop = mAllowEasyFling || mTotalMotion > mPageSlop;
1380 boolean isFling = passedSlop && shouldFlingForVelocity(velocity);
Vinit Nayaka406f722019-12-19 11:50:55 -08001381 boolean isDeltaLeft = mIsRtl ? delta > 0 : delta < 0;
1382 boolean isVelocityLeft = mIsRtl ? velocity > 0 : velocity < 0;
Winson Chung4941f652020-06-18 15:11:53 -07001383 if (DEBUG_FAILED_QUICKSWITCH && !isFling && mAllowEasyFling) {
1384 Log.d("Quickswitch", "isFling=false vel=" + velocity
1385 + " threshold=" + mEasyFlingThresholdVelocity);
1386 }
Adam Cohen00481b32011-11-18 12:03:48 -08001387
Adam Cohenf358a4b2013-07-23 16:47:31 -07001388 if (!mFreeScroll) {
1389 // In the case that the page is moved far to one direction and then is flung
1390 // in the opposite direction, we use a threshold to determine whether we should
1391 // just return to the starting page, or if we should skip one further.
1392 boolean returnToOriginalPage = false;
Vinit Nayaka406f722019-12-19 11:50:55 -08001393 if (Math.abs(delta) > pageOrientedSize * RETURN_TO_ORIGINAL_PAGE_THRESHOLD &&
1394 Math.signum(velocity) != Math.signum(delta) && isFling) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001395 returnToOriginalPage = true;
1396 }
Adam Cohenaefd4e12011-02-14 16:39:38 -08001397
Adam Cohenf358a4b2013-07-23 16:47:31 -07001398 int finalPage;
1399 // We give flings precedence over large moves, which is why we short-circuit our
1400 // test for a large move if a fling has been registered. That is, a large
1401 // move to the left and fling to the right will register as a fling to the right.
Sunny Goyalb7b01352018-08-09 12:31:20 -07001402
Vinit Nayaka406f722019-12-19 11:50:55 -08001403 if (((isSignificantMove && !isDeltaLeft && !isFling) ||
1404 (isFling && !isVelocityLeft)) && mCurrentPage > 0) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +01001405 finalPage = returnToOriginalPage
1406 ? mCurrentPage : mCurrentPage - getPanelCount();
Vinit Nayaka406f722019-12-19 11:50:55 -08001407 snapToPageWithVelocity(finalPage, velocity);
1408 } 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();
Vinit Nayaka406f722019-12-19 11:50:55 -08001413 snapToPageWithVelocity(finalPage, velocity);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001414 } else {
1415 snapToDestination();
Adam Cohenf358a4b2013-07-23 16:47:31 -07001416 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001417 } else {
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001418 if (!mScroller.isFinished()) {
1419 abortScrollerAnimation(true);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001420 }
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001421
Vinit Nayaka406f722019-12-19 11:50:55 -08001422 int initialScroll = mOrientationHandler.getPrimaryScroll(this);
1423 int maxScroll = mMaxScroll;
1424 int minScroll = mMinScroll;
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001425
Vinit Nayaka406f722019-12-19 11:50:55 -08001426 if (((initialScroll >= maxScroll) && (isVelocityLeft || !isFling)) ||
1427 ((initialScroll <= minScroll) && (!isVelocityLeft || !isFling))) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001428 mScroller.springBack(initialScroll, 0, minScroll, maxScroll, 0, 0);
Alex Chaub794ea62021-02-03 18:00:30 +00001429 mNextPage = getDestinationPage();
Sunny Goyalb7b01352018-08-09 12:31:20 -07001430 } else {
Sunny Goyalc39db732021-04-03 01:20:21 -07001431 int velocity1 = -velocity;
1432 // Continue a scroll or fling in progress
1433 mScroller.fling(initialScroll, 0, velocity1, 0, minScroll, maxScroll, 0, 0,
1434 Math.round(getWidth() * 0.5f * OVERSCROLL_DAMP_FACTOR), 0);
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001435
Sunny Goyalc39db732021-04-03 01:20:21 -07001436 int finalPos = mScroller.getFinalX();
Alex Chaub794ea62021-02-03 18:00:30 +00001437 mNextPage = getDestinationPage(finalPos);
Sunny Goyalc39db732021-04-03 01:20:21 -07001438 onNotSnappingToPageInFreeScroll();
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001439 }
1440 invalidate();
Winson Chung321e9ee2010-08-09 13:37:56 -07001441 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001442 }
Adam Cohen7d30a372013-07-01 17:03:59 -07001443
Sunny Goyalc39db732021-04-03 01:20:21 -07001444 mEdgeGlowLeft.onRelease();
1445 mEdgeGlowRight.onRelease();
Adam Cohen7d30a372013-07-01 17:03:59 -07001446 // End any intermediate reordering states
1447 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001448 break;
1449
1450 case MotionEvent.ACTION_CANCEL:
Sunny Goyalaad33592018-08-07 17:20:35 -07001451 if (mIsBeingDragged) {
Michael Jurkab8f06722010-10-10 15:58:46 -07001452 snapToDestination();
1453 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001454 mEdgeGlowLeft.onRelease();
1455 mEdgeGlowRight.onRelease();
Adam Cohen7d30a372013-07-01 17:03:59 -07001456 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001457 break;
1458
1459 case MotionEvent.ACTION_POINTER_UP:
1460 onSecondaryPointerUp(ev);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001461 releaseVelocityTracker();
Winson Chung321e9ee2010-08-09 13:37:56 -07001462 break;
1463 }
1464
1465 return true;
1466 }
1467
Sunny Goyalc39db732021-04-03 01:20:21 -07001468 protected void onNotSnappingToPageInFreeScroll() { }
Alex Chaub794ea62021-02-03 18:00:30 +00001469
Lais Andradecc5c8842021-06-04 18:20:30 +01001470 /**
1471 * Called when the view edges absorb part of the scroll. Subclasses can override this
1472 * to provide custom behavior during animation.
1473 */
1474 protected void onEdgeAbsorbingScroll() {
1475 }
1476
1477 /**
1478 * Called when the current page closest to the center of the screen changes as part of the
1479 * scroll. Subclasses can override this to provide custom behavior during scroll.
1480 */
1481 protected void onScrollOverPageChanged() {
1482 }
1483
Vinit Nayaka406f722019-12-19 11:50:55 -08001484 protected boolean shouldFlingForVelocity(int velocity) {
Winson Chung4941f652020-06-18 15:11:53 -07001485 float threshold = mAllowEasyFling ? mEasyFlingThresholdVelocity : mFlingThresholdVelocity;
1486 return Math.abs(velocity) > threshold;
Sunny Goyal65d9ceb2017-05-08 09:17:42 -07001487 }
1488
Alex Chau9d8eeab2022-04-05 17:13:56 +01001489 protected void resetTouchState() {
Adam Cohen7d30a372013-07-01 17:03:59 -07001490 releaseVelocityTracker();
Sunny Goyalaad33592018-08-07 17:20:35 -07001491 mIsBeingDragged = false;
Adam Cohen7d30a372013-07-01 17:03:59 -07001492 mActivePointerId = INVALID_POINTER;
Adam Cohen7d30a372013-07-01 17:03:59 -07001493 }
1494
Winson Chung185d7162011-02-28 13:47:29 -08001495 @Override
1496 public boolean onGenericMotionEvent(MotionEvent event) {
1497 if ((event.getSource() & InputDevice.SOURCE_CLASS_POINTER) != 0) {
1498 switch (event.getAction()) {
1499 case MotionEvent.ACTION_SCROLL: {
1500 // Handle mouse (or ext. device) by shifting the page depending on the scroll
1501 final float vscroll;
1502 final float hscroll;
1503 if ((event.getMetaState() & KeyEvent.META_SHIFT_ON) != 0) {
1504 vscroll = 0;
1505 hscroll = event.getAxisValue(MotionEvent.AXIS_VSCROLL);
1506 } else {
1507 vscroll = -event.getAxisValue(MotionEvent.AXIS_VSCROLL);
1508 hscroll = event.getAxisValue(MotionEvent.AXIS_HSCROLL);
1509 }
Sunny Goyal8b37c572020-03-31 12:12:14 -07001510 if (!canScroll(Math.abs(vscroll), Math.abs(hscroll))) {
1511 return false;
Samuel Fufa59cba192019-08-22 18:31:34 -07001512 }
Winson Chung185d7162011-02-28 13:47:29 -08001513 if (hscroll != 0 || vscroll != 0) {
Sunny Goyal70660032015-05-14 00:07:08 -07001514 boolean isForwardScroll = mIsRtl ? (hscroll < 0 || vscroll < 0)
Adam Cohen0ffac432013-07-10 11:19:26 -07001515 : (hscroll > 0 || vscroll > 0);
1516 if (isForwardScroll) {
Winson Chung185d7162011-02-28 13:47:29 -08001517 scrollRight();
1518 } else {
1519 scrollLeft();
1520 }
1521 return true;
1522 }
1523 }
1524 }
1525 }
1526 return super.onGenericMotionEvent(event);
1527 }
1528
Sunny Goyal8b37c572020-03-31 12:12:14 -07001529 /**
1530 * Returns true if the paged view can scroll for the provided vertical and horizontal
1531 * scroll values
1532 */
1533 protected boolean canScroll(float absVScroll, float absHScroll) {
1534 ActivityContext ac = ActivityContext.lookupContext(getContext());
1535 return (ac == null || AbstractFloatingView.getTopOpenView(ac) == null);
Samuel Fufa59cba192019-08-22 18:31:34 -07001536 }
1537
Michael Jurkab8f06722010-10-10 15:58:46 -07001538 private void acquireVelocityTrackerAndAddMovement(MotionEvent ev) {
1539 if (mVelocityTracker == null) {
1540 mVelocityTracker = VelocityTracker.obtain();
1541 }
1542 mVelocityTracker.addMovement(ev);
1543 }
1544
1545 private void releaseVelocityTracker() {
1546 if (mVelocityTracker != null) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001547 mVelocityTracker.clear();
Michael Jurkab8f06722010-10-10 15:58:46 -07001548 mVelocityTracker.recycle();
1549 mVelocityTracker = null;
1550 }
1551 }
1552
Winson Chung321e9ee2010-08-09 13:37:56 -07001553 private void onSecondaryPointerUp(MotionEvent ev) {
Winson Chung4941f652020-06-18 15:11:53 -07001554 final int pointerIndex = ev.getActionIndex();
Winson Chung321e9ee2010-08-09 13:37:56 -07001555 final int pointerId = ev.getPointerId(pointerIndex);
1556 if (pointerId == mActivePointerId) {
1557 // This was our active pointer going up. Choose a new
1558 // active pointer and adjust accordingly.
1559 // TODO: Make this decision more intelligent.
1560 final int newPointerIndex = pointerIndex == 0 ? 1 : 0;
Vinit Nayaka406f722019-12-19 11:50:55 -08001561 mLastMotion = mDownMotionPrimary = mOrientationHandler.getPrimaryDirection(ev,
1562 newPointerIndex);
1563 mLastMotionRemainder = 0;
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) {
Alex Chaudedbc8a2021-03-17 16:53:26 +00001617 int childSize = Math.round(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
Andy Wickhamda5a89b2021-07-23 12:38:14 -10001714 if (FeatureFlags.IS_STUDIO_BUILD && !Utilities.IS_RUNNING_IN_TEST_HARNESS) {
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}