blob: 68c54c76676a8f04202f3bfe6fc31a28e26dab5e [file] [log] [blame]
Winson Chung321e9ee2010-08-09 13:37:56 -07001/*
Adam Cohen7d30a372013-07-01 17:03:59 -07002 * Copyright (C) 2012 The Android Open Source Project
Winson Chung321e9ee2010-08-09 13:37:56 -07003 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Daniel Sandler325dc232013-06-05 22:57:57 -040017package com.android.launcher3;
Winson Chung321e9ee2010-08-09 13:37:56 -070018
Andras Kloczl55edfe52021-05-14 12:21:30 +020019import static androidx.annotation.VisibleForTesting.PACKAGE_PRIVATE;
Andras Kloczldbf577a2021-05-26 15:02:52 +020020
Sunny Goyalc39db732021-04-03 01:20:21 -070021import static com.android.launcher3.anim.Interpolators.SCROLL;
Sunny Goyal8b37c572020-03-31 12:12:14 -070022import static com.android.launcher3.compat.AccessibilityManagerCompat.isAccessibilityEnabled;
23import static com.android.launcher3.compat.AccessibilityManagerCompat.isObservedEventType;
Sunny Goyal8b37c572020-03-31 12:12:14 -070024import static com.android.launcher3.touch.OverScroll.OVERSCROLL_DAMP_FACTOR;
Sunny Goyal8b37c572020-03-31 12:12:14 -070025import static com.android.launcher3.touch.PagedOrientationHandler.VIEW_SCROLL_BY;
26import static com.android.launcher3.touch.PagedOrientationHandler.VIEW_SCROLL_TO;
27
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -070028import android.animation.LayoutTransition;
Sunny Goyalcf25b522015-07-09 00:01:18 -070029import android.annotation.SuppressLint;
Winson Chung321e9ee2010-08-09 13:37:56 -070030import android.content.Context;
Andras Kloczlc2bd15f2022-03-30 18:06:13 +010031import android.content.res.Configuration;
32import android.content.res.Resources;
Adam Cohen9c4949e2010-10-05 12:27:22 -070033import android.content.res.TypedArray;
Jon Miranda71cb80c2019-01-24 21:25:13 -080034import android.graphics.Canvas;
Winson Chung321e9ee2010-08-09 13:37:56 -070035import android.graphics.Rect;
Svetoslav Ganov08055f62012-05-15 11:06:36 -070036import android.os.Bundle;
Tony Wickhamd58c2d52018-05-04 12:10:55 -070037import android.provider.Settings;
Winson Chung321e9ee2010-08-09 13:37:56 -070038import android.util.AttributeSet;
Winson Chung785d2eb2011-04-14 16:08:02 -070039import android.util.Log;
Winson Chung185d7162011-02-28 13:47:29 -080040import android.view.InputDevice;
41import android.view.KeyEvent;
Winson Chung321e9ee2010-08-09 13:37:56 -070042import android.view.MotionEvent;
43import android.view.VelocityTracker;
44import android.view.View;
45import android.view.ViewConfiguration;
Sunny Goyal4ffec482016-02-09 11:28:52 -080046import android.view.ViewDebug;
Winson Chung321e9ee2010-08-09 13:37:56 -070047import android.view.ViewGroup;
48import android.view.ViewParent;
Winson Chung6a0f57d2011-06-29 20:10:49 -070049import android.view.accessibility.AccessibilityEvent;
50import android.view.accessibility.AccessibilityNodeInfo;
Sunny Goyalc39db732021-04-03 01:20:21 -070051import android.widget.OverScroller;
Vadim Trysheve6bbefb2018-04-03 13:38:06 -070052import android.widget.ScrollView;
Tony Wickhamf549dab2016-05-16 09:54:06 -070053
Tony Wickham62117d72020-03-26 16:56:26 -070054import androidx.annotation.Nullable;
Andras Kloczl55edfe52021-05-14 12:21:30 +020055import androidx.annotation.VisibleForTesting;
Tony Wickham62117d72020-03-26 16:56:26 -070056
Jon Miranda9e198662020-03-11 14:42:02 -070057import com.android.launcher3.compat.AccessibilityManagerCompat;
58import com.android.launcher3.config.FeatureFlags;
Jon Miranda9e198662020-03-11 14:42:02 -070059import com.android.launcher3.pageindicators.PageIndicator;
Jon Miranda9e198662020-03-11 14:42:02 -070060import com.android.launcher3.touch.PagedOrientationHandler;
61import com.android.launcher3.touch.PagedOrientationHandler.ChildBounds;
Sunny Goyalc39db732021-04-03 01:20:21 -070062import com.android.launcher3.util.EdgeEffectCompat;
Andras Kloczl55edfe52021-05-14 12:21:30 +020063import com.android.launcher3.util.IntSet;
Jon Miranda9e198662020-03-11 14:42:02 -070064import com.android.launcher3.util.Thunk;
Sunny Goyal8b37c572020-03-31 12:12:14 -070065import com.android.launcher3.views.ActivityContext;
Jon Miranda9e198662020-03-11 14:42:02 -070066
67import java.util.ArrayList;
Sunny Goyal59969372021-05-06 12:11:44 -070068import java.util.function.Consumer;
Jon Miranda9e198662020-03-11 14:42:02 -070069
Winson Chung321e9ee2010-08-09 13:37:56 -070070/**
71 * An abstraction of the original Workspace which supports browsing through a
Michael Jurka0142d492010-08-25 17:46:15 -070072 * sequential list of "pages"
Winson Chung321e9ee2010-08-09 13:37:56 -070073 */
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -080074public abstract class PagedView<T extends View & PageIndicator> extends ViewGroup {
Winson Chung321e9ee2010-08-09 13:37:56 -070075 private static final String TAG = "PagedView";
Winson Chung785d2eb2011-04-14 16:08:02 -070076 private static final boolean DEBUG = false;
Winson Chung4941f652020-06-18 15:11:53 -070077 public static final boolean DEBUG_FAILED_QUICKSWITCH = false;
Sunny Goyal20a13ff2018-03-13 16:44:00 -070078
Winson Chung4941f652020-06-18 15:11:53 -070079 public static final int ACTION_MOVE_ALLOW_EASY_FLING = MotionEvent.ACTION_MASK - 1;
Sunny Goyala7a5bf32020-01-05 15:35:29 +053080 public static final int INVALID_PAGE = -1;
Sunny Goyal20a13ff2018-03-13 16:44:00 -070081 protected static final ComputePageScrollsLogic SIMPLE_SCROLL_LOGIC = (v) -> v.getVisibility() != GONE;
Winson Chung321e9ee2010-08-09 13:37:56 -070082
Adam Cohenb64cb5a2011-02-15 13:53:42 -080083 private static final float RETURN_TO_ORIGINAL_PAGE_THRESHOLD = 0.33f;
Adam Cohen00481b32011-11-18 12:03:48 -080084 // The page is moved more than halfway, automatically move to the next page on touch up.
85 private static final float SIGNIFICANT_MOVE_THRESHOLD = 0.4f;
Adam Cohen68d73932010-11-15 10:50:58 -080086
Sunny Goyal8e2133b2015-05-06 13:39:07 -070087 private static final float MAX_SCROLL_PROGRESS = 1.0f;
88
Adam Cohenf358a4b2013-07-23 16:47:31 -070089 private boolean mFreeScroll = false;
Adam Cohenf358a4b2013-07-23 16:47:31 -070090
Andras Kloczlc2bd15f2022-03-30 18:06:13 +010091 private int mFlingThresholdVelocity;
92 private int mEasyFlingThresholdVelocity;
93 private int mMinFlingVelocity;
94 private int mMinSnapVelocity;
95 private int mPageSnapAnimationDuration;
Michael Jurka0142d492010-08-25 17:46:15 -070096
Michael Jurka0142d492010-08-25 17:46:15 -070097 protected boolean mFirstLayout = true;
98
Sunny Goyal4ffec482016-02-09 11:28:52 -080099 @ViewDebug.ExportedProperty(category = "launcher")
Michael Jurka0142d492010-08-25 17:46:15 -0700100 protected int mCurrentPage;
Alex Chauba61b982021-06-15 16:29:19 +0100101 // Difference between current scroll position and mCurrentPage's page scroll. Used to maintain
102 // relative scroll position unchanged in updateCurrentPageScroll. Cleared when snapping to a
103 // page.
104 protected int mCurrentPageScrollDiff;
Lais Andradecc5c8842021-06-04 18:20:30 +0100105 // The current page the PagedView is scrolling over on it's way to the destination page.
106 protected int mCurrentScrollOverPage;
Adam Cohene61a9a22013-06-11 15:45:31 -0700107
Sunny Goyal4ffec482016-02-09 11:28:52 -0800108 @ViewDebug.ExportedProperty(category = "launcher")
Michael Jurka0142d492010-08-25 17:46:15 -0700109 protected int mNextPage = INVALID_PAGE;
Vinit Nayaka406f722019-12-19 11:50:55 -0800110 protected int mMaxScroll;
111 protected int mMinScroll;
Sunny Goyalb7b01352018-08-09 12:31:20 -0700112 protected OverScroller mScroller;
Winson Chung321e9ee2010-08-09 13:37:56 -0700113 private VelocityTracker mVelocityTracker;
Sunny Goyale15e2a82017-12-15 13:05:42 -0800114 protected int mPageSpacing = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -0700115
116 private float mDownMotionX;
Adam Cohen7d30a372013-07-01 17:03:59 -0700117 private float mDownMotionY;
Vinit Nayaka406f722019-12-19 11:50:55 -0800118 private float mDownMotionPrimary;
119 private float mLastMotion;
120 private float mLastMotionRemainder;
121 private float mTotalMotion;
Winson Chung4941f652020-06-18 15:11:53 -0700122 // Used in special cases where the fling checks can be relaxed for an intentional gesture
123 private boolean mAllowEasyFling;
Sunny Goyalacd17df2020-04-03 15:58:45 -0700124 protected PagedOrientationHandler mOrientationHandler = PagedOrientationHandler.PORTRAIT;
Adam Cohenedb40762013-07-18 16:45:45 -0700125
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700126 private final ArrayList<Runnable> mOnPageScrollsInitializedCallbacks = new ArrayList<>();
127
128 // We should always check pageScrollsInitialized() is true when using mPageScrolls.
129 @Nullable protected int[] mPageScrolls = null;
Sunny Goyalaad33592018-08-07 17:20:35 -0700130 private boolean mIsBeingDragged;
Adam Cohencae7f572013-11-04 14:42:52 -0800131
Winson Chung4941f652020-06-18 15:11:53 -0700132 // The amount of movement to begin scrolling
Michael Jurka7426c422010-11-11 15:23:47 -0800133 protected int mTouchSlop;
Winson Chung4941f652020-06-18 15:11:53 -0700134 // The amount of movement to begin paging
135 protected int mPageSlop;
Winson Chung321e9ee2010-08-09 13:37:56 -0700136 private int mMaximumVelocity;
Adam Cohen68d73932010-11-15 10:50:58 -0800137 protected boolean mAllowOverScroll = true;
Winson Chung321e9ee2010-08-09 13:37:56 -0700138
Michael Jurka5f1c5092010-09-03 14:15:02 -0700139 protected static final int INVALID_POINTER = -1;
Winson Chung321e9ee2010-08-09 13:37:56 -0700140
Michael Jurka5f1c5092010-09-03 14:15:02 -0700141 protected int mActivePointerId = INVALID_POINTER;
Winson Chung321e9ee2010-08-09 13:37:56 -0700142
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700143 protected boolean mIsPageInTransition = false;
Tony Wickham62117d72020-03-26 16:56:26 -0700144 private Runnable mOnPageTransitionEndCallback;
Patrick Dubroy1262e362010-10-06 15:49:50 -0700145
Winson Chungd2be3812013-07-16 11:11:32 -0700146 // Page Indicator
Adam Cohen091440a2015-03-18 14:16:05 -0700147 @Thunk int mPageIndicatorViewId;
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800148 protected T mPageIndicator;
Adam Cohen7d30a372013-07-01 17:03:59 -0700149
John Spurlock77e1f472013-09-11 10:09:51 -0400150 protected final Rect mInsets = new Rect();
Tony Wickhamdfb5cc92018-02-26 16:41:57 -0800151 protected boolean mIsRtl;
John Spurlock77e1f472013-09-11 10:09:51 -0400152
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800153 // Similar to the platform implementation of isLayoutValid();
154 protected boolean mIsLayoutValid;
155
Vadim Tryshev528b9e02018-05-24 18:22:03 -0700156 private int[] mTmpIntPair = new int[2];
157
Sunny Goyalc39db732021-04-03 01:20:21 -0700158 protected EdgeEffectCompat mEdgeGlowLeft;
159 protected EdgeEffectCompat mEdgeGlowRight;
160
Winson Chung321e9ee2010-08-09 13:37:56 -0700161 public PagedView(Context context) {
162 this(context, null);
163 }
164
165 public PagedView(Context context, AttributeSet attrs) {
166 this(context, attrs, 0);
167 }
168
169 public PagedView(Context context, AttributeSet attrs, int defStyle) {
170 super(context, attrs, defStyle);
Winson Chungc9ca2982013-07-19 12:07:38 -0700171
Adam Cohen9c4949e2010-10-05 12:27:22 -0700172 TypedArray a = context.obtainStyledAttributes(attrs,
173 R.styleable.PagedView, defStyle, 0);
Winson Chungd2be3812013-07-16 11:11:32 -0700174 mPageIndicatorViewId = a.getResourceId(R.styleable.PagedView_pageIndicator, -1);
Adam Cohen9c4949e2010-10-05 12:27:22 -0700175 a.recycle();
176
Winson Chung321e9ee2010-08-09 13:37:56 -0700177 setHapticFeedbackEnabled(false);
Sunny Goyal70660032015-05-14 00:07:08 -0700178 mIsRtl = Utilities.isRtl(getResources());
Winson Chung321e9ee2010-08-09 13:37:56 -0700179
Sunny Goyalc39db732021-04-03 01:20:21 -0700180 mScroller = new OverScroller(context, SCROLL);
Winson Chung86f77532010-08-24 11:08:22 -0700181 mCurrentPage = 0;
Lais Andradecc5c8842021-06-04 18:20:30 +0100182 mCurrentScrollOverPage = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -0700183
Vinit Nayaka406f722019-12-19 11:50:55 -0800184 final ViewConfiguration configuration = ViewConfiguration.get(context);
Winson Chung4941f652020-06-18 15:11:53 -0700185 mTouchSlop = configuration.getScaledTouchSlop();
186 mPageSlop = configuration.getScaledPagingTouchSlop();
Winson Chung321e9ee2010-08-09 13:37:56 -0700187 mMaximumVelocity = configuration.getScaledMaximumFlingVelocity();
Adam Cohen265b9a62011-12-07 14:37:18 -0800188
Andras Kloczlc2bd15f2022-03-30 18:06:13 +0100189 updateVelocityValues();
Sunny Goyala9f55462018-03-25 18:15:15 -0700190
Sunny Goyalc39db732021-04-03 01:20:21 -0700191 initEdgeEffect();
Sunny Goyaleaf7a952020-07-29 16:54:20 -0700192 setDefaultFocusHighlightEnabled(false);
Sunny Goyalc39db732021-04-03 01:20:21 -0700193 setWillNotDraw(false);
Winson Chung321e9ee2010-08-09 13:37:56 -0700194 }
195
Sunny Goyalc39db732021-04-03 01:20:21 -0700196 protected void initEdgeEffect() {
197 mEdgeGlowLeft = new EdgeEffectCompat(getContext());
198 mEdgeGlowRight = new EdgeEffectCompat(getContext());
Adam Cohenf9618852013-11-08 06:45:03 -0800199 }
200
Sunny Goyald0a6ae72016-06-16 12:29:03 -0700201 public void initParentViews(View parent) {
202 if (mPageIndicatorViewId > -1) {
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800203 mPageIndicator = parent.findViewById(mPageIndicatorViewId);
Tony Wickhambab101c2021-09-20 15:12:44 -0700204 mPageIndicator.setMarkersCount(getChildCount() / getPanelCount());
Winson Chungd2be3812013-07-16 11:11:32 -0700205 }
206 }
207
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800208 public T getPageIndicator() {
Adam Cohenedb40762013-07-18 16:45:45 -0700209 return mPageIndicator;
210 }
211
Adam Cohen674531f2013-12-13 15:07:14 -0800212 /**
Tony Wickham29d853c2015-09-08 10:35:56 -0700213 * Returns the index of the currently displayed page. When in free scroll mode, this is the page
214 * that the user was on before entering free scroll mode (e.g. the home screen page they
Alex Chaub794ea62021-02-03 18:00:30 +0000215 * long-pressed on to enter the overview). Try using {@link #getDestinationPage()}
Tony Wickham29d853c2015-09-08 10:35:56 -0700216 * to get the page the user is currently scrolling over.
Winson Chung321e9ee2010-08-09 13:37:56 -0700217 */
Sunny Goyal83a8f042015-05-19 12:52:12 -0700218 public int getCurrentPage() {
Winson Chung86f77532010-08-24 11:08:22 -0700219 return mCurrentPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700220 }
Adam Cohen7d30a372013-07-01 17:03:59 -0700221
Hyunyoung Songb76cd622015-04-16 14:34:09 -0700222 /**
223 * Returns the index of page to be shown immediately afterwards.
224 */
Vadim Tryshevfedca432015-08-19 17:55:02 -0700225 public int getNextPage() {
Winson Chung360e63f2012-04-27 13:48:05 -0700226 return (mNextPage != INVALID_PAGE) ? mNextPage : mCurrentPage;
227 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700228
Adam Cohenf9c184a2016-01-15 16:47:43 -0800229 public int getPageCount() {
Winson Chung321e9ee2010-08-09 13:37:56 -0700230 return getChildCount();
231 }
232
Sunny Goyal83a8f042015-05-19 12:52:12 -0700233 public View getPageAt(int index) {
Winson Chung321e9ee2010-08-09 13:37:56 -0700234 return getChildAt(index);
235 }
236
Winson Chung321e9ee2010-08-09 13:37:56 -0700237 /**
Winson Chungbbc60d82010-11-11 16:34:41 -0800238 * Updates the scroll of the current page immediately to its final scroll position. We use this
239 * in CustomizePagedView to allow tabs to share the same PagedView while resetting the scroll of
240 * the previous tab page.
241 */
242 protected void updateCurrentPageScroll() {
Adam Cohen0ffac432013-07-10 11:19:26 -0700243 // If the current page is invalid, just reset the scroll position to zero
Vinit Nayaka406f722019-12-19 11:50:55 -0800244 int newPosition = 0;
Adam Cohen0ffac432013-07-10 11:19:26 -0700245 if (0 <= mCurrentPage && mCurrentPage < getPageCount()) {
Alex Chauba61b982021-06-15 16:29:19 +0100246 newPosition = getScrollForPage(mCurrentPage) + mCurrentPageScrollDiff;
Adam Cohen0ffac432013-07-10 11:19:26 -0700247 }
Alex Chau6499e832021-11-19 14:35:46 +0000248 mOrientationHandler.setPrimary(this, VIEW_SCROLL_TO, newPosition);
Sunny Goyalc39db732021-04-03 01:20:21 -0700249 mScroller.startScroll(mScroller.getCurrX(), 0, newPosition - mScroller.getCurrX(), 0);
Tony Wickhamd5521322021-09-14 14:26:50 -0700250 forceFinishScroller();
Winson Chungbbc60d82010-11-11 16:34:41 -0800251 }
252
Tony Wickhamf8d731a2021-05-26 14:58:13 -0700253 /**
254 * Immediately finishes any overscroll effect and jumps to the end of the scroller animation.
255 */
256 public void abortScrollerAnimation() {
257 mEdgeGlowLeft.finish();
258 mEdgeGlowRight.finish();
259 abortScrollerAnimation(true);
260 }
261
Schneider Victor-tuliasa602a0a2022-09-06 13:34:00 -0700262 protected void onScrollerAnimationAborted() {
263 // No-Op
264 }
265
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700266 private void abortScrollerAnimation(boolean resetNextPage) {
Adam Cohen4fe4c932013-10-28 16:02:34 -0700267 mScroller.abortAnimation();
Schneider Victor-tuliasa602a0a2022-09-06 13:34:00 -0700268 onScrollerAnimationAborted();
Adam Cohen4fe4c932013-10-28 16:02:34 -0700269 // We need to clean up the next page here to avoid computeScrollHelper from
270 // updating current page on the pass.
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700271 if (resetNextPage) {
272 mNextPage = INVALID_PAGE;
Sunny Goyal857b1b92018-03-05 10:49:05 -0800273 pageEndTransition();
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700274 }
Chet Haasebc2f0822012-10-26 17:59:53 -0700275 }
Adam Cohen4fe4c932013-10-28 16:02:34 -0700276
Tony Wickhamd5521322021-09-14 14:26:50 -0700277 /**
278 * Immediately finishes any in-progress scroll, maintaining the current position. Also sets
279 * mNextPage = INVALID_PAGE and calls pageEndTransition().
280 */
281 public void forceFinishScroller() {
Adam Cohen4fe4c932013-10-28 16:02:34 -0700282 mScroller.forceFinished(true);
283 // We need to clean up the next page here to avoid computeScrollHelper from
284 // updating current page on the pass.
Tony Wickhamd5521322021-09-14 14:26:50 -0700285 mNextPage = INVALID_PAGE;
286 pageEndTransition();
Adam Cohen4fe4c932013-10-28 16:02:34 -0700287 }
288
Adam Cohen6f127a62014-06-12 14:54:41 -0700289 private int validateNewPage(int newPage) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700290 newPage = ensureWithinScrollBounds(newPage);
Adam Cohen6f127a62014-06-12 14:54:41 -0700291 // Ensure that it is clamped by the actual set of children in all cases
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100292 newPage = Utilities.boundToRange(newPage, 0, getPageCount() - 1);
293
294 if (getPanelCount() > 1) {
Alex Chau1e448462021-08-13 21:48:35 +0100295 // Always return left most panel as new page
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100296 newPage = getLeftmostVisiblePageForIndex(newPage);
297 }
298 return newPage;
299 }
300
Andras Kloczl55edfe52021-05-14 12:21:30 +0200301 /**
302 * In most cases where panelCount is 1, this method will just return the page index that was
303 * passed in.
304 * But for example when two panel home is enabled we might need the leftmost visible page index
305 * because that page is the current page.
306 */
307 public int getLeftmostVisiblePageForIndex(int pageIndex) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100308 int panelCount = getPanelCount();
Andras Kloczl55edfe52021-05-14 12:21:30 +0200309 return pageIndex - pageIndex % panelCount;
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100310 }
311
312 /**
313 * Returns the number of pages that are shown at the same time.
314 */
315 protected int getPanelCount() {
316 return 1;
317 }
318
319 /**
Andras Kloczl55edfe52021-05-14 12:21:30 +0200320 * Returns an IntSet with the indices of the currently visible pages
321 */
322 @VisibleForTesting(otherwise = PACKAGE_PRIVATE)
323 public IntSet getVisiblePageIndices() {
Andras Kloczl7e912442021-05-06 12:50:28 +0200324 return getPageIndices(mCurrentPage);
325 }
326
327 /**
328 * In case the panelCount is 1 this just returns the same page index in an IntSet.
329 * But in cases where the panelCount > 1 this will return all the page indices that belong
330 * together, i.e. on the Workspace they are next to each other and shown at the same time.
331 */
332 private IntSet getPageIndices(int pageIndex) {
333 // we want to make sure the pageIndex is the leftmost page
334 pageIndex = getLeftmostVisiblePageForIndex(pageIndex);
335
336 IntSet pageIndices = new IntSet();
Andras Kloczl55edfe52021-05-14 12:21:30 +0200337 int panelCount = getPanelCount();
338 int pageCount = getPageCount();
Andras Kloczl7e912442021-05-06 12:50:28 +0200339 for (int page = pageIndex; page < pageIndex + panelCount && page < pageCount; page++) {
340 pageIndices.add(page);
Andras Kloczl55edfe52021-05-14 12:21:30 +0200341 }
Andras Kloczl7e912442021-05-06 12:50:28 +0200342 return pageIndices;
343 }
344
345 /**
346 * Returns an IntSet with the indices of the neighbour pages that are in the focus direction.
347 */
348 private IntSet getNeighbourPageIndices(int focus) {
349 int panelCount = getPanelCount();
350 // getNextPage is more reliable than getCurrentPage
351 int currentPage = getNextPage();
352
353 int nextPage;
354 if (focus == View.FOCUS_LEFT) {
355 nextPage = currentPage - panelCount;
356 } else if (focus == View.FOCUS_RIGHT) {
357 nextPage = currentPage + panelCount;
358 } else {
Andras Kloczlb0632942021-08-03 14:03:58 +0200359 // no neighbours to other directions
Andras Kloczl7e912442021-05-06 12:50:28 +0200360 return new IntSet();
361 }
362 nextPage = validateNewPage(nextPage);
363 if (nextPage == currentPage) {
364 // We reached the end of the pages
365 return new IntSet();
366 }
367
Andras Kloczlb0632942021-08-03 14:03:58 +0200368 return getPageIndices(nextPage);
Andras Kloczl55edfe52021-05-14 12:21:30 +0200369 }
370
371 /**
Sunny Goyal59969372021-05-06 12:11:44 -0700372 * Executes the callback against each visible page
Andras Kloczl2bb51342021-03-20 01:13:45 +0100373 */
Sunny Goyal59969372021-05-06 12:11:44 -0700374 public void forEachVisiblePage(Consumer<View> callback) {
Andras Kloczl55edfe52021-05-14 12:21:30 +0200375 getVisiblePageIndices().forEach(pageIndex -> {
376 View page = getPageAt(pageIndex);
Andras Kloczl2bb51342021-03-20 01:13:45 +0100377 if (page != null) {
Sunny Goyal59969372021-05-06 12:11:44 -0700378 callback.accept(page);
Andras Kloczl2bb51342021-03-20 01:13:45 +0100379 }
Andras Kloczl55edfe52021-05-14 12:21:30 +0200380 });
Andras Kloczl2bb51342021-03-20 01:13:45 +0100381 }
382
383 /**
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100384 * Returns true if the view is on one of the current pages, false otherwise.
385 */
386 public boolean isVisible(View child) {
Andras Kloczl7e912442021-05-06 12:50:28 +0200387 return isVisible(indexOfChild(child));
388 }
389
390 /**
391 * Returns true if the page with the given index is currently visible, false otherwise.
392 */
393 private boolean isVisible(int pageIndex) {
394 return getLeftmostVisiblePageForIndex(pageIndex) == mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700395 }
396
Chet Haasebc2f0822012-10-26 17:59:53 -0700397 /**
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700398 * @return The closest page to the provided page that is within mMinScrollX and mMaxScrollX.
399 */
400 private int ensureWithinScrollBounds(int page) {
401 int dir = !mIsRtl ? 1 : - 1;
402 int currScroll = getScrollForPage(page);
403 int prevScroll;
Vinit Nayaka406f722019-12-19 11:50:55 -0800404 while (currScroll < mMinScroll) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700405 page += dir;
406 prevScroll = currScroll;
407 currScroll = getScrollForPage(page);
408 if (currScroll <= prevScroll) {
409 Log.e(TAG, "validateNewPage: failed to find a page > mMinScrollX");
410 break;
411 }
412 }
Vinit Nayaka406f722019-12-19 11:50:55 -0800413 while (currScroll > mMaxScroll) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700414 page -= dir;
415 prevScroll = currScroll;
416 currScroll = getScrollForPage(page);
417 if (currScroll >= prevScroll) {
418 Log.e(TAG, "validateNewPage: failed to find a page < mMaxScrollX");
419 break;
420 }
421 }
422 return page;
423 }
424
Tony Wickham03f27012019-04-25 14:22:54 -0700425 public void setCurrentPage(int currentPage) {
426 setCurrentPage(currentPage, INVALID_PAGE);
427 }
428
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700429 /**
Winson Chung86f77532010-08-24 11:08:22 -0700430 * Sets the current page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700431 */
Tony Wickham03f27012019-04-25 14:22:54 -0700432 public void setCurrentPage(int currentPage, int overridePrevPage) {
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800433 if (!mScroller.isFinished()) {
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700434 abortScrollerAnimation(true);
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800435 }
Michael Jurkad3ef3062010-11-23 16:23:58 -0800436 // don't introduce any checks like mCurrentPage == currentPage here-- if we change the
437 // the default
438 if (getChildCount() == 0) {
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800439 return;
440 }
Tony Wickham03f27012019-04-25 14:22:54 -0700441 int prevPage = overridePrevPage != INVALID_PAGE ? overridePrevPage : mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700442 mCurrentPage = validateNewPage(currentPage);
Lais Andradecc5c8842021-06-04 18:20:30 +0100443 mCurrentScrollOverPage = mCurrentPage;
Winson Chung181c3dc2013-07-17 15:36:20 -0700444 updateCurrentPageScroll();
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700445 notifyPageSwitchListener(prevPage);
Winson Chunga12a2502010-12-20 14:41:35 -0800446 invalidate();
Winson Chung321e9ee2010-08-09 13:37:56 -0700447 }
448
Winson Chung8c87cd82013-07-23 16:20:10 -0700449 /**
Adam Cohen674531f2013-12-13 15:07:14 -0800450 * Should be called whenever the page changes. In the case of a scroll, we wait until the page
451 * has settled.
452 */
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700453 protected void notifyPageSwitchListener(int prevPage) {
Adam Cohen674531f2013-12-13 15:07:14 -0800454 updatePageIndicator();
455 }
456
457 private void updatePageIndicator() {
Sunny Goyal4cbf0462014-08-28 16:19:39 -0700458 if (mPageIndicator != null) {
Tony Mak4f521af2018-03-15 16:37:34 +0000459 mPageIndicator.setActiveMarker(getNextPage());
Winson Chungd2be3812013-07-16 11:11:32 -0700460 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700461 }
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700462 protected void pageBeginTransition() {
463 if (!mIsPageInTransition) {
464 mIsPageInTransition = true;
465 onPageBeginTransition();
Michael Jurkad74c9842011-07-10 12:44:21 -0700466 }
Patrick Dubroy1262e362010-10-06 15:49:50 -0700467 }
468
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700469 protected void pageEndTransition() {
Sunny Goyal05b59c02021-04-29 13:55:40 -0700470 if (mIsPageInTransition && !mIsBeingDragged && mScroller.isFinished()
Sunny Goyalb745a2a2021-04-30 13:38:22 -0700471 && (!isShown() || (mEdgeGlowLeft.isFinished() && mEdgeGlowRight.isFinished()))) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700472 mIsPageInTransition = false;
473 onPageEndTransition();
Michael Jurkad74c9842011-07-10 12:44:21 -0700474 }
Michael Jurka0142d492010-08-25 17:46:15 -0700475 }
476
Sunny Goyalb745a2a2021-04-30 13:38:22 -0700477 @Override
478 public void onVisibilityAggregated(boolean isVisible) {
479 pageEndTransition();
480 super.onVisibilityAggregated(isVisible);
481 }
482
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700483 protected boolean isPageInTransition() {
484 return mIsPageInTransition;
Adam Cohen26976d92011-03-22 15:33:33 -0700485 }
486
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700487 /**
488 * Called when the page starts moving as part of the scroll. Subclasses can override this
489 * to provide custom behavior during animation.
490 */
491 protected void onPageBeginTransition() {
Patrick Dubroy1262e362010-10-06 15:49:50 -0700492 }
493
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700494 /**
495 * Called when the page ends moving as part of the scroll. Subclasses can override this
496 * to provide custom behavior during animation.
497 */
498 protected void onPageEndTransition() {
Alex Chauba61b982021-06-15 16:29:19 +0100499 mCurrentPageScrollDiff = 0;
vadimt4d93df52019-07-10 17:32:58 -0700500 AccessibilityManagerCompat.sendScrollFinishedEventToTest(getContext());
Tony Wickham619daaf2020-02-07 12:29:06 -0800501 AccessibilityManagerCompat.sendCustomAccessibilityEvent(getPageAt(mCurrentPage),
502 AccessibilityEvent.TYPE_VIEW_FOCUSED, null);
Tony Wickham62117d72020-03-26 16:56:26 -0700503 if (mOnPageTransitionEndCallback != null) {
504 mOnPageTransitionEndCallback.run();
505 mOnPageTransitionEndCallback = null;
506 }
507 }
508
509 /**
510 * Sets a callback to run once when the scrolling finishes. If there is currently
511 * no page in transition, then the callback is called immediately.
512 */
513 public void setOnPageTransitionEndCallback(@Nullable Runnable callback) {
514 if (mIsPageInTransition || callback == null) {
515 mOnPageTransitionEndCallback = callback;
516 } else {
517 callback.run();
518 }
Michael Jurka0142d492010-08-25 17:46:15 -0700519 }
520
Adam Cohen68d73932010-11-15 10:50:58 -0800521 @Override
Michael Jurka0142d492010-08-25 17:46:15 -0700522 public void scrollTo(int x, int y) {
Sunny Goyalc39db732021-04-03 01:20:21 -0700523 x = Utilities.boundToRange(x,
524 mOrientationHandler.getPrimaryValue(mMinScroll, 0), mMaxScroll);
525 y = Utilities.boundToRange(y,
526 mOrientationHandler.getPrimaryValue(0, mMinScroll), mMaxScroll);
Vinit Nayaka406f722019-12-19 11:50:55 -0800527 super.scrollTo(x, y);
Michael Jurka0142d492010-08-25 17:46:15 -0700528 }
529
Adam Cohen53805212013-10-01 10:39:23 -0700530 private void sendScrollAccessibilityEvent() {
Sunny Goyald0030b02017-12-08 15:07:24 -0800531 if (isObservedEventType(getContext(), AccessibilityEvent.TYPE_VIEW_SCROLLED)) {
Vadim Tryshevf4715972015-05-08 17:21:03 -0700532 if (mCurrentPage != getNextPage()) {
533 AccessibilityEvent ev =
534 AccessibilityEvent.obtain(AccessibilityEvent.TYPE_VIEW_SCROLLED);
Vadim Tryshev7066c122015-05-21 14:06:35 -0700535 ev.setScrollable(true);
536 ev.setScrollX(getScrollX());
537 ev.setScrollY(getScrollY());
Vinit Nayaka406f722019-12-19 11:50:55 -0800538 mOrientationHandler.setMaxScroll(ev, mMaxScroll);
Vadim Tryshevf4715972015-05-08 17:21:03 -0700539 sendAccessibilityEventUnchecked(ev);
Adam Cohen53805212013-10-01 10:39:23 -0700540 }
Adam Cohen53805212013-10-01 10:39:23 -0700541 }
542 }
543
Vadim Tryshev2c430b32018-04-04 14:45:21 -0700544 protected void announcePageForAccessibility() {
545 if (isAccessibilityEnabled(getContext())) {
546 // Notify the user when the page changes
547 announceForAccessibility(getCurrentPageDescription());
548 }
549 }
550
Winson Chung85425412021-05-10 16:24:14 -0700551 protected boolean computeScrollHelper() {
Winson Chung321e9ee2010-08-09 13:37:56 -0700552 if (mScroller.computeScrollOffset()) {
Winson Chung557d6ed2011-07-08 15:34:52 -0700553 // Don't bother scrolling if the page does not need to be moved
Sunny Goyalc39db732021-04-03 01:20:21 -0700554 int oldPos = mOrientationHandler.getPrimaryScroll(this);
555 int newPos = mScroller.getCurrX();
556 if (oldPos != newPos) {
Alex Chau6499e832021-11-19 14:35:46 +0000557 mOrientationHandler.setPrimary(this, VIEW_SCROLL_TO, mScroller.getCurrX());
Winson Chung557d6ed2011-07-08 15:34:52 -0700558 }
Winson Chung85425412021-05-10 16:24:14 -0700559
560 if (mAllowOverScroll) {
561 if (newPos < mMinScroll && oldPos >= mMinScroll) {
562 mEdgeGlowLeft.onAbsorb((int) mScroller.getCurrVelocity());
Schneider Victor-tuliasa602a0a2022-09-06 13:34:00 -0700563 abortScrollerAnimation(false);
Lais Andradecc5c8842021-06-04 18:20:30 +0100564 onEdgeAbsorbingScroll();
Winson Chung85425412021-05-10 16:24:14 -0700565 } else if (newPos > mMaxScroll && oldPos <= mMaxScroll) {
566 mEdgeGlowRight.onAbsorb((int) mScroller.getCurrVelocity());
Schneider Victor-tuliasa602a0a2022-09-06 13:34:00 -0700567 abortScrollerAnimation(false);
Lais Andradecc5c8842021-06-04 18:20:30 +0100568 onEdgeAbsorbingScroll();
Sunny Goyalc39db732021-04-03 01:20:21 -0700569 }
Tony Wickham95cdb3a2016-02-18 14:37:07 -0800570 }
Adam Cohen53805212013-10-01 10:39:23 -0700571
Winson Chung85425412021-05-10 16:24:14 -0700572 // If the scroller has scrolled to the final position and there is no edge effect, then
573 // finish the scroller to skip waiting for additional settling
574 int finalPos = mOrientationHandler.getPrimaryValue(mScroller.getFinalX(),
575 mScroller.getFinalY());
576 if (newPos == finalPos && mEdgeGlowLeft.isFinished() && mEdgeGlowRight.isFinished()) {
Schneider Victor-tuliasa602a0a2022-09-06 13:34:00 -0700577 abortScrollerAnimation(false);
Winson Chung85425412021-05-10 16:24:14 -0700578 }
579
580 invalidate();
581 return true;
582 } else if (mNextPage != INVALID_PAGE) {
583 sendScrollAccessibilityEvent();
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700584 int prevPage = mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700585 mCurrentPage = validateNewPage(mNextPage);
Lais Andradecc5c8842021-06-04 18:20:30 +0100586 mCurrentScrollOverPage = mCurrentPage;
Winson Chung86f77532010-08-24 11:08:22 -0700587 mNextPage = INVALID_PAGE;
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700588 notifyPageSwitchListener(prevPage);
Winson Chungb44b5242011-06-13 11:32:14 -0700589
Adam Cohen73aa9752010-11-24 16:26:58 -0800590 // We don't want to trigger a page end moving unless the page has settled
591 // and the user has stopped scrolling
Sunny Goyalaad33592018-08-07 17:20:35 -0700592 if (!mIsBeingDragged) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700593 pageEndTransition();
Adam Cohen73aa9752010-11-24 16:26:58 -0800594 }
Winson Chungc27d1bb2011-09-29 12:07:42 -0700595
Vadim Tryshev2c430b32018-04-04 14:45:21 -0700596 if (canAnnouncePageDescription()) {
597 announcePageForAccessibility();
Adam Cohen0ffac432013-07-10 11:19:26 -0700598 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700599 }
Michael Jurka0142d492010-08-25 17:46:15 -0700600 return false;
601 }
602
603 @Override
604 public void computeScroll() {
605 computeScrollHelper();
Winson Chung321e9ee2010-08-09 13:37:56 -0700606 }
607
Sunny Goyalce8809a2018-01-18 14:02:47 -0800608 public int getExpectedHeight() {
609 return getMeasuredHeight();
610 }
611
Adam Cohen410f3cd2013-09-22 12:09:32 -0700612 public int getNormalChildHeight() {
Sunny Goyalce8809a2018-01-18 14:02:47 -0800613 return getExpectedHeight() - getPaddingTop() - getPaddingBottom()
Sunny Goyalac00cba2017-11-13 15:58:01 -0800614 - mInsets.top - mInsets.bottom;
Adam Cohen410f3cd2013-09-22 12:09:32 -0700615 }
616
Sunny Goyalce8809a2018-01-18 14:02:47 -0800617 public int getExpectedWidth() {
618 return getMeasuredWidth();
619 }
620
Sunny Goyalbc683e92017-12-06 10:25:07 -0800621 public int getNormalChildWidth() {
Sunny Goyalce8809a2018-01-18 14:02:47 -0800622 return getExpectedWidth() - getPaddingLeft() - getPaddingRight()
Sunny Goyalbc683e92017-12-06 10:25:07 -0800623 - mInsets.left - mInsets.right;
624 }
625
Andras Kloczlc2bd15f2022-03-30 18:06:13 +0100626 private void updateVelocityValues() {
627 Resources res = getResources();
628 mFlingThresholdVelocity = res.getDimensionPixelSize(R.dimen.fling_threshold_velocity);
629 mEasyFlingThresholdVelocity =
630 res.getDimensionPixelSize(R.dimen.easy_fling_threshold_velocity);
631 mMinFlingVelocity = res.getDimensionPixelSize(R.dimen.min_fling_velocity);
632 mMinSnapVelocity = res.getDimensionPixelSize(R.dimen.min_page_snap_velocity);
633 mPageSnapAnimationDuration = res.getInteger(R.integer.config_pageSnapAnimationDuration);
634 }
635
636 @Override
637 protected void onConfigurationChanged(Configuration newConfig) {
638 super.onConfigurationChanged(newConfig);
639 updateVelocityValues();
640 }
641
Winson Chung321e9ee2010-08-09 13:37:56 -0700642 @Override
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800643 public void requestLayout() {
644 mIsLayoutValid = false;
645 super.requestLayout();
646 }
647
648 @Override
649 public void forceLayout() {
650 mIsLayoutValid = false;
651 super.forceLayout();
652 }
653
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100654 private int getPageWidthSize(int widthSize) {
Thales Lima7a6752d2021-09-23 14:31:00 +0100655 // It's necessary to add the padding back because it is remove when measuring children,
656 // like when MeasureSpec.getSize in CellLayout.
657 return (widthSize - mInsets.left - mInsets.right - getPaddingLeft() - getPaddingRight())
658 / getPanelCount() + getPaddingLeft() + getPaddingRight();
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100659 }
660
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800661 @Override
Winson Chung321e9ee2010-08-09 13:37:56 -0700662 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
Sunny Goyal8e2133b2015-05-06 13:39:07 -0700663 if (getChildCount() == 0) {
Winson Chungf0ea4d32011-06-06 14:27:16 -0700664 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
665 return;
666 }
667
Adam Cohen7d30a372013-07-01 17:03:59 -0700668 // We measure the dimensions of the PagedView to be larger than the pages so that when we
669 // zoom out (and scale down), the view is still contained in the parent
Adam Cohen7d30a372013-07-01 17:03:59 -0700670 int widthMode = MeasureSpec.getMode(widthMeasureSpec);
671 int widthSize = MeasureSpec.getSize(widthMeasureSpec);
672 int heightMode = MeasureSpec.getMode(heightMeasureSpec);
Winson Chung8aad6102012-05-11 16:27:49 -0700673 int heightSize = MeasureSpec.getSize(heightMeasureSpec);
Adam Cohen410f3cd2013-09-22 12:09:32 -0700674
Adam Cohen7d30a372013-07-01 17:03:59 -0700675 if (widthMode == MeasureSpec.UNSPECIFIED || heightMode == MeasureSpec.UNSPECIFIED) {
676 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
677 return;
Winson Chung321e9ee2010-08-09 13:37:56 -0700678 }
679
Winson Chung8aad6102012-05-11 16:27:49 -0700680 // Return early if we aren't given a proper dimension
681 if (widthSize <= 0 || heightSize <= 0) {
682 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
683 return;
684 }
685
Winson Chung321e9ee2010-08-09 13:37:56 -0700686 // The children are given the same width and height as the workspace
Michael Jurka5f1c5092010-09-03 14:15:02 -0700687 // unless they were set to WRAP_CONTENT
Winson Chung785d2eb2011-04-14 16:08:02 -0700688 if (DEBUG) Log.d(TAG, "PagedView.onMeasure(): " + widthSize + ", " + heightSize);
Michael Jurka5f1c5092010-09-03 14:15:02 -0700689
Sunny Goyalac00cba2017-11-13 15:58:01 -0800690 int myWidthSpec = MeasureSpec.makeMeasureSpec(
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100691 getPageWidthSize(widthSize), MeasureSpec.EXACTLY);
Sunny Goyalac00cba2017-11-13 15:58:01 -0800692 int myHeightSpec = MeasureSpec.makeMeasureSpec(
Sunny Goyal228153d2018-01-04 15:35:22 -0800693 heightSize - mInsets.top - mInsets.bottom, MeasureSpec.EXACTLY);
Adam Cohen96d30a12013-07-16 18:13:21 -0700694
Sunny Goyalac00cba2017-11-13 15:58:01 -0800695 // measureChildren takes accounts for content padding, we only need to care about extra
696 // space due to insets.
697 measureChildren(myWidthSpec, myHeightSpec);
698 setMeasuredDimension(widthSize, heightSize);
Adam Cohen60b07122011-11-14 17:26:06 -0800699 }
700
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700701 /** Returns true iff this PagedView's scroll amounts are initialized to each page index. */
702 protected boolean pageScrollsInitialized() {
703 return mPageScrolls != null && mPageScrolls.length == getChildCount();
704 }
705
706 /**
707 * Queues the given callback to be run once {@code mPageScrolls} has been initialized.
708 */
709 public void runOnPageScrollsInitialized(Runnable callback) {
710 mOnPageScrollsInitializedCallbacks.add(callback);
711 if (pageScrollsInitialized()) {
712 onPageScrollsInitialized();
713 }
714 }
715
716 private void onPageScrollsInitialized() {
717 for (Runnable callback : mOnPageScrollsInitializedCallbacks) {
718 callback.run();
719 }
720 mOnPageScrollsInitializedCallbacks.clear();
721 }
722
Sunny Goyalcf25b522015-07-09 00:01:18 -0700723 @SuppressLint("DrawAllocation")
Winson Chung321e9ee2010-08-09 13:37:56 -0700724 @Override
Michael Jurka28750fb2010-09-24 17:43:49 -0700725 protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800726 mIsLayoutValid = true;
Vadim Trysheveb701c62018-05-14 16:00:15 -0700727 final int childCount = getChildCount();
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700728 int[] pageScrolls = mPageScrolls;
Vadim Trysheveb701c62018-05-14 16:00:15 -0700729 boolean pageScrollChanged = false;
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700730 if (!pageScrollsInitialized()) {
731 pageScrolls = new int[childCount];
Vadim Trysheveb701c62018-05-14 16:00:15 -0700732 pageScrollChanged = true;
733 }
734
Winson Chung785d2eb2011-04-14 16:08:02 -0700735 if (DEBUG) Log.d(TAG, "PagedView.onLayout()");
Winson Chung321e9ee2010-08-09 13:37:56 -0700736
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700737 pageScrollChanged |= getPageScrolls(pageScrolls, true, SIMPLE_SCROLL_LOGIC);
738 mPageScrolls = pageScrolls;
Winson Chungc3665fa2011-09-14 17:56:27 -0700739
Winson Chung359cb5d2022-05-26 23:38:48 +0000740 if (childCount == 0) {
741 onPageScrollsInitialized();
742 return;
743 }
744
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700745 final LayoutTransition transition = getLayoutTransition();
746 // If the transition is running defer updating max scroll, as some empty pages could
747 // still be present, and a max scroll change could cause sudden jumps in scroll.
748 if (transition != null && transition.isRunning()) {
749 transition.addTransitionListener(new LayoutTransition.TransitionListener() {
750
751 @Override
752 public void startTransition(LayoutTransition transition, ViewGroup container,
753 View view, int transitionType) { }
754
755 @Override
756 public void endTransition(LayoutTransition transition, ViewGroup container,
757 View view, int transitionType) {
758 // Wait until all transitions are complete.
759 if (!transition.isRunning()) {
760 transition.removeTransitionListener(this);
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700761 updateMinAndMaxScrollX();
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700762 }
763 }
764 });
Adam Cohenf698c6e2013-07-17 18:44:25 -0700765 } else {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700766 updateMinAndMaxScrollX();
Adam Cohenf698c6e2013-07-17 18:44:25 -0700767 }
768
Sunny Goyalcb037ee2015-07-08 16:41:21 -0700769 if (mFirstLayout && mCurrentPage >= 0 && mCurrentPage < childCount) {
770 updateCurrentPageScroll();
771 mFirstLayout = false;
772 }
773
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800774 if (mScroller.isFinished() && pageScrollChanged) {
Sunny Goyalc82c6392018-06-06 15:39:13 -0700775 setCurrentPage(getNextPage());
Adam Cohenf698c6e2013-07-17 18:44:25 -0700776 }
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700777 onPageScrollsInitialized();
Winson Chunge3193b92010-09-10 11:44:42 -0700778 }
779
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700780 /**
781 * Initializes {@code outPageScrolls} with scroll positions for view at that index. The length
782 * of {@code outPageScrolls} should be same as the the childCount
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700783 */
784 protected boolean getPageScrolls(int[] outPageScrolls, boolean layoutChildren,
785 ComputePageScrollsLogic scrollLogic) {
786 final int childCount = getChildCount();
787
788 final int startIndex = mIsRtl ? childCount - 1 : 0;
789 final int endIndex = mIsRtl ? -1 : childCount;
790 final int delta = mIsRtl ? -1 : 1;
791
Vinit Nayaka406f722019-12-19 11:50:55 -0800792 final int pageCenter = mOrientationHandler.getCenterForPage(this, mInsets);
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700793
Vinit Nayaka406f722019-12-19 11:50:55 -0800794 final int scrollOffsetStart = mOrientationHandler.getScrollOffsetStart(this, mInsets);
795 final int scrollOffsetEnd = mOrientationHandler.getScrollOffsetEnd(this, mInsets);
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700796 boolean pageScrollChanged = false;
Thales Limae4457742021-07-20 16:46:38 +0100797 int panelCount = getPanelCount();
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700798
Vinit Nayaka406f722019-12-19 11:50:55 -0800799 for (int i = startIndex, childStart = scrollOffsetStart; i != endIndex; i += delta) {
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700800 final View child = getPageAt(i);
801 if (scrollLogic.shouldIncludeView(child)) {
Vinit Nayaka406f722019-12-19 11:50:55 -0800802 ChildBounds bounds = mOrientationHandler.getChildBounds(child, childStart,
803 pageCenter, layoutChildren);
804 final int primaryDimension = bounds.primaryDimension;
805 final int childPrimaryEnd = bounds.childPrimaryEnd;
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700806
Alex Chaub5c4d112021-03-29 17:37:53 +0100807 // In case the pages are of different width, align the page to left edge for non-RTL
808 // or right edge for RTL.
809 final int pageScroll =
810 mIsRtl ? childPrimaryEnd - scrollOffsetEnd : childStart - scrollOffsetStart;
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700811 if (outPageScrolls[i] != pageScroll) {
812 pageScrollChanged = true;
813 outPageScrolls[i] = pageScroll;
814 }
Alex Chau2e487602022-03-15 19:34:08 +0000815 childStart += primaryDimension + getChildGap(i, i + delta);
Thales Limae4457742021-07-20 16:46:38 +0100816
817 // This makes sure that the space is added after the page, not after each panel
Thales Limac2a6f6f2021-09-09 17:06:22 +0100818 int lastPanel = mIsRtl ? 0 : panelCount - 1;
819 if (i % panelCount == lastPanel) {
Thales Limae4457742021-07-20 16:46:38 +0100820 childStart += mPageSpacing;
821 }
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700822 }
823 }
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100824
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100825 if (panelCount > 1) {
826 for (int i = 0; i < childCount; i++) {
Alex Chau1e448462021-08-13 21:48:35 +0100827 // In case we have multiple panels, always use left most panel's page scroll for all
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100828 // panels on the screen.
829 int adjustedScroll = outPageScrolls[getLeftmostVisiblePageForIndex(i)];
830 if (outPageScrolls[i] != adjustedScroll) {
831 outPageScrolls[i] = adjustedScroll;
832 pageScrollChanged = true;
833 }
834 }
835 }
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700836 return pageScrollChanged;
837 }
838
Alex Chau2e487602022-03-15 19:34:08 +0000839 protected int getChildGap(int fromIndex, int toIndex) {
Sunny Goyala1fbd842015-05-20 13:40:27 -0700840 return 0;
841 }
842
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700843 protected void updateMinAndMaxScrollX() {
Vinit Nayaka406f722019-12-19 11:50:55 -0800844 mMinScroll = computeMinScroll();
845 mMaxScroll = computeMaxScroll();
Tony Wickhamf549dab2016-05-16 09:54:06 -0700846 }
847
Vinit Nayaka406f722019-12-19 11:50:55 -0800848 protected int computeMinScroll() {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700849 return 0;
Tony50876bf2018-09-19 23:09:14 -0400850 }
851
Vinit Nayaka406f722019-12-19 11:50:55 -0800852 protected int computeMaxScroll() {
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700853 int childCount = getChildCount();
854 if (childCount > 0) {
Sunny Goyal70660032015-05-14 00:07:08 -0700855 final int index = mIsRtl ? 0 : childCount - 1;
Tony Wickhamf549dab2016-05-16 09:54:06 -0700856 return getScrollForPage(index);
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700857 } else {
Tony Wickhamf549dab2016-05-16 09:54:06 -0700858 return 0;
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700859 }
860 }
861
Adam Cohen3b185e22013-10-29 14:45:58 -0700862 public void setPageSpacing(int pageSpacing) {
863 mPageSpacing = pageSpacing;
864 requestLayout();
865 }
866
Tony50876bf2018-09-19 23:09:14 -0400867 public int getPageSpacing() {
868 return mPageSpacing;
869 }
870
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800871 private void dispatchPageCountChanged() {
872 if (mPageIndicator != null) {
Tony Wickhambab101c2021-09-20 15:12:44 -0700873 mPageIndicator.setMarkersCount(getChildCount() / getPanelCount());
Winson Chungd2be3812013-07-16 11:11:32 -0700874 }
Adam Cohen2591f6a2011-10-25 14:36:40 -0700875 // This ensures that when children are added, they get the correct transforms / alphas
876 // in accordance with any scroll effects.
Adam Cohen2591f6a2011-10-25 14:36:40 -0700877 invalidate();
878 }
879
Michael Jurka8b805b12012-04-18 14:23:14 -0700880 @Override
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800881 public void onViewAdded(View child) {
Winson Chungc7c51582018-02-23 17:58:36 -0800882 super.onViewAdded(child);
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800883 dispatchPageCountChanged();
884 }
885
886 @Override
887 public void onViewRemoved(View child) {
Winson Chungc7c51582018-02-23 17:58:36 -0800888 super.onViewRemoved(child);
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -0700889 runOnPageScrollsInitialized(() -> {
890 mCurrentPage = validateNewPage(mCurrentPage);
891 mCurrentScrollOverPage = mCurrentPage;
892 });
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800893 dispatchPageCountChanged();
Winson Chungd2be3812013-07-16 11:11:32 -0700894 }
895
Adam Cohen73894962011-10-31 13:17:17 -0700896 protected int getChildOffset(int index) {
Adam Cohen7d30a372013-07-01 17:03:59 -0700897 if (index < 0 || index > getChildCount() - 1) return 0;
Vinit Nayaka406f722019-12-19 11:50:55 -0800898 View pageAtIndex = getPageAt(index);
899 return mOrientationHandler.getChildStart(pageAtIndex);
Adam Cohen73894962011-10-31 13:17:17 -0700900 }
901
Alex Chau7944ee52021-01-08 19:07:25 +0000902 protected int getChildVisibleSize(int index) {
903 View layout = getPageAt(index);
904 return mOrientationHandler.getMeasuredSize(layout);
905 }
906
Winson Chung321e9ee2010-08-09 13:37:56 -0700907 @Override
908 public boolean requestChildRectangleOnScreen(View child, Rect rectangle, boolean immediate) {
Andras Kloczl7e912442021-05-06 12:50:28 +0200909 int page = indexOfChild(child);
910 if (!isVisible(page) || !mScroller.isFinished()) {
Vadim Trysheveeaa8ee2018-04-11 12:23:42 -0700911 if (immediate) {
912 setCurrentPage(page);
913 } else {
914 snapToPage(page);
915 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700916 return true;
917 }
918 return false;
919 }
920
921 @Override
922 protected boolean onRequestFocusInDescendants(int direction, Rect previouslyFocusedRect) {
Winson Chung86f77532010-08-24 11:08:22 -0700923 int focusablePage;
924 if (mNextPage != INVALID_PAGE) {
925 focusablePage = mNextPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700926 } else {
Winson Chung86f77532010-08-24 11:08:22 -0700927 focusablePage = mCurrentPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700928 }
Winson Chung86f77532010-08-24 11:08:22 -0700929 View v = getPageAt(focusablePage);
Winson Chung321e9ee2010-08-09 13:37:56 -0700930 if (v != null) {
Adam Cohen76fc0852011-06-17 13:26:23 -0700931 return v.requestFocus(direction, previouslyFocusedRect);
Winson Chung321e9ee2010-08-09 13:37:56 -0700932 }
933 return false;
934 }
935
936 @Override
937 public boolean dispatchUnhandledMove(View focused, int direction) {
Sunny Goyal0c4e3722015-12-01 13:21:49 -0800938 if (super.dispatchUnhandledMove(focused, direction)) {
939 return true;
940 }
941
942 if (mIsRtl) {
943 if (direction == View.FOCUS_LEFT) {
944 direction = View.FOCUS_RIGHT;
945 } else if (direction == View.FOCUS_RIGHT) {
946 direction = View.FOCUS_LEFT;
947 }
948 }
Andras Kloczl7e912442021-05-06 12:50:28 +0200949
950 int currentPage = getNextPage();
951 int closestNeighbourIndex = -1;
952 int closestNeighbourDistance = Integer.MAX_VALUE;
953 // Find the closest neighbour page
954 for (int neighbourPageIndex : getNeighbourPageIndices(direction)) {
955 int distance = Math.abs(neighbourPageIndex - currentPage);
956 if (closestNeighbourDistance > distance) {
957 closestNeighbourDistance = distance;
958 closestNeighbourIndex = neighbourPageIndex;
Winson Chung321e9ee2010-08-09 13:37:56 -0700959 }
960 }
Andras Kloczl7e912442021-05-06 12:50:28 +0200961 if (closestNeighbourIndex != -1) {
962 View page = getPageAt(closestNeighbourIndex);
963 snapToPage(closestNeighbourIndex);
964 page.requestFocus(direction);
965 return true;
966 }
967
Sunny Goyal0c4e3722015-12-01 13:21:49 -0800968 return false;
Winson Chung321e9ee2010-08-09 13:37:56 -0700969 }
970
971 @Override
972 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) {
Jon Miranda6a858172016-10-25 16:19:17 -0700973 if (getDescendantFocusability() == FOCUS_BLOCK_DESCENDANTS) {
974 return;
975 }
976
Andras Kloczl7e912442021-05-06 12:50:28 +0200977 // nextPage is more reliable when multiple control movements have been done in a short
978 // period of time
979 getPageIndices(getNextPage())
980 .addAll(getNeighbourPageIndices(direction))
981 .forEach(pageIndex ->
982 getPageAt(pageIndex).addFocusables(views, direction, focusableMode));
Winson Chung321e9ee2010-08-09 13:37:56 -0700983 }
984
985 /**
986 * If one of our descendant views decides that it could be focused now, only
Winson Chung86f77532010-08-24 11:08:22 -0700987 * pass that along if it's on the current page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700988 *
Winson Chung86f77532010-08-24 11:08:22 -0700989 * This happens when live folders requery, and if they're off page, they
990 * end up calling requestFocus, which pulls it on page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700991 */
992 @Override
993 public void focusableViewAvailable(View focused) {
Winson Chung86f77532010-08-24 11:08:22 -0700994 View current = getPageAt(mCurrentPage);
Winson Chung321e9ee2010-08-09 13:37:56 -0700995 View v = focused;
996 while (true) {
997 if (v == current) {
998 super.focusableViewAvailable(focused);
999 return;
1000 }
1001 if (v == this) {
1002 return;
1003 }
1004 ViewParent parent = v.getParent();
1005 if (parent instanceof View) {
1006 v = (View)v.getParent();
1007 } else {
1008 return;
1009 }
1010 }
1011 }
1012
1013 /**
1014 * {@inheritDoc}
1015 */
1016 @Override
1017 public void requestDisallowInterceptTouchEvent(boolean disallowIntercept) {
1018 if (disallowIntercept) {
1019 // We need to make sure to cancel our long press if
1020 // a scrollable widget takes over touch events
Andras Kloczl7a1ca0b2021-04-08 16:08:16 +02001021 cancelCurrentPageLongPress();
Winson Chung321e9ee2010-08-09 13:37:56 -07001022 }
1023 super.requestDisallowInterceptTouchEvent(disallowIntercept);
1024 }
1025
1026 @Override
1027 public boolean onInterceptTouchEvent(MotionEvent ev) {
1028 /*
1029 * This method JUST determines whether we want to intercept the motion.
1030 * If we return true, onTouchEvent will be called and we do the actual
1031 * scrolling there.
1032 */
1033
Winson Chung45e1d6e2010-11-09 17:19:49 -08001034 // Skip touch handling if there are no pages to swipe
Tony Wickhamb6841ac2019-07-22 12:39:59 -07001035 if (getChildCount() <= 0) return false;
Sunny Goyalc4bb3732019-06-20 11:34:14 -07001036
1037 acquireVelocityTrackerAndAddMovement(ev);
Winson Chung45e1d6e2010-11-09 17:19:49 -08001038
Winson Chung321e9ee2010-08-09 13:37:56 -07001039 /*
1040 * Shortcut the most recurring case: the user is in the dragging
1041 * state and he is moving his finger. We want to intercept this
1042 * motion.
1043 */
1044 final int action = ev.getAction();
Sunny Goyalaad33592018-08-07 17:20:35 -07001045 if ((action == MotionEvent.ACTION_MOVE) && mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001046 return true;
1047 }
1048
Winson Chung321e9ee2010-08-09 13:37:56 -07001049 switch (action & MotionEvent.ACTION_MASK) {
1050 case MotionEvent.ACTION_MOVE: {
1051 /*
1052 * mIsBeingDragged == false, otherwise the shortcut would have caught it. Check
Vinit Nayaka406f722019-12-19 11:50:55 -08001053 * whether the user has moved far enough from their original down touch.
Winson Chung321e9ee2010-08-09 13:37:56 -07001054 */
Michael Jurka1ff706b2010-09-14 17:35:20 -07001055 if (mActivePointerId != INVALID_POINTER) {
1056 determineScrollingStart(ev);
Michael Jurka1ff706b2010-09-14 17:35:20 -07001057 }
1058 // if mActivePointerId is INVALID_POINTER, then we must have missed an ACTION_DOWN
Vinit Nayaka406f722019-12-19 11:50:55 -08001059 // event. in that case, treat the first occurrence of a move event as a ACTION_DOWN
Michael Jurka1ff706b2010-09-14 17:35:20 -07001060 // i.e. fall through to the next case (don't break)
1061 // (We sometimes miss ACTION_DOWN events in Workspace because it ignores all events
1062 // while it's small- this was causing a crash before we checked for INVALID_POINTER)
Adam Cohen93c97562013-09-26 13:48:01 -07001063 break;
Winson Chung321e9ee2010-08-09 13:37:56 -07001064 }
1065
1066 case MotionEvent.ACTION_DOWN: {
1067 final float x = ev.getX();
1068 final float y = ev.getY();
1069 // Remember location of down touch
1070 mDownMotionX = x;
Adam Cohen7d30a372013-07-01 17:03:59 -07001071 mDownMotionY = y;
Jon Mirandaf52af432020-04-10 17:25:57 -07001072 mDownMotionPrimary = mLastMotion = mOrientationHandler.getPrimaryDirection(ev, 0);
Vinit Nayaka406f722019-12-19 11:50:55 -08001073 mLastMotionRemainder = 0;
1074 mTotalMotion = 0;
Winson Chung4941f652020-06-18 15:11:53 -07001075 mAllowEasyFling = false;
Winson Chung321e9ee2010-08-09 13:37:56 -07001076 mActivePointerId = ev.getPointerId(0);
Sunny Goyalc39db732021-04-03 01:20:21 -07001077 updateIsBeingDraggedOnTouchDown(ev);
Winson Chung321e9ee2010-08-09 13:37:56 -07001078 break;
1079 }
1080
Winson Chung321e9ee2010-08-09 13:37:56 -07001081 case MotionEvent.ACTION_UP:
Jeff Brown1d0867c2010-12-02 18:27:39 -08001082 case MotionEvent.ACTION_CANCEL:
Adam Cohen7d30a372013-07-01 17:03:59 -07001083 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001084 break;
1085
1086 case MotionEvent.ACTION_POINTER_UP:
1087 onSecondaryPointerUp(ev);
Adam Cohen6342bba2011-03-10 11:33:35 -08001088 releaseVelocityTracker();
Winson Chung321e9ee2010-08-09 13:37:56 -07001089 break;
1090 }
1091
1092 /*
1093 * The only time we want to intercept motion events is if we are in the
1094 * drag mode.
1095 */
Sunny Goyalaad33592018-08-07 17:20:35 -07001096 return mIsBeingDragged;
Winson Chung321e9ee2010-08-09 13:37:56 -07001097 }
1098
Tony Wickhama0aee212019-09-18 09:24:03 -07001099 /**
1100 * If being flinged and user touches the screen, initiate drag; otherwise don't.
1101 */
Sunny Goyalbb030562021-07-19 16:28:39 -07001102 protected void updateIsBeingDraggedOnTouchDown(MotionEvent ev) {
Tony Wickhama0aee212019-09-18 09:24:03 -07001103 // mScroller.isFinished should be false when being flinged.
Sunny Goyalc39db732021-04-03 01:20:21 -07001104 final int xDist = Math.abs(mScroller.getFinalX() - mScroller.getCurrX());
Winson Chung4941f652020-06-18 15:11:53 -07001105 final boolean finishedScrolling = (mScroller.isFinished() || xDist < mPageSlop / 3);
Tony Wickhama0aee212019-09-18 09:24:03 -07001106
1107 if (finishedScrolling) {
1108 mIsBeingDragged = false;
1109 if (!mScroller.isFinished() && !mFreeScroll) {
1110 setCurrentPage(getNextPage());
1111 pageEndTransition();
1112 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001113 mIsBeingDragged = !mEdgeGlowLeft.isFinished() || !mEdgeGlowRight.isFinished();
Tony Wickhama0aee212019-09-18 09:24:03 -07001114 } else {
1115 mIsBeingDragged = true;
1116 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001117
1118 // Catch the edge effect if it is active.
1119 float displacement = mOrientationHandler.getSecondaryValue(ev.getX(), ev.getY())
1120 / mOrientationHandler.getSecondaryValue(getWidth(), getHeight());
1121 if (!mEdgeGlowLeft.isFinished()) {
1122 mEdgeGlowLeft.onPullDistance(0f, 1f - displacement);
1123 }
1124 if (!mEdgeGlowRight.isFinished()) {
1125 mEdgeGlowRight.onPullDistance(0f, displacement);
1126 }
Tony Wickhama0aee212019-09-18 09:24:03 -07001127 }
1128
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001129 public boolean isHandlingTouch() {
Sunny Goyalaad33592018-08-07 17:20:35 -07001130 return mIsBeingDragged;
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001131 }
1132
Adam Cohenf8d28232011-02-01 21:47:00 -08001133 protected void determineScrollingStart(MotionEvent ev) {
1134 determineScrollingStart(ev, 1.0f);
1135 }
1136
Winson Chung321e9ee2010-08-09 13:37:56 -07001137 /*
1138 * Determines if we should change the touch state to start scrolling after the
1139 * user moves their touch point too far.
1140 */
Adam Cohenf8d28232011-02-01 21:47:00 -08001141 protected void determineScrollingStart(MotionEvent ev, float touchSlopScale) {
Adam Cohen7d30a372013-07-01 17:03:59 -07001142 // Disallow scrolling if we don't have a valid pointer index
Winson Chung321e9ee2010-08-09 13:37:56 -07001143 final int pointerIndex = ev.findPointerIndex(mActivePointerId);
Adam Cohen7d30a372013-07-01 17:03:59 -07001144 if (pointerIndex == -1) return;
1145
Vinit Nayaka406f722019-12-19 11:50:55 -08001146 final float primaryDirection = mOrientationHandler.getPrimaryDirection(ev, pointerIndex);
1147 final int diff = (int) Math.abs(primaryDirection - mLastMotion);
Adam Cohenf8d28232011-02-01 21:47:00 -08001148 final int touchSlop = Math.round(touchSlopScale * mTouchSlop);
Winson Chung4941f652020-06-18 15:11:53 -07001149 boolean moved = diff > touchSlop || ev.getAction() == ACTION_MOVE_ALLOW_EASY_FLING;
Winson Chung321e9ee2010-08-09 13:37:56 -07001150
Vinit Nayaka406f722019-12-19 11:50:55 -08001151 if (moved) {
Sunny Goyal5a1f53b2015-05-27 10:24:24 -07001152 // Scroll if the user moved far enough along the X axis
Sunny Goyalaad33592018-08-07 17:20:35 -07001153 mIsBeingDragged = true;
Vinit Nayaka406f722019-12-19 11:50:55 -08001154 mTotalMotion += Math.abs(mLastMotion - primaryDirection);
1155 mLastMotion = primaryDirection;
1156 mLastMotionRemainder = 0;
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001157 pageBeginTransition();
Tony Wickhamdadb3042016-02-24 11:07:00 -08001158 // Stop listening for things like pinches.
1159 requestDisallowInterceptTouchEvent(true);
Adam Cohenf8d28232011-02-01 21:47:00 -08001160 }
1161 }
1162
1163 protected void cancelCurrentPageLongPress() {
Sunny Goyal8e2133b2015-05-06 13:39:07 -07001164 // Try canceling the long press. It could also have been scheduled
1165 // by a distant descendant, so use the mAllowLongPress flag to block
1166 // everything
Sunny Goyal59969372021-05-06 12:11:44 -07001167 forEachVisiblePage(View::cancelLongPress);
Winson Chung321e9ee2010-08-09 13:37:56 -07001168 }
1169
Adam Cohenb5ba0972011-09-07 18:02:31 -07001170 protected float getScrollProgress(int screenCenter, View v, int page) {
Sunny Goyal228153d2018-01-04 15:35:22 -08001171 final int halfScreenSize = getMeasuredWidth() / 2;
Adam Cohenedb40762013-07-18 16:45:45 -07001172 int delta = screenCenter - (getScrollForPage(page) + halfScreenSize);
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001173 int panelCount = getPanelCount();
1174 int pageCount = getChildCount();
Adam Cohen3b185e22013-10-29 14:45:58 -07001175
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001176 int adjacentPage = page + panelCount;
Sunny Goyal70660032015-05-14 00:07:08 -07001177 if ((delta < 0 && !mIsRtl) || (delta > 0 && mIsRtl)) {
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001178 adjacentPage = page - panelCount;
Adam Cohen3b185e22013-10-29 14:45:58 -07001179 }
1180
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001181 final int totalDistance;
1182 if (adjacentPage < 0 || adjacentPage > pageCount - 1) {
1183 totalDistance = (v.getMeasuredWidth() + mPageSpacing) * panelCount;
Adam Cohen3b185e22013-10-29 14:45:58 -07001184 } else {
1185 totalDistance = Math.abs(getScrollForPage(adjacentPage) - getScrollForPage(page));
1186 }
Adam Cohenb5ba0972011-09-07 18:02:31 -07001187
1188 float scrollProgress = delta / (totalDistance * 1.0f);
Sunny Goyal8e2133b2015-05-06 13:39:07 -07001189 scrollProgress = Math.min(scrollProgress, MAX_SCROLL_PROGRESS);
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001190 scrollProgress = Math.max(scrollProgress, -MAX_SCROLL_PROGRESS);
Adam Cohenb5ba0972011-09-07 18:02:31 -07001191 return scrollProgress;
1192 }
1193
Adam Cohenedb40762013-07-18 16:45:45 -07001194 public int getScrollForPage(int index) {
Tony Wickhambed0d632022-06-14 15:51:09 -07001195 if (!pageScrollsInitialized() || index >= mPageScrolls.length || index < 0) {
Adam Cohenedb40762013-07-18 16:45:45 -07001196 return 0;
1197 } else {
1198 return mPageScrolls[index];
1199 }
1200 }
1201
Adam Cohen564a2e72013-10-09 14:47:32 -07001202 // While layout transitions are occurring, a child's position may stray from its baseline
1203 // position. This method returns the magnitude of this stray at any given time.
1204 public int getLayoutTransitionOffsetForPage(int index) {
Schneider Victor-tuliasbb44c032022-04-07 15:25:00 -07001205 if (!pageScrollsInitialized() || index >= mPageScrolls.length || index < 0) {
Adam Cohen564a2e72013-10-09 14:47:32 -07001206 return 0;
1207 } else {
1208 View child = getChildAt(index);
Adam Cohen3b185e22013-10-29 14:45:58 -07001209
Sunny Goyal228153d2018-01-04 15:35:22 -08001210 int scrollOffset = mIsRtl ? getPaddingRight() : getPaddingLeft();
1211 int baselineX = mPageScrolls[index] + scrollOffset;
Adam Cohen564a2e72013-10-09 14:47:32 -07001212 return (int) (child.getX() - baselineX);
1213 }
1214 }
1215
Tony Wickham023f4042019-01-29 10:52:31 -08001216 public void setEnableFreeScroll(boolean freeScroll) {
Winson Chung0e449002019-04-26 11:09:58 -07001217 if (mFreeScroll == freeScroll) {
1218 return;
1219 }
1220
Tony Wickham8f7ead32016-04-07 18:46:44 -07001221 boolean wasFreeScroll = mFreeScroll;
Adam Cohenf358a4b2013-07-23 16:47:31 -07001222 mFreeScroll = freeScroll;
1223
Adam Cohenf9618852013-11-08 06:45:03 -08001224 if (mFreeScroll) {
Sunny Goyal4d519f22017-10-24 10:32:40 -07001225 setCurrentPage(getNextPage());
Tony Wickham8f7ead32016-04-07 18:46:44 -07001226 } else if (wasFreeScroll) {
Tony Wickhamaf33f2c2019-10-04 12:55:22 -07001227 if (getScrollForPage(getNextPage()) != getScrollX()) {
1228 snapToPage(getNextPage());
1229 }
Adam Cohenf358a4b2013-07-23 16:47:31 -07001230 }
Adam Cohenf358a4b2013-07-23 16:47:31 -07001231 }
1232
Sunny Goyal2f0ec852015-03-26 13:38:27 -07001233 protected void setEnableOverscroll(boolean enable) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001234 mAllowOverScroll = enable;
1235 }
1236
Andras Kloczl07111f22022-03-30 17:25:54 +01001237 protected boolean isSignificantMove(float absoluteDelta, int pageOrientedSize) {
1238 return absoluteDelta > pageOrientedSize * SIGNIFICANT_MOVE_THRESHOLD;
Alex Chau822acf42021-06-03 11:35:05 +01001239 }
1240
Winson Chung321e9ee2010-08-09 13:37:56 -07001241 @Override
1242 public boolean onTouchEvent(MotionEvent ev) {
Winson Chung45e1d6e2010-11-09 17:19:49 -08001243 // Skip touch handling if there are no pages to swipe
Tony Wickhamb6841ac2019-07-22 12:39:59 -07001244 if (getChildCount() <= 0) return false;
Winson Chung45e1d6e2010-11-09 17:19:49 -08001245
Michael Jurkab8f06722010-10-10 15:58:46 -07001246 acquireVelocityTrackerAndAddMovement(ev);
Winson Chung321e9ee2010-08-09 13:37:56 -07001247
1248 final int action = ev.getAction();
1249
1250 switch (action & MotionEvent.ACTION_MASK) {
1251 case MotionEvent.ACTION_DOWN:
Sunny Goyalc39db732021-04-03 01:20:21 -07001252 updateIsBeingDraggedOnTouchDown(ev);
Tony Wickhama0aee212019-09-18 09:24:03 -07001253
Winson Chung321e9ee2010-08-09 13:37:56 -07001254 /*
1255 * If being flinged and user touches, stop the fling. isFinished
1256 * will be false if being flinged.
1257 */
1258 if (!mScroller.isFinished()) {
Adam Cohen8bdbaab2013-10-29 15:25:02 -07001259 abortScrollerAnimation(false);
Winson Chung321e9ee2010-08-09 13:37:56 -07001260 }
1261
1262 // Remember where the motion event started
Vinit Nayaka406f722019-12-19 11:50:55 -08001263 mDownMotionX = ev.getX();
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001264 mDownMotionY = ev.getY();
Vinit Nayaka406f722019-12-19 11:50:55 -08001265 mDownMotionPrimary = mLastMotion = mOrientationHandler.getPrimaryDirection(ev, 0);
1266 mLastMotionRemainder = 0;
1267 mTotalMotion = 0;
Winson Chung4941f652020-06-18 15:11:53 -07001268 mAllowEasyFling = false;
Winson Chung321e9ee2010-08-09 13:37:56 -07001269 mActivePointerId = ev.getPointerId(0);
Sunny Goyalaad33592018-08-07 17:20:35 -07001270 if (mIsBeingDragged) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001271 pageBeginTransition();
Michael Jurka0142d492010-08-25 17:46:15 -07001272 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001273 break;
1274
Winson Chung4941f652020-06-18 15:11:53 -07001275 case ACTION_MOVE_ALLOW_EASY_FLING:
1276 // Start scrolling immediately
1277 determineScrollingStart(ev);
1278 mAllowEasyFling = true;
1279 break;
1280
1281 case MotionEvent.ACTION_MOVE:
1282 if (mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001283 // Scroll to follow the motion event
1284 final int pointerIndex = ev.findPointerIndex(mActivePointerId);
Adam Cohen7d30a372013-07-01 17:03:59 -07001285
1286 if (pointerIndex == -1) return true;
Sunny Goyalc39db732021-04-03 01:20:21 -07001287 float oldScroll = mOrientationHandler.getPrimaryScroll(this);
1288 float dx = ev.getX(pointerIndex);
1289 float dy = ev.getY(pointerIndex);
Adam Cohen7d30a372013-07-01 17:03:59 -07001290
Sunny Goyalc39db732021-04-03 01:20:21 -07001291 float direction = mOrientationHandler.getPrimaryValue(dx, dy);
Vinit Nayaka406f722019-12-19 11:50:55 -08001292 float delta = mLastMotion + mLastMotionRemainder - direction;
Sunny Goyalc39db732021-04-03 01:20:21 -07001293
1294 int width = getWidth();
1295 int height = getHeight();
1296 int size = mOrientationHandler.getPrimaryValue(width, height);
1297
1298 final float displacement = mOrientationHandler.getSecondaryValue(dx, dy)
1299 / mOrientationHandler.getSecondaryValue(width, height);
Vinit Nayaka406f722019-12-19 11:50:55 -08001300 mTotalMotion += Math.abs(delta);
Adam Cohenaefd4e12011-02-14 16:39:38 -08001301
Sunny Goyalc39db732021-04-03 01:20:21 -07001302 if (mAllowOverScroll) {
1303 float consumed = 0;
1304 if (delta < 0 && mEdgeGlowRight.getDistance() != 0f) {
1305 consumed = size * mEdgeGlowRight.onPullDistance(delta / size, displacement);
1306 } else if (delta > 0 && mEdgeGlowLeft.getDistance() != 0f) {
1307 consumed = -size * mEdgeGlowLeft.onPullDistance(
1308 -delta / size, 1 - displacement);
1309 }
1310 delta -= consumed;
1311 }
Alex Chau822acf42021-06-03 11:35:05 +01001312 delta /= mOrientationHandler.getPrimaryScale(this);
Sunny Goyalc39db732021-04-03 01:20:21 -07001313
Winson Chungc0844aa2011-02-02 15:25:58 -08001314 // Only scroll and update mLastMotionX if we have moved some discrete amount. We
1315 // keep the remainder because we are actually testing if we've moved from the last
1316 // scrolled position (which is discrete).
Sunny Goyalc39db732021-04-03 01:20:21 -07001317 mLastMotion = direction;
1318 int movedDelta = (int) delta;
1319 mLastMotionRemainder = delta - movedDelta;
Vinit Nayaka406f722019-12-19 11:50:55 -08001320
Sunny Goyalc39db732021-04-03 01:20:21 -07001321 if (delta != 0) {
Alex Chau6499e832021-11-19 14:35:46 +00001322 mOrientationHandler.setPrimary(this, VIEW_SCROLL_BY, movedDelta);
Sunny Goyalc39db732021-04-03 01:20:21 -07001323
1324 if (mAllowOverScroll) {
1325 final float pulledToX = oldScroll + delta;
1326
1327 if (pulledToX < mMinScroll) {
1328 mEdgeGlowLeft.onPullDistance(-delta / size, 1.f - displacement);
1329 if (!mEdgeGlowRight.isFinished()) {
1330 mEdgeGlowRight.onRelease();
1331 }
1332 } else if (pulledToX > mMaxScroll) {
1333 mEdgeGlowRight.onPullDistance(delta / size, displacement);
1334 if (!mEdgeGlowLeft.isFinished()) {
1335 mEdgeGlowLeft.onRelease();
1336 }
1337 }
1338
1339 if (!mEdgeGlowLeft.isFinished() || !mEdgeGlowRight.isFinished()) {
1340 postInvalidateOnAnimation();
1341 }
1342 }
1343
Winson Chung321e9ee2010-08-09 13:37:56 -07001344 } else {
1345 awakenScrollBars();
1346 }
Adam Cohen564976a2010-10-13 18:52:07 -07001347 } else {
Winson Chung321e9ee2010-08-09 13:37:56 -07001348 determineScrollingStart(ev);
1349 }
1350 break;
1351
1352 case MotionEvent.ACTION_UP:
Sunny Goyalaad33592018-08-07 17:20:35 -07001353 if (mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001354 final int activePointerId = mActivePointerId;
1355 final int pointerIndex = ev.findPointerIndex(activePointerId);
Vinit Nayak93bf1fe2020-05-26 17:22:13 -07001356 if (pointerIndex == -1) return true;
1357
Vinit Nayaka406f722019-12-19 11:50:55 -08001358 final float primaryDirection = mOrientationHandler.getPrimaryDirection(ev,
1359 pointerIndex);
Sunny Goyal4bb8b062019-02-19 16:37:38 -08001360 final VelocityTracker velocityTracker = mVelocityTracker;
1361 velocityTracker.computeCurrentVelocity(1000, mMaximumVelocity);
Adam Cohenaefd4e12011-02-14 16:39:38 -08001362
Vinit Nayaka406f722019-12-19 11:50:55 -08001363 int velocity = (int) mOrientationHandler.getPrimaryVelocity(velocityTracker,
Andras Kloczl07111f22022-03-30 17:25:54 +01001364 mActivePointerId);
Alex Chau822acf42021-06-03 11:35:05 +01001365 float delta = primaryDirection - mDownMotionPrimary;
Andras Kloczl07111f22022-03-30 17:25:54 +01001366 int pageOrientedSize = (int) (mOrientationHandler.getMeasuredSize(
1367 getPageAt(mCurrentPage))
1368 * mOrientationHandler.getPrimaryScale(this));
1369 boolean isSignificantMove = isSignificantMove(Math.abs(delta), pageOrientedSize);
Vinit Nayaka406f722019-12-19 11:50:55 -08001370
1371 mTotalMotion += Math.abs(mLastMotion + mLastMotionRemainder - primaryDirection);
Winson Chung4941f652020-06-18 15:11:53 -07001372 boolean passedSlop = mAllowEasyFling || mTotalMotion > mPageSlop;
1373 boolean isFling = passedSlop && shouldFlingForVelocity(velocity);
Vinit Nayaka406f722019-12-19 11:50:55 -08001374 boolean isDeltaLeft = mIsRtl ? delta > 0 : delta < 0;
1375 boolean isVelocityLeft = mIsRtl ? velocity > 0 : velocity < 0;
Winson Chung4941f652020-06-18 15:11:53 -07001376 if (DEBUG_FAILED_QUICKSWITCH && !isFling && mAllowEasyFling) {
1377 Log.d("Quickswitch", "isFling=false vel=" + velocity
1378 + " threshold=" + mEasyFlingThresholdVelocity);
1379 }
Adam Cohen00481b32011-11-18 12:03:48 -08001380
Adam Cohenf358a4b2013-07-23 16:47:31 -07001381 if (!mFreeScroll) {
1382 // In the case that the page is moved far to one direction and then is flung
1383 // in the opposite direction, we use a threshold to determine whether we should
1384 // just return to the starting page, or if we should skip one further.
1385 boolean returnToOriginalPage = false;
Vinit Nayaka406f722019-12-19 11:50:55 -08001386 if (Math.abs(delta) > pageOrientedSize * RETURN_TO_ORIGINAL_PAGE_THRESHOLD &&
1387 Math.signum(velocity) != Math.signum(delta) && isFling) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001388 returnToOriginalPage = true;
1389 }
Adam Cohenaefd4e12011-02-14 16:39:38 -08001390
Adam Cohenf358a4b2013-07-23 16:47:31 -07001391 int finalPage;
1392 // We give flings precedence over large moves, which is why we short-circuit our
1393 // test for a large move if a fling has been registered. That is, a large
1394 // move to the left and fling to the right will register as a fling to the right.
Sunny Goyalb7b01352018-08-09 12:31:20 -07001395
Vinit Nayaka406f722019-12-19 11:50:55 -08001396 if (((isSignificantMove && !isDeltaLeft && !isFling) ||
1397 (isFling && !isVelocityLeft)) && mCurrentPage > 0) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +01001398 finalPage = returnToOriginalPage
1399 ? mCurrentPage : mCurrentPage - getPanelCount();
Vinit Nayaka406f722019-12-19 11:50:55 -08001400 snapToPageWithVelocity(finalPage, velocity);
1401 } else if (((isSignificantMove && isDeltaLeft && !isFling) ||
1402 (isFling && isVelocityLeft)) &&
Adam Cohenf358a4b2013-07-23 16:47:31 -07001403 mCurrentPage < getChildCount() - 1) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +01001404 finalPage = returnToOriginalPage
1405 ? mCurrentPage : mCurrentPage + getPanelCount();
Vinit Nayaka406f722019-12-19 11:50:55 -08001406 snapToPageWithVelocity(finalPage, velocity);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001407 } else {
1408 snapToDestination();
Adam Cohenf358a4b2013-07-23 16:47:31 -07001409 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001410 } else {
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001411 if (!mScroller.isFinished()) {
1412 abortScrollerAnimation(true);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001413 }
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001414
Vinit Nayaka406f722019-12-19 11:50:55 -08001415 int initialScroll = mOrientationHandler.getPrimaryScroll(this);
1416 int maxScroll = mMaxScroll;
1417 int minScroll = mMinScroll;
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001418
Vinit Nayaka406f722019-12-19 11:50:55 -08001419 if (((initialScroll >= maxScroll) && (isVelocityLeft || !isFling)) ||
1420 ((initialScroll <= minScroll) && (!isVelocityLeft || !isFling))) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001421 mScroller.springBack(initialScroll, 0, minScroll, maxScroll, 0, 0);
Alex Chaub794ea62021-02-03 18:00:30 +00001422 mNextPage = getDestinationPage();
Sunny Goyalb7b01352018-08-09 12:31:20 -07001423 } else {
Sunny Goyalc39db732021-04-03 01:20:21 -07001424 int velocity1 = -velocity;
1425 // Continue a scroll or fling in progress
1426 mScroller.fling(initialScroll, 0, velocity1, 0, minScroll, maxScroll, 0, 0,
1427 Math.round(getWidth() * 0.5f * OVERSCROLL_DAMP_FACTOR), 0);
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001428
Sunny Goyalc39db732021-04-03 01:20:21 -07001429 int finalPos = mScroller.getFinalX();
Alex Chaub794ea62021-02-03 18:00:30 +00001430 mNextPage = getDestinationPage(finalPos);
Sunny Goyalc39db732021-04-03 01:20:21 -07001431 onNotSnappingToPageInFreeScroll();
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001432 }
1433 invalidate();
Winson Chung321e9ee2010-08-09 13:37:56 -07001434 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001435 }
Adam Cohen7d30a372013-07-01 17:03:59 -07001436
Sunny Goyalc39db732021-04-03 01:20:21 -07001437 mEdgeGlowLeft.onRelease();
1438 mEdgeGlowRight.onRelease();
Adam Cohen7d30a372013-07-01 17:03:59 -07001439 // End any intermediate reordering states
1440 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001441 break;
1442
1443 case MotionEvent.ACTION_CANCEL:
Sunny Goyalaad33592018-08-07 17:20:35 -07001444 if (mIsBeingDragged) {
Michael Jurkab8f06722010-10-10 15:58:46 -07001445 snapToDestination();
1446 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001447 mEdgeGlowLeft.onRelease();
1448 mEdgeGlowRight.onRelease();
Adam Cohen7d30a372013-07-01 17:03:59 -07001449 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001450 break;
1451
1452 case MotionEvent.ACTION_POINTER_UP:
1453 onSecondaryPointerUp(ev);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001454 releaseVelocityTracker();
Winson Chung321e9ee2010-08-09 13:37:56 -07001455 break;
1456 }
1457
1458 return true;
1459 }
1460
Sunny Goyalc39db732021-04-03 01:20:21 -07001461 protected void onNotSnappingToPageInFreeScroll() { }
Alex Chaub794ea62021-02-03 18:00:30 +00001462
Lais Andradecc5c8842021-06-04 18:20:30 +01001463 /**
1464 * Called when the view edges absorb part of the scroll. Subclasses can override this
1465 * to provide custom behavior during animation.
1466 */
1467 protected void onEdgeAbsorbingScroll() {
1468 }
1469
1470 /**
1471 * Called when the current page closest to the center of the screen changes as part of the
1472 * scroll. Subclasses can override this to provide custom behavior during scroll.
1473 */
1474 protected void onScrollOverPageChanged() {
1475 }
1476
Vinit Nayaka406f722019-12-19 11:50:55 -08001477 protected boolean shouldFlingForVelocity(int velocity) {
Winson Chung4941f652020-06-18 15:11:53 -07001478 float threshold = mAllowEasyFling ? mEasyFlingThresholdVelocity : mFlingThresholdVelocity;
1479 return Math.abs(velocity) > threshold;
Sunny Goyal65d9ceb2017-05-08 09:17:42 -07001480 }
1481
Alex Chau9d8eeab2022-04-05 17:13:56 +01001482 protected void resetTouchState() {
Adam Cohen7d30a372013-07-01 17:03:59 -07001483 releaseVelocityTracker();
Sunny Goyalaad33592018-08-07 17:20:35 -07001484 mIsBeingDragged = false;
Adam Cohen7d30a372013-07-01 17:03:59 -07001485 mActivePointerId = INVALID_POINTER;
Adam Cohen7d30a372013-07-01 17:03:59 -07001486 }
1487
Winson Chung185d7162011-02-28 13:47:29 -08001488 @Override
1489 public boolean onGenericMotionEvent(MotionEvent event) {
1490 if ((event.getSource() & InputDevice.SOURCE_CLASS_POINTER) != 0) {
1491 switch (event.getAction()) {
1492 case MotionEvent.ACTION_SCROLL: {
1493 // Handle mouse (or ext. device) by shifting the page depending on the scroll
1494 final float vscroll;
1495 final float hscroll;
1496 if ((event.getMetaState() & KeyEvent.META_SHIFT_ON) != 0) {
1497 vscroll = 0;
1498 hscroll = event.getAxisValue(MotionEvent.AXIS_VSCROLL);
1499 } else {
1500 vscroll = -event.getAxisValue(MotionEvent.AXIS_VSCROLL);
1501 hscroll = event.getAxisValue(MotionEvent.AXIS_HSCROLL);
1502 }
Sunny Goyal8b37c572020-03-31 12:12:14 -07001503 if (!canScroll(Math.abs(vscroll), Math.abs(hscroll))) {
1504 return false;
Samuel Fufa59cba192019-08-22 18:31:34 -07001505 }
Winson Chung185d7162011-02-28 13:47:29 -08001506 if (hscroll != 0 || vscroll != 0) {
Sunny Goyal70660032015-05-14 00:07:08 -07001507 boolean isForwardScroll = mIsRtl ? (hscroll < 0 || vscroll < 0)
Adam Cohen0ffac432013-07-10 11:19:26 -07001508 : (hscroll > 0 || vscroll > 0);
1509 if (isForwardScroll) {
Winson Chung185d7162011-02-28 13:47:29 -08001510 scrollRight();
1511 } else {
1512 scrollLeft();
1513 }
1514 return true;
1515 }
1516 }
1517 }
1518 }
1519 return super.onGenericMotionEvent(event);
1520 }
1521
Sunny Goyal8b37c572020-03-31 12:12:14 -07001522 /**
1523 * Returns true if the paged view can scroll for the provided vertical and horizontal
1524 * scroll values
1525 */
1526 protected boolean canScroll(float absVScroll, float absHScroll) {
1527 ActivityContext ac = ActivityContext.lookupContext(getContext());
1528 return (ac == null || AbstractFloatingView.getTopOpenView(ac) == null);
Samuel Fufa59cba192019-08-22 18:31:34 -07001529 }
1530
Michael Jurkab8f06722010-10-10 15:58:46 -07001531 private void acquireVelocityTrackerAndAddMovement(MotionEvent ev) {
1532 if (mVelocityTracker == null) {
1533 mVelocityTracker = VelocityTracker.obtain();
1534 }
1535 mVelocityTracker.addMovement(ev);
1536 }
1537
1538 private void releaseVelocityTracker() {
1539 if (mVelocityTracker != null) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001540 mVelocityTracker.clear();
Michael Jurkab8f06722010-10-10 15:58:46 -07001541 mVelocityTracker.recycle();
1542 mVelocityTracker = null;
1543 }
1544 }
1545
Winson Chung321e9ee2010-08-09 13:37:56 -07001546 private void onSecondaryPointerUp(MotionEvent ev) {
Winson Chung4941f652020-06-18 15:11:53 -07001547 final int pointerIndex = ev.getActionIndex();
Winson Chung321e9ee2010-08-09 13:37:56 -07001548 final int pointerId = ev.getPointerId(pointerIndex);
1549 if (pointerId == mActivePointerId) {
1550 // This was our active pointer going up. Choose a new
1551 // active pointer and adjust accordingly.
1552 // TODO: Make this decision more intelligent.
1553 final int newPointerIndex = pointerIndex == 0 ? 1 : 0;
Vinit Nayaka406f722019-12-19 11:50:55 -08001554 mLastMotion = mDownMotionPrimary = mOrientationHandler.getPrimaryDirection(ev,
1555 newPointerIndex);
1556 mLastMotionRemainder = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -07001557 mActivePointerId = ev.getPointerId(newPointerIndex);
1558 if (mVelocityTracker != null) {
1559 mVelocityTracker.clear();
1560 }
1561 }
Jeff Brown1d0867c2010-12-02 18:27:39 -08001562 }
1563
Winson Chung321e9ee2010-08-09 13:37:56 -07001564 @Override
1565 public void requestChildFocus(View child, View focused) {
1566 super.requestChildFocus(child, focused);
Andras Kloczl359d1ae2021-05-04 22:25:27 +02001567
1568 // In case the device is controlled by a controller, mCurrentPage isn't updated properly
1569 // which results in incorrect navigation
1570 int nextPage = getNextPage();
1571 if (nextPage != mCurrentPage) {
1572 setCurrentPage(nextPage);
1573 }
1574
Andras Kloczl7e912442021-05-06 12:50:28 +02001575 int page = indexOfChild(child);
1576 if (page >= 0 && !isVisible(page) && !isInTouchMode()) {
Winson Chung86f77532010-08-24 11:08:22 -07001577 snapToPage(page);
Winson Chung321e9ee2010-08-09 13:37:56 -07001578 }
1579 }
1580
Alex Chaub794ea62021-02-03 18:00:30 +00001581 public int getDestinationPage() {
1582 return getDestinationPage(mOrientationHandler.getPrimaryScroll(this));
1583 }
1584
Alex Chaudedbc8a2021-03-17 16:53:26 +00001585 protected int getDestinationPage(int primaryScroll) {
1586 return getPageNearestToCenterOfScreen(primaryScroll);
Alex Chaub794ea62021-02-03 18:00:30 +00001587 }
1588
Sunny Goyal228153d2018-01-04 15:35:22 -08001589 public int getPageNearestToCenterOfScreen() {
Vinit Nayaka406f722019-12-19 11:50:55 -08001590 return getPageNearestToCenterOfScreen(mOrientationHandler.getPrimaryScroll(this));
Tony Wickham8f7ead32016-04-07 18:46:44 -07001591 }
1592
Alex Chaudedbc8a2021-03-17 16:53:26 +00001593 private int getPageNearestToCenterOfScreen(int primaryScroll) {
1594 int screenCenter = getScreenCenter(primaryScroll);
Adam Cohen22f823d2011-09-01 17:22:18 -07001595 int minDistanceFromScreenCenter = Integer.MAX_VALUE;
Winson Chung321e9ee2010-08-09 13:37:56 -07001596 int minDistanceFromScreenCenterIndex = -1;
Winson Chung321e9ee2010-08-09 13:37:56 -07001597 final int childCount = getChildCount();
1598 for (int i = 0; i < childCount; ++i) {
Tony Wickham7383d4e2020-07-07 19:25:25 -07001599 int distanceFromScreenCenter = Math.abs(
1600 getDisplacementFromScreenCenter(i, screenCenter));
Winson Chung321e9ee2010-08-09 13:37:56 -07001601 if (distanceFromScreenCenter < minDistanceFromScreenCenter) {
1602 minDistanceFromScreenCenter = distanceFromScreenCenter;
1603 minDistanceFromScreenCenterIndex = i;
1604 }
1605 }
Adam Cohend19d3ca2010-09-15 14:43:42 -07001606 return minDistanceFromScreenCenterIndex;
1607 }
1608
Tony Wickham7383d4e2020-07-07 19:25:25 -07001609 private int getDisplacementFromScreenCenter(int childIndex, int screenCenter) {
Alex Chaudedbc8a2021-03-17 16:53:26 +00001610 int childSize = Math.round(getChildVisibleSize(childIndex));
Tony Wickham7383d4e2020-07-07 19:25:25 -07001611 int halfChildSize = (childSize / 2);
1612 int childCenter = getChildOffset(childIndex) + halfChildSize;
1613 return childCenter - screenCenter;
1614 }
1615
1616 protected int getDisplacementFromScreenCenter(int childIndex) {
Alex Chaudedbc8a2021-03-17 16:53:26 +00001617 int primaryScroll = mOrientationHandler.getPrimaryScroll(this);
1618 int screenCenter = getScreenCenter(primaryScroll);
Tony Wickham7383d4e2020-07-07 19:25:25 -07001619 return getDisplacementFromScreenCenter(childIndex, screenCenter);
1620 }
1621
Andras Kloczl9732df12021-09-09 19:40:42 +01001622 protected int getScreenCenter(int primaryScroll) {
Alex Chaudedbc8a2021-03-17 16:53:26 +00001623 float primaryScale = mOrientationHandler.getPrimaryScale(this);
1624 float primaryPivot = mOrientationHandler.getPrimaryValue(getPivotX(), getPivotY());
1625 int pageOrientationSize = mOrientationHandler.getMeasuredSize(this);
1626 return Math.round(primaryScroll + (pageOrientationSize / 2f - primaryPivot) / primaryScale
1627 + primaryPivot);
1628 }
1629
Adam Cohend19d3ca2010-09-15 14:43:42 -07001630 protected void snapToDestination() {
Andras Kloczlc2bd15f2022-03-30 18:06:13 +01001631 snapToPage(getDestinationPage(), mPageSnapAnimationDuration);
Winson Chung321e9ee2010-08-09 13:37:56 -07001632 }
1633
Adam Cohene0f66b52010-11-23 15:06:07 -08001634 // We want the duration of the page snap animation to be influenced by the distance that
1635 // the screen has to travel, however, we don't want this duration to be effected in a
1636 // purely linear fashion. Instead, we use this method to moderate the effect that the distance
1637 // of travel has on the overall snap duration.
Sunny Goyal4d113a52015-05-27 10:05:28 -07001638 private float distanceInfluenceForSnapDuration(float f) {
Adam Cohene0f66b52010-11-23 15:06:07 -08001639 f -= 0.5f; // center the values about 0.
1640 f *= 0.3f * Math.PI / 2.0f;
1641 return (float) Math.sin(f);
1642 }
1643
Winson Chung05a31ed2018-02-08 17:08:43 -08001644 protected boolean snapToPageWithVelocity(int whichPage, int velocity) {
Adam Cohen6f127a62014-06-12 14:54:41 -07001645 whichPage = validateNewPage(whichPage);
Vinit Nayaka406f722019-12-19 11:50:55 -08001646 int halfScreenSize = mOrientationHandler.getMeasuredSize(this) / 2;
Adam Cohene0f66b52010-11-23 15:06:07 -08001647
Vinit Nayaka406f722019-12-19 11:50:55 -08001648 final int newLoc = getScrollForPage(whichPage);
Sunny Goyalc39db732021-04-03 01:20:21 -07001649 int delta = newLoc - mOrientationHandler.getPrimaryScroll(this);
Adam Cohene0f66b52010-11-23 15:06:07 -08001650 int duration = 0;
1651
Sunny Goyal4d113a52015-05-27 10:05:28 -07001652 if (Math.abs(velocity) < mMinFlingVelocity) {
Adam Cohene0f66b52010-11-23 15:06:07 -08001653 // If the velocity is low enough, then treat this more as an automatic page advance
1654 // as opposed to an apparent physical response to flinging
Andras Kloczlc2bd15f2022-03-30 18:06:13 +01001655 return snapToPage(whichPage, mPageSnapAnimationDuration);
Adam Cohene0f66b52010-11-23 15:06:07 -08001656 }
1657
1658 // Here we compute a "distance" that will be used in the computation of the overall
1659 // snap duration. This is a function of the actual distance that needs to be traveled;
1660 // we keep this value close to half screen size in order to reduce the variance in snap
1661 // duration as a function of the distance the page needs to travel.
Michael Jurka20b7ca92011-06-07 20:09:16 -07001662 float distanceRatio = Math.min(1f, 1.0f * Math.abs(delta) / (2 * halfScreenSize));
Adam Cohene0f66b52010-11-23 15:06:07 -08001663 float distance = halfScreenSize + halfScreenSize *
1664 distanceInfluenceForSnapDuration(distanceRatio);
1665
1666 velocity = Math.abs(velocity);
Adam Cohen265b9a62011-12-07 14:37:18 -08001667 velocity = Math.max(mMinSnapVelocity, velocity);
Adam Cohene0f66b52010-11-23 15:06:07 -08001668
1669 // we want the page's snap velocity to approximately match the velocity at which the
1670 // user flings, so we scale the duration by a value near to the derivative of the scroll
Michael Jurka20b7ca92011-06-07 20:09:16 -07001671 // interpolator at zero, ie. 5. We use 4 to make it a little slower.
1672 duration = 4 * Math.round(1000 * Math.abs(distance / velocity));
Adam Cohene0f66b52010-11-23 15:06:07 -08001673
Sunny Goyalc39db732021-04-03 01:20:21 -07001674 return snapToPage(whichPage, delta, duration);
Michael Jurka0142d492010-08-25 17:46:15 -07001675 }
1676
Winson Chung05a31ed2018-02-08 17:08:43 -08001677 public boolean snapToPage(int whichPage) {
Andras Kloczlc2bd15f2022-03-30 18:06:13 +01001678 return snapToPage(whichPage, mPageSnapAnimationDuration);
Winson Chung321e9ee2010-08-09 13:37:56 -07001679 }
1680
Winson Chung05a31ed2018-02-08 17:08:43 -08001681 public boolean snapToPageImmediately(int whichPage) {
Andras Kloczlc2bd15f2022-03-30 18:06:13 +01001682 return snapToPage(whichPage, mPageSnapAnimationDuration, true);
Adam Cohen7d30a372013-07-01 17:03:59 -07001683 }
1684
Winson Chung05a31ed2018-02-08 17:08:43 -08001685 public boolean snapToPage(int whichPage, int duration) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001686 return snapToPage(whichPage, duration, false);
Adam Cohen7d30a372013-07-01 17:03:59 -07001687 }
1688
Sunny Goyalc39db732021-04-03 01:20:21 -07001689 protected boolean snapToPage(int whichPage, int duration, boolean immediate) {
Adam Cohen6f127a62014-06-12 14:54:41 -07001690 whichPage = validateNewPage(whichPage);
Winson Chung321e9ee2010-08-09 13:37:56 -07001691
Vinit Nayaka406f722019-12-19 11:50:55 -08001692 int newLoc = getScrollForPage(whichPage);
Sunny Goyalc39db732021-04-03 01:20:21 -07001693 final int delta = newLoc - mOrientationHandler.getPrimaryScroll(this);
1694 return snapToPage(whichPage, delta, duration, immediate);
Michael Jurka0142d492010-08-25 17:46:15 -07001695 }
1696
Winson Chung05a31ed2018-02-08 17:08:43 -08001697 protected boolean snapToPage(int whichPage, int delta, int duration) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001698 return snapToPage(whichPage, delta, duration, false);
Adam Cohen7d30a372013-07-01 17:03:59 -07001699 }
Michael Jurka0142d492010-08-25 17:46:15 -07001700
Sunny Goyalc39db732021-04-03 01:20:21 -07001701 protected boolean snapToPage(int whichPage, int delta, int duration, boolean immediate) {
Sunny Goyal9bb8ffb2018-05-24 17:11:16 -07001702 if (mFirstLayout) {
1703 setCurrentPage(whichPage);
1704 return false;
1705 }
Tony Wickhamd58c2d52018-05-04 12:10:55 -07001706
Andy Wickhamda5a89b2021-07-23 12:38:14 -10001707 if (FeatureFlags.IS_STUDIO_BUILD && !Utilities.IS_RUNNING_IN_TEST_HARNESS) {
Tony Wickhamcb3f8702018-08-27 17:36:03 -07001708 duration *= Settings.Global.getFloat(getContext().getContentResolver(),
1709 Settings.Global.WINDOW_ANIMATION_SCALE, 1);
Tony Wickhamd58c2d52018-05-04 12:10:55 -07001710 }
1711
Adam Cohen6f127a62014-06-12 14:54:41 -07001712 whichPage = validateNewPage(whichPage);
1713
Adam Cohen7d30a372013-07-01 17:03:59 -07001714 mNextPage = whichPage;
Michael Jurka0142d492010-08-25 17:46:15 -07001715
Winson Chung321e9ee2010-08-09 13:37:56 -07001716 awakenScrollBars(duration);
Adam Cohen7d30a372013-07-01 17:03:59 -07001717 if (immediate) {
1718 duration = 0;
1719 } else if (duration == 0) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001720 duration = Math.abs(delta);
1721 }
1722
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001723 if (duration != 0) {
1724 pageBeginTransition();
1725 }
1726
Adam Cohenf358a4b2013-07-23 16:47:31 -07001727 if (!mScroller.isFinished()) {
Adam Cohenf9618852013-11-08 06:45:03 -08001728 abortScrollerAnimation(false);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001729 }
Adam Cohenf9618852013-11-08 06:45:03 -08001730
Sunny Goyalc39db732021-04-03 01:20:21 -07001731 mScroller.startScroll(mOrientationHandler.getPrimaryScroll(this), 0, delta, 0, duration);
Adam Cohen674531f2013-12-13 15:07:14 -08001732 updatePageIndicator();
Adam Cohen7d30a372013-07-01 17:03:59 -07001733
1734 // Trigger a compute() to finish switching pages if necessary
1735 if (immediate) {
1736 computeScroll();
Sunny Goyal76dbf6f2017-01-03 14:55:47 -08001737 pageEndTransition();
Adam Cohen7d30a372013-07-01 17:03:59 -07001738 }
1739
Winson Chung321e9ee2010-08-09 13:37:56 -07001740 invalidate();
Winson Chung05a31ed2018-02-08 17:08:43 -08001741 return Math.abs(delta) > 0;
Winson Chung321e9ee2010-08-09 13:37:56 -07001742 }
1743
Vadim Tryshev98913d02018-05-18 18:41:34 -07001744 public boolean scrollLeft() {
1745 if (getNextPage() > 0) {
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001746 snapToPage(getNextPage() - getPanelCount());
Vadim Tryshev98913d02018-05-18 18:41:34 -07001747 return true;
1748 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001749 return mAllowOverScroll;
Winson Chung321e9ee2010-08-09 13:37:56 -07001750 }
1751
Vadim Tryshev98913d02018-05-18 18:41:34 -07001752 public boolean scrollRight() {
1753 if (getNextPage() < getChildCount() - 1) {
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001754 snapToPage(getNextPage() + getPanelCount());
Vadim Tryshev98913d02018-05-18 18:41:34 -07001755 return true;
1756 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001757 return mAllowOverScroll;
Winson Chung321e9ee2010-08-09 13:37:56 -07001758 }
1759
Vadim Trysheve6bbefb2018-04-03 13:38:06 -07001760 @Override
Lais Andradecc5c8842021-06-04 18:20:30 +01001761 protected void onScrollChanged(int l, int t, int oldl, int oldt) {
Lais Andradef6e31b12021-10-27 12:04:28 +01001762 if (mScroller.isFinished()) {
1763 // This was not caused by the scroller, skip it.
1764 return;
1765 }
Lais Andradecc5c8842021-06-04 18:20:30 +01001766 int newDestinationPage = getDestinationPage();
1767 if (newDestinationPage >= 0 && newDestinationPage != mCurrentScrollOverPage) {
1768 mCurrentScrollOverPage = newDestinationPage;
1769 onScrollOverPageChanged();
1770 }
1771 }
1772
1773 @Override
Vadim Trysheve6bbefb2018-04-03 13:38:06 -07001774 public CharSequence getAccessibilityClassName() {
1775 // Some accessibility services have special logic for ScrollView. Since we provide same
1776 // accessibility info as ScrollView, inform the service to handle use the same way.
1777 return ScrollView.class.getName();
1778 }
1779
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001780 protected boolean isPageOrderFlipped() {
1781 return false;
1782 }
1783
Winson Chung6a0f57d2011-06-29 20:10:49 -07001784 /* Accessibility */
Sunny Goyalcf25b522015-07-09 00:01:18 -07001785 @SuppressWarnings("deprecation")
Winson Chung6a0f57d2011-06-29 20:10:49 -07001786 @Override
1787 public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) {
1788 super.onInitializeAccessibilityNodeInfo(info);
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001789 final boolean pagesFlipped = isPageOrderFlipped();
Alex Chau9ead9ca2021-11-26 16:22:49 +00001790 info.setScrollable(getPageCount() > 0);
1791 int primaryScroll = mOrientationHandler.getPrimaryScroll(this);
1792 if (getCurrentPage() < getPageCount() - getPanelCount()
1793 || (getCurrentPage() == getPageCount() - getPanelCount()
1794 && primaryScroll != getScrollForPage(getPageCount() - getPanelCount()))) {
yingleiw02cc8482019-08-02 16:14:27 -07001795 info.addAction(pagesFlipped ?
Alex Chau9ead9ca2021-11-26 16:22:49 +00001796 AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_BACKWARD
1797 : AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_FORWARD);
yingleiw02cc8482019-08-02 16:14:27 -07001798 info.addAction(mIsRtl ?
1799 AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_LEFT
1800 : AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_RIGHT);
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001801 }
Alex Chau9ead9ca2021-11-26 16:22:49 +00001802 if (getCurrentPage() > 0
1803 || (getCurrentPage() == 0 && primaryScroll != getScrollForPage(0))) {
yingleiw02cc8482019-08-02 16:14:27 -07001804 info.addAction(pagesFlipped ?
Alex Chau9ead9ca2021-11-26 16:22:49 +00001805 AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_FORWARD
1806 : AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_BACKWARD);
yingleiw02cc8482019-08-02 16:14:27 -07001807 info.addAction(mIsRtl ?
1808 AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_RIGHT
1809 : AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_LEFT);
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001810 }
Vadim Tryshev7af0d442015-05-15 08:48:11 -07001811 // Accessibility-wise, PagedView doesn't support long click, so disabling it.
1812 // Besides disabling the accessibility long-click, this also prevents this view from getting
1813 // accessibility focus.
1814 info.setLongClickable(false);
Sunny Goyala52ecb02016-12-16 15:04:51 -08001815 info.removeAction(AccessibilityNodeInfo.AccessibilityAction.ACTION_LONG_CLICK);
Winson Chung6a0f57d2011-06-29 20:10:49 -07001816 }
1817
1818 @Override
Alan Viverette254139a2013-10-08 13:13:46 -07001819 public void sendAccessibilityEvent(int eventType) {
1820 // Don't let the view send real scroll events.
1821 if (eventType != AccessibilityEvent.TYPE_VIEW_SCROLLED) {
1822 super.sendAccessibilityEvent(eventType);
1823 }
1824 }
1825
1826 @Override
Winson Chung6a0f57d2011-06-29 20:10:49 -07001827 public void onInitializeAccessibilityEvent(AccessibilityEvent event) {
1828 super.onInitializeAccessibilityEvent(event);
Pinyao Tingaf6daa22019-09-18 22:18:03 +00001829 event.setScrollable(mAllowOverScroll || getPageCount() > 1);
Winson Chung6a0f57d2011-06-29 20:10:49 -07001830 }
1831
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001832 @Override
1833 public boolean performAccessibilityAction(int action, Bundle arguments) {
1834 if (super.performAccessibilityAction(action, arguments)) {
1835 return true;
1836 }
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001837 final boolean pagesFlipped = isPageOrderFlipped();
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001838 switch (action) {
1839 case AccessibilityNodeInfo.ACTION_SCROLL_FORWARD: {
Vadim Tryshev98913d02018-05-18 18:41:34 -07001840 if (pagesFlipped ? scrollLeft() : scrollRight()) {
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001841 return true;
1842 }
1843 } break;
1844 case AccessibilityNodeInfo.ACTION_SCROLL_BACKWARD: {
Vadim Tryshev98913d02018-05-18 18:41:34 -07001845 if (pagesFlipped ? scrollRight() : scrollLeft()) {
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001846 return true;
1847 }
yingleiw02cc8482019-08-02 16:14:27 -07001848 } break;
1849 case android.R.id.accessibilityActionPageRight: {
1850 if (!mIsRtl) {
Alex Chau9ead9ca2021-11-26 16:22:49 +00001851 return scrollRight();
yingleiw02cc8482019-08-02 16:14:27 -07001852 } else {
Alex Chau9ead9ca2021-11-26 16:22:49 +00001853 return scrollLeft();
yingleiw02cc8482019-08-02 16:14:27 -07001854 }
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001855 }
yingleiw02cc8482019-08-02 16:14:27 -07001856 case android.R.id.accessibilityActionPageLeft: {
1857 if (!mIsRtl) {
Alex Chau9ead9ca2021-11-26 16:22:49 +00001858 return scrollLeft();
yingleiw02cc8482019-08-02 16:14:27 -07001859 } else {
Alex Chau9ead9ca2021-11-26 16:22:49 +00001860 return scrollRight();
yingleiw02cc8482019-08-02 16:14:27 -07001861 }
1862 }
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001863 }
1864 return false;
1865 }
1866
Vadim Tryshev2c430b32018-04-04 14:45:21 -07001867 protected boolean canAnnouncePageDescription() {
1868 return true;
1869 }
1870
Adam Cohen0ffac432013-07-10 11:19:26 -07001871 protected String getCurrentPageDescription() {
Sunny Goyalf4f89ef2015-09-02 15:06:12 -07001872 return getContext().getString(R.string.default_scroll_format,
Adam Cohen0ffac432013-07-10 11:19:26 -07001873 getNextPage() + 1, getChildCount());
1874 }
1875
Tony Mak2e564402018-02-27 17:19:34 +00001876 protected float getDownMotionX() {
1877 return mDownMotionX;
1878 }
1879
1880 protected float getDownMotionY() {
1881 return mDownMotionY;
1882 }
1883
Sunny Goyal20a13ff2018-03-13 16:44:00 -07001884 protected interface ComputePageScrollsLogic {
1885
1886 boolean shouldIncludeView(View view);
1887 }
Vadim Tryshev528b9e02018-05-24 18:22:03 -07001888
1889 public int[] getVisibleChildrenRange() {
1890 float visibleLeft = 0;
1891 float visibleRight = visibleLeft + getMeasuredWidth();
1892 float scaleX = getScaleX();
1893 if (scaleX < 1 && scaleX > 0) {
1894 float mid = getMeasuredWidth() / 2;
1895 visibleLeft = mid - ((mid - visibleLeft) / scaleX);
1896 visibleRight = mid + ((visibleRight - mid) / scaleX);
1897 }
1898
1899 int leftChild = -1;
1900 int rightChild = -1;
1901 final int childCount = getChildCount();
1902 for (int i = 0; i < childCount; i++) {
1903 final View child = getPageAt(i);
1904
1905 float left = child.getLeft() + child.getTranslationX() - getScrollX();
1906 if (left <= visibleRight && (left + child.getMeasuredWidth()) >= visibleLeft) {
1907 if (leftChild == -1) {
1908 leftChild = i;
1909 }
1910 rightChild = i;
1911 }
1912 }
1913 mTmpIntPair[0] = leftChild;
1914 mTmpIntPair[1] = rightChild;
1915 return mTmpIntPair;
1916 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001917
1918 @Override
1919 public void draw(Canvas canvas) {
1920 super.draw(canvas);
1921 drawEdgeEffect(canvas);
Sunny Goyal05b59c02021-04-29 13:55:40 -07001922 pageEndTransition();
Sunny Goyalc39db732021-04-03 01:20:21 -07001923 }
1924
1925 protected void drawEdgeEffect(Canvas canvas) {
1926 if (mAllowOverScroll && (!mEdgeGlowRight.isFinished() || !mEdgeGlowLeft.isFinished())) {
1927 final int width = getWidth();
1928 final int height = getHeight();
1929 if (!mEdgeGlowLeft.isFinished()) {
1930 final int restoreCount = canvas.save();
1931 canvas.rotate(-90);
1932 canvas.translate(-height, Math.min(mMinScroll, getScrollX()));
1933 mEdgeGlowLeft.setSize(height, width);
1934 if (mEdgeGlowLeft.draw(canvas)) {
1935 postInvalidateOnAnimation();
1936 }
1937 canvas.restoreToCount(restoreCount);
1938 }
1939 if (!mEdgeGlowRight.isFinished()) {
1940 final int restoreCount = canvas.save();
1941 canvas.rotate(90, width, 0);
1942 canvas.translate(width, -(Math.max(mMaxScroll, getScrollX())));
1943
1944 mEdgeGlowRight.setSize(height, width);
1945 if (mEdgeGlowRight.draw(canvas)) {
1946 postInvalidateOnAnimation();
1947 }
1948 canvas.restoreToCount(restoreCount);
1949 }
1950 }
1951 }
Adam Cohen5084cba2013-09-03 12:01:16 -07001952}