blob: 95a8a2a9c89fc7a4b1e5c8de35398c9f56439538 [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;
Adam Cohen9c4949e2010-10-05 12:27:22 -070031import android.content.res.TypedArray;
Jon Miranda71cb80c2019-01-24 21:25:13 -080032import android.graphics.Canvas;
Winson Chung321e9ee2010-08-09 13:37:56 -070033import android.graphics.Rect;
Svetoslav Ganov08055f62012-05-15 11:06:36 -070034import android.os.Bundle;
Tony Wickhamd58c2d52018-05-04 12:10:55 -070035import android.provider.Settings;
Winson Chung321e9ee2010-08-09 13:37:56 -070036import android.util.AttributeSet;
Winson Chung785d2eb2011-04-14 16:08:02 -070037import android.util.Log;
Winson Chung185d7162011-02-28 13:47:29 -080038import android.view.InputDevice;
39import android.view.KeyEvent;
Winson Chung321e9ee2010-08-09 13:37:56 -070040import android.view.MotionEvent;
41import android.view.VelocityTracker;
42import android.view.View;
43import android.view.ViewConfiguration;
Sunny Goyal4ffec482016-02-09 11:28:52 -080044import android.view.ViewDebug;
Winson Chung321e9ee2010-08-09 13:37:56 -070045import android.view.ViewGroup;
46import android.view.ViewParent;
Winson Chung6a0f57d2011-06-29 20:10:49 -070047import android.view.accessibility.AccessibilityEvent;
48import android.view.accessibility.AccessibilityNodeInfo;
Sunny Goyalc39db732021-04-03 01:20:21 -070049import android.widget.OverScroller;
Vadim Trysheve6bbefb2018-04-03 13:38:06 -070050import android.widget.ScrollView;
Tony Wickhamf549dab2016-05-16 09:54:06 -070051
Tony Wickham62117d72020-03-26 16:56:26 -070052import androidx.annotation.Nullable;
Andras Kloczl55edfe52021-05-14 12:21:30 +020053import androidx.annotation.VisibleForTesting;
Tony Wickham62117d72020-03-26 16:56:26 -070054
Jon Miranda9e198662020-03-11 14:42:02 -070055import com.android.launcher3.compat.AccessibilityManagerCompat;
56import com.android.launcher3.config.FeatureFlags;
Jon Miranda9e198662020-03-11 14:42:02 -070057import com.android.launcher3.pageindicators.PageIndicator;
Jon Miranda9e198662020-03-11 14:42:02 -070058import com.android.launcher3.touch.PagedOrientationHandler;
59import com.android.launcher3.touch.PagedOrientationHandler.ChildBounds;
Sunny Goyalc39db732021-04-03 01:20:21 -070060import com.android.launcher3.util.EdgeEffectCompat;
Andras Kloczl55edfe52021-05-14 12:21:30 +020061import com.android.launcher3.util.IntSet;
Jon Miranda9e198662020-03-11 14:42:02 -070062import com.android.launcher3.util.Thunk;
Sunny Goyal8b37c572020-03-31 12:12:14 -070063import com.android.launcher3.views.ActivityContext;
Jon Miranda9e198662020-03-11 14:42:02 -070064
65import java.util.ArrayList;
Sunny Goyal59969372021-05-06 12:11:44 -070066import java.util.function.Consumer;
Jon Miranda9e198662020-03-11 14:42:02 -070067
Winson Chung321e9ee2010-08-09 13:37:56 -070068/**
69 * An abstraction of the original Workspace which supports browsing through a
Michael Jurka0142d492010-08-25 17:46:15 -070070 * sequential list of "pages"
Winson Chung321e9ee2010-08-09 13:37:56 -070071 */
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -080072public abstract class PagedView<T extends View & PageIndicator> extends ViewGroup {
Winson Chung321e9ee2010-08-09 13:37:56 -070073 private static final String TAG = "PagedView";
Winson Chung785d2eb2011-04-14 16:08:02 -070074 private static final boolean DEBUG = false;
Winson Chung4941f652020-06-18 15:11:53 -070075 public static final boolean DEBUG_FAILED_QUICKSWITCH = false;
Sunny Goyal20a13ff2018-03-13 16:44:00 -070076
Winson Chung4941f652020-06-18 15:11:53 -070077 public static final int ACTION_MOVE_ALLOW_EASY_FLING = MotionEvent.ACTION_MASK - 1;
Sunny Goyala7a5bf32020-01-05 15:35:29 +053078 public static final int INVALID_PAGE = -1;
Sunny Goyal20a13ff2018-03-13 16:44:00 -070079 protected static final ComputePageScrollsLogic SIMPLE_SCROLL_LOGIC = (v) -> v.getVisibility() != GONE;
Winson Chung321e9ee2010-08-09 13:37:56 -070080
Vadim Tryshevfedca432015-08-19 17:55:02 -070081 public static final int PAGE_SNAP_ANIMATION_DURATION = 750;
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 Cohen265b9a62011-12-07 14:37:18 -080089 // The following constants need to be scaled based on density. The scaled versions will be
90 // assigned to the corresponding member variables below.
91 private static final int FLING_THRESHOLD_VELOCITY = 500;
Winson Chung4941f652020-06-18 15:11:53 -070092 private static final int EASY_FLING_THRESHOLD_VELOCITY = 400;
Adam Cohen265b9a62011-12-07 14:37:18 -080093 private static final int MIN_SNAP_VELOCITY = 1500;
94 private static final int MIN_FLING_VELOCITY = 250;
95
Adam Cohenf358a4b2013-07-23 16:47:31 -070096 private boolean mFreeScroll = false;
Adam Cohenf358a4b2013-07-23 16:47:31 -070097
Winson Chung4941f652020-06-18 15:11:53 -070098 protected final int mFlingThresholdVelocity;
99 protected final int mEasyFlingThresholdVelocity;
100 protected final int mMinFlingVelocity;
101 protected final int mMinSnapVelocity;
Michael Jurka0142d492010-08-25 17:46:15 -0700102
Michael Jurka0142d492010-08-25 17:46:15 -0700103 protected boolean mFirstLayout = true;
104
Sunny Goyal4ffec482016-02-09 11:28:52 -0800105 @ViewDebug.ExportedProperty(category = "launcher")
Michael Jurka0142d492010-08-25 17:46:15 -0700106 protected int mCurrentPage;
Alex Chauba61b982021-06-15 16:29:19 +0100107 // Difference between current scroll position and mCurrentPage's page scroll. Used to maintain
108 // relative scroll position unchanged in updateCurrentPageScroll. Cleared when snapping to a
109 // page.
110 protected int mCurrentPageScrollDiff;
Lais Andradecc5c8842021-06-04 18:20:30 +0100111 // The current page the PagedView is scrolling over on it's way to the destination page.
112 protected int mCurrentScrollOverPage;
Adam Cohene61a9a22013-06-11 15:45:31 -0700113
Sunny Goyal4ffec482016-02-09 11:28:52 -0800114 @ViewDebug.ExportedProperty(category = "launcher")
Michael Jurka0142d492010-08-25 17:46:15 -0700115 protected int mNextPage = INVALID_PAGE;
Vinit Nayaka406f722019-12-19 11:50:55 -0800116 protected int mMaxScroll;
117 protected int mMinScroll;
Sunny Goyalb7b01352018-08-09 12:31:20 -0700118 protected OverScroller mScroller;
Winson Chung321e9ee2010-08-09 13:37:56 -0700119 private VelocityTracker mVelocityTracker;
Sunny Goyale15e2a82017-12-15 13:05:42 -0800120 protected int mPageSpacing = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -0700121
122 private float mDownMotionX;
Adam Cohen7d30a372013-07-01 17:03:59 -0700123 private float mDownMotionY;
Vinit Nayaka406f722019-12-19 11:50:55 -0800124 private float mDownMotionPrimary;
125 private float mLastMotion;
126 private float mLastMotionRemainder;
127 private float mTotalMotion;
Winson Chung4941f652020-06-18 15:11:53 -0700128 // Used in special cases where the fling checks can be relaxed for an intentional gesture
129 private boolean mAllowEasyFling;
Sunny Goyalacd17df2020-04-03 15:58:45 -0700130 protected PagedOrientationHandler mOrientationHandler = PagedOrientationHandler.PORTRAIT;
Adam Cohenedb40762013-07-18 16:45:45 -0700131
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700132 private final ArrayList<Runnable> mOnPageScrollsInitializedCallbacks = new ArrayList<>();
133
134 // We should always check pageScrollsInitialized() is true when using mPageScrolls.
135 @Nullable protected int[] mPageScrolls = null;
Sunny Goyalaad33592018-08-07 17:20:35 -0700136 private boolean mIsBeingDragged;
Adam Cohencae7f572013-11-04 14:42:52 -0800137
Winson Chung4941f652020-06-18 15:11:53 -0700138 // The amount of movement to begin scrolling
Michael Jurka7426c422010-11-11 15:23:47 -0800139 protected int mTouchSlop;
Winson Chung4941f652020-06-18 15:11:53 -0700140 // The amount of movement to begin paging
141 protected int mPageSlop;
Winson Chung321e9ee2010-08-09 13:37:56 -0700142 private int mMaximumVelocity;
Adam Cohen68d73932010-11-15 10:50:58 -0800143 protected boolean mAllowOverScroll = true;
Winson Chung321e9ee2010-08-09 13:37:56 -0700144
Michael Jurka5f1c5092010-09-03 14:15:02 -0700145 protected static final int INVALID_POINTER = -1;
Winson Chung321e9ee2010-08-09 13:37:56 -0700146
Michael Jurka5f1c5092010-09-03 14:15:02 -0700147 protected int mActivePointerId = INVALID_POINTER;
Winson Chung321e9ee2010-08-09 13:37:56 -0700148
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700149 protected boolean mIsPageInTransition = false;
Tony Wickham62117d72020-03-26 16:56:26 -0700150 private Runnable mOnPageTransitionEndCallback;
Patrick Dubroy1262e362010-10-06 15:49:50 -0700151
Winson Chungd2be3812013-07-16 11:11:32 -0700152 // Page Indicator
Adam Cohen091440a2015-03-18 14:16:05 -0700153 @Thunk int mPageIndicatorViewId;
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800154 protected T mPageIndicator;
Adam Cohen7d30a372013-07-01 17:03:59 -0700155
John Spurlock77e1f472013-09-11 10:09:51 -0400156 protected final Rect mInsets = new Rect();
Tony Wickhamdfb5cc92018-02-26 16:41:57 -0800157 protected boolean mIsRtl;
John Spurlock77e1f472013-09-11 10:09:51 -0400158
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800159 // Similar to the platform implementation of isLayoutValid();
160 protected boolean mIsLayoutValid;
161
Vadim Tryshev528b9e02018-05-24 18:22:03 -0700162 private int[] mTmpIntPair = new int[2];
163
Sunny Goyalc39db732021-04-03 01:20:21 -0700164 protected EdgeEffectCompat mEdgeGlowLeft;
165 protected EdgeEffectCompat mEdgeGlowRight;
166
Winson Chung321e9ee2010-08-09 13:37:56 -0700167 public PagedView(Context context) {
168 this(context, null);
169 }
170
171 public PagedView(Context context, AttributeSet attrs) {
172 this(context, attrs, 0);
173 }
174
175 public PagedView(Context context, AttributeSet attrs, int defStyle) {
176 super(context, attrs, defStyle);
Winson Chungc9ca2982013-07-19 12:07:38 -0700177
Adam Cohen9c4949e2010-10-05 12:27:22 -0700178 TypedArray a = context.obtainStyledAttributes(attrs,
179 R.styleable.PagedView, defStyle, 0);
Winson Chungd2be3812013-07-16 11:11:32 -0700180 mPageIndicatorViewId = a.getResourceId(R.styleable.PagedView_pageIndicator, -1);
Adam Cohen9c4949e2010-10-05 12:27:22 -0700181 a.recycle();
182
Winson Chung321e9ee2010-08-09 13:37:56 -0700183 setHapticFeedbackEnabled(false);
Sunny Goyal70660032015-05-14 00:07:08 -0700184 mIsRtl = Utilities.isRtl(getResources());
Winson Chung321e9ee2010-08-09 13:37:56 -0700185
Sunny Goyalc39db732021-04-03 01:20:21 -0700186 mScroller = new OverScroller(context, SCROLL);
Winson Chung86f77532010-08-24 11:08:22 -0700187 mCurrentPage = 0;
Lais Andradecc5c8842021-06-04 18:20:30 +0100188 mCurrentScrollOverPage = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -0700189
Vinit Nayaka406f722019-12-19 11:50:55 -0800190 final ViewConfiguration configuration = ViewConfiguration.get(context);
Winson Chung4941f652020-06-18 15:11:53 -0700191 mTouchSlop = configuration.getScaledTouchSlop();
192 mPageSlop = configuration.getScaledPagingTouchSlop();
Winson Chung321e9ee2010-08-09 13:37:56 -0700193 mMaximumVelocity = configuration.getScaledMaximumFlingVelocity();
Adam Cohen265b9a62011-12-07 14:37:18 -0800194
Sunny Goyalcf25b522015-07-09 00:01:18 -0700195 float density = getResources().getDisplayMetrics().density;
196 mFlingThresholdVelocity = (int) (FLING_THRESHOLD_VELOCITY * density);
Winson Chung4941f652020-06-18 15:11:53 -0700197 mEasyFlingThresholdVelocity = (int) (EASY_FLING_THRESHOLD_VELOCITY * density);
Sunny Goyalcf25b522015-07-09 00:01:18 -0700198 mMinFlingVelocity = (int) (MIN_FLING_VELOCITY * density);
199 mMinSnapVelocity = (int) (MIN_SNAP_VELOCITY * density);
Sunny Goyala9f55462018-03-25 18:15:15 -0700200
Sunny Goyalc39db732021-04-03 01:20:21 -0700201 initEdgeEffect();
Sunny Goyaleaf7a952020-07-29 16:54:20 -0700202 setDefaultFocusHighlightEnabled(false);
Sunny Goyalc39db732021-04-03 01:20:21 -0700203 setWillNotDraw(false);
Winson Chung321e9ee2010-08-09 13:37:56 -0700204 }
205
Sunny Goyalc39db732021-04-03 01:20:21 -0700206 protected void initEdgeEffect() {
207 mEdgeGlowLeft = new EdgeEffectCompat(getContext());
208 mEdgeGlowRight = new EdgeEffectCompat(getContext());
Adam Cohenf9618852013-11-08 06:45:03 -0800209 }
210
Sunny Goyald0a6ae72016-06-16 12:29:03 -0700211 public void initParentViews(View parent) {
212 if (mPageIndicatorViewId > -1) {
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800213 mPageIndicator = parent.findViewById(mPageIndicatorViewId);
Tony Wickhambab101c2021-09-20 15:12:44 -0700214 mPageIndicator.setMarkersCount(getChildCount() / getPanelCount());
Winson Chungd2be3812013-07-16 11:11:32 -0700215 }
216 }
217
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800218 public T getPageIndicator() {
Adam Cohenedb40762013-07-18 16:45:45 -0700219 return mPageIndicator;
220 }
221
Adam Cohen674531f2013-12-13 15:07:14 -0800222 /**
Tony Wickham29d853c2015-09-08 10:35:56 -0700223 * Returns the index of the currently displayed page. When in free scroll mode, this is the page
224 * that the user was on before entering free scroll mode (e.g. the home screen page they
Alex Chaub794ea62021-02-03 18:00:30 +0000225 * long-pressed on to enter the overview). Try using {@link #getDestinationPage()}
Tony Wickham29d853c2015-09-08 10:35:56 -0700226 * to get the page the user is currently scrolling over.
Winson Chung321e9ee2010-08-09 13:37:56 -0700227 */
Sunny Goyal83a8f042015-05-19 12:52:12 -0700228 public int getCurrentPage() {
Winson Chung86f77532010-08-24 11:08:22 -0700229 return mCurrentPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700230 }
Adam Cohen7d30a372013-07-01 17:03:59 -0700231
Hyunyoung Songb76cd622015-04-16 14:34:09 -0700232 /**
233 * Returns the index of page to be shown immediately afterwards.
234 */
Vadim Tryshevfedca432015-08-19 17:55:02 -0700235 public int getNextPage() {
Winson Chung360e63f2012-04-27 13:48:05 -0700236 return (mNextPage != INVALID_PAGE) ? mNextPage : mCurrentPage;
237 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700238
Adam Cohenf9c184a2016-01-15 16:47:43 -0800239 public int getPageCount() {
Winson Chung321e9ee2010-08-09 13:37:56 -0700240 return getChildCount();
241 }
242
Sunny Goyal83a8f042015-05-19 12:52:12 -0700243 public View getPageAt(int index) {
Winson Chung321e9ee2010-08-09 13:37:56 -0700244 return getChildAt(index);
245 }
246
Winson Chung321e9ee2010-08-09 13:37:56 -0700247 /**
Winson Chungbbc60d82010-11-11 16:34:41 -0800248 * Updates the scroll of the current page immediately to its final scroll position. We use this
249 * in CustomizePagedView to allow tabs to share the same PagedView while resetting the scroll of
250 * the previous tab page.
251 */
252 protected void updateCurrentPageScroll() {
Adam Cohen0ffac432013-07-10 11:19:26 -0700253 // If the current page is invalid, just reset the scroll position to zero
Vinit Nayaka406f722019-12-19 11:50:55 -0800254 int newPosition = 0;
Adam Cohen0ffac432013-07-10 11:19:26 -0700255 if (0 <= mCurrentPage && mCurrentPage < getPageCount()) {
Alex Chauba61b982021-06-15 16:29:19 +0100256 newPosition = getScrollForPage(mCurrentPage) + mCurrentPageScrollDiff;
Adam Cohen0ffac432013-07-10 11:19:26 -0700257 }
Alex Chau6499e832021-11-19 14:35:46 +0000258 mOrientationHandler.setPrimary(this, VIEW_SCROLL_TO, newPosition);
Sunny Goyalc39db732021-04-03 01:20:21 -0700259 mScroller.startScroll(mScroller.getCurrX(), 0, newPosition - mScroller.getCurrX(), 0);
Tony Wickhamd5521322021-09-14 14:26:50 -0700260 forceFinishScroller();
Winson Chungbbc60d82010-11-11 16:34:41 -0800261 }
262
Tony Wickhamf8d731a2021-05-26 14:58:13 -0700263 /**
264 * Immediately finishes any overscroll effect and jumps to the end of the scroller animation.
265 */
266 public void abortScrollerAnimation() {
267 mEdgeGlowLeft.finish();
268 mEdgeGlowRight.finish();
269 abortScrollerAnimation(true);
270 }
271
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700272 private void abortScrollerAnimation(boolean resetNextPage) {
Adam Cohen4fe4c932013-10-28 16:02:34 -0700273 mScroller.abortAnimation();
274 // We need to clean up the next page here to avoid computeScrollHelper from
275 // updating current page on the pass.
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700276 if (resetNextPage) {
277 mNextPage = INVALID_PAGE;
Sunny Goyal857b1b92018-03-05 10:49:05 -0800278 pageEndTransition();
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700279 }
Chet Haasebc2f0822012-10-26 17:59:53 -0700280 }
Adam Cohen4fe4c932013-10-28 16:02:34 -0700281
Tony Wickhamd5521322021-09-14 14:26:50 -0700282 /**
283 * Immediately finishes any in-progress scroll, maintaining the current position. Also sets
284 * mNextPage = INVALID_PAGE and calls pageEndTransition().
285 */
286 public void forceFinishScroller() {
Adam Cohen4fe4c932013-10-28 16:02:34 -0700287 mScroller.forceFinished(true);
288 // We need to clean up the next page here to avoid computeScrollHelper from
289 // updating current page on the pass.
Tony Wickhamd5521322021-09-14 14:26:50 -0700290 mNextPage = INVALID_PAGE;
291 pageEndTransition();
Adam Cohen4fe4c932013-10-28 16:02:34 -0700292 }
293
Adam Cohen6f127a62014-06-12 14:54:41 -0700294 private int validateNewPage(int newPage) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700295 newPage = ensureWithinScrollBounds(newPage);
Adam Cohen6f127a62014-06-12 14:54:41 -0700296 // Ensure that it is clamped by the actual set of children in all cases
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100297 newPage = Utilities.boundToRange(newPage, 0, getPageCount() - 1);
298
299 if (getPanelCount() > 1) {
Alex Chau1e448462021-08-13 21:48:35 +0100300 // Always return left most panel as new page
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100301 newPage = getLeftmostVisiblePageForIndex(newPage);
302 }
303 return newPage;
304 }
305
Andras Kloczl55edfe52021-05-14 12:21:30 +0200306 /**
307 * In most cases where panelCount is 1, this method will just return the page index that was
308 * passed in.
309 * But for example when two panel home is enabled we might need the leftmost visible page index
310 * because that page is the current page.
311 */
312 public int getLeftmostVisiblePageForIndex(int pageIndex) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100313 int panelCount = getPanelCount();
Andras Kloczl55edfe52021-05-14 12:21:30 +0200314 return pageIndex - pageIndex % panelCount;
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100315 }
316
317 /**
318 * Returns the number of pages that are shown at the same time.
319 */
320 protected int getPanelCount() {
321 return 1;
322 }
323
324 /**
Andras Kloczl55edfe52021-05-14 12:21:30 +0200325 * Returns an IntSet with the indices of the currently visible pages
326 */
327 @VisibleForTesting(otherwise = PACKAGE_PRIVATE)
328 public IntSet getVisiblePageIndices() {
Andras Kloczl7e912442021-05-06 12:50:28 +0200329 return getPageIndices(mCurrentPage);
330 }
331
332 /**
333 * In case the panelCount is 1 this just returns the same page index in an IntSet.
334 * But in cases where the panelCount > 1 this will return all the page indices that belong
335 * together, i.e. on the Workspace they are next to each other and shown at the same time.
336 */
337 private IntSet getPageIndices(int pageIndex) {
338 // we want to make sure the pageIndex is the leftmost page
339 pageIndex = getLeftmostVisiblePageForIndex(pageIndex);
340
341 IntSet pageIndices = new IntSet();
Andras Kloczl55edfe52021-05-14 12:21:30 +0200342 int panelCount = getPanelCount();
343 int pageCount = getPageCount();
Andras Kloczl7e912442021-05-06 12:50:28 +0200344 for (int page = pageIndex; page < pageIndex + panelCount && page < pageCount; page++) {
345 pageIndices.add(page);
Andras Kloczl55edfe52021-05-14 12:21:30 +0200346 }
Andras Kloczl7e912442021-05-06 12:50:28 +0200347 return pageIndices;
348 }
349
350 /**
351 * Returns an IntSet with the indices of the neighbour pages that are in the focus direction.
352 */
353 private IntSet getNeighbourPageIndices(int focus) {
354 int panelCount = getPanelCount();
355 // getNextPage is more reliable than getCurrentPage
356 int currentPage = getNextPage();
357
358 int nextPage;
359 if (focus == View.FOCUS_LEFT) {
360 nextPage = currentPage - panelCount;
361 } else if (focus == View.FOCUS_RIGHT) {
362 nextPage = currentPage + panelCount;
363 } else {
Andras Kloczlb0632942021-08-03 14:03:58 +0200364 // no neighbours to other directions
Andras Kloczl7e912442021-05-06 12:50:28 +0200365 return new IntSet();
366 }
367 nextPage = validateNewPage(nextPage);
368 if (nextPage == currentPage) {
369 // We reached the end of the pages
370 return new IntSet();
371 }
372
Andras Kloczlb0632942021-08-03 14:03:58 +0200373 return getPageIndices(nextPage);
Andras Kloczl55edfe52021-05-14 12:21:30 +0200374 }
375
376 /**
Sunny Goyal59969372021-05-06 12:11:44 -0700377 * Executes the callback against each visible page
Andras Kloczl2bb51342021-03-20 01:13:45 +0100378 */
Sunny Goyal59969372021-05-06 12:11:44 -0700379 public void forEachVisiblePage(Consumer<View> callback) {
Andras Kloczl55edfe52021-05-14 12:21:30 +0200380 getVisiblePageIndices().forEach(pageIndex -> {
381 View page = getPageAt(pageIndex);
Andras Kloczl2bb51342021-03-20 01:13:45 +0100382 if (page != null) {
Sunny Goyal59969372021-05-06 12:11:44 -0700383 callback.accept(page);
Andras Kloczl2bb51342021-03-20 01:13:45 +0100384 }
Andras Kloczl55edfe52021-05-14 12:21:30 +0200385 });
Andras Kloczl2bb51342021-03-20 01:13:45 +0100386 }
387
388 /**
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100389 * Returns true if the view is on one of the current pages, false otherwise.
390 */
391 public boolean isVisible(View child) {
Andras Kloczl7e912442021-05-06 12:50:28 +0200392 return isVisible(indexOfChild(child));
393 }
394
395 /**
396 * Returns true if the page with the given index is currently visible, false otherwise.
397 */
398 private boolean isVisible(int pageIndex) {
399 return getLeftmostVisiblePageForIndex(pageIndex) == mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700400 }
401
Chet Haasebc2f0822012-10-26 17:59:53 -0700402 /**
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700403 * @return The closest page to the provided page that is within mMinScrollX and mMaxScrollX.
404 */
405 private int ensureWithinScrollBounds(int page) {
406 int dir = !mIsRtl ? 1 : - 1;
407 int currScroll = getScrollForPage(page);
408 int prevScroll;
Vinit Nayaka406f722019-12-19 11:50:55 -0800409 while (currScroll < mMinScroll) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700410 page += dir;
411 prevScroll = currScroll;
412 currScroll = getScrollForPage(page);
413 if (currScroll <= prevScroll) {
414 Log.e(TAG, "validateNewPage: failed to find a page > mMinScrollX");
415 break;
416 }
417 }
Vinit Nayaka406f722019-12-19 11:50:55 -0800418 while (currScroll > mMaxScroll) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700419 page -= dir;
420 prevScroll = currScroll;
421 currScroll = getScrollForPage(page);
422 if (currScroll >= prevScroll) {
423 Log.e(TAG, "validateNewPage: failed to find a page < mMaxScrollX");
424 break;
425 }
426 }
427 return page;
428 }
429
Tony Wickham03f27012019-04-25 14:22:54 -0700430 public void setCurrentPage(int currentPage) {
431 setCurrentPage(currentPage, INVALID_PAGE);
432 }
433
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700434 /**
Winson Chung86f77532010-08-24 11:08:22 -0700435 * Sets the current page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700436 */
Tony Wickham03f27012019-04-25 14:22:54 -0700437 public void setCurrentPage(int currentPage, int overridePrevPage) {
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800438 if (!mScroller.isFinished()) {
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700439 abortScrollerAnimation(true);
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800440 }
Michael Jurkad3ef3062010-11-23 16:23:58 -0800441 // don't introduce any checks like mCurrentPage == currentPage here-- if we change the
442 // the default
443 if (getChildCount() == 0) {
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800444 return;
445 }
Tony Wickham03f27012019-04-25 14:22:54 -0700446 int prevPage = overridePrevPage != INVALID_PAGE ? overridePrevPage : mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700447 mCurrentPage = validateNewPage(currentPage);
Lais Andradecc5c8842021-06-04 18:20:30 +0100448 mCurrentScrollOverPage = mCurrentPage;
Winson Chung181c3dc2013-07-17 15:36:20 -0700449 updateCurrentPageScroll();
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700450 notifyPageSwitchListener(prevPage);
Winson Chunga12a2502010-12-20 14:41:35 -0800451 invalidate();
Winson Chung321e9ee2010-08-09 13:37:56 -0700452 }
453
Winson Chung8c87cd82013-07-23 16:20:10 -0700454 /**
Adam Cohen674531f2013-12-13 15:07:14 -0800455 * Should be called whenever the page changes. In the case of a scroll, we wait until the page
456 * has settled.
457 */
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700458 protected void notifyPageSwitchListener(int prevPage) {
Adam Cohen674531f2013-12-13 15:07:14 -0800459 updatePageIndicator();
460 }
461
462 private void updatePageIndicator() {
Sunny Goyal4cbf0462014-08-28 16:19:39 -0700463 if (mPageIndicator != null) {
Tony Mak4f521af2018-03-15 16:37:34 +0000464 mPageIndicator.setActiveMarker(getNextPage());
Winson Chungd2be3812013-07-16 11:11:32 -0700465 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700466 }
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700467 protected void pageBeginTransition() {
468 if (!mIsPageInTransition) {
469 mIsPageInTransition = true;
470 onPageBeginTransition();
Michael Jurkad74c9842011-07-10 12:44:21 -0700471 }
Patrick Dubroy1262e362010-10-06 15:49:50 -0700472 }
473
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700474 protected void pageEndTransition() {
Sunny Goyal05b59c02021-04-29 13:55:40 -0700475 if (mIsPageInTransition && !mIsBeingDragged && mScroller.isFinished()
Sunny Goyalb745a2a2021-04-30 13:38:22 -0700476 && (!isShown() || (mEdgeGlowLeft.isFinished() && mEdgeGlowRight.isFinished()))) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700477 mIsPageInTransition = false;
478 onPageEndTransition();
Michael Jurkad74c9842011-07-10 12:44:21 -0700479 }
Michael Jurka0142d492010-08-25 17:46:15 -0700480 }
481
Sunny Goyalb745a2a2021-04-30 13:38:22 -0700482 @Override
483 public void onVisibilityAggregated(boolean isVisible) {
484 pageEndTransition();
485 super.onVisibilityAggregated(isVisible);
486 }
487
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700488 protected boolean isPageInTransition() {
489 return mIsPageInTransition;
Adam Cohen26976d92011-03-22 15:33:33 -0700490 }
491
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700492 /**
493 * Called when the page starts moving as part of the scroll. Subclasses can override this
494 * to provide custom behavior during animation.
495 */
496 protected void onPageBeginTransition() {
Patrick Dubroy1262e362010-10-06 15:49:50 -0700497 }
498
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700499 /**
500 * Called when the page ends moving as part of the scroll. Subclasses can override this
501 * to provide custom behavior during animation.
502 */
503 protected void onPageEndTransition() {
Alex Chauba61b982021-06-15 16:29:19 +0100504 mCurrentPageScrollDiff = 0;
vadimt4d93df52019-07-10 17:32:58 -0700505 AccessibilityManagerCompat.sendScrollFinishedEventToTest(getContext());
Tony Wickham619daaf2020-02-07 12:29:06 -0800506 AccessibilityManagerCompat.sendCustomAccessibilityEvent(getPageAt(mCurrentPage),
507 AccessibilityEvent.TYPE_VIEW_FOCUSED, null);
Tony Wickham62117d72020-03-26 16:56:26 -0700508 if (mOnPageTransitionEndCallback != null) {
509 mOnPageTransitionEndCallback.run();
510 mOnPageTransitionEndCallback = null;
511 }
512 }
513
514 /**
515 * Sets a callback to run once when the scrolling finishes. If there is currently
516 * no page in transition, then the callback is called immediately.
517 */
518 public void setOnPageTransitionEndCallback(@Nullable Runnable callback) {
519 if (mIsPageInTransition || callback == null) {
520 mOnPageTransitionEndCallback = callback;
521 } else {
522 callback.run();
523 }
Michael Jurka0142d492010-08-25 17:46:15 -0700524 }
525
Adam Cohen68d73932010-11-15 10:50:58 -0800526 @Override
Michael Jurka0142d492010-08-25 17:46:15 -0700527 public void scrollTo(int x, int y) {
Sunny Goyalc39db732021-04-03 01:20:21 -0700528 x = Utilities.boundToRange(x,
529 mOrientationHandler.getPrimaryValue(mMinScroll, 0), mMaxScroll);
530 y = Utilities.boundToRange(y,
531 mOrientationHandler.getPrimaryValue(0, mMinScroll), mMaxScroll);
Vinit Nayaka406f722019-12-19 11:50:55 -0800532 super.scrollTo(x, y);
Michael Jurka0142d492010-08-25 17:46:15 -0700533 }
534
Adam Cohen53805212013-10-01 10:39:23 -0700535 private void sendScrollAccessibilityEvent() {
Sunny Goyald0030b02017-12-08 15:07:24 -0800536 if (isObservedEventType(getContext(), AccessibilityEvent.TYPE_VIEW_SCROLLED)) {
Vadim Tryshevf4715972015-05-08 17:21:03 -0700537 if (mCurrentPage != getNextPage()) {
538 AccessibilityEvent ev =
539 AccessibilityEvent.obtain(AccessibilityEvent.TYPE_VIEW_SCROLLED);
Vadim Tryshev7066c122015-05-21 14:06:35 -0700540 ev.setScrollable(true);
541 ev.setScrollX(getScrollX());
542 ev.setScrollY(getScrollY());
Vinit Nayaka406f722019-12-19 11:50:55 -0800543 mOrientationHandler.setMaxScroll(ev, mMaxScroll);
Vadim Tryshevf4715972015-05-08 17:21:03 -0700544 sendAccessibilityEventUnchecked(ev);
Adam Cohen53805212013-10-01 10:39:23 -0700545 }
Adam Cohen53805212013-10-01 10:39:23 -0700546 }
547 }
548
Vadim Tryshev2c430b32018-04-04 14:45:21 -0700549 protected void announcePageForAccessibility() {
550 if (isAccessibilityEnabled(getContext())) {
551 // Notify the user when the page changes
552 announceForAccessibility(getCurrentPageDescription());
553 }
554 }
555
Winson Chung85425412021-05-10 16:24:14 -0700556 protected boolean computeScrollHelper() {
Winson Chung321e9ee2010-08-09 13:37:56 -0700557 if (mScroller.computeScrollOffset()) {
Winson Chung557d6ed2011-07-08 15:34:52 -0700558 // Don't bother scrolling if the page does not need to be moved
Sunny Goyalc39db732021-04-03 01:20:21 -0700559 int oldPos = mOrientationHandler.getPrimaryScroll(this);
560 int newPos = mScroller.getCurrX();
561 if (oldPos != newPos) {
Alex Chau6499e832021-11-19 14:35:46 +0000562 mOrientationHandler.setPrimary(this, VIEW_SCROLL_TO, mScroller.getCurrX());
Winson Chung557d6ed2011-07-08 15:34:52 -0700563 }
Winson Chung85425412021-05-10 16:24:14 -0700564
565 if (mAllowOverScroll) {
566 if (newPos < mMinScroll && oldPos >= mMinScroll) {
567 mEdgeGlowLeft.onAbsorb((int) mScroller.getCurrVelocity());
568 mScroller.abortAnimation();
Lais Andradecc5c8842021-06-04 18:20:30 +0100569 onEdgeAbsorbingScroll();
Winson Chung85425412021-05-10 16:24:14 -0700570 } else if (newPos > mMaxScroll && oldPos <= mMaxScroll) {
571 mEdgeGlowRight.onAbsorb((int) mScroller.getCurrVelocity());
572 mScroller.abortAnimation();
Lais Andradecc5c8842021-06-04 18:20:30 +0100573 onEdgeAbsorbingScroll();
Sunny Goyalc39db732021-04-03 01:20:21 -0700574 }
Tony Wickham95cdb3a2016-02-18 14:37:07 -0800575 }
Adam Cohen53805212013-10-01 10:39:23 -0700576
Winson Chung85425412021-05-10 16:24:14 -0700577 // If the scroller has scrolled to the final position and there is no edge effect, then
578 // finish the scroller to skip waiting for additional settling
579 int finalPos = mOrientationHandler.getPrimaryValue(mScroller.getFinalX(),
580 mScroller.getFinalY());
581 if (newPos == finalPos && mEdgeGlowLeft.isFinished() && mEdgeGlowRight.isFinished()) {
582 mScroller.abortAnimation();
583 }
584
585 invalidate();
586 return true;
587 } else if (mNextPage != INVALID_PAGE) {
588 sendScrollAccessibilityEvent();
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700589 int prevPage = mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700590 mCurrentPage = validateNewPage(mNextPage);
Lais Andradecc5c8842021-06-04 18:20:30 +0100591 mCurrentScrollOverPage = mCurrentPage;
Winson Chung86f77532010-08-24 11:08:22 -0700592 mNextPage = INVALID_PAGE;
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700593 notifyPageSwitchListener(prevPage);
Winson Chungb44b5242011-06-13 11:32:14 -0700594
Adam Cohen73aa9752010-11-24 16:26:58 -0800595 // We don't want to trigger a page end moving unless the page has settled
596 // and the user has stopped scrolling
Sunny Goyalaad33592018-08-07 17:20:35 -0700597 if (!mIsBeingDragged) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700598 pageEndTransition();
Adam Cohen73aa9752010-11-24 16:26:58 -0800599 }
Winson Chungc27d1bb2011-09-29 12:07:42 -0700600
Vadim Tryshev2c430b32018-04-04 14:45:21 -0700601 if (canAnnouncePageDescription()) {
602 announcePageForAccessibility();
Adam Cohen0ffac432013-07-10 11:19:26 -0700603 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700604 }
Michael Jurka0142d492010-08-25 17:46:15 -0700605 return false;
606 }
607
608 @Override
609 public void computeScroll() {
610 computeScrollHelper();
Winson Chung321e9ee2010-08-09 13:37:56 -0700611 }
612
Sunny Goyalce8809a2018-01-18 14:02:47 -0800613 public int getExpectedHeight() {
614 return getMeasuredHeight();
615 }
616
Adam Cohen410f3cd2013-09-22 12:09:32 -0700617 public int getNormalChildHeight() {
Sunny Goyalce8809a2018-01-18 14:02:47 -0800618 return getExpectedHeight() - getPaddingTop() - getPaddingBottom()
Sunny Goyalac00cba2017-11-13 15:58:01 -0800619 - mInsets.top - mInsets.bottom;
Adam Cohen410f3cd2013-09-22 12:09:32 -0700620 }
621
Sunny Goyalce8809a2018-01-18 14:02:47 -0800622 public int getExpectedWidth() {
623 return getMeasuredWidth();
624 }
625
Sunny Goyalbc683e92017-12-06 10:25:07 -0800626 public int getNormalChildWidth() {
Sunny Goyalce8809a2018-01-18 14:02:47 -0800627 return getExpectedWidth() - getPaddingLeft() - getPaddingRight()
Sunny Goyalbc683e92017-12-06 10:25:07 -0800628 - mInsets.left - mInsets.right;
629 }
630
Winson Chung321e9ee2010-08-09 13:37:56 -0700631 @Override
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800632 public void requestLayout() {
633 mIsLayoutValid = false;
634 super.requestLayout();
635 }
636
637 @Override
638 public void forceLayout() {
639 mIsLayoutValid = false;
640 super.forceLayout();
641 }
642
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100643 private int getPageWidthSize(int widthSize) {
Thales Lima7a6752d2021-09-23 14:31:00 +0100644 // It's necessary to add the padding back because it is remove when measuring children,
645 // like when MeasureSpec.getSize in CellLayout.
646 return (widthSize - mInsets.left - mInsets.right - getPaddingLeft() - getPaddingRight())
647 / getPanelCount() + getPaddingLeft() + getPaddingRight();
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100648 }
649
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800650 @Override
Winson Chung321e9ee2010-08-09 13:37:56 -0700651 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
Sunny Goyal8e2133b2015-05-06 13:39:07 -0700652 if (getChildCount() == 0) {
Winson Chungf0ea4d32011-06-06 14:27:16 -0700653 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
654 return;
655 }
656
Adam Cohen7d30a372013-07-01 17:03:59 -0700657 // We measure the dimensions of the PagedView to be larger than the pages so that when we
658 // zoom out (and scale down), the view is still contained in the parent
Adam Cohen7d30a372013-07-01 17:03:59 -0700659 int widthMode = MeasureSpec.getMode(widthMeasureSpec);
660 int widthSize = MeasureSpec.getSize(widthMeasureSpec);
661 int heightMode = MeasureSpec.getMode(heightMeasureSpec);
Winson Chung8aad6102012-05-11 16:27:49 -0700662 int heightSize = MeasureSpec.getSize(heightMeasureSpec);
Adam Cohen410f3cd2013-09-22 12:09:32 -0700663
Adam Cohen7d30a372013-07-01 17:03:59 -0700664 if (widthMode == MeasureSpec.UNSPECIFIED || heightMode == MeasureSpec.UNSPECIFIED) {
665 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
666 return;
Winson Chung321e9ee2010-08-09 13:37:56 -0700667 }
668
Winson Chung8aad6102012-05-11 16:27:49 -0700669 // Return early if we aren't given a proper dimension
670 if (widthSize <= 0 || heightSize <= 0) {
671 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
672 return;
673 }
674
Winson Chung321e9ee2010-08-09 13:37:56 -0700675 // The children are given the same width and height as the workspace
Michael Jurka5f1c5092010-09-03 14:15:02 -0700676 // unless they were set to WRAP_CONTENT
Winson Chung785d2eb2011-04-14 16:08:02 -0700677 if (DEBUG) Log.d(TAG, "PagedView.onMeasure(): " + widthSize + ", " + heightSize);
Michael Jurka5f1c5092010-09-03 14:15:02 -0700678
Sunny Goyalac00cba2017-11-13 15:58:01 -0800679 int myWidthSpec = MeasureSpec.makeMeasureSpec(
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100680 getPageWidthSize(widthSize), MeasureSpec.EXACTLY);
Sunny Goyalac00cba2017-11-13 15:58:01 -0800681 int myHeightSpec = MeasureSpec.makeMeasureSpec(
Sunny Goyal228153d2018-01-04 15:35:22 -0800682 heightSize - mInsets.top - mInsets.bottom, MeasureSpec.EXACTLY);
Adam Cohen96d30a12013-07-16 18:13:21 -0700683
Sunny Goyalac00cba2017-11-13 15:58:01 -0800684 // measureChildren takes accounts for content padding, we only need to care about extra
685 // space due to insets.
686 measureChildren(myWidthSpec, myHeightSpec);
687 setMeasuredDimension(widthSize, heightSize);
Adam Cohen60b07122011-11-14 17:26:06 -0800688 }
689
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700690 /** Returns true iff this PagedView's scroll amounts are initialized to each page index. */
691 protected boolean pageScrollsInitialized() {
692 return mPageScrolls != null && mPageScrolls.length == getChildCount();
693 }
694
695 /**
696 * Queues the given callback to be run once {@code mPageScrolls} has been initialized.
697 */
698 public void runOnPageScrollsInitialized(Runnable callback) {
699 mOnPageScrollsInitializedCallbacks.add(callback);
700 if (pageScrollsInitialized()) {
701 onPageScrollsInitialized();
702 }
703 }
704
705 private void onPageScrollsInitialized() {
706 for (Runnable callback : mOnPageScrollsInitializedCallbacks) {
707 callback.run();
708 }
709 mOnPageScrollsInitializedCallbacks.clear();
710 }
711
Sunny Goyalcf25b522015-07-09 00:01:18 -0700712 @SuppressLint("DrawAllocation")
Winson Chung321e9ee2010-08-09 13:37:56 -0700713 @Override
Michael Jurka28750fb2010-09-24 17:43:49 -0700714 protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800715 mIsLayoutValid = true;
Vadim Trysheveb701c62018-05-14 16:00:15 -0700716 final int childCount = getChildCount();
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700717 int[] pageScrolls = mPageScrolls;
Vadim Trysheveb701c62018-05-14 16:00:15 -0700718 boolean pageScrollChanged = false;
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700719 if (!pageScrollsInitialized()) {
720 pageScrolls = new int[childCount];
Vadim Trysheveb701c62018-05-14 16:00:15 -0700721 pageScrollChanged = true;
722 }
723
724 if (childCount == 0) {
Winson Chungf0ea4d32011-06-06 14:27:16 -0700725 return;
726 }
727
Winson Chung785d2eb2011-04-14 16:08:02 -0700728 if (DEBUG) Log.d(TAG, "PagedView.onLayout()");
Winson Chung321e9ee2010-08-09 13:37:56 -0700729
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700730 pageScrollChanged |= getPageScrolls(pageScrolls, true, SIMPLE_SCROLL_LOGIC);
731 mPageScrolls = pageScrolls;
Winson Chungc3665fa2011-09-14 17:56:27 -0700732
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700733 final LayoutTransition transition = getLayoutTransition();
734 // If the transition is running defer updating max scroll, as some empty pages could
735 // still be present, and a max scroll change could cause sudden jumps in scroll.
736 if (transition != null && transition.isRunning()) {
737 transition.addTransitionListener(new LayoutTransition.TransitionListener() {
738
739 @Override
740 public void startTransition(LayoutTransition transition, ViewGroup container,
741 View view, int transitionType) { }
742
743 @Override
744 public void endTransition(LayoutTransition transition, ViewGroup container,
745 View view, int transitionType) {
746 // Wait until all transitions are complete.
747 if (!transition.isRunning()) {
748 transition.removeTransitionListener(this);
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700749 updateMinAndMaxScrollX();
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700750 }
751 }
752 });
Adam Cohenf698c6e2013-07-17 18:44:25 -0700753 } else {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700754 updateMinAndMaxScrollX();
Adam Cohenf698c6e2013-07-17 18:44:25 -0700755 }
756
Sunny Goyalcb037ee2015-07-08 16:41:21 -0700757 if (mFirstLayout && mCurrentPage >= 0 && mCurrentPage < childCount) {
758 updateCurrentPageScroll();
759 mFirstLayout = false;
760 }
761
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800762 if (mScroller.isFinished() && pageScrollChanged) {
Sunny Goyalc82c6392018-06-06 15:39:13 -0700763 setCurrentPage(getNextPage());
Adam Cohenf698c6e2013-07-17 18:44:25 -0700764 }
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700765 onPageScrollsInitialized();
Winson Chunge3193b92010-09-10 11:44:42 -0700766 }
767
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700768 /**
769 * Initializes {@code outPageScrolls} with scroll positions for view at that index. The length
770 * of {@code outPageScrolls} should be same as the the childCount
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700771 */
772 protected boolean getPageScrolls(int[] outPageScrolls, boolean layoutChildren,
773 ComputePageScrollsLogic scrollLogic) {
774 final int childCount = getChildCount();
775
776 final int startIndex = mIsRtl ? childCount - 1 : 0;
777 final int endIndex = mIsRtl ? -1 : childCount;
778 final int delta = mIsRtl ? -1 : 1;
779
Vinit Nayaka406f722019-12-19 11:50:55 -0800780 final int pageCenter = mOrientationHandler.getCenterForPage(this, mInsets);
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700781
Vinit Nayaka406f722019-12-19 11:50:55 -0800782 final int scrollOffsetStart = mOrientationHandler.getScrollOffsetStart(this, mInsets);
783 final int scrollOffsetEnd = mOrientationHandler.getScrollOffsetEnd(this, mInsets);
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700784 boolean pageScrollChanged = false;
Thales Limae4457742021-07-20 16:46:38 +0100785 int panelCount = getPanelCount();
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700786
Vinit Nayaka406f722019-12-19 11:50:55 -0800787 for (int i = startIndex, childStart = scrollOffsetStart; i != endIndex; i += delta) {
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700788 final View child = getPageAt(i);
789 if (scrollLogic.shouldIncludeView(child)) {
Vinit Nayaka406f722019-12-19 11:50:55 -0800790 ChildBounds bounds = mOrientationHandler.getChildBounds(child, childStart,
791 pageCenter, layoutChildren);
792 final int primaryDimension = bounds.primaryDimension;
793 final int childPrimaryEnd = bounds.childPrimaryEnd;
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700794
Alex Chaub5c4d112021-03-29 17:37:53 +0100795 // In case the pages are of different width, align the page to left edge for non-RTL
796 // or right edge for RTL.
797 final int pageScroll =
798 mIsRtl ? childPrimaryEnd - scrollOffsetEnd : childStart - scrollOffsetStart;
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700799 if (outPageScrolls[i] != pageScroll) {
800 pageScrollChanged = true;
801 outPageScrolls[i] = pageScroll;
802 }
Alex Chau2e487602022-03-15 19:34:08 +0000803 childStart += primaryDimension + getChildGap(i, i + delta);
Thales Limae4457742021-07-20 16:46:38 +0100804
805 // This makes sure that the space is added after the page, not after each panel
Thales Limac2a6f6f2021-09-09 17:06:22 +0100806 int lastPanel = mIsRtl ? 0 : panelCount - 1;
807 if (i % panelCount == lastPanel) {
Thales Limae4457742021-07-20 16:46:38 +0100808 childStart += mPageSpacing;
809 }
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700810 }
811 }
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100812
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100813 if (panelCount > 1) {
814 for (int i = 0; i < childCount; i++) {
Alex Chau1e448462021-08-13 21:48:35 +0100815 // In case we have multiple panels, always use left most panel's page scroll for all
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100816 // panels on the screen.
817 int adjustedScroll = outPageScrolls[getLeftmostVisiblePageForIndex(i)];
818 if (outPageScrolls[i] != adjustedScroll) {
819 outPageScrolls[i] = adjustedScroll;
820 pageScrollChanged = true;
821 }
822 }
823 }
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700824 return pageScrollChanged;
825 }
826
Alex Chau2e487602022-03-15 19:34:08 +0000827 protected int getChildGap(int fromIndex, int toIndex) {
Sunny Goyala1fbd842015-05-20 13:40:27 -0700828 return 0;
829 }
830
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700831 protected void updateMinAndMaxScrollX() {
Vinit Nayaka406f722019-12-19 11:50:55 -0800832 mMinScroll = computeMinScroll();
833 mMaxScroll = computeMaxScroll();
Tony Wickhamf549dab2016-05-16 09:54:06 -0700834 }
835
Vinit Nayaka406f722019-12-19 11:50:55 -0800836 protected int computeMinScroll() {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700837 return 0;
Tony50876bf2018-09-19 23:09:14 -0400838 }
839
Vinit Nayaka406f722019-12-19 11:50:55 -0800840 protected int computeMaxScroll() {
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700841 int childCount = getChildCount();
842 if (childCount > 0) {
Sunny Goyal70660032015-05-14 00:07:08 -0700843 final int index = mIsRtl ? 0 : childCount - 1;
Tony Wickhamf549dab2016-05-16 09:54:06 -0700844 return getScrollForPage(index);
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700845 } else {
Tony Wickhamf549dab2016-05-16 09:54:06 -0700846 return 0;
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700847 }
848 }
849
Adam Cohen3b185e22013-10-29 14:45:58 -0700850 public void setPageSpacing(int pageSpacing) {
851 mPageSpacing = pageSpacing;
852 requestLayout();
853 }
854
Tony50876bf2018-09-19 23:09:14 -0400855 public int getPageSpacing() {
856 return mPageSpacing;
857 }
858
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800859 private void dispatchPageCountChanged() {
860 if (mPageIndicator != null) {
Tony Wickhambab101c2021-09-20 15:12:44 -0700861 mPageIndicator.setMarkersCount(getChildCount() / getPanelCount());
Winson Chungd2be3812013-07-16 11:11:32 -0700862 }
Adam Cohen2591f6a2011-10-25 14:36:40 -0700863 // This ensures that when children are added, they get the correct transforms / alphas
864 // in accordance with any scroll effects.
Adam Cohen2591f6a2011-10-25 14:36:40 -0700865 invalidate();
866 }
867
Michael Jurka8b805b12012-04-18 14:23:14 -0700868 @Override
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800869 public void onViewAdded(View child) {
Winson Chungc7c51582018-02-23 17:58:36 -0800870 super.onViewAdded(child);
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800871 dispatchPageCountChanged();
872 }
873
874 @Override
875 public void onViewRemoved(View child) {
Winson Chungc7c51582018-02-23 17:58:36 -0800876 super.onViewRemoved(child);
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700877 runOnPageScrollsInitialized(() -> {
878 mCurrentPage = validateNewPage(mCurrentPage);
879 mCurrentScrollOverPage = mCurrentPage;
880 });
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800881 dispatchPageCountChanged();
Winson Chungd2be3812013-07-16 11:11:32 -0700882 }
883
Adam Cohen73894962011-10-31 13:17:17 -0700884 protected int getChildOffset(int index) {
Adam Cohen7d30a372013-07-01 17:03:59 -0700885 if (index < 0 || index > getChildCount() - 1) return 0;
Vinit Nayaka406f722019-12-19 11:50:55 -0800886 View pageAtIndex = getPageAt(index);
887 return mOrientationHandler.getChildStart(pageAtIndex);
Adam Cohen73894962011-10-31 13:17:17 -0700888 }
889
Alex Chau7944ee52021-01-08 19:07:25 +0000890 protected int getChildVisibleSize(int index) {
891 View layout = getPageAt(index);
892 return mOrientationHandler.getMeasuredSize(layout);
893 }
894
Winson Chung321e9ee2010-08-09 13:37:56 -0700895 @Override
896 public boolean requestChildRectangleOnScreen(View child, Rect rectangle, boolean immediate) {
Andras Kloczl7e912442021-05-06 12:50:28 +0200897 int page = indexOfChild(child);
898 if (!isVisible(page) || !mScroller.isFinished()) {
Vadim Trysheveeaa8ee2018-04-11 12:23:42 -0700899 if (immediate) {
900 setCurrentPage(page);
901 } else {
902 snapToPage(page);
903 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700904 return true;
905 }
906 return false;
907 }
908
909 @Override
910 protected boolean onRequestFocusInDescendants(int direction, Rect previouslyFocusedRect) {
Winson Chung86f77532010-08-24 11:08:22 -0700911 int focusablePage;
912 if (mNextPage != INVALID_PAGE) {
913 focusablePage = mNextPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700914 } else {
Winson Chung86f77532010-08-24 11:08:22 -0700915 focusablePage = mCurrentPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700916 }
Winson Chung86f77532010-08-24 11:08:22 -0700917 View v = getPageAt(focusablePage);
Winson Chung321e9ee2010-08-09 13:37:56 -0700918 if (v != null) {
Adam Cohen76fc0852011-06-17 13:26:23 -0700919 return v.requestFocus(direction, previouslyFocusedRect);
Winson Chung321e9ee2010-08-09 13:37:56 -0700920 }
921 return false;
922 }
923
924 @Override
925 public boolean dispatchUnhandledMove(View focused, int direction) {
Sunny Goyal0c4e3722015-12-01 13:21:49 -0800926 if (super.dispatchUnhandledMove(focused, direction)) {
927 return true;
928 }
929
930 if (mIsRtl) {
931 if (direction == View.FOCUS_LEFT) {
932 direction = View.FOCUS_RIGHT;
933 } else if (direction == View.FOCUS_RIGHT) {
934 direction = View.FOCUS_LEFT;
935 }
936 }
Andras Kloczl7e912442021-05-06 12:50:28 +0200937
938 int currentPage = getNextPage();
939 int closestNeighbourIndex = -1;
940 int closestNeighbourDistance = Integer.MAX_VALUE;
941 // Find the closest neighbour page
942 for (int neighbourPageIndex : getNeighbourPageIndices(direction)) {
943 int distance = Math.abs(neighbourPageIndex - currentPage);
944 if (closestNeighbourDistance > distance) {
945 closestNeighbourDistance = distance;
946 closestNeighbourIndex = neighbourPageIndex;
Winson Chung321e9ee2010-08-09 13:37:56 -0700947 }
948 }
Andras Kloczl7e912442021-05-06 12:50:28 +0200949 if (closestNeighbourIndex != -1) {
950 View page = getPageAt(closestNeighbourIndex);
951 snapToPage(closestNeighbourIndex);
952 page.requestFocus(direction);
953 return true;
954 }
955
Sunny Goyal0c4e3722015-12-01 13:21:49 -0800956 return false;
Winson Chung321e9ee2010-08-09 13:37:56 -0700957 }
958
959 @Override
960 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) {
Jon Miranda6a858172016-10-25 16:19:17 -0700961 if (getDescendantFocusability() == FOCUS_BLOCK_DESCENDANTS) {
962 return;
963 }
964
Andras Kloczl7e912442021-05-06 12:50:28 +0200965 // nextPage is more reliable when multiple control movements have been done in a short
966 // period of time
967 getPageIndices(getNextPage())
968 .addAll(getNeighbourPageIndices(direction))
969 .forEach(pageIndex ->
970 getPageAt(pageIndex).addFocusables(views, direction, focusableMode));
Winson Chung321e9ee2010-08-09 13:37:56 -0700971 }
972
973 /**
974 * If one of our descendant views decides that it could be focused now, only
Winson Chung86f77532010-08-24 11:08:22 -0700975 * pass that along if it's on the current page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700976 *
Winson Chung86f77532010-08-24 11:08:22 -0700977 * This happens when live folders requery, and if they're off page, they
978 * end up calling requestFocus, which pulls it on page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700979 */
980 @Override
981 public void focusableViewAvailable(View focused) {
Winson Chung86f77532010-08-24 11:08:22 -0700982 View current = getPageAt(mCurrentPage);
Winson Chung321e9ee2010-08-09 13:37:56 -0700983 View v = focused;
984 while (true) {
985 if (v == current) {
986 super.focusableViewAvailable(focused);
987 return;
988 }
989 if (v == this) {
990 return;
991 }
992 ViewParent parent = v.getParent();
993 if (parent instanceof View) {
994 v = (View)v.getParent();
995 } else {
996 return;
997 }
998 }
999 }
1000
1001 /**
1002 * {@inheritDoc}
1003 */
1004 @Override
1005 public void requestDisallowInterceptTouchEvent(boolean disallowIntercept) {
1006 if (disallowIntercept) {
1007 // We need to make sure to cancel our long press if
1008 // a scrollable widget takes over touch events
Andras Kloczl7a1ca0b2021-04-08 16:08:16 +02001009 cancelCurrentPageLongPress();
Winson Chung321e9ee2010-08-09 13:37:56 -07001010 }
1011 super.requestDisallowInterceptTouchEvent(disallowIntercept);
1012 }
1013
1014 @Override
1015 public boolean onInterceptTouchEvent(MotionEvent ev) {
1016 /*
1017 * This method JUST determines whether we want to intercept the motion.
1018 * If we return true, onTouchEvent will be called and we do the actual
1019 * scrolling there.
1020 */
1021
Winson Chung45e1d6e2010-11-09 17:19:49 -08001022 // Skip touch handling if there are no pages to swipe
Tony Wickhamb6841ac2019-07-22 12:39:59 -07001023 if (getChildCount() <= 0) return false;
Sunny Goyalc4bb3732019-06-20 11:34:14 -07001024
1025 acquireVelocityTrackerAndAddMovement(ev);
Winson Chung45e1d6e2010-11-09 17:19:49 -08001026
Winson Chung321e9ee2010-08-09 13:37:56 -07001027 /*
1028 * Shortcut the most recurring case: the user is in the dragging
1029 * state and he is moving his finger. We want to intercept this
1030 * motion.
1031 */
1032 final int action = ev.getAction();
Sunny Goyalaad33592018-08-07 17:20:35 -07001033 if ((action == MotionEvent.ACTION_MOVE) && mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001034 return true;
1035 }
1036
Winson Chung321e9ee2010-08-09 13:37:56 -07001037 switch (action & MotionEvent.ACTION_MASK) {
1038 case MotionEvent.ACTION_MOVE: {
1039 /*
1040 * mIsBeingDragged == false, otherwise the shortcut would have caught it. Check
Vinit Nayaka406f722019-12-19 11:50:55 -08001041 * whether the user has moved far enough from their original down touch.
Winson Chung321e9ee2010-08-09 13:37:56 -07001042 */
Michael Jurka1ff706b2010-09-14 17:35:20 -07001043 if (mActivePointerId != INVALID_POINTER) {
1044 determineScrollingStart(ev);
Michael Jurka1ff706b2010-09-14 17:35:20 -07001045 }
1046 // if mActivePointerId is INVALID_POINTER, then we must have missed an ACTION_DOWN
Vinit Nayaka406f722019-12-19 11:50:55 -08001047 // event. in that case, treat the first occurrence of a move event as a ACTION_DOWN
Michael Jurka1ff706b2010-09-14 17:35:20 -07001048 // i.e. fall through to the next case (don't break)
1049 // (We sometimes miss ACTION_DOWN events in Workspace because it ignores all events
1050 // while it's small- this was causing a crash before we checked for INVALID_POINTER)
Adam Cohen93c97562013-09-26 13:48:01 -07001051 break;
Winson Chung321e9ee2010-08-09 13:37:56 -07001052 }
1053
1054 case MotionEvent.ACTION_DOWN: {
1055 final float x = ev.getX();
1056 final float y = ev.getY();
1057 // Remember location of down touch
1058 mDownMotionX = x;
Adam Cohen7d30a372013-07-01 17:03:59 -07001059 mDownMotionY = y;
Jon Mirandaf52af432020-04-10 17:25:57 -07001060 mDownMotionPrimary = mLastMotion = mOrientationHandler.getPrimaryDirection(ev, 0);
Vinit Nayaka406f722019-12-19 11:50:55 -08001061 mLastMotionRemainder = 0;
1062 mTotalMotion = 0;
Winson Chung4941f652020-06-18 15:11:53 -07001063 mAllowEasyFling = false;
Winson Chung321e9ee2010-08-09 13:37:56 -07001064 mActivePointerId = ev.getPointerId(0);
Sunny Goyalc39db732021-04-03 01:20:21 -07001065 updateIsBeingDraggedOnTouchDown(ev);
Winson Chung321e9ee2010-08-09 13:37:56 -07001066 break;
1067 }
1068
Winson Chung321e9ee2010-08-09 13:37:56 -07001069 case MotionEvent.ACTION_UP:
Jeff Brown1d0867c2010-12-02 18:27:39 -08001070 case MotionEvent.ACTION_CANCEL:
Adam Cohen7d30a372013-07-01 17:03:59 -07001071 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001072 break;
1073
1074 case MotionEvent.ACTION_POINTER_UP:
1075 onSecondaryPointerUp(ev);
Adam Cohen6342bba2011-03-10 11:33:35 -08001076 releaseVelocityTracker();
Winson Chung321e9ee2010-08-09 13:37:56 -07001077 break;
1078 }
1079
1080 /*
1081 * The only time we want to intercept motion events is if we are in the
1082 * drag mode.
1083 */
Sunny Goyalaad33592018-08-07 17:20:35 -07001084 return mIsBeingDragged;
Winson Chung321e9ee2010-08-09 13:37:56 -07001085 }
1086
Tony Wickhama0aee212019-09-18 09:24:03 -07001087 /**
1088 * If being flinged and user touches the screen, initiate drag; otherwise don't.
1089 */
Sunny Goyalbb030562021-07-19 16:28:39 -07001090 protected void updateIsBeingDraggedOnTouchDown(MotionEvent ev) {
Tony Wickhama0aee212019-09-18 09:24:03 -07001091 // mScroller.isFinished should be false when being flinged.
Sunny Goyalc39db732021-04-03 01:20:21 -07001092 final int xDist = Math.abs(mScroller.getFinalX() - mScroller.getCurrX());
Winson Chung4941f652020-06-18 15:11:53 -07001093 final boolean finishedScrolling = (mScroller.isFinished() || xDist < mPageSlop / 3);
Tony Wickhama0aee212019-09-18 09:24:03 -07001094
1095 if (finishedScrolling) {
1096 mIsBeingDragged = false;
1097 if (!mScroller.isFinished() && !mFreeScroll) {
1098 setCurrentPage(getNextPage());
1099 pageEndTransition();
1100 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001101 mIsBeingDragged = !mEdgeGlowLeft.isFinished() || !mEdgeGlowRight.isFinished();
Tony Wickhama0aee212019-09-18 09:24:03 -07001102 } else {
1103 mIsBeingDragged = true;
1104 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001105
1106 // Catch the edge effect if it is active.
1107 float displacement = mOrientationHandler.getSecondaryValue(ev.getX(), ev.getY())
1108 / mOrientationHandler.getSecondaryValue(getWidth(), getHeight());
1109 if (!mEdgeGlowLeft.isFinished()) {
1110 mEdgeGlowLeft.onPullDistance(0f, 1f - displacement);
1111 }
1112 if (!mEdgeGlowRight.isFinished()) {
1113 mEdgeGlowRight.onPullDistance(0f, displacement);
1114 }
Tony Wickhama0aee212019-09-18 09:24:03 -07001115 }
1116
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001117 public boolean isHandlingTouch() {
Sunny Goyalaad33592018-08-07 17:20:35 -07001118 return mIsBeingDragged;
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001119 }
1120
Adam Cohenf8d28232011-02-01 21:47:00 -08001121 protected void determineScrollingStart(MotionEvent ev) {
1122 determineScrollingStart(ev, 1.0f);
1123 }
1124
Winson Chung321e9ee2010-08-09 13:37:56 -07001125 /*
1126 * Determines if we should change the touch state to start scrolling after the
1127 * user moves their touch point too far.
1128 */
Adam Cohenf8d28232011-02-01 21:47:00 -08001129 protected void determineScrollingStart(MotionEvent ev, float touchSlopScale) {
Adam Cohen7d30a372013-07-01 17:03:59 -07001130 // Disallow scrolling if we don't have a valid pointer index
Winson Chung321e9ee2010-08-09 13:37:56 -07001131 final int pointerIndex = ev.findPointerIndex(mActivePointerId);
Adam Cohen7d30a372013-07-01 17:03:59 -07001132 if (pointerIndex == -1) return;
1133
Vinit Nayaka406f722019-12-19 11:50:55 -08001134 final float primaryDirection = mOrientationHandler.getPrimaryDirection(ev, pointerIndex);
1135 final int diff = (int) Math.abs(primaryDirection - mLastMotion);
Adam Cohenf8d28232011-02-01 21:47:00 -08001136 final int touchSlop = Math.round(touchSlopScale * mTouchSlop);
Winson Chung4941f652020-06-18 15:11:53 -07001137 boolean moved = diff > touchSlop || ev.getAction() == ACTION_MOVE_ALLOW_EASY_FLING;
Winson Chung321e9ee2010-08-09 13:37:56 -07001138
Vinit Nayaka406f722019-12-19 11:50:55 -08001139 if (moved) {
Sunny Goyal5a1f53b2015-05-27 10:24:24 -07001140 // Scroll if the user moved far enough along the X axis
Sunny Goyalaad33592018-08-07 17:20:35 -07001141 mIsBeingDragged = true;
Vinit Nayaka406f722019-12-19 11:50:55 -08001142 mTotalMotion += Math.abs(mLastMotion - primaryDirection);
1143 mLastMotion = primaryDirection;
1144 mLastMotionRemainder = 0;
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001145 pageBeginTransition();
Tony Wickhamdadb3042016-02-24 11:07:00 -08001146 // Stop listening for things like pinches.
1147 requestDisallowInterceptTouchEvent(true);
Adam Cohenf8d28232011-02-01 21:47:00 -08001148 }
1149 }
1150
1151 protected void cancelCurrentPageLongPress() {
Sunny Goyal8e2133b2015-05-06 13:39:07 -07001152 // Try canceling the long press. It could also have been scheduled
1153 // by a distant descendant, so use the mAllowLongPress flag to block
1154 // everything
Sunny Goyal59969372021-05-06 12:11:44 -07001155 forEachVisiblePage(View::cancelLongPress);
Winson Chung321e9ee2010-08-09 13:37:56 -07001156 }
1157
Adam Cohenb5ba0972011-09-07 18:02:31 -07001158 protected float getScrollProgress(int screenCenter, View v, int page) {
Sunny Goyal228153d2018-01-04 15:35:22 -08001159 final int halfScreenSize = getMeasuredWidth() / 2;
Adam Cohenedb40762013-07-18 16:45:45 -07001160 int delta = screenCenter - (getScrollForPage(page) + halfScreenSize);
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001161 int panelCount = getPanelCount();
1162 int pageCount = getChildCount();
Adam Cohen3b185e22013-10-29 14:45:58 -07001163
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001164 int adjacentPage = page + panelCount;
Sunny Goyal70660032015-05-14 00:07:08 -07001165 if ((delta < 0 && !mIsRtl) || (delta > 0 && mIsRtl)) {
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001166 adjacentPage = page - panelCount;
Adam Cohen3b185e22013-10-29 14:45:58 -07001167 }
1168
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001169 final int totalDistance;
1170 if (adjacentPage < 0 || adjacentPage > pageCount - 1) {
1171 totalDistance = (v.getMeasuredWidth() + mPageSpacing) * panelCount;
Adam Cohen3b185e22013-10-29 14:45:58 -07001172 } else {
1173 totalDistance = Math.abs(getScrollForPage(adjacentPage) - getScrollForPage(page));
1174 }
Adam Cohenb5ba0972011-09-07 18:02:31 -07001175
1176 float scrollProgress = delta / (totalDistance * 1.0f);
Sunny Goyal8e2133b2015-05-06 13:39:07 -07001177 scrollProgress = Math.min(scrollProgress, MAX_SCROLL_PROGRESS);
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001178 scrollProgress = Math.max(scrollProgress, -MAX_SCROLL_PROGRESS);
Adam Cohenb5ba0972011-09-07 18:02:31 -07001179 return scrollProgress;
1180 }
1181
Adam Cohenedb40762013-07-18 16:45:45 -07001182 public int getScrollForPage(int index) {
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -07001183 if (!pageScrollsInitialized() || index >= mPageScrolls.length || index < 0) {
Adam Cohenedb40762013-07-18 16:45:45 -07001184 return 0;
1185 } else {
1186 return mPageScrolls[index];
1187 }
1188 }
1189
Adam Cohen564a2e72013-10-09 14:47:32 -07001190 // While layout transitions are occurring, a child's position may stray from its baseline
1191 // position. This method returns the magnitude of this stray at any given time.
1192 public int getLayoutTransitionOffsetForPage(int index) {
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -07001193 if (!pageScrollsInitialized() || index >= mPageScrolls.length || index < 0) {
Adam Cohen564a2e72013-10-09 14:47:32 -07001194 return 0;
1195 } else {
1196 View child = getChildAt(index);
Adam Cohen3b185e22013-10-29 14:45:58 -07001197
Sunny Goyal228153d2018-01-04 15:35:22 -08001198 int scrollOffset = mIsRtl ? getPaddingRight() : getPaddingLeft();
1199 int baselineX = mPageScrolls[index] + scrollOffset;
Adam Cohen564a2e72013-10-09 14:47:32 -07001200 return (int) (child.getX() - baselineX);
1201 }
1202 }
1203
Tony Wickham023f4042019-01-29 10:52:31 -08001204 public void setEnableFreeScroll(boolean freeScroll) {
Winson Chung0e449002019-04-26 11:09:58 -07001205 if (mFreeScroll == freeScroll) {
1206 return;
1207 }
1208
Tony Wickham8f7ead32016-04-07 18:46:44 -07001209 boolean wasFreeScroll = mFreeScroll;
Adam Cohenf358a4b2013-07-23 16:47:31 -07001210 mFreeScroll = freeScroll;
1211
Adam Cohenf9618852013-11-08 06:45:03 -08001212 if (mFreeScroll) {
Sunny Goyal4d519f22017-10-24 10:32:40 -07001213 setCurrentPage(getNextPage());
Tony Wickham8f7ead32016-04-07 18:46:44 -07001214 } else if (wasFreeScroll) {
Tony Wickhamaf33f2c2019-10-04 12:55:22 -07001215 if (getScrollForPage(getNextPage()) != getScrollX()) {
1216 snapToPage(getNextPage());
1217 }
Adam Cohenf358a4b2013-07-23 16:47:31 -07001218 }
Adam Cohenf358a4b2013-07-23 16:47:31 -07001219 }
1220
Sunny Goyal2f0ec852015-03-26 13:38:27 -07001221 protected void setEnableOverscroll(boolean enable) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001222 mAllowOverScroll = enable;
1223 }
1224
Andras Kloczl07111f22022-03-30 17:25:54 +01001225 protected boolean isSignificantMove(float absoluteDelta, int pageOrientedSize) {
1226 return absoluteDelta > pageOrientedSize * SIGNIFICANT_MOVE_THRESHOLD;
Alex Chau822acf42021-06-03 11:35:05 +01001227 }
1228
Winson Chung321e9ee2010-08-09 13:37:56 -07001229 @Override
1230 public boolean onTouchEvent(MotionEvent ev) {
Winson Chung45e1d6e2010-11-09 17:19:49 -08001231 // Skip touch handling if there are no pages to swipe
Tony Wickhamb6841ac2019-07-22 12:39:59 -07001232 if (getChildCount() <= 0) return false;
Winson Chung45e1d6e2010-11-09 17:19:49 -08001233
Michael Jurkab8f06722010-10-10 15:58:46 -07001234 acquireVelocityTrackerAndAddMovement(ev);
Winson Chung321e9ee2010-08-09 13:37:56 -07001235
1236 final int action = ev.getAction();
1237
1238 switch (action & MotionEvent.ACTION_MASK) {
1239 case MotionEvent.ACTION_DOWN:
Sunny Goyalc39db732021-04-03 01:20:21 -07001240 updateIsBeingDraggedOnTouchDown(ev);
Tony Wickhama0aee212019-09-18 09:24:03 -07001241
Winson Chung321e9ee2010-08-09 13:37:56 -07001242 /*
1243 * If being flinged and user touches, stop the fling. isFinished
1244 * will be false if being flinged.
1245 */
1246 if (!mScroller.isFinished()) {
Adam Cohen8bdbaab2013-10-29 15:25:02 -07001247 abortScrollerAnimation(false);
Winson Chung321e9ee2010-08-09 13:37:56 -07001248 }
1249
1250 // Remember where the motion event started
Vinit Nayaka406f722019-12-19 11:50:55 -08001251 mDownMotionX = ev.getX();
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001252 mDownMotionY = ev.getY();
Vinit Nayaka406f722019-12-19 11:50:55 -08001253 mDownMotionPrimary = mLastMotion = mOrientationHandler.getPrimaryDirection(ev, 0);
1254 mLastMotionRemainder = 0;
1255 mTotalMotion = 0;
Winson Chung4941f652020-06-18 15:11:53 -07001256 mAllowEasyFling = false;
Winson Chung321e9ee2010-08-09 13:37:56 -07001257 mActivePointerId = ev.getPointerId(0);
Sunny Goyalaad33592018-08-07 17:20:35 -07001258 if (mIsBeingDragged) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001259 pageBeginTransition();
Michael Jurka0142d492010-08-25 17:46:15 -07001260 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001261 break;
1262
Winson Chung4941f652020-06-18 15:11:53 -07001263 case ACTION_MOVE_ALLOW_EASY_FLING:
1264 // Start scrolling immediately
1265 determineScrollingStart(ev);
1266 mAllowEasyFling = true;
1267 break;
1268
1269 case MotionEvent.ACTION_MOVE:
1270 if (mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001271 // Scroll to follow the motion event
1272 final int pointerIndex = ev.findPointerIndex(mActivePointerId);
Adam Cohen7d30a372013-07-01 17:03:59 -07001273
1274 if (pointerIndex == -1) return true;
Sunny Goyalc39db732021-04-03 01:20:21 -07001275 float oldScroll = mOrientationHandler.getPrimaryScroll(this);
1276 float dx = ev.getX(pointerIndex);
1277 float dy = ev.getY(pointerIndex);
Adam Cohen7d30a372013-07-01 17:03:59 -07001278
Sunny Goyalc39db732021-04-03 01:20:21 -07001279 float direction = mOrientationHandler.getPrimaryValue(dx, dy);
Vinit Nayaka406f722019-12-19 11:50:55 -08001280 float delta = mLastMotion + mLastMotionRemainder - direction;
Sunny Goyalc39db732021-04-03 01:20:21 -07001281
1282 int width = getWidth();
1283 int height = getHeight();
1284 int size = mOrientationHandler.getPrimaryValue(width, height);
1285
1286 final float displacement = mOrientationHandler.getSecondaryValue(dx, dy)
1287 / mOrientationHandler.getSecondaryValue(width, height);
Vinit Nayaka406f722019-12-19 11:50:55 -08001288 mTotalMotion += Math.abs(delta);
Adam Cohenaefd4e12011-02-14 16:39:38 -08001289
Sunny Goyalc39db732021-04-03 01:20:21 -07001290 if (mAllowOverScroll) {
1291 float consumed = 0;
1292 if (delta < 0 && mEdgeGlowRight.getDistance() != 0f) {
1293 consumed = size * mEdgeGlowRight.onPullDistance(delta / size, displacement);
1294 } else if (delta > 0 && mEdgeGlowLeft.getDistance() != 0f) {
1295 consumed = -size * mEdgeGlowLeft.onPullDistance(
1296 -delta / size, 1 - displacement);
1297 }
1298 delta -= consumed;
1299 }
Alex Chau822acf42021-06-03 11:35:05 +01001300 delta /= mOrientationHandler.getPrimaryScale(this);
Sunny Goyalc39db732021-04-03 01:20:21 -07001301
Winson Chungc0844aa2011-02-02 15:25:58 -08001302 // Only scroll and update mLastMotionX if we have moved some discrete amount. We
1303 // keep the remainder because we are actually testing if we've moved from the last
1304 // scrolled position (which is discrete).
Sunny Goyalc39db732021-04-03 01:20:21 -07001305 mLastMotion = direction;
1306 int movedDelta = (int) delta;
1307 mLastMotionRemainder = delta - movedDelta;
Vinit Nayaka406f722019-12-19 11:50:55 -08001308
Sunny Goyalc39db732021-04-03 01:20:21 -07001309 if (delta != 0) {
Alex Chau6499e832021-11-19 14:35:46 +00001310 mOrientationHandler.setPrimary(this, VIEW_SCROLL_BY, movedDelta);
Sunny Goyalc39db732021-04-03 01:20:21 -07001311
1312 if (mAllowOverScroll) {
1313 final float pulledToX = oldScroll + delta;
1314
1315 if (pulledToX < mMinScroll) {
1316 mEdgeGlowLeft.onPullDistance(-delta / size, 1.f - displacement);
1317 if (!mEdgeGlowRight.isFinished()) {
1318 mEdgeGlowRight.onRelease();
1319 }
1320 } else if (pulledToX > mMaxScroll) {
1321 mEdgeGlowRight.onPullDistance(delta / size, displacement);
1322 if (!mEdgeGlowLeft.isFinished()) {
1323 mEdgeGlowLeft.onRelease();
1324 }
1325 }
1326
1327 if (!mEdgeGlowLeft.isFinished() || !mEdgeGlowRight.isFinished()) {
1328 postInvalidateOnAnimation();
1329 }
1330 }
1331
Winson Chung321e9ee2010-08-09 13:37:56 -07001332 } else {
1333 awakenScrollBars();
1334 }
Adam Cohen564976a2010-10-13 18:52:07 -07001335 } else {
Winson Chung321e9ee2010-08-09 13:37:56 -07001336 determineScrollingStart(ev);
1337 }
1338 break;
1339
1340 case MotionEvent.ACTION_UP:
Sunny Goyalaad33592018-08-07 17:20:35 -07001341 if (mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001342 final int activePointerId = mActivePointerId;
1343 final int pointerIndex = ev.findPointerIndex(activePointerId);
Vinit Nayak93bf1fe2020-05-26 17:22:13 -07001344 if (pointerIndex == -1) return true;
1345
Vinit Nayaka406f722019-12-19 11:50:55 -08001346 final float primaryDirection = mOrientationHandler.getPrimaryDirection(ev,
1347 pointerIndex);
Sunny Goyal4bb8b062019-02-19 16:37:38 -08001348 final VelocityTracker velocityTracker = mVelocityTracker;
1349 velocityTracker.computeCurrentVelocity(1000, mMaximumVelocity);
Adam Cohenaefd4e12011-02-14 16:39:38 -08001350
Vinit Nayaka406f722019-12-19 11:50:55 -08001351 int velocity = (int) mOrientationHandler.getPrimaryVelocity(velocityTracker,
Andras Kloczl07111f22022-03-30 17:25:54 +01001352 mActivePointerId);
Alex Chau822acf42021-06-03 11:35:05 +01001353 float delta = primaryDirection - mDownMotionPrimary;
Andras Kloczl07111f22022-03-30 17:25:54 +01001354 int pageOrientedSize = (int) (mOrientationHandler.getMeasuredSize(
1355 getPageAt(mCurrentPage))
1356 * mOrientationHandler.getPrimaryScale(this));
1357 boolean isSignificantMove = isSignificantMove(Math.abs(delta), pageOrientedSize);
Vinit Nayaka406f722019-12-19 11:50:55 -08001358
1359 mTotalMotion += Math.abs(mLastMotion + mLastMotionRemainder - primaryDirection);
Winson Chung4941f652020-06-18 15:11:53 -07001360 boolean passedSlop = mAllowEasyFling || mTotalMotion > mPageSlop;
1361 boolean isFling = passedSlop && shouldFlingForVelocity(velocity);
Vinit Nayaka406f722019-12-19 11:50:55 -08001362 boolean isDeltaLeft = mIsRtl ? delta > 0 : delta < 0;
1363 boolean isVelocityLeft = mIsRtl ? velocity > 0 : velocity < 0;
Winson Chung4941f652020-06-18 15:11:53 -07001364 if (DEBUG_FAILED_QUICKSWITCH && !isFling && mAllowEasyFling) {
1365 Log.d("Quickswitch", "isFling=false vel=" + velocity
1366 + " threshold=" + mEasyFlingThresholdVelocity);
1367 }
Adam Cohen00481b32011-11-18 12:03:48 -08001368
Adam Cohenf358a4b2013-07-23 16:47:31 -07001369 if (!mFreeScroll) {
1370 // In the case that the page is moved far to one direction and then is flung
1371 // in the opposite direction, we use a threshold to determine whether we should
1372 // just return to the starting page, or if we should skip one further.
1373 boolean returnToOriginalPage = false;
Vinit Nayaka406f722019-12-19 11:50:55 -08001374 if (Math.abs(delta) > pageOrientedSize * RETURN_TO_ORIGINAL_PAGE_THRESHOLD &&
1375 Math.signum(velocity) != Math.signum(delta) && isFling) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001376 returnToOriginalPage = true;
1377 }
Adam Cohenaefd4e12011-02-14 16:39:38 -08001378
Adam Cohenf358a4b2013-07-23 16:47:31 -07001379 int finalPage;
1380 // We give flings precedence over large moves, which is why we short-circuit our
1381 // test for a large move if a fling has been registered. That is, a large
1382 // move to the left and fling to the right will register as a fling to the right.
Sunny Goyalb7b01352018-08-09 12:31:20 -07001383
Vinit Nayaka406f722019-12-19 11:50:55 -08001384 if (((isSignificantMove && !isDeltaLeft && !isFling) ||
1385 (isFling && !isVelocityLeft)) && mCurrentPage > 0) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +01001386 finalPage = returnToOriginalPage
1387 ? mCurrentPage : mCurrentPage - getPanelCount();
Vinit Nayaka406f722019-12-19 11:50:55 -08001388 snapToPageWithVelocity(finalPage, velocity);
1389 } else if (((isSignificantMove && isDeltaLeft && !isFling) ||
1390 (isFling && isVelocityLeft)) &&
Adam Cohenf358a4b2013-07-23 16:47:31 -07001391 mCurrentPage < getChildCount() - 1) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +01001392 finalPage = returnToOriginalPage
1393 ? mCurrentPage : mCurrentPage + getPanelCount();
Vinit Nayaka406f722019-12-19 11:50:55 -08001394 snapToPageWithVelocity(finalPage, velocity);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001395 } else {
1396 snapToDestination();
Adam Cohenf358a4b2013-07-23 16:47:31 -07001397 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001398 } else {
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001399 if (!mScroller.isFinished()) {
1400 abortScrollerAnimation(true);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001401 }
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001402
Vinit Nayaka406f722019-12-19 11:50:55 -08001403 int initialScroll = mOrientationHandler.getPrimaryScroll(this);
1404 int maxScroll = mMaxScroll;
1405 int minScroll = mMinScroll;
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001406
Vinit Nayaka406f722019-12-19 11:50:55 -08001407 if (((initialScroll >= maxScroll) && (isVelocityLeft || !isFling)) ||
1408 ((initialScroll <= minScroll) && (!isVelocityLeft || !isFling))) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001409 mScroller.springBack(initialScroll, 0, minScroll, maxScroll, 0, 0);
Alex Chaub794ea62021-02-03 18:00:30 +00001410 mNextPage = getDestinationPage();
Sunny Goyalb7b01352018-08-09 12:31:20 -07001411 } else {
Sunny Goyalc39db732021-04-03 01:20:21 -07001412 int velocity1 = -velocity;
1413 // Continue a scroll or fling in progress
1414 mScroller.fling(initialScroll, 0, velocity1, 0, minScroll, maxScroll, 0, 0,
1415 Math.round(getWidth() * 0.5f * OVERSCROLL_DAMP_FACTOR), 0);
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001416
Sunny Goyalc39db732021-04-03 01:20:21 -07001417 int finalPos = mScroller.getFinalX();
Alex Chaub794ea62021-02-03 18:00:30 +00001418 mNextPage = getDestinationPage(finalPos);
Sunny Goyalc39db732021-04-03 01:20:21 -07001419 onNotSnappingToPageInFreeScroll();
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001420 }
1421 invalidate();
Winson Chung321e9ee2010-08-09 13:37:56 -07001422 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001423 }
Adam Cohen7d30a372013-07-01 17:03:59 -07001424
Sunny Goyalc39db732021-04-03 01:20:21 -07001425 mEdgeGlowLeft.onRelease();
1426 mEdgeGlowRight.onRelease();
Adam Cohen7d30a372013-07-01 17:03:59 -07001427 // End any intermediate reordering states
1428 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001429 break;
1430
1431 case MotionEvent.ACTION_CANCEL:
Sunny Goyalaad33592018-08-07 17:20:35 -07001432 if (mIsBeingDragged) {
Michael Jurkab8f06722010-10-10 15:58:46 -07001433 snapToDestination();
1434 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001435 mEdgeGlowLeft.onRelease();
1436 mEdgeGlowRight.onRelease();
Adam Cohen7d30a372013-07-01 17:03:59 -07001437 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001438 break;
1439
1440 case MotionEvent.ACTION_POINTER_UP:
1441 onSecondaryPointerUp(ev);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001442 releaseVelocityTracker();
Winson Chung321e9ee2010-08-09 13:37:56 -07001443 break;
1444 }
1445
1446 return true;
1447 }
1448
Sunny Goyalc39db732021-04-03 01:20:21 -07001449 protected void onNotSnappingToPageInFreeScroll() { }
Alex Chaub794ea62021-02-03 18:00:30 +00001450
Lais Andradecc5c8842021-06-04 18:20:30 +01001451 /**
1452 * Called when the view edges absorb part of the scroll. Subclasses can override this
1453 * to provide custom behavior during animation.
1454 */
1455 protected void onEdgeAbsorbingScroll() {
1456 }
1457
1458 /**
1459 * Called when the current page closest to the center of the screen changes as part of the
1460 * scroll. Subclasses can override this to provide custom behavior during scroll.
1461 */
1462 protected void onScrollOverPageChanged() {
1463 }
1464
Vinit Nayaka406f722019-12-19 11:50:55 -08001465 protected boolean shouldFlingForVelocity(int velocity) {
Winson Chung4941f652020-06-18 15:11:53 -07001466 float threshold = mAllowEasyFling ? mEasyFlingThresholdVelocity : mFlingThresholdVelocity;
1467 return Math.abs(velocity) > threshold;
Sunny Goyal65d9ceb2017-05-08 09:17:42 -07001468 }
1469
Alex Chau9d8eeab2022-04-05 17:13:56 +01001470 protected void resetTouchState() {
Adam Cohen7d30a372013-07-01 17:03:59 -07001471 releaseVelocityTracker();
Sunny Goyalaad33592018-08-07 17:20:35 -07001472 mIsBeingDragged = false;
Adam Cohen7d30a372013-07-01 17:03:59 -07001473 mActivePointerId = INVALID_POINTER;
Adam Cohen7d30a372013-07-01 17:03:59 -07001474 }
1475
Winson Chung185d7162011-02-28 13:47:29 -08001476 @Override
1477 public boolean onGenericMotionEvent(MotionEvent event) {
1478 if ((event.getSource() & InputDevice.SOURCE_CLASS_POINTER) != 0) {
1479 switch (event.getAction()) {
1480 case MotionEvent.ACTION_SCROLL: {
1481 // Handle mouse (or ext. device) by shifting the page depending on the scroll
1482 final float vscroll;
1483 final float hscroll;
1484 if ((event.getMetaState() & KeyEvent.META_SHIFT_ON) != 0) {
1485 vscroll = 0;
1486 hscroll = event.getAxisValue(MotionEvent.AXIS_VSCROLL);
1487 } else {
1488 vscroll = -event.getAxisValue(MotionEvent.AXIS_VSCROLL);
1489 hscroll = event.getAxisValue(MotionEvent.AXIS_HSCROLL);
1490 }
Sunny Goyal8b37c572020-03-31 12:12:14 -07001491 if (!canScroll(Math.abs(vscroll), Math.abs(hscroll))) {
1492 return false;
Samuel Fufa59cba192019-08-22 18:31:34 -07001493 }
Winson Chung185d7162011-02-28 13:47:29 -08001494 if (hscroll != 0 || vscroll != 0) {
Sunny Goyal70660032015-05-14 00:07:08 -07001495 boolean isForwardScroll = mIsRtl ? (hscroll < 0 || vscroll < 0)
Adam Cohen0ffac432013-07-10 11:19:26 -07001496 : (hscroll > 0 || vscroll > 0);
1497 if (isForwardScroll) {
Winson Chung185d7162011-02-28 13:47:29 -08001498 scrollRight();
1499 } else {
1500 scrollLeft();
1501 }
1502 return true;
1503 }
1504 }
1505 }
1506 }
1507 return super.onGenericMotionEvent(event);
1508 }
1509
Sunny Goyal8b37c572020-03-31 12:12:14 -07001510 /**
1511 * Returns true if the paged view can scroll for the provided vertical and horizontal
1512 * scroll values
1513 */
1514 protected boolean canScroll(float absVScroll, float absHScroll) {
1515 ActivityContext ac = ActivityContext.lookupContext(getContext());
1516 return (ac == null || AbstractFloatingView.getTopOpenView(ac) == null);
Samuel Fufa59cba192019-08-22 18:31:34 -07001517 }
1518
Michael Jurkab8f06722010-10-10 15:58:46 -07001519 private void acquireVelocityTrackerAndAddMovement(MotionEvent ev) {
1520 if (mVelocityTracker == null) {
1521 mVelocityTracker = VelocityTracker.obtain();
1522 }
1523 mVelocityTracker.addMovement(ev);
1524 }
1525
1526 private void releaseVelocityTracker() {
1527 if (mVelocityTracker != null) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001528 mVelocityTracker.clear();
Michael Jurkab8f06722010-10-10 15:58:46 -07001529 mVelocityTracker.recycle();
1530 mVelocityTracker = null;
1531 }
1532 }
1533
Winson Chung321e9ee2010-08-09 13:37:56 -07001534 private void onSecondaryPointerUp(MotionEvent ev) {
Winson Chung4941f652020-06-18 15:11:53 -07001535 final int pointerIndex = ev.getActionIndex();
Winson Chung321e9ee2010-08-09 13:37:56 -07001536 final int pointerId = ev.getPointerId(pointerIndex);
1537 if (pointerId == mActivePointerId) {
1538 // This was our active pointer going up. Choose a new
1539 // active pointer and adjust accordingly.
1540 // TODO: Make this decision more intelligent.
1541 final int newPointerIndex = pointerIndex == 0 ? 1 : 0;
Vinit Nayaka406f722019-12-19 11:50:55 -08001542 mLastMotion = mDownMotionPrimary = mOrientationHandler.getPrimaryDirection(ev,
1543 newPointerIndex);
1544 mLastMotionRemainder = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -07001545 mActivePointerId = ev.getPointerId(newPointerIndex);
1546 if (mVelocityTracker != null) {
1547 mVelocityTracker.clear();
1548 }
1549 }
Jeff Brown1d0867c2010-12-02 18:27:39 -08001550 }
1551
Winson Chung321e9ee2010-08-09 13:37:56 -07001552 @Override
1553 public void requestChildFocus(View child, View focused) {
1554 super.requestChildFocus(child, focused);
Andras Kloczl359d1ae2021-05-04 22:25:27 +02001555
1556 // In case the device is controlled by a controller, mCurrentPage isn't updated properly
1557 // which results in incorrect navigation
1558 int nextPage = getNextPage();
1559 if (nextPage != mCurrentPage) {
1560 setCurrentPage(nextPage);
1561 }
1562
Andras Kloczl7e912442021-05-06 12:50:28 +02001563 int page = indexOfChild(child);
1564 if (page >= 0 && !isVisible(page) && !isInTouchMode()) {
Winson Chung86f77532010-08-24 11:08:22 -07001565 snapToPage(page);
Winson Chung321e9ee2010-08-09 13:37:56 -07001566 }
1567 }
1568
Alex Chaub794ea62021-02-03 18:00:30 +00001569 public int getDestinationPage() {
1570 return getDestinationPage(mOrientationHandler.getPrimaryScroll(this));
1571 }
1572
Alex Chaudedbc8a2021-03-17 16:53:26 +00001573 protected int getDestinationPage(int primaryScroll) {
1574 return getPageNearestToCenterOfScreen(primaryScroll);
Alex Chaub794ea62021-02-03 18:00:30 +00001575 }
1576
Sunny Goyal228153d2018-01-04 15:35:22 -08001577 public int getPageNearestToCenterOfScreen() {
Vinit Nayaka406f722019-12-19 11:50:55 -08001578 return getPageNearestToCenterOfScreen(mOrientationHandler.getPrimaryScroll(this));
Tony Wickham8f7ead32016-04-07 18:46:44 -07001579 }
1580
Alex Chaudedbc8a2021-03-17 16:53:26 +00001581 private int getPageNearestToCenterOfScreen(int primaryScroll) {
1582 int screenCenter = getScreenCenter(primaryScroll);
Adam Cohen22f823d2011-09-01 17:22:18 -07001583 int minDistanceFromScreenCenter = Integer.MAX_VALUE;
Winson Chung321e9ee2010-08-09 13:37:56 -07001584 int minDistanceFromScreenCenterIndex = -1;
Winson Chung321e9ee2010-08-09 13:37:56 -07001585 final int childCount = getChildCount();
1586 for (int i = 0; i < childCount; ++i) {
Tony Wickham7383d4e2020-07-07 19:25:25 -07001587 int distanceFromScreenCenter = Math.abs(
1588 getDisplacementFromScreenCenter(i, screenCenter));
Winson Chung321e9ee2010-08-09 13:37:56 -07001589 if (distanceFromScreenCenter < minDistanceFromScreenCenter) {
1590 minDistanceFromScreenCenter = distanceFromScreenCenter;
1591 minDistanceFromScreenCenterIndex = i;
1592 }
1593 }
Adam Cohend19d3ca2010-09-15 14:43:42 -07001594 return minDistanceFromScreenCenterIndex;
1595 }
1596
Tony Wickham7383d4e2020-07-07 19:25:25 -07001597 private int getDisplacementFromScreenCenter(int childIndex, int screenCenter) {
Alex Chaudedbc8a2021-03-17 16:53:26 +00001598 int childSize = Math.round(getChildVisibleSize(childIndex));
Tony Wickham7383d4e2020-07-07 19:25:25 -07001599 int halfChildSize = (childSize / 2);
1600 int childCenter = getChildOffset(childIndex) + halfChildSize;
1601 return childCenter - screenCenter;
1602 }
1603
1604 protected int getDisplacementFromScreenCenter(int childIndex) {
Alex Chaudedbc8a2021-03-17 16:53:26 +00001605 int primaryScroll = mOrientationHandler.getPrimaryScroll(this);
1606 int screenCenter = getScreenCenter(primaryScroll);
Tony Wickham7383d4e2020-07-07 19:25:25 -07001607 return getDisplacementFromScreenCenter(childIndex, screenCenter);
1608 }
1609
Andras Kloczl9732df12021-09-09 19:40:42 +01001610 protected int getScreenCenter(int primaryScroll) {
Alex Chaudedbc8a2021-03-17 16:53:26 +00001611 float primaryScale = mOrientationHandler.getPrimaryScale(this);
1612 float primaryPivot = mOrientationHandler.getPrimaryValue(getPivotX(), getPivotY());
1613 int pageOrientationSize = mOrientationHandler.getMeasuredSize(this);
1614 return Math.round(primaryScroll + (pageOrientationSize / 2f - primaryPivot) / primaryScale
1615 + primaryPivot);
1616 }
1617
Adam Cohend19d3ca2010-09-15 14:43:42 -07001618 protected void snapToDestination() {
Sunny Goyalc39db732021-04-03 01:20:21 -07001619 snapToPage(getDestinationPage(), PAGE_SNAP_ANIMATION_DURATION);
Winson Chung321e9ee2010-08-09 13:37:56 -07001620 }
1621
Adam Cohene0f66b52010-11-23 15:06:07 -08001622 // We want the duration of the page snap animation to be influenced by the distance that
1623 // the screen has to travel, however, we don't want this duration to be effected in a
1624 // purely linear fashion. Instead, we use this method to moderate the effect that the distance
1625 // of travel has on the overall snap duration.
Sunny Goyal4d113a52015-05-27 10:05:28 -07001626 private float distanceInfluenceForSnapDuration(float f) {
Adam Cohene0f66b52010-11-23 15:06:07 -08001627 f -= 0.5f; // center the values about 0.
1628 f *= 0.3f * Math.PI / 2.0f;
1629 return (float) Math.sin(f);
1630 }
1631
Winson Chung05a31ed2018-02-08 17:08:43 -08001632 protected boolean snapToPageWithVelocity(int whichPage, int velocity) {
Adam Cohen6f127a62014-06-12 14:54:41 -07001633 whichPage = validateNewPage(whichPage);
Vinit Nayaka406f722019-12-19 11:50:55 -08001634 int halfScreenSize = mOrientationHandler.getMeasuredSize(this) / 2;
Adam Cohene0f66b52010-11-23 15:06:07 -08001635
Vinit Nayaka406f722019-12-19 11:50:55 -08001636 final int newLoc = getScrollForPage(whichPage);
Sunny Goyalc39db732021-04-03 01:20:21 -07001637 int delta = newLoc - mOrientationHandler.getPrimaryScroll(this);
Adam Cohene0f66b52010-11-23 15:06:07 -08001638 int duration = 0;
1639
Sunny Goyal4d113a52015-05-27 10:05:28 -07001640 if (Math.abs(velocity) < mMinFlingVelocity) {
Adam Cohene0f66b52010-11-23 15:06:07 -08001641 // If the velocity is low enough, then treat this more as an automatic page advance
1642 // as opposed to an apparent physical response to flinging
Winson Chung05a31ed2018-02-08 17:08:43 -08001643 return snapToPage(whichPage, PAGE_SNAP_ANIMATION_DURATION);
Adam Cohene0f66b52010-11-23 15:06:07 -08001644 }
1645
1646 // Here we compute a "distance" that will be used in the computation of the overall
1647 // snap duration. This is a function of the actual distance that needs to be traveled;
1648 // we keep this value close to half screen size in order to reduce the variance in snap
1649 // duration as a function of the distance the page needs to travel.
Michael Jurka20b7ca92011-06-07 20:09:16 -07001650 float distanceRatio = Math.min(1f, 1.0f * Math.abs(delta) / (2 * halfScreenSize));
Adam Cohene0f66b52010-11-23 15:06:07 -08001651 float distance = halfScreenSize + halfScreenSize *
1652 distanceInfluenceForSnapDuration(distanceRatio);
1653
1654 velocity = Math.abs(velocity);
Adam Cohen265b9a62011-12-07 14:37:18 -08001655 velocity = Math.max(mMinSnapVelocity, velocity);
Adam Cohene0f66b52010-11-23 15:06:07 -08001656
1657 // we want the page's snap velocity to approximately match the velocity at which the
1658 // user flings, so we scale the duration by a value near to the derivative of the scroll
Michael Jurka20b7ca92011-06-07 20:09:16 -07001659 // interpolator at zero, ie. 5. We use 4 to make it a little slower.
1660 duration = 4 * Math.round(1000 * Math.abs(distance / velocity));
Adam Cohene0f66b52010-11-23 15:06:07 -08001661
Sunny Goyalc39db732021-04-03 01:20:21 -07001662 return snapToPage(whichPage, delta, duration);
Michael Jurka0142d492010-08-25 17:46:15 -07001663 }
1664
Winson Chung05a31ed2018-02-08 17:08:43 -08001665 public boolean snapToPage(int whichPage) {
1666 return snapToPage(whichPage, PAGE_SNAP_ANIMATION_DURATION);
Winson Chung321e9ee2010-08-09 13:37:56 -07001667 }
1668
Winson Chung05a31ed2018-02-08 17:08:43 -08001669 public boolean snapToPageImmediately(int whichPage) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001670 return snapToPage(whichPage, PAGE_SNAP_ANIMATION_DURATION, true);
Adam Cohen7d30a372013-07-01 17:03:59 -07001671 }
1672
Winson Chung05a31ed2018-02-08 17:08:43 -08001673 public boolean snapToPage(int whichPage, int duration) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001674 return snapToPage(whichPage, duration, false);
Adam Cohen7d30a372013-07-01 17:03:59 -07001675 }
1676
Sunny Goyalc39db732021-04-03 01:20:21 -07001677 protected boolean snapToPage(int whichPage, int duration, boolean immediate) {
Adam Cohen6f127a62014-06-12 14:54:41 -07001678 whichPage = validateNewPage(whichPage);
Winson Chung321e9ee2010-08-09 13:37:56 -07001679
Vinit Nayaka406f722019-12-19 11:50:55 -08001680 int newLoc = getScrollForPage(whichPage);
Sunny Goyalc39db732021-04-03 01:20:21 -07001681 final int delta = newLoc - mOrientationHandler.getPrimaryScroll(this);
1682 return snapToPage(whichPage, delta, duration, immediate);
Michael Jurka0142d492010-08-25 17:46:15 -07001683 }
1684
Winson Chung05a31ed2018-02-08 17:08:43 -08001685 protected boolean snapToPage(int whichPage, int delta, int duration) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001686 return snapToPage(whichPage, delta, duration, false);
Adam Cohen7d30a372013-07-01 17:03:59 -07001687 }
Michael Jurka0142d492010-08-25 17:46:15 -07001688
Sunny Goyalc39db732021-04-03 01:20:21 -07001689 protected boolean snapToPage(int whichPage, int delta, int duration, boolean immediate) {
Sunny Goyal9bb8ffb2018-05-24 17:11:16 -07001690 if (mFirstLayout) {
1691 setCurrentPage(whichPage);
1692 return false;
1693 }
Tony Wickhamd58c2d52018-05-04 12:10:55 -07001694
Andy Wickhamda5a89b2021-07-23 12:38:14 -10001695 if (FeatureFlags.IS_STUDIO_BUILD && !Utilities.IS_RUNNING_IN_TEST_HARNESS) {
Tony Wickhamcb3f8702018-08-27 17:36:03 -07001696 duration *= Settings.Global.getFloat(getContext().getContentResolver(),
1697 Settings.Global.WINDOW_ANIMATION_SCALE, 1);
Tony Wickhamd58c2d52018-05-04 12:10:55 -07001698 }
1699
Adam Cohen6f127a62014-06-12 14:54:41 -07001700 whichPage = validateNewPage(whichPage);
1701
Adam Cohen7d30a372013-07-01 17:03:59 -07001702 mNextPage = whichPage;
Michael Jurka0142d492010-08-25 17:46:15 -07001703
Winson Chung321e9ee2010-08-09 13:37:56 -07001704 awakenScrollBars(duration);
Adam Cohen7d30a372013-07-01 17:03:59 -07001705 if (immediate) {
1706 duration = 0;
1707 } else if (duration == 0) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001708 duration = Math.abs(delta);
1709 }
1710
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001711 if (duration != 0) {
1712 pageBeginTransition();
1713 }
1714
Adam Cohenf358a4b2013-07-23 16:47:31 -07001715 if (!mScroller.isFinished()) {
Adam Cohenf9618852013-11-08 06:45:03 -08001716 abortScrollerAnimation(false);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001717 }
Adam Cohenf9618852013-11-08 06:45:03 -08001718
Sunny Goyalc39db732021-04-03 01:20:21 -07001719 mScroller.startScroll(mOrientationHandler.getPrimaryScroll(this), 0, delta, 0, duration);
Adam Cohen674531f2013-12-13 15:07:14 -08001720 updatePageIndicator();
Adam Cohen7d30a372013-07-01 17:03:59 -07001721
1722 // Trigger a compute() to finish switching pages if necessary
1723 if (immediate) {
1724 computeScroll();
Sunny Goyal76dbf6f2017-01-03 14:55:47 -08001725 pageEndTransition();
Adam Cohen7d30a372013-07-01 17:03:59 -07001726 }
1727
Winson Chung321e9ee2010-08-09 13:37:56 -07001728 invalidate();
Winson Chung05a31ed2018-02-08 17:08:43 -08001729 return Math.abs(delta) > 0;
Winson Chung321e9ee2010-08-09 13:37:56 -07001730 }
1731
Vadim Tryshev98913d02018-05-18 18:41:34 -07001732 public boolean scrollLeft() {
1733 if (getNextPage() > 0) {
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001734 snapToPage(getNextPage() - getPanelCount());
Vadim Tryshev98913d02018-05-18 18:41:34 -07001735 return true;
1736 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001737 return mAllowOverScroll;
Winson Chung321e9ee2010-08-09 13:37:56 -07001738 }
1739
Vadim Tryshev98913d02018-05-18 18:41:34 -07001740 public boolean scrollRight() {
1741 if (getNextPage() < getChildCount() - 1) {
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001742 snapToPage(getNextPage() + getPanelCount());
Vadim Tryshev98913d02018-05-18 18:41:34 -07001743 return true;
1744 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001745 return mAllowOverScroll;
Winson Chung321e9ee2010-08-09 13:37:56 -07001746 }
1747
Vadim Trysheve6bbefb2018-04-03 13:38:06 -07001748 @Override
Lais Andradecc5c8842021-06-04 18:20:30 +01001749 protected void onScrollChanged(int l, int t, int oldl, int oldt) {
Lais Andradef6e31b12021-10-27 12:04:28 +01001750 if (mScroller.isFinished()) {
1751 // This was not caused by the scroller, skip it.
1752 return;
1753 }
Lais Andradecc5c8842021-06-04 18:20:30 +01001754 int newDestinationPage = getDestinationPage();
1755 if (newDestinationPage >= 0 && newDestinationPage != mCurrentScrollOverPage) {
1756 mCurrentScrollOverPage = newDestinationPage;
1757 onScrollOverPageChanged();
1758 }
1759 }
1760
1761 @Override
Vadim Trysheve6bbefb2018-04-03 13:38:06 -07001762 public CharSequence getAccessibilityClassName() {
1763 // Some accessibility services have special logic for ScrollView. Since we provide same
1764 // accessibility info as ScrollView, inform the service to handle use the same way.
1765 return ScrollView.class.getName();
1766 }
1767
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001768 protected boolean isPageOrderFlipped() {
1769 return false;
1770 }
1771
Winson Chung6a0f57d2011-06-29 20:10:49 -07001772 /* Accessibility */
Sunny Goyalcf25b522015-07-09 00:01:18 -07001773 @SuppressWarnings("deprecation")
Winson Chung6a0f57d2011-06-29 20:10:49 -07001774 @Override
1775 public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) {
1776 super.onInitializeAccessibilityNodeInfo(info);
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001777 final boolean pagesFlipped = isPageOrderFlipped();
Alex Chau9ead9ca2021-11-26 16:22:49 +00001778 info.setScrollable(getPageCount() > 0);
1779 int primaryScroll = mOrientationHandler.getPrimaryScroll(this);
1780 if (getCurrentPage() < getPageCount() - getPanelCount()
1781 || (getCurrentPage() == getPageCount() - getPanelCount()
1782 && primaryScroll != getScrollForPage(getPageCount() - getPanelCount()))) {
yingleiw02cc8482019-08-02 16:14:27 -07001783 info.addAction(pagesFlipped ?
Alex Chau9ead9ca2021-11-26 16:22:49 +00001784 AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_BACKWARD
1785 : AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_FORWARD);
yingleiw02cc8482019-08-02 16:14:27 -07001786 info.addAction(mIsRtl ?
1787 AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_LEFT
1788 : AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_RIGHT);
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001789 }
Alex Chau9ead9ca2021-11-26 16:22:49 +00001790 if (getCurrentPage() > 0
1791 || (getCurrentPage() == 0 && primaryScroll != getScrollForPage(0))) {
yingleiw02cc8482019-08-02 16:14:27 -07001792 info.addAction(pagesFlipped ?
Alex Chau9ead9ca2021-11-26 16:22:49 +00001793 AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_FORWARD
1794 : AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_BACKWARD);
yingleiw02cc8482019-08-02 16:14:27 -07001795 info.addAction(mIsRtl ?
1796 AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_RIGHT
1797 : AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_LEFT);
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001798 }
Vadim Tryshev7af0d442015-05-15 08:48:11 -07001799 // Accessibility-wise, PagedView doesn't support long click, so disabling it.
1800 // Besides disabling the accessibility long-click, this also prevents this view from getting
1801 // accessibility focus.
1802 info.setLongClickable(false);
Sunny Goyala52ecb02016-12-16 15:04:51 -08001803 info.removeAction(AccessibilityNodeInfo.AccessibilityAction.ACTION_LONG_CLICK);
Winson Chung6a0f57d2011-06-29 20:10:49 -07001804 }
1805
1806 @Override
Alan Viverette254139a2013-10-08 13:13:46 -07001807 public void sendAccessibilityEvent(int eventType) {
1808 // Don't let the view send real scroll events.
1809 if (eventType != AccessibilityEvent.TYPE_VIEW_SCROLLED) {
1810 super.sendAccessibilityEvent(eventType);
1811 }
1812 }
1813
1814 @Override
Winson Chung6a0f57d2011-06-29 20:10:49 -07001815 public void onInitializeAccessibilityEvent(AccessibilityEvent event) {
1816 super.onInitializeAccessibilityEvent(event);
Pinyao Tingaf6daa22019-09-18 22:18:03 +00001817 event.setScrollable(mAllowOverScroll || getPageCount() > 1);
Winson Chung6a0f57d2011-06-29 20:10:49 -07001818 }
1819
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001820 @Override
1821 public boolean performAccessibilityAction(int action, Bundle arguments) {
1822 if (super.performAccessibilityAction(action, arguments)) {
1823 return true;
1824 }
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001825 final boolean pagesFlipped = isPageOrderFlipped();
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001826 switch (action) {
1827 case AccessibilityNodeInfo.ACTION_SCROLL_FORWARD: {
Vadim Tryshev98913d02018-05-18 18:41:34 -07001828 if (pagesFlipped ? scrollLeft() : scrollRight()) {
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001829 return true;
1830 }
1831 } break;
1832 case AccessibilityNodeInfo.ACTION_SCROLL_BACKWARD: {
Vadim Tryshev98913d02018-05-18 18:41:34 -07001833 if (pagesFlipped ? scrollRight() : scrollLeft()) {
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001834 return true;
1835 }
yingleiw02cc8482019-08-02 16:14:27 -07001836 } break;
1837 case android.R.id.accessibilityActionPageRight: {
1838 if (!mIsRtl) {
Alex Chau9ead9ca2021-11-26 16:22:49 +00001839 return scrollRight();
yingleiw02cc8482019-08-02 16:14:27 -07001840 } else {
Alex Chau9ead9ca2021-11-26 16:22:49 +00001841 return scrollLeft();
yingleiw02cc8482019-08-02 16:14:27 -07001842 }
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001843 }
yingleiw02cc8482019-08-02 16:14:27 -07001844 case android.R.id.accessibilityActionPageLeft: {
1845 if (!mIsRtl) {
Alex Chau9ead9ca2021-11-26 16:22:49 +00001846 return scrollLeft();
yingleiw02cc8482019-08-02 16:14:27 -07001847 } else {
Alex Chau9ead9ca2021-11-26 16:22:49 +00001848 return scrollRight();
yingleiw02cc8482019-08-02 16:14:27 -07001849 }
1850 }
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001851 }
1852 return false;
1853 }
1854
Vadim Tryshev2c430b32018-04-04 14:45:21 -07001855 protected boolean canAnnouncePageDescription() {
1856 return true;
1857 }
1858
Adam Cohen0ffac432013-07-10 11:19:26 -07001859 protected String getCurrentPageDescription() {
Sunny Goyalf4f89ef2015-09-02 15:06:12 -07001860 return getContext().getString(R.string.default_scroll_format,
Adam Cohen0ffac432013-07-10 11:19:26 -07001861 getNextPage() + 1, getChildCount());
1862 }
1863
Tony Mak2e564402018-02-27 17:19:34 +00001864 protected float getDownMotionX() {
1865 return mDownMotionX;
1866 }
1867
1868 protected float getDownMotionY() {
1869 return mDownMotionY;
1870 }
1871
Sunny Goyal20a13ff2018-03-13 16:44:00 -07001872 protected interface ComputePageScrollsLogic {
1873
1874 boolean shouldIncludeView(View view);
1875 }
Vadim Tryshev528b9e02018-05-24 18:22:03 -07001876
1877 public int[] getVisibleChildrenRange() {
1878 float visibleLeft = 0;
1879 float visibleRight = visibleLeft + getMeasuredWidth();
1880 float scaleX = getScaleX();
1881 if (scaleX < 1 && scaleX > 0) {
1882 float mid = getMeasuredWidth() / 2;
1883 visibleLeft = mid - ((mid - visibleLeft) / scaleX);
1884 visibleRight = mid + ((visibleRight - mid) / scaleX);
1885 }
1886
1887 int leftChild = -1;
1888 int rightChild = -1;
1889 final int childCount = getChildCount();
1890 for (int i = 0; i < childCount; i++) {
1891 final View child = getPageAt(i);
1892
1893 float left = child.getLeft() + child.getTranslationX() - getScrollX();
1894 if (left <= visibleRight && (left + child.getMeasuredWidth()) >= visibleLeft) {
1895 if (leftChild == -1) {
1896 leftChild = i;
1897 }
1898 rightChild = i;
1899 }
1900 }
1901 mTmpIntPair[0] = leftChild;
1902 mTmpIntPair[1] = rightChild;
1903 return mTmpIntPair;
1904 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001905
1906 @Override
1907 public void draw(Canvas canvas) {
1908 super.draw(canvas);
1909 drawEdgeEffect(canvas);
Sunny Goyal05b59c02021-04-29 13:55:40 -07001910 pageEndTransition();
Sunny Goyalc39db732021-04-03 01:20:21 -07001911 }
1912
1913 protected void drawEdgeEffect(Canvas canvas) {
1914 if (mAllowOverScroll && (!mEdgeGlowRight.isFinished() || !mEdgeGlowLeft.isFinished())) {
1915 final int width = getWidth();
1916 final int height = getHeight();
1917 if (!mEdgeGlowLeft.isFinished()) {
1918 final int restoreCount = canvas.save();
1919 canvas.rotate(-90);
1920 canvas.translate(-height, Math.min(mMinScroll, getScrollX()));
1921 mEdgeGlowLeft.setSize(height, width);
1922 if (mEdgeGlowLeft.draw(canvas)) {
1923 postInvalidateOnAnimation();
1924 }
1925 canvas.restoreToCount(restoreCount);
1926 }
1927 if (!mEdgeGlowRight.isFinished()) {
1928 final int restoreCount = canvas.save();
1929 canvas.rotate(90, width, 0);
1930 canvas.translate(width, -(Math.max(mMaxScroll, getScrollX())));
1931
1932 mEdgeGlowRight.setSize(height, width);
1933 if (mEdgeGlowRight.draw(canvas)) {
1934 postInvalidateOnAnimation();
1935 }
1936 canvas.restoreToCount(restoreCount);
1937 }
1938 }
1939 }
Adam Cohen5084cba2013-09-03 12:01:16 -07001940}