blob: 3f7a3ad852b34c64a48ff77aa4b0a65c975b766c [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;
Thales Limae4457742021-07-20 16:46:38 +0100712 int panelCount = getPanelCount();
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700713
Vinit Nayaka406f722019-12-19 11:50:55 -0800714 for (int i = startIndex, childStart = scrollOffsetStart; i != endIndex; i += delta) {
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700715 final View child = getPageAt(i);
716 if (scrollLogic.shouldIncludeView(child)) {
Vinit Nayaka406f722019-12-19 11:50:55 -0800717 ChildBounds bounds = mOrientationHandler.getChildBounds(child, childStart,
718 pageCenter, layoutChildren);
719 final int primaryDimension = bounds.primaryDimension;
720 final int childPrimaryEnd = bounds.childPrimaryEnd;
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700721
Alex Chaub5c4d112021-03-29 17:37:53 +0100722 // In case the pages are of different width, align the page to left edge for non-RTL
723 // or right edge for RTL.
724 final int pageScroll =
725 mIsRtl ? childPrimaryEnd - scrollOffsetEnd : childStart - scrollOffsetStart;
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700726 if (outPageScrolls[i] != pageScroll) {
727 pageScrollChanged = true;
728 outPageScrolls[i] = pageScroll;
729 }
Thales Limae4457742021-07-20 16:46:38 +0100730 childStart += primaryDimension + getChildGap();
731
732 // This makes sure that the space is added after the page, not after each panel
733 if (i % panelCount == panelCount - 1) {
734 childStart += mPageSpacing;
735 }
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700736 }
737 }
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100738
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100739 if (panelCount > 1) {
740 for (int i = 0; i < childCount; i++) {
741 // In case we have multiple panels, always use left panel's page scroll for all
742 // panels on the screen.
743 int adjustedScroll = outPageScrolls[getLeftmostVisiblePageForIndex(i)];
744 if (outPageScrolls[i] != adjustedScroll) {
745 outPageScrolls[i] = adjustedScroll;
746 pageScrollChanged = true;
747 }
748 }
749 }
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700750 return pageScrollChanged;
751 }
752
Sunny Goyala1fbd842015-05-20 13:40:27 -0700753 protected int getChildGap() {
754 return 0;
755 }
756
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700757 protected void updateMinAndMaxScrollX() {
Vinit Nayaka406f722019-12-19 11:50:55 -0800758 mMinScroll = computeMinScroll();
759 mMaxScroll = computeMaxScroll();
Tony Wickhamf549dab2016-05-16 09:54:06 -0700760 }
761
Vinit Nayaka406f722019-12-19 11:50:55 -0800762 protected int computeMinScroll() {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700763 return 0;
Tony50876bf2018-09-19 23:09:14 -0400764 }
765
Vinit Nayaka406f722019-12-19 11:50:55 -0800766 protected int computeMaxScroll() {
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700767 int childCount = getChildCount();
768 if (childCount > 0) {
Sunny Goyal70660032015-05-14 00:07:08 -0700769 final int index = mIsRtl ? 0 : childCount - 1;
Tony Wickhamf549dab2016-05-16 09:54:06 -0700770 return getScrollForPage(index);
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700771 } else {
Tony Wickhamf549dab2016-05-16 09:54:06 -0700772 return 0;
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700773 }
774 }
775
Adam Cohen3b185e22013-10-29 14:45:58 -0700776 public void setPageSpacing(int pageSpacing) {
777 mPageSpacing = pageSpacing;
778 requestLayout();
779 }
780
Tony50876bf2018-09-19 23:09:14 -0400781 public int getPageSpacing() {
782 return mPageSpacing;
783 }
784
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800785 private void dispatchPageCountChanged() {
786 if (mPageIndicator != null) {
787 mPageIndicator.setMarkersCount(getChildCount());
Winson Chungd2be3812013-07-16 11:11:32 -0700788 }
Adam Cohen2591f6a2011-10-25 14:36:40 -0700789 // This ensures that when children are added, they get the correct transforms / alphas
790 // in accordance with any scroll effects.
Adam Cohen2591f6a2011-10-25 14:36:40 -0700791 invalidate();
792 }
793
Michael Jurka8b805b12012-04-18 14:23:14 -0700794 @Override
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800795 public void onViewAdded(View child) {
Winson Chungc7c51582018-02-23 17:58:36 -0800796 super.onViewAdded(child);
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800797 dispatchPageCountChanged();
798 }
799
800 @Override
801 public void onViewRemoved(View child) {
Winson Chungc7c51582018-02-23 17:58:36 -0800802 super.onViewRemoved(child);
Tonya361c722017-07-04 09:43:06 -0700803 mCurrentPage = validateNewPage(mCurrentPage);
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800804 dispatchPageCountChanged();
Winson Chungd2be3812013-07-16 11:11:32 -0700805 }
806
Adam Cohen73894962011-10-31 13:17:17 -0700807 protected int getChildOffset(int index) {
Adam Cohen7d30a372013-07-01 17:03:59 -0700808 if (index < 0 || index > getChildCount() - 1) return 0;
Vinit Nayaka406f722019-12-19 11:50:55 -0800809 View pageAtIndex = getPageAt(index);
810 return mOrientationHandler.getChildStart(pageAtIndex);
Adam Cohen73894962011-10-31 13:17:17 -0700811 }
812
Alex Chau7944ee52021-01-08 19:07:25 +0000813 protected int getChildVisibleSize(int index) {
814 View layout = getPageAt(index);
815 return mOrientationHandler.getMeasuredSize(layout);
816 }
817
Winson Chung321e9ee2010-08-09 13:37:56 -0700818 @Override
819 public boolean requestChildRectangleOnScreen(View child, Rect rectangle, boolean immediate) {
Adam Cohenae4f1552011-10-20 00:15:42 -0700820 int page = indexToPage(indexOfChild(child));
Winson Chung86f77532010-08-24 11:08:22 -0700821 if (page != mCurrentPage || !mScroller.isFinished()) {
Vadim Trysheveeaa8ee2018-04-11 12:23:42 -0700822 if (immediate) {
823 setCurrentPage(page);
824 } else {
825 snapToPage(page);
826 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700827 return true;
828 }
829 return false;
830 }
831
832 @Override
833 protected boolean onRequestFocusInDescendants(int direction, Rect previouslyFocusedRect) {
Winson Chung86f77532010-08-24 11:08:22 -0700834 int focusablePage;
835 if (mNextPage != INVALID_PAGE) {
836 focusablePage = mNextPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700837 } else {
Winson Chung86f77532010-08-24 11:08:22 -0700838 focusablePage = mCurrentPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700839 }
Winson Chung86f77532010-08-24 11:08:22 -0700840 View v = getPageAt(focusablePage);
Winson Chung321e9ee2010-08-09 13:37:56 -0700841 if (v != null) {
Adam Cohen76fc0852011-06-17 13:26:23 -0700842 return v.requestFocus(direction, previouslyFocusedRect);
Winson Chung321e9ee2010-08-09 13:37:56 -0700843 }
844 return false;
845 }
846
847 @Override
848 public boolean dispatchUnhandledMove(View focused, int direction) {
Sunny Goyal0c4e3722015-12-01 13:21:49 -0800849 if (super.dispatchUnhandledMove(focused, direction)) {
850 return true;
851 }
852
853 if (mIsRtl) {
854 if (direction == View.FOCUS_LEFT) {
855 direction = View.FOCUS_RIGHT;
856 } else if (direction == View.FOCUS_RIGHT) {
857 direction = View.FOCUS_LEFT;
858 }
859 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700860 if (direction == View.FOCUS_LEFT) {
Winson Chung86f77532010-08-24 11:08:22 -0700861 if (getCurrentPage() > 0) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100862 int nextPage = validateNewPage(getCurrentPage() - 1);
863 snapToPage(nextPage);
864 getChildAt(nextPage).requestFocus(direction);
Winson Chung321e9ee2010-08-09 13:37:56 -0700865 return true;
866 }
867 } else if (direction == View.FOCUS_RIGHT) {
Winson Chung86f77532010-08-24 11:08:22 -0700868 if (getCurrentPage() < getPageCount() - 1) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100869 int nextPage = validateNewPage(getCurrentPage() + 1);
870 snapToPage(nextPage);
871 getChildAt(nextPage).requestFocus(direction);
Winson Chung321e9ee2010-08-09 13:37:56 -0700872 return true;
873 }
874 }
Sunny Goyal0c4e3722015-12-01 13:21:49 -0800875 return false;
Winson Chung321e9ee2010-08-09 13:37:56 -0700876 }
877
878 @Override
879 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) {
Jon Miranda6a858172016-10-25 16:19:17 -0700880 if (getDescendantFocusability() == FOCUS_BLOCK_DESCENDANTS) {
881 return;
882 }
883
Andras Kloczl359d1ae2021-05-04 22:25:27 +0200884 // Add the current page's views as focusable and the next possible page's too. If the
885 // last focus change action was left then the left neighbour's views will be added, and
886 // if it was right then the right neighbour's views will be added.
887 // Unfortunately mCurrentPage can be outdated if there were multiple control actions in a
888 // short period of time, but mNextPage is up to date because it is always updated by
889 // method snapToPage.
890 int nextPage = getNextPage();
Adam Cohen0ffac432013-07-10 11:19:26 -0700891 // XXX-RTL: This will be fixed in a future CL
Andras Kloczl359d1ae2021-05-04 22:25:27 +0200892 if (nextPage >= 0 && nextPage < getPageCount()) {
893 getPageAt(nextPage).addFocusables(views, direction, focusableMode);
Winson Chung321e9ee2010-08-09 13:37:56 -0700894 }
895 if (direction == View.FOCUS_LEFT) {
Andras Kloczl359d1ae2021-05-04 22:25:27 +0200896 if (nextPage > 0) {
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 }
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100900 } else if (direction == View.FOCUS_RIGHT) {
Andras Kloczl359d1ae2021-05-04 22:25:27 +0200901 if (nextPage < getPageCount() - 1) {
902 nextPage = validateNewPage(nextPage + 1);
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100903 getPageAt(nextPage).addFocusables(views, direction, focusableMode);
Winson Chung321e9ee2010-08-09 13:37:56 -0700904 }
905 }
906 }
907
908 /**
909 * If one of our descendant views decides that it could be focused now, only
Winson Chung86f77532010-08-24 11:08:22 -0700910 * pass that along if it's on the current page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700911 *
Winson Chung86f77532010-08-24 11:08:22 -0700912 * This happens when live folders requery, and if they're off page, they
913 * end up calling requestFocus, which pulls it on page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700914 */
915 @Override
916 public void focusableViewAvailable(View focused) {
Winson Chung86f77532010-08-24 11:08:22 -0700917 View current = getPageAt(mCurrentPage);
Winson Chung321e9ee2010-08-09 13:37:56 -0700918 View v = focused;
919 while (true) {
920 if (v == current) {
921 super.focusableViewAvailable(focused);
922 return;
923 }
924 if (v == this) {
925 return;
926 }
927 ViewParent parent = v.getParent();
928 if (parent instanceof View) {
929 v = (View)v.getParent();
930 } else {
931 return;
932 }
933 }
934 }
935
936 /**
937 * {@inheritDoc}
938 */
939 @Override
940 public void requestDisallowInterceptTouchEvent(boolean disallowIntercept) {
941 if (disallowIntercept) {
942 // We need to make sure to cancel our long press if
943 // a scrollable widget takes over touch events
Andras Kloczl7a1ca0b2021-04-08 16:08:16 +0200944 cancelCurrentPageLongPress();
Winson Chung321e9ee2010-08-09 13:37:56 -0700945 }
946 super.requestDisallowInterceptTouchEvent(disallowIntercept);
947 }
948
949 @Override
950 public boolean onInterceptTouchEvent(MotionEvent ev) {
951 /*
952 * This method JUST determines whether we want to intercept the motion.
953 * If we return true, onTouchEvent will be called and we do the actual
954 * scrolling there.
955 */
956
Winson Chung45e1d6e2010-11-09 17:19:49 -0800957 // Skip touch handling if there are no pages to swipe
Tony Wickhamb6841ac2019-07-22 12:39:59 -0700958 if (getChildCount() <= 0) return false;
Sunny Goyalc4bb3732019-06-20 11:34:14 -0700959
960 acquireVelocityTrackerAndAddMovement(ev);
Winson Chung45e1d6e2010-11-09 17:19:49 -0800961
Winson Chung321e9ee2010-08-09 13:37:56 -0700962 /*
963 * Shortcut the most recurring case: the user is in the dragging
964 * state and he is moving his finger. We want to intercept this
965 * motion.
966 */
967 final int action = ev.getAction();
Sunny Goyalaad33592018-08-07 17:20:35 -0700968 if ((action == MotionEvent.ACTION_MOVE) && mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -0700969 return true;
970 }
971
Winson Chung321e9ee2010-08-09 13:37:56 -0700972 switch (action & MotionEvent.ACTION_MASK) {
973 case MotionEvent.ACTION_MOVE: {
974 /*
975 * mIsBeingDragged == false, otherwise the shortcut would have caught it. Check
Vinit Nayaka406f722019-12-19 11:50:55 -0800976 * whether the user has moved far enough from their original down touch.
Winson Chung321e9ee2010-08-09 13:37:56 -0700977 */
Michael Jurka1ff706b2010-09-14 17:35:20 -0700978 if (mActivePointerId != INVALID_POINTER) {
979 determineScrollingStart(ev);
Michael Jurka1ff706b2010-09-14 17:35:20 -0700980 }
981 // if mActivePointerId is INVALID_POINTER, then we must have missed an ACTION_DOWN
Vinit Nayaka406f722019-12-19 11:50:55 -0800982 // event. in that case, treat the first occurrence of a move event as a ACTION_DOWN
Michael Jurka1ff706b2010-09-14 17:35:20 -0700983 // i.e. fall through to the next case (don't break)
984 // (We sometimes miss ACTION_DOWN events in Workspace because it ignores all events
985 // while it's small- this was causing a crash before we checked for INVALID_POINTER)
Adam Cohen93c97562013-09-26 13:48:01 -0700986 break;
Winson Chung321e9ee2010-08-09 13:37:56 -0700987 }
988
989 case MotionEvent.ACTION_DOWN: {
990 final float x = ev.getX();
991 final float y = ev.getY();
992 // Remember location of down touch
993 mDownMotionX = x;
Adam Cohen7d30a372013-07-01 17:03:59 -0700994 mDownMotionY = y;
Jon Mirandaf52af432020-04-10 17:25:57 -0700995 mDownMotionPrimary = mLastMotion = mOrientationHandler.getPrimaryDirection(ev, 0);
Vinit Nayaka406f722019-12-19 11:50:55 -0800996 mLastMotionRemainder = 0;
997 mTotalMotion = 0;
Winson Chung4941f652020-06-18 15:11:53 -0700998 mAllowEasyFling = false;
Winson Chung321e9ee2010-08-09 13:37:56 -0700999 mActivePointerId = ev.getPointerId(0);
Sunny Goyalc39db732021-04-03 01:20:21 -07001000 updateIsBeingDraggedOnTouchDown(ev);
Winson Chung321e9ee2010-08-09 13:37:56 -07001001 break;
1002 }
1003
Winson Chung321e9ee2010-08-09 13:37:56 -07001004 case MotionEvent.ACTION_UP:
Jeff Brown1d0867c2010-12-02 18:27:39 -08001005 case MotionEvent.ACTION_CANCEL:
Adam Cohen7d30a372013-07-01 17:03:59 -07001006 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001007 break;
1008
1009 case MotionEvent.ACTION_POINTER_UP:
1010 onSecondaryPointerUp(ev);
Adam Cohen6342bba2011-03-10 11:33:35 -08001011 releaseVelocityTracker();
Winson Chung321e9ee2010-08-09 13:37:56 -07001012 break;
1013 }
1014
1015 /*
1016 * The only time we want to intercept motion events is if we are in the
1017 * drag mode.
1018 */
Sunny Goyalaad33592018-08-07 17:20:35 -07001019 return mIsBeingDragged;
Winson Chung321e9ee2010-08-09 13:37:56 -07001020 }
1021
Tony Wickhama0aee212019-09-18 09:24:03 -07001022 /**
1023 * If being flinged and user touches the screen, initiate drag; otherwise don't.
1024 */
Sunny Goyalc39db732021-04-03 01:20:21 -07001025 private void updateIsBeingDraggedOnTouchDown(MotionEvent ev) {
Tony Wickhama0aee212019-09-18 09:24:03 -07001026 // mScroller.isFinished should be false when being flinged.
Sunny Goyalc39db732021-04-03 01:20:21 -07001027 final int xDist = Math.abs(mScroller.getFinalX() - mScroller.getCurrX());
Winson Chung4941f652020-06-18 15:11:53 -07001028 final boolean finishedScrolling = (mScroller.isFinished() || xDist < mPageSlop / 3);
Tony Wickhama0aee212019-09-18 09:24:03 -07001029
1030 if (finishedScrolling) {
1031 mIsBeingDragged = false;
1032 if (!mScroller.isFinished() && !mFreeScroll) {
1033 setCurrentPage(getNextPage());
1034 pageEndTransition();
1035 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001036 mIsBeingDragged = !mEdgeGlowLeft.isFinished() || !mEdgeGlowRight.isFinished();
Tony Wickhama0aee212019-09-18 09:24:03 -07001037 } else {
1038 mIsBeingDragged = true;
1039 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001040
1041 // Catch the edge effect if it is active.
1042 float displacement = mOrientationHandler.getSecondaryValue(ev.getX(), ev.getY())
1043 / mOrientationHandler.getSecondaryValue(getWidth(), getHeight());
1044 if (!mEdgeGlowLeft.isFinished()) {
1045 mEdgeGlowLeft.onPullDistance(0f, 1f - displacement);
1046 }
1047 if (!mEdgeGlowRight.isFinished()) {
1048 mEdgeGlowRight.onPullDistance(0f, displacement);
1049 }
Tony Wickhama0aee212019-09-18 09:24:03 -07001050 }
1051
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001052 public boolean isHandlingTouch() {
Sunny Goyalaad33592018-08-07 17:20:35 -07001053 return mIsBeingDragged;
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001054 }
1055
Adam Cohenf8d28232011-02-01 21:47:00 -08001056 protected void determineScrollingStart(MotionEvent ev) {
1057 determineScrollingStart(ev, 1.0f);
1058 }
1059
Winson Chung321e9ee2010-08-09 13:37:56 -07001060 /*
1061 * Determines if we should change the touch state to start scrolling after the
1062 * user moves their touch point too far.
1063 */
Adam Cohenf8d28232011-02-01 21:47:00 -08001064 protected void determineScrollingStart(MotionEvent ev, float touchSlopScale) {
Adam Cohen7d30a372013-07-01 17:03:59 -07001065 // Disallow scrolling if we don't have a valid pointer index
Winson Chung321e9ee2010-08-09 13:37:56 -07001066 final int pointerIndex = ev.findPointerIndex(mActivePointerId);
Adam Cohen7d30a372013-07-01 17:03:59 -07001067 if (pointerIndex == -1) return;
1068
Vinit Nayaka406f722019-12-19 11:50:55 -08001069 final float primaryDirection = mOrientationHandler.getPrimaryDirection(ev, pointerIndex);
1070 final int diff = (int) Math.abs(primaryDirection - mLastMotion);
Adam Cohenf8d28232011-02-01 21:47:00 -08001071 final int touchSlop = Math.round(touchSlopScale * mTouchSlop);
Winson Chung4941f652020-06-18 15:11:53 -07001072 boolean moved = diff > touchSlop || ev.getAction() == ACTION_MOVE_ALLOW_EASY_FLING;
Winson Chung321e9ee2010-08-09 13:37:56 -07001073
Vinit Nayaka406f722019-12-19 11:50:55 -08001074 if (moved) {
Sunny Goyal5a1f53b2015-05-27 10:24:24 -07001075 // Scroll if the user moved far enough along the X axis
Sunny Goyalaad33592018-08-07 17:20:35 -07001076 mIsBeingDragged = true;
Vinit Nayaka406f722019-12-19 11:50:55 -08001077 mTotalMotion += Math.abs(mLastMotion - primaryDirection);
1078 mLastMotion = primaryDirection;
1079 mLastMotionRemainder = 0;
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001080 pageBeginTransition();
Tony Wickhamdadb3042016-02-24 11:07:00 -08001081 // Stop listening for things like pinches.
1082 requestDisallowInterceptTouchEvent(true);
Adam Cohenf8d28232011-02-01 21:47:00 -08001083 }
1084 }
1085
1086 protected void cancelCurrentPageLongPress() {
Sunny Goyal8e2133b2015-05-06 13:39:07 -07001087 // Try canceling the long press. It could also have been scheduled
1088 // by a distant descendant, so use the mAllowLongPress flag to block
1089 // everything
Sunny Goyal59969372021-05-06 12:11:44 -07001090 forEachVisiblePage(View::cancelLongPress);
Winson Chung321e9ee2010-08-09 13:37:56 -07001091 }
1092
Adam Cohenb5ba0972011-09-07 18:02:31 -07001093 protected float getScrollProgress(int screenCenter, View v, int page) {
Sunny Goyal228153d2018-01-04 15:35:22 -08001094 final int halfScreenSize = getMeasuredWidth() / 2;
Adam Cohenedb40762013-07-18 16:45:45 -07001095 int delta = screenCenter - (getScrollForPage(page) + halfScreenSize);
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001096 int panelCount = getPanelCount();
1097 int pageCount = getChildCount();
Adam Cohen3b185e22013-10-29 14:45:58 -07001098
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001099 int adjacentPage = page + panelCount;
Sunny Goyal70660032015-05-14 00:07:08 -07001100 if ((delta < 0 && !mIsRtl) || (delta > 0 && mIsRtl)) {
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001101 adjacentPage = page - panelCount;
Adam Cohen3b185e22013-10-29 14:45:58 -07001102 }
1103
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001104 final int totalDistance;
1105 if (adjacentPage < 0 || adjacentPage > pageCount - 1) {
1106 totalDistance = (v.getMeasuredWidth() + mPageSpacing) * panelCount;
Adam Cohen3b185e22013-10-29 14:45:58 -07001107 } else {
1108 totalDistance = Math.abs(getScrollForPage(adjacentPage) - getScrollForPage(page));
1109 }
Adam Cohenb5ba0972011-09-07 18:02:31 -07001110
1111 float scrollProgress = delta / (totalDistance * 1.0f);
Sunny Goyal8e2133b2015-05-06 13:39:07 -07001112 scrollProgress = Math.min(scrollProgress, MAX_SCROLL_PROGRESS);
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001113 scrollProgress = Math.max(scrollProgress, -MAX_SCROLL_PROGRESS);
Adam Cohenb5ba0972011-09-07 18:02:31 -07001114 return scrollProgress;
1115 }
1116
Adam Cohenedb40762013-07-18 16:45:45 -07001117 public int getScrollForPage(int index) {
Adam Cohen1f1f45d2013-10-02 09:40:18 -07001118 if (mPageScrolls == null || index >= mPageScrolls.length || index < 0) {
Adam Cohenedb40762013-07-18 16:45:45 -07001119 return 0;
1120 } else {
1121 return mPageScrolls[index];
1122 }
1123 }
1124
Adam Cohen564a2e72013-10-09 14:47:32 -07001125 // While layout transitions are occurring, a child's position may stray from its baseline
1126 // position. This method returns the magnitude of this stray at any given time.
1127 public int getLayoutTransitionOffsetForPage(int index) {
1128 if (mPageScrolls == null || index >= mPageScrolls.length || index < 0) {
1129 return 0;
1130 } else {
1131 View child = getChildAt(index);
Adam Cohen3b185e22013-10-29 14:45:58 -07001132
Sunny Goyal228153d2018-01-04 15:35:22 -08001133 int scrollOffset = mIsRtl ? getPaddingRight() : getPaddingLeft();
1134 int baselineX = mPageScrolls[index] + scrollOffset;
Adam Cohen564a2e72013-10-09 14:47:32 -07001135 return (int) (child.getX() - baselineX);
1136 }
1137 }
1138
Tony Wickham023f4042019-01-29 10:52:31 -08001139 public void setEnableFreeScroll(boolean freeScroll) {
Winson Chung0e449002019-04-26 11:09:58 -07001140 if (mFreeScroll == freeScroll) {
1141 return;
1142 }
1143
Tony Wickham8f7ead32016-04-07 18:46:44 -07001144 boolean wasFreeScroll = mFreeScroll;
Adam Cohenf358a4b2013-07-23 16:47:31 -07001145 mFreeScroll = freeScroll;
1146
Adam Cohenf9618852013-11-08 06:45:03 -08001147 if (mFreeScroll) {
Sunny Goyal4d519f22017-10-24 10:32:40 -07001148 setCurrentPage(getNextPage());
Tony Wickham8f7ead32016-04-07 18:46:44 -07001149 } else if (wasFreeScroll) {
Tony Wickhamaf33f2c2019-10-04 12:55:22 -07001150 if (getScrollForPage(getNextPage()) != getScrollX()) {
1151 snapToPage(getNextPage());
1152 }
Adam Cohenf358a4b2013-07-23 16:47:31 -07001153 }
Adam Cohenf358a4b2013-07-23 16:47:31 -07001154 }
1155
Sunny Goyal2f0ec852015-03-26 13:38:27 -07001156 protected void setEnableOverscroll(boolean enable) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001157 mAllowOverScroll = enable;
1158 }
1159
Alex Chau822acf42021-06-03 11:35:05 +01001160 protected float getSignificantMoveThreshold() {
1161 return SIGNIFICANT_MOVE_THRESHOLD;
1162 }
1163
Winson Chung321e9ee2010-08-09 13:37:56 -07001164 @Override
1165 public boolean onTouchEvent(MotionEvent ev) {
Winson Chung45e1d6e2010-11-09 17:19:49 -08001166 // Skip touch handling if there are no pages to swipe
Tony Wickhamb6841ac2019-07-22 12:39:59 -07001167 if (getChildCount() <= 0) return false;
Winson Chung45e1d6e2010-11-09 17:19:49 -08001168
Michael Jurkab8f06722010-10-10 15:58:46 -07001169 acquireVelocityTrackerAndAddMovement(ev);
Winson Chung321e9ee2010-08-09 13:37:56 -07001170
1171 final int action = ev.getAction();
1172
1173 switch (action & MotionEvent.ACTION_MASK) {
1174 case MotionEvent.ACTION_DOWN:
Sunny Goyalc39db732021-04-03 01:20:21 -07001175 updateIsBeingDraggedOnTouchDown(ev);
Tony Wickhama0aee212019-09-18 09:24:03 -07001176
Winson Chung321e9ee2010-08-09 13:37:56 -07001177 /*
1178 * If being flinged and user touches, stop the fling. isFinished
1179 * will be false if being flinged.
1180 */
1181 if (!mScroller.isFinished()) {
Adam Cohen8bdbaab2013-10-29 15:25:02 -07001182 abortScrollerAnimation(false);
Winson Chung321e9ee2010-08-09 13:37:56 -07001183 }
1184
1185 // Remember where the motion event started
Vinit Nayaka406f722019-12-19 11:50:55 -08001186 mDownMotionX = ev.getX();
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001187 mDownMotionY = ev.getY();
Vinit Nayaka406f722019-12-19 11:50:55 -08001188 mDownMotionPrimary = mLastMotion = mOrientationHandler.getPrimaryDirection(ev, 0);
1189 mLastMotionRemainder = 0;
1190 mTotalMotion = 0;
Winson Chung4941f652020-06-18 15:11:53 -07001191 mAllowEasyFling = false;
Winson Chung321e9ee2010-08-09 13:37:56 -07001192 mActivePointerId = ev.getPointerId(0);
Sunny Goyalaad33592018-08-07 17:20:35 -07001193 if (mIsBeingDragged) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001194 pageBeginTransition();
Michael Jurka0142d492010-08-25 17:46:15 -07001195 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001196 break;
1197
Winson Chung4941f652020-06-18 15:11:53 -07001198 case ACTION_MOVE_ALLOW_EASY_FLING:
1199 // Start scrolling immediately
1200 determineScrollingStart(ev);
1201 mAllowEasyFling = true;
1202 break;
1203
1204 case MotionEvent.ACTION_MOVE:
1205 if (mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001206 // Scroll to follow the motion event
1207 final int pointerIndex = ev.findPointerIndex(mActivePointerId);
Adam Cohen7d30a372013-07-01 17:03:59 -07001208
1209 if (pointerIndex == -1) return true;
Sunny Goyalc39db732021-04-03 01:20:21 -07001210 float oldScroll = mOrientationHandler.getPrimaryScroll(this);
1211 float dx = ev.getX(pointerIndex);
1212 float dy = ev.getY(pointerIndex);
Adam Cohen7d30a372013-07-01 17:03:59 -07001213
Sunny Goyalc39db732021-04-03 01:20:21 -07001214 float direction = mOrientationHandler.getPrimaryValue(dx, dy);
Vinit Nayaka406f722019-12-19 11:50:55 -08001215 float delta = mLastMotion + mLastMotionRemainder - direction;
Sunny Goyalc39db732021-04-03 01:20:21 -07001216
1217 int width = getWidth();
1218 int height = getHeight();
1219 int size = mOrientationHandler.getPrimaryValue(width, height);
1220
1221 final float displacement = mOrientationHandler.getSecondaryValue(dx, dy)
1222 / mOrientationHandler.getSecondaryValue(width, height);
Vinit Nayaka406f722019-12-19 11:50:55 -08001223 mTotalMotion += Math.abs(delta);
Adam Cohenaefd4e12011-02-14 16:39:38 -08001224
Sunny Goyalc39db732021-04-03 01:20:21 -07001225 if (mAllowOverScroll) {
1226 float consumed = 0;
1227 if (delta < 0 && mEdgeGlowRight.getDistance() != 0f) {
1228 consumed = size * mEdgeGlowRight.onPullDistance(delta / size, displacement);
1229 } else if (delta > 0 && mEdgeGlowLeft.getDistance() != 0f) {
1230 consumed = -size * mEdgeGlowLeft.onPullDistance(
1231 -delta / size, 1 - displacement);
1232 }
1233 delta -= consumed;
1234 }
Alex Chau822acf42021-06-03 11:35:05 +01001235 delta /= mOrientationHandler.getPrimaryScale(this);
Sunny Goyalc39db732021-04-03 01:20:21 -07001236
Winson Chungc0844aa2011-02-02 15:25:58 -08001237 // Only scroll and update mLastMotionX if we have moved some discrete amount. We
1238 // keep the remainder because we are actually testing if we've moved from the last
1239 // scrolled position (which is discrete).
Sunny Goyalc39db732021-04-03 01:20:21 -07001240 mLastMotion = direction;
1241 int movedDelta = (int) delta;
1242 mLastMotionRemainder = delta - movedDelta;
Vinit Nayaka406f722019-12-19 11:50:55 -08001243
Sunny Goyalc39db732021-04-03 01:20:21 -07001244 if (delta != 0) {
1245 mOrientationHandler.set(this, VIEW_SCROLL_BY, movedDelta);
1246
1247 if (mAllowOverScroll) {
1248 final float pulledToX = oldScroll + delta;
1249
1250 if (pulledToX < mMinScroll) {
1251 mEdgeGlowLeft.onPullDistance(-delta / size, 1.f - displacement);
1252 if (!mEdgeGlowRight.isFinished()) {
1253 mEdgeGlowRight.onRelease();
1254 }
1255 } else if (pulledToX > mMaxScroll) {
1256 mEdgeGlowRight.onPullDistance(delta / size, displacement);
1257 if (!mEdgeGlowLeft.isFinished()) {
1258 mEdgeGlowLeft.onRelease();
1259 }
1260 }
1261
1262 if (!mEdgeGlowLeft.isFinished() || !mEdgeGlowRight.isFinished()) {
1263 postInvalidateOnAnimation();
1264 }
1265 }
1266
Winson Chung321e9ee2010-08-09 13:37:56 -07001267 } else {
1268 awakenScrollBars();
1269 }
Adam Cohen564976a2010-10-13 18:52:07 -07001270 } else {
Winson Chung321e9ee2010-08-09 13:37:56 -07001271 determineScrollingStart(ev);
1272 }
1273 break;
1274
1275 case MotionEvent.ACTION_UP:
Sunny Goyalaad33592018-08-07 17:20:35 -07001276 if (mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001277 final int activePointerId = mActivePointerId;
1278 final int pointerIndex = ev.findPointerIndex(activePointerId);
Vinit Nayak93bf1fe2020-05-26 17:22:13 -07001279 if (pointerIndex == -1) return true;
1280
Vinit Nayaka406f722019-12-19 11:50:55 -08001281 final float primaryDirection = mOrientationHandler.getPrimaryDirection(ev,
1282 pointerIndex);
Sunny Goyal4bb8b062019-02-19 16:37:38 -08001283 final VelocityTracker velocityTracker = mVelocityTracker;
1284 velocityTracker.computeCurrentVelocity(1000, mMaximumVelocity);
Adam Cohenaefd4e12011-02-14 16:39:38 -08001285
Vinit Nayaka406f722019-12-19 11:50:55 -08001286 int velocity = (int) mOrientationHandler.getPrimaryVelocity(velocityTracker,
1287 mActivePointerId);
Alex Chau822acf42021-06-03 11:35:05 +01001288 float delta = primaryDirection - mDownMotionPrimary;
1289 delta /= mOrientationHandler.getPrimaryScale(this);
Vinit Nayaka406f722019-12-19 11:50:55 -08001290 int pageOrientedSize = mOrientationHandler.getMeasuredSize(getPageAt(mCurrentPage));
1291
Alex Chau822acf42021-06-03 11:35:05 +01001292 boolean isSignificantMove = Math.abs(delta)
1293 > pageOrientedSize * getSignificantMoveThreshold();
Vinit Nayaka406f722019-12-19 11:50:55 -08001294
1295 mTotalMotion += Math.abs(mLastMotion + mLastMotionRemainder - primaryDirection);
Winson Chung4941f652020-06-18 15:11:53 -07001296 boolean passedSlop = mAllowEasyFling || mTotalMotion > mPageSlop;
1297 boolean isFling = passedSlop && shouldFlingForVelocity(velocity);
Vinit Nayaka406f722019-12-19 11:50:55 -08001298 boolean isDeltaLeft = mIsRtl ? delta > 0 : delta < 0;
1299 boolean isVelocityLeft = mIsRtl ? velocity > 0 : velocity < 0;
Winson Chung4941f652020-06-18 15:11:53 -07001300 if (DEBUG_FAILED_QUICKSWITCH && !isFling && mAllowEasyFling) {
1301 Log.d("Quickswitch", "isFling=false vel=" + velocity
1302 + " threshold=" + mEasyFlingThresholdVelocity);
1303 }
Adam Cohen00481b32011-11-18 12:03:48 -08001304
Adam Cohenf358a4b2013-07-23 16:47:31 -07001305 if (!mFreeScroll) {
1306 // In the case that the page is moved far to one direction and then is flung
1307 // in the opposite direction, we use a threshold to determine whether we should
1308 // just return to the starting page, or if we should skip one further.
1309 boolean returnToOriginalPage = false;
Vinit Nayaka406f722019-12-19 11:50:55 -08001310 if (Math.abs(delta) > pageOrientedSize * RETURN_TO_ORIGINAL_PAGE_THRESHOLD &&
1311 Math.signum(velocity) != Math.signum(delta) && isFling) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001312 returnToOriginalPage = true;
1313 }
Adam Cohenaefd4e12011-02-14 16:39:38 -08001314
Adam Cohenf358a4b2013-07-23 16:47:31 -07001315 int finalPage;
1316 // We give flings precedence over large moves, which is why we short-circuit our
1317 // test for a large move if a fling has been registered. That is, a large
1318 // move to the left and fling to the right will register as a fling to the right.
Sunny Goyalb7b01352018-08-09 12:31:20 -07001319
Vinit Nayaka406f722019-12-19 11:50:55 -08001320 if (((isSignificantMove && !isDeltaLeft && !isFling) ||
1321 (isFling && !isVelocityLeft)) && mCurrentPage > 0) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +01001322 finalPage = returnToOriginalPage
1323 ? mCurrentPage : mCurrentPage - getPanelCount();
Vinit Nayaka406f722019-12-19 11:50:55 -08001324 snapToPageWithVelocity(finalPage, velocity);
1325 } else if (((isSignificantMove && isDeltaLeft && !isFling) ||
1326 (isFling && isVelocityLeft)) &&
Adam Cohenf358a4b2013-07-23 16:47:31 -07001327 mCurrentPage < getChildCount() - 1) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +01001328 finalPage = returnToOriginalPage
1329 ? mCurrentPage : mCurrentPage + getPanelCount();
Vinit Nayaka406f722019-12-19 11:50:55 -08001330 snapToPageWithVelocity(finalPage, velocity);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001331 } else {
1332 snapToDestination();
Adam Cohenf358a4b2013-07-23 16:47:31 -07001333 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001334 } else {
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001335 if (!mScroller.isFinished()) {
1336 abortScrollerAnimation(true);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001337 }
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001338
Vinit Nayaka406f722019-12-19 11:50:55 -08001339 int initialScroll = mOrientationHandler.getPrimaryScroll(this);
1340 int maxScroll = mMaxScroll;
1341 int minScroll = mMinScroll;
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001342
Vinit Nayaka406f722019-12-19 11:50:55 -08001343 if (((initialScroll >= maxScroll) && (isVelocityLeft || !isFling)) ||
1344 ((initialScroll <= minScroll) && (!isVelocityLeft || !isFling))) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001345 mScroller.springBack(initialScroll, 0, minScroll, maxScroll, 0, 0);
Alex Chaub794ea62021-02-03 18:00:30 +00001346 mNextPage = getDestinationPage();
Sunny Goyalb7b01352018-08-09 12:31:20 -07001347 } else {
Sunny Goyalc39db732021-04-03 01:20:21 -07001348 int velocity1 = -velocity;
1349 // Continue a scroll or fling in progress
1350 mScroller.fling(initialScroll, 0, velocity1, 0, minScroll, maxScroll, 0, 0,
1351 Math.round(getWidth() * 0.5f * OVERSCROLL_DAMP_FACTOR), 0);
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001352
Sunny Goyalc39db732021-04-03 01:20:21 -07001353 int finalPos = mScroller.getFinalX();
Alex Chaub794ea62021-02-03 18:00:30 +00001354 mNextPage = getDestinationPage(finalPos);
Sunny Goyalc39db732021-04-03 01:20:21 -07001355 onNotSnappingToPageInFreeScroll();
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001356 }
1357 invalidate();
Winson Chung321e9ee2010-08-09 13:37:56 -07001358 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001359 }
Adam Cohen7d30a372013-07-01 17:03:59 -07001360
Sunny Goyalc39db732021-04-03 01:20:21 -07001361 mEdgeGlowLeft.onRelease();
1362 mEdgeGlowRight.onRelease();
Adam Cohen7d30a372013-07-01 17:03:59 -07001363 // End any intermediate reordering states
1364 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001365 break;
1366
1367 case MotionEvent.ACTION_CANCEL:
Sunny Goyalaad33592018-08-07 17:20:35 -07001368 if (mIsBeingDragged) {
Michael Jurkab8f06722010-10-10 15:58:46 -07001369 snapToDestination();
1370 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001371 mEdgeGlowLeft.onRelease();
1372 mEdgeGlowRight.onRelease();
Adam Cohen7d30a372013-07-01 17:03:59 -07001373 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001374 break;
1375
1376 case MotionEvent.ACTION_POINTER_UP:
1377 onSecondaryPointerUp(ev);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001378 releaseVelocityTracker();
Winson Chung321e9ee2010-08-09 13:37:56 -07001379 break;
1380 }
1381
1382 return true;
1383 }
1384
Sunny Goyalc39db732021-04-03 01:20:21 -07001385 protected void onNotSnappingToPageInFreeScroll() { }
Alex Chaub794ea62021-02-03 18:00:30 +00001386
Vinit Nayaka406f722019-12-19 11:50:55 -08001387 protected boolean shouldFlingForVelocity(int velocity) {
Winson Chung4941f652020-06-18 15:11:53 -07001388 float threshold = mAllowEasyFling ? mEasyFlingThresholdVelocity : mFlingThresholdVelocity;
1389 return Math.abs(velocity) > threshold;
Sunny Goyal65d9ceb2017-05-08 09:17:42 -07001390 }
1391
Adam Cohen7d30a372013-07-01 17:03:59 -07001392 private void resetTouchState() {
1393 releaseVelocityTracker();
Sunny Goyalaad33592018-08-07 17:20:35 -07001394 mIsBeingDragged = false;
Adam Cohen7d30a372013-07-01 17:03:59 -07001395 mActivePointerId = INVALID_POINTER;
Adam Cohen7d30a372013-07-01 17:03:59 -07001396 }
1397
Winson Chung185d7162011-02-28 13:47:29 -08001398 @Override
1399 public boolean onGenericMotionEvent(MotionEvent event) {
1400 if ((event.getSource() & InputDevice.SOURCE_CLASS_POINTER) != 0) {
1401 switch (event.getAction()) {
1402 case MotionEvent.ACTION_SCROLL: {
1403 // Handle mouse (or ext. device) by shifting the page depending on the scroll
1404 final float vscroll;
1405 final float hscroll;
1406 if ((event.getMetaState() & KeyEvent.META_SHIFT_ON) != 0) {
1407 vscroll = 0;
1408 hscroll = event.getAxisValue(MotionEvent.AXIS_VSCROLL);
1409 } else {
1410 vscroll = -event.getAxisValue(MotionEvent.AXIS_VSCROLL);
1411 hscroll = event.getAxisValue(MotionEvent.AXIS_HSCROLL);
1412 }
Sunny Goyal8b37c572020-03-31 12:12:14 -07001413 if (!canScroll(Math.abs(vscroll), Math.abs(hscroll))) {
1414 return false;
Samuel Fufa59cba192019-08-22 18:31:34 -07001415 }
Winson Chung185d7162011-02-28 13:47:29 -08001416 if (hscroll != 0 || vscroll != 0) {
Sunny Goyal70660032015-05-14 00:07:08 -07001417 boolean isForwardScroll = mIsRtl ? (hscroll < 0 || vscroll < 0)
Adam Cohen0ffac432013-07-10 11:19:26 -07001418 : (hscroll > 0 || vscroll > 0);
1419 if (isForwardScroll) {
Winson Chung185d7162011-02-28 13:47:29 -08001420 scrollRight();
1421 } else {
1422 scrollLeft();
1423 }
1424 return true;
1425 }
1426 }
1427 }
1428 }
1429 return super.onGenericMotionEvent(event);
1430 }
1431
Sunny Goyal8b37c572020-03-31 12:12:14 -07001432 /**
1433 * Returns true if the paged view can scroll for the provided vertical and horizontal
1434 * scroll values
1435 */
1436 protected boolean canScroll(float absVScroll, float absHScroll) {
1437 ActivityContext ac = ActivityContext.lookupContext(getContext());
1438 return (ac == null || AbstractFloatingView.getTopOpenView(ac) == null);
Samuel Fufa59cba192019-08-22 18:31:34 -07001439 }
1440
Michael Jurkab8f06722010-10-10 15:58:46 -07001441 private void acquireVelocityTrackerAndAddMovement(MotionEvent ev) {
1442 if (mVelocityTracker == null) {
1443 mVelocityTracker = VelocityTracker.obtain();
1444 }
1445 mVelocityTracker.addMovement(ev);
1446 }
1447
1448 private void releaseVelocityTracker() {
1449 if (mVelocityTracker != null) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001450 mVelocityTracker.clear();
Michael Jurkab8f06722010-10-10 15:58:46 -07001451 mVelocityTracker.recycle();
1452 mVelocityTracker = null;
1453 }
1454 }
1455
Winson Chung321e9ee2010-08-09 13:37:56 -07001456 private void onSecondaryPointerUp(MotionEvent ev) {
Winson Chung4941f652020-06-18 15:11:53 -07001457 final int pointerIndex = ev.getActionIndex();
Winson Chung321e9ee2010-08-09 13:37:56 -07001458 final int pointerId = ev.getPointerId(pointerIndex);
1459 if (pointerId == mActivePointerId) {
1460 // This was our active pointer going up. Choose a new
1461 // active pointer and adjust accordingly.
1462 // TODO: Make this decision more intelligent.
1463 final int newPointerIndex = pointerIndex == 0 ? 1 : 0;
Vinit Nayaka406f722019-12-19 11:50:55 -08001464 mLastMotion = mDownMotionPrimary = mOrientationHandler.getPrimaryDirection(ev,
1465 newPointerIndex);
1466 mLastMotionRemainder = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -07001467 mActivePointerId = ev.getPointerId(newPointerIndex);
1468 if (mVelocityTracker != null) {
1469 mVelocityTracker.clear();
1470 }
1471 }
Jeff Brown1d0867c2010-12-02 18:27:39 -08001472 }
1473
Winson Chung321e9ee2010-08-09 13:37:56 -07001474 @Override
1475 public void requestChildFocus(View child, View focused) {
1476 super.requestChildFocus(child, focused);
Andras Kloczl359d1ae2021-05-04 22:25:27 +02001477
1478 // In case the device is controlled by a controller, mCurrentPage isn't updated properly
1479 // which results in incorrect navigation
1480 int nextPage = getNextPage();
1481 if (nextPage != mCurrentPage) {
1482 setCurrentPage(nextPage);
1483 }
1484
Adam Cohenae4f1552011-10-20 00:15:42 -07001485 int page = indexToPage(indexOfChild(child));
Winson Chung97d85d22011-04-13 11:27:36 -07001486 if (page >= 0 && page != getCurrentPage() && !isInTouchMode()) {
Winson Chung86f77532010-08-24 11:08:22 -07001487 snapToPage(page);
Winson Chung321e9ee2010-08-09 13:37:56 -07001488 }
1489 }
1490
Alex Chaub794ea62021-02-03 18:00:30 +00001491 public int getDestinationPage() {
1492 return getDestinationPage(mOrientationHandler.getPrimaryScroll(this));
1493 }
1494
Alex Chaudedbc8a2021-03-17 16:53:26 +00001495 protected int getDestinationPage(int primaryScroll) {
1496 return getPageNearestToCenterOfScreen(primaryScroll);
Alex Chaub794ea62021-02-03 18:00:30 +00001497 }
1498
Sunny Goyal228153d2018-01-04 15:35:22 -08001499 public int getPageNearestToCenterOfScreen() {
Vinit Nayaka406f722019-12-19 11:50:55 -08001500 return getPageNearestToCenterOfScreen(mOrientationHandler.getPrimaryScroll(this));
Tony Wickham8f7ead32016-04-07 18:46:44 -07001501 }
1502
Alex Chaudedbc8a2021-03-17 16:53:26 +00001503 private int getPageNearestToCenterOfScreen(int primaryScroll) {
1504 int screenCenter = getScreenCenter(primaryScroll);
Adam Cohen22f823d2011-09-01 17:22:18 -07001505 int minDistanceFromScreenCenter = Integer.MAX_VALUE;
Winson Chung321e9ee2010-08-09 13:37:56 -07001506 int minDistanceFromScreenCenterIndex = -1;
Winson Chung321e9ee2010-08-09 13:37:56 -07001507 final int childCount = getChildCount();
1508 for (int i = 0; i < childCount; ++i) {
Tony Wickham7383d4e2020-07-07 19:25:25 -07001509 int distanceFromScreenCenter = Math.abs(
1510 getDisplacementFromScreenCenter(i, screenCenter));
Winson Chung321e9ee2010-08-09 13:37:56 -07001511 if (distanceFromScreenCenter < minDistanceFromScreenCenter) {
1512 minDistanceFromScreenCenter = distanceFromScreenCenter;
1513 minDistanceFromScreenCenterIndex = i;
1514 }
1515 }
Adam Cohend19d3ca2010-09-15 14:43:42 -07001516 return minDistanceFromScreenCenterIndex;
1517 }
1518
Tony Wickham7383d4e2020-07-07 19:25:25 -07001519 private int getDisplacementFromScreenCenter(int childIndex, int screenCenter) {
Alex Chaudedbc8a2021-03-17 16:53:26 +00001520 int childSize = Math.round(getChildVisibleSize(childIndex));
Tony Wickham7383d4e2020-07-07 19:25:25 -07001521 int halfChildSize = (childSize / 2);
1522 int childCenter = getChildOffset(childIndex) + halfChildSize;
1523 return childCenter - screenCenter;
1524 }
1525
1526 protected int getDisplacementFromScreenCenter(int childIndex) {
Alex Chaudedbc8a2021-03-17 16:53:26 +00001527 int primaryScroll = mOrientationHandler.getPrimaryScroll(this);
1528 int screenCenter = getScreenCenter(primaryScroll);
Tony Wickham7383d4e2020-07-07 19:25:25 -07001529 return getDisplacementFromScreenCenter(childIndex, screenCenter);
1530 }
1531
Alex Chaudedbc8a2021-03-17 16:53:26 +00001532 private int getScreenCenter(int primaryScroll) {
1533 float primaryScale = mOrientationHandler.getPrimaryScale(this);
1534 float primaryPivot = mOrientationHandler.getPrimaryValue(getPivotX(), getPivotY());
1535 int pageOrientationSize = mOrientationHandler.getMeasuredSize(this);
1536 return Math.round(primaryScroll + (pageOrientationSize / 2f - primaryPivot) / primaryScale
1537 + primaryPivot);
1538 }
1539
Adam Cohend19d3ca2010-09-15 14:43:42 -07001540 protected void snapToDestination() {
Sunny Goyalc39db732021-04-03 01:20:21 -07001541 snapToPage(getDestinationPage(), PAGE_SNAP_ANIMATION_DURATION);
Winson Chung321e9ee2010-08-09 13:37:56 -07001542 }
1543
Adam Cohene0f66b52010-11-23 15:06:07 -08001544 // We want the duration of the page snap animation to be influenced by the distance that
1545 // the screen has to travel, however, we don't want this duration to be effected in a
1546 // purely linear fashion. Instead, we use this method to moderate the effect that the distance
1547 // of travel has on the overall snap duration.
Sunny Goyal4d113a52015-05-27 10:05:28 -07001548 private float distanceInfluenceForSnapDuration(float f) {
Adam Cohene0f66b52010-11-23 15:06:07 -08001549 f -= 0.5f; // center the values about 0.
1550 f *= 0.3f * Math.PI / 2.0f;
1551 return (float) Math.sin(f);
1552 }
1553
Winson Chung05a31ed2018-02-08 17:08:43 -08001554 protected boolean snapToPageWithVelocity(int whichPage, int velocity) {
Adam Cohen6f127a62014-06-12 14:54:41 -07001555 whichPage = validateNewPage(whichPage);
Vinit Nayaka406f722019-12-19 11:50:55 -08001556 int halfScreenSize = mOrientationHandler.getMeasuredSize(this) / 2;
Adam Cohene0f66b52010-11-23 15:06:07 -08001557
Vinit Nayaka406f722019-12-19 11:50:55 -08001558 final int newLoc = getScrollForPage(whichPage);
Sunny Goyalc39db732021-04-03 01:20:21 -07001559 int delta = newLoc - mOrientationHandler.getPrimaryScroll(this);
Adam Cohene0f66b52010-11-23 15:06:07 -08001560 int duration = 0;
1561
Sunny Goyal4d113a52015-05-27 10:05:28 -07001562 if (Math.abs(velocity) < mMinFlingVelocity) {
Adam Cohene0f66b52010-11-23 15:06:07 -08001563 // If the velocity is low enough, then treat this more as an automatic page advance
1564 // as opposed to an apparent physical response to flinging
Winson Chung05a31ed2018-02-08 17:08:43 -08001565 return snapToPage(whichPage, PAGE_SNAP_ANIMATION_DURATION);
Adam Cohene0f66b52010-11-23 15:06:07 -08001566 }
1567
1568 // Here we compute a "distance" that will be used in the computation of the overall
1569 // snap duration. This is a function of the actual distance that needs to be traveled;
1570 // we keep this value close to half screen size in order to reduce the variance in snap
1571 // duration as a function of the distance the page needs to travel.
Michael Jurka20b7ca92011-06-07 20:09:16 -07001572 float distanceRatio = Math.min(1f, 1.0f * Math.abs(delta) / (2 * halfScreenSize));
Adam Cohene0f66b52010-11-23 15:06:07 -08001573 float distance = halfScreenSize + halfScreenSize *
1574 distanceInfluenceForSnapDuration(distanceRatio);
1575
1576 velocity = Math.abs(velocity);
Adam Cohen265b9a62011-12-07 14:37:18 -08001577 velocity = Math.max(mMinSnapVelocity, velocity);
Adam Cohene0f66b52010-11-23 15:06:07 -08001578
1579 // we want the page's snap velocity to approximately match the velocity at which the
1580 // user flings, so we scale the duration by a value near to the derivative of the scroll
Michael Jurka20b7ca92011-06-07 20:09:16 -07001581 // interpolator at zero, ie. 5. We use 4 to make it a little slower.
1582 duration = 4 * Math.round(1000 * Math.abs(distance / velocity));
Adam Cohene0f66b52010-11-23 15:06:07 -08001583
Sunny Goyalc39db732021-04-03 01:20:21 -07001584 return snapToPage(whichPage, delta, duration);
Michael Jurka0142d492010-08-25 17:46:15 -07001585 }
1586
Winson Chung05a31ed2018-02-08 17:08:43 -08001587 public boolean snapToPage(int whichPage) {
1588 return snapToPage(whichPage, PAGE_SNAP_ANIMATION_DURATION);
Winson Chung321e9ee2010-08-09 13:37:56 -07001589 }
1590
Winson Chung05a31ed2018-02-08 17:08:43 -08001591 public boolean snapToPageImmediately(int whichPage) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001592 return snapToPage(whichPage, PAGE_SNAP_ANIMATION_DURATION, true);
Adam Cohen7d30a372013-07-01 17:03:59 -07001593 }
1594
Winson Chung05a31ed2018-02-08 17:08:43 -08001595 public boolean snapToPage(int whichPage, int duration) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001596 return snapToPage(whichPage, duration, false);
Adam Cohen7d30a372013-07-01 17:03:59 -07001597 }
1598
Sunny Goyalc39db732021-04-03 01:20:21 -07001599 protected boolean snapToPage(int whichPage, int duration, boolean immediate) {
Adam Cohen6f127a62014-06-12 14:54:41 -07001600 whichPage = validateNewPage(whichPage);
Winson Chung321e9ee2010-08-09 13:37:56 -07001601
Vinit Nayaka406f722019-12-19 11:50:55 -08001602 int newLoc = getScrollForPage(whichPage);
Sunny Goyalc39db732021-04-03 01:20:21 -07001603 final int delta = newLoc - mOrientationHandler.getPrimaryScroll(this);
1604 return snapToPage(whichPage, delta, duration, immediate);
Michael Jurka0142d492010-08-25 17:46:15 -07001605 }
1606
Winson Chung05a31ed2018-02-08 17:08:43 -08001607 protected boolean snapToPage(int whichPage, int delta, int duration) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001608 return snapToPage(whichPage, delta, duration, false);
Adam Cohen7d30a372013-07-01 17:03:59 -07001609 }
Michael Jurka0142d492010-08-25 17:46:15 -07001610
Sunny Goyalc39db732021-04-03 01:20:21 -07001611 protected boolean snapToPage(int whichPage, int delta, int duration, boolean immediate) {
Sunny Goyal9bb8ffb2018-05-24 17:11:16 -07001612 if (mFirstLayout) {
1613 setCurrentPage(whichPage);
1614 return false;
1615 }
Tony Wickhamd58c2d52018-05-04 12:10:55 -07001616
Andy Wickhamda5a89b2021-07-23 12:38:14 -10001617 if (FeatureFlags.IS_STUDIO_BUILD && !Utilities.IS_RUNNING_IN_TEST_HARNESS) {
Tony Wickhamcb3f8702018-08-27 17:36:03 -07001618 duration *= Settings.Global.getFloat(getContext().getContentResolver(),
1619 Settings.Global.WINDOW_ANIMATION_SCALE, 1);
Tony Wickhamd58c2d52018-05-04 12:10:55 -07001620 }
1621
Adam Cohen6f127a62014-06-12 14:54:41 -07001622 whichPage = validateNewPage(whichPage);
1623
Adam Cohen7d30a372013-07-01 17:03:59 -07001624 mNextPage = whichPage;
Michael Jurka0142d492010-08-25 17:46:15 -07001625
Winson Chung321e9ee2010-08-09 13:37:56 -07001626 awakenScrollBars(duration);
Adam Cohen7d30a372013-07-01 17:03:59 -07001627 if (immediate) {
1628 duration = 0;
1629 } else if (duration == 0) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001630 duration = Math.abs(delta);
1631 }
1632
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001633 if (duration != 0) {
1634 pageBeginTransition();
1635 }
1636
Adam Cohenf358a4b2013-07-23 16:47:31 -07001637 if (!mScroller.isFinished()) {
Adam Cohenf9618852013-11-08 06:45:03 -08001638 abortScrollerAnimation(false);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001639 }
Adam Cohenf9618852013-11-08 06:45:03 -08001640
Sunny Goyalc39db732021-04-03 01:20:21 -07001641 mScroller.startScroll(mOrientationHandler.getPrimaryScroll(this), 0, delta, 0, duration);
Adam Cohen674531f2013-12-13 15:07:14 -08001642 updatePageIndicator();
Adam Cohen7d30a372013-07-01 17:03:59 -07001643
1644 // Trigger a compute() to finish switching pages if necessary
1645 if (immediate) {
1646 computeScroll();
Sunny Goyal76dbf6f2017-01-03 14:55:47 -08001647 pageEndTransition();
Adam Cohen7d30a372013-07-01 17:03:59 -07001648 }
1649
Winson Chung321e9ee2010-08-09 13:37:56 -07001650 invalidate();
Winson Chung05a31ed2018-02-08 17:08:43 -08001651 return Math.abs(delta) > 0;
Winson Chung321e9ee2010-08-09 13:37:56 -07001652 }
1653
Vadim Tryshev98913d02018-05-18 18:41:34 -07001654 public boolean scrollLeft() {
1655 if (getNextPage() > 0) {
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001656 snapToPage(getNextPage() - getPanelCount());
Vadim Tryshev98913d02018-05-18 18:41:34 -07001657 return true;
1658 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001659 return mAllowOverScroll;
Winson Chung321e9ee2010-08-09 13:37:56 -07001660 }
1661
Vadim Tryshev98913d02018-05-18 18:41:34 -07001662 public boolean scrollRight() {
1663 if (getNextPage() < getChildCount() - 1) {
Andras Kloczl77b3eb02021-07-15 11:15:24 +02001664 snapToPage(getNextPage() + getPanelCount());
Vadim Tryshev98913d02018-05-18 18:41:34 -07001665 return true;
1666 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001667 return mAllowOverScroll;
Winson Chung321e9ee2010-08-09 13:37:56 -07001668 }
1669
Vadim Trysheve6bbefb2018-04-03 13:38:06 -07001670 @Override
1671 public CharSequence getAccessibilityClassName() {
1672 // Some accessibility services have special logic for ScrollView. Since we provide same
1673 // accessibility info as ScrollView, inform the service to handle use the same way.
1674 return ScrollView.class.getName();
1675 }
1676
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001677 protected boolean isPageOrderFlipped() {
1678 return false;
1679 }
1680
Winson Chung6a0f57d2011-06-29 20:10:49 -07001681 /* Accessibility */
Sunny Goyalcf25b522015-07-09 00:01:18 -07001682 @SuppressWarnings("deprecation")
Winson Chung6a0f57d2011-06-29 20:10:49 -07001683 @Override
1684 public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) {
1685 super.onInitializeAccessibilityNodeInfo(info);
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001686 final boolean pagesFlipped = isPageOrderFlipped();
Pinyao Tingaf6daa22019-09-18 22:18:03 +00001687 int offset = (mAllowOverScroll ? 0 : 1);
1688 info.setScrollable(getPageCount() > offset);
1689 if (getCurrentPage() < getPageCount() - offset) {
yingleiw02cc8482019-08-02 16:14:27 -07001690 info.addAction(pagesFlipped ?
1691 AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_BACKWARD
1692 : AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_FORWARD);
1693 info.addAction(mIsRtl ?
1694 AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_LEFT
1695 : AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_RIGHT);
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001696 }
Pinyao Tingaf6daa22019-09-18 22:18:03 +00001697 if (getCurrentPage() >= offset) {
yingleiw02cc8482019-08-02 16:14:27 -07001698 info.addAction(pagesFlipped ?
1699 AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_FORWARD
1700 : AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_BACKWARD);
1701 info.addAction(mIsRtl ?
1702 AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_RIGHT
1703 : AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_LEFT);
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001704 }
Vadim Tryshev7af0d442015-05-15 08:48:11 -07001705 // Accessibility-wise, PagedView doesn't support long click, so disabling it.
1706 // Besides disabling the accessibility long-click, this also prevents this view from getting
1707 // accessibility focus.
1708 info.setLongClickable(false);
Sunny Goyala52ecb02016-12-16 15:04:51 -08001709 info.removeAction(AccessibilityNodeInfo.AccessibilityAction.ACTION_LONG_CLICK);
Winson Chung6a0f57d2011-06-29 20:10:49 -07001710 }
1711
1712 @Override
Alan Viverette254139a2013-10-08 13:13:46 -07001713 public void sendAccessibilityEvent(int eventType) {
1714 // Don't let the view send real scroll events.
1715 if (eventType != AccessibilityEvent.TYPE_VIEW_SCROLLED) {
1716 super.sendAccessibilityEvent(eventType);
1717 }
1718 }
1719
1720 @Override
Winson Chung6a0f57d2011-06-29 20:10:49 -07001721 public void onInitializeAccessibilityEvent(AccessibilityEvent event) {
1722 super.onInitializeAccessibilityEvent(event);
Pinyao Tingaf6daa22019-09-18 22:18:03 +00001723 event.setScrollable(mAllowOverScroll || getPageCount() > 1);
Winson Chung6a0f57d2011-06-29 20:10:49 -07001724 }
1725
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001726 @Override
1727 public boolean performAccessibilityAction(int action, Bundle arguments) {
1728 if (super.performAccessibilityAction(action, arguments)) {
1729 return true;
1730 }
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001731 final boolean pagesFlipped = isPageOrderFlipped();
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001732 switch (action) {
1733 case AccessibilityNodeInfo.ACTION_SCROLL_FORWARD: {
Vadim Tryshev98913d02018-05-18 18:41:34 -07001734 if (pagesFlipped ? scrollLeft() : scrollRight()) {
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001735 return true;
1736 }
1737 } break;
1738 case AccessibilityNodeInfo.ACTION_SCROLL_BACKWARD: {
Vadim Tryshev98913d02018-05-18 18:41:34 -07001739 if (pagesFlipped ? scrollRight() : scrollLeft()) {
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001740 return true;
1741 }
yingleiw02cc8482019-08-02 16:14:27 -07001742 } break;
1743 case android.R.id.accessibilityActionPageRight: {
1744 if (!mIsRtl) {
1745 return scrollRight();
1746 } else {
1747 return scrollLeft();
1748 }
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001749 }
yingleiw02cc8482019-08-02 16:14:27 -07001750 case android.R.id.accessibilityActionPageLeft: {
1751 if (!mIsRtl) {
1752 return scrollLeft();
1753 } else {
1754 return scrollRight();
1755 }
1756 }
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001757 }
1758 return false;
1759 }
1760
Vadim Tryshev2c430b32018-04-04 14:45:21 -07001761 protected boolean canAnnouncePageDescription() {
1762 return true;
1763 }
1764
Adam Cohen0ffac432013-07-10 11:19:26 -07001765 protected String getCurrentPageDescription() {
Sunny Goyalf4f89ef2015-09-02 15:06:12 -07001766 return getContext().getString(R.string.default_scroll_format,
Adam Cohen0ffac432013-07-10 11:19:26 -07001767 getNextPage() + 1, getChildCount());
1768 }
1769
Tony Mak2e564402018-02-27 17:19:34 +00001770 protected float getDownMotionX() {
1771 return mDownMotionX;
1772 }
1773
1774 protected float getDownMotionY() {
1775 return mDownMotionY;
1776 }
1777
Sunny Goyal20a13ff2018-03-13 16:44:00 -07001778 protected interface ComputePageScrollsLogic {
1779
1780 boolean shouldIncludeView(View view);
1781 }
Vadim Tryshev528b9e02018-05-24 18:22:03 -07001782
1783 public int[] getVisibleChildrenRange() {
1784 float visibleLeft = 0;
1785 float visibleRight = visibleLeft + getMeasuredWidth();
1786 float scaleX = getScaleX();
1787 if (scaleX < 1 && scaleX > 0) {
1788 float mid = getMeasuredWidth() / 2;
1789 visibleLeft = mid - ((mid - visibleLeft) / scaleX);
1790 visibleRight = mid + ((visibleRight - mid) / scaleX);
1791 }
1792
1793 int leftChild = -1;
1794 int rightChild = -1;
1795 final int childCount = getChildCount();
1796 for (int i = 0; i < childCount; i++) {
1797 final View child = getPageAt(i);
1798
1799 float left = child.getLeft() + child.getTranslationX() - getScrollX();
1800 if (left <= visibleRight && (left + child.getMeasuredWidth()) >= visibleLeft) {
1801 if (leftChild == -1) {
1802 leftChild = i;
1803 }
1804 rightChild = i;
1805 }
1806 }
1807 mTmpIntPair[0] = leftChild;
1808 mTmpIntPair[1] = rightChild;
1809 return mTmpIntPair;
1810 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001811
1812 @Override
1813 public void draw(Canvas canvas) {
1814 super.draw(canvas);
1815 drawEdgeEffect(canvas);
Sunny Goyal05b59c02021-04-29 13:55:40 -07001816 pageEndTransition();
Sunny Goyalc39db732021-04-03 01:20:21 -07001817 }
1818
1819 protected void drawEdgeEffect(Canvas canvas) {
1820 if (mAllowOverScroll && (!mEdgeGlowRight.isFinished() || !mEdgeGlowLeft.isFinished())) {
1821 final int width = getWidth();
1822 final int height = getHeight();
1823 if (!mEdgeGlowLeft.isFinished()) {
1824 final int restoreCount = canvas.save();
1825 canvas.rotate(-90);
1826 canvas.translate(-height, Math.min(mMinScroll, getScrollX()));
1827 mEdgeGlowLeft.setSize(height, width);
1828 if (mEdgeGlowLeft.draw(canvas)) {
1829 postInvalidateOnAnimation();
1830 }
1831 canvas.restoreToCount(restoreCount);
1832 }
1833 if (!mEdgeGlowRight.isFinished()) {
1834 final int restoreCount = canvas.save();
1835 canvas.rotate(90, width, 0);
1836 canvas.translate(width, -(Math.max(mMaxScroll, getScrollX())));
1837
1838 mEdgeGlowRight.setSize(height, width);
1839 if (mEdgeGlowRight.draw(canvas)) {
1840 postInvalidateOnAnimation();
1841 }
1842 canvas.restoreToCount(restoreCount);
1843 }
1844 }
1845 }
Adam Cohen5084cba2013-09-03 12:01:16 -07001846}