blob: 52a6cef4972326a04e8d066ceb9067b5fa292b48 [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
Sunny Goyalc39db732021-04-03 01:20:21 -070019import static com.android.launcher3.anim.Interpolators.SCROLL;
Sunny Goyal8b37c572020-03-31 12:12:14 -070020import static com.android.launcher3.compat.AccessibilityManagerCompat.isAccessibilityEnabled;
21import static com.android.launcher3.compat.AccessibilityManagerCompat.isObservedEventType;
Sunny Goyal8b37c572020-03-31 12:12:14 -070022import static com.android.launcher3.touch.OverScroll.OVERSCROLL_DAMP_FACTOR;
Sunny Goyal8b37c572020-03-31 12:12:14 -070023import static com.android.launcher3.touch.PagedOrientationHandler.VIEW_SCROLL_BY;
24import static com.android.launcher3.touch.PagedOrientationHandler.VIEW_SCROLL_TO;
25
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -070026import android.animation.LayoutTransition;
Sunny Goyalcf25b522015-07-09 00:01:18 -070027import android.annotation.SuppressLint;
Winson Chung321e9ee2010-08-09 13:37:56 -070028import android.content.Context;
Adam Cohen9c4949e2010-10-05 12:27:22 -070029import android.content.res.TypedArray;
Jon Miranda71cb80c2019-01-24 21:25:13 -080030import android.graphics.Canvas;
Winson Chung321e9ee2010-08-09 13:37:56 -070031import android.graphics.Rect;
Svetoslav Ganov08055f62012-05-15 11:06:36 -070032import android.os.Bundle;
Tony Wickhamd58c2d52018-05-04 12:10:55 -070033import android.provider.Settings;
Winson Chung321e9ee2010-08-09 13:37:56 -070034import android.util.AttributeSet;
Winson Chung785d2eb2011-04-14 16:08:02 -070035import android.util.Log;
Winson Chung185d7162011-02-28 13:47:29 -080036import android.view.InputDevice;
37import android.view.KeyEvent;
Winson Chung321e9ee2010-08-09 13:37:56 -070038import android.view.MotionEvent;
39import android.view.VelocityTracker;
40import android.view.View;
41import android.view.ViewConfiguration;
Sunny Goyal4ffec482016-02-09 11:28:52 -080042import android.view.ViewDebug;
Winson Chung321e9ee2010-08-09 13:37:56 -070043import android.view.ViewGroup;
44import android.view.ViewParent;
Winson Chung6a0f57d2011-06-29 20:10:49 -070045import android.view.accessibility.AccessibilityEvent;
46import android.view.accessibility.AccessibilityNodeInfo;
Sunny Goyalc39db732021-04-03 01:20:21 -070047import android.widget.OverScroller;
Vadim Trysheve6bbefb2018-04-03 13:38:06 -070048import android.widget.ScrollView;
Tony Wickhamf549dab2016-05-16 09:54:06 -070049
Tony Wickham62117d72020-03-26 16:56:26 -070050import androidx.annotation.Nullable;
51
Jon Miranda9e198662020-03-11 14:42:02 -070052import com.android.launcher3.compat.AccessibilityManagerCompat;
53import com.android.launcher3.config.FeatureFlags;
Jon Miranda9e198662020-03-11 14:42:02 -070054import com.android.launcher3.pageindicators.PageIndicator;
Jon Miranda9e198662020-03-11 14:42:02 -070055import com.android.launcher3.touch.PagedOrientationHandler;
56import com.android.launcher3.touch.PagedOrientationHandler.ChildBounds;
Sunny Goyalc39db732021-04-03 01:20:21 -070057import com.android.launcher3.util.EdgeEffectCompat;
Jon Miranda9e198662020-03-11 14:42:02 -070058import com.android.launcher3.util.Thunk;
Sunny Goyal8b37c572020-03-31 12:12:14 -070059import com.android.launcher3.views.ActivityContext;
Jon Miranda9e198662020-03-11 14:42:02 -070060
61import java.util.ArrayList;
Sunny Goyal59969372021-05-06 12:11:44 -070062import java.util.function.Consumer;
Jon Miranda9e198662020-03-11 14:42:02 -070063
Winson Chung321e9ee2010-08-09 13:37:56 -070064/**
65 * An abstraction of the original Workspace which supports browsing through a
Michael Jurka0142d492010-08-25 17:46:15 -070066 * sequential list of "pages"
Winson Chung321e9ee2010-08-09 13:37:56 -070067 */
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -080068public abstract class PagedView<T extends View & PageIndicator> extends ViewGroup {
Winson Chung321e9ee2010-08-09 13:37:56 -070069 private static final String TAG = "PagedView";
Winson Chung785d2eb2011-04-14 16:08:02 -070070 private static final boolean DEBUG = false;
Winson Chung4941f652020-06-18 15:11:53 -070071 public static final boolean DEBUG_FAILED_QUICKSWITCH = false;
Sunny Goyal20a13ff2018-03-13 16:44:00 -070072
Winson Chung4941f652020-06-18 15:11:53 -070073 public static final int ACTION_MOVE_ALLOW_EASY_FLING = MotionEvent.ACTION_MASK - 1;
Sunny Goyala7a5bf32020-01-05 15:35:29 +053074 public static final int INVALID_PAGE = -1;
Sunny Goyal20a13ff2018-03-13 16:44:00 -070075 protected static final ComputePageScrollsLogic SIMPLE_SCROLL_LOGIC = (v) -> v.getVisibility() != GONE;
Winson Chung321e9ee2010-08-09 13:37:56 -070076
Vadim Tryshevfedca432015-08-19 17:55:02 -070077 public static final int PAGE_SNAP_ANIMATION_DURATION = 750;
Winson Chung321e9ee2010-08-09 13:37:56 -070078
Adam Cohenb64cb5a2011-02-15 13:53:42 -080079 private static final float RETURN_TO_ORIGINAL_PAGE_THRESHOLD = 0.33f;
Adam Cohen00481b32011-11-18 12:03:48 -080080 // The page is moved more than halfway, automatically move to the next page on touch up.
81 private static final float SIGNIFICANT_MOVE_THRESHOLD = 0.4f;
Adam Cohen68d73932010-11-15 10:50:58 -080082
Sunny Goyal8e2133b2015-05-06 13:39:07 -070083 private static final float MAX_SCROLL_PROGRESS = 1.0f;
84
Adam Cohen265b9a62011-12-07 14:37:18 -080085 // The following constants need to be scaled based on density. The scaled versions will be
86 // assigned to the corresponding member variables below.
87 private static final int FLING_THRESHOLD_VELOCITY = 500;
Winson Chung4941f652020-06-18 15:11:53 -070088 private static final int EASY_FLING_THRESHOLD_VELOCITY = 400;
Adam Cohen265b9a62011-12-07 14:37:18 -080089 private static final int MIN_SNAP_VELOCITY = 1500;
90 private static final int MIN_FLING_VELOCITY = 250;
91
Adam Cohenf358a4b2013-07-23 16:47:31 -070092 private boolean mFreeScroll = false;
Adam Cohenf358a4b2013-07-23 16:47:31 -070093
Winson Chung4941f652020-06-18 15:11:53 -070094 protected final int mFlingThresholdVelocity;
95 protected final int mEasyFlingThresholdVelocity;
96 protected final int mMinFlingVelocity;
97 protected final int mMinSnapVelocity;
Michael Jurka0142d492010-08-25 17:46:15 -070098
Michael Jurka0142d492010-08-25 17:46:15 -070099 protected boolean mFirstLayout = true;
100
Sunny Goyal4ffec482016-02-09 11:28:52 -0800101 @ViewDebug.ExportedProperty(category = "launcher")
Michael Jurka0142d492010-08-25 17:46:15 -0700102 protected int mCurrentPage;
Adam Cohene61a9a22013-06-11 15:45:31 -0700103
Sunny Goyal4ffec482016-02-09 11:28:52 -0800104 @ViewDebug.ExportedProperty(category = "launcher")
Michael Jurka0142d492010-08-25 17:46:15 -0700105 protected int mNextPage = INVALID_PAGE;
Vinit Nayaka406f722019-12-19 11:50:55 -0800106 protected int mMaxScroll;
107 protected int mMinScroll;
Sunny Goyalb7b01352018-08-09 12:31:20 -0700108 protected OverScroller mScroller;
Winson Chung321e9ee2010-08-09 13:37:56 -0700109 private VelocityTracker mVelocityTracker;
Sunny Goyale15e2a82017-12-15 13:05:42 -0800110 protected int mPageSpacing = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -0700111
112 private float mDownMotionX;
Adam Cohen7d30a372013-07-01 17:03:59 -0700113 private float mDownMotionY;
Vinit Nayaka406f722019-12-19 11:50:55 -0800114 private float mDownMotionPrimary;
115 private float mLastMotion;
116 private float mLastMotionRemainder;
117 private float mTotalMotion;
Winson Chung4941f652020-06-18 15:11:53 -0700118 // Used in special cases where the fling checks can be relaxed for an intentional gesture
119 private boolean mAllowEasyFling;
Sunny Goyalacd17df2020-04-03 15:58:45 -0700120 protected PagedOrientationHandler mOrientationHandler = PagedOrientationHandler.PORTRAIT;
Adam Cohenedb40762013-07-18 16:45:45 -0700121
Vadim Trysheve628c472018-05-16 14:28:18 -0700122 protected int[] mPageScrolls;
Sunny Goyalaad33592018-08-07 17:20:35 -0700123 private boolean mIsBeingDragged;
Adam Cohencae7f572013-11-04 14:42:52 -0800124
Winson Chung4941f652020-06-18 15:11:53 -0700125 // The amount of movement to begin scrolling
Michael Jurka7426c422010-11-11 15:23:47 -0800126 protected int mTouchSlop;
Winson Chung4941f652020-06-18 15:11:53 -0700127 // The amount of movement to begin paging
128 protected int mPageSlop;
Winson Chung321e9ee2010-08-09 13:37:56 -0700129 private int mMaximumVelocity;
Adam Cohen68d73932010-11-15 10:50:58 -0800130 protected boolean mAllowOverScroll = true;
Winson Chung321e9ee2010-08-09 13:37:56 -0700131
Michael Jurka5f1c5092010-09-03 14:15:02 -0700132 protected static final int INVALID_POINTER = -1;
Winson Chung321e9ee2010-08-09 13:37:56 -0700133
Michael Jurka5f1c5092010-09-03 14:15:02 -0700134 protected int mActivePointerId = INVALID_POINTER;
Winson Chung321e9ee2010-08-09 13:37:56 -0700135
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700136 protected boolean mIsPageInTransition = false;
Tony Wickham62117d72020-03-26 16:56:26 -0700137 private Runnable mOnPageTransitionEndCallback;
Patrick Dubroy1262e362010-10-06 15:49:50 -0700138
Winson Chungd2be3812013-07-16 11:11:32 -0700139 // Page Indicator
Adam Cohen091440a2015-03-18 14:16:05 -0700140 @Thunk int mPageIndicatorViewId;
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800141 protected T mPageIndicator;
Adam Cohen7d30a372013-07-01 17:03:59 -0700142
John Spurlock77e1f472013-09-11 10:09:51 -0400143 protected final Rect mInsets = new Rect();
Tony Wickhamdfb5cc92018-02-26 16:41:57 -0800144 protected boolean mIsRtl;
John Spurlock77e1f472013-09-11 10:09:51 -0400145
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800146 // Similar to the platform implementation of isLayoutValid();
147 protected boolean mIsLayoutValid;
148
Vadim Tryshev528b9e02018-05-24 18:22:03 -0700149 private int[] mTmpIntPair = new int[2];
150
Sunny Goyalc39db732021-04-03 01:20:21 -0700151 protected EdgeEffectCompat mEdgeGlowLeft;
152 protected EdgeEffectCompat mEdgeGlowRight;
153
Winson Chung321e9ee2010-08-09 13:37:56 -0700154 public PagedView(Context context) {
155 this(context, null);
156 }
157
158 public PagedView(Context context, AttributeSet attrs) {
159 this(context, attrs, 0);
160 }
161
162 public PagedView(Context context, AttributeSet attrs, int defStyle) {
163 super(context, attrs, defStyle);
Winson Chungc9ca2982013-07-19 12:07:38 -0700164
Adam Cohen9c4949e2010-10-05 12:27:22 -0700165 TypedArray a = context.obtainStyledAttributes(attrs,
166 R.styleable.PagedView, defStyle, 0);
Winson Chungd2be3812013-07-16 11:11:32 -0700167 mPageIndicatorViewId = a.getResourceId(R.styleable.PagedView_pageIndicator, -1);
Adam Cohen9c4949e2010-10-05 12:27:22 -0700168 a.recycle();
169
Winson Chung321e9ee2010-08-09 13:37:56 -0700170 setHapticFeedbackEnabled(false);
Sunny Goyal70660032015-05-14 00:07:08 -0700171 mIsRtl = Utilities.isRtl(getResources());
Winson Chung321e9ee2010-08-09 13:37:56 -0700172
Sunny Goyalc39db732021-04-03 01:20:21 -0700173 mScroller = new OverScroller(context, SCROLL);
Winson Chung86f77532010-08-24 11:08:22 -0700174 mCurrentPage = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -0700175
Vinit Nayaka406f722019-12-19 11:50:55 -0800176 final ViewConfiguration configuration = ViewConfiguration.get(context);
Winson Chung4941f652020-06-18 15:11:53 -0700177 mTouchSlop = configuration.getScaledTouchSlop();
178 mPageSlop = configuration.getScaledPagingTouchSlop();
Winson Chung321e9ee2010-08-09 13:37:56 -0700179 mMaximumVelocity = configuration.getScaledMaximumFlingVelocity();
Adam Cohen265b9a62011-12-07 14:37:18 -0800180
Sunny Goyalcf25b522015-07-09 00:01:18 -0700181 float density = getResources().getDisplayMetrics().density;
182 mFlingThresholdVelocity = (int) (FLING_THRESHOLD_VELOCITY * density);
Winson Chung4941f652020-06-18 15:11:53 -0700183 mEasyFlingThresholdVelocity = (int) (EASY_FLING_THRESHOLD_VELOCITY * density);
Sunny Goyalcf25b522015-07-09 00:01:18 -0700184 mMinFlingVelocity = (int) (MIN_FLING_VELOCITY * density);
185 mMinSnapVelocity = (int) (MIN_SNAP_VELOCITY * density);
Sunny Goyala9f55462018-03-25 18:15:15 -0700186
Sunny Goyalc39db732021-04-03 01:20:21 -0700187 initEdgeEffect();
Sunny Goyaleaf7a952020-07-29 16:54:20 -0700188 setDefaultFocusHighlightEnabled(false);
Sunny Goyalc39db732021-04-03 01:20:21 -0700189 setWillNotDraw(false);
Winson Chung321e9ee2010-08-09 13:37:56 -0700190 }
191
Sunny Goyalc39db732021-04-03 01:20:21 -0700192 protected void initEdgeEffect() {
193 mEdgeGlowLeft = new EdgeEffectCompat(getContext());
194 mEdgeGlowRight = new EdgeEffectCompat(getContext());
Adam Cohenf9618852013-11-08 06:45:03 -0800195 }
196
Sunny Goyald0a6ae72016-06-16 12:29:03 -0700197 public void initParentViews(View parent) {
198 if (mPageIndicatorViewId > -1) {
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800199 mPageIndicator = parent.findViewById(mPageIndicatorViewId);
Sunny Goyalc64cfdd2016-05-18 14:12:02 -0700200 mPageIndicator.setMarkersCount(getChildCount());
Winson Chungd2be3812013-07-16 11:11:32 -0700201 }
202 }
203
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800204 public T getPageIndicator() {
Adam Cohenedb40762013-07-18 16:45:45 -0700205 return mPageIndicator;
206 }
207
Adam Cohen674531f2013-12-13 15:07:14 -0800208 /**
Tony Wickham29d853c2015-09-08 10:35:56 -0700209 * Returns the index of the currently displayed page. When in free scroll mode, this is the page
210 * that the user was on before entering free scroll mode (e.g. the home screen page they
Alex Chaub794ea62021-02-03 18:00:30 +0000211 * long-pressed on to enter the overview). Try using {@link #getDestinationPage()}
Tony Wickham29d853c2015-09-08 10:35:56 -0700212 * to get the page the user is currently scrolling over.
Winson Chung321e9ee2010-08-09 13:37:56 -0700213 */
Sunny Goyal83a8f042015-05-19 12:52:12 -0700214 public int getCurrentPage() {
Winson Chung86f77532010-08-24 11:08:22 -0700215 return mCurrentPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700216 }
Adam Cohen7d30a372013-07-01 17:03:59 -0700217
Hyunyoung Songb76cd622015-04-16 14:34:09 -0700218 /**
219 * Returns the index of page to be shown immediately afterwards.
220 */
Vadim Tryshevfedca432015-08-19 17:55:02 -0700221 public int getNextPage() {
Winson Chung360e63f2012-04-27 13:48:05 -0700222 return (mNextPage != INVALID_PAGE) ? mNextPage : mCurrentPage;
223 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700224
Adam Cohenf9c184a2016-01-15 16:47:43 -0800225 public int getPageCount() {
Winson Chung321e9ee2010-08-09 13:37:56 -0700226 return getChildCount();
227 }
228
Sunny Goyal83a8f042015-05-19 12:52:12 -0700229 public View getPageAt(int index) {
Winson Chung321e9ee2010-08-09 13:37:56 -0700230 return getChildAt(index);
231 }
232
Adam Cohenae4f1552011-10-20 00:15:42 -0700233 protected int indexToPage(int index) {
234 return index;
235 }
236
Winson Chung321e9ee2010-08-09 13:37:56 -0700237 /**
Winson Chungbbc60d82010-11-11 16:34:41 -0800238 * Updates the scroll of the current page immediately to its final scroll position. We use this
239 * in CustomizePagedView to allow tabs to share the same PagedView while resetting the scroll of
240 * the previous tab page.
241 */
242 protected void updateCurrentPageScroll() {
Adam Cohen0ffac432013-07-10 11:19:26 -0700243 // If the current page is invalid, just reset the scroll position to zero
Vinit Nayaka406f722019-12-19 11:50:55 -0800244 int newPosition = 0;
Adam Cohen0ffac432013-07-10 11:19:26 -0700245 if (0 <= mCurrentPage && mCurrentPage < getPageCount()) {
Vinit Nayaka406f722019-12-19 11:50:55 -0800246 newPosition = getScrollForPage(mCurrentPage);
Adam Cohen0ffac432013-07-10 11:19:26 -0700247 }
Vinit Nayaka406f722019-12-19 11:50:55 -0800248 mOrientationHandler.set(this, VIEW_SCROLL_TO, newPosition);
Sunny Goyalc39db732021-04-03 01:20:21 -0700249 mScroller.startScroll(mScroller.getCurrX(), 0, newPosition - mScroller.getCurrX(), 0);
Sunny Goyalc82c6392018-06-06 15:39:13 -0700250 forceFinishScroller(true);
Winson Chungbbc60d82010-11-11 16:34:41 -0800251 }
252
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700253 private void abortScrollerAnimation(boolean resetNextPage) {
Adam Cohen4fe4c932013-10-28 16:02:34 -0700254 mScroller.abortAnimation();
255 // We need to clean up the next page here to avoid computeScrollHelper from
256 // updating current page on the pass.
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700257 if (resetNextPage) {
258 mNextPage = INVALID_PAGE;
Sunny Goyal857b1b92018-03-05 10:49:05 -0800259 pageEndTransition();
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700260 }
Chet Haasebc2f0822012-10-26 17:59:53 -0700261 }
Adam Cohen4fe4c932013-10-28 16:02:34 -0700262
Tony Wickham8f7ead32016-04-07 18:46:44 -0700263 private void forceFinishScroller(boolean resetNextPage) {
Adam Cohen4fe4c932013-10-28 16:02:34 -0700264 mScroller.forceFinished(true);
265 // We need to clean up the next page here to avoid computeScrollHelper from
266 // updating current page on the pass.
Tony Wickham8f7ead32016-04-07 18:46:44 -0700267 if (resetNextPage) {
268 mNextPage = INVALID_PAGE;
Sunny Goyal857b1b92018-03-05 10:49:05 -0800269 pageEndTransition();
Tony Wickham8f7ead32016-04-07 18:46:44 -0700270 }
Adam Cohen4fe4c932013-10-28 16:02:34 -0700271 }
272
Adam Cohen6f127a62014-06-12 14:54:41 -0700273 private int validateNewPage(int newPage) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700274 newPage = ensureWithinScrollBounds(newPage);
Adam Cohen6f127a62014-06-12 14:54:41 -0700275 // Ensure that it is clamped by the actual set of children in all cases
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100276 newPage = Utilities.boundToRange(newPage, 0, getPageCount() - 1);
277
278 if (getPanelCount() > 1) {
279 // Always return left panel as new page
280 newPage = getLeftmostVisiblePageForIndex(newPage);
281 }
282 return newPage;
283 }
284
285 private int getLeftmostVisiblePageForIndex(int pageIndex) {
286 int panelCount = getPanelCount();
287 return (pageIndex / panelCount) * panelCount;
288 }
289
290 /**
291 * Returns the number of pages that are shown at the same time.
292 */
293 protected int getPanelCount() {
294 return 1;
295 }
296
297 /**
Sunny Goyal59969372021-05-06 12:11:44 -0700298 * Executes the callback against each visible page
Andras Kloczl2bb51342021-03-20 01:13:45 +0100299 */
Sunny Goyal59969372021-05-06 12:11:44 -0700300 public void forEachVisiblePage(Consumer<View> callback) {
Andras Kloczl2bb51342021-03-20 01:13:45 +0100301 int panelCount = getPanelCount();
Andras Kloczl2bb51342021-03-20 01:13:45 +0100302 for (int i = mCurrentPage; i < mCurrentPage + panelCount; i++) {
303 View page = getPageAt(i);
304 if (page != null) {
Sunny Goyal59969372021-05-06 12:11:44 -0700305 callback.accept(page);
Andras Kloczl2bb51342021-03-20 01:13:45 +0100306 }
307 }
Andras Kloczl2bb51342021-03-20 01:13:45 +0100308 }
309
310 /**
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100311 * Returns true if the view is on one of the current pages, false otherwise.
312 */
313 public boolean isVisible(View child) {
314 return getLeftmostVisiblePageForIndex(indexOfChild(child)) == mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700315 }
316
Chet Haasebc2f0822012-10-26 17:59:53 -0700317 /**
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700318 * @return The closest page to the provided page that is within mMinScrollX and mMaxScrollX.
319 */
320 private int ensureWithinScrollBounds(int page) {
321 int dir = !mIsRtl ? 1 : - 1;
322 int currScroll = getScrollForPage(page);
323 int prevScroll;
Vinit Nayaka406f722019-12-19 11:50:55 -0800324 while (currScroll < mMinScroll) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700325 page += dir;
326 prevScroll = currScroll;
327 currScroll = getScrollForPage(page);
328 if (currScroll <= prevScroll) {
329 Log.e(TAG, "validateNewPage: failed to find a page > mMinScrollX");
330 break;
331 }
332 }
Vinit Nayaka406f722019-12-19 11:50:55 -0800333 while (currScroll > mMaxScroll) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700334 page -= dir;
335 prevScroll = currScroll;
336 currScroll = getScrollForPage(page);
337 if (currScroll >= prevScroll) {
338 Log.e(TAG, "validateNewPage: failed to find a page < mMaxScrollX");
339 break;
340 }
341 }
342 return page;
343 }
344
Tony Wickham03f27012019-04-25 14:22:54 -0700345 public void setCurrentPage(int currentPage) {
346 setCurrentPage(currentPage, INVALID_PAGE);
347 }
348
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700349 /**
Winson Chung86f77532010-08-24 11:08:22 -0700350 * Sets the current page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700351 */
Tony Wickham03f27012019-04-25 14:22:54 -0700352 public void setCurrentPage(int currentPage, int overridePrevPage) {
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800353 if (!mScroller.isFinished()) {
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700354 abortScrollerAnimation(true);
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800355 }
Michael Jurkad3ef3062010-11-23 16:23:58 -0800356 // don't introduce any checks like mCurrentPage == currentPage here-- if we change the
357 // the default
358 if (getChildCount() == 0) {
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800359 return;
360 }
Tony Wickham03f27012019-04-25 14:22:54 -0700361 int prevPage = overridePrevPage != INVALID_PAGE ? overridePrevPage : mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700362 mCurrentPage = validateNewPage(currentPage);
Winson Chung181c3dc2013-07-17 15:36:20 -0700363 updateCurrentPageScroll();
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700364 notifyPageSwitchListener(prevPage);
Winson Chunga12a2502010-12-20 14:41:35 -0800365 invalidate();
Winson Chung321e9ee2010-08-09 13:37:56 -0700366 }
367
Winson Chung8c87cd82013-07-23 16:20:10 -0700368 /**
Adam Cohen674531f2013-12-13 15:07:14 -0800369 * Should be called whenever the page changes. In the case of a scroll, we wait until the page
370 * has settled.
371 */
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700372 protected void notifyPageSwitchListener(int prevPage) {
Adam Cohen674531f2013-12-13 15:07:14 -0800373 updatePageIndicator();
374 }
375
376 private void updatePageIndicator() {
Sunny Goyal4cbf0462014-08-28 16:19:39 -0700377 if (mPageIndicator != null) {
Tony Mak4f521af2018-03-15 16:37:34 +0000378 mPageIndicator.setActiveMarker(getNextPage());
Winson Chungd2be3812013-07-16 11:11:32 -0700379 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700380 }
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700381 protected void pageBeginTransition() {
382 if (!mIsPageInTransition) {
383 mIsPageInTransition = true;
384 onPageBeginTransition();
Michael Jurkad74c9842011-07-10 12:44:21 -0700385 }
Patrick Dubroy1262e362010-10-06 15:49:50 -0700386 }
387
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700388 protected void pageEndTransition() {
Sunny Goyal05b59c02021-04-29 13:55:40 -0700389 if (mIsPageInTransition && !mIsBeingDragged && mScroller.isFinished()
Sunny Goyalb745a2a2021-04-30 13:38:22 -0700390 && (!isShown() || (mEdgeGlowLeft.isFinished() && mEdgeGlowRight.isFinished()))) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700391 mIsPageInTransition = false;
392 onPageEndTransition();
Michael Jurkad74c9842011-07-10 12:44:21 -0700393 }
Michael Jurka0142d492010-08-25 17:46:15 -0700394 }
395
Sunny Goyalb745a2a2021-04-30 13:38:22 -0700396 @Override
397 public void onVisibilityAggregated(boolean isVisible) {
398 pageEndTransition();
399 super.onVisibilityAggregated(isVisible);
400 }
401
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700402 protected boolean isPageInTransition() {
403 return mIsPageInTransition;
Adam Cohen26976d92011-03-22 15:33:33 -0700404 }
405
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700406 /**
407 * Called when the page starts moving as part of the scroll. Subclasses can override this
408 * to provide custom behavior during animation.
409 */
410 protected void onPageBeginTransition() {
Patrick Dubroy1262e362010-10-06 15:49:50 -0700411 }
412
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700413 /**
414 * Called when the page ends moving as part of the scroll. Subclasses can override this
415 * to provide custom behavior during animation.
416 */
417 protected void onPageEndTransition() {
vadimt4d93df52019-07-10 17:32:58 -0700418 AccessibilityManagerCompat.sendScrollFinishedEventToTest(getContext());
Tony Wickham619daaf2020-02-07 12:29:06 -0800419 AccessibilityManagerCompat.sendCustomAccessibilityEvent(getPageAt(mCurrentPage),
420 AccessibilityEvent.TYPE_VIEW_FOCUSED, null);
Tony Wickham62117d72020-03-26 16:56:26 -0700421 if (mOnPageTransitionEndCallback != null) {
422 mOnPageTransitionEndCallback.run();
423 mOnPageTransitionEndCallback = null;
424 }
425 }
426
427 /**
428 * Sets a callback to run once when the scrolling finishes. If there is currently
429 * no page in transition, then the callback is called immediately.
430 */
431 public void setOnPageTransitionEndCallback(@Nullable Runnable callback) {
432 if (mIsPageInTransition || callback == null) {
433 mOnPageTransitionEndCallback = callback;
434 } else {
435 callback.run();
436 }
Michael Jurka0142d492010-08-25 17:46:15 -0700437 }
438
Adam Cohen68d73932010-11-15 10:50:58 -0800439 @Override
Michael Jurka0142d492010-08-25 17:46:15 -0700440 public void scrollTo(int x, int y) {
Sunny Goyalc39db732021-04-03 01:20:21 -0700441 x = Utilities.boundToRange(x,
442 mOrientationHandler.getPrimaryValue(mMinScroll, 0), mMaxScroll);
443 y = Utilities.boundToRange(y,
444 mOrientationHandler.getPrimaryValue(0, mMinScroll), mMaxScroll);
Vinit Nayaka406f722019-12-19 11:50:55 -0800445 super.scrollTo(x, y);
Michael Jurka0142d492010-08-25 17:46:15 -0700446 }
447
Adam Cohen53805212013-10-01 10:39:23 -0700448 private void sendScrollAccessibilityEvent() {
Sunny Goyald0030b02017-12-08 15:07:24 -0800449 if (isObservedEventType(getContext(), AccessibilityEvent.TYPE_VIEW_SCROLLED)) {
Vadim Tryshevf4715972015-05-08 17:21:03 -0700450 if (mCurrentPage != getNextPage()) {
451 AccessibilityEvent ev =
452 AccessibilityEvent.obtain(AccessibilityEvent.TYPE_VIEW_SCROLLED);
Vadim Tryshev7066c122015-05-21 14:06:35 -0700453 ev.setScrollable(true);
454 ev.setScrollX(getScrollX());
455 ev.setScrollY(getScrollY());
Vinit Nayaka406f722019-12-19 11:50:55 -0800456 mOrientationHandler.setMaxScroll(ev, mMaxScroll);
Vadim Tryshevf4715972015-05-08 17:21:03 -0700457 sendAccessibilityEventUnchecked(ev);
Adam Cohen53805212013-10-01 10:39:23 -0700458 }
Adam Cohen53805212013-10-01 10:39:23 -0700459 }
460 }
461
Michael Jurka0142d492010-08-25 17:46:15 -0700462 // we moved this functionality to a helper function so SmoothPagedView can reuse it
463 protected boolean computeScrollHelper() {
Tony Wickham95cdb3a2016-02-18 14:37:07 -0800464 return computeScrollHelper(true);
465 }
466
Vadim Tryshev2c430b32018-04-04 14:45:21 -0700467 protected void announcePageForAccessibility() {
468 if (isAccessibilityEnabled(getContext())) {
469 // Notify the user when the page changes
470 announceForAccessibility(getCurrentPageDescription());
471 }
472 }
473
Tony Wickham95cdb3a2016-02-18 14:37:07 -0800474 protected boolean computeScrollHelper(boolean shouldInvalidate) {
Winson Chung321e9ee2010-08-09 13:37:56 -0700475 if (mScroller.computeScrollOffset()) {
Winson Chung557d6ed2011-07-08 15:34:52 -0700476 // Don't bother scrolling if the page does not need to be moved
Sunny Goyalc39db732021-04-03 01:20:21 -0700477 int oldPos = mOrientationHandler.getPrimaryScroll(this);
478 int newPos = mScroller.getCurrX();
479 if (oldPos != newPos) {
480 mOrientationHandler.set(this, VIEW_SCROLL_TO, mScroller.getCurrX());
Winson Chung557d6ed2011-07-08 15:34:52 -0700481 }
Tony Wickham95cdb3a2016-02-18 14:37:07 -0800482 if (shouldInvalidate) {
Sunny Goyalc39db732021-04-03 01:20:21 -0700483 if (mAllowOverScroll) {
484 if (newPos < mMinScroll && oldPos >= mMinScroll) {
485 mEdgeGlowLeft.onAbsorb((int) mScroller.getCurrVelocity());
486 mScroller.abortAnimation();
487 } else if (newPos > mMaxScroll && oldPos <= mMaxScroll) {
488 mEdgeGlowRight.onAbsorb((int) mScroller.getCurrVelocity());
489 mScroller.abortAnimation();
490 }
491 }
492
Tony Wickham95cdb3a2016-02-18 14:37:07 -0800493 invalidate();
494 }
Michael Jurka0142d492010-08-25 17:46:15 -0700495 return true;
Tony Wickham95cdb3a2016-02-18 14:37:07 -0800496 } else if (mNextPage != INVALID_PAGE && shouldInvalidate) {
Adam Cohen53805212013-10-01 10:39:23 -0700497 sendScrollAccessibilityEvent();
498
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700499 int prevPage = mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700500 mCurrentPage = validateNewPage(mNextPage);
Winson Chung86f77532010-08-24 11:08:22 -0700501 mNextPage = INVALID_PAGE;
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700502 notifyPageSwitchListener(prevPage);
Winson Chungb44b5242011-06-13 11:32:14 -0700503
Adam Cohen73aa9752010-11-24 16:26:58 -0800504 // We don't want to trigger a page end moving unless the page has settled
505 // and the user has stopped scrolling
Sunny Goyalaad33592018-08-07 17:20:35 -0700506 if (!mIsBeingDragged) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700507 pageEndTransition();
Adam Cohen73aa9752010-11-24 16:26:58 -0800508 }
Winson Chungc27d1bb2011-09-29 12:07:42 -0700509
Vadim Tryshev2c430b32018-04-04 14:45:21 -0700510 if (canAnnouncePageDescription()) {
511 announcePageForAccessibility();
Adam Cohen0ffac432013-07-10 11:19:26 -0700512 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700513 }
Michael Jurka0142d492010-08-25 17:46:15 -0700514 return false;
515 }
516
517 @Override
518 public void computeScroll() {
519 computeScrollHelper();
Winson Chung321e9ee2010-08-09 13:37:56 -0700520 }
521
Sunny Goyalce8809a2018-01-18 14:02:47 -0800522 public int getExpectedHeight() {
523 return getMeasuredHeight();
524 }
525
Adam Cohen410f3cd2013-09-22 12:09:32 -0700526 public int getNormalChildHeight() {
Sunny Goyalce8809a2018-01-18 14:02:47 -0800527 return getExpectedHeight() - getPaddingTop() - getPaddingBottom()
Sunny Goyalac00cba2017-11-13 15:58:01 -0800528 - mInsets.top - mInsets.bottom;
Adam Cohen410f3cd2013-09-22 12:09:32 -0700529 }
530
Sunny Goyalce8809a2018-01-18 14:02:47 -0800531 public int getExpectedWidth() {
532 return getMeasuredWidth();
533 }
534
Sunny Goyalbc683e92017-12-06 10:25:07 -0800535 public int getNormalChildWidth() {
Sunny Goyalce8809a2018-01-18 14:02:47 -0800536 return getExpectedWidth() - getPaddingLeft() - getPaddingRight()
Sunny Goyalbc683e92017-12-06 10:25:07 -0800537 - mInsets.left - mInsets.right;
538 }
539
Winson Chung321e9ee2010-08-09 13:37:56 -0700540 @Override
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800541 public void requestLayout() {
542 mIsLayoutValid = false;
543 super.requestLayout();
544 }
545
546 @Override
547 public void forceLayout() {
548 mIsLayoutValid = false;
549 super.forceLayout();
550 }
551
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100552 private int getPageWidthSize(int widthSize) {
553 return (widthSize - mInsets.left - mInsets.right) / getPanelCount();
554 }
555
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800556 @Override
Winson Chung321e9ee2010-08-09 13:37:56 -0700557 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
Sunny Goyal8e2133b2015-05-06 13:39:07 -0700558 if (getChildCount() == 0) {
Winson Chungf0ea4d32011-06-06 14:27:16 -0700559 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
560 return;
561 }
562
Adam Cohen7d30a372013-07-01 17:03:59 -0700563 // We measure the dimensions of the PagedView to be larger than the pages so that when we
564 // zoom out (and scale down), the view is still contained in the parent
Adam Cohen7d30a372013-07-01 17:03:59 -0700565 int widthMode = MeasureSpec.getMode(widthMeasureSpec);
566 int widthSize = MeasureSpec.getSize(widthMeasureSpec);
567 int heightMode = MeasureSpec.getMode(heightMeasureSpec);
Winson Chung8aad6102012-05-11 16:27:49 -0700568 int heightSize = MeasureSpec.getSize(heightMeasureSpec);
Adam Cohen410f3cd2013-09-22 12:09:32 -0700569
Adam Cohen7d30a372013-07-01 17:03:59 -0700570 if (widthMode == MeasureSpec.UNSPECIFIED || heightMode == MeasureSpec.UNSPECIFIED) {
571 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
572 return;
Winson Chung321e9ee2010-08-09 13:37:56 -0700573 }
574
Winson Chung8aad6102012-05-11 16:27:49 -0700575 // Return early if we aren't given a proper dimension
576 if (widthSize <= 0 || heightSize <= 0) {
577 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
578 return;
579 }
580
Winson Chung321e9ee2010-08-09 13:37:56 -0700581 // The children are given the same width and height as the workspace
Michael Jurka5f1c5092010-09-03 14:15:02 -0700582 // unless they were set to WRAP_CONTENT
Winson Chung785d2eb2011-04-14 16:08:02 -0700583 if (DEBUG) Log.d(TAG, "PagedView.onMeasure(): " + widthSize + ", " + heightSize);
Michael Jurka5f1c5092010-09-03 14:15:02 -0700584
Sunny Goyalac00cba2017-11-13 15:58:01 -0800585 int myWidthSpec = MeasureSpec.makeMeasureSpec(
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100586 getPageWidthSize(widthSize), MeasureSpec.EXACTLY);
Sunny Goyalac00cba2017-11-13 15:58:01 -0800587 int myHeightSpec = MeasureSpec.makeMeasureSpec(
Sunny Goyal228153d2018-01-04 15:35:22 -0800588 heightSize - mInsets.top - mInsets.bottom, MeasureSpec.EXACTLY);
Adam Cohen96d30a12013-07-16 18:13:21 -0700589
Sunny Goyalac00cba2017-11-13 15:58:01 -0800590 // measureChildren takes accounts for content padding, we only need to care about extra
591 // space due to insets.
592 measureChildren(myWidthSpec, myHeightSpec);
593 setMeasuredDimension(widthSize, heightSize);
Adam Cohen60b07122011-11-14 17:26:06 -0800594 }
595
Sunny Goyalcf25b522015-07-09 00:01:18 -0700596 @SuppressLint("DrawAllocation")
Winson Chung321e9ee2010-08-09 13:37:56 -0700597 @Override
Michael Jurka28750fb2010-09-24 17:43:49 -0700598 protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800599 mIsLayoutValid = true;
Vadim Trysheveb701c62018-05-14 16:00:15 -0700600 final int childCount = getChildCount();
601 boolean pageScrollChanged = false;
602 if (mPageScrolls == null || childCount != mPageScrolls.length) {
603 mPageScrolls = new int[childCount];
604 pageScrollChanged = true;
605 }
606
607 if (childCount == 0) {
Winson Chungf0ea4d32011-06-06 14:27:16 -0700608 return;
609 }
610
Winson Chung785d2eb2011-04-14 16:08:02 -0700611 if (DEBUG) Log.d(TAG, "PagedView.onLayout()");
Winson Chung321e9ee2010-08-09 13:37:56 -0700612
Vinit Nayaka406f722019-12-19 11:50:55 -0800613 boolean isScrollChanged = getPageScrolls(mPageScrolls, true, SIMPLE_SCROLL_LOGIC);
614 if (isScrollChanged) {
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700615 pageScrollChanged = true;
Winson Chung321e9ee2010-08-09 13:37:56 -0700616 }
Winson Chungc3665fa2011-09-14 17:56:27 -0700617
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700618 final LayoutTransition transition = getLayoutTransition();
619 // If the transition is running defer updating max scroll, as some empty pages could
620 // still be present, and a max scroll change could cause sudden jumps in scroll.
621 if (transition != null && transition.isRunning()) {
622 transition.addTransitionListener(new LayoutTransition.TransitionListener() {
623
624 @Override
625 public void startTransition(LayoutTransition transition, ViewGroup container,
626 View view, int transitionType) { }
627
628 @Override
629 public void endTransition(LayoutTransition transition, ViewGroup container,
630 View view, int transitionType) {
631 // Wait until all transitions are complete.
632 if (!transition.isRunning()) {
633 transition.removeTransitionListener(this);
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700634 updateMinAndMaxScrollX();
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700635 }
636 }
637 });
Adam Cohenf698c6e2013-07-17 18:44:25 -0700638 } else {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700639 updateMinAndMaxScrollX();
Adam Cohenf698c6e2013-07-17 18:44:25 -0700640 }
641
Sunny Goyalcb037ee2015-07-08 16:41:21 -0700642 if (mFirstLayout && mCurrentPage >= 0 && mCurrentPage < childCount) {
643 updateCurrentPageScroll();
644 mFirstLayout = false;
645 }
646
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800647 if (mScroller.isFinished() && pageScrollChanged) {
Sunny Goyalc82c6392018-06-06 15:39:13 -0700648 setCurrentPage(getNextPage());
Adam Cohenf698c6e2013-07-17 18:44:25 -0700649 }
Winson Chunge3193b92010-09-10 11:44:42 -0700650 }
651
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700652 /**
653 * Initializes {@code outPageScrolls} with scroll positions for view at that index. The length
654 * of {@code outPageScrolls} should be same as the the childCount
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700655 */
656 protected boolean getPageScrolls(int[] outPageScrolls, boolean layoutChildren,
657 ComputePageScrollsLogic scrollLogic) {
658 final int childCount = getChildCount();
659
660 final int startIndex = mIsRtl ? childCount - 1 : 0;
661 final int endIndex = mIsRtl ? -1 : childCount;
662 final int delta = mIsRtl ? -1 : 1;
663
Vinit Nayaka406f722019-12-19 11:50:55 -0800664 final int pageCenter = mOrientationHandler.getCenterForPage(this, mInsets);
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700665
Vinit Nayaka406f722019-12-19 11:50:55 -0800666 final int scrollOffsetStart = mOrientationHandler.getScrollOffsetStart(this, mInsets);
667 final int scrollOffsetEnd = mOrientationHandler.getScrollOffsetEnd(this, mInsets);
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700668 boolean pageScrollChanged = false;
669
Vinit Nayaka406f722019-12-19 11:50:55 -0800670 for (int i = startIndex, childStart = scrollOffsetStart; i != endIndex; i += delta) {
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700671 final View child = getPageAt(i);
672 if (scrollLogic.shouldIncludeView(child)) {
Vinit Nayaka406f722019-12-19 11:50:55 -0800673 ChildBounds bounds = mOrientationHandler.getChildBounds(child, childStart,
674 pageCenter, layoutChildren);
675 final int primaryDimension = bounds.primaryDimension;
676 final int childPrimaryEnd = bounds.childPrimaryEnd;
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700677
Alex Chaub5c4d112021-03-29 17:37:53 +0100678 // In case the pages are of different width, align the page to left edge for non-RTL
679 // or right edge for RTL.
680 final int pageScroll =
681 mIsRtl ? childPrimaryEnd - scrollOffsetEnd : childStart - scrollOffsetStart;
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700682 if (outPageScrolls[i] != pageScroll) {
683 pageScrollChanged = true;
684 outPageScrolls[i] = pageScroll;
685 }
Vinit Nayaka406f722019-12-19 11:50:55 -0800686 childStart += primaryDimension + mPageSpacing + getChildGap();
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700687 }
688 }
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100689
690 int panelCount = getPanelCount();
691 if (panelCount > 1) {
692 for (int i = 0; i < childCount; i++) {
693 // In case we have multiple panels, always use left panel's page scroll for all
694 // panels on the screen.
695 int adjustedScroll = outPageScrolls[getLeftmostVisiblePageForIndex(i)];
696 if (outPageScrolls[i] != adjustedScroll) {
697 outPageScrolls[i] = adjustedScroll;
698 pageScrollChanged = true;
699 }
700 }
701 }
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700702 return pageScrollChanged;
703 }
704
Sunny Goyala1fbd842015-05-20 13:40:27 -0700705 protected int getChildGap() {
706 return 0;
707 }
708
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700709 protected void updateMinAndMaxScrollX() {
Vinit Nayaka406f722019-12-19 11:50:55 -0800710 mMinScroll = computeMinScroll();
711 mMaxScroll = computeMaxScroll();
Tony Wickhamf549dab2016-05-16 09:54:06 -0700712 }
713
Vinit Nayaka406f722019-12-19 11:50:55 -0800714 protected int computeMinScroll() {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700715 return 0;
Tony50876bf2018-09-19 23:09:14 -0400716 }
717
Vinit Nayaka406f722019-12-19 11:50:55 -0800718 protected int computeMaxScroll() {
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700719 int childCount = getChildCount();
720 if (childCount > 0) {
Sunny Goyal70660032015-05-14 00:07:08 -0700721 final int index = mIsRtl ? 0 : childCount - 1;
Tony Wickhamf549dab2016-05-16 09:54:06 -0700722 return getScrollForPage(index);
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700723 } else {
Tony Wickhamf549dab2016-05-16 09:54:06 -0700724 return 0;
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700725 }
726 }
727
Adam Cohen3b185e22013-10-29 14:45:58 -0700728 public void setPageSpacing(int pageSpacing) {
729 mPageSpacing = pageSpacing;
730 requestLayout();
731 }
732
Tony50876bf2018-09-19 23:09:14 -0400733 public int getPageSpacing() {
734 return mPageSpacing;
735 }
736
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800737 private void dispatchPageCountChanged() {
738 if (mPageIndicator != null) {
739 mPageIndicator.setMarkersCount(getChildCount());
Winson Chungd2be3812013-07-16 11:11:32 -0700740 }
Adam Cohen2591f6a2011-10-25 14:36:40 -0700741 // This ensures that when children are added, they get the correct transforms / alphas
742 // in accordance with any scroll effects.
Adam Cohen2591f6a2011-10-25 14:36:40 -0700743 invalidate();
744 }
745
Michael Jurka8b805b12012-04-18 14:23:14 -0700746 @Override
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800747 public void onViewAdded(View child) {
Winson Chungc7c51582018-02-23 17:58:36 -0800748 super.onViewAdded(child);
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800749 dispatchPageCountChanged();
750 }
751
752 @Override
753 public void onViewRemoved(View child) {
Winson Chungc7c51582018-02-23 17:58:36 -0800754 super.onViewRemoved(child);
Tonya361c722017-07-04 09:43:06 -0700755 mCurrentPage = validateNewPage(mCurrentPage);
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800756 dispatchPageCountChanged();
Winson Chungd2be3812013-07-16 11:11:32 -0700757 }
758
Adam Cohen73894962011-10-31 13:17:17 -0700759 protected int getChildOffset(int index) {
Adam Cohen7d30a372013-07-01 17:03:59 -0700760 if (index < 0 || index > getChildCount() - 1) return 0;
Vinit Nayaka406f722019-12-19 11:50:55 -0800761 View pageAtIndex = getPageAt(index);
762 return mOrientationHandler.getChildStart(pageAtIndex);
Adam Cohen73894962011-10-31 13:17:17 -0700763 }
764
Alex Chau7944ee52021-01-08 19:07:25 +0000765 protected int getChildVisibleSize(int index) {
766 View layout = getPageAt(index);
767 return mOrientationHandler.getMeasuredSize(layout);
768 }
769
Winson Chung321e9ee2010-08-09 13:37:56 -0700770 @Override
771 public boolean requestChildRectangleOnScreen(View child, Rect rectangle, boolean immediate) {
Adam Cohenae4f1552011-10-20 00:15:42 -0700772 int page = indexToPage(indexOfChild(child));
Winson Chung86f77532010-08-24 11:08:22 -0700773 if (page != mCurrentPage || !mScroller.isFinished()) {
Vadim Trysheveeaa8ee2018-04-11 12:23:42 -0700774 if (immediate) {
775 setCurrentPage(page);
776 } else {
777 snapToPage(page);
778 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700779 return true;
780 }
781 return false;
782 }
783
784 @Override
785 protected boolean onRequestFocusInDescendants(int direction, Rect previouslyFocusedRect) {
Winson Chung86f77532010-08-24 11:08:22 -0700786 int focusablePage;
787 if (mNextPage != INVALID_PAGE) {
788 focusablePage = mNextPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700789 } else {
Winson Chung86f77532010-08-24 11:08:22 -0700790 focusablePage = mCurrentPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700791 }
Winson Chung86f77532010-08-24 11:08:22 -0700792 View v = getPageAt(focusablePage);
Winson Chung321e9ee2010-08-09 13:37:56 -0700793 if (v != null) {
Adam Cohen76fc0852011-06-17 13:26:23 -0700794 return v.requestFocus(direction, previouslyFocusedRect);
Winson Chung321e9ee2010-08-09 13:37:56 -0700795 }
796 return false;
797 }
798
799 @Override
800 public boolean dispatchUnhandledMove(View focused, int direction) {
Sunny Goyal0c4e3722015-12-01 13:21:49 -0800801 if (super.dispatchUnhandledMove(focused, direction)) {
802 return true;
803 }
804
805 if (mIsRtl) {
806 if (direction == View.FOCUS_LEFT) {
807 direction = View.FOCUS_RIGHT;
808 } else if (direction == View.FOCUS_RIGHT) {
809 direction = View.FOCUS_LEFT;
810 }
811 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700812 if (direction == View.FOCUS_LEFT) {
Winson Chung86f77532010-08-24 11:08:22 -0700813 if (getCurrentPage() > 0) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100814 int nextPage = validateNewPage(getCurrentPage() - 1);
815 snapToPage(nextPage);
816 getChildAt(nextPage).requestFocus(direction);
Winson Chung321e9ee2010-08-09 13:37:56 -0700817 return true;
818 }
819 } else if (direction == View.FOCUS_RIGHT) {
Winson Chung86f77532010-08-24 11:08:22 -0700820 if (getCurrentPage() < getPageCount() - 1) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100821 int nextPage = validateNewPage(getCurrentPage() + 1);
822 snapToPage(nextPage);
823 getChildAt(nextPage).requestFocus(direction);
Winson Chung321e9ee2010-08-09 13:37:56 -0700824 return true;
825 }
826 }
Sunny Goyal0c4e3722015-12-01 13:21:49 -0800827 return false;
Winson Chung321e9ee2010-08-09 13:37:56 -0700828 }
829
830 @Override
831 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) {
Jon Miranda6a858172016-10-25 16:19:17 -0700832 if (getDescendantFocusability() == FOCUS_BLOCK_DESCENDANTS) {
833 return;
834 }
835
Adam Cohen0ffac432013-07-10 11:19:26 -0700836 // XXX-RTL: This will be fixed in a future CL
Winson Chung86f77532010-08-24 11:08:22 -0700837 if (mCurrentPage >= 0 && mCurrentPage < getPageCount()) {
alanvaf519952012-05-07 17:33:22 -0700838 getPageAt(mCurrentPage).addFocusables(views, direction, focusableMode);
Winson Chung321e9ee2010-08-09 13:37:56 -0700839 }
840 if (direction == View.FOCUS_LEFT) {
Winson Chung86f77532010-08-24 11:08:22 -0700841 if (mCurrentPage > 0) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100842 int nextPage = validateNewPage(mCurrentPage - 1);
843 getPageAt(nextPage).addFocusables(views, direction, focusableMode);
Winson Chung321e9ee2010-08-09 13:37:56 -0700844 }
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100845 } else if (direction == View.FOCUS_RIGHT) {
Winson Chung86f77532010-08-24 11:08:22 -0700846 if (mCurrentPage < getPageCount() - 1) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100847 int nextPage = validateNewPage(mCurrentPage + 1);
848 getPageAt(nextPage).addFocusables(views, direction, focusableMode);
Winson Chung321e9ee2010-08-09 13:37:56 -0700849 }
850 }
851 }
852
853 /**
854 * If one of our descendant views decides that it could be focused now, only
Winson Chung86f77532010-08-24 11:08:22 -0700855 * pass that along if it's on the current page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700856 *
Winson Chung86f77532010-08-24 11:08:22 -0700857 * This happens when live folders requery, and if they're off page, they
858 * end up calling requestFocus, which pulls it on page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700859 */
860 @Override
861 public void focusableViewAvailable(View focused) {
Winson Chung86f77532010-08-24 11:08:22 -0700862 View current = getPageAt(mCurrentPage);
Winson Chung321e9ee2010-08-09 13:37:56 -0700863 View v = focused;
864 while (true) {
865 if (v == current) {
866 super.focusableViewAvailable(focused);
867 return;
868 }
869 if (v == this) {
870 return;
871 }
872 ViewParent parent = v.getParent();
873 if (parent instanceof View) {
874 v = (View)v.getParent();
875 } else {
876 return;
877 }
878 }
879 }
880
881 /**
882 * {@inheritDoc}
883 */
884 @Override
885 public void requestDisallowInterceptTouchEvent(boolean disallowIntercept) {
886 if (disallowIntercept) {
887 // We need to make sure to cancel our long press if
888 // a scrollable widget takes over touch events
Andras Kloczl7a1ca0b2021-04-08 16:08:16 +0200889 cancelCurrentPageLongPress();
Winson Chung321e9ee2010-08-09 13:37:56 -0700890 }
891 super.requestDisallowInterceptTouchEvent(disallowIntercept);
892 }
893
894 @Override
895 public boolean onInterceptTouchEvent(MotionEvent ev) {
896 /*
897 * This method JUST determines whether we want to intercept the motion.
898 * If we return true, onTouchEvent will be called and we do the actual
899 * scrolling there.
900 */
901
Winson Chung45e1d6e2010-11-09 17:19:49 -0800902 // Skip touch handling if there are no pages to swipe
Tony Wickhamb6841ac2019-07-22 12:39:59 -0700903 if (getChildCount() <= 0) return false;
Sunny Goyalc4bb3732019-06-20 11:34:14 -0700904
905 acquireVelocityTrackerAndAddMovement(ev);
Winson Chung45e1d6e2010-11-09 17:19:49 -0800906
Winson Chung321e9ee2010-08-09 13:37:56 -0700907 /*
908 * Shortcut the most recurring case: the user is in the dragging
909 * state and he is moving his finger. We want to intercept this
910 * motion.
911 */
912 final int action = ev.getAction();
Sunny Goyalaad33592018-08-07 17:20:35 -0700913 if ((action == MotionEvent.ACTION_MOVE) && mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -0700914 return true;
915 }
916
Winson Chung321e9ee2010-08-09 13:37:56 -0700917 switch (action & MotionEvent.ACTION_MASK) {
918 case MotionEvent.ACTION_MOVE: {
919 /*
920 * mIsBeingDragged == false, otherwise the shortcut would have caught it. Check
Vinit Nayaka406f722019-12-19 11:50:55 -0800921 * whether the user has moved far enough from their original down touch.
Winson Chung321e9ee2010-08-09 13:37:56 -0700922 */
Michael Jurka1ff706b2010-09-14 17:35:20 -0700923 if (mActivePointerId != INVALID_POINTER) {
924 determineScrollingStart(ev);
Michael Jurka1ff706b2010-09-14 17:35:20 -0700925 }
926 // if mActivePointerId is INVALID_POINTER, then we must have missed an ACTION_DOWN
Vinit Nayaka406f722019-12-19 11:50:55 -0800927 // event. in that case, treat the first occurrence of a move event as a ACTION_DOWN
Michael Jurka1ff706b2010-09-14 17:35:20 -0700928 // i.e. fall through to the next case (don't break)
929 // (We sometimes miss ACTION_DOWN events in Workspace because it ignores all events
930 // while it's small- this was causing a crash before we checked for INVALID_POINTER)
Adam Cohen93c97562013-09-26 13:48:01 -0700931 break;
Winson Chung321e9ee2010-08-09 13:37:56 -0700932 }
933
934 case MotionEvent.ACTION_DOWN: {
935 final float x = ev.getX();
936 final float y = ev.getY();
937 // Remember location of down touch
938 mDownMotionX = x;
Adam Cohen7d30a372013-07-01 17:03:59 -0700939 mDownMotionY = y;
Jon Mirandaf52af432020-04-10 17:25:57 -0700940 mDownMotionPrimary = mLastMotion = mOrientationHandler.getPrimaryDirection(ev, 0);
Vinit Nayaka406f722019-12-19 11:50:55 -0800941 mLastMotionRemainder = 0;
942 mTotalMotion = 0;
Winson Chung4941f652020-06-18 15:11:53 -0700943 mAllowEasyFling = false;
Winson Chung321e9ee2010-08-09 13:37:56 -0700944 mActivePointerId = ev.getPointerId(0);
Sunny Goyalc39db732021-04-03 01:20:21 -0700945 updateIsBeingDraggedOnTouchDown(ev);
Winson Chung321e9ee2010-08-09 13:37:56 -0700946 break;
947 }
948
Winson Chung321e9ee2010-08-09 13:37:56 -0700949 case MotionEvent.ACTION_UP:
Jeff Brown1d0867c2010-12-02 18:27:39 -0800950 case MotionEvent.ACTION_CANCEL:
Adam Cohen7d30a372013-07-01 17:03:59 -0700951 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -0700952 break;
953
954 case MotionEvent.ACTION_POINTER_UP:
955 onSecondaryPointerUp(ev);
Adam Cohen6342bba2011-03-10 11:33:35 -0800956 releaseVelocityTracker();
Winson Chung321e9ee2010-08-09 13:37:56 -0700957 break;
958 }
959
960 /*
961 * The only time we want to intercept motion events is if we are in the
962 * drag mode.
963 */
Sunny Goyalaad33592018-08-07 17:20:35 -0700964 return mIsBeingDragged;
Winson Chung321e9ee2010-08-09 13:37:56 -0700965 }
966
Tony Wickhama0aee212019-09-18 09:24:03 -0700967 /**
968 * If being flinged and user touches the screen, initiate drag; otherwise don't.
969 */
Sunny Goyalc39db732021-04-03 01:20:21 -0700970 private void updateIsBeingDraggedOnTouchDown(MotionEvent ev) {
Tony Wickhama0aee212019-09-18 09:24:03 -0700971 // mScroller.isFinished should be false when being flinged.
Sunny Goyalc39db732021-04-03 01:20:21 -0700972 final int xDist = Math.abs(mScroller.getFinalX() - mScroller.getCurrX());
Winson Chung4941f652020-06-18 15:11:53 -0700973 final boolean finishedScrolling = (mScroller.isFinished() || xDist < mPageSlop / 3);
Tony Wickhama0aee212019-09-18 09:24:03 -0700974
975 if (finishedScrolling) {
976 mIsBeingDragged = false;
977 if (!mScroller.isFinished() && !mFreeScroll) {
978 setCurrentPage(getNextPage());
979 pageEndTransition();
980 }
Sunny Goyalc39db732021-04-03 01:20:21 -0700981 mIsBeingDragged = !mEdgeGlowLeft.isFinished() || !mEdgeGlowRight.isFinished();
Tony Wickhama0aee212019-09-18 09:24:03 -0700982 } else {
983 mIsBeingDragged = true;
984 }
Sunny Goyalc39db732021-04-03 01:20:21 -0700985
986 // Catch the edge effect if it is active.
987 float displacement = mOrientationHandler.getSecondaryValue(ev.getX(), ev.getY())
988 / mOrientationHandler.getSecondaryValue(getWidth(), getHeight());
989 if (!mEdgeGlowLeft.isFinished()) {
990 mEdgeGlowLeft.onPullDistance(0f, 1f - displacement);
991 }
992 if (!mEdgeGlowRight.isFinished()) {
993 mEdgeGlowRight.onPullDistance(0f, displacement);
994 }
Tony Wickhama0aee212019-09-18 09:24:03 -0700995 }
996
Sunny Goyal7c7be8c2018-03-07 19:58:07 -0800997 public boolean isHandlingTouch() {
Sunny Goyalaad33592018-08-07 17:20:35 -0700998 return mIsBeingDragged;
Sunny Goyal7c7be8c2018-03-07 19:58:07 -0800999 }
1000
Adam Cohenf8d28232011-02-01 21:47:00 -08001001 protected void determineScrollingStart(MotionEvent ev) {
1002 determineScrollingStart(ev, 1.0f);
1003 }
1004
Winson Chung321e9ee2010-08-09 13:37:56 -07001005 /*
1006 * Determines if we should change the touch state to start scrolling after the
1007 * user moves their touch point too far.
1008 */
Adam Cohenf8d28232011-02-01 21:47:00 -08001009 protected void determineScrollingStart(MotionEvent ev, float touchSlopScale) {
Adam Cohen7d30a372013-07-01 17:03:59 -07001010 // Disallow scrolling if we don't have a valid pointer index
Winson Chung321e9ee2010-08-09 13:37:56 -07001011 final int pointerIndex = ev.findPointerIndex(mActivePointerId);
Adam Cohen7d30a372013-07-01 17:03:59 -07001012 if (pointerIndex == -1) return;
1013
Vinit Nayaka406f722019-12-19 11:50:55 -08001014 final float primaryDirection = mOrientationHandler.getPrimaryDirection(ev, pointerIndex);
1015 final int diff = (int) Math.abs(primaryDirection - mLastMotion);
Adam Cohenf8d28232011-02-01 21:47:00 -08001016 final int touchSlop = Math.round(touchSlopScale * mTouchSlop);
Winson Chung4941f652020-06-18 15:11:53 -07001017 boolean moved = diff > touchSlop || ev.getAction() == ACTION_MOVE_ALLOW_EASY_FLING;
Winson Chung321e9ee2010-08-09 13:37:56 -07001018
Vinit Nayaka406f722019-12-19 11:50:55 -08001019 if (moved) {
Sunny Goyal5a1f53b2015-05-27 10:24:24 -07001020 // Scroll if the user moved far enough along the X axis
Sunny Goyalaad33592018-08-07 17:20:35 -07001021 mIsBeingDragged = true;
Vinit Nayaka406f722019-12-19 11:50:55 -08001022 mTotalMotion += Math.abs(mLastMotion - primaryDirection);
1023 mLastMotion = primaryDirection;
1024 mLastMotionRemainder = 0;
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001025 pageBeginTransition();
Tony Wickhamdadb3042016-02-24 11:07:00 -08001026 // Stop listening for things like pinches.
1027 requestDisallowInterceptTouchEvent(true);
Adam Cohenf8d28232011-02-01 21:47:00 -08001028 }
1029 }
1030
1031 protected void cancelCurrentPageLongPress() {
Sunny Goyal8e2133b2015-05-06 13:39:07 -07001032 // Try canceling the long press. It could also have been scheduled
1033 // by a distant descendant, so use the mAllowLongPress flag to block
1034 // everything
Sunny Goyal59969372021-05-06 12:11:44 -07001035 forEachVisiblePage(View::cancelLongPress);
Winson Chung321e9ee2010-08-09 13:37:56 -07001036 }
1037
Adam Cohenb5ba0972011-09-07 18:02:31 -07001038 protected float getScrollProgress(int screenCenter, View v, int page) {
Sunny Goyal228153d2018-01-04 15:35:22 -08001039 final int halfScreenSize = getMeasuredWidth() / 2;
Adam Cohenb5ba0972011-09-07 18:02:31 -07001040
Adam Cohenedb40762013-07-18 16:45:45 -07001041 int delta = screenCenter - (getScrollForPage(page) + halfScreenSize);
Adam Cohen3b185e22013-10-29 14:45:58 -07001042 int count = getChildCount();
1043
1044 final int totalDistance;
1045
1046 int adjacentPage = page + 1;
Sunny Goyal70660032015-05-14 00:07:08 -07001047 if ((delta < 0 && !mIsRtl) || (delta > 0 && mIsRtl)) {
Adam Cohen3b185e22013-10-29 14:45:58 -07001048 adjacentPage = page - 1;
1049 }
1050
1051 if (adjacentPage < 0 || adjacentPage > count - 1) {
1052 totalDistance = v.getMeasuredWidth() + mPageSpacing;
1053 } else {
1054 totalDistance = Math.abs(getScrollForPage(adjacentPage) - getScrollForPage(page));
1055 }
Adam Cohenb5ba0972011-09-07 18:02:31 -07001056
1057 float scrollProgress = delta / (totalDistance * 1.0f);
Sunny Goyal8e2133b2015-05-06 13:39:07 -07001058 scrollProgress = Math.min(scrollProgress, MAX_SCROLL_PROGRESS);
1059 scrollProgress = Math.max(scrollProgress, - MAX_SCROLL_PROGRESS);
Adam Cohenb5ba0972011-09-07 18:02:31 -07001060 return scrollProgress;
1061 }
1062
Adam Cohenedb40762013-07-18 16:45:45 -07001063 public int getScrollForPage(int index) {
Adam Cohen1f1f45d2013-10-02 09:40:18 -07001064 if (mPageScrolls == null || index >= mPageScrolls.length || index < 0) {
Adam Cohenedb40762013-07-18 16:45:45 -07001065 return 0;
1066 } else {
1067 return mPageScrolls[index];
1068 }
1069 }
1070
Adam Cohen564a2e72013-10-09 14:47:32 -07001071 // While layout transitions are occurring, a child's position may stray from its baseline
1072 // position. This method returns the magnitude of this stray at any given time.
1073 public int getLayoutTransitionOffsetForPage(int index) {
1074 if (mPageScrolls == null || index >= mPageScrolls.length || index < 0) {
1075 return 0;
1076 } else {
1077 View child = getChildAt(index);
Adam Cohen3b185e22013-10-29 14:45:58 -07001078
Sunny Goyal228153d2018-01-04 15:35:22 -08001079 int scrollOffset = mIsRtl ? getPaddingRight() : getPaddingLeft();
1080 int baselineX = mPageScrolls[index] + scrollOffset;
Adam Cohen564a2e72013-10-09 14:47:32 -07001081 return (int) (child.getX() - baselineX);
1082 }
1083 }
1084
Tony Wickham023f4042019-01-29 10:52:31 -08001085 public void setEnableFreeScroll(boolean freeScroll) {
Winson Chung0e449002019-04-26 11:09:58 -07001086 if (mFreeScroll == freeScroll) {
1087 return;
1088 }
1089
Tony Wickham8f7ead32016-04-07 18:46:44 -07001090 boolean wasFreeScroll = mFreeScroll;
Adam Cohenf358a4b2013-07-23 16:47:31 -07001091 mFreeScroll = freeScroll;
1092
Adam Cohenf9618852013-11-08 06:45:03 -08001093 if (mFreeScroll) {
Sunny Goyal4d519f22017-10-24 10:32:40 -07001094 setCurrentPage(getNextPage());
Tony Wickham8f7ead32016-04-07 18:46:44 -07001095 } else if (wasFreeScroll) {
Tony Wickhamaf33f2c2019-10-04 12:55:22 -07001096 if (getScrollForPage(getNextPage()) != getScrollX()) {
1097 snapToPage(getNextPage());
1098 }
Adam Cohenf358a4b2013-07-23 16:47:31 -07001099 }
Adam Cohenf358a4b2013-07-23 16:47:31 -07001100 }
1101
Sunny Goyal2f0ec852015-03-26 13:38:27 -07001102 protected void setEnableOverscroll(boolean enable) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001103 mAllowOverScroll = enable;
1104 }
1105
Winson Chung321e9ee2010-08-09 13:37:56 -07001106 @Override
1107 public boolean onTouchEvent(MotionEvent ev) {
Winson Chung45e1d6e2010-11-09 17:19:49 -08001108 // Skip touch handling if there are no pages to swipe
Tony Wickhamb6841ac2019-07-22 12:39:59 -07001109 if (getChildCount() <= 0) return false;
Winson Chung45e1d6e2010-11-09 17:19:49 -08001110
Michael Jurkab8f06722010-10-10 15:58:46 -07001111 acquireVelocityTrackerAndAddMovement(ev);
Winson Chung321e9ee2010-08-09 13:37:56 -07001112
1113 final int action = ev.getAction();
1114
1115 switch (action & MotionEvent.ACTION_MASK) {
1116 case MotionEvent.ACTION_DOWN:
Sunny Goyalc39db732021-04-03 01:20:21 -07001117 updateIsBeingDraggedOnTouchDown(ev);
Tony Wickhama0aee212019-09-18 09:24:03 -07001118
Winson Chung321e9ee2010-08-09 13:37:56 -07001119 /*
1120 * If being flinged and user touches, stop the fling. isFinished
1121 * will be false if being flinged.
1122 */
1123 if (!mScroller.isFinished()) {
Adam Cohen8bdbaab2013-10-29 15:25:02 -07001124 abortScrollerAnimation(false);
Winson Chung321e9ee2010-08-09 13:37:56 -07001125 }
1126
1127 // Remember where the motion event started
Vinit Nayaka406f722019-12-19 11:50:55 -08001128 mDownMotionX = ev.getX();
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001129 mDownMotionY = ev.getY();
Vinit Nayaka406f722019-12-19 11:50:55 -08001130 mDownMotionPrimary = mLastMotion = mOrientationHandler.getPrimaryDirection(ev, 0);
1131 mLastMotionRemainder = 0;
1132 mTotalMotion = 0;
Winson Chung4941f652020-06-18 15:11:53 -07001133 mAllowEasyFling = false;
Winson Chung321e9ee2010-08-09 13:37:56 -07001134 mActivePointerId = ev.getPointerId(0);
Sunny Goyalaad33592018-08-07 17:20:35 -07001135 if (mIsBeingDragged) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001136 pageBeginTransition();
Michael Jurka0142d492010-08-25 17:46:15 -07001137 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001138 break;
1139
Winson Chung4941f652020-06-18 15:11:53 -07001140 case ACTION_MOVE_ALLOW_EASY_FLING:
1141 // Start scrolling immediately
1142 determineScrollingStart(ev);
1143 mAllowEasyFling = true;
1144 break;
1145
1146 case MotionEvent.ACTION_MOVE:
1147 if (mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001148 // Scroll to follow the motion event
1149 final int pointerIndex = ev.findPointerIndex(mActivePointerId);
Adam Cohen7d30a372013-07-01 17:03:59 -07001150
1151 if (pointerIndex == -1) return true;
Sunny Goyalc39db732021-04-03 01:20:21 -07001152 float oldScroll = mOrientationHandler.getPrimaryScroll(this);
1153 float dx = ev.getX(pointerIndex);
1154 float dy = ev.getY(pointerIndex);
Adam Cohen7d30a372013-07-01 17:03:59 -07001155
Sunny Goyalc39db732021-04-03 01:20:21 -07001156 float direction = mOrientationHandler.getPrimaryValue(dx, dy);
Vinit Nayaka406f722019-12-19 11:50:55 -08001157 float delta = mLastMotion + mLastMotionRemainder - direction;
Sunny Goyalc39db732021-04-03 01:20:21 -07001158
1159 int width = getWidth();
1160 int height = getHeight();
1161 int size = mOrientationHandler.getPrimaryValue(width, height);
1162
1163 final float displacement = mOrientationHandler.getSecondaryValue(dx, dy)
1164 / mOrientationHandler.getSecondaryValue(width, height);
Vinit Nayaka406f722019-12-19 11:50:55 -08001165 mTotalMotion += Math.abs(delta);
Adam Cohenaefd4e12011-02-14 16:39:38 -08001166
Sunny Goyalc39db732021-04-03 01:20:21 -07001167 if (mAllowOverScroll) {
1168 float consumed = 0;
1169 if (delta < 0 && mEdgeGlowRight.getDistance() != 0f) {
1170 consumed = size * mEdgeGlowRight.onPullDistance(delta / size, displacement);
1171 } else if (delta > 0 && mEdgeGlowLeft.getDistance() != 0f) {
1172 consumed = -size * mEdgeGlowLeft.onPullDistance(
1173 -delta / size, 1 - displacement);
1174 }
1175 delta -= consumed;
1176 }
1177
Winson Chungc0844aa2011-02-02 15:25:58 -08001178 // Only scroll and update mLastMotionX if we have moved some discrete amount. We
1179 // keep the remainder because we are actually testing if we've moved from the last
1180 // scrolled position (which is discrete).
Sunny Goyalc39db732021-04-03 01:20:21 -07001181 mLastMotion = direction;
1182 int movedDelta = (int) delta;
1183 mLastMotionRemainder = delta - movedDelta;
Vinit Nayaka406f722019-12-19 11:50:55 -08001184
Sunny Goyalc39db732021-04-03 01:20:21 -07001185 if (delta != 0) {
1186 mOrientationHandler.set(this, VIEW_SCROLL_BY, movedDelta);
1187
1188 if (mAllowOverScroll) {
1189 final float pulledToX = oldScroll + delta;
1190
1191 if (pulledToX < mMinScroll) {
1192 mEdgeGlowLeft.onPullDistance(-delta / size, 1.f - displacement);
1193 if (!mEdgeGlowRight.isFinished()) {
1194 mEdgeGlowRight.onRelease();
1195 }
1196 } else if (pulledToX > mMaxScroll) {
1197 mEdgeGlowRight.onPullDistance(delta / size, displacement);
1198 if (!mEdgeGlowLeft.isFinished()) {
1199 mEdgeGlowLeft.onRelease();
1200 }
1201 }
1202
1203 if (!mEdgeGlowLeft.isFinished() || !mEdgeGlowRight.isFinished()) {
1204 postInvalidateOnAnimation();
1205 }
1206 }
1207
Winson Chung321e9ee2010-08-09 13:37:56 -07001208 } else {
1209 awakenScrollBars();
1210 }
Adam Cohen564976a2010-10-13 18:52:07 -07001211 } else {
Winson Chung321e9ee2010-08-09 13:37:56 -07001212 determineScrollingStart(ev);
1213 }
1214 break;
1215
1216 case MotionEvent.ACTION_UP:
Sunny Goyalaad33592018-08-07 17:20:35 -07001217 if (mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001218 final int activePointerId = mActivePointerId;
1219 final int pointerIndex = ev.findPointerIndex(activePointerId);
Vinit Nayak93bf1fe2020-05-26 17:22:13 -07001220 if (pointerIndex == -1) return true;
1221
Vinit Nayaka406f722019-12-19 11:50:55 -08001222 final float primaryDirection = mOrientationHandler.getPrimaryDirection(ev,
1223 pointerIndex);
Sunny Goyal4bb8b062019-02-19 16:37:38 -08001224 final VelocityTracker velocityTracker = mVelocityTracker;
1225 velocityTracker.computeCurrentVelocity(1000, mMaximumVelocity);
Adam Cohenaefd4e12011-02-14 16:39:38 -08001226
Vinit Nayaka406f722019-12-19 11:50:55 -08001227 int velocity = (int) mOrientationHandler.getPrimaryVelocity(velocityTracker,
1228 mActivePointerId);
1229 int delta = (int) (primaryDirection - mDownMotionPrimary);
1230 int pageOrientedSize = mOrientationHandler.getMeasuredSize(getPageAt(mCurrentPage));
1231
1232 boolean isSignificantMove = Math.abs(delta) > pageOrientedSize *
1233 SIGNIFICANT_MOVE_THRESHOLD;
1234
1235 mTotalMotion += Math.abs(mLastMotion + mLastMotionRemainder - primaryDirection);
Winson Chung4941f652020-06-18 15:11:53 -07001236 boolean passedSlop = mAllowEasyFling || mTotalMotion > mPageSlop;
1237 boolean isFling = passedSlop && shouldFlingForVelocity(velocity);
Vinit Nayaka406f722019-12-19 11:50:55 -08001238 boolean isDeltaLeft = mIsRtl ? delta > 0 : delta < 0;
1239 boolean isVelocityLeft = mIsRtl ? velocity > 0 : velocity < 0;
Winson Chung4941f652020-06-18 15:11:53 -07001240 if (DEBUG_FAILED_QUICKSWITCH && !isFling && mAllowEasyFling) {
1241 Log.d("Quickswitch", "isFling=false vel=" + velocity
1242 + " threshold=" + mEasyFlingThresholdVelocity);
1243 }
Adam Cohen00481b32011-11-18 12:03:48 -08001244
Adam Cohenf358a4b2013-07-23 16:47:31 -07001245 if (!mFreeScroll) {
1246 // In the case that the page is moved far to one direction and then is flung
1247 // in the opposite direction, we use a threshold to determine whether we should
1248 // just return to the starting page, or if we should skip one further.
1249 boolean returnToOriginalPage = false;
Vinit Nayaka406f722019-12-19 11:50:55 -08001250 if (Math.abs(delta) > pageOrientedSize * RETURN_TO_ORIGINAL_PAGE_THRESHOLD &&
1251 Math.signum(velocity) != Math.signum(delta) && isFling) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001252 returnToOriginalPage = true;
1253 }
Adam Cohenaefd4e12011-02-14 16:39:38 -08001254
Adam Cohenf358a4b2013-07-23 16:47:31 -07001255 int finalPage;
1256 // We give flings precedence over large moves, which is why we short-circuit our
1257 // test for a large move if a fling has been registered. That is, a large
1258 // move to the left and fling to the right will register as a fling to the right.
Sunny Goyalb7b01352018-08-09 12:31:20 -07001259
Vinit Nayaka406f722019-12-19 11:50:55 -08001260 if (((isSignificantMove && !isDeltaLeft && !isFling) ||
1261 (isFling && !isVelocityLeft)) && mCurrentPage > 0) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +01001262 finalPage = returnToOriginalPage
1263 ? mCurrentPage : mCurrentPage - getPanelCount();
Vinit Nayaka406f722019-12-19 11:50:55 -08001264 snapToPageWithVelocity(finalPage, velocity);
1265 } else if (((isSignificantMove && isDeltaLeft && !isFling) ||
1266 (isFling && isVelocityLeft)) &&
Adam Cohenf358a4b2013-07-23 16:47:31 -07001267 mCurrentPage < getChildCount() - 1) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +01001268 finalPage = returnToOriginalPage
1269 ? mCurrentPage : mCurrentPage + getPanelCount();
Vinit Nayaka406f722019-12-19 11:50:55 -08001270 snapToPageWithVelocity(finalPage, velocity);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001271 } else {
1272 snapToDestination();
Adam Cohenf358a4b2013-07-23 16:47:31 -07001273 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001274 } else {
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001275 if (!mScroller.isFinished()) {
1276 abortScrollerAnimation(true);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001277 }
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001278
Vinit Nayaka406f722019-12-19 11:50:55 -08001279 int initialScroll = mOrientationHandler.getPrimaryScroll(this);
1280 int maxScroll = mMaxScroll;
1281 int minScroll = mMinScroll;
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001282
Vinit Nayaka406f722019-12-19 11:50:55 -08001283 if (((initialScroll >= maxScroll) && (isVelocityLeft || !isFling)) ||
1284 ((initialScroll <= minScroll) && (!isVelocityLeft || !isFling))) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001285 mScroller.springBack(initialScroll, 0, minScroll, maxScroll, 0, 0);
Alex Chaub794ea62021-02-03 18:00:30 +00001286 mNextPage = getDestinationPage();
Sunny Goyalb7b01352018-08-09 12:31:20 -07001287 } else {
Sunny Goyalc39db732021-04-03 01:20:21 -07001288 int velocity1 = -velocity;
1289 // Continue a scroll or fling in progress
1290 mScroller.fling(initialScroll, 0, velocity1, 0, minScroll, maxScroll, 0, 0,
1291 Math.round(getWidth() * 0.5f * OVERSCROLL_DAMP_FACTOR), 0);
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001292
Sunny Goyalc39db732021-04-03 01:20:21 -07001293 int finalPos = mScroller.getFinalX();
Alex Chaub794ea62021-02-03 18:00:30 +00001294 mNextPage = getDestinationPage(finalPos);
Sunny Goyalc39db732021-04-03 01:20:21 -07001295 onNotSnappingToPageInFreeScroll();
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001296 }
1297 invalidate();
Winson Chung321e9ee2010-08-09 13:37:56 -07001298 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001299 }
Adam Cohen7d30a372013-07-01 17:03:59 -07001300
Sunny Goyalc39db732021-04-03 01:20:21 -07001301 mEdgeGlowLeft.onRelease();
1302 mEdgeGlowRight.onRelease();
Adam Cohen7d30a372013-07-01 17:03:59 -07001303 // End any intermediate reordering states
1304 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001305 break;
1306
1307 case MotionEvent.ACTION_CANCEL:
Sunny Goyalaad33592018-08-07 17:20:35 -07001308 if (mIsBeingDragged) {
Michael Jurkab8f06722010-10-10 15:58:46 -07001309 snapToDestination();
1310 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001311 mEdgeGlowLeft.onRelease();
1312 mEdgeGlowRight.onRelease();
Adam Cohen7d30a372013-07-01 17:03:59 -07001313 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001314 break;
1315
1316 case MotionEvent.ACTION_POINTER_UP:
1317 onSecondaryPointerUp(ev);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001318 releaseVelocityTracker();
Winson Chung321e9ee2010-08-09 13:37:56 -07001319 break;
1320 }
1321
1322 return true;
1323 }
1324
Sunny Goyalc39db732021-04-03 01:20:21 -07001325 protected void onNotSnappingToPageInFreeScroll() { }
Alex Chaub794ea62021-02-03 18:00:30 +00001326
Vinit Nayaka406f722019-12-19 11:50:55 -08001327 protected boolean shouldFlingForVelocity(int velocity) {
Winson Chung4941f652020-06-18 15:11:53 -07001328 float threshold = mAllowEasyFling ? mEasyFlingThresholdVelocity : mFlingThresholdVelocity;
1329 return Math.abs(velocity) > threshold;
Sunny Goyal65d9ceb2017-05-08 09:17:42 -07001330 }
1331
Adam Cohen7d30a372013-07-01 17:03:59 -07001332 private void resetTouchState() {
1333 releaseVelocityTracker();
Sunny Goyalaad33592018-08-07 17:20:35 -07001334 mIsBeingDragged = false;
Adam Cohen7d30a372013-07-01 17:03:59 -07001335 mActivePointerId = INVALID_POINTER;
Adam Cohen7d30a372013-07-01 17:03:59 -07001336 }
1337
Winson Chung185d7162011-02-28 13:47:29 -08001338 @Override
1339 public boolean onGenericMotionEvent(MotionEvent event) {
1340 if ((event.getSource() & InputDevice.SOURCE_CLASS_POINTER) != 0) {
1341 switch (event.getAction()) {
1342 case MotionEvent.ACTION_SCROLL: {
1343 // Handle mouse (or ext. device) by shifting the page depending on the scroll
1344 final float vscroll;
1345 final float hscroll;
1346 if ((event.getMetaState() & KeyEvent.META_SHIFT_ON) != 0) {
1347 vscroll = 0;
1348 hscroll = event.getAxisValue(MotionEvent.AXIS_VSCROLL);
1349 } else {
1350 vscroll = -event.getAxisValue(MotionEvent.AXIS_VSCROLL);
1351 hscroll = event.getAxisValue(MotionEvent.AXIS_HSCROLL);
1352 }
Sunny Goyal8b37c572020-03-31 12:12:14 -07001353 if (!canScroll(Math.abs(vscroll), Math.abs(hscroll))) {
1354 return false;
Samuel Fufa59cba192019-08-22 18:31:34 -07001355 }
Winson Chung185d7162011-02-28 13:47:29 -08001356 if (hscroll != 0 || vscroll != 0) {
Sunny Goyal70660032015-05-14 00:07:08 -07001357 boolean isForwardScroll = mIsRtl ? (hscroll < 0 || vscroll < 0)
Adam Cohen0ffac432013-07-10 11:19:26 -07001358 : (hscroll > 0 || vscroll > 0);
1359 if (isForwardScroll) {
Winson Chung185d7162011-02-28 13:47:29 -08001360 scrollRight();
1361 } else {
1362 scrollLeft();
1363 }
1364 return true;
1365 }
1366 }
1367 }
1368 }
1369 return super.onGenericMotionEvent(event);
1370 }
1371
Sunny Goyal8b37c572020-03-31 12:12:14 -07001372 /**
1373 * Returns true if the paged view can scroll for the provided vertical and horizontal
1374 * scroll values
1375 */
1376 protected boolean canScroll(float absVScroll, float absHScroll) {
1377 ActivityContext ac = ActivityContext.lookupContext(getContext());
1378 return (ac == null || AbstractFloatingView.getTopOpenView(ac) == null);
Samuel Fufa59cba192019-08-22 18:31:34 -07001379 }
1380
Michael Jurkab8f06722010-10-10 15:58:46 -07001381 private void acquireVelocityTrackerAndAddMovement(MotionEvent ev) {
1382 if (mVelocityTracker == null) {
1383 mVelocityTracker = VelocityTracker.obtain();
1384 }
1385 mVelocityTracker.addMovement(ev);
1386 }
1387
1388 private void releaseVelocityTracker() {
1389 if (mVelocityTracker != null) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001390 mVelocityTracker.clear();
Michael Jurkab8f06722010-10-10 15:58:46 -07001391 mVelocityTracker.recycle();
1392 mVelocityTracker = null;
1393 }
1394 }
1395
Winson Chung321e9ee2010-08-09 13:37:56 -07001396 private void onSecondaryPointerUp(MotionEvent ev) {
Winson Chung4941f652020-06-18 15:11:53 -07001397 final int pointerIndex = ev.getActionIndex();
Winson Chung321e9ee2010-08-09 13:37:56 -07001398 final int pointerId = ev.getPointerId(pointerIndex);
1399 if (pointerId == mActivePointerId) {
1400 // This was our active pointer going up. Choose a new
1401 // active pointer and adjust accordingly.
1402 // TODO: Make this decision more intelligent.
1403 final int newPointerIndex = pointerIndex == 0 ? 1 : 0;
Vinit Nayaka406f722019-12-19 11:50:55 -08001404 mLastMotion = mDownMotionPrimary = mOrientationHandler.getPrimaryDirection(ev,
1405 newPointerIndex);
1406 mLastMotionRemainder = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -07001407 mActivePointerId = ev.getPointerId(newPointerIndex);
1408 if (mVelocityTracker != null) {
1409 mVelocityTracker.clear();
1410 }
1411 }
Jeff Brown1d0867c2010-12-02 18:27:39 -08001412 }
1413
Winson Chung321e9ee2010-08-09 13:37:56 -07001414 @Override
1415 public void requestChildFocus(View child, View focused) {
1416 super.requestChildFocus(child, focused);
Adam Cohenae4f1552011-10-20 00:15:42 -07001417 int page = indexToPage(indexOfChild(child));
Winson Chung97d85d22011-04-13 11:27:36 -07001418 if (page >= 0 && page != getCurrentPage() && !isInTouchMode()) {
Winson Chung86f77532010-08-24 11:08:22 -07001419 snapToPage(page);
Winson Chung321e9ee2010-08-09 13:37:56 -07001420 }
1421 }
1422
Alex Chaub794ea62021-02-03 18:00:30 +00001423 public int getDestinationPage() {
1424 return getDestinationPage(mOrientationHandler.getPrimaryScroll(this));
1425 }
1426
Alex Chaudedbc8a2021-03-17 16:53:26 +00001427 protected int getDestinationPage(int primaryScroll) {
1428 return getPageNearestToCenterOfScreen(primaryScroll);
Alex Chaub794ea62021-02-03 18:00:30 +00001429 }
1430
Sunny Goyal228153d2018-01-04 15:35:22 -08001431 public int getPageNearestToCenterOfScreen() {
Vinit Nayaka406f722019-12-19 11:50:55 -08001432 return getPageNearestToCenterOfScreen(mOrientationHandler.getPrimaryScroll(this));
Tony Wickham8f7ead32016-04-07 18:46:44 -07001433 }
1434
Alex Chaudedbc8a2021-03-17 16:53:26 +00001435 private int getPageNearestToCenterOfScreen(int primaryScroll) {
1436 int screenCenter = getScreenCenter(primaryScroll);
Adam Cohen22f823d2011-09-01 17:22:18 -07001437 int minDistanceFromScreenCenter = Integer.MAX_VALUE;
Winson Chung321e9ee2010-08-09 13:37:56 -07001438 int minDistanceFromScreenCenterIndex = -1;
Winson Chung321e9ee2010-08-09 13:37:56 -07001439 final int childCount = getChildCount();
1440 for (int i = 0; i < childCount; ++i) {
Tony Wickham7383d4e2020-07-07 19:25:25 -07001441 int distanceFromScreenCenter = Math.abs(
1442 getDisplacementFromScreenCenter(i, screenCenter));
Winson Chung321e9ee2010-08-09 13:37:56 -07001443 if (distanceFromScreenCenter < minDistanceFromScreenCenter) {
1444 minDistanceFromScreenCenter = distanceFromScreenCenter;
1445 minDistanceFromScreenCenterIndex = i;
1446 }
1447 }
Adam Cohend19d3ca2010-09-15 14:43:42 -07001448 return minDistanceFromScreenCenterIndex;
1449 }
1450
Tony Wickham7383d4e2020-07-07 19:25:25 -07001451 private int getDisplacementFromScreenCenter(int childIndex, int screenCenter) {
Alex Chaudedbc8a2021-03-17 16:53:26 +00001452 int childSize = Math.round(getChildVisibleSize(childIndex));
Tony Wickham7383d4e2020-07-07 19:25:25 -07001453 int halfChildSize = (childSize / 2);
1454 int childCenter = getChildOffset(childIndex) + halfChildSize;
1455 return childCenter - screenCenter;
1456 }
1457
1458 protected int getDisplacementFromScreenCenter(int childIndex) {
Alex Chaudedbc8a2021-03-17 16:53:26 +00001459 int primaryScroll = mOrientationHandler.getPrimaryScroll(this);
1460 int screenCenter = getScreenCenter(primaryScroll);
Tony Wickham7383d4e2020-07-07 19:25:25 -07001461 return getDisplacementFromScreenCenter(childIndex, screenCenter);
1462 }
1463
Alex Chaudedbc8a2021-03-17 16:53:26 +00001464 private int getScreenCenter(int primaryScroll) {
1465 float primaryScale = mOrientationHandler.getPrimaryScale(this);
1466 float primaryPivot = mOrientationHandler.getPrimaryValue(getPivotX(), getPivotY());
1467 int pageOrientationSize = mOrientationHandler.getMeasuredSize(this);
1468 return Math.round(primaryScroll + (pageOrientationSize / 2f - primaryPivot) / primaryScale
1469 + primaryPivot);
1470 }
1471
Adam Cohend19d3ca2010-09-15 14:43:42 -07001472 protected void snapToDestination() {
Sunny Goyalc39db732021-04-03 01:20:21 -07001473 snapToPage(getDestinationPage(), PAGE_SNAP_ANIMATION_DURATION);
Winson Chung321e9ee2010-08-09 13:37:56 -07001474 }
1475
Adam Cohene0f66b52010-11-23 15:06:07 -08001476 // We want the duration of the page snap animation to be influenced by the distance that
1477 // the screen has to travel, however, we don't want this duration to be effected in a
1478 // purely linear fashion. Instead, we use this method to moderate the effect that the distance
1479 // of travel has on the overall snap duration.
Sunny Goyal4d113a52015-05-27 10:05:28 -07001480 private float distanceInfluenceForSnapDuration(float f) {
Adam Cohene0f66b52010-11-23 15:06:07 -08001481 f -= 0.5f; // center the values about 0.
1482 f *= 0.3f * Math.PI / 2.0f;
1483 return (float) Math.sin(f);
1484 }
1485
Winson Chung05a31ed2018-02-08 17:08:43 -08001486 protected boolean snapToPageWithVelocity(int whichPage, int velocity) {
Adam Cohen6f127a62014-06-12 14:54:41 -07001487 whichPage = validateNewPage(whichPage);
Vinit Nayaka406f722019-12-19 11:50:55 -08001488 int halfScreenSize = mOrientationHandler.getMeasuredSize(this) / 2;
Adam Cohene0f66b52010-11-23 15:06:07 -08001489
Vinit Nayaka406f722019-12-19 11:50:55 -08001490 final int newLoc = getScrollForPage(whichPage);
Sunny Goyalc39db732021-04-03 01:20:21 -07001491 int delta = newLoc - mOrientationHandler.getPrimaryScroll(this);
Adam Cohene0f66b52010-11-23 15:06:07 -08001492 int duration = 0;
1493
Sunny Goyal4d113a52015-05-27 10:05:28 -07001494 if (Math.abs(velocity) < mMinFlingVelocity) {
Adam Cohene0f66b52010-11-23 15:06:07 -08001495 // If the velocity is low enough, then treat this more as an automatic page advance
1496 // as opposed to an apparent physical response to flinging
Winson Chung05a31ed2018-02-08 17:08:43 -08001497 return snapToPage(whichPage, PAGE_SNAP_ANIMATION_DURATION);
Adam Cohene0f66b52010-11-23 15:06:07 -08001498 }
1499
1500 // Here we compute a "distance" that will be used in the computation of the overall
1501 // snap duration. This is a function of the actual distance that needs to be traveled;
1502 // we keep this value close to half screen size in order to reduce the variance in snap
1503 // duration as a function of the distance the page needs to travel.
Michael Jurka20b7ca92011-06-07 20:09:16 -07001504 float distanceRatio = Math.min(1f, 1.0f * Math.abs(delta) / (2 * halfScreenSize));
Adam Cohene0f66b52010-11-23 15:06:07 -08001505 float distance = halfScreenSize + halfScreenSize *
1506 distanceInfluenceForSnapDuration(distanceRatio);
1507
1508 velocity = Math.abs(velocity);
Adam Cohen265b9a62011-12-07 14:37:18 -08001509 velocity = Math.max(mMinSnapVelocity, velocity);
Adam Cohene0f66b52010-11-23 15:06:07 -08001510
1511 // we want the page's snap velocity to approximately match the velocity at which the
1512 // user flings, so we scale the duration by a value near to the derivative of the scroll
Michael Jurka20b7ca92011-06-07 20:09:16 -07001513 // interpolator at zero, ie. 5. We use 4 to make it a little slower.
1514 duration = 4 * Math.round(1000 * Math.abs(distance / velocity));
Adam Cohene0f66b52010-11-23 15:06:07 -08001515
Sunny Goyalc39db732021-04-03 01:20:21 -07001516 return snapToPage(whichPage, delta, duration);
Michael Jurka0142d492010-08-25 17:46:15 -07001517 }
1518
Winson Chung05a31ed2018-02-08 17:08:43 -08001519 public boolean snapToPage(int whichPage) {
1520 return snapToPage(whichPage, PAGE_SNAP_ANIMATION_DURATION);
Winson Chung321e9ee2010-08-09 13:37:56 -07001521 }
1522
Winson Chung05a31ed2018-02-08 17:08:43 -08001523 public boolean snapToPageImmediately(int whichPage) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001524 return snapToPage(whichPage, PAGE_SNAP_ANIMATION_DURATION, true);
Adam Cohen7d30a372013-07-01 17:03:59 -07001525 }
1526
Winson Chung05a31ed2018-02-08 17:08:43 -08001527 public boolean snapToPage(int whichPage, int duration) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001528 return snapToPage(whichPage, duration, false);
Adam Cohen7d30a372013-07-01 17:03:59 -07001529 }
1530
Sunny Goyalc39db732021-04-03 01:20:21 -07001531 protected boolean snapToPage(int whichPage, int duration, boolean immediate) {
Adam Cohen6f127a62014-06-12 14:54:41 -07001532 whichPage = validateNewPage(whichPage);
Winson Chung321e9ee2010-08-09 13:37:56 -07001533
Vinit Nayaka406f722019-12-19 11:50:55 -08001534 int newLoc = getScrollForPage(whichPage);
Sunny Goyalc39db732021-04-03 01:20:21 -07001535 final int delta = newLoc - mOrientationHandler.getPrimaryScroll(this);
1536 return snapToPage(whichPage, delta, duration, immediate);
Michael Jurka0142d492010-08-25 17:46:15 -07001537 }
1538
Winson Chung05a31ed2018-02-08 17:08:43 -08001539 protected boolean snapToPage(int whichPage, int delta, int duration) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001540 return snapToPage(whichPage, delta, duration, false);
Adam Cohen7d30a372013-07-01 17:03:59 -07001541 }
Michael Jurka0142d492010-08-25 17:46:15 -07001542
Sunny Goyalc39db732021-04-03 01:20:21 -07001543 protected boolean snapToPage(int whichPage, int delta, int duration, boolean immediate) {
Sunny Goyal9bb8ffb2018-05-24 17:11:16 -07001544 if (mFirstLayout) {
1545 setCurrentPage(whichPage);
1546 return false;
1547 }
Tony Wickhamd58c2d52018-05-04 12:10:55 -07001548
Zak Cohen3eeb41d2020-02-14 14:15:13 -08001549 if (FeatureFlags.IS_STUDIO_BUILD) {
Tony Wickhamcb3f8702018-08-27 17:36:03 -07001550 duration *= Settings.Global.getFloat(getContext().getContentResolver(),
1551 Settings.Global.WINDOW_ANIMATION_SCALE, 1);
Tony Wickhamd58c2d52018-05-04 12:10:55 -07001552 }
1553
Adam Cohen6f127a62014-06-12 14:54:41 -07001554 whichPage = validateNewPage(whichPage);
1555
Adam Cohen7d30a372013-07-01 17:03:59 -07001556 mNextPage = whichPage;
Michael Jurka0142d492010-08-25 17:46:15 -07001557
Winson Chung321e9ee2010-08-09 13:37:56 -07001558 awakenScrollBars(duration);
Adam Cohen7d30a372013-07-01 17:03:59 -07001559 if (immediate) {
1560 duration = 0;
1561 } else if (duration == 0) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001562 duration = Math.abs(delta);
1563 }
1564
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001565 if (duration != 0) {
1566 pageBeginTransition();
1567 }
1568
Adam Cohenf358a4b2013-07-23 16:47:31 -07001569 if (!mScroller.isFinished()) {
Adam Cohenf9618852013-11-08 06:45:03 -08001570 abortScrollerAnimation(false);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001571 }
Adam Cohenf9618852013-11-08 06:45:03 -08001572
Sunny Goyalc39db732021-04-03 01:20:21 -07001573 mScroller.startScroll(mOrientationHandler.getPrimaryScroll(this), 0, delta, 0, duration);
Adam Cohen674531f2013-12-13 15:07:14 -08001574 updatePageIndicator();
Adam Cohen7d30a372013-07-01 17:03:59 -07001575
1576 // Trigger a compute() to finish switching pages if necessary
1577 if (immediate) {
1578 computeScroll();
Sunny Goyal76dbf6f2017-01-03 14:55:47 -08001579 pageEndTransition();
Adam Cohen7d30a372013-07-01 17:03:59 -07001580 }
1581
Winson Chung321e9ee2010-08-09 13:37:56 -07001582 invalidate();
Winson Chung05a31ed2018-02-08 17:08:43 -08001583 return Math.abs(delta) > 0;
Winson Chung321e9ee2010-08-09 13:37:56 -07001584 }
1585
Vadim Tryshev98913d02018-05-18 18:41:34 -07001586 public boolean scrollLeft() {
1587 if (getNextPage() > 0) {
1588 snapToPage(getNextPage() - 1);
1589 return true;
1590 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001591 return mAllowOverScroll;
Winson Chung321e9ee2010-08-09 13:37:56 -07001592 }
1593
Vadim Tryshev98913d02018-05-18 18:41:34 -07001594 public boolean scrollRight() {
1595 if (getNextPage() < getChildCount() - 1) {
1596 snapToPage(getNextPage() + 1);
1597 return true;
1598 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001599 return mAllowOverScroll;
Winson Chung321e9ee2010-08-09 13:37:56 -07001600 }
1601
Vadim Trysheve6bbefb2018-04-03 13:38:06 -07001602 @Override
1603 public CharSequence getAccessibilityClassName() {
1604 // Some accessibility services have special logic for ScrollView. Since we provide same
1605 // accessibility info as ScrollView, inform the service to handle use the same way.
1606 return ScrollView.class.getName();
1607 }
1608
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001609 protected boolean isPageOrderFlipped() {
1610 return false;
1611 }
1612
Winson Chung6a0f57d2011-06-29 20:10:49 -07001613 /* Accessibility */
Sunny Goyalcf25b522015-07-09 00:01:18 -07001614 @SuppressWarnings("deprecation")
Winson Chung6a0f57d2011-06-29 20:10:49 -07001615 @Override
1616 public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) {
1617 super.onInitializeAccessibilityNodeInfo(info);
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001618 final boolean pagesFlipped = isPageOrderFlipped();
Pinyao Tingaf6daa22019-09-18 22:18:03 +00001619 int offset = (mAllowOverScroll ? 0 : 1);
1620 info.setScrollable(getPageCount() > offset);
1621 if (getCurrentPage() < getPageCount() - offset) {
yingleiw02cc8482019-08-02 16:14:27 -07001622 info.addAction(pagesFlipped ?
1623 AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_BACKWARD
1624 : AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_FORWARD);
1625 info.addAction(mIsRtl ?
1626 AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_LEFT
1627 : AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_RIGHT);
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001628 }
Pinyao Tingaf6daa22019-09-18 22:18:03 +00001629 if (getCurrentPage() >= offset) {
yingleiw02cc8482019-08-02 16:14:27 -07001630 info.addAction(pagesFlipped ?
1631 AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_FORWARD
1632 : AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_BACKWARD);
1633 info.addAction(mIsRtl ?
1634 AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_RIGHT
1635 : AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_LEFT);
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001636 }
Vadim Tryshev7af0d442015-05-15 08:48:11 -07001637 // Accessibility-wise, PagedView doesn't support long click, so disabling it.
1638 // Besides disabling the accessibility long-click, this also prevents this view from getting
1639 // accessibility focus.
1640 info.setLongClickable(false);
Sunny Goyala52ecb02016-12-16 15:04:51 -08001641 info.removeAction(AccessibilityNodeInfo.AccessibilityAction.ACTION_LONG_CLICK);
Winson Chung6a0f57d2011-06-29 20:10:49 -07001642 }
1643
1644 @Override
Alan Viverette254139a2013-10-08 13:13:46 -07001645 public void sendAccessibilityEvent(int eventType) {
1646 // Don't let the view send real scroll events.
1647 if (eventType != AccessibilityEvent.TYPE_VIEW_SCROLLED) {
1648 super.sendAccessibilityEvent(eventType);
1649 }
1650 }
1651
1652 @Override
Winson Chung6a0f57d2011-06-29 20:10:49 -07001653 public void onInitializeAccessibilityEvent(AccessibilityEvent event) {
1654 super.onInitializeAccessibilityEvent(event);
Pinyao Tingaf6daa22019-09-18 22:18:03 +00001655 event.setScrollable(mAllowOverScroll || getPageCount() > 1);
Winson Chung6a0f57d2011-06-29 20:10:49 -07001656 }
1657
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001658 @Override
1659 public boolean performAccessibilityAction(int action, Bundle arguments) {
1660 if (super.performAccessibilityAction(action, arguments)) {
1661 return true;
1662 }
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001663 final boolean pagesFlipped = isPageOrderFlipped();
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001664 switch (action) {
1665 case AccessibilityNodeInfo.ACTION_SCROLL_FORWARD: {
Vadim Tryshev98913d02018-05-18 18:41:34 -07001666 if (pagesFlipped ? scrollLeft() : scrollRight()) {
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001667 return true;
1668 }
1669 } break;
1670 case AccessibilityNodeInfo.ACTION_SCROLL_BACKWARD: {
Vadim Tryshev98913d02018-05-18 18:41:34 -07001671 if (pagesFlipped ? scrollRight() : scrollLeft()) {
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001672 return true;
1673 }
yingleiw02cc8482019-08-02 16:14:27 -07001674 } break;
1675 case android.R.id.accessibilityActionPageRight: {
1676 if (!mIsRtl) {
1677 return scrollRight();
1678 } else {
1679 return scrollLeft();
1680 }
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001681 }
yingleiw02cc8482019-08-02 16:14:27 -07001682 case android.R.id.accessibilityActionPageLeft: {
1683 if (!mIsRtl) {
1684 return scrollLeft();
1685 } else {
1686 return scrollRight();
1687 }
1688 }
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001689 }
1690 return false;
1691 }
1692
Vadim Tryshev2c430b32018-04-04 14:45:21 -07001693 protected boolean canAnnouncePageDescription() {
1694 return true;
1695 }
1696
Adam Cohen0ffac432013-07-10 11:19:26 -07001697 protected String getCurrentPageDescription() {
Sunny Goyalf4f89ef2015-09-02 15:06:12 -07001698 return getContext().getString(R.string.default_scroll_format,
Adam Cohen0ffac432013-07-10 11:19:26 -07001699 getNextPage() + 1, getChildCount());
1700 }
1701
Tony Mak2e564402018-02-27 17:19:34 +00001702 protected float getDownMotionX() {
1703 return mDownMotionX;
1704 }
1705
1706 protected float getDownMotionY() {
1707 return mDownMotionY;
1708 }
1709
Sunny Goyal20a13ff2018-03-13 16:44:00 -07001710 protected interface ComputePageScrollsLogic {
1711
1712 boolean shouldIncludeView(View view);
1713 }
Vadim Tryshev528b9e02018-05-24 18:22:03 -07001714
1715 public int[] getVisibleChildrenRange() {
1716 float visibleLeft = 0;
1717 float visibleRight = visibleLeft + getMeasuredWidth();
1718 float scaleX = getScaleX();
1719 if (scaleX < 1 && scaleX > 0) {
1720 float mid = getMeasuredWidth() / 2;
1721 visibleLeft = mid - ((mid - visibleLeft) / scaleX);
1722 visibleRight = mid + ((visibleRight - mid) / scaleX);
1723 }
1724
1725 int leftChild = -1;
1726 int rightChild = -1;
1727 final int childCount = getChildCount();
1728 for (int i = 0; i < childCount; i++) {
1729 final View child = getPageAt(i);
1730
1731 float left = child.getLeft() + child.getTranslationX() - getScrollX();
1732 if (left <= visibleRight && (left + child.getMeasuredWidth()) >= visibleLeft) {
1733 if (leftChild == -1) {
1734 leftChild = i;
1735 }
1736 rightChild = i;
1737 }
1738 }
1739 mTmpIntPair[0] = leftChild;
1740 mTmpIntPair[1] = rightChild;
1741 return mTmpIntPair;
1742 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001743
1744 @Override
1745 public void draw(Canvas canvas) {
1746 super.draw(canvas);
1747 drawEdgeEffect(canvas);
Sunny Goyal05b59c02021-04-29 13:55:40 -07001748 pageEndTransition();
Sunny Goyalc39db732021-04-03 01:20:21 -07001749 }
1750
1751 protected void drawEdgeEffect(Canvas canvas) {
1752 if (mAllowOverScroll && (!mEdgeGlowRight.isFinished() || !mEdgeGlowLeft.isFinished())) {
1753 final int width = getWidth();
1754 final int height = getHeight();
1755 if (!mEdgeGlowLeft.isFinished()) {
1756 final int restoreCount = canvas.save();
1757 canvas.rotate(-90);
1758 canvas.translate(-height, Math.min(mMinScroll, getScrollX()));
1759 mEdgeGlowLeft.setSize(height, width);
1760 if (mEdgeGlowLeft.draw(canvas)) {
1761 postInvalidateOnAnimation();
1762 }
1763 canvas.restoreToCount(restoreCount);
1764 }
1765 if (!mEdgeGlowRight.isFinished()) {
1766 final int restoreCount = canvas.save();
1767 canvas.rotate(90, width, 0);
1768 canvas.translate(width, -(Math.max(mMaxScroll, getScrollX())));
1769
1770 mEdgeGlowRight.setSize(height, width);
1771 if (mEdgeGlowRight.draw(canvas)) {
1772 postInvalidateOnAnimation();
1773 }
1774 canvas.restoreToCount(restoreCount);
1775 }
1776 }
1777 }
Adam Cohen5084cba2013-09-03 12:01:16 -07001778}