blob: fb216987c96d82c421d18ca39e5140c54dcf3b45 [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;
Andras Kloczl2bb51342021-03-20 01:13:45 +010062import java.util.List;
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 /**
Andras Kloczl2bb51342021-03-20 01:13:45 +0100298 * Returns the currently visible pages.
299 */
Andras Kloczla4cb0f02021-03-21 00:23:07 +0100300 public Iterable<View> getVisiblePages() {
Andras Kloczl2bb51342021-03-20 01:13:45 +0100301 int panelCount = getPanelCount();
302 List<View> visiblePages = new ArrayList<>(panelCount);
303 for (int i = mCurrentPage; i < mCurrentPage + panelCount; i++) {
304 View page = getPageAt(i);
305 if (page != null) {
306 visiblePages.add(page);
307 }
308 }
309 return visiblePages;
310 }
311
312 /**
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100313 * Returns true if the view is on one of the current pages, false otherwise.
314 */
315 public boolean isVisible(View child) {
316 return getLeftmostVisiblePageForIndex(indexOfChild(child)) == mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700317 }
318
Chet Haasebc2f0822012-10-26 17:59:53 -0700319 /**
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700320 * @return The closest page to the provided page that is within mMinScrollX and mMaxScrollX.
321 */
322 private int ensureWithinScrollBounds(int page) {
323 int dir = !mIsRtl ? 1 : - 1;
324 int currScroll = getScrollForPage(page);
325 int prevScroll;
Vinit Nayaka406f722019-12-19 11:50:55 -0800326 while (currScroll < mMinScroll) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700327 page += dir;
328 prevScroll = currScroll;
329 currScroll = getScrollForPage(page);
330 if (currScroll <= prevScroll) {
331 Log.e(TAG, "validateNewPage: failed to find a page > mMinScrollX");
332 break;
333 }
334 }
Vinit Nayaka406f722019-12-19 11:50:55 -0800335 while (currScroll > mMaxScroll) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700336 page -= dir;
337 prevScroll = currScroll;
338 currScroll = getScrollForPage(page);
339 if (currScroll >= prevScroll) {
340 Log.e(TAG, "validateNewPage: failed to find a page < mMaxScrollX");
341 break;
342 }
343 }
344 return page;
345 }
346
Tony Wickham03f27012019-04-25 14:22:54 -0700347 public void setCurrentPage(int currentPage) {
348 setCurrentPage(currentPage, INVALID_PAGE);
349 }
350
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700351 /**
Winson Chung86f77532010-08-24 11:08:22 -0700352 * Sets the current page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700353 */
Tony Wickham03f27012019-04-25 14:22:54 -0700354 public void setCurrentPage(int currentPage, int overridePrevPage) {
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800355 if (!mScroller.isFinished()) {
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700356 abortScrollerAnimation(true);
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800357 }
Michael Jurkad3ef3062010-11-23 16:23:58 -0800358 // don't introduce any checks like mCurrentPage == currentPage here-- if we change the
359 // the default
360 if (getChildCount() == 0) {
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800361 return;
362 }
Tony Wickham03f27012019-04-25 14:22:54 -0700363 int prevPage = overridePrevPage != INVALID_PAGE ? overridePrevPage : mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700364 mCurrentPage = validateNewPage(currentPage);
Winson Chung181c3dc2013-07-17 15:36:20 -0700365 updateCurrentPageScroll();
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700366 notifyPageSwitchListener(prevPage);
Winson Chunga12a2502010-12-20 14:41:35 -0800367 invalidate();
Winson Chung321e9ee2010-08-09 13:37:56 -0700368 }
369
Winson Chung8c87cd82013-07-23 16:20:10 -0700370 /**
Adam Cohen674531f2013-12-13 15:07:14 -0800371 * Should be called whenever the page changes. In the case of a scroll, we wait until the page
372 * has settled.
373 */
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700374 protected void notifyPageSwitchListener(int prevPage) {
Adam Cohen674531f2013-12-13 15:07:14 -0800375 updatePageIndicator();
376 }
377
378 private void updatePageIndicator() {
Sunny Goyal4cbf0462014-08-28 16:19:39 -0700379 if (mPageIndicator != null) {
Tony Mak4f521af2018-03-15 16:37:34 +0000380 mPageIndicator.setActiveMarker(getNextPage());
Winson Chungd2be3812013-07-16 11:11:32 -0700381 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700382 }
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700383 protected void pageBeginTransition() {
384 if (!mIsPageInTransition) {
385 mIsPageInTransition = true;
386 onPageBeginTransition();
Michael Jurkad74c9842011-07-10 12:44:21 -0700387 }
Patrick Dubroy1262e362010-10-06 15:49:50 -0700388 }
389
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700390 protected void pageEndTransition() {
Sunny Goyal05b59c02021-04-29 13:55:40 -0700391 if (mIsPageInTransition && !mIsBeingDragged && mScroller.isFinished()
Sunny Goyalb745a2a2021-04-30 13:38:22 -0700392 && (!isShown() || (mEdgeGlowLeft.isFinished() && mEdgeGlowRight.isFinished()))) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700393 mIsPageInTransition = false;
394 onPageEndTransition();
Michael Jurkad74c9842011-07-10 12:44:21 -0700395 }
Michael Jurka0142d492010-08-25 17:46:15 -0700396 }
397
Sunny Goyalb745a2a2021-04-30 13:38:22 -0700398 @Override
399 public void onVisibilityAggregated(boolean isVisible) {
400 pageEndTransition();
401 super.onVisibilityAggregated(isVisible);
402 }
403
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700404 protected boolean isPageInTransition() {
405 return mIsPageInTransition;
Adam Cohen26976d92011-03-22 15:33:33 -0700406 }
407
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700408 /**
409 * Called when the page starts moving as part of the scroll. Subclasses can override this
410 * to provide custom behavior during animation.
411 */
412 protected void onPageBeginTransition() {
Patrick Dubroy1262e362010-10-06 15:49:50 -0700413 }
414
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700415 /**
416 * Called when the page ends moving as part of the scroll. Subclasses can override this
417 * to provide custom behavior during animation.
418 */
419 protected void onPageEndTransition() {
vadimt4d93df52019-07-10 17:32:58 -0700420 AccessibilityManagerCompat.sendScrollFinishedEventToTest(getContext());
Tony Wickham619daaf2020-02-07 12:29:06 -0800421 AccessibilityManagerCompat.sendCustomAccessibilityEvent(getPageAt(mCurrentPage),
422 AccessibilityEvent.TYPE_VIEW_FOCUSED, null);
Tony Wickham62117d72020-03-26 16:56:26 -0700423 if (mOnPageTransitionEndCallback != null) {
424 mOnPageTransitionEndCallback.run();
425 mOnPageTransitionEndCallback = null;
426 }
427 }
428
429 /**
430 * Sets a callback to run once when the scrolling finishes. If there is currently
431 * no page in transition, then the callback is called immediately.
432 */
433 public void setOnPageTransitionEndCallback(@Nullable Runnable callback) {
434 if (mIsPageInTransition || callback == null) {
435 mOnPageTransitionEndCallback = callback;
436 } else {
437 callback.run();
438 }
Michael Jurka0142d492010-08-25 17:46:15 -0700439 }
440
Adam Cohen68d73932010-11-15 10:50:58 -0800441 @Override
Michael Jurka0142d492010-08-25 17:46:15 -0700442 public void scrollTo(int x, int y) {
Sunny Goyalc39db732021-04-03 01:20:21 -0700443 x = Utilities.boundToRange(x,
444 mOrientationHandler.getPrimaryValue(mMinScroll, 0), mMaxScroll);
445 y = Utilities.boundToRange(y,
446 mOrientationHandler.getPrimaryValue(0, mMinScroll), mMaxScroll);
Vinit Nayaka406f722019-12-19 11:50:55 -0800447 super.scrollTo(x, y);
Michael Jurka0142d492010-08-25 17:46:15 -0700448 }
449
Adam Cohen53805212013-10-01 10:39:23 -0700450 private void sendScrollAccessibilityEvent() {
Sunny Goyald0030b02017-12-08 15:07:24 -0800451 if (isObservedEventType(getContext(), AccessibilityEvent.TYPE_VIEW_SCROLLED)) {
Vadim Tryshevf4715972015-05-08 17:21:03 -0700452 if (mCurrentPage != getNextPage()) {
453 AccessibilityEvent ev =
454 AccessibilityEvent.obtain(AccessibilityEvent.TYPE_VIEW_SCROLLED);
Vadim Tryshev7066c122015-05-21 14:06:35 -0700455 ev.setScrollable(true);
456 ev.setScrollX(getScrollX());
457 ev.setScrollY(getScrollY());
Vinit Nayaka406f722019-12-19 11:50:55 -0800458 mOrientationHandler.setMaxScroll(ev, mMaxScroll);
Vadim Tryshevf4715972015-05-08 17:21:03 -0700459 sendAccessibilityEventUnchecked(ev);
Adam Cohen53805212013-10-01 10:39:23 -0700460 }
Adam Cohen53805212013-10-01 10:39:23 -0700461 }
462 }
463
Michael Jurka0142d492010-08-25 17:46:15 -0700464 // we moved this functionality to a helper function so SmoothPagedView can reuse it
465 protected boolean computeScrollHelper() {
Tony Wickham95cdb3a2016-02-18 14:37:07 -0800466 return computeScrollHelper(true);
467 }
468
Vadim Tryshev2c430b32018-04-04 14:45:21 -0700469 protected void announcePageForAccessibility() {
470 if (isAccessibilityEnabled(getContext())) {
471 // Notify the user when the page changes
472 announceForAccessibility(getCurrentPageDescription());
473 }
474 }
475
Tony Wickham95cdb3a2016-02-18 14:37:07 -0800476 protected boolean computeScrollHelper(boolean shouldInvalidate) {
Winson Chung321e9ee2010-08-09 13:37:56 -0700477 if (mScroller.computeScrollOffset()) {
Winson Chung557d6ed2011-07-08 15:34:52 -0700478 // Don't bother scrolling if the page does not need to be moved
Sunny Goyalc39db732021-04-03 01:20:21 -0700479 int oldPos = mOrientationHandler.getPrimaryScroll(this);
480 int newPos = mScroller.getCurrX();
481 if (oldPos != newPos) {
482 mOrientationHandler.set(this, VIEW_SCROLL_TO, mScroller.getCurrX());
Winson Chung557d6ed2011-07-08 15:34:52 -0700483 }
Tony Wickham95cdb3a2016-02-18 14:37:07 -0800484 if (shouldInvalidate) {
Sunny Goyalc39db732021-04-03 01:20:21 -0700485 if (mAllowOverScroll) {
486 if (newPos < mMinScroll && oldPos >= mMinScroll) {
487 mEdgeGlowLeft.onAbsorb((int) mScroller.getCurrVelocity());
488 mScroller.abortAnimation();
489 } else if (newPos > mMaxScroll && oldPos <= mMaxScroll) {
490 mEdgeGlowRight.onAbsorb((int) mScroller.getCurrVelocity());
491 mScroller.abortAnimation();
492 }
493 }
494
Tony Wickham95cdb3a2016-02-18 14:37:07 -0800495 invalidate();
496 }
Michael Jurka0142d492010-08-25 17:46:15 -0700497 return true;
Tony Wickham95cdb3a2016-02-18 14:37:07 -0800498 } else if (mNextPage != INVALID_PAGE && shouldInvalidate) {
Adam Cohen53805212013-10-01 10:39:23 -0700499 sendScrollAccessibilityEvent();
500
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700501 int prevPage = mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700502 mCurrentPage = validateNewPage(mNextPage);
Winson Chung86f77532010-08-24 11:08:22 -0700503 mNextPage = INVALID_PAGE;
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700504 notifyPageSwitchListener(prevPage);
Winson Chungb44b5242011-06-13 11:32:14 -0700505
Adam Cohen73aa9752010-11-24 16:26:58 -0800506 // We don't want to trigger a page end moving unless the page has settled
507 // and the user has stopped scrolling
Sunny Goyalaad33592018-08-07 17:20:35 -0700508 if (!mIsBeingDragged) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700509 pageEndTransition();
Adam Cohen73aa9752010-11-24 16:26:58 -0800510 }
Winson Chungc27d1bb2011-09-29 12:07:42 -0700511
Vadim Tryshev2c430b32018-04-04 14:45:21 -0700512 if (canAnnouncePageDescription()) {
513 announcePageForAccessibility();
Adam Cohen0ffac432013-07-10 11:19:26 -0700514 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700515 }
Michael Jurka0142d492010-08-25 17:46:15 -0700516 return false;
517 }
518
519 @Override
520 public void computeScroll() {
521 computeScrollHelper();
Winson Chung321e9ee2010-08-09 13:37:56 -0700522 }
523
Sunny Goyalce8809a2018-01-18 14:02:47 -0800524 public int getExpectedHeight() {
525 return getMeasuredHeight();
526 }
527
Adam Cohen410f3cd2013-09-22 12:09:32 -0700528 public int getNormalChildHeight() {
Sunny Goyalce8809a2018-01-18 14:02:47 -0800529 return getExpectedHeight() - getPaddingTop() - getPaddingBottom()
Sunny Goyalac00cba2017-11-13 15:58:01 -0800530 - mInsets.top - mInsets.bottom;
Adam Cohen410f3cd2013-09-22 12:09:32 -0700531 }
532
Sunny Goyalce8809a2018-01-18 14:02:47 -0800533 public int getExpectedWidth() {
534 return getMeasuredWidth();
535 }
536
Sunny Goyalbc683e92017-12-06 10:25:07 -0800537 public int getNormalChildWidth() {
Sunny Goyalce8809a2018-01-18 14:02:47 -0800538 return getExpectedWidth() - getPaddingLeft() - getPaddingRight()
Sunny Goyalbc683e92017-12-06 10:25:07 -0800539 - mInsets.left - mInsets.right;
540 }
541
Winson Chung321e9ee2010-08-09 13:37:56 -0700542 @Override
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800543 public void requestLayout() {
544 mIsLayoutValid = false;
545 super.requestLayout();
546 }
547
548 @Override
549 public void forceLayout() {
550 mIsLayoutValid = false;
551 super.forceLayout();
552 }
553
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100554 private int getPageWidthSize(int widthSize) {
555 return (widthSize - mInsets.left - mInsets.right) / getPanelCount();
556 }
557
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800558 @Override
Winson Chung321e9ee2010-08-09 13:37:56 -0700559 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
Sunny Goyal8e2133b2015-05-06 13:39:07 -0700560 if (getChildCount() == 0) {
Winson Chungf0ea4d32011-06-06 14:27:16 -0700561 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
562 return;
563 }
564
Adam Cohen7d30a372013-07-01 17:03:59 -0700565 // We measure the dimensions of the PagedView to be larger than the pages so that when we
566 // zoom out (and scale down), the view is still contained in the parent
Adam Cohen7d30a372013-07-01 17:03:59 -0700567 int widthMode = MeasureSpec.getMode(widthMeasureSpec);
568 int widthSize = MeasureSpec.getSize(widthMeasureSpec);
569 int heightMode = MeasureSpec.getMode(heightMeasureSpec);
Winson Chung8aad6102012-05-11 16:27:49 -0700570 int heightSize = MeasureSpec.getSize(heightMeasureSpec);
Adam Cohen410f3cd2013-09-22 12:09:32 -0700571
Adam Cohen7d30a372013-07-01 17:03:59 -0700572 if (widthMode == MeasureSpec.UNSPECIFIED || heightMode == MeasureSpec.UNSPECIFIED) {
573 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
574 return;
Winson Chung321e9ee2010-08-09 13:37:56 -0700575 }
576
Winson Chung8aad6102012-05-11 16:27:49 -0700577 // Return early if we aren't given a proper dimension
578 if (widthSize <= 0 || heightSize <= 0) {
579 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
580 return;
581 }
582
Winson Chung321e9ee2010-08-09 13:37:56 -0700583 // The children are given the same width and height as the workspace
Michael Jurka5f1c5092010-09-03 14:15:02 -0700584 // unless they were set to WRAP_CONTENT
Winson Chung785d2eb2011-04-14 16:08:02 -0700585 if (DEBUG) Log.d(TAG, "PagedView.onMeasure(): " + widthSize + ", " + heightSize);
Michael Jurka5f1c5092010-09-03 14:15:02 -0700586
Sunny Goyalac00cba2017-11-13 15:58:01 -0800587 int myWidthSpec = MeasureSpec.makeMeasureSpec(
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100588 getPageWidthSize(widthSize), MeasureSpec.EXACTLY);
Sunny Goyalac00cba2017-11-13 15:58:01 -0800589 int myHeightSpec = MeasureSpec.makeMeasureSpec(
Sunny Goyal228153d2018-01-04 15:35:22 -0800590 heightSize - mInsets.top - mInsets.bottom, MeasureSpec.EXACTLY);
Adam Cohen96d30a12013-07-16 18:13:21 -0700591
Sunny Goyalac00cba2017-11-13 15:58:01 -0800592 // measureChildren takes accounts for content padding, we only need to care about extra
593 // space due to insets.
594 measureChildren(myWidthSpec, myHeightSpec);
595 setMeasuredDimension(widthSize, heightSize);
Adam Cohen60b07122011-11-14 17:26:06 -0800596 }
597
Sunny Goyalcf25b522015-07-09 00:01:18 -0700598 @SuppressLint("DrawAllocation")
Winson Chung321e9ee2010-08-09 13:37:56 -0700599 @Override
Michael Jurka28750fb2010-09-24 17:43:49 -0700600 protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800601 mIsLayoutValid = true;
Vadim Trysheveb701c62018-05-14 16:00:15 -0700602 final int childCount = getChildCount();
603 boolean pageScrollChanged = false;
604 if (mPageScrolls == null || childCount != mPageScrolls.length) {
605 mPageScrolls = new int[childCount];
606 pageScrollChanged = true;
607 }
608
609 if (childCount == 0) {
Winson Chungf0ea4d32011-06-06 14:27:16 -0700610 return;
611 }
612
Winson Chung785d2eb2011-04-14 16:08:02 -0700613 if (DEBUG) Log.d(TAG, "PagedView.onLayout()");
Winson Chung321e9ee2010-08-09 13:37:56 -0700614
Vinit Nayaka406f722019-12-19 11:50:55 -0800615 boolean isScrollChanged = getPageScrolls(mPageScrolls, true, SIMPLE_SCROLL_LOGIC);
616 if (isScrollChanged) {
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700617 pageScrollChanged = true;
Winson Chung321e9ee2010-08-09 13:37:56 -0700618 }
Winson Chungc3665fa2011-09-14 17:56:27 -0700619
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700620 final LayoutTransition transition = getLayoutTransition();
621 // If the transition is running defer updating max scroll, as some empty pages could
622 // still be present, and a max scroll change could cause sudden jumps in scroll.
623 if (transition != null && transition.isRunning()) {
624 transition.addTransitionListener(new LayoutTransition.TransitionListener() {
625
626 @Override
627 public void startTransition(LayoutTransition transition, ViewGroup container,
628 View view, int transitionType) { }
629
630 @Override
631 public void endTransition(LayoutTransition transition, ViewGroup container,
632 View view, int transitionType) {
633 // Wait until all transitions are complete.
634 if (!transition.isRunning()) {
635 transition.removeTransitionListener(this);
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700636 updateMinAndMaxScrollX();
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700637 }
638 }
639 });
Adam Cohenf698c6e2013-07-17 18:44:25 -0700640 } else {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700641 updateMinAndMaxScrollX();
Adam Cohenf698c6e2013-07-17 18:44:25 -0700642 }
643
Sunny Goyalcb037ee2015-07-08 16:41:21 -0700644 if (mFirstLayout && mCurrentPage >= 0 && mCurrentPage < childCount) {
645 updateCurrentPageScroll();
646 mFirstLayout = false;
647 }
648
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800649 if (mScroller.isFinished() && pageScrollChanged) {
Sunny Goyalc82c6392018-06-06 15:39:13 -0700650 setCurrentPage(getNextPage());
Adam Cohenf698c6e2013-07-17 18:44:25 -0700651 }
Winson Chunge3193b92010-09-10 11:44:42 -0700652 }
653
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700654 /**
655 * Initializes {@code outPageScrolls} with scroll positions for view at that index. The length
656 * of {@code outPageScrolls} should be same as the the childCount
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700657 */
658 protected boolean getPageScrolls(int[] outPageScrolls, boolean layoutChildren,
659 ComputePageScrollsLogic scrollLogic) {
660 final int childCount = getChildCount();
661
662 final int startIndex = mIsRtl ? childCount - 1 : 0;
663 final int endIndex = mIsRtl ? -1 : childCount;
664 final int delta = mIsRtl ? -1 : 1;
665
Vinit Nayaka406f722019-12-19 11:50:55 -0800666 final int pageCenter = mOrientationHandler.getCenterForPage(this, mInsets);
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700667
Vinit Nayaka406f722019-12-19 11:50:55 -0800668 final int scrollOffsetStart = mOrientationHandler.getScrollOffsetStart(this, mInsets);
669 final int scrollOffsetEnd = mOrientationHandler.getScrollOffsetEnd(this, mInsets);
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700670 boolean pageScrollChanged = false;
671
Vinit Nayaka406f722019-12-19 11:50:55 -0800672 for (int i = startIndex, childStart = scrollOffsetStart; i != endIndex; i += delta) {
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700673 final View child = getPageAt(i);
674 if (scrollLogic.shouldIncludeView(child)) {
Vinit Nayaka406f722019-12-19 11:50:55 -0800675 ChildBounds bounds = mOrientationHandler.getChildBounds(child, childStart,
676 pageCenter, layoutChildren);
677 final int primaryDimension = bounds.primaryDimension;
678 final int childPrimaryEnd = bounds.childPrimaryEnd;
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700679
Alex Chaub5c4d112021-03-29 17:37:53 +0100680 // In case the pages are of different width, align the page to left edge for non-RTL
681 // or right edge for RTL.
682 final int pageScroll =
683 mIsRtl ? childPrimaryEnd - scrollOffsetEnd : childStart - scrollOffsetStart;
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700684 if (outPageScrolls[i] != pageScroll) {
685 pageScrollChanged = true;
686 outPageScrolls[i] = pageScroll;
687 }
Vinit Nayaka406f722019-12-19 11:50:55 -0800688 childStart += primaryDimension + mPageSpacing + getChildGap();
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700689 }
690 }
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100691
692 int panelCount = getPanelCount();
693 if (panelCount > 1) {
694 for (int i = 0; i < childCount; i++) {
695 // In case we have multiple panels, always use left panel's page scroll for all
696 // panels on the screen.
697 int adjustedScroll = outPageScrolls[getLeftmostVisiblePageForIndex(i)];
698 if (outPageScrolls[i] != adjustedScroll) {
699 outPageScrolls[i] = adjustedScroll;
700 pageScrollChanged = true;
701 }
702 }
703 }
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700704 return pageScrollChanged;
705 }
706
Sunny Goyala1fbd842015-05-20 13:40:27 -0700707 protected int getChildGap() {
708 return 0;
709 }
710
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700711 protected void updateMinAndMaxScrollX() {
Vinit Nayaka406f722019-12-19 11:50:55 -0800712 mMinScroll = computeMinScroll();
713 mMaxScroll = computeMaxScroll();
Tony Wickhamf549dab2016-05-16 09:54:06 -0700714 }
715
Vinit Nayaka406f722019-12-19 11:50:55 -0800716 protected int computeMinScroll() {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700717 return 0;
Tony50876bf2018-09-19 23:09:14 -0400718 }
719
Vinit Nayaka406f722019-12-19 11:50:55 -0800720 protected int computeMaxScroll() {
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700721 int childCount = getChildCount();
722 if (childCount > 0) {
Sunny Goyal70660032015-05-14 00:07:08 -0700723 final int index = mIsRtl ? 0 : childCount - 1;
Tony Wickhamf549dab2016-05-16 09:54:06 -0700724 return getScrollForPage(index);
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700725 } else {
Tony Wickhamf549dab2016-05-16 09:54:06 -0700726 return 0;
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700727 }
728 }
729
Adam Cohen3b185e22013-10-29 14:45:58 -0700730 public void setPageSpacing(int pageSpacing) {
731 mPageSpacing = pageSpacing;
732 requestLayout();
733 }
734
Tony50876bf2018-09-19 23:09:14 -0400735 public int getPageSpacing() {
736 return mPageSpacing;
737 }
738
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800739 private void dispatchPageCountChanged() {
740 if (mPageIndicator != null) {
741 mPageIndicator.setMarkersCount(getChildCount());
Winson Chungd2be3812013-07-16 11:11:32 -0700742 }
Adam Cohen2591f6a2011-10-25 14:36:40 -0700743 // This ensures that when children are added, they get the correct transforms / alphas
744 // in accordance with any scroll effects.
Adam Cohen2591f6a2011-10-25 14:36:40 -0700745 invalidate();
746 }
747
Michael Jurka8b805b12012-04-18 14:23:14 -0700748 @Override
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800749 public void onViewAdded(View child) {
Winson Chungc7c51582018-02-23 17:58:36 -0800750 super.onViewAdded(child);
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800751 dispatchPageCountChanged();
752 }
753
754 @Override
755 public void onViewRemoved(View child) {
Winson Chungc7c51582018-02-23 17:58:36 -0800756 super.onViewRemoved(child);
Tonya361c722017-07-04 09:43:06 -0700757 mCurrentPage = validateNewPage(mCurrentPage);
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800758 dispatchPageCountChanged();
Winson Chungd2be3812013-07-16 11:11:32 -0700759 }
760
Adam Cohen73894962011-10-31 13:17:17 -0700761 protected int getChildOffset(int index) {
Adam Cohen7d30a372013-07-01 17:03:59 -0700762 if (index < 0 || index > getChildCount() - 1) return 0;
Vinit Nayaka406f722019-12-19 11:50:55 -0800763 View pageAtIndex = getPageAt(index);
764 return mOrientationHandler.getChildStart(pageAtIndex);
Adam Cohen73894962011-10-31 13:17:17 -0700765 }
766
Alex Chau7944ee52021-01-08 19:07:25 +0000767 protected int getChildVisibleSize(int index) {
768 View layout = getPageAt(index);
769 return mOrientationHandler.getMeasuredSize(layout);
770 }
771
Winson Chung321e9ee2010-08-09 13:37:56 -0700772 @Override
773 public boolean requestChildRectangleOnScreen(View child, Rect rectangle, boolean immediate) {
Adam Cohenae4f1552011-10-20 00:15:42 -0700774 int page = indexToPage(indexOfChild(child));
Winson Chung86f77532010-08-24 11:08:22 -0700775 if (page != mCurrentPage || !mScroller.isFinished()) {
Vadim Trysheveeaa8ee2018-04-11 12:23:42 -0700776 if (immediate) {
777 setCurrentPage(page);
778 } else {
779 snapToPage(page);
780 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700781 return true;
782 }
783 return false;
784 }
785
786 @Override
787 protected boolean onRequestFocusInDescendants(int direction, Rect previouslyFocusedRect) {
Winson Chung86f77532010-08-24 11:08:22 -0700788 int focusablePage;
789 if (mNextPage != INVALID_PAGE) {
790 focusablePage = mNextPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700791 } else {
Winson Chung86f77532010-08-24 11:08:22 -0700792 focusablePage = mCurrentPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700793 }
Winson Chung86f77532010-08-24 11:08:22 -0700794 View v = getPageAt(focusablePage);
Winson Chung321e9ee2010-08-09 13:37:56 -0700795 if (v != null) {
Adam Cohen76fc0852011-06-17 13:26:23 -0700796 return v.requestFocus(direction, previouslyFocusedRect);
Winson Chung321e9ee2010-08-09 13:37:56 -0700797 }
798 return false;
799 }
800
801 @Override
802 public boolean dispatchUnhandledMove(View focused, int direction) {
Sunny Goyal0c4e3722015-12-01 13:21:49 -0800803 if (super.dispatchUnhandledMove(focused, direction)) {
804 return true;
805 }
806
807 if (mIsRtl) {
808 if (direction == View.FOCUS_LEFT) {
809 direction = View.FOCUS_RIGHT;
810 } else if (direction == View.FOCUS_RIGHT) {
811 direction = View.FOCUS_LEFT;
812 }
813 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700814 if (direction == View.FOCUS_LEFT) {
Winson Chung86f77532010-08-24 11:08:22 -0700815 if (getCurrentPage() > 0) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100816 int nextPage = validateNewPage(getCurrentPage() - 1);
817 snapToPage(nextPage);
818 getChildAt(nextPage).requestFocus(direction);
Winson Chung321e9ee2010-08-09 13:37:56 -0700819 return true;
820 }
821 } else if (direction == View.FOCUS_RIGHT) {
Winson Chung86f77532010-08-24 11:08:22 -0700822 if (getCurrentPage() < getPageCount() - 1) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100823 int nextPage = validateNewPage(getCurrentPage() + 1);
824 snapToPage(nextPage);
825 getChildAt(nextPage).requestFocus(direction);
Winson Chung321e9ee2010-08-09 13:37:56 -0700826 return true;
827 }
828 }
Sunny Goyal0c4e3722015-12-01 13:21:49 -0800829 return false;
Winson Chung321e9ee2010-08-09 13:37:56 -0700830 }
831
832 @Override
833 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) {
Jon Miranda6a858172016-10-25 16:19:17 -0700834 if (getDescendantFocusability() == FOCUS_BLOCK_DESCENDANTS) {
835 return;
836 }
837
Adam Cohen0ffac432013-07-10 11:19:26 -0700838 // XXX-RTL: This will be fixed in a future CL
Winson Chung86f77532010-08-24 11:08:22 -0700839 if (mCurrentPage >= 0 && mCurrentPage < getPageCount()) {
alanvaf519952012-05-07 17:33:22 -0700840 getPageAt(mCurrentPage).addFocusables(views, direction, focusableMode);
Winson Chung321e9ee2010-08-09 13:37:56 -0700841 }
842 if (direction == View.FOCUS_LEFT) {
Winson Chung86f77532010-08-24 11:08:22 -0700843 if (mCurrentPage > 0) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100844 int nextPage = validateNewPage(mCurrentPage - 1);
845 getPageAt(nextPage).addFocusables(views, direction, focusableMode);
Winson Chung321e9ee2010-08-09 13:37:56 -0700846 }
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100847 } else if (direction == View.FOCUS_RIGHT) {
Winson Chung86f77532010-08-24 11:08:22 -0700848 if (mCurrentPage < getPageCount() - 1) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100849 int nextPage = validateNewPage(mCurrentPage + 1);
850 getPageAt(nextPage).addFocusables(views, direction, focusableMode);
Winson Chung321e9ee2010-08-09 13:37:56 -0700851 }
852 }
853 }
854
855 /**
856 * If one of our descendant views decides that it could be focused now, only
Winson Chung86f77532010-08-24 11:08:22 -0700857 * pass that along if it's on the current page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700858 *
Winson Chung86f77532010-08-24 11:08:22 -0700859 * This happens when live folders requery, and if they're off page, they
860 * end up calling requestFocus, which pulls it on page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700861 */
862 @Override
863 public void focusableViewAvailable(View focused) {
Winson Chung86f77532010-08-24 11:08:22 -0700864 View current = getPageAt(mCurrentPage);
Winson Chung321e9ee2010-08-09 13:37:56 -0700865 View v = focused;
866 while (true) {
867 if (v == current) {
868 super.focusableViewAvailable(focused);
869 return;
870 }
871 if (v == this) {
872 return;
873 }
874 ViewParent parent = v.getParent();
875 if (parent instanceof View) {
876 v = (View)v.getParent();
877 } else {
878 return;
879 }
880 }
881 }
882
883 /**
884 * {@inheritDoc}
885 */
886 @Override
887 public void requestDisallowInterceptTouchEvent(boolean disallowIntercept) {
888 if (disallowIntercept) {
889 // We need to make sure to cancel our long press if
890 // a scrollable widget takes over touch events
Andras Kloczl7a1ca0b2021-04-08 16:08:16 +0200891 cancelCurrentPageLongPress();
Winson Chung321e9ee2010-08-09 13:37:56 -0700892 }
893 super.requestDisallowInterceptTouchEvent(disallowIntercept);
894 }
895
896 @Override
897 public boolean onInterceptTouchEvent(MotionEvent ev) {
898 /*
899 * This method JUST determines whether we want to intercept the motion.
900 * If we return true, onTouchEvent will be called and we do the actual
901 * scrolling there.
902 */
903
Winson Chung45e1d6e2010-11-09 17:19:49 -0800904 // Skip touch handling if there are no pages to swipe
Tony Wickhamb6841ac2019-07-22 12:39:59 -0700905 if (getChildCount() <= 0) return false;
Sunny Goyalc4bb3732019-06-20 11:34:14 -0700906
907 acquireVelocityTrackerAndAddMovement(ev);
Winson Chung45e1d6e2010-11-09 17:19:49 -0800908
Winson Chung321e9ee2010-08-09 13:37:56 -0700909 /*
910 * Shortcut the most recurring case: the user is in the dragging
911 * state and he is moving his finger. We want to intercept this
912 * motion.
913 */
914 final int action = ev.getAction();
Sunny Goyalaad33592018-08-07 17:20:35 -0700915 if ((action == MotionEvent.ACTION_MOVE) && mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -0700916 return true;
917 }
918
Winson Chung321e9ee2010-08-09 13:37:56 -0700919 switch (action & MotionEvent.ACTION_MASK) {
920 case MotionEvent.ACTION_MOVE: {
921 /*
922 * mIsBeingDragged == false, otherwise the shortcut would have caught it. Check
Vinit Nayaka406f722019-12-19 11:50:55 -0800923 * whether the user has moved far enough from their original down touch.
Winson Chung321e9ee2010-08-09 13:37:56 -0700924 */
Michael Jurka1ff706b2010-09-14 17:35:20 -0700925 if (mActivePointerId != INVALID_POINTER) {
926 determineScrollingStart(ev);
Michael Jurka1ff706b2010-09-14 17:35:20 -0700927 }
928 // if mActivePointerId is INVALID_POINTER, then we must have missed an ACTION_DOWN
Vinit Nayaka406f722019-12-19 11:50:55 -0800929 // event. in that case, treat the first occurrence of a move event as a ACTION_DOWN
Michael Jurka1ff706b2010-09-14 17:35:20 -0700930 // i.e. fall through to the next case (don't break)
931 // (We sometimes miss ACTION_DOWN events in Workspace because it ignores all events
932 // while it's small- this was causing a crash before we checked for INVALID_POINTER)
Adam Cohen93c97562013-09-26 13:48:01 -0700933 break;
Winson Chung321e9ee2010-08-09 13:37:56 -0700934 }
935
936 case MotionEvent.ACTION_DOWN: {
937 final float x = ev.getX();
938 final float y = ev.getY();
939 // Remember location of down touch
940 mDownMotionX = x;
Adam Cohen7d30a372013-07-01 17:03:59 -0700941 mDownMotionY = y;
Jon Mirandaf52af432020-04-10 17:25:57 -0700942 mDownMotionPrimary = mLastMotion = mOrientationHandler.getPrimaryDirection(ev, 0);
Vinit Nayaka406f722019-12-19 11:50:55 -0800943 mLastMotionRemainder = 0;
944 mTotalMotion = 0;
Winson Chung4941f652020-06-18 15:11:53 -0700945 mAllowEasyFling = false;
Winson Chung321e9ee2010-08-09 13:37:56 -0700946 mActivePointerId = ev.getPointerId(0);
Sunny Goyalc39db732021-04-03 01:20:21 -0700947 updateIsBeingDraggedOnTouchDown(ev);
Winson Chung321e9ee2010-08-09 13:37:56 -0700948 break;
949 }
950
Winson Chung321e9ee2010-08-09 13:37:56 -0700951 case MotionEvent.ACTION_UP:
Jeff Brown1d0867c2010-12-02 18:27:39 -0800952 case MotionEvent.ACTION_CANCEL:
Adam Cohen7d30a372013-07-01 17:03:59 -0700953 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -0700954 break;
955
956 case MotionEvent.ACTION_POINTER_UP:
957 onSecondaryPointerUp(ev);
Adam Cohen6342bba2011-03-10 11:33:35 -0800958 releaseVelocityTracker();
Winson Chung321e9ee2010-08-09 13:37:56 -0700959 break;
960 }
961
962 /*
963 * The only time we want to intercept motion events is if we are in the
964 * drag mode.
965 */
Sunny Goyalaad33592018-08-07 17:20:35 -0700966 return mIsBeingDragged;
Winson Chung321e9ee2010-08-09 13:37:56 -0700967 }
968
Tony Wickhama0aee212019-09-18 09:24:03 -0700969 /**
970 * If being flinged and user touches the screen, initiate drag; otherwise don't.
971 */
Sunny Goyalc39db732021-04-03 01:20:21 -0700972 private void updateIsBeingDraggedOnTouchDown(MotionEvent ev) {
Tony Wickhama0aee212019-09-18 09:24:03 -0700973 // mScroller.isFinished should be false when being flinged.
Sunny Goyalc39db732021-04-03 01:20:21 -0700974 final int xDist = Math.abs(mScroller.getFinalX() - mScroller.getCurrX());
Winson Chung4941f652020-06-18 15:11:53 -0700975 final boolean finishedScrolling = (mScroller.isFinished() || xDist < mPageSlop / 3);
Tony Wickhama0aee212019-09-18 09:24:03 -0700976
977 if (finishedScrolling) {
978 mIsBeingDragged = false;
979 if (!mScroller.isFinished() && !mFreeScroll) {
980 setCurrentPage(getNextPage());
981 pageEndTransition();
982 }
Sunny Goyalc39db732021-04-03 01:20:21 -0700983 mIsBeingDragged = !mEdgeGlowLeft.isFinished() || !mEdgeGlowRight.isFinished();
Tony Wickhama0aee212019-09-18 09:24:03 -0700984 } else {
985 mIsBeingDragged = true;
986 }
Sunny Goyalc39db732021-04-03 01:20:21 -0700987
988 // Catch the edge effect if it is active.
989 float displacement = mOrientationHandler.getSecondaryValue(ev.getX(), ev.getY())
990 / mOrientationHandler.getSecondaryValue(getWidth(), getHeight());
991 if (!mEdgeGlowLeft.isFinished()) {
992 mEdgeGlowLeft.onPullDistance(0f, 1f - displacement);
993 }
994 if (!mEdgeGlowRight.isFinished()) {
995 mEdgeGlowRight.onPullDistance(0f, displacement);
996 }
Tony Wickhama0aee212019-09-18 09:24:03 -0700997 }
998
Sunny Goyal7c7be8c2018-03-07 19:58:07 -0800999 public boolean isHandlingTouch() {
Sunny Goyalaad33592018-08-07 17:20:35 -07001000 return mIsBeingDragged;
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001001 }
1002
Adam Cohenf8d28232011-02-01 21:47:00 -08001003 protected void determineScrollingStart(MotionEvent ev) {
1004 determineScrollingStart(ev, 1.0f);
1005 }
1006
Winson Chung321e9ee2010-08-09 13:37:56 -07001007 /*
1008 * Determines if we should change the touch state to start scrolling after the
1009 * user moves their touch point too far.
1010 */
Adam Cohenf8d28232011-02-01 21:47:00 -08001011 protected void determineScrollingStart(MotionEvent ev, float touchSlopScale) {
Adam Cohen7d30a372013-07-01 17:03:59 -07001012 // Disallow scrolling if we don't have a valid pointer index
Winson Chung321e9ee2010-08-09 13:37:56 -07001013 final int pointerIndex = ev.findPointerIndex(mActivePointerId);
Adam Cohen7d30a372013-07-01 17:03:59 -07001014 if (pointerIndex == -1) return;
1015
Vinit Nayaka406f722019-12-19 11:50:55 -08001016 final float primaryDirection = mOrientationHandler.getPrimaryDirection(ev, pointerIndex);
1017 final int diff = (int) Math.abs(primaryDirection - mLastMotion);
Adam Cohenf8d28232011-02-01 21:47:00 -08001018 final int touchSlop = Math.round(touchSlopScale * mTouchSlop);
Winson Chung4941f652020-06-18 15:11:53 -07001019 boolean moved = diff > touchSlop || ev.getAction() == ACTION_MOVE_ALLOW_EASY_FLING;
Winson Chung321e9ee2010-08-09 13:37:56 -07001020
Vinit Nayaka406f722019-12-19 11:50:55 -08001021 if (moved) {
Sunny Goyal5a1f53b2015-05-27 10:24:24 -07001022 // Scroll if the user moved far enough along the X axis
Sunny Goyalaad33592018-08-07 17:20:35 -07001023 mIsBeingDragged = true;
Vinit Nayaka406f722019-12-19 11:50:55 -08001024 mTotalMotion += Math.abs(mLastMotion - primaryDirection);
1025 mLastMotion = primaryDirection;
1026 mLastMotionRemainder = 0;
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001027 pageBeginTransition();
Tony Wickhamdadb3042016-02-24 11:07:00 -08001028 // Stop listening for things like pinches.
1029 requestDisallowInterceptTouchEvent(true);
Adam Cohenf8d28232011-02-01 21:47:00 -08001030 }
1031 }
1032
1033 protected void cancelCurrentPageLongPress() {
Sunny Goyal8e2133b2015-05-06 13:39:07 -07001034 // Try canceling the long press. It could also have been scheduled
1035 // by a distant descendant, so use the mAllowLongPress flag to block
1036 // everything
Andras Kloczl2bb51342021-03-20 01:13:45 +01001037 getVisiblePages().forEach(View::cancelLongPress);
Winson Chung321e9ee2010-08-09 13:37:56 -07001038 }
1039
Adam Cohenb5ba0972011-09-07 18:02:31 -07001040 protected float getScrollProgress(int screenCenter, View v, int page) {
Sunny Goyal228153d2018-01-04 15:35:22 -08001041 final int halfScreenSize = getMeasuredWidth() / 2;
Adam Cohenb5ba0972011-09-07 18:02:31 -07001042
Adam Cohenedb40762013-07-18 16:45:45 -07001043 int delta = screenCenter - (getScrollForPage(page) + halfScreenSize);
Adam Cohen3b185e22013-10-29 14:45:58 -07001044 int count = getChildCount();
1045
1046 final int totalDistance;
1047
1048 int adjacentPage = page + 1;
Sunny Goyal70660032015-05-14 00:07:08 -07001049 if ((delta < 0 && !mIsRtl) || (delta > 0 && mIsRtl)) {
Adam Cohen3b185e22013-10-29 14:45:58 -07001050 adjacentPage = page - 1;
1051 }
1052
1053 if (adjacentPage < 0 || adjacentPage > count - 1) {
1054 totalDistance = v.getMeasuredWidth() + mPageSpacing;
1055 } else {
1056 totalDistance = Math.abs(getScrollForPage(adjacentPage) - getScrollForPage(page));
1057 }
Adam Cohenb5ba0972011-09-07 18:02:31 -07001058
1059 float scrollProgress = delta / (totalDistance * 1.0f);
Sunny Goyal8e2133b2015-05-06 13:39:07 -07001060 scrollProgress = Math.min(scrollProgress, MAX_SCROLL_PROGRESS);
1061 scrollProgress = Math.max(scrollProgress, - MAX_SCROLL_PROGRESS);
Adam Cohenb5ba0972011-09-07 18:02:31 -07001062 return scrollProgress;
1063 }
1064
Adam Cohenedb40762013-07-18 16:45:45 -07001065 public int getScrollForPage(int index) {
Adam Cohen1f1f45d2013-10-02 09:40:18 -07001066 if (mPageScrolls == null || index >= mPageScrolls.length || index < 0) {
Adam Cohenedb40762013-07-18 16:45:45 -07001067 return 0;
1068 } else {
1069 return mPageScrolls[index];
1070 }
1071 }
1072
Adam Cohen564a2e72013-10-09 14:47:32 -07001073 // While layout transitions are occurring, a child's position may stray from its baseline
1074 // position. This method returns the magnitude of this stray at any given time.
1075 public int getLayoutTransitionOffsetForPage(int index) {
1076 if (mPageScrolls == null || index >= mPageScrolls.length || index < 0) {
1077 return 0;
1078 } else {
1079 View child = getChildAt(index);
Adam Cohen3b185e22013-10-29 14:45:58 -07001080
Sunny Goyal228153d2018-01-04 15:35:22 -08001081 int scrollOffset = mIsRtl ? getPaddingRight() : getPaddingLeft();
1082 int baselineX = mPageScrolls[index] + scrollOffset;
Adam Cohen564a2e72013-10-09 14:47:32 -07001083 return (int) (child.getX() - baselineX);
1084 }
1085 }
1086
Tony Wickham023f4042019-01-29 10:52:31 -08001087 public void setEnableFreeScroll(boolean freeScroll) {
Winson Chung0e449002019-04-26 11:09:58 -07001088 if (mFreeScroll == freeScroll) {
1089 return;
1090 }
1091
Tony Wickham8f7ead32016-04-07 18:46:44 -07001092 boolean wasFreeScroll = mFreeScroll;
Adam Cohenf358a4b2013-07-23 16:47:31 -07001093 mFreeScroll = freeScroll;
1094
Adam Cohenf9618852013-11-08 06:45:03 -08001095 if (mFreeScroll) {
Sunny Goyal4d519f22017-10-24 10:32:40 -07001096 setCurrentPage(getNextPage());
Tony Wickham8f7ead32016-04-07 18:46:44 -07001097 } else if (wasFreeScroll) {
Tony Wickhamaf33f2c2019-10-04 12:55:22 -07001098 if (getScrollForPage(getNextPage()) != getScrollX()) {
1099 snapToPage(getNextPage());
1100 }
Adam Cohenf358a4b2013-07-23 16:47:31 -07001101 }
Adam Cohenf358a4b2013-07-23 16:47:31 -07001102 }
1103
Sunny Goyal2f0ec852015-03-26 13:38:27 -07001104 protected void setEnableOverscroll(boolean enable) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001105 mAllowOverScroll = enable;
1106 }
1107
Winson Chung321e9ee2010-08-09 13:37:56 -07001108 @Override
1109 public boolean onTouchEvent(MotionEvent ev) {
Winson Chung45e1d6e2010-11-09 17:19:49 -08001110 // Skip touch handling if there are no pages to swipe
Tony Wickhamb6841ac2019-07-22 12:39:59 -07001111 if (getChildCount() <= 0) return false;
Winson Chung45e1d6e2010-11-09 17:19:49 -08001112
Michael Jurkab8f06722010-10-10 15:58:46 -07001113 acquireVelocityTrackerAndAddMovement(ev);
Winson Chung321e9ee2010-08-09 13:37:56 -07001114
1115 final int action = ev.getAction();
1116
1117 switch (action & MotionEvent.ACTION_MASK) {
1118 case MotionEvent.ACTION_DOWN:
Sunny Goyalc39db732021-04-03 01:20:21 -07001119 updateIsBeingDraggedOnTouchDown(ev);
Tony Wickhama0aee212019-09-18 09:24:03 -07001120
Winson Chung321e9ee2010-08-09 13:37:56 -07001121 /*
1122 * If being flinged and user touches, stop the fling. isFinished
1123 * will be false if being flinged.
1124 */
1125 if (!mScroller.isFinished()) {
Adam Cohen8bdbaab2013-10-29 15:25:02 -07001126 abortScrollerAnimation(false);
Winson Chung321e9ee2010-08-09 13:37:56 -07001127 }
1128
1129 // Remember where the motion event started
Vinit Nayaka406f722019-12-19 11:50:55 -08001130 mDownMotionX = ev.getX();
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001131 mDownMotionY = ev.getY();
Vinit Nayaka406f722019-12-19 11:50:55 -08001132 mDownMotionPrimary = mLastMotion = mOrientationHandler.getPrimaryDirection(ev, 0);
1133 mLastMotionRemainder = 0;
1134 mTotalMotion = 0;
Winson Chung4941f652020-06-18 15:11:53 -07001135 mAllowEasyFling = false;
Winson Chung321e9ee2010-08-09 13:37:56 -07001136 mActivePointerId = ev.getPointerId(0);
Sunny Goyalaad33592018-08-07 17:20:35 -07001137 if (mIsBeingDragged) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001138 pageBeginTransition();
Michael Jurka0142d492010-08-25 17:46:15 -07001139 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001140 break;
1141
Winson Chung4941f652020-06-18 15:11:53 -07001142 case ACTION_MOVE_ALLOW_EASY_FLING:
1143 // Start scrolling immediately
1144 determineScrollingStart(ev);
1145 mAllowEasyFling = true;
1146 break;
1147
1148 case MotionEvent.ACTION_MOVE:
1149 if (mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001150 // Scroll to follow the motion event
1151 final int pointerIndex = ev.findPointerIndex(mActivePointerId);
Adam Cohen7d30a372013-07-01 17:03:59 -07001152
1153 if (pointerIndex == -1) return true;
Sunny Goyalc39db732021-04-03 01:20:21 -07001154 float oldScroll = mOrientationHandler.getPrimaryScroll(this);
1155 float dx = ev.getX(pointerIndex);
1156 float dy = ev.getY(pointerIndex);
Adam Cohen7d30a372013-07-01 17:03:59 -07001157
Sunny Goyalc39db732021-04-03 01:20:21 -07001158 float direction = mOrientationHandler.getPrimaryValue(dx, dy);
Vinit Nayaka406f722019-12-19 11:50:55 -08001159 float delta = mLastMotion + mLastMotionRemainder - direction;
Sunny Goyalc39db732021-04-03 01:20:21 -07001160
1161 int width = getWidth();
1162 int height = getHeight();
1163 int size = mOrientationHandler.getPrimaryValue(width, height);
1164
1165 final float displacement = mOrientationHandler.getSecondaryValue(dx, dy)
1166 / mOrientationHandler.getSecondaryValue(width, height);
Vinit Nayaka406f722019-12-19 11:50:55 -08001167 mTotalMotion += Math.abs(delta);
Adam Cohenaefd4e12011-02-14 16:39:38 -08001168
Sunny Goyalc39db732021-04-03 01:20:21 -07001169 if (mAllowOverScroll) {
1170 float consumed = 0;
1171 if (delta < 0 && mEdgeGlowRight.getDistance() != 0f) {
1172 consumed = size * mEdgeGlowRight.onPullDistance(delta / size, displacement);
1173 } else if (delta > 0 && mEdgeGlowLeft.getDistance() != 0f) {
1174 consumed = -size * mEdgeGlowLeft.onPullDistance(
1175 -delta / size, 1 - displacement);
1176 }
1177 delta -= consumed;
1178 }
1179
Winson Chungc0844aa2011-02-02 15:25:58 -08001180 // Only scroll and update mLastMotionX if we have moved some discrete amount. We
1181 // keep the remainder because we are actually testing if we've moved from the last
1182 // scrolled position (which is discrete).
Sunny Goyalc39db732021-04-03 01:20:21 -07001183 mLastMotion = direction;
1184 int movedDelta = (int) delta;
1185 mLastMotionRemainder = delta - movedDelta;
Vinit Nayaka406f722019-12-19 11:50:55 -08001186
Sunny Goyalc39db732021-04-03 01:20:21 -07001187 if (delta != 0) {
1188 mOrientationHandler.set(this, VIEW_SCROLL_BY, movedDelta);
1189
1190 if (mAllowOverScroll) {
1191 final float pulledToX = oldScroll + delta;
1192
1193 if (pulledToX < mMinScroll) {
1194 mEdgeGlowLeft.onPullDistance(-delta / size, 1.f - displacement);
1195 if (!mEdgeGlowRight.isFinished()) {
1196 mEdgeGlowRight.onRelease();
1197 }
1198 } else if (pulledToX > mMaxScroll) {
1199 mEdgeGlowRight.onPullDistance(delta / size, displacement);
1200 if (!mEdgeGlowLeft.isFinished()) {
1201 mEdgeGlowLeft.onRelease();
1202 }
1203 }
1204
1205 if (!mEdgeGlowLeft.isFinished() || !mEdgeGlowRight.isFinished()) {
1206 postInvalidateOnAnimation();
1207 }
1208 }
1209
Winson Chung321e9ee2010-08-09 13:37:56 -07001210 } else {
1211 awakenScrollBars();
1212 }
Adam Cohen564976a2010-10-13 18:52:07 -07001213 } else {
Winson Chung321e9ee2010-08-09 13:37:56 -07001214 determineScrollingStart(ev);
1215 }
1216 break;
1217
1218 case MotionEvent.ACTION_UP:
Sunny Goyalaad33592018-08-07 17:20:35 -07001219 if (mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001220 final int activePointerId = mActivePointerId;
1221 final int pointerIndex = ev.findPointerIndex(activePointerId);
Vinit Nayak93bf1fe2020-05-26 17:22:13 -07001222 if (pointerIndex == -1) return true;
1223
Vinit Nayaka406f722019-12-19 11:50:55 -08001224 final float primaryDirection = mOrientationHandler.getPrimaryDirection(ev,
1225 pointerIndex);
Sunny Goyal4bb8b062019-02-19 16:37:38 -08001226 final VelocityTracker velocityTracker = mVelocityTracker;
1227 velocityTracker.computeCurrentVelocity(1000, mMaximumVelocity);
Adam Cohenaefd4e12011-02-14 16:39:38 -08001228
Vinit Nayaka406f722019-12-19 11:50:55 -08001229 int velocity = (int) mOrientationHandler.getPrimaryVelocity(velocityTracker,
1230 mActivePointerId);
1231 int delta = (int) (primaryDirection - mDownMotionPrimary);
1232 int pageOrientedSize = mOrientationHandler.getMeasuredSize(getPageAt(mCurrentPage));
1233
1234 boolean isSignificantMove = Math.abs(delta) > pageOrientedSize *
1235 SIGNIFICANT_MOVE_THRESHOLD;
1236
1237 mTotalMotion += Math.abs(mLastMotion + mLastMotionRemainder - primaryDirection);
Winson Chung4941f652020-06-18 15:11:53 -07001238 boolean passedSlop = mAllowEasyFling || mTotalMotion > mPageSlop;
1239 boolean isFling = passedSlop && shouldFlingForVelocity(velocity);
Vinit Nayaka406f722019-12-19 11:50:55 -08001240 boolean isDeltaLeft = mIsRtl ? delta > 0 : delta < 0;
1241 boolean isVelocityLeft = mIsRtl ? velocity > 0 : velocity < 0;
Winson Chung4941f652020-06-18 15:11:53 -07001242 if (DEBUG_FAILED_QUICKSWITCH && !isFling && mAllowEasyFling) {
1243 Log.d("Quickswitch", "isFling=false vel=" + velocity
1244 + " threshold=" + mEasyFlingThresholdVelocity);
1245 }
Adam Cohen00481b32011-11-18 12:03:48 -08001246
Adam Cohenf358a4b2013-07-23 16:47:31 -07001247 if (!mFreeScroll) {
1248 // In the case that the page is moved far to one direction and then is flung
1249 // in the opposite direction, we use a threshold to determine whether we should
1250 // just return to the starting page, or if we should skip one further.
1251 boolean returnToOriginalPage = false;
Vinit Nayaka406f722019-12-19 11:50:55 -08001252 if (Math.abs(delta) > pageOrientedSize * RETURN_TO_ORIGINAL_PAGE_THRESHOLD &&
1253 Math.signum(velocity) != Math.signum(delta) && isFling) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001254 returnToOriginalPage = true;
1255 }
Adam Cohenaefd4e12011-02-14 16:39:38 -08001256
Adam Cohenf358a4b2013-07-23 16:47:31 -07001257 int finalPage;
1258 // We give flings precedence over large moves, which is why we short-circuit our
1259 // test for a large move if a fling has been registered. That is, a large
1260 // move to the left and fling to the right will register as a fling to the right.
Sunny Goyalb7b01352018-08-09 12:31:20 -07001261
Vinit Nayaka406f722019-12-19 11:50:55 -08001262 if (((isSignificantMove && !isDeltaLeft && !isFling) ||
1263 (isFling && !isVelocityLeft)) && mCurrentPage > 0) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +01001264 finalPage = returnToOriginalPage
1265 ? mCurrentPage : mCurrentPage - getPanelCount();
Vinit Nayaka406f722019-12-19 11:50:55 -08001266 snapToPageWithVelocity(finalPage, velocity);
1267 } else if (((isSignificantMove && isDeltaLeft && !isFling) ||
1268 (isFling && isVelocityLeft)) &&
Adam Cohenf358a4b2013-07-23 16:47:31 -07001269 mCurrentPage < getChildCount() - 1) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +01001270 finalPage = returnToOriginalPage
1271 ? mCurrentPage : mCurrentPage + getPanelCount();
Vinit Nayaka406f722019-12-19 11:50:55 -08001272 snapToPageWithVelocity(finalPage, velocity);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001273 } else {
1274 snapToDestination();
Adam Cohenf358a4b2013-07-23 16:47:31 -07001275 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001276 } else {
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001277 if (!mScroller.isFinished()) {
1278 abortScrollerAnimation(true);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001279 }
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001280
Vinit Nayaka406f722019-12-19 11:50:55 -08001281 int initialScroll = mOrientationHandler.getPrimaryScroll(this);
1282 int maxScroll = mMaxScroll;
1283 int minScroll = mMinScroll;
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001284
Vinit Nayaka406f722019-12-19 11:50:55 -08001285 if (((initialScroll >= maxScroll) && (isVelocityLeft || !isFling)) ||
1286 ((initialScroll <= minScroll) && (!isVelocityLeft || !isFling))) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001287 mScroller.springBack(initialScroll, 0, minScroll, maxScroll, 0, 0);
Alex Chaub794ea62021-02-03 18:00:30 +00001288 mNextPage = getDestinationPage();
Sunny Goyalb7b01352018-08-09 12:31:20 -07001289 } else {
Sunny Goyalc39db732021-04-03 01:20:21 -07001290 int velocity1 = -velocity;
1291 // Continue a scroll or fling in progress
1292 mScroller.fling(initialScroll, 0, velocity1, 0, minScroll, maxScroll, 0, 0,
1293 Math.round(getWidth() * 0.5f * OVERSCROLL_DAMP_FACTOR), 0);
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001294
Sunny Goyalc39db732021-04-03 01:20:21 -07001295 int finalPos = mScroller.getFinalX();
Alex Chaub794ea62021-02-03 18:00:30 +00001296 mNextPage = getDestinationPage(finalPos);
Sunny Goyalc39db732021-04-03 01:20:21 -07001297 onNotSnappingToPageInFreeScroll();
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001298 }
1299 invalidate();
Winson Chung321e9ee2010-08-09 13:37:56 -07001300 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001301 }
Adam Cohen7d30a372013-07-01 17:03:59 -07001302
Sunny Goyalc39db732021-04-03 01:20:21 -07001303 mEdgeGlowLeft.onRelease();
1304 mEdgeGlowRight.onRelease();
Adam Cohen7d30a372013-07-01 17:03:59 -07001305 // End any intermediate reordering states
1306 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001307 break;
1308
1309 case MotionEvent.ACTION_CANCEL:
Sunny Goyalaad33592018-08-07 17:20:35 -07001310 if (mIsBeingDragged) {
Michael Jurkab8f06722010-10-10 15:58:46 -07001311 snapToDestination();
1312 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001313 mEdgeGlowLeft.onRelease();
1314 mEdgeGlowRight.onRelease();
Adam Cohen7d30a372013-07-01 17:03:59 -07001315 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001316 break;
1317
1318 case MotionEvent.ACTION_POINTER_UP:
1319 onSecondaryPointerUp(ev);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001320 releaseVelocityTracker();
Winson Chung321e9ee2010-08-09 13:37:56 -07001321 break;
1322 }
1323
1324 return true;
1325 }
1326
Sunny Goyalc39db732021-04-03 01:20:21 -07001327 protected void onNotSnappingToPageInFreeScroll() { }
Alex Chaub794ea62021-02-03 18:00:30 +00001328
Vinit Nayaka406f722019-12-19 11:50:55 -08001329 protected boolean shouldFlingForVelocity(int velocity) {
Winson Chung4941f652020-06-18 15:11:53 -07001330 float threshold = mAllowEasyFling ? mEasyFlingThresholdVelocity : mFlingThresholdVelocity;
1331 return Math.abs(velocity) > threshold;
Sunny Goyal65d9ceb2017-05-08 09:17:42 -07001332 }
1333
Adam Cohen7d30a372013-07-01 17:03:59 -07001334 private void resetTouchState() {
1335 releaseVelocityTracker();
Sunny Goyalaad33592018-08-07 17:20:35 -07001336 mIsBeingDragged = false;
Adam Cohen7d30a372013-07-01 17:03:59 -07001337 mActivePointerId = INVALID_POINTER;
Adam Cohen7d30a372013-07-01 17:03:59 -07001338 }
1339
Winson Chung185d7162011-02-28 13:47:29 -08001340 @Override
1341 public boolean onGenericMotionEvent(MotionEvent event) {
1342 if ((event.getSource() & InputDevice.SOURCE_CLASS_POINTER) != 0) {
1343 switch (event.getAction()) {
1344 case MotionEvent.ACTION_SCROLL: {
1345 // Handle mouse (or ext. device) by shifting the page depending on the scroll
1346 final float vscroll;
1347 final float hscroll;
1348 if ((event.getMetaState() & KeyEvent.META_SHIFT_ON) != 0) {
1349 vscroll = 0;
1350 hscroll = event.getAxisValue(MotionEvent.AXIS_VSCROLL);
1351 } else {
1352 vscroll = -event.getAxisValue(MotionEvent.AXIS_VSCROLL);
1353 hscroll = event.getAxisValue(MotionEvent.AXIS_HSCROLL);
1354 }
Sunny Goyal8b37c572020-03-31 12:12:14 -07001355 if (!canScroll(Math.abs(vscroll), Math.abs(hscroll))) {
1356 return false;
Samuel Fufa59cba192019-08-22 18:31:34 -07001357 }
Winson Chung185d7162011-02-28 13:47:29 -08001358 if (hscroll != 0 || vscroll != 0) {
Sunny Goyal70660032015-05-14 00:07:08 -07001359 boolean isForwardScroll = mIsRtl ? (hscroll < 0 || vscroll < 0)
Adam Cohen0ffac432013-07-10 11:19:26 -07001360 : (hscroll > 0 || vscroll > 0);
1361 if (isForwardScroll) {
Winson Chung185d7162011-02-28 13:47:29 -08001362 scrollRight();
1363 } else {
1364 scrollLeft();
1365 }
1366 return true;
1367 }
1368 }
1369 }
1370 }
1371 return super.onGenericMotionEvent(event);
1372 }
1373
Sunny Goyal8b37c572020-03-31 12:12:14 -07001374 /**
1375 * Returns true if the paged view can scroll for the provided vertical and horizontal
1376 * scroll values
1377 */
1378 protected boolean canScroll(float absVScroll, float absHScroll) {
1379 ActivityContext ac = ActivityContext.lookupContext(getContext());
1380 return (ac == null || AbstractFloatingView.getTopOpenView(ac) == null);
Samuel Fufa59cba192019-08-22 18:31:34 -07001381 }
1382
Michael Jurkab8f06722010-10-10 15:58:46 -07001383 private void acquireVelocityTrackerAndAddMovement(MotionEvent ev) {
1384 if (mVelocityTracker == null) {
1385 mVelocityTracker = VelocityTracker.obtain();
1386 }
1387 mVelocityTracker.addMovement(ev);
1388 }
1389
1390 private void releaseVelocityTracker() {
1391 if (mVelocityTracker != null) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001392 mVelocityTracker.clear();
Michael Jurkab8f06722010-10-10 15:58:46 -07001393 mVelocityTracker.recycle();
1394 mVelocityTracker = null;
1395 }
1396 }
1397
Winson Chung321e9ee2010-08-09 13:37:56 -07001398 private void onSecondaryPointerUp(MotionEvent ev) {
Winson Chung4941f652020-06-18 15:11:53 -07001399 final int pointerIndex = ev.getActionIndex();
Winson Chung321e9ee2010-08-09 13:37:56 -07001400 final int pointerId = ev.getPointerId(pointerIndex);
1401 if (pointerId == mActivePointerId) {
1402 // This was our active pointer going up. Choose a new
1403 // active pointer and adjust accordingly.
1404 // TODO: Make this decision more intelligent.
1405 final int newPointerIndex = pointerIndex == 0 ? 1 : 0;
Vinit Nayaka406f722019-12-19 11:50:55 -08001406 mLastMotion = mDownMotionPrimary = mOrientationHandler.getPrimaryDirection(ev,
1407 newPointerIndex);
1408 mLastMotionRemainder = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -07001409 mActivePointerId = ev.getPointerId(newPointerIndex);
1410 if (mVelocityTracker != null) {
1411 mVelocityTracker.clear();
1412 }
1413 }
Jeff Brown1d0867c2010-12-02 18:27:39 -08001414 }
1415
Winson Chung321e9ee2010-08-09 13:37:56 -07001416 @Override
1417 public void requestChildFocus(View child, View focused) {
1418 super.requestChildFocus(child, focused);
Adam Cohenae4f1552011-10-20 00:15:42 -07001419 int page = indexToPage(indexOfChild(child));
Winson Chung97d85d22011-04-13 11:27:36 -07001420 if (page >= 0 && page != getCurrentPage() && !isInTouchMode()) {
Winson Chung86f77532010-08-24 11:08:22 -07001421 snapToPage(page);
Winson Chung321e9ee2010-08-09 13:37:56 -07001422 }
1423 }
1424
Alex Chaub794ea62021-02-03 18:00:30 +00001425 public int getDestinationPage() {
1426 return getDestinationPage(mOrientationHandler.getPrimaryScroll(this));
1427 }
1428
Alex Chaudedbc8a2021-03-17 16:53:26 +00001429 protected int getDestinationPage(int primaryScroll) {
1430 return getPageNearestToCenterOfScreen(primaryScroll);
Alex Chaub794ea62021-02-03 18:00:30 +00001431 }
1432
Sunny Goyal228153d2018-01-04 15:35:22 -08001433 public int getPageNearestToCenterOfScreen() {
Vinit Nayaka406f722019-12-19 11:50:55 -08001434 return getPageNearestToCenterOfScreen(mOrientationHandler.getPrimaryScroll(this));
Tony Wickham8f7ead32016-04-07 18:46:44 -07001435 }
1436
Alex Chaudedbc8a2021-03-17 16:53:26 +00001437 private int getPageNearestToCenterOfScreen(int primaryScroll) {
1438 int screenCenter = getScreenCenter(primaryScroll);
Adam Cohen22f823d2011-09-01 17:22:18 -07001439 int minDistanceFromScreenCenter = Integer.MAX_VALUE;
Winson Chung321e9ee2010-08-09 13:37:56 -07001440 int minDistanceFromScreenCenterIndex = -1;
Winson Chung321e9ee2010-08-09 13:37:56 -07001441 final int childCount = getChildCount();
1442 for (int i = 0; i < childCount; ++i) {
Tony Wickham7383d4e2020-07-07 19:25:25 -07001443 int distanceFromScreenCenter = Math.abs(
1444 getDisplacementFromScreenCenter(i, screenCenter));
Winson Chung321e9ee2010-08-09 13:37:56 -07001445 if (distanceFromScreenCenter < minDistanceFromScreenCenter) {
1446 minDistanceFromScreenCenter = distanceFromScreenCenter;
1447 minDistanceFromScreenCenterIndex = i;
1448 }
1449 }
Adam Cohend19d3ca2010-09-15 14:43:42 -07001450 return minDistanceFromScreenCenterIndex;
1451 }
1452
Tony Wickham7383d4e2020-07-07 19:25:25 -07001453 private int getDisplacementFromScreenCenter(int childIndex, int screenCenter) {
Alex Chaudedbc8a2021-03-17 16:53:26 +00001454 int childSize = Math.round(getChildVisibleSize(childIndex));
Tony Wickham7383d4e2020-07-07 19:25:25 -07001455 int halfChildSize = (childSize / 2);
1456 int childCenter = getChildOffset(childIndex) + halfChildSize;
1457 return childCenter - screenCenter;
1458 }
1459
1460 protected int getDisplacementFromScreenCenter(int childIndex) {
Alex Chaudedbc8a2021-03-17 16:53:26 +00001461 int primaryScroll = mOrientationHandler.getPrimaryScroll(this);
1462 int screenCenter = getScreenCenter(primaryScroll);
Tony Wickham7383d4e2020-07-07 19:25:25 -07001463 return getDisplacementFromScreenCenter(childIndex, screenCenter);
1464 }
1465
Alex Chaudedbc8a2021-03-17 16:53:26 +00001466 private int getScreenCenter(int primaryScroll) {
1467 float primaryScale = mOrientationHandler.getPrimaryScale(this);
1468 float primaryPivot = mOrientationHandler.getPrimaryValue(getPivotX(), getPivotY());
1469 int pageOrientationSize = mOrientationHandler.getMeasuredSize(this);
1470 return Math.round(primaryScroll + (pageOrientationSize / 2f - primaryPivot) / primaryScale
1471 + primaryPivot);
1472 }
1473
Adam Cohend19d3ca2010-09-15 14:43:42 -07001474 protected void snapToDestination() {
Sunny Goyalc39db732021-04-03 01:20:21 -07001475 snapToPage(getDestinationPage(), PAGE_SNAP_ANIMATION_DURATION);
Winson Chung321e9ee2010-08-09 13:37:56 -07001476 }
1477
Adam Cohene0f66b52010-11-23 15:06:07 -08001478 // We want the duration of the page snap animation to be influenced by the distance that
1479 // the screen has to travel, however, we don't want this duration to be effected in a
1480 // purely linear fashion. Instead, we use this method to moderate the effect that the distance
1481 // of travel has on the overall snap duration.
Sunny Goyal4d113a52015-05-27 10:05:28 -07001482 private float distanceInfluenceForSnapDuration(float f) {
Adam Cohene0f66b52010-11-23 15:06:07 -08001483 f -= 0.5f; // center the values about 0.
1484 f *= 0.3f * Math.PI / 2.0f;
1485 return (float) Math.sin(f);
1486 }
1487
Winson Chung05a31ed2018-02-08 17:08:43 -08001488 protected boolean snapToPageWithVelocity(int whichPage, int velocity) {
Adam Cohen6f127a62014-06-12 14:54:41 -07001489 whichPage = validateNewPage(whichPage);
Vinit Nayaka406f722019-12-19 11:50:55 -08001490 int halfScreenSize = mOrientationHandler.getMeasuredSize(this) / 2;
Adam Cohene0f66b52010-11-23 15:06:07 -08001491
Vinit Nayaka406f722019-12-19 11:50:55 -08001492 final int newLoc = getScrollForPage(whichPage);
Sunny Goyalc39db732021-04-03 01:20:21 -07001493 int delta = newLoc - mOrientationHandler.getPrimaryScroll(this);
Adam Cohene0f66b52010-11-23 15:06:07 -08001494 int duration = 0;
1495
Sunny Goyal4d113a52015-05-27 10:05:28 -07001496 if (Math.abs(velocity) < mMinFlingVelocity) {
Adam Cohene0f66b52010-11-23 15:06:07 -08001497 // If the velocity is low enough, then treat this more as an automatic page advance
1498 // as opposed to an apparent physical response to flinging
Winson Chung05a31ed2018-02-08 17:08:43 -08001499 return snapToPage(whichPage, PAGE_SNAP_ANIMATION_DURATION);
Adam Cohene0f66b52010-11-23 15:06:07 -08001500 }
1501
1502 // Here we compute a "distance" that will be used in the computation of the overall
1503 // snap duration. This is a function of the actual distance that needs to be traveled;
1504 // we keep this value close to half screen size in order to reduce the variance in snap
1505 // duration as a function of the distance the page needs to travel.
Michael Jurka20b7ca92011-06-07 20:09:16 -07001506 float distanceRatio = Math.min(1f, 1.0f * Math.abs(delta) / (2 * halfScreenSize));
Adam Cohene0f66b52010-11-23 15:06:07 -08001507 float distance = halfScreenSize + halfScreenSize *
1508 distanceInfluenceForSnapDuration(distanceRatio);
1509
1510 velocity = Math.abs(velocity);
Adam Cohen265b9a62011-12-07 14:37:18 -08001511 velocity = Math.max(mMinSnapVelocity, velocity);
Adam Cohene0f66b52010-11-23 15:06:07 -08001512
1513 // we want the page's snap velocity to approximately match the velocity at which the
1514 // user flings, so we scale the duration by a value near to the derivative of the scroll
Michael Jurka20b7ca92011-06-07 20:09:16 -07001515 // interpolator at zero, ie. 5. We use 4 to make it a little slower.
1516 duration = 4 * Math.round(1000 * Math.abs(distance / velocity));
Adam Cohene0f66b52010-11-23 15:06:07 -08001517
Sunny Goyalc39db732021-04-03 01:20:21 -07001518 return snapToPage(whichPage, delta, duration);
Michael Jurka0142d492010-08-25 17:46:15 -07001519 }
1520
Winson Chung05a31ed2018-02-08 17:08:43 -08001521 public boolean snapToPage(int whichPage) {
1522 return snapToPage(whichPage, PAGE_SNAP_ANIMATION_DURATION);
Winson Chung321e9ee2010-08-09 13:37:56 -07001523 }
1524
Winson Chung05a31ed2018-02-08 17:08:43 -08001525 public boolean snapToPageImmediately(int whichPage) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001526 return snapToPage(whichPage, PAGE_SNAP_ANIMATION_DURATION, true);
Adam Cohen7d30a372013-07-01 17:03:59 -07001527 }
1528
Winson Chung05a31ed2018-02-08 17:08:43 -08001529 public boolean snapToPage(int whichPage, int duration) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001530 return snapToPage(whichPage, duration, false);
Adam Cohen7d30a372013-07-01 17:03:59 -07001531 }
1532
Sunny Goyalc39db732021-04-03 01:20:21 -07001533 protected boolean snapToPage(int whichPage, int duration, boolean immediate) {
Adam Cohen6f127a62014-06-12 14:54:41 -07001534 whichPage = validateNewPage(whichPage);
Winson Chung321e9ee2010-08-09 13:37:56 -07001535
Vinit Nayaka406f722019-12-19 11:50:55 -08001536 int newLoc = getScrollForPage(whichPage);
Sunny Goyalc39db732021-04-03 01:20:21 -07001537 final int delta = newLoc - mOrientationHandler.getPrimaryScroll(this);
1538 return snapToPage(whichPage, delta, duration, immediate);
Michael Jurka0142d492010-08-25 17:46:15 -07001539 }
1540
Winson Chung05a31ed2018-02-08 17:08:43 -08001541 protected boolean snapToPage(int whichPage, int delta, int duration) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001542 return snapToPage(whichPage, delta, duration, false);
Adam Cohen7d30a372013-07-01 17:03:59 -07001543 }
Michael Jurka0142d492010-08-25 17:46:15 -07001544
Sunny Goyalc39db732021-04-03 01:20:21 -07001545 protected boolean snapToPage(int whichPage, int delta, int duration, boolean immediate) {
Sunny Goyal9bb8ffb2018-05-24 17:11:16 -07001546 if (mFirstLayout) {
1547 setCurrentPage(whichPage);
1548 return false;
1549 }
Tony Wickhamd58c2d52018-05-04 12:10:55 -07001550
Zak Cohen3eeb41d2020-02-14 14:15:13 -08001551 if (FeatureFlags.IS_STUDIO_BUILD) {
Tony Wickhamcb3f8702018-08-27 17:36:03 -07001552 duration *= Settings.Global.getFloat(getContext().getContentResolver(),
1553 Settings.Global.WINDOW_ANIMATION_SCALE, 1);
Tony Wickhamd58c2d52018-05-04 12:10:55 -07001554 }
1555
Adam Cohen6f127a62014-06-12 14:54:41 -07001556 whichPage = validateNewPage(whichPage);
1557
Adam Cohen7d30a372013-07-01 17:03:59 -07001558 mNextPage = whichPage;
Michael Jurka0142d492010-08-25 17:46:15 -07001559
Winson Chung321e9ee2010-08-09 13:37:56 -07001560 awakenScrollBars(duration);
Adam Cohen7d30a372013-07-01 17:03:59 -07001561 if (immediate) {
1562 duration = 0;
1563 } else if (duration == 0) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001564 duration = Math.abs(delta);
1565 }
1566
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001567 if (duration != 0) {
1568 pageBeginTransition();
1569 }
1570
Adam Cohenf358a4b2013-07-23 16:47:31 -07001571 if (!mScroller.isFinished()) {
Adam Cohenf9618852013-11-08 06:45:03 -08001572 abortScrollerAnimation(false);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001573 }
Adam Cohenf9618852013-11-08 06:45:03 -08001574
Sunny Goyalc39db732021-04-03 01:20:21 -07001575 mScroller.startScroll(mOrientationHandler.getPrimaryScroll(this), 0, delta, 0, duration);
Adam Cohen674531f2013-12-13 15:07:14 -08001576 updatePageIndicator();
Adam Cohen7d30a372013-07-01 17:03:59 -07001577
1578 // Trigger a compute() to finish switching pages if necessary
1579 if (immediate) {
1580 computeScroll();
Sunny Goyal76dbf6f2017-01-03 14:55:47 -08001581 pageEndTransition();
Adam Cohen7d30a372013-07-01 17:03:59 -07001582 }
1583
Winson Chung321e9ee2010-08-09 13:37:56 -07001584 invalidate();
Winson Chung05a31ed2018-02-08 17:08:43 -08001585 return Math.abs(delta) > 0;
Winson Chung321e9ee2010-08-09 13:37:56 -07001586 }
1587
Vadim Tryshev98913d02018-05-18 18:41:34 -07001588 public boolean scrollLeft() {
1589 if (getNextPage() > 0) {
1590 snapToPage(getNextPage() - 1);
1591 return true;
1592 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001593 return mAllowOverScroll;
Winson Chung321e9ee2010-08-09 13:37:56 -07001594 }
1595
Vadim Tryshev98913d02018-05-18 18:41:34 -07001596 public boolean scrollRight() {
1597 if (getNextPage() < getChildCount() - 1) {
1598 snapToPage(getNextPage() + 1);
1599 return true;
1600 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001601 return mAllowOverScroll;
Winson Chung321e9ee2010-08-09 13:37:56 -07001602 }
1603
Vadim Trysheve6bbefb2018-04-03 13:38:06 -07001604 @Override
1605 public CharSequence getAccessibilityClassName() {
1606 // Some accessibility services have special logic for ScrollView. Since we provide same
1607 // accessibility info as ScrollView, inform the service to handle use the same way.
1608 return ScrollView.class.getName();
1609 }
1610
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001611 protected boolean isPageOrderFlipped() {
1612 return false;
1613 }
1614
Winson Chung6a0f57d2011-06-29 20:10:49 -07001615 /* Accessibility */
Sunny Goyalcf25b522015-07-09 00:01:18 -07001616 @SuppressWarnings("deprecation")
Winson Chung6a0f57d2011-06-29 20:10:49 -07001617 @Override
1618 public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) {
1619 super.onInitializeAccessibilityNodeInfo(info);
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001620 final boolean pagesFlipped = isPageOrderFlipped();
Pinyao Tingaf6daa22019-09-18 22:18:03 +00001621 int offset = (mAllowOverScroll ? 0 : 1);
1622 info.setScrollable(getPageCount() > offset);
1623 if (getCurrentPage() < getPageCount() - offset) {
yingleiw02cc8482019-08-02 16:14:27 -07001624 info.addAction(pagesFlipped ?
1625 AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_BACKWARD
1626 : AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_FORWARD);
1627 info.addAction(mIsRtl ?
1628 AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_LEFT
1629 : AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_RIGHT);
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001630 }
Pinyao Tingaf6daa22019-09-18 22:18:03 +00001631 if (getCurrentPage() >= offset) {
yingleiw02cc8482019-08-02 16:14:27 -07001632 info.addAction(pagesFlipped ?
1633 AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_FORWARD
1634 : AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_BACKWARD);
1635 info.addAction(mIsRtl ?
1636 AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_RIGHT
1637 : AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_LEFT);
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001638 }
Vadim Tryshev7af0d442015-05-15 08:48:11 -07001639 // Accessibility-wise, PagedView doesn't support long click, so disabling it.
1640 // Besides disabling the accessibility long-click, this also prevents this view from getting
1641 // accessibility focus.
1642 info.setLongClickable(false);
Sunny Goyala52ecb02016-12-16 15:04:51 -08001643 info.removeAction(AccessibilityNodeInfo.AccessibilityAction.ACTION_LONG_CLICK);
Winson Chung6a0f57d2011-06-29 20:10:49 -07001644 }
1645
1646 @Override
Alan Viverette254139a2013-10-08 13:13:46 -07001647 public void sendAccessibilityEvent(int eventType) {
1648 // Don't let the view send real scroll events.
1649 if (eventType != AccessibilityEvent.TYPE_VIEW_SCROLLED) {
1650 super.sendAccessibilityEvent(eventType);
1651 }
1652 }
1653
1654 @Override
Winson Chung6a0f57d2011-06-29 20:10:49 -07001655 public void onInitializeAccessibilityEvent(AccessibilityEvent event) {
1656 super.onInitializeAccessibilityEvent(event);
Pinyao Tingaf6daa22019-09-18 22:18:03 +00001657 event.setScrollable(mAllowOverScroll || getPageCount() > 1);
Winson Chung6a0f57d2011-06-29 20:10:49 -07001658 }
1659
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001660 @Override
1661 public boolean performAccessibilityAction(int action, Bundle arguments) {
1662 if (super.performAccessibilityAction(action, arguments)) {
1663 return true;
1664 }
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001665 final boolean pagesFlipped = isPageOrderFlipped();
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001666 switch (action) {
1667 case AccessibilityNodeInfo.ACTION_SCROLL_FORWARD: {
Vadim Tryshev98913d02018-05-18 18:41:34 -07001668 if (pagesFlipped ? scrollLeft() : scrollRight()) {
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001669 return true;
1670 }
1671 } break;
1672 case AccessibilityNodeInfo.ACTION_SCROLL_BACKWARD: {
Vadim Tryshev98913d02018-05-18 18:41:34 -07001673 if (pagesFlipped ? scrollRight() : scrollLeft()) {
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001674 return true;
1675 }
yingleiw02cc8482019-08-02 16:14:27 -07001676 } break;
1677 case android.R.id.accessibilityActionPageRight: {
1678 if (!mIsRtl) {
1679 return scrollRight();
1680 } else {
1681 return scrollLeft();
1682 }
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001683 }
yingleiw02cc8482019-08-02 16:14:27 -07001684 case android.R.id.accessibilityActionPageLeft: {
1685 if (!mIsRtl) {
1686 return scrollLeft();
1687 } else {
1688 return scrollRight();
1689 }
1690 }
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001691 }
1692 return false;
1693 }
1694
Vadim Tryshev2c430b32018-04-04 14:45:21 -07001695 protected boolean canAnnouncePageDescription() {
1696 return true;
1697 }
1698
Adam Cohen0ffac432013-07-10 11:19:26 -07001699 protected String getCurrentPageDescription() {
Sunny Goyalf4f89ef2015-09-02 15:06:12 -07001700 return getContext().getString(R.string.default_scroll_format,
Adam Cohen0ffac432013-07-10 11:19:26 -07001701 getNextPage() + 1, getChildCount());
1702 }
1703
Tony Mak2e564402018-02-27 17:19:34 +00001704 protected float getDownMotionX() {
1705 return mDownMotionX;
1706 }
1707
1708 protected float getDownMotionY() {
1709 return mDownMotionY;
1710 }
1711
Sunny Goyal20a13ff2018-03-13 16:44:00 -07001712 protected interface ComputePageScrollsLogic {
1713
1714 boolean shouldIncludeView(View view);
1715 }
Vadim Tryshev528b9e02018-05-24 18:22:03 -07001716
1717 public int[] getVisibleChildrenRange() {
1718 float visibleLeft = 0;
1719 float visibleRight = visibleLeft + getMeasuredWidth();
1720 float scaleX = getScaleX();
1721 if (scaleX < 1 && scaleX > 0) {
1722 float mid = getMeasuredWidth() / 2;
1723 visibleLeft = mid - ((mid - visibleLeft) / scaleX);
1724 visibleRight = mid + ((visibleRight - mid) / scaleX);
1725 }
1726
1727 int leftChild = -1;
1728 int rightChild = -1;
1729 final int childCount = getChildCount();
1730 for (int i = 0; i < childCount; i++) {
1731 final View child = getPageAt(i);
1732
1733 float left = child.getLeft() + child.getTranslationX() - getScrollX();
1734 if (left <= visibleRight && (left + child.getMeasuredWidth()) >= visibleLeft) {
1735 if (leftChild == -1) {
1736 leftChild = i;
1737 }
1738 rightChild = i;
1739 }
1740 }
1741 mTmpIntPair[0] = leftChild;
1742 mTmpIntPair[1] = rightChild;
1743 return mTmpIntPair;
1744 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001745
1746 @Override
1747 public void draw(Canvas canvas) {
1748 super.draw(canvas);
1749 drawEdgeEffect(canvas);
Sunny Goyal05b59c02021-04-29 13:55:40 -07001750 pageEndTransition();
Sunny Goyalc39db732021-04-03 01:20:21 -07001751 }
1752
1753 protected void drawEdgeEffect(Canvas canvas) {
1754 if (mAllowOverScroll && (!mEdgeGlowRight.isFinished() || !mEdgeGlowLeft.isFinished())) {
1755 final int width = getWidth();
1756 final int height = getHeight();
1757 if (!mEdgeGlowLeft.isFinished()) {
1758 final int restoreCount = canvas.save();
1759 canvas.rotate(-90);
1760 canvas.translate(-height, Math.min(mMinScroll, getScrollX()));
1761 mEdgeGlowLeft.setSize(height, width);
1762 if (mEdgeGlowLeft.draw(canvas)) {
1763 postInvalidateOnAnimation();
1764 }
1765 canvas.restoreToCount(restoreCount);
1766 }
1767 if (!mEdgeGlowRight.isFinished()) {
1768 final int restoreCount = canvas.save();
1769 canvas.rotate(90, width, 0);
1770 canvas.translate(width, -(Math.max(mMaxScroll, getScrollX())));
1771
1772 mEdgeGlowRight.setSize(height, width);
1773 if (mEdgeGlowRight.draw(canvas)) {
1774 postInvalidateOnAnimation();
1775 }
1776 canvas.restoreToCount(restoreCount);
1777 }
1778 }
1779 }
Adam Cohen5084cba2013-09-03 12:01:16 -07001780}