blob: 8cedbc33de2e585f04abbec91794b45a3b2647db [file] [log] [blame]
Winson Chung321e9ee2010-08-09 13:37:56 -07001/*
Adam Cohen7d30a372013-07-01 17:03:59 -07002 * Copyright (C) 2012 The Android Open Source Project
Winson Chung321e9ee2010-08-09 13:37:56 -07003 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Daniel Sandler325dc232013-06-05 22:57:57 -040017package com.android.launcher3;
Winson Chung321e9ee2010-08-09 13:37:56 -070018
Andras Kloczl55edfe52021-05-14 12:21:30 +020019import static androidx.annotation.VisibleForTesting.PACKAGE_PRIVATE;
Andras Kloczldbf577a2021-05-26 15:02:52 +020020
Sunny Goyalc39db732021-04-03 01:20:21 -070021import static com.android.launcher3.anim.Interpolators.SCROLL;
Sunny Goyal8b37c572020-03-31 12:12:14 -070022import static com.android.launcher3.compat.AccessibilityManagerCompat.isAccessibilityEnabled;
23import static com.android.launcher3.compat.AccessibilityManagerCompat.isObservedEventType;
Sunny Goyal8b37c572020-03-31 12:12:14 -070024import static com.android.launcher3.touch.OverScroll.OVERSCROLL_DAMP_FACTOR;
Sunny Goyal8b37c572020-03-31 12:12:14 -070025import static com.android.launcher3.touch.PagedOrientationHandler.VIEW_SCROLL_BY;
26import static com.android.launcher3.touch.PagedOrientationHandler.VIEW_SCROLL_TO;
27
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -070028import android.animation.LayoutTransition;
Sunny Goyalcf25b522015-07-09 00:01:18 -070029import android.annotation.SuppressLint;
Winson Chung321e9ee2010-08-09 13:37:56 -070030import android.content.Context;
Adam Cohen9c4949e2010-10-05 12:27:22 -070031import android.content.res.TypedArray;
Jon Miranda71cb80c2019-01-24 21:25:13 -080032import android.graphics.Canvas;
Winson Chung321e9ee2010-08-09 13:37:56 -070033import android.graphics.Rect;
Svetoslav Ganov08055f62012-05-15 11:06:36 -070034import android.os.Bundle;
Tony Wickhamd58c2d52018-05-04 12:10:55 -070035import android.provider.Settings;
Winson Chung321e9ee2010-08-09 13:37:56 -070036import android.util.AttributeSet;
Winson Chung785d2eb2011-04-14 16:08:02 -070037import android.util.Log;
Winson Chung185d7162011-02-28 13:47:29 -080038import android.view.InputDevice;
39import android.view.KeyEvent;
Winson Chung321e9ee2010-08-09 13:37:56 -070040import android.view.MotionEvent;
41import android.view.VelocityTracker;
42import android.view.View;
43import android.view.ViewConfiguration;
Sunny Goyal4ffec482016-02-09 11:28:52 -080044import android.view.ViewDebug;
Winson Chung321e9ee2010-08-09 13:37:56 -070045import android.view.ViewGroup;
46import android.view.ViewParent;
Winson Chung6a0f57d2011-06-29 20:10:49 -070047import android.view.accessibility.AccessibilityEvent;
48import android.view.accessibility.AccessibilityNodeInfo;
Sunny Goyalc39db732021-04-03 01:20:21 -070049import android.widget.OverScroller;
Vadim Trysheve6bbefb2018-04-03 13:38:06 -070050import android.widget.ScrollView;
Tony Wickhamf549dab2016-05-16 09:54:06 -070051
Tony Wickham62117d72020-03-26 16:56:26 -070052import androidx.annotation.Nullable;
Andras Kloczl55edfe52021-05-14 12:21:30 +020053import androidx.annotation.VisibleForTesting;
Tony Wickham62117d72020-03-26 16:56:26 -070054
Jon Miranda9e198662020-03-11 14:42:02 -070055import com.android.launcher3.compat.AccessibilityManagerCompat;
56import com.android.launcher3.config.FeatureFlags;
Jon Miranda9e198662020-03-11 14:42:02 -070057import com.android.launcher3.pageindicators.PageIndicator;
Jon Miranda9e198662020-03-11 14:42:02 -070058import com.android.launcher3.touch.PagedOrientationHandler;
59import com.android.launcher3.touch.PagedOrientationHandler.ChildBounds;
Sunny Goyalc39db732021-04-03 01:20:21 -070060import com.android.launcher3.util.EdgeEffectCompat;
Andras Kloczl55edfe52021-05-14 12:21:30 +020061import com.android.launcher3.util.IntSet;
Jon Miranda9e198662020-03-11 14:42:02 -070062import com.android.launcher3.util.Thunk;
Sunny Goyal8b37c572020-03-31 12:12:14 -070063import com.android.launcher3.views.ActivityContext;
Jon Miranda9e198662020-03-11 14:42:02 -070064
65import java.util.ArrayList;
Sunny Goyal59969372021-05-06 12:11:44 -070066import java.util.function.Consumer;
Jon Miranda9e198662020-03-11 14:42:02 -070067
Winson Chung321e9ee2010-08-09 13:37:56 -070068/**
69 * An abstraction of the original Workspace which supports browsing through a
Michael Jurka0142d492010-08-25 17:46:15 -070070 * sequential list of "pages"
Winson Chung321e9ee2010-08-09 13:37:56 -070071 */
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -080072public abstract class PagedView<T extends View & PageIndicator> extends ViewGroup {
Winson Chung321e9ee2010-08-09 13:37:56 -070073 private static final String TAG = "PagedView";
Winson Chung785d2eb2011-04-14 16:08:02 -070074 private static final boolean DEBUG = false;
Winson Chung4941f652020-06-18 15:11:53 -070075 public static final boolean DEBUG_FAILED_QUICKSWITCH = false;
Sunny Goyal20a13ff2018-03-13 16:44:00 -070076
Winson Chung4941f652020-06-18 15:11:53 -070077 public static final int ACTION_MOVE_ALLOW_EASY_FLING = MotionEvent.ACTION_MASK - 1;
Sunny Goyala7a5bf32020-01-05 15:35:29 +053078 public static final int INVALID_PAGE = -1;
Sunny Goyal20a13ff2018-03-13 16:44:00 -070079 protected static final ComputePageScrollsLogic SIMPLE_SCROLL_LOGIC = (v) -> v.getVisibility() != GONE;
Winson Chung321e9ee2010-08-09 13:37:56 -070080
Vadim Tryshevfedca432015-08-19 17:55:02 -070081 public static final int PAGE_SNAP_ANIMATION_DURATION = 750;
Winson Chung321e9ee2010-08-09 13:37:56 -070082
Adam Cohenb64cb5a2011-02-15 13:53:42 -080083 private static final float RETURN_TO_ORIGINAL_PAGE_THRESHOLD = 0.33f;
Adam Cohen00481b32011-11-18 12:03:48 -080084 // The page is moved more than halfway, automatically move to the next page on touch up.
85 private static final float SIGNIFICANT_MOVE_THRESHOLD = 0.4f;
Adam Cohen68d73932010-11-15 10:50:58 -080086
Sunny Goyal8e2133b2015-05-06 13:39:07 -070087 private static final float MAX_SCROLL_PROGRESS = 1.0f;
88
Adam Cohen265b9a62011-12-07 14:37:18 -080089 // The following constants need to be scaled based on density. The scaled versions will be
90 // assigned to the corresponding member variables below.
91 private static final int FLING_THRESHOLD_VELOCITY = 500;
Winson Chung4941f652020-06-18 15:11:53 -070092 private static final int EASY_FLING_THRESHOLD_VELOCITY = 400;
Adam Cohen265b9a62011-12-07 14:37:18 -080093 private static final int MIN_SNAP_VELOCITY = 1500;
94 private static final int MIN_FLING_VELOCITY = 250;
95
Adam Cohenf358a4b2013-07-23 16:47:31 -070096 private boolean mFreeScroll = false;
Adam Cohenf358a4b2013-07-23 16:47:31 -070097
Winson Chung4941f652020-06-18 15:11:53 -070098 protected final int mFlingThresholdVelocity;
99 protected final int mEasyFlingThresholdVelocity;
100 protected final int mMinFlingVelocity;
101 protected final int mMinSnapVelocity;
Michael Jurka0142d492010-08-25 17:46:15 -0700102
Michael Jurka0142d492010-08-25 17:46:15 -0700103 protected boolean mFirstLayout = true;
104
Sunny Goyal4ffec482016-02-09 11:28:52 -0800105 @ViewDebug.ExportedProperty(category = "launcher")
Michael Jurka0142d492010-08-25 17:46:15 -0700106 protected int mCurrentPage;
Alex Chauba61b982021-06-15 16:29:19 +0100107 // Difference between current scroll position and mCurrentPage's page scroll. Used to maintain
108 // relative scroll position unchanged in updateCurrentPageScroll. Cleared when snapping to a
109 // page.
110 protected int mCurrentPageScrollDiff;
Adam Cohene61a9a22013-06-11 15:45:31 -0700111
Sunny Goyal4ffec482016-02-09 11:28:52 -0800112 @ViewDebug.ExportedProperty(category = "launcher")
Michael Jurka0142d492010-08-25 17:46:15 -0700113 protected int mNextPage = INVALID_PAGE;
Vinit Nayaka406f722019-12-19 11:50:55 -0800114 protected int mMaxScroll;
115 protected int mMinScroll;
Sunny Goyalb7b01352018-08-09 12:31:20 -0700116 protected OverScroller mScroller;
Winson Chung321e9ee2010-08-09 13:37:56 -0700117 private VelocityTracker mVelocityTracker;
Sunny Goyale15e2a82017-12-15 13:05:42 -0800118 protected int mPageSpacing = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -0700119
120 private float mDownMotionX;
Adam Cohen7d30a372013-07-01 17:03:59 -0700121 private float mDownMotionY;
Vinit Nayaka406f722019-12-19 11:50:55 -0800122 private float mDownMotionPrimary;
123 private float mLastMotion;
124 private float mLastMotionRemainder;
125 private float mTotalMotion;
Winson Chung4941f652020-06-18 15:11:53 -0700126 // Used in special cases where the fling checks can be relaxed for an intentional gesture
127 private boolean mAllowEasyFling;
Sunny Goyalacd17df2020-04-03 15:58:45 -0700128 protected PagedOrientationHandler mOrientationHandler = PagedOrientationHandler.PORTRAIT;
Adam Cohenedb40762013-07-18 16:45:45 -0700129
Vadim Trysheve628c472018-05-16 14:28:18 -0700130 protected int[] mPageScrolls;
Sunny Goyalaad33592018-08-07 17:20:35 -0700131 private boolean mIsBeingDragged;
Adam Cohencae7f572013-11-04 14:42:52 -0800132
Winson Chung4941f652020-06-18 15:11:53 -0700133 // The amount of movement to begin scrolling
Michael Jurka7426c422010-11-11 15:23:47 -0800134 protected int mTouchSlop;
Winson Chung4941f652020-06-18 15:11:53 -0700135 // The amount of movement to begin paging
136 protected int mPageSlop;
Winson Chung321e9ee2010-08-09 13:37:56 -0700137 private int mMaximumVelocity;
Adam Cohen68d73932010-11-15 10:50:58 -0800138 protected boolean mAllowOverScroll = true;
Winson Chung321e9ee2010-08-09 13:37:56 -0700139
Michael Jurka5f1c5092010-09-03 14:15:02 -0700140 protected static final int INVALID_POINTER = -1;
Winson Chung321e9ee2010-08-09 13:37:56 -0700141
Michael Jurka5f1c5092010-09-03 14:15:02 -0700142 protected int mActivePointerId = INVALID_POINTER;
Winson Chung321e9ee2010-08-09 13:37:56 -0700143
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700144 protected boolean mIsPageInTransition = false;
Tony Wickham62117d72020-03-26 16:56:26 -0700145 private Runnable mOnPageTransitionEndCallback;
Patrick Dubroy1262e362010-10-06 15:49:50 -0700146
Winson Chungd2be3812013-07-16 11:11:32 -0700147 // Page Indicator
Adam Cohen091440a2015-03-18 14:16:05 -0700148 @Thunk int mPageIndicatorViewId;
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800149 protected T mPageIndicator;
Adam Cohen7d30a372013-07-01 17:03:59 -0700150
John Spurlock77e1f472013-09-11 10:09:51 -0400151 protected final Rect mInsets = new Rect();
Tony Wickhamdfb5cc92018-02-26 16:41:57 -0800152 protected boolean mIsRtl;
John Spurlock77e1f472013-09-11 10:09:51 -0400153
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800154 // Similar to the platform implementation of isLayoutValid();
155 protected boolean mIsLayoutValid;
156
Vadim Tryshev528b9e02018-05-24 18:22:03 -0700157 private int[] mTmpIntPair = new int[2];
158
Sunny Goyalc39db732021-04-03 01:20:21 -0700159 protected EdgeEffectCompat mEdgeGlowLeft;
160 protected EdgeEffectCompat mEdgeGlowRight;
161
Winson Chung321e9ee2010-08-09 13:37:56 -0700162 public PagedView(Context context) {
163 this(context, null);
164 }
165
166 public PagedView(Context context, AttributeSet attrs) {
167 this(context, attrs, 0);
168 }
169
170 public PagedView(Context context, AttributeSet attrs, int defStyle) {
171 super(context, attrs, defStyle);
Winson Chungc9ca2982013-07-19 12:07:38 -0700172
Adam Cohen9c4949e2010-10-05 12:27:22 -0700173 TypedArray a = context.obtainStyledAttributes(attrs,
174 R.styleable.PagedView, defStyle, 0);
Winson Chungd2be3812013-07-16 11:11:32 -0700175 mPageIndicatorViewId = a.getResourceId(R.styleable.PagedView_pageIndicator, -1);
Adam Cohen9c4949e2010-10-05 12:27:22 -0700176 a.recycle();
177
Winson Chung321e9ee2010-08-09 13:37:56 -0700178 setHapticFeedbackEnabled(false);
Sunny Goyal70660032015-05-14 00:07:08 -0700179 mIsRtl = Utilities.isRtl(getResources());
Winson Chung321e9ee2010-08-09 13:37:56 -0700180
Sunny Goyalc39db732021-04-03 01:20:21 -0700181 mScroller = new OverScroller(context, SCROLL);
Winson Chung86f77532010-08-24 11:08:22 -0700182 mCurrentPage = 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
Sunny Goyalcf25b522015-07-09 00:01:18 -0700189 float density = getResources().getDisplayMetrics().density;
190 mFlingThresholdVelocity = (int) (FLING_THRESHOLD_VELOCITY * density);
Winson Chung4941f652020-06-18 15:11:53 -0700191 mEasyFlingThresholdVelocity = (int) (EASY_FLING_THRESHOLD_VELOCITY * density);
Sunny Goyalcf25b522015-07-09 00:01:18 -0700192 mMinFlingVelocity = (int) (MIN_FLING_VELOCITY * density);
193 mMinSnapVelocity = (int) (MIN_SNAP_VELOCITY * density);
Sunny Goyala9f55462018-03-25 18:15:15 -0700194
Sunny Goyalc39db732021-04-03 01:20:21 -0700195 initEdgeEffect();
Sunny Goyaleaf7a952020-07-29 16:54:20 -0700196 setDefaultFocusHighlightEnabled(false);
Sunny Goyalc39db732021-04-03 01:20:21 -0700197 setWillNotDraw(false);
Winson Chung321e9ee2010-08-09 13:37:56 -0700198 }
199
Sunny Goyalc39db732021-04-03 01:20:21 -0700200 protected void initEdgeEffect() {
201 mEdgeGlowLeft = new EdgeEffectCompat(getContext());
202 mEdgeGlowRight = new EdgeEffectCompat(getContext());
Adam Cohenf9618852013-11-08 06:45:03 -0800203 }
204
Sunny Goyald0a6ae72016-06-16 12:29:03 -0700205 public void initParentViews(View parent) {
206 if (mPageIndicatorViewId > -1) {
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800207 mPageIndicator = parent.findViewById(mPageIndicatorViewId);
Sunny Goyalc64cfdd2016-05-18 14:12:02 -0700208 mPageIndicator.setMarkersCount(getChildCount());
Winson Chungd2be3812013-07-16 11:11:32 -0700209 }
210 }
211
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800212 public T getPageIndicator() {
Adam Cohenedb40762013-07-18 16:45:45 -0700213 return mPageIndicator;
214 }
215
Adam Cohen674531f2013-12-13 15:07:14 -0800216 /**
Tony Wickham29d853c2015-09-08 10:35:56 -0700217 * Returns the index of the currently displayed page. When in free scroll mode, this is the page
218 * that the user was on before entering free scroll mode (e.g. the home screen page they
Alex Chaub794ea62021-02-03 18:00:30 +0000219 * long-pressed on to enter the overview). Try using {@link #getDestinationPage()}
Tony Wickham29d853c2015-09-08 10:35:56 -0700220 * to get the page the user is currently scrolling over.
Winson Chung321e9ee2010-08-09 13:37:56 -0700221 */
Sunny Goyal83a8f042015-05-19 12:52:12 -0700222 public int getCurrentPage() {
Winson Chung86f77532010-08-24 11:08:22 -0700223 return mCurrentPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700224 }
Adam Cohen7d30a372013-07-01 17:03:59 -0700225
Hyunyoung Songb76cd622015-04-16 14:34:09 -0700226 /**
227 * Returns the index of page to be shown immediately afterwards.
228 */
Vadim Tryshevfedca432015-08-19 17:55:02 -0700229 public int getNextPage() {
Winson Chung360e63f2012-04-27 13:48:05 -0700230 return (mNextPage != INVALID_PAGE) ? mNextPage : mCurrentPage;
231 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700232
Adam Cohenf9c184a2016-01-15 16:47:43 -0800233 public int getPageCount() {
Winson Chung321e9ee2010-08-09 13:37:56 -0700234 return getChildCount();
235 }
236
Sunny Goyal83a8f042015-05-19 12:52:12 -0700237 public View getPageAt(int index) {
Winson Chung321e9ee2010-08-09 13:37:56 -0700238 return getChildAt(index);
239 }
240
Adam Cohenae4f1552011-10-20 00:15:42 -0700241 protected int indexToPage(int index) {
242 return index;
243 }
244
Winson Chung321e9ee2010-08-09 13:37:56 -0700245 /**
Winson Chungbbc60d82010-11-11 16:34:41 -0800246 * Updates the scroll of the current page immediately to its final scroll position. We use this
247 * in CustomizePagedView to allow tabs to share the same PagedView while resetting the scroll of
248 * the previous tab page.
249 */
250 protected void updateCurrentPageScroll() {
Adam Cohen0ffac432013-07-10 11:19:26 -0700251 // If the current page is invalid, just reset the scroll position to zero
Vinit Nayaka406f722019-12-19 11:50:55 -0800252 int newPosition = 0;
Adam Cohen0ffac432013-07-10 11:19:26 -0700253 if (0 <= mCurrentPage && mCurrentPage < getPageCount()) {
Alex Chauba61b982021-06-15 16:29:19 +0100254 newPosition = getScrollForPage(mCurrentPage) + mCurrentPageScrollDiff;
Adam Cohen0ffac432013-07-10 11:19:26 -0700255 }
Vinit Nayaka406f722019-12-19 11:50:55 -0800256 mOrientationHandler.set(this, VIEW_SCROLL_TO, newPosition);
Sunny Goyalc39db732021-04-03 01:20:21 -0700257 mScroller.startScroll(mScroller.getCurrX(), 0, newPosition - mScroller.getCurrX(), 0);
Sunny Goyalc82c6392018-06-06 15:39:13 -0700258 forceFinishScroller(true);
Winson Chungbbc60d82010-11-11 16:34:41 -0800259 }
260
Tony Wickhamf8d731a2021-05-26 14:58:13 -0700261 /**
262 * Immediately finishes any overscroll effect and jumps to the end of the scroller animation.
263 */
264 public void abortScrollerAnimation() {
265 mEdgeGlowLeft.finish();
266 mEdgeGlowRight.finish();
267 abortScrollerAnimation(true);
268 }
269
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700270 private void abortScrollerAnimation(boolean resetNextPage) {
Adam Cohen4fe4c932013-10-28 16:02:34 -0700271 mScroller.abortAnimation();
272 // We need to clean up the next page here to avoid computeScrollHelper from
273 // updating current page on the pass.
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700274 if (resetNextPage) {
275 mNextPage = INVALID_PAGE;
Sunny Goyal857b1b92018-03-05 10:49:05 -0800276 pageEndTransition();
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700277 }
Chet Haasebc2f0822012-10-26 17:59:53 -0700278 }
Adam Cohen4fe4c932013-10-28 16:02:34 -0700279
Tony Wickham8f7ead32016-04-07 18:46:44 -0700280 private void forceFinishScroller(boolean resetNextPage) {
Adam Cohen4fe4c932013-10-28 16:02:34 -0700281 mScroller.forceFinished(true);
282 // We need to clean up the next page here to avoid computeScrollHelper from
283 // updating current page on the pass.
Tony Wickham8f7ead32016-04-07 18:46:44 -0700284 if (resetNextPage) {
285 mNextPage = INVALID_PAGE;
Sunny Goyal857b1b92018-03-05 10:49:05 -0800286 pageEndTransition();
Tony Wickham8f7ead32016-04-07 18:46:44 -0700287 }
Adam Cohen4fe4c932013-10-28 16:02:34 -0700288 }
289
Adam Cohen6f127a62014-06-12 14:54:41 -0700290 private int validateNewPage(int newPage) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700291 newPage = ensureWithinScrollBounds(newPage);
Adam Cohen6f127a62014-06-12 14:54:41 -0700292 // Ensure that it is clamped by the actual set of children in all cases
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100293 newPage = Utilities.boundToRange(newPage, 0, getPageCount() - 1);
294
295 if (getPanelCount() > 1) {
296 // Always return left panel as new page
297 newPage = getLeftmostVisiblePageForIndex(newPage);
298 }
299 return newPage;
300 }
301
Andras Kloczl55edfe52021-05-14 12:21:30 +0200302 /**
303 * In most cases where panelCount is 1, this method will just return the page index that was
304 * passed in.
305 * But for example when two panel home is enabled we might need the leftmost visible page index
306 * because that page is the current page.
307 */
308 public int getLeftmostVisiblePageForIndex(int pageIndex) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100309 int panelCount = getPanelCount();
Andras Kloczl55edfe52021-05-14 12:21:30 +0200310 return pageIndex - pageIndex % panelCount;
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100311 }
312
313 /**
314 * Returns the number of pages that are shown at the same time.
315 */
316 protected int getPanelCount() {
317 return 1;
318 }
319
320 /**
Andras Kloczl55edfe52021-05-14 12:21:30 +0200321 * Returns an IntSet with the indices of the currently visible pages
322 */
323 @VisibleForTesting(otherwise = PACKAGE_PRIVATE)
324 public IntSet getVisiblePageIndices() {
325 IntSet visiblePageIndices = new IntSet();
326 int panelCount = getPanelCount();
327 int pageCount = getPageCount();
328
329 // If a device goes from one panel to two panel (i.e. unfolding a foldable device) while
330 // an odd indexed page is the current page, then the new leftmost visible page will be
331 // different from the old mCurrentPage.
332 int currentPage = getLeftmostVisiblePageForIndex(mCurrentPage);
333 for (int page = currentPage; page < currentPage + panelCount && page < pageCount; page++) {
334 visiblePageIndices.add(page);
335 }
336 return visiblePageIndices;
337 }
338
339 /**
Sunny Goyal59969372021-05-06 12:11:44 -0700340 * Executes the callback against each visible page
Andras Kloczl2bb51342021-03-20 01:13:45 +0100341 */
Sunny Goyal59969372021-05-06 12:11:44 -0700342 public void forEachVisiblePage(Consumer<View> callback) {
Andras Kloczl55edfe52021-05-14 12:21:30 +0200343 getVisiblePageIndices().forEach(pageIndex -> {
344 View page = getPageAt(pageIndex);
Andras Kloczl2bb51342021-03-20 01:13:45 +0100345 if (page != null) {
Sunny Goyal59969372021-05-06 12:11:44 -0700346 callback.accept(page);
Andras Kloczl2bb51342021-03-20 01:13:45 +0100347 }
Andras Kloczl55edfe52021-05-14 12:21:30 +0200348 });
Andras Kloczl2bb51342021-03-20 01:13:45 +0100349 }
350
351 /**
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100352 * Returns true if the view is on one of the current pages, false otherwise.
353 */
354 public boolean isVisible(View child) {
355 return getLeftmostVisiblePageForIndex(indexOfChild(child)) == mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700356 }
357
Chet Haasebc2f0822012-10-26 17:59:53 -0700358 /**
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700359 * @return The closest page to the provided page that is within mMinScrollX and mMaxScrollX.
360 */
361 private int ensureWithinScrollBounds(int page) {
362 int dir = !mIsRtl ? 1 : - 1;
363 int currScroll = getScrollForPage(page);
364 int prevScroll;
Vinit Nayaka406f722019-12-19 11:50:55 -0800365 while (currScroll < mMinScroll) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700366 page += dir;
367 prevScroll = currScroll;
368 currScroll = getScrollForPage(page);
369 if (currScroll <= prevScroll) {
370 Log.e(TAG, "validateNewPage: failed to find a page > mMinScrollX");
371 break;
372 }
373 }
Vinit Nayaka406f722019-12-19 11:50:55 -0800374 while (currScroll > mMaxScroll) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700375 page -= dir;
376 prevScroll = currScroll;
377 currScroll = getScrollForPage(page);
378 if (currScroll >= prevScroll) {
379 Log.e(TAG, "validateNewPage: failed to find a page < mMaxScrollX");
380 break;
381 }
382 }
383 return page;
384 }
385
Tony Wickham03f27012019-04-25 14:22:54 -0700386 public void setCurrentPage(int currentPage) {
387 setCurrentPage(currentPage, INVALID_PAGE);
388 }
389
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700390 /**
Winson Chung86f77532010-08-24 11:08:22 -0700391 * Sets the current page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700392 */
Tony Wickham03f27012019-04-25 14:22:54 -0700393 public void setCurrentPage(int currentPage, int overridePrevPage) {
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800394 if (!mScroller.isFinished()) {
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700395 abortScrollerAnimation(true);
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800396 }
Michael Jurkad3ef3062010-11-23 16:23:58 -0800397 // don't introduce any checks like mCurrentPage == currentPage here-- if we change the
398 // the default
399 if (getChildCount() == 0) {
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800400 return;
401 }
Tony Wickham03f27012019-04-25 14:22:54 -0700402 int prevPage = overridePrevPage != INVALID_PAGE ? overridePrevPage : mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700403 mCurrentPage = validateNewPage(currentPage);
Winson Chung181c3dc2013-07-17 15:36:20 -0700404 updateCurrentPageScroll();
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700405 notifyPageSwitchListener(prevPage);
Winson Chunga12a2502010-12-20 14:41:35 -0800406 invalidate();
Winson Chung321e9ee2010-08-09 13:37:56 -0700407 }
408
Winson Chung8c87cd82013-07-23 16:20:10 -0700409 /**
Adam Cohen674531f2013-12-13 15:07:14 -0800410 * Should be called whenever the page changes. In the case of a scroll, we wait until the page
411 * has settled.
412 */
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700413 protected void notifyPageSwitchListener(int prevPage) {
Adam Cohen674531f2013-12-13 15:07:14 -0800414 updatePageIndicator();
415 }
416
417 private void updatePageIndicator() {
Sunny Goyal4cbf0462014-08-28 16:19:39 -0700418 if (mPageIndicator != null) {
Tony Mak4f521af2018-03-15 16:37:34 +0000419 mPageIndicator.setActiveMarker(getNextPage());
Winson Chungd2be3812013-07-16 11:11:32 -0700420 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700421 }
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700422 protected void pageBeginTransition() {
423 if (!mIsPageInTransition) {
424 mIsPageInTransition = true;
425 onPageBeginTransition();
Michael Jurkad74c9842011-07-10 12:44:21 -0700426 }
Patrick Dubroy1262e362010-10-06 15:49:50 -0700427 }
428
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700429 protected void pageEndTransition() {
Sunny Goyal05b59c02021-04-29 13:55:40 -0700430 if (mIsPageInTransition && !mIsBeingDragged && mScroller.isFinished()
Sunny Goyalb745a2a2021-04-30 13:38:22 -0700431 && (!isShown() || (mEdgeGlowLeft.isFinished() && mEdgeGlowRight.isFinished()))) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700432 mIsPageInTransition = false;
433 onPageEndTransition();
Michael Jurkad74c9842011-07-10 12:44:21 -0700434 }
Michael Jurka0142d492010-08-25 17:46:15 -0700435 }
436
Sunny Goyalb745a2a2021-04-30 13:38:22 -0700437 @Override
438 public void onVisibilityAggregated(boolean isVisible) {
439 pageEndTransition();
440 super.onVisibilityAggregated(isVisible);
441 }
442
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700443 protected boolean isPageInTransition() {
444 return mIsPageInTransition;
Adam Cohen26976d92011-03-22 15:33:33 -0700445 }
446
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700447 /**
448 * Called when the page starts moving as part of the scroll. Subclasses can override this
449 * to provide custom behavior during animation.
450 */
451 protected void onPageBeginTransition() {
Patrick Dubroy1262e362010-10-06 15:49:50 -0700452 }
453
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700454 /**
455 * Called when the page ends moving as part of the scroll. Subclasses can override this
456 * to provide custom behavior during animation.
457 */
458 protected void onPageEndTransition() {
Alex Chauba61b982021-06-15 16:29:19 +0100459 mCurrentPageScrollDiff = 0;
vadimt4d93df52019-07-10 17:32:58 -0700460 AccessibilityManagerCompat.sendScrollFinishedEventToTest(getContext());
Tony Wickham619daaf2020-02-07 12:29:06 -0800461 AccessibilityManagerCompat.sendCustomAccessibilityEvent(getPageAt(mCurrentPage),
462 AccessibilityEvent.TYPE_VIEW_FOCUSED, null);
Tony Wickham62117d72020-03-26 16:56:26 -0700463 if (mOnPageTransitionEndCallback != null) {
464 mOnPageTransitionEndCallback.run();
465 mOnPageTransitionEndCallback = null;
466 }
467 }
468
469 /**
470 * Sets a callback to run once when the scrolling finishes. If there is currently
471 * no page in transition, then the callback is called immediately.
472 */
473 public void setOnPageTransitionEndCallback(@Nullable Runnable callback) {
474 if (mIsPageInTransition || callback == null) {
475 mOnPageTransitionEndCallback = callback;
476 } else {
477 callback.run();
478 }
Michael Jurka0142d492010-08-25 17:46:15 -0700479 }
480
Adam Cohen68d73932010-11-15 10:50:58 -0800481 @Override
Michael Jurka0142d492010-08-25 17:46:15 -0700482 public void scrollTo(int x, int y) {
Sunny Goyalc39db732021-04-03 01:20:21 -0700483 x = Utilities.boundToRange(x,
484 mOrientationHandler.getPrimaryValue(mMinScroll, 0), mMaxScroll);
485 y = Utilities.boundToRange(y,
486 mOrientationHandler.getPrimaryValue(0, mMinScroll), mMaxScroll);
Vinit Nayaka406f722019-12-19 11:50:55 -0800487 super.scrollTo(x, y);
Michael Jurka0142d492010-08-25 17:46:15 -0700488 }
489
Adam Cohen53805212013-10-01 10:39:23 -0700490 private void sendScrollAccessibilityEvent() {
Sunny Goyald0030b02017-12-08 15:07:24 -0800491 if (isObservedEventType(getContext(), AccessibilityEvent.TYPE_VIEW_SCROLLED)) {
Vadim Tryshevf4715972015-05-08 17:21:03 -0700492 if (mCurrentPage != getNextPage()) {
493 AccessibilityEvent ev =
494 AccessibilityEvent.obtain(AccessibilityEvent.TYPE_VIEW_SCROLLED);
Vadim Tryshev7066c122015-05-21 14:06:35 -0700495 ev.setScrollable(true);
496 ev.setScrollX(getScrollX());
497 ev.setScrollY(getScrollY());
Vinit Nayaka406f722019-12-19 11:50:55 -0800498 mOrientationHandler.setMaxScroll(ev, mMaxScroll);
Vadim Tryshevf4715972015-05-08 17:21:03 -0700499 sendAccessibilityEventUnchecked(ev);
Adam Cohen53805212013-10-01 10:39:23 -0700500 }
Adam Cohen53805212013-10-01 10:39:23 -0700501 }
502 }
503
Vadim Tryshev2c430b32018-04-04 14:45:21 -0700504 protected void announcePageForAccessibility() {
505 if (isAccessibilityEnabled(getContext())) {
506 // Notify the user when the page changes
507 announceForAccessibility(getCurrentPageDescription());
508 }
509 }
510
Winson Chung85425412021-05-10 16:24:14 -0700511 protected boolean computeScrollHelper() {
Winson Chung321e9ee2010-08-09 13:37:56 -0700512 if (mScroller.computeScrollOffset()) {
Winson Chung557d6ed2011-07-08 15:34:52 -0700513 // Don't bother scrolling if the page does not need to be moved
Sunny Goyalc39db732021-04-03 01:20:21 -0700514 int oldPos = mOrientationHandler.getPrimaryScroll(this);
515 int newPos = mScroller.getCurrX();
516 if (oldPos != newPos) {
517 mOrientationHandler.set(this, VIEW_SCROLL_TO, mScroller.getCurrX());
Winson Chung557d6ed2011-07-08 15:34:52 -0700518 }
Winson Chung85425412021-05-10 16:24:14 -0700519
520 if (mAllowOverScroll) {
521 if (newPos < mMinScroll && oldPos >= mMinScroll) {
522 mEdgeGlowLeft.onAbsorb((int) mScroller.getCurrVelocity());
523 mScroller.abortAnimation();
524 } else if (newPos > mMaxScroll && oldPos <= mMaxScroll) {
525 mEdgeGlowRight.onAbsorb((int) mScroller.getCurrVelocity());
526 mScroller.abortAnimation();
Sunny Goyalc39db732021-04-03 01:20:21 -0700527 }
Tony Wickham95cdb3a2016-02-18 14:37:07 -0800528 }
Adam Cohen53805212013-10-01 10:39:23 -0700529
Winson Chung85425412021-05-10 16:24:14 -0700530 // If the scroller has scrolled to the final position and there is no edge effect, then
531 // finish the scroller to skip waiting for additional settling
532 int finalPos = mOrientationHandler.getPrimaryValue(mScroller.getFinalX(),
533 mScroller.getFinalY());
534 if (newPos == finalPos && mEdgeGlowLeft.isFinished() && mEdgeGlowRight.isFinished()) {
535 mScroller.abortAnimation();
536 }
537
538 invalidate();
539 return true;
540 } else if (mNextPage != INVALID_PAGE) {
541 sendScrollAccessibilityEvent();
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700542 int prevPage = mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700543 mCurrentPage = validateNewPage(mNextPage);
Winson Chung86f77532010-08-24 11:08:22 -0700544 mNextPage = INVALID_PAGE;
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700545 notifyPageSwitchListener(prevPage);
Winson Chungb44b5242011-06-13 11:32:14 -0700546
Adam Cohen73aa9752010-11-24 16:26:58 -0800547 // We don't want to trigger a page end moving unless the page has settled
548 // and the user has stopped scrolling
Sunny Goyalaad33592018-08-07 17:20:35 -0700549 if (!mIsBeingDragged) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700550 pageEndTransition();
Adam Cohen73aa9752010-11-24 16:26:58 -0800551 }
Winson Chungc27d1bb2011-09-29 12:07:42 -0700552
Vadim Tryshev2c430b32018-04-04 14:45:21 -0700553 if (canAnnouncePageDescription()) {
554 announcePageForAccessibility();
Adam Cohen0ffac432013-07-10 11:19:26 -0700555 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700556 }
Michael Jurka0142d492010-08-25 17:46:15 -0700557 return false;
558 }
559
560 @Override
561 public void computeScroll() {
562 computeScrollHelper();
Winson Chung321e9ee2010-08-09 13:37:56 -0700563 }
564
Sunny Goyalce8809a2018-01-18 14:02:47 -0800565 public int getExpectedHeight() {
566 return getMeasuredHeight();
567 }
568
Adam Cohen410f3cd2013-09-22 12:09:32 -0700569 public int getNormalChildHeight() {
Sunny Goyalce8809a2018-01-18 14:02:47 -0800570 return getExpectedHeight() - getPaddingTop() - getPaddingBottom()
Sunny Goyalac00cba2017-11-13 15:58:01 -0800571 - mInsets.top - mInsets.bottom;
Adam Cohen410f3cd2013-09-22 12:09:32 -0700572 }
573
Sunny Goyalce8809a2018-01-18 14:02:47 -0800574 public int getExpectedWidth() {
575 return getMeasuredWidth();
576 }
577
Sunny Goyalbc683e92017-12-06 10:25:07 -0800578 public int getNormalChildWidth() {
Sunny Goyalce8809a2018-01-18 14:02:47 -0800579 return getExpectedWidth() - getPaddingLeft() - getPaddingRight()
Sunny Goyalbc683e92017-12-06 10:25:07 -0800580 - mInsets.left - mInsets.right;
581 }
582
Winson Chung321e9ee2010-08-09 13:37:56 -0700583 @Override
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800584 public void requestLayout() {
585 mIsLayoutValid = false;
586 super.requestLayout();
587 }
588
589 @Override
590 public void forceLayout() {
591 mIsLayoutValid = false;
592 super.forceLayout();
593 }
594
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100595 private int getPageWidthSize(int widthSize) {
596 return (widthSize - mInsets.left - mInsets.right) / getPanelCount();
597 }
598
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800599 @Override
Winson Chung321e9ee2010-08-09 13:37:56 -0700600 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
Sunny Goyal8e2133b2015-05-06 13:39:07 -0700601 if (getChildCount() == 0) {
Winson Chungf0ea4d32011-06-06 14:27:16 -0700602 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
603 return;
604 }
605
Adam Cohen7d30a372013-07-01 17:03:59 -0700606 // We measure the dimensions of the PagedView to be larger than the pages so that when we
607 // zoom out (and scale down), the view is still contained in the parent
Adam Cohen7d30a372013-07-01 17:03:59 -0700608 int widthMode = MeasureSpec.getMode(widthMeasureSpec);
609 int widthSize = MeasureSpec.getSize(widthMeasureSpec);
610 int heightMode = MeasureSpec.getMode(heightMeasureSpec);
Winson Chung8aad6102012-05-11 16:27:49 -0700611 int heightSize = MeasureSpec.getSize(heightMeasureSpec);
Adam Cohen410f3cd2013-09-22 12:09:32 -0700612
Adam Cohen7d30a372013-07-01 17:03:59 -0700613 if (widthMode == MeasureSpec.UNSPECIFIED || heightMode == MeasureSpec.UNSPECIFIED) {
614 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
615 return;
Winson Chung321e9ee2010-08-09 13:37:56 -0700616 }
617
Winson Chung8aad6102012-05-11 16:27:49 -0700618 // Return early if we aren't given a proper dimension
619 if (widthSize <= 0 || heightSize <= 0) {
620 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
621 return;
622 }
623
Winson Chung321e9ee2010-08-09 13:37:56 -0700624 // The children are given the same width and height as the workspace
Michael Jurka5f1c5092010-09-03 14:15:02 -0700625 // unless they were set to WRAP_CONTENT
Winson Chung785d2eb2011-04-14 16:08:02 -0700626 if (DEBUG) Log.d(TAG, "PagedView.onMeasure(): " + widthSize + ", " + heightSize);
Michael Jurka5f1c5092010-09-03 14:15:02 -0700627
Sunny Goyalac00cba2017-11-13 15:58:01 -0800628 int myWidthSpec = MeasureSpec.makeMeasureSpec(
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100629 getPageWidthSize(widthSize), MeasureSpec.EXACTLY);
Sunny Goyalac00cba2017-11-13 15:58:01 -0800630 int myHeightSpec = MeasureSpec.makeMeasureSpec(
Sunny Goyal228153d2018-01-04 15:35:22 -0800631 heightSize - mInsets.top - mInsets.bottom, MeasureSpec.EXACTLY);
Adam Cohen96d30a12013-07-16 18:13:21 -0700632
Sunny Goyalac00cba2017-11-13 15:58:01 -0800633 // measureChildren takes accounts for content padding, we only need to care about extra
634 // space due to insets.
635 measureChildren(myWidthSpec, myHeightSpec);
636 setMeasuredDimension(widthSize, heightSize);
Adam Cohen60b07122011-11-14 17:26:06 -0800637 }
638
Sunny Goyalcf25b522015-07-09 00:01:18 -0700639 @SuppressLint("DrawAllocation")
Winson Chung321e9ee2010-08-09 13:37:56 -0700640 @Override
Michael Jurka28750fb2010-09-24 17:43:49 -0700641 protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800642 mIsLayoutValid = true;
Vadim Trysheveb701c62018-05-14 16:00:15 -0700643 final int childCount = getChildCount();
644 boolean pageScrollChanged = false;
645 if (mPageScrolls == null || childCount != mPageScrolls.length) {
646 mPageScrolls = new int[childCount];
647 pageScrollChanged = true;
648 }
649
650 if (childCount == 0) {
Winson Chungf0ea4d32011-06-06 14:27:16 -0700651 return;
652 }
653
Winson Chung785d2eb2011-04-14 16:08:02 -0700654 if (DEBUG) Log.d(TAG, "PagedView.onLayout()");
Winson Chung321e9ee2010-08-09 13:37:56 -0700655
Vinit Nayaka406f722019-12-19 11:50:55 -0800656 boolean isScrollChanged = getPageScrolls(mPageScrolls, true, SIMPLE_SCROLL_LOGIC);
657 if (isScrollChanged) {
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700658 pageScrollChanged = true;
Winson Chung321e9ee2010-08-09 13:37:56 -0700659 }
Winson Chungc3665fa2011-09-14 17:56:27 -0700660
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700661 final LayoutTransition transition = getLayoutTransition();
662 // If the transition is running defer updating max scroll, as some empty pages could
663 // still be present, and a max scroll change could cause sudden jumps in scroll.
664 if (transition != null && transition.isRunning()) {
665 transition.addTransitionListener(new LayoutTransition.TransitionListener() {
666
667 @Override
668 public void startTransition(LayoutTransition transition, ViewGroup container,
669 View view, int transitionType) { }
670
671 @Override
672 public void endTransition(LayoutTransition transition, ViewGroup container,
673 View view, int transitionType) {
674 // Wait until all transitions are complete.
675 if (!transition.isRunning()) {
676 transition.removeTransitionListener(this);
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700677 updateMinAndMaxScrollX();
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700678 }
679 }
680 });
Adam Cohenf698c6e2013-07-17 18:44:25 -0700681 } else {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700682 updateMinAndMaxScrollX();
Adam Cohenf698c6e2013-07-17 18:44:25 -0700683 }
684
Sunny Goyalcb037ee2015-07-08 16:41:21 -0700685 if (mFirstLayout && mCurrentPage >= 0 && mCurrentPage < childCount) {
686 updateCurrentPageScroll();
687 mFirstLayout = false;
688 }
689
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800690 if (mScroller.isFinished() && pageScrollChanged) {
Sunny Goyalc82c6392018-06-06 15:39:13 -0700691 setCurrentPage(getNextPage());
Adam Cohenf698c6e2013-07-17 18:44:25 -0700692 }
Winson Chunge3193b92010-09-10 11:44:42 -0700693 }
694
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700695 /**
696 * Initializes {@code outPageScrolls} with scroll positions for view at that index. The length
697 * of {@code outPageScrolls} should be same as the the childCount
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700698 */
699 protected boolean getPageScrolls(int[] outPageScrolls, boolean layoutChildren,
700 ComputePageScrollsLogic scrollLogic) {
701 final int childCount = getChildCount();
702
703 final int startIndex = mIsRtl ? childCount - 1 : 0;
704 final int endIndex = mIsRtl ? -1 : childCount;
705 final int delta = mIsRtl ? -1 : 1;
706
Vinit Nayaka406f722019-12-19 11:50:55 -0800707 final int pageCenter = mOrientationHandler.getCenterForPage(this, mInsets);
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700708
Vinit Nayaka406f722019-12-19 11:50:55 -0800709 final int scrollOffsetStart = mOrientationHandler.getScrollOffsetStart(this, mInsets);
710 final int scrollOffsetEnd = mOrientationHandler.getScrollOffsetEnd(this, mInsets);
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700711 boolean pageScrollChanged = false;
712
Vinit Nayaka406f722019-12-19 11:50:55 -0800713 for (int i = startIndex, childStart = scrollOffsetStart; i != endIndex; i += delta) {
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700714 final View child = getPageAt(i);
715 if (scrollLogic.shouldIncludeView(child)) {
Vinit Nayaka406f722019-12-19 11:50:55 -0800716 ChildBounds bounds = mOrientationHandler.getChildBounds(child, childStart,
717 pageCenter, layoutChildren);
718 final int primaryDimension = bounds.primaryDimension;
719 final int childPrimaryEnd = bounds.childPrimaryEnd;
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700720
Alex Chaub5c4d112021-03-29 17:37:53 +0100721 // In case the pages are of different width, align the page to left edge for non-RTL
722 // or right edge for RTL.
723 final int pageScroll =
724 mIsRtl ? childPrimaryEnd - scrollOffsetEnd : childStart - scrollOffsetStart;
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700725 if (outPageScrolls[i] != pageScroll) {
726 pageScrollChanged = true;
727 outPageScrolls[i] = pageScroll;
728 }
Vinit Nayaka406f722019-12-19 11:50:55 -0800729 childStart += primaryDimension + mPageSpacing + getChildGap();
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700730 }
731 }
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100732
733 int panelCount = getPanelCount();
734 if (panelCount > 1) {
735 for (int i = 0; i < childCount; i++) {
736 // In case we have multiple panels, always use left panel's page scroll for all
737 // panels on the screen.
738 int adjustedScroll = outPageScrolls[getLeftmostVisiblePageForIndex(i)];
739 if (outPageScrolls[i] != adjustedScroll) {
740 outPageScrolls[i] = adjustedScroll;
741 pageScrollChanged = true;
742 }
743 }
744 }
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700745 return pageScrollChanged;
746 }
747
Sunny Goyala1fbd842015-05-20 13:40:27 -0700748 protected int getChildGap() {
749 return 0;
750 }
751
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700752 protected void updateMinAndMaxScrollX() {
Vinit Nayaka406f722019-12-19 11:50:55 -0800753 mMinScroll = computeMinScroll();
754 mMaxScroll = computeMaxScroll();
Tony Wickhamf549dab2016-05-16 09:54:06 -0700755 }
756
Vinit Nayaka406f722019-12-19 11:50:55 -0800757 protected int computeMinScroll() {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700758 return 0;
Tony50876bf2018-09-19 23:09:14 -0400759 }
760
Vinit Nayaka406f722019-12-19 11:50:55 -0800761 protected int computeMaxScroll() {
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700762 int childCount = getChildCount();
763 if (childCount > 0) {
Sunny Goyal70660032015-05-14 00:07:08 -0700764 final int index = mIsRtl ? 0 : childCount - 1;
Tony Wickhamf549dab2016-05-16 09:54:06 -0700765 return getScrollForPage(index);
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700766 } else {
Tony Wickhamf549dab2016-05-16 09:54:06 -0700767 return 0;
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700768 }
769 }
770
Adam Cohen3b185e22013-10-29 14:45:58 -0700771 public void setPageSpacing(int pageSpacing) {
772 mPageSpacing = pageSpacing;
773 requestLayout();
774 }
775
Tony50876bf2018-09-19 23:09:14 -0400776 public int getPageSpacing() {
777 return mPageSpacing;
778 }
779
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800780 private void dispatchPageCountChanged() {
781 if (mPageIndicator != null) {
782 mPageIndicator.setMarkersCount(getChildCount());
Winson Chungd2be3812013-07-16 11:11:32 -0700783 }
Adam Cohen2591f6a2011-10-25 14:36:40 -0700784 // This ensures that when children are added, they get the correct transforms / alphas
785 // in accordance with any scroll effects.
Adam Cohen2591f6a2011-10-25 14:36:40 -0700786 invalidate();
787 }
788
Michael Jurka8b805b12012-04-18 14:23:14 -0700789 @Override
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800790 public void onViewAdded(View child) {
Winson Chungc7c51582018-02-23 17:58:36 -0800791 super.onViewAdded(child);
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800792 dispatchPageCountChanged();
793 }
794
795 @Override
796 public void onViewRemoved(View child) {
Winson Chungc7c51582018-02-23 17:58:36 -0800797 super.onViewRemoved(child);
Tonya361c722017-07-04 09:43:06 -0700798 mCurrentPage = validateNewPage(mCurrentPage);
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800799 dispatchPageCountChanged();
Winson Chungd2be3812013-07-16 11:11:32 -0700800 }
801
Adam Cohen73894962011-10-31 13:17:17 -0700802 protected int getChildOffset(int index) {
Adam Cohen7d30a372013-07-01 17:03:59 -0700803 if (index < 0 || index > getChildCount() - 1) return 0;
Vinit Nayaka406f722019-12-19 11:50:55 -0800804 View pageAtIndex = getPageAt(index);
805 return mOrientationHandler.getChildStart(pageAtIndex);
Adam Cohen73894962011-10-31 13:17:17 -0700806 }
807
Alex Chau7944ee52021-01-08 19:07:25 +0000808 protected int getChildVisibleSize(int index) {
809 View layout = getPageAt(index);
810 return mOrientationHandler.getMeasuredSize(layout);
811 }
812
Winson Chung321e9ee2010-08-09 13:37:56 -0700813 @Override
814 public boolean requestChildRectangleOnScreen(View child, Rect rectangle, boolean immediate) {
Adam Cohenae4f1552011-10-20 00:15:42 -0700815 int page = indexToPage(indexOfChild(child));
Winson Chung86f77532010-08-24 11:08:22 -0700816 if (page != mCurrentPage || !mScroller.isFinished()) {
Vadim Trysheveeaa8ee2018-04-11 12:23:42 -0700817 if (immediate) {
818 setCurrentPage(page);
819 } else {
820 snapToPage(page);
821 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700822 return true;
823 }
824 return false;
825 }
826
827 @Override
828 protected boolean onRequestFocusInDescendants(int direction, Rect previouslyFocusedRect) {
Winson Chung86f77532010-08-24 11:08:22 -0700829 int focusablePage;
830 if (mNextPage != INVALID_PAGE) {
831 focusablePage = mNextPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700832 } else {
Winson Chung86f77532010-08-24 11:08:22 -0700833 focusablePage = mCurrentPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700834 }
Winson Chung86f77532010-08-24 11:08:22 -0700835 View v = getPageAt(focusablePage);
Winson Chung321e9ee2010-08-09 13:37:56 -0700836 if (v != null) {
Adam Cohen76fc0852011-06-17 13:26:23 -0700837 return v.requestFocus(direction, previouslyFocusedRect);
Winson Chung321e9ee2010-08-09 13:37:56 -0700838 }
839 return false;
840 }
841
842 @Override
843 public boolean dispatchUnhandledMove(View focused, int direction) {
Sunny Goyal0c4e3722015-12-01 13:21:49 -0800844 if (super.dispatchUnhandledMove(focused, direction)) {
845 return true;
846 }
847
848 if (mIsRtl) {
849 if (direction == View.FOCUS_LEFT) {
850 direction = View.FOCUS_RIGHT;
851 } else if (direction == View.FOCUS_RIGHT) {
852 direction = View.FOCUS_LEFT;
853 }
854 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700855 if (direction == View.FOCUS_LEFT) {
Winson Chung86f77532010-08-24 11:08:22 -0700856 if (getCurrentPage() > 0) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100857 int nextPage = validateNewPage(getCurrentPage() - 1);
858 snapToPage(nextPage);
859 getChildAt(nextPage).requestFocus(direction);
Winson Chung321e9ee2010-08-09 13:37:56 -0700860 return true;
861 }
862 } else if (direction == View.FOCUS_RIGHT) {
Winson Chung86f77532010-08-24 11:08:22 -0700863 if (getCurrentPage() < getPageCount() - 1) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100864 int nextPage = validateNewPage(getCurrentPage() + 1);
865 snapToPage(nextPage);
866 getChildAt(nextPage).requestFocus(direction);
Winson Chung321e9ee2010-08-09 13:37:56 -0700867 return true;
868 }
869 }
Sunny Goyal0c4e3722015-12-01 13:21:49 -0800870 return false;
Winson Chung321e9ee2010-08-09 13:37:56 -0700871 }
872
873 @Override
874 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) {
Jon Miranda6a858172016-10-25 16:19:17 -0700875 if (getDescendantFocusability() == FOCUS_BLOCK_DESCENDANTS) {
876 return;
877 }
878
Andras Kloczl359d1ae2021-05-04 22:25:27 +0200879 // Add the current page's views as focusable and the next possible page's too. If the
880 // last focus change action was left then the left neighbour's views will be added, and
881 // if it was right then the right neighbour's views will be added.
882 // Unfortunately mCurrentPage can be outdated if there were multiple control actions in a
883 // short period of time, but mNextPage is up to date because it is always updated by
884 // method snapToPage.
885 int nextPage = getNextPage();
Adam Cohen0ffac432013-07-10 11:19:26 -0700886 // XXX-RTL: This will be fixed in a future CL
Andras Kloczl359d1ae2021-05-04 22:25:27 +0200887 if (nextPage >= 0 && nextPage < getPageCount()) {
888 getPageAt(nextPage).addFocusables(views, direction, focusableMode);
Winson Chung321e9ee2010-08-09 13:37:56 -0700889 }
890 if (direction == View.FOCUS_LEFT) {
Andras Kloczl359d1ae2021-05-04 22:25:27 +0200891 if (nextPage > 0) {
892 nextPage = validateNewPage(nextPage - 1);
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100893 getPageAt(nextPage).addFocusables(views, direction, focusableMode);
Winson Chung321e9ee2010-08-09 13:37:56 -0700894 }
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100895 } else if (direction == View.FOCUS_RIGHT) {
Andras Kloczl359d1ae2021-05-04 22:25:27 +0200896 if (nextPage < getPageCount() - 1) {
897 nextPage = validateNewPage(nextPage + 1);
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100898 getPageAt(nextPage).addFocusables(views, direction, focusableMode);
Winson Chung321e9ee2010-08-09 13:37:56 -0700899 }
900 }
901 }
902
903 /**
904 * If one of our descendant views decides that it could be focused now, only
Winson Chung86f77532010-08-24 11:08:22 -0700905 * pass that along if it's on the current page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700906 *
Winson Chung86f77532010-08-24 11:08:22 -0700907 * This happens when live folders requery, and if they're off page, they
908 * end up calling requestFocus, which pulls it on page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700909 */
910 @Override
911 public void focusableViewAvailable(View focused) {
Winson Chung86f77532010-08-24 11:08:22 -0700912 View current = getPageAt(mCurrentPage);
Winson Chung321e9ee2010-08-09 13:37:56 -0700913 View v = focused;
914 while (true) {
915 if (v == current) {
916 super.focusableViewAvailable(focused);
917 return;
918 }
919 if (v == this) {
920 return;
921 }
922 ViewParent parent = v.getParent();
923 if (parent instanceof View) {
924 v = (View)v.getParent();
925 } else {
926 return;
927 }
928 }
929 }
930
931 /**
932 * {@inheritDoc}
933 */
934 @Override
935 public void requestDisallowInterceptTouchEvent(boolean disallowIntercept) {
936 if (disallowIntercept) {
937 // We need to make sure to cancel our long press if
938 // a scrollable widget takes over touch events
Andras Kloczl7a1ca0b2021-04-08 16:08:16 +0200939 cancelCurrentPageLongPress();
Winson Chung321e9ee2010-08-09 13:37:56 -0700940 }
941 super.requestDisallowInterceptTouchEvent(disallowIntercept);
942 }
943
944 @Override
945 public boolean onInterceptTouchEvent(MotionEvent ev) {
946 /*
947 * This method JUST determines whether we want to intercept the motion.
948 * If we return true, onTouchEvent will be called and we do the actual
949 * scrolling there.
950 */
951
Winson Chung45e1d6e2010-11-09 17:19:49 -0800952 // Skip touch handling if there are no pages to swipe
Tony Wickhamb6841ac2019-07-22 12:39:59 -0700953 if (getChildCount() <= 0) return false;
Sunny Goyalc4bb3732019-06-20 11:34:14 -0700954
955 acquireVelocityTrackerAndAddMovement(ev);
Winson Chung45e1d6e2010-11-09 17:19:49 -0800956
Winson Chung321e9ee2010-08-09 13:37:56 -0700957 /*
958 * Shortcut the most recurring case: the user is in the dragging
959 * state and he is moving his finger. We want to intercept this
960 * motion.
961 */
962 final int action = ev.getAction();
Sunny Goyalaad33592018-08-07 17:20:35 -0700963 if ((action == MotionEvent.ACTION_MOVE) && mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -0700964 return true;
965 }
966
Winson Chung321e9ee2010-08-09 13:37:56 -0700967 switch (action & MotionEvent.ACTION_MASK) {
968 case MotionEvent.ACTION_MOVE: {
969 /*
970 * mIsBeingDragged == false, otherwise the shortcut would have caught it. Check
Vinit Nayaka406f722019-12-19 11:50:55 -0800971 * whether the user has moved far enough from their original down touch.
Winson Chung321e9ee2010-08-09 13:37:56 -0700972 */
Michael Jurka1ff706b2010-09-14 17:35:20 -0700973 if (mActivePointerId != INVALID_POINTER) {
974 determineScrollingStart(ev);
Michael Jurka1ff706b2010-09-14 17:35:20 -0700975 }
976 // if mActivePointerId is INVALID_POINTER, then we must have missed an ACTION_DOWN
Vinit Nayaka406f722019-12-19 11:50:55 -0800977 // event. in that case, treat the first occurrence of a move event as a ACTION_DOWN
Michael Jurka1ff706b2010-09-14 17:35:20 -0700978 // i.e. fall through to the next case (don't break)
979 // (We sometimes miss ACTION_DOWN events in Workspace because it ignores all events
980 // while it's small- this was causing a crash before we checked for INVALID_POINTER)
Adam Cohen93c97562013-09-26 13:48:01 -0700981 break;
Winson Chung321e9ee2010-08-09 13:37:56 -0700982 }
983
984 case MotionEvent.ACTION_DOWN: {
985 final float x = ev.getX();
986 final float y = ev.getY();
987 // Remember location of down touch
988 mDownMotionX = x;
Adam Cohen7d30a372013-07-01 17:03:59 -0700989 mDownMotionY = y;
Jon Mirandaf52af432020-04-10 17:25:57 -0700990 mDownMotionPrimary = mLastMotion = mOrientationHandler.getPrimaryDirection(ev, 0);
Vinit Nayaka406f722019-12-19 11:50:55 -0800991 mLastMotionRemainder = 0;
992 mTotalMotion = 0;
Winson Chung4941f652020-06-18 15:11:53 -0700993 mAllowEasyFling = false;
Winson Chung321e9ee2010-08-09 13:37:56 -0700994 mActivePointerId = ev.getPointerId(0);
Sunny Goyalc39db732021-04-03 01:20:21 -0700995 updateIsBeingDraggedOnTouchDown(ev);
Winson Chung321e9ee2010-08-09 13:37:56 -0700996 break;
997 }
998
Winson Chung321e9ee2010-08-09 13:37:56 -0700999 case MotionEvent.ACTION_UP:
Jeff Brown1d0867c2010-12-02 18:27:39 -08001000 case MotionEvent.ACTION_CANCEL:
Adam Cohen7d30a372013-07-01 17:03:59 -07001001 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001002 break;
1003
1004 case MotionEvent.ACTION_POINTER_UP:
1005 onSecondaryPointerUp(ev);
Adam Cohen6342bba2011-03-10 11:33:35 -08001006 releaseVelocityTracker();
Winson Chung321e9ee2010-08-09 13:37:56 -07001007 break;
1008 }
1009
1010 /*
1011 * The only time we want to intercept motion events is if we are in the
1012 * drag mode.
1013 */
Sunny Goyalaad33592018-08-07 17:20:35 -07001014 return mIsBeingDragged;
Winson Chung321e9ee2010-08-09 13:37:56 -07001015 }
1016
Tony Wickhama0aee212019-09-18 09:24:03 -07001017 /**
1018 * If being flinged and user touches the screen, initiate drag; otherwise don't.
1019 */
Sunny Goyalc39db732021-04-03 01:20:21 -07001020 private void updateIsBeingDraggedOnTouchDown(MotionEvent ev) {
Tony Wickhama0aee212019-09-18 09:24:03 -07001021 // mScroller.isFinished should be false when being flinged.
Sunny Goyalc39db732021-04-03 01:20:21 -07001022 final int xDist = Math.abs(mScroller.getFinalX() - mScroller.getCurrX());
Winson Chung4941f652020-06-18 15:11:53 -07001023 final boolean finishedScrolling = (mScroller.isFinished() || xDist < mPageSlop / 3);
Tony Wickhama0aee212019-09-18 09:24:03 -07001024
1025 if (finishedScrolling) {
1026 mIsBeingDragged = false;
1027 if (!mScroller.isFinished() && !mFreeScroll) {
1028 setCurrentPage(getNextPage());
1029 pageEndTransition();
1030 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001031 mIsBeingDragged = !mEdgeGlowLeft.isFinished() || !mEdgeGlowRight.isFinished();
Tony Wickhama0aee212019-09-18 09:24:03 -07001032 } else {
1033 mIsBeingDragged = true;
1034 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001035
1036 // Catch the edge effect if it is active.
1037 float displacement = mOrientationHandler.getSecondaryValue(ev.getX(), ev.getY())
1038 / mOrientationHandler.getSecondaryValue(getWidth(), getHeight());
1039 if (!mEdgeGlowLeft.isFinished()) {
1040 mEdgeGlowLeft.onPullDistance(0f, 1f - displacement);
1041 }
1042 if (!mEdgeGlowRight.isFinished()) {
1043 mEdgeGlowRight.onPullDistance(0f, displacement);
1044 }
Tony Wickhama0aee212019-09-18 09:24:03 -07001045 }
1046
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001047 public boolean isHandlingTouch() {
Sunny Goyalaad33592018-08-07 17:20:35 -07001048 return mIsBeingDragged;
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001049 }
1050
Adam Cohenf8d28232011-02-01 21:47:00 -08001051 protected void determineScrollingStart(MotionEvent ev) {
1052 determineScrollingStart(ev, 1.0f);
1053 }
1054
Winson Chung321e9ee2010-08-09 13:37:56 -07001055 /*
1056 * Determines if we should change the touch state to start scrolling after the
1057 * user moves their touch point too far.
1058 */
Adam Cohenf8d28232011-02-01 21:47:00 -08001059 protected void determineScrollingStart(MotionEvent ev, float touchSlopScale) {
Adam Cohen7d30a372013-07-01 17:03:59 -07001060 // Disallow scrolling if we don't have a valid pointer index
Winson Chung321e9ee2010-08-09 13:37:56 -07001061 final int pointerIndex = ev.findPointerIndex(mActivePointerId);
Adam Cohen7d30a372013-07-01 17:03:59 -07001062 if (pointerIndex == -1) return;
1063
Vinit Nayaka406f722019-12-19 11:50:55 -08001064 final float primaryDirection = mOrientationHandler.getPrimaryDirection(ev, pointerIndex);
1065 final int diff = (int) Math.abs(primaryDirection - mLastMotion);
Adam Cohenf8d28232011-02-01 21:47:00 -08001066 final int touchSlop = Math.round(touchSlopScale * mTouchSlop);
Winson Chung4941f652020-06-18 15:11:53 -07001067 boolean moved = diff > touchSlop || ev.getAction() == ACTION_MOVE_ALLOW_EASY_FLING;
Winson Chung321e9ee2010-08-09 13:37:56 -07001068
Vinit Nayaka406f722019-12-19 11:50:55 -08001069 if (moved) {
Sunny Goyal5a1f53b2015-05-27 10:24:24 -07001070 // Scroll if the user moved far enough along the X axis
Sunny Goyalaad33592018-08-07 17:20:35 -07001071 mIsBeingDragged = true;
Vinit Nayaka406f722019-12-19 11:50:55 -08001072 mTotalMotion += Math.abs(mLastMotion - primaryDirection);
1073 mLastMotion = primaryDirection;
1074 mLastMotionRemainder = 0;
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001075 pageBeginTransition();
Tony Wickhamdadb3042016-02-24 11:07:00 -08001076 // Stop listening for things like pinches.
1077 requestDisallowInterceptTouchEvent(true);
Adam Cohenf8d28232011-02-01 21:47:00 -08001078 }
1079 }
1080
1081 protected void cancelCurrentPageLongPress() {
Sunny Goyal8e2133b2015-05-06 13:39:07 -07001082 // Try canceling the long press. It could also have been scheduled
1083 // by a distant descendant, so use the mAllowLongPress flag to block
1084 // everything
Sunny Goyal59969372021-05-06 12:11:44 -07001085 forEachVisiblePage(View::cancelLongPress);
Winson Chung321e9ee2010-08-09 13:37:56 -07001086 }
1087
Adam Cohenb5ba0972011-09-07 18:02:31 -07001088 protected float getScrollProgress(int screenCenter, View v, int page) {
Sunny Goyal228153d2018-01-04 15:35:22 -08001089 final int halfScreenSize = getMeasuredWidth() / 2;
Adam Cohenedb40762013-07-18 16:45:45 -07001090 int delta = screenCenter - (getScrollForPage(page) + halfScreenSize);
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001091 int panelCount = getPanelCount();
1092 int pageCount = getChildCount();
Adam Cohen3b185e22013-10-29 14:45:58 -07001093
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001094 int adjacentPage = page + panelCount;
Sunny Goyal70660032015-05-14 00:07:08 -07001095 if ((delta < 0 && !mIsRtl) || (delta > 0 && mIsRtl)) {
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001096 adjacentPage = page - panelCount;
Adam Cohen3b185e22013-10-29 14:45:58 -07001097 }
1098
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001099 final int totalDistance;
1100 if (adjacentPage < 0 || adjacentPage > pageCount - 1) {
1101 totalDistance = (v.getMeasuredWidth() + mPageSpacing) * panelCount;
Adam Cohen3b185e22013-10-29 14:45:58 -07001102 } else {
1103 totalDistance = Math.abs(getScrollForPage(adjacentPage) - getScrollForPage(page));
1104 }
Adam Cohenb5ba0972011-09-07 18:02:31 -07001105
1106 float scrollProgress = delta / (totalDistance * 1.0f);
Sunny Goyal8e2133b2015-05-06 13:39:07 -07001107 scrollProgress = Math.min(scrollProgress, MAX_SCROLL_PROGRESS);
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001108 scrollProgress = Math.max(scrollProgress, -MAX_SCROLL_PROGRESS);
Adam Cohenb5ba0972011-09-07 18:02:31 -07001109 return scrollProgress;
1110 }
1111
Adam Cohenedb40762013-07-18 16:45:45 -07001112 public int getScrollForPage(int index) {
Adam Cohen1f1f45d2013-10-02 09:40:18 -07001113 if (mPageScrolls == null || index >= mPageScrolls.length || index < 0) {
Adam Cohenedb40762013-07-18 16:45:45 -07001114 return 0;
1115 } else {
1116 return mPageScrolls[index];
1117 }
1118 }
1119
Adam Cohen564a2e72013-10-09 14:47:32 -07001120 // While layout transitions are occurring, a child's position may stray from its baseline
1121 // position. This method returns the magnitude of this stray at any given time.
1122 public int getLayoutTransitionOffsetForPage(int index) {
1123 if (mPageScrolls == null || index >= mPageScrolls.length || index < 0) {
1124 return 0;
1125 } else {
1126 View child = getChildAt(index);
Adam Cohen3b185e22013-10-29 14:45:58 -07001127
Sunny Goyal228153d2018-01-04 15:35:22 -08001128 int scrollOffset = mIsRtl ? getPaddingRight() : getPaddingLeft();
1129 int baselineX = mPageScrolls[index] + scrollOffset;
Adam Cohen564a2e72013-10-09 14:47:32 -07001130 return (int) (child.getX() - baselineX);
1131 }
1132 }
1133
Tony Wickham023f4042019-01-29 10:52:31 -08001134 public void setEnableFreeScroll(boolean freeScroll) {
Winson Chung0e449002019-04-26 11:09:58 -07001135 if (mFreeScroll == freeScroll) {
1136 return;
1137 }
1138
Tony Wickham8f7ead32016-04-07 18:46:44 -07001139 boolean wasFreeScroll = mFreeScroll;
Adam Cohenf358a4b2013-07-23 16:47:31 -07001140 mFreeScroll = freeScroll;
1141
Adam Cohenf9618852013-11-08 06:45:03 -08001142 if (mFreeScroll) {
Sunny Goyal4d519f22017-10-24 10:32:40 -07001143 setCurrentPage(getNextPage());
Tony Wickham8f7ead32016-04-07 18:46:44 -07001144 } else if (wasFreeScroll) {
Tony Wickhamaf33f2c2019-10-04 12:55:22 -07001145 if (getScrollForPage(getNextPage()) != getScrollX()) {
1146 snapToPage(getNextPage());
1147 }
Adam Cohenf358a4b2013-07-23 16:47:31 -07001148 }
Adam Cohenf358a4b2013-07-23 16:47:31 -07001149 }
1150
Sunny Goyal2f0ec852015-03-26 13:38:27 -07001151 protected void setEnableOverscroll(boolean enable) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001152 mAllowOverScroll = enable;
1153 }
1154
Alex Chau822acf42021-06-03 11:35:05 +01001155 protected float getSignificantMoveThreshold() {
1156 return SIGNIFICANT_MOVE_THRESHOLD;
1157 }
1158
Winson Chung321e9ee2010-08-09 13:37:56 -07001159 @Override
1160 public boolean onTouchEvent(MotionEvent ev) {
Winson Chung45e1d6e2010-11-09 17:19:49 -08001161 // Skip touch handling if there are no pages to swipe
Tony Wickhamb6841ac2019-07-22 12:39:59 -07001162 if (getChildCount() <= 0) return false;
Winson Chung45e1d6e2010-11-09 17:19:49 -08001163
Michael Jurkab8f06722010-10-10 15:58:46 -07001164 acquireVelocityTrackerAndAddMovement(ev);
Winson Chung321e9ee2010-08-09 13:37:56 -07001165
1166 final int action = ev.getAction();
1167
1168 switch (action & MotionEvent.ACTION_MASK) {
1169 case MotionEvent.ACTION_DOWN:
Sunny Goyalc39db732021-04-03 01:20:21 -07001170 updateIsBeingDraggedOnTouchDown(ev);
Tony Wickhama0aee212019-09-18 09:24:03 -07001171
Winson Chung321e9ee2010-08-09 13:37:56 -07001172 /*
1173 * If being flinged and user touches, stop the fling. isFinished
1174 * will be false if being flinged.
1175 */
1176 if (!mScroller.isFinished()) {
Adam Cohen8bdbaab2013-10-29 15:25:02 -07001177 abortScrollerAnimation(false);
Winson Chung321e9ee2010-08-09 13:37:56 -07001178 }
1179
1180 // Remember where the motion event started
Vinit Nayaka406f722019-12-19 11:50:55 -08001181 mDownMotionX = ev.getX();
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001182 mDownMotionY = ev.getY();
Vinit Nayaka406f722019-12-19 11:50:55 -08001183 mDownMotionPrimary = mLastMotion = mOrientationHandler.getPrimaryDirection(ev, 0);
1184 mLastMotionRemainder = 0;
1185 mTotalMotion = 0;
Winson Chung4941f652020-06-18 15:11:53 -07001186 mAllowEasyFling = false;
Winson Chung321e9ee2010-08-09 13:37:56 -07001187 mActivePointerId = ev.getPointerId(0);
Sunny Goyalaad33592018-08-07 17:20:35 -07001188 if (mIsBeingDragged) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001189 pageBeginTransition();
Michael Jurka0142d492010-08-25 17:46:15 -07001190 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001191 break;
1192
Winson Chung4941f652020-06-18 15:11:53 -07001193 case ACTION_MOVE_ALLOW_EASY_FLING:
1194 // Start scrolling immediately
1195 determineScrollingStart(ev);
1196 mAllowEasyFling = true;
1197 break;
1198
1199 case MotionEvent.ACTION_MOVE:
1200 if (mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001201 // Scroll to follow the motion event
1202 final int pointerIndex = ev.findPointerIndex(mActivePointerId);
Adam Cohen7d30a372013-07-01 17:03:59 -07001203
1204 if (pointerIndex == -1) return true;
Sunny Goyalc39db732021-04-03 01:20:21 -07001205 float oldScroll = mOrientationHandler.getPrimaryScroll(this);
1206 float dx = ev.getX(pointerIndex);
1207 float dy = ev.getY(pointerIndex);
Adam Cohen7d30a372013-07-01 17:03:59 -07001208
Sunny Goyalc39db732021-04-03 01:20:21 -07001209 float direction = mOrientationHandler.getPrimaryValue(dx, dy);
Vinit Nayaka406f722019-12-19 11:50:55 -08001210 float delta = mLastMotion + mLastMotionRemainder - direction;
Sunny Goyalc39db732021-04-03 01:20:21 -07001211
1212 int width = getWidth();
1213 int height = getHeight();
1214 int size = mOrientationHandler.getPrimaryValue(width, height);
1215
1216 final float displacement = mOrientationHandler.getSecondaryValue(dx, dy)
1217 / mOrientationHandler.getSecondaryValue(width, height);
Vinit Nayaka406f722019-12-19 11:50:55 -08001218 mTotalMotion += Math.abs(delta);
Adam Cohenaefd4e12011-02-14 16:39:38 -08001219
Sunny Goyalc39db732021-04-03 01:20:21 -07001220 if (mAllowOverScroll) {
1221 float consumed = 0;
1222 if (delta < 0 && mEdgeGlowRight.getDistance() != 0f) {
1223 consumed = size * mEdgeGlowRight.onPullDistance(delta / size, displacement);
1224 } else if (delta > 0 && mEdgeGlowLeft.getDistance() != 0f) {
1225 consumed = -size * mEdgeGlowLeft.onPullDistance(
1226 -delta / size, 1 - displacement);
1227 }
1228 delta -= consumed;
1229 }
Alex Chau822acf42021-06-03 11:35:05 +01001230 delta /= mOrientationHandler.getPrimaryScale(this);
Sunny Goyalc39db732021-04-03 01:20:21 -07001231
Winson Chungc0844aa2011-02-02 15:25:58 -08001232 // Only scroll and update mLastMotionX if we have moved some discrete amount. We
1233 // keep the remainder because we are actually testing if we've moved from the last
1234 // scrolled position (which is discrete).
Sunny Goyalc39db732021-04-03 01:20:21 -07001235 mLastMotion = direction;
1236 int movedDelta = (int) delta;
1237 mLastMotionRemainder = delta - movedDelta;
Vinit Nayaka406f722019-12-19 11:50:55 -08001238
Sunny Goyalc39db732021-04-03 01:20:21 -07001239 if (delta != 0) {
1240 mOrientationHandler.set(this, VIEW_SCROLL_BY, movedDelta);
1241
1242 if (mAllowOverScroll) {
1243 final float pulledToX = oldScroll + delta;
1244
1245 if (pulledToX < mMinScroll) {
1246 mEdgeGlowLeft.onPullDistance(-delta / size, 1.f - displacement);
1247 if (!mEdgeGlowRight.isFinished()) {
1248 mEdgeGlowRight.onRelease();
1249 }
1250 } else if (pulledToX > mMaxScroll) {
1251 mEdgeGlowRight.onPullDistance(delta / size, displacement);
1252 if (!mEdgeGlowLeft.isFinished()) {
1253 mEdgeGlowLeft.onRelease();
1254 }
1255 }
1256
1257 if (!mEdgeGlowLeft.isFinished() || !mEdgeGlowRight.isFinished()) {
1258 postInvalidateOnAnimation();
1259 }
1260 }
1261
Winson Chung321e9ee2010-08-09 13:37:56 -07001262 } else {
1263 awakenScrollBars();
1264 }
Adam Cohen564976a2010-10-13 18:52:07 -07001265 } else {
Winson Chung321e9ee2010-08-09 13:37:56 -07001266 determineScrollingStart(ev);
1267 }
1268 break;
1269
1270 case MotionEvent.ACTION_UP:
Sunny Goyalaad33592018-08-07 17:20:35 -07001271 if (mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001272 final int activePointerId = mActivePointerId;
1273 final int pointerIndex = ev.findPointerIndex(activePointerId);
Vinit Nayak93bf1fe2020-05-26 17:22:13 -07001274 if (pointerIndex == -1) return true;
1275
Vinit Nayaka406f722019-12-19 11:50:55 -08001276 final float primaryDirection = mOrientationHandler.getPrimaryDirection(ev,
1277 pointerIndex);
Sunny Goyal4bb8b062019-02-19 16:37:38 -08001278 final VelocityTracker velocityTracker = mVelocityTracker;
1279 velocityTracker.computeCurrentVelocity(1000, mMaximumVelocity);
Adam Cohenaefd4e12011-02-14 16:39:38 -08001280
Vinit Nayaka406f722019-12-19 11:50:55 -08001281 int velocity = (int) mOrientationHandler.getPrimaryVelocity(velocityTracker,
1282 mActivePointerId);
Alex Chau822acf42021-06-03 11:35:05 +01001283 float delta = primaryDirection - mDownMotionPrimary;
1284 delta /= mOrientationHandler.getPrimaryScale(this);
Vinit Nayaka406f722019-12-19 11:50:55 -08001285 int pageOrientedSize = mOrientationHandler.getMeasuredSize(getPageAt(mCurrentPage));
1286
Alex Chau822acf42021-06-03 11:35:05 +01001287 boolean isSignificantMove = Math.abs(delta)
1288 > pageOrientedSize * getSignificantMoveThreshold();
Vinit Nayaka406f722019-12-19 11:50:55 -08001289
1290 mTotalMotion += Math.abs(mLastMotion + mLastMotionRemainder - primaryDirection);
Winson Chung4941f652020-06-18 15:11:53 -07001291 boolean passedSlop = mAllowEasyFling || mTotalMotion > mPageSlop;
1292 boolean isFling = passedSlop && shouldFlingForVelocity(velocity);
Vinit Nayaka406f722019-12-19 11:50:55 -08001293 boolean isDeltaLeft = mIsRtl ? delta > 0 : delta < 0;
1294 boolean isVelocityLeft = mIsRtl ? velocity > 0 : velocity < 0;
Winson Chung4941f652020-06-18 15:11:53 -07001295 if (DEBUG_FAILED_QUICKSWITCH && !isFling && mAllowEasyFling) {
1296 Log.d("Quickswitch", "isFling=false vel=" + velocity
1297 + " threshold=" + mEasyFlingThresholdVelocity);
1298 }
Adam Cohen00481b32011-11-18 12:03:48 -08001299
Adam Cohenf358a4b2013-07-23 16:47:31 -07001300 if (!mFreeScroll) {
1301 // In the case that the page is moved far to one direction and then is flung
1302 // in the opposite direction, we use a threshold to determine whether we should
1303 // just return to the starting page, or if we should skip one further.
1304 boolean returnToOriginalPage = false;
Vinit Nayaka406f722019-12-19 11:50:55 -08001305 if (Math.abs(delta) > pageOrientedSize * RETURN_TO_ORIGINAL_PAGE_THRESHOLD &&
1306 Math.signum(velocity) != Math.signum(delta) && isFling) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001307 returnToOriginalPage = true;
1308 }
Adam Cohenaefd4e12011-02-14 16:39:38 -08001309
Adam Cohenf358a4b2013-07-23 16:47:31 -07001310 int finalPage;
1311 // We give flings precedence over large moves, which is why we short-circuit our
1312 // test for a large move if a fling has been registered. That is, a large
1313 // move to the left and fling to the right will register as a fling to the right.
Sunny Goyalb7b01352018-08-09 12:31:20 -07001314
Vinit Nayaka406f722019-12-19 11:50:55 -08001315 if (((isSignificantMove && !isDeltaLeft && !isFling) ||
1316 (isFling && !isVelocityLeft)) && mCurrentPage > 0) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +01001317 finalPage = returnToOriginalPage
1318 ? mCurrentPage : mCurrentPage - getPanelCount();
Vinit Nayaka406f722019-12-19 11:50:55 -08001319 snapToPageWithVelocity(finalPage, velocity);
1320 } else if (((isSignificantMove && isDeltaLeft && !isFling) ||
1321 (isFling && isVelocityLeft)) &&
Adam Cohenf358a4b2013-07-23 16:47:31 -07001322 mCurrentPage < getChildCount() - 1) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +01001323 finalPage = returnToOriginalPage
1324 ? mCurrentPage : mCurrentPage + getPanelCount();
Vinit Nayaka406f722019-12-19 11:50:55 -08001325 snapToPageWithVelocity(finalPage, velocity);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001326 } else {
1327 snapToDestination();
Adam Cohenf358a4b2013-07-23 16:47:31 -07001328 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001329 } else {
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001330 if (!mScroller.isFinished()) {
1331 abortScrollerAnimation(true);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001332 }
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001333
Vinit Nayaka406f722019-12-19 11:50:55 -08001334 int initialScroll = mOrientationHandler.getPrimaryScroll(this);
1335 int maxScroll = mMaxScroll;
1336 int minScroll = mMinScroll;
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001337
Vinit Nayaka406f722019-12-19 11:50:55 -08001338 if (((initialScroll >= maxScroll) && (isVelocityLeft || !isFling)) ||
1339 ((initialScroll <= minScroll) && (!isVelocityLeft || !isFling))) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001340 mScroller.springBack(initialScroll, 0, minScroll, maxScroll, 0, 0);
Alex Chaub794ea62021-02-03 18:00:30 +00001341 mNextPage = getDestinationPage();
Sunny Goyalb7b01352018-08-09 12:31:20 -07001342 } else {
Sunny Goyalc39db732021-04-03 01:20:21 -07001343 int velocity1 = -velocity;
1344 // Continue a scroll or fling in progress
1345 mScroller.fling(initialScroll, 0, velocity1, 0, minScroll, maxScroll, 0, 0,
1346 Math.round(getWidth() * 0.5f * OVERSCROLL_DAMP_FACTOR), 0);
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001347
Sunny Goyalc39db732021-04-03 01:20:21 -07001348 int finalPos = mScroller.getFinalX();
Alex Chaub794ea62021-02-03 18:00:30 +00001349 mNextPage = getDestinationPage(finalPos);
Sunny Goyalc39db732021-04-03 01:20:21 -07001350 onNotSnappingToPageInFreeScroll();
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001351 }
1352 invalidate();
Winson Chung321e9ee2010-08-09 13:37:56 -07001353 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001354 }
Adam Cohen7d30a372013-07-01 17:03:59 -07001355
Sunny Goyalc39db732021-04-03 01:20:21 -07001356 mEdgeGlowLeft.onRelease();
1357 mEdgeGlowRight.onRelease();
Adam Cohen7d30a372013-07-01 17:03:59 -07001358 // End any intermediate reordering states
1359 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001360 break;
1361
1362 case MotionEvent.ACTION_CANCEL:
Sunny Goyalaad33592018-08-07 17:20:35 -07001363 if (mIsBeingDragged) {
Michael Jurkab8f06722010-10-10 15:58:46 -07001364 snapToDestination();
1365 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001366 mEdgeGlowLeft.onRelease();
1367 mEdgeGlowRight.onRelease();
Adam Cohen7d30a372013-07-01 17:03:59 -07001368 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001369 break;
1370
1371 case MotionEvent.ACTION_POINTER_UP:
1372 onSecondaryPointerUp(ev);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001373 releaseVelocityTracker();
Winson Chung321e9ee2010-08-09 13:37:56 -07001374 break;
1375 }
1376
1377 return true;
1378 }
1379
Sunny Goyalc39db732021-04-03 01:20:21 -07001380 protected void onNotSnappingToPageInFreeScroll() { }
Alex Chaub794ea62021-02-03 18:00:30 +00001381
Vinit Nayaka406f722019-12-19 11:50:55 -08001382 protected boolean shouldFlingForVelocity(int velocity) {
Winson Chung4941f652020-06-18 15:11:53 -07001383 float threshold = mAllowEasyFling ? mEasyFlingThresholdVelocity : mFlingThresholdVelocity;
1384 return Math.abs(velocity) > threshold;
Sunny Goyal65d9ceb2017-05-08 09:17:42 -07001385 }
1386
Adam Cohen7d30a372013-07-01 17:03:59 -07001387 private void resetTouchState() {
1388 releaseVelocityTracker();
Sunny Goyalaad33592018-08-07 17:20:35 -07001389 mIsBeingDragged = false;
Adam Cohen7d30a372013-07-01 17:03:59 -07001390 mActivePointerId = INVALID_POINTER;
Adam Cohen7d30a372013-07-01 17:03:59 -07001391 }
1392
Winson Chung185d7162011-02-28 13:47:29 -08001393 @Override
1394 public boolean onGenericMotionEvent(MotionEvent event) {
1395 if ((event.getSource() & InputDevice.SOURCE_CLASS_POINTER) != 0) {
1396 switch (event.getAction()) {
1397 case MotionEvent.ACTION_SCROLL: {
1398 // Handle mouse (or ext. device) by shifting the page depending on the scroll
1399 final float vscroll;
1400 final float hscroll;
1401 if ((event.getMetaState() & KeyEvent.META_SHIFT_ON) != 0) {
1402 vscroll = 0;
1403 hscroll = event.getAxisValue(MotionEvent.AXIS_VSCROLL);
1404 } else {
1405 vscroll = -event.getAxisValue(MotionEvent.AXIS_VSCROLL);
1406 hscroll = event.getAxisValue(MotionEvent.AXIS_HSCROLL);
1407 }
Sunny Goyal8b37c572020-03-31 12:12:14 -07001408 if (!canScroll(Math.abs(vscroll), Math.abs(hscroll))) {
1409 return false;
Samuel Fufa59cba192019-08-22 18:31:34 -07001410 }
Winson Chung185d7162011-02-28 13:47:29 -08001411 if (hscroll != 0 || vscroll != 0) {
Sunny Goyal70660032015-05-14 00:07:08 -07001412 boolean isForwardScroll = mIsRtl ? (hscroll < 0 || vscroll < 0)
Adam Cohen0ffac432013-07-10 11:19:26 -07001413 : (hscroll > 0 || vscroll > 0);
1414 if (isForwardScroll) {
Winson Chung185d7162011-02-28 13:47:29 -08001415 scrollRight();
1416 } else {
1417 scrollLeft();
1418 }
1419 return true;
1420 }
1421 }
1422 }
1423 }
1424 return super.onGenericMotionEvent(event);
1425 }
1426
Sunny Goyal8b37c572020-03-31 12:12:14 -07001427 /**
1428 * Returns true if the paged view can scroll for the provided vertical and horizontal
1429 * scroll values
1430 */
1431 protected boolean canScroll(float absVScroll, float absHScroll) {
1432 ActivityContext ac = ActivityContext.lookupContext(getContext());
1433 return (ac == null || AbstractFloatingView.getTopOpenView(ac) == null);
Samuel Fufa59cba192019-08-22 18:31:34 -07001434 }
1435
Michael Jurkab8f06722010-10-10 15:58:46 -07001436 private void acquireVelocityTrackerAndAddMovement(MotionEvent ev) {
1437 if (mVelocityTracker == null) {
1438 mVelocityTracker = VelocityTracker.obtain();
1439 }
1440 mVelocityTracker.addMovement(ev);
1441 }
1442
1443 private void releaseVelocityTracker() {
1444 if (mVelocityTracker != null) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001445 mVelocityTracker.clear();
Michael Jurkab8f06722010-10-10 15:58:46 -07001446 mVelocityTracker.recycle();
1447 mVelocityTracker = null;
1448 }
1449 }
1450
Winson Chung321e9ee2010-08-09 13:37:56 -07001451 private void onSecondaryPointerUp(MotionEvent ev) {
Winson Chung4941f652020-06-18 15:11:53 -07001452 final int pointerIndex = ev.getActionIndex();
Winson Chung321e9ee2010-08-09 13:37:56 -07001453 final int pointerId = ev.getPointerId(pointerIndex);
1454 if (pointerId == mActivePointerId) {
1455 // This was our active pointer going up. Choose a new
1456 // active pointer and adjust accordingly.
1457 // TODO: Make this decision more intelligent.
1458 final int newPointerIndex = pointerIndex == 0 ? 1 : 0;
Vinit Nayaka406f722019-12-19 11:50:55 -08001459 mLastMotion = mDownMotionPrimary = mOrientationHandler.getPrimaryDirection(ev,
1460 newPointerIndex);
1461 mLastMotionRemainder = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -07001462 mActivePointerId = ev.getPointerId(newPointerIndex);
1463 if (mVelocityTracker != null) {
1464 mVelocityTracker.clear();
1465 }
1466 }
Jeff Brown1d0867c2010-12-02 18:27:39 -08001467 }
1468
Winson Chung321e9ee2010-08-09 13:37:56 -07001469 @Override
1470 public void requestChildFocus(View child, View focused) {
1471 super.requestChildFocus(child, focused);
Andras Kloczl359d1ae2021-05-04 22:25:27 +02001472
1473 // In case the device is controlled by a controller, mCurrentPage isn't updated properly
1474 // which results in incorrect navigation
1475 int nextPage = getNextPage();
1476 if (nextPage != mCurrentPage) {
1477 setCurrentPage(nextPage);
1478 }
1479
Adam Cohenae4f1552011-10-20 00:15:42 -07001480 int page = indexToPage(indexOfChild(child));
Winson Chung97d85d22011-04-13 11:27:36 -07001481 if (page >= 0 && page != getCurrentPage() && !isInTouchMode()) {
Winson Chung86f77532010-08-24 11:08:22 -07001482 snapToPage(page);
Winson Chung321e9ee2010-08-09 13:37:56 -07001483 }
1484 }
1485
Alex Chaub794ea62021-02-03 18:00:30 +00001486 public int getDestinationPage() {
1487 return getDestinationPage(mOrientationHandler.getPrimaryScroll(this));
1488 }
1489
Alex Chaudedbc8a2021-03-17 16:53:26 +00001490 protected int getDestinationPage(int primaryScroll) {
1491 return getPageNearestToCenterOfScreen(primaryScroll);
Alex Chaub794ea62021-02-03 18:00:30 +00001492 }
1493
Sunny Goyal228153d2018-01-04 15:35:22 -08001494 public int getPageNearestToCenterOfScreen() {
Vinit Nayaka406f722019-12-19 11:50:55 -08001495 return getPageNearestToCenterOfScreen(mOrientationHandler.getPrimaryScroll(this));
Tony Wickham8f7ead32016-04-07 18:46:44 -07001496 }
1497
Alex Chaudedbc8a2021-03-17 16:53:26 +00001498 private int getPageNearestToCenterOfScreen(int primaryScroll) {
1499 int screenCenter = getScreenCenter(primaryScroll);
Adam Cohen22f823d2011-09-01 17:22:18 -07001500 int minDistanceFromScreenCenter = Integer.MAX_VALUE;
Winson Chung321e9ee2010-08-09 13:37:56 -07001501 int minDistanceFromScreenCenterIndex = -1;
Winson Chung321e9ee2010-08-09 13:37:56 -07001502 final int childCount = getChildCount();
1503 for (int i = 0; i < childCount; ++i) {
Tony Wickham7383d4e2020-07-07 19:25:25 -07001504 int distanceFromScreenCenter = Math.abs(
1505 getDisplacementFromScreenCenter(i, screenCenter));
Winson Chung321e9ee2010-08-09 13:37:56 -07001506 if (distanceFromScreenCenter < minDistanceFromScreenCenter) {
1507 minDistanceFromScreenCenter = distanceFromScreenCenter;
1508 minDistanceFromScreenCenterIndex = i;
1509 }
1510 }
Adam Cohend19d3ca2010-09-15 14:43:42 -07001511 return minDistanceFromScreenCenterIndex;
1512 }
1513
Tony Wickham7383d4e2020-07-07 19:25:25 -07001514 private int getDisplacementFromScreenCenter(int childIndex, int screenCenter) {
Alex Chaudedbc8a2021-03-17 16:53:26 +00001515 int childSize = Math.round(getChildVisibleSize(childIndex));
Tony Wickham7383d4e2020-07-07 19:25:25 -07001516 int halfChildSize = (childSize / 2);
1517 int childCenter = getChildOffset(childIndex) + halfChildSize;
1518 return childCenter - screenCenter;
1519 }
1520
1521 protected int getDisplacementFromScreenCenter(int childIndex) {
Alex Chaudedbc8a2021-03-17 16:53:26 +00001522 int primaryScroll = mOrientationHandler.getPrimaryScroll(this);
1523 int screenCenter = getScreenCenter(primaryScroll);
Tony Wickham7383d4e2020-07-07 19:25:25 -07001524 return getDisplacementFromScreenCenter(childIndex, screenCenter);
1525 }
1526
Alex Chaudedbc8a2021-03-17 16:53:26 +00001527 private int getScreenCenter(int primaryScroll) {
1528 float primaryScale = mOrientationHandler.getPrimaryScale(this);
1529 float primaryPivot = mOrientationHandler.getPrimaryValue(getPivotX(), getPivotY());
1530 int pageOrientationSize = mOrientationHandler.getMeasuredSize(this);
1531 return Math.round(primaryScroll + (pageOrientationSize / 2f - primaryPivot) / primaryScale
1532 + primaryPivot);
1533 }
1534
Adam Cohend19d3ca2010-09-15 14:43:42 -07001535 protected void snapToDestination() {
Sunny Goyalc39db732021-04-03 01:20:21 -07001536 snapToPage(getDestinationPage(), PAGE_SNAP_ANIMATION_DURATION);
Winson Chung321e9ee2010-08-09 13:37:56 -07001537 }
1538
Adam Cohene0f66b52010-11-23 15:06:07 -08001539 // We want the duration of the page snap animation to be influenced by the distance that
1540 // the screen has to travel, however, we don't want this duration to be effected in a
1541 // purely linear fashion. Instead, we use this method to moderate the effect that the distance
1542 // of travel has on the overall snap duration.
Sunny Goyal4d113a52015-05-27 10:05:28 -07001543 private float distanceInfluenceForSnapDuration(float f) {
Adam Cohene0f66b52010-11-23 15:06:07 -08001544 f -= 0.5f; // center the values about 0.
1545 f *= 0.3f * Math.PI / 2.0f;
1546 return (float) Math.sin(f);
1547 }
1548
Winson Chung05a31ed2018-02-08 17:08:43 -08001549 protected boolean snapToPageWithVelocity(int whichPage, int velocity) {
Adam Cohen6f127a62014-06-12 14:54:41 -07001550 whichPage = validateNewPage(whichPage);
Vinit Nayaka406f722019-12-19 11:50:55 -08001551 int halfScreenSize = mOrientationHandler.getMeasuredSize(this) / 2;
Adam Cohene0f66b52010-11-23 15:06:07 -08001552
Vinit Nayaka406f722019-12-19 11:50:55 -08001553 final int newLoc = getScrollForPage(whichPage);
Sunny Goyalc39db732021-04-03 01:20:21 -07001554 int delta = newLoc - mOrientationHandler.getPrimaryScroll(this);
Adam Cohene0f66b52010-11-23 15:06:07 -08001555 int duration = 0;
1556
Sunny Goyal4d113a52015-05-27 10:05:28 -07001557 if (Math.abs(velocity) < mMinFlingVelocity) {
Adam Cohene0f66b52010-11-23 15:06:07 -08001558 // If the velocity is low enough, then treat this more as an automatic page advance
1559 // as opposed to an apparent physical response to flinging
Winson Chung05a31ed2018-02-08 17:08:43 -08001560 return snapToPage(whichPage, PAGE_SNAP_ANIMATION_DURATION);
Adam Cohene0f66b52010-11-23 15:06:07 -08001561 }
1562
1563 // Here we compute a "distance" that will be used in the computation of the overall
1564 // snap duration. This is a function of the actual distance that needs to be traveled;
1565 // we keep this value close to half screen size in order to reduce the variance in snap
1566 // duration as a function of the distance the page needs to travel.
Michael Jurka20b7ca92011-06-07 20:09:16 -07001567 float distanceRatio = Math.min(1f, 1.0f * Math.abs(delta) / (2 * halfScreenSize));
Adam Cohene0f66b52010-11-23 15:06:07 -08001568 float distance = halfScreenSize + halfScreenSize *
1569 distanceInfluenceForSnapDuration(distanceRatio);
1570
1571 velocity = Math.abs(velocity);
Adam Cohen265b9a62011-12-07 14:37:18 -08001572 velocity = Math.max(mMinSnapVelocity, velocity);
Adam Cohene0f66b52010-11-23 15:06:07 -08001573
1574 // we want the page's snap velocity to approximately match the velocity at which the
1575 // user flings, so we scale the duration by a value near to the derivative of the scroll
Michael Jurka20b7ca92011-06-07 20:09:16 -07001576 // interpolator at zero, ie. 5. We use 4 to make it a little slower.
1577 duration = 4 * Math.round(1000 * Math.abs(distance / velocity));
Adam Cohene0f66b52010-11-23 15:06:07 -08001578
Sunny Goyalc39db732021-04-03 01:20:21 -07001579 return snapToPage(whichPage, delta, duration);
Michael Jurka0142d492010-08-25 17:46:15 -07001580 }
1581
Winson Chung05a31ed2018-02-08 17:08:43 -08001582 public boolean snapToPage(int whichPage) {
1583 return snapToPage(whichPage, PAGE_SNAP_ANIMATION_DURATION);
Winson Chung321e9ee2010-08-09 13:37:56 -07001584 }
1585
Winson Chung05a31ed2018-02-08 17:08:43 -08001586 public boolean snapToPageImmediately(int whichPage) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001587 return snapToPage(whichPage, PAGE_SNAP_ANIMATION_DURATION, true);
Adam Cohen7d30a372013-07-01 17:03:59 -07001588 }
1589
Winson Chung05a31ed2018-02-08 17:08:43 -08001590 public boolean snapToPage(int whichPage, int duration) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001591 return snapToPage(whichPage, duration, false);
Adam Cohen7d30a372013-07-01 17:03:59 -07001592 }
1593
Sunny Goyalc39db732021-04-03 01:20:21 -07001594 protected boolean snapToPage(int whichPage, int duration, boolean immediate) {
Adam Cohen6f127a62014-06-12 14:54:41 -07001595 whichPage = validateNewPage(whichPage);
Winson Chung321e9ee2010-08-09 13:37:56 -07001596
Vinit Nayaka406f722019-12-19 11:50:55 -08001597 int newLoc = getScrollForPage(whichPage);
Sunny Goyalc39db732021-04-03 01:20:21 -07001598 final int delta = newLoc - mOrientationHandler.getPrimaryScroll(this);
1599 return snapToPage(whichPage, delta, duration, immediate);
Michael Jurka0142d492010-08-25 17:46:15 -07001600 }
1601
Winson Chung05a31ed2018-02-08 17:08:43 -08001602 protected boolean snapToPage(int whichPage, int delta, int duration) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001603 return snapToPage(whichPage, delta, duration, false);
Adam Cohen7d30a372013-07-01 17:03:59 -07001604 }
Michael Jurka0142d492010-08-25 17:46:15 -07001605
Sunny Goyalc39db732021-04-03 01:20:21 -07001606 protected boolean snapToPage(int whichPage, int delta, int duration, boolean immediate) {
Sunny Goyal9bb8ffb2018-05-24 17:11:16 -07001607 if (mFirstLayout) {
1608 setCurrentPage(whichPage);
1609 return false;
1610 }
Tony Wickhamd58c2d52018-05-04 12:10:55 -07001611
Andy Wickhamda5a89b2021-07-23 12:38:14 -10001612 if (FeatureFlags.IS_STUDIO_BUILD && !Utilities.IS_RUNNING_IN_TEST_HARNESS) {
Tony Wickhamcb3f8702018-08-27 17:36:03 -07001613 duration *= Settings.Global.getFloat(getContext().getContentResolver(),
1614 Settings.Global.WINDOW_ANIMATION_SCALE, 1);
Tony Wickhamd58c2d52018-05-04 12:10:55 -07001615 }
1616
Adam Cohen6f127a62014-06-12 14:54:41 -07001617 whichPage = validateNewPage(whichPage);
1618
Adam Cohen7d30a372013-07-01 17:03:59 -07001619 mNextPage = whichPage;
Michael Jurka0142d492010-08-25 17:46:15 -07001620
Winson Chung321e9ee2010-08-09 13:37:56 -07001621 awakenScrollBars(duration);
Adam Cohen7d30a372013-07-01 17:03:59 -07001622 if (immediate) {
1623 duration = 0;
1624 } else if (duration == 0) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001625 duration = Math.abs(delta);
1626 }
1627
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001628 if (duration != 0) {
1629 pageBeginTransition();
1630 }
1631
Adam Cohenf358a4b2013-07-23 16:47:31 -07001632 if (!mScroller.isFinished()) {
Adam Cohenf9618852013-11-08 06:45:03 -08001633 abortScrollerAnimation(false);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001634 }
Adam Cohenf9618852013-11-08 06:45:03 -08001635
Sunny Goyalc39db732021-04-03 01:20:21 -07001636 mScroller.startScroll(mOrientationHandler.getPrimaryScroll(this), 0, delta, 0, duration);
Adam Cohen674531f2013-12-13 15:07:14 -08001637 updatePageIndicator();
Adam Cohen7d30a372013-07-01 17:03:59 -07001638
1639 // Trigger a compute() to finish switching pages if necessary
1640 if (immediate) {
1641 computeScroll();
Sunny Goyal76dbf6f2017-01-03 14:55:47 -08001642 pageEndTransition();
Adam Cohen7d30a372013-07-01 17:03:59 -07001643 }
1644
Winson Chung321e9ee2010-08-09 13:37:56 -07001645 invalidate();
Winson Chung05a31ed2018-02-08 17:08:43 -08001646 return Math.abs(delta) > 0;
Winson Chung321e9ee2010-08-09 13:37:56 -07001647 }
1648
Vadim Tryshev98913d02018-05-18 18:41:34 -07001649 public boolean scrollLeft() {
1650 if (getNextPage() > 0) {
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001651 snapToPage(getNextPage() - getPanelCount());
Vadim Tryshev98913d02018-05-18 18:41:34 -07001652 return true;
1653 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001654 return mAllowOverScroll;
Winson Chung321e9ee2010-08-09 13:37:56 -07001655 }
1656
Vadim Tryshev98913d02018-05-18 18:41:34 -07001657 public boolean scrollRight() {
1658 if (getNextPage() < getChildCount() - 1) {
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001659 snapToPage(getNextPage() + getPanelCount());
Vadim Tryshev98913d02018-05-18 18:41:34 -07001660 return true;
1661 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001662 return mAllowOverScroll;
Winson Chung321e9ee2010-08-09 13:37:56 -07001663 }
1664
Vadim Trysheve6bbefb2018-04-03 13:38:06 -07001665 @Override
1666 public CharSequence getAccessibilityClassName() {
1667 // Some accessibility services have special logic for ScrollView. Since we provide same
1668 // accessibility info as ScrollView, inform the service to handle use the same way.
1669 return ScrollView.class.getName();
1670 }
1671
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001672 protected boolean isPageOrderFlipped() {
1673 return false;
1674 }
1675
Winson Chung6a0f57d2011-06-29 20:10:49 -07001676 /* Accessibility */
Sunny Goyalcf25b522015-07-09 00:01:18 -07001677 @SuppressWarnings("deprecation")
Winson Chung6a0f57d2011-06-29 20:10:49 -07001678 @Override
1679 public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) {
1680 super.onInitializeAccessibilityNodeInfo(info);
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001681 final boolean pagesFlipped = isPageOrderFlipped();
Pinyao Tingaf6daa22019-09-18 22:18:03 +00001682 int offset = (mAllowOverScroll ? 0 : 1);
1683 info.setScrollable(getPageCount() > offset);
1684 if (getCurrentPage() < getPageCount() - offset) {
yingleiw02cc8482019-08-02 16:14:27 -07001685 info.addAction(pagesFlipped ?
1686 AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_BACKWARD
1687 : AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_FORWARD);
1688 info.addAction(mIsRtl ?
1689 AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_LEFT
1690 : AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_RIGHT);
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001691 }
Pinyao Tingaf6daa22019-09-18 22:18:03 +00001692 if (getCurrentPage() >= offset) {
yingleiw02cc8482019-08-02 16:14:27 -07001693 info.addAction(pagesFlipped ?
1694 AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_FORWARD
1695 : AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_BACKWARD);
1696 info.addAction(mIsRtl ?
1697 AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_RIGHT
1698 : AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_LEFT);
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001699 }
Vadim Tryshev7af0d442015-05-15 08:48:11 -07001700 // Accessibility-wise, PagedView doesn't support long click, so disabling it.
1701 // Besides disabling the accessibility long-click, this also prevents this view from getting
1702 // accessibility focus.
1703 info.setLongClickable(false);
Sunny Goyala52ecb02016-12-16 15:04:51 -08001704 info.removeAction(AccessibilityNodeInfo.AccessibilityAction.ACTION_LONG_CLICK);
Winson Chung6a0f57d2011-06-29 20:10:49 -07001705 }
1706
1707 @Override
Alan Viverette254139a2013-10-08 13:13:46 -07001708 public void sendAccessibilityEvent(int eventType) {
1709 // Don't let the view send real scroll events.
1710 if (eventType != AccessibilityEvent.TYPE_VIEW_SCROLLED) {
1711 super.sendAccessibilityEvent(eventType);
1712 }
1713 }
1714
1715 @Override
Winson Chung6a0f57d2011-06-29 20:10:49 -07001716 public void onInitializeAccessibilityEvent(AccessibilityEvent event) {
1717 super.onInitializeAccessibilityEvent(event);
Pinyao Tingaf6daa22019-09-18 22:18:03 +00001718 event.setScrollable(mAllowOverScroll || getPageCount() > 1);
Winson Chung6a0f57d2011-06-29 20:10:49 -07001719 }
1720
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001721 @Override
1722 public boolean performAccessibilityAction(int action, Bundle arguments) {
1723 if (super.performAccessibilityAction(action, arguments)) {
1724 return true;
1725 }
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001726 final boolean pagesFlipped = isPageOrderFlipped();
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001727 switch (action) {
1728 case AccessibilityNodeInfo.ACTION_SCROLL_FORWARD: {
Vadim Tryshev98913d02018-05-18 18:41:34 -07001729 if (pagesFlipped ? scrollLeft() : scrollRight()) {
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001730 return true;
1731 }
1732 } break;
1733 case AccessibilityNodeInfo.ACTION_SCROLL_BACKWARD: {
Vadim Tryshev98913d02018-05-18 18:41:34 -07001734 if (pagesFlipped ? scrollRight() : scrollLeft()) {
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001735 return true;
1736 }
yingleiw02cc8482019-08-02 16:14:27 -07001737 } break;
1738 case android.R.id.accessibilityActionPageRight: {
1739 if (!mIsRtl) {
1740 return scrollRight();
1741 } else {
1742 return scrollLeft();
1743 }
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001744 }
yingleiw02cc8482019-08-02 16:14:27 -07001745 case android.R.id.accessibilityActionPageLeft: {
1746 if (!mIsRtl) {
1747 return scrollLeft();
1748 } else {
1749 return scrollRight();
1750 }
1751 }
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001752 }
1753 return false;
1754 }
1755
Vadim Tryshev2c430b32018-04-04 14:45:21 -07001756 protected boolean canAnnouncePageDescription() {
1757 return true;
1758 }
1759
Adam Cohen0ffac432013-07-10 11:19:26 -07001760 protected String getCurrentPageDescription() {
Sunny Goyalf4f89ef2015-09-02 15:06:12 -07001761 return getContext().getString(R.string.default_scroll_format,
Adam Cohen0ffac432013-07-10 11:19:26 -07001762 getNextPage() + 1, getChildCount());
1763 }
1764
Tony Mak2e564402018-02-27 17:19:34 +00001765 protected float getDownMotionX() {
1766 return mDownMotionX;
1767 }
1768
1769 protected float getDownMotionY() {
1770 return mDownMotionY;
1771 }
1772
Sunny Goyal20a13ff2018-03-13 16:44:00 -07001773 protected interface ComputePageScrollsLogic {
1774
1775 boolean shouldIncludeView(View view);
1776 }
Vadim Tryshev528b9e02018-05-24 18:22:03 -07001777
1778 public int[] getVisibleChildrenRange() {
1779 float visibleLeft = 0;
1780 float visibleRight = visibleLeft + getMeasuredWidth();
1781 float scaleX = getScaleX();
1782 if (scaleX < 1 && scaleX > 0) {
1783 float mid = getMeasuredWidth() / 2;
1784 visibleLeft = mid - ((mid - visibleLeft) / scaleX);
1785 visibleRight = mid + ((visibleRight - mid) / scaleX);
1786 }
1787
1788 int leftChild = -1;
1789 int rightChild = -1;
1790 final int childCount = getChildCount();
1791 for (int i = 0; i < childCount; i++) {
1792 final View child = getPageAt(i);
1793
1794 float left = child.getLeft() + child.getTranslationX() - getScrollX();
1795 if (left <= visibleRight && (left + child.getMeasuredWidth()) >= visibleLeft) {
1796 if (leftChild == -1) {
1797 leftChild = i;
1798 }
1799 rightChild = i;
1800 }
1801 }
1802 mTmpIntPair[0] = leftChild;
1803 mTmpIntPair[1] = rightChild;
1804 return mTmpIntPair;
1805 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001806
1807 @Override
1808 public void draw(Canvas canvas) {
1809 super.draw(canvas);
1810 drawEdgeEffect(canvas);
Sunny Goyal05b59c02021-04-29 13:55:40 -07001811 pageEndTransition();
Sunny Goyalc39db732021-04-03 01:20:21 -07001812 }
1813
1814 protected void drawEdgeEffect(Canvas canvas) {
1815 if (mAllowOverScroll && (!mEdgeGlowRight.isFinished() || !mEdgeGlowLeft.isFinished())) {
1816 final int width = getWidth();
1817 final int height = getHeight();
1818 if (!mEdgeGlowLeft.isFinished()) {
1819 final int restoreCount = canvas.save();
1820 canvas.rotate(-90);
1821 canvas.translate(-height, Math.min(mMinScroll, getScrollX()));
1822 mEdgeGlowLeft.setSize(height, width);
1823 if (mEdgeGlowLeft.draw(canvas)) {
1824 postInvalidateOnAnimation();
1825 }
1826 canvas.restoreToCount(restoreCount);
1827 }
1828 if (!mEdgeGlowRight.isFinished()) {
1829 final int restoreCount = canvas.save();
1830 canvas.rotate(90, width, 0);
1831 canvas.translate(width, -(Math.max(mMaxScroll, getScrollX())));
1832
1833 mEdgeGlowRight.setSize(height, width);
1834 if (mEdgeGlowRight.draw(canvas)) {
1835 postInvalidateOnAnimation();
1836 }
1837 canvas.restoreToCount(restoreCount);
1838 }
1839 }
1840 }
Adam Cohen5084cba2013-09-03 12:01:16 -07001841}