blob: 123ae6c0c3d8805789eda50ed707c1bd6b550d6c [file] [log] [blame]
Winson Chung321e9ee2010-08-09 13:37:56 -07001/*
Adam Cohen7d30a372013-07-01 17:03:59 -07002 * Copyright (C) 2012 The Android Open Source Project
Winson Chung321e9ee2010-08-09 13:37:56 -07003 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Daniel Sandler325dc232013-06-05 22:57:57 -040017package com.android.launcher3;
Winson Chung321e9ee2010-08-09 13:37:56 -070018
Andras Kloczl55edfe52021-05-14 12:21:30 +020019import static androidx.annotation.VisibleForTesting.PACKAGE_PRIVATE;
Sunny Goyalc39db732021-04-03 01:20:21 -070020import static com.android.launcher3.anim.Interpolators.SCROLL;
Sunny Goyal8b37c572020-03-31 12:12:14 -070021import static com.android.launcher3.compat.AccessibilityManagerCompat.isAccessibilityEnabled;
22import static com.android.launcher3.compat.AccessibilityManagerCompat.isObservedEventType;
Sunny Goyal8b37c572020-03-31 12:12:14 -070023import static com.android.launcher3.touch.OverScroll.OVERSCROLL_DAMP_FACTOR;
Sunny Goyal8b37c572020-03-31 12:12:14 -070024import static com.android.launcher3.touch.PagedOrientationHandler.VIEW_SCROLL_BY;
25import static com.android.launcher3.touch.PagedOrientationHandler.VIEW_SCROLL_TO;
26
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -070027import android.animation.LayoutTransition;
Sunny Goyalcf25b522015-07-09 00:01:18 -070028import android.annotation.SuppressLint;
Winson Chung321e9ee2010-08-09 13:37:56 -070029import android.content.Context;
Adam Cohen9c4949e2010-10-05 12:27:22 -070030import android.content.res.TypedArray;
Jon Miranda71cb80c2019-01-24 21:25:13 -080031import android.graphics.Canvas;
Winson Chung321e9ee2010-08-09 13:37:56 -070032import android.graphics.Rect;
Svetoslav Ganov08055f62012-05-15 11:06:36 -070033import android.os.Bundle;
Tony Wickhamd58c2d52018-05-04 12:10:55 -070034import android.provider.Settings;
Winson Chung321e9ee2010-08-09 13:37:56 -070035import android.util.AttributeSet;
Winson Chung785d2eb2011-04-14 16:08:02 -070036import android.util.Log;
Winson Chung185d7162011-02-28 13:47:29 -080037import android.view.InputDevice;
38import android.view.KeyEvent;
Winson Chung321e9ee2010-08-09 13:37:56 -070039import android.view.MotionEvent;
40import android.view.VelocityTracker;
41import android.view.View;
42import android.view.ViewConfiguration;
Sunny Goyal4ffec482016-02-09 11:28:52 -080043import android.view.ViewDebug;
Winson Chung321e9ee2010-08-09 13:37:56 -070044import android.view.ViewGroup;
45import android.view.ViewParent;
Winson Chung6a0f57d2011-06-29 20:10:49 -070046import android.view.accessibility.AccessibilityEvent;
47import android.view.accessibility.AccessibilityNodeInfo;
Sunny Goyalc39db732021-04-03 01:20:21 -070048import android.widget.OverScroller;
Vadim Trysheve6bbefb2018-04-03 13:38:06 -070049import android.widget.ScrollView;
Tony Wickhamf549dab2016-05-16 09:54:06 -070050
Tony Wickham62117d72020-03-26 16:56:26 -070051import androidx.annotation.Nullable;
Andras Kloczl55edfe52021-05-14 12:21:30 +020052import androidx.annotation.VisibleForTesting;
Tony Wickham62117d72020-03-26 16:56:26 -070053
Jon Miranda9e198662020-03-11 14:42:02 -070054import com.android.launcher3.compat.AccessibilityManagerCompat;
55import com.android.launcher3.config.FeatureFlags;
Jon Miranda9e198662020-03-11 14:42:02 -070056import com.android.launcher3.pageindicators.PageIndicator;
Jon Miranda9e198662020-03-11 14:42:02 -070057import com.android.launcher3.touch.PagedOrientationHandler;
58import com.android.launcher3.touch.PagedOrientationHandler.ChildBounds;
Sunny Goyalc39db732021-04-03 01:20:21 -070059import com.android.launcher3.util.EdgeEffectCompat;
Andras Kloczl55edfe52021-05-14 12:21:30 +020060import com.android.launcher3.util.IntSet;
Jon Miranda9e198662020-03-11 14:42:02 -070061import com.android.launcher3.util.Thunk;
Sunny Goyal8b37c572020-03-31 12:12:14 -070062import com.android.launcher3.views.ActivityContext;
Jon Miranda9e198662020-03-11 14:42:02 -070063
64import java.util.ArrayList;
Sunny Goyal59969372021-05-06 12:11:44 -070065import java.util.function.Consumer;
Jon Miranda9e198662020-03-11 14:42:02 -070066
Winson Chung321e9ee2010-08-09 13:37:56 -070067/**
68 * An abstraction of the original Workspace which supports browsing through a
Michael Jurka0142d492010-08-25 17:46:15 -070069 * sequential list of "pages"
Winson Chung321e9ee2010-08-09 13:37:56 -070070 */
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -080071public abstract class PagedView<T extends View & PageIndicator> extends ViewGroup {
Winson Chung321e9ee2010-08-09 13:37:56 -070072 private static final String TAG = "PagedView";
Winson Chung785d2eb2011-04-14 16:08:02 -070073 private static final boolean DEBUG = false;
Winson Chung4941f652020-06-18 15:11:53 -070074 public static final boolean DEBUG_FAILED_QUICKSWITCH = false;
Sunny Goyal20a13ff2018-03-13 16:44:00 -070075
Winson Chung4941f652020-06-18 15:11:53 -070076 public static final int ACTION_MOVE_ALLOW_EASY_FLING = MotionEvent.ACTION_MASK - 1;
Sunny Goyala7a5bf32020-01-05 15:35:29 +053077 public static final int INVALID_PAGE = -1;
Sunny Goyal20a13ff2018-03-13 16:44:00 -070078 protected static final ComputePageScrollsLogic SIMPLE_SCROLL_LOGIC = (v) -> v.getVisibility() != GONE;
Winson Chung321e9ee2010-08-09 13:37:56 -070079
Vadim Tryshevfedca432015-08-19 17:55:02 -070080 public static final int PAGE_SNAP_ANIMATION_DURATION = 750;
Winson Chung321e9ee2010-08-09 13:37:56 -070081
Adam Cohenb64cb5a2011-02-15 13:53:42 -080082 private static final float RETURN_TO_ORIGINAL_PAGE_THRESHOLD = 0.33f;
Adam Cohen00481b32011-11-18 12:03:48 -080083 // The page is moved more than halfway, automatically move to the next page on touch up.
84 private static final float SIGNIFICANT_MOVE_THRESHOLD = 0.4f;
Adam Cohen68d73932010-11-15 10:50:58 -080085
Sunny Goyal8e2133b2015-05-06 13:39:07 -070086 private static final float MAX_SCROLL_PROGRESS = 1.0f;
87
Adam Cohen265b9a62011-12-07 14:37:18 -080088 // The following constants need to be scaled based on density. The scaled versions will be
89 // assigned to the corresponding member variables below.
90 private static final int FLING_THRESHOLD_VELOCITY = 500;
Winson Chung4941f652020-06-18 15:11:53 -070091 private static final int EASY_FLING_THRESHOLD_VELOCITY = 400;
Adam Cohen265b9a62011-12-07 14:37:18 -080092 private static final int MIN_SNAP_VELOCITY = 1500;
93 private static final int MIN_FLING_VELOCITY = 250;
94
Adam Cohenf358a4b2013-07-23 16:47:31 -070095 private boolean mFreeScroll = false;
Adam Cohenf358a4b2013-07-23 16:47:31 -070096
Winson Chung4941f652020-06-18 15:11:53 -070097 protected final int mFlingThresholdVelocity;
98 protected final int mEasyFlingThresholdVelocity;
99 protected final int mMinFlingVelocity;
100 protected final int mMinSnapVelocity;
Michael Jurka0142d492010-08-25 17:46:15 -0700101
Michael Jurka0142d492010-08-25 17:46:15 -0700102 protected boolean mFirstLayout = true;
103
Sunny Goyal4ffec482016-02-09 11:28:52 -0800104 @ViewDebug.ExportedProperty(category = "launcher")
Michael Jurka0142d492010-08-25 17:46:15 -0700105 protected int mCurrentPage;
Adam Cohene61a9a22013-06-11 15:45:31 -0700106
Sunny Goyal4ffec482016-02-09 11:28:52 -0800107 @ViewDebug.ExportedProperty(category = "launcher")
Michael Jurka0142d492010-08-25 17:46:15 -0700108 protected int mNextPage = INVALID_PAGE;
Vinit Nayaka406f722019-12-19 11:50:55 -0800109 protected int mMaxScroll;
110 protected int mMinScroll;
Sunny Goyalb7b01352018-08-09 12:31:20 -0700111 protected OverScroller mScroller;
Winson Chung321e9ee2010-08-09 13:37:56 -0700112 private VelocityTracker mVelocityTracker;
Sunny Goyale15e2a82017-12-15 13:05:42 -0800113 protected int mPageSpacing = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -0700114
115 private float mDownMotionX;
Adam Cohen7d30a372013-07-01 17:03:59 -0700116 private float mDownMotionY;
Vinit Nayaka406f722019-12-19 11:50:55 -0800117 private float mDownMotionPrimary;
118 private float mLastMotion;
119 private float mLastMotionRemainder;
120 private float mTotalMotion;
Winson Chung4941f652020-06-18 15:11:53 -0700121 // Used in special cases where the fling checks can be relaxed for an intentional gesture
122 private boolean mAllowEasyFling;
Sunny Goyalacd17df2020-04-03 15:58:45 -0700123 protected PagedOrientationHandler mOrientationHandler = PagedOrientationHandler.PORTRAIT;
Adam Cohenedb40762013-07-18 16:45:45 -0700124
Vadim Trysheve628c472018-05-16 14:28:18 -0700125 protected int[] mPageScrolls;
Sunny Goyalaad33592018-08-07 17:20:35 -0700126 private boolean mIsBeingDragged;
Adam Cohencae7f572013-11-04 14:42:52 -0800127
Winson Chung4941f652020-06-18 15:11:53 -0700128 // The amount of movement to begin scrolling
Michael Jurka7426c422010-11-11 15:23:47 -0800129 protected int mTouchSlop;
Winson Chung4941f652020-06-18 15:11:53 -0700130 // The amount of movement to begin paging
131 protected int mPageSlop;
Winson Chung321e9ee2010-08-09 13:37:56 -0700132 private int mMaximumVelocity;
Adam Cohen68d73932010-11-15 10:50:58 -0800133 protected boolean mAllowOverScroll = true;
Winson Chung321e9ee2010-08-09 13:37:56 -0700134
Michael Jurka5f1c5092010-09-03 14:15:02 -0700135 protected static final int INVALID_POINTER = -1;
Winson Chung321e9ee2010-08-09 13:37:56 -0700136
Michael Jurka5f1c5092010-09-03 14:15:02 -0700137 protected int mActivePointerId = INVALID_POINTER;
Winson Chung321e9ee2010-08-09 13:37:56 -0700138
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700139 protected boolean mIsPageInTransition = false;
Tony Wickham62117d72020-03-26 16:56:26 -0700140 private Runnable mOnPageTransitionEndCallback;
Patrick Dubroy1262e362010-10-06 15:49:50 -0700141
Winson Chungd2be3812013-07-16 11:11:32 -0700142 // Page Indicator
Adam Cohen091440a2015-03-18 14:16:05 -0700143 @Thunk int mPageIndicatorViewId;
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800144 protected T mPageIndicator;
Adam Cohen7d30a372013-07-01 17:03:59 -0700145
John Spurlock77e1f472013-09-11 10:09:51 -0400146 protected final Rect mInsets = new Rect();
Tony Wickhamdfb5cc92018-02-26 16:41:57 -0800147 protected boolean mIsRtl;
John Spurlock77e1f472013-09-11 10:09:51 -0400148
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800149 // Similar to the platform implementation of isLayoutValid();
150 protected boolean mIsLayoutValid;
151
Vadim Tryshev528b9e02018-05-24 18:22:03 -0700152 private int[] mTmpIntPair = new int[2];
153
Sunny Goyalc39db732021-04-03 01:20:21 -0700154 protected EdgeEffectCompat mEdgeGlowLeft;
155 protected EdgeEffectCompat mEdgeGlowRight;
156
Winson Chung321e9ee2010-08-09 13:37:56 -0700157 public PagedView(Context context) {
158 this(context, null);
159 }
160
161 public PagedView(Context context, AttributeSet attrs) {
162 this(context, attrs, 0);
163 }
164
165 public PagedView(Context context, AttributeSet attrs, int defStyle) {
166 super(context, attrs, defStyle);
Winson Chungc9ca2982013-07-19 12:07:38 -0700167
Adam Cohen9c4949e2010-10-05 12:27:22 -0700168 TypedArray a = context.obtainStyledAttributes(attrs,
169 R.styleable.PagedView, defStyle, 0);
Winson Chungd2be3812013-07-16 11:11:32 -0700170 mPageIndicatorViewId = a.getResourceId(R.styleable.PagedView_pageIndicator, -1);
Adam Cohen9c4949e2010-10-05 12:27:22 -0700171 a.recycle();
172
Winson Chung321e9ee2010-08-09 13:37:56 -0700173 setHapticFeedbackEnabled(false);
Sunny Goyal70660032015-05-14 00:07:08 -0700174 mIsRtl = Utilities.isRtl(getResources());
Winson Chung321e9ee2010-08-09 13:37:56 -0700175
Sunny Goyalc39db732021-04-03 01:20:21 -0700176 mScroller = new OverScroller(context, SCROLL);
Winson Chung86f77532010-08-24 11:08:22 -0700177 mCurrentPage = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -0700178
Vinit Nayaka406f722019-12-19 11:50:55 -0800179 final ViewConfiguration configuration = ViewConfiguration.get(context);
Winson Chung4941f652020-06-18 15:11:53 -0700180 mTouchSlop = configuration.getScaledTouchSlop();
181 mPageSlop = configuration.getScaledPagingTouchSlop();
Winson Chung321e9ee2010-08-09 13:37:56 -0700182 mMaximumVelocity = configuration.getScaledMaximumFlingVelocity();
Adam Cohen265b9a62011-12-07 14:37:18 -0800183
Sunny Goyalcf25b522015-07-09 00:01:18 -0700184 float density = getResources().getDisplayMetrics().density;
185 mFlingThresholdVelocity = (int) (FLING_THRESHOLD_VELOCITY * density);
Winson Chung4941f652020-06-18 15:11:53 -0700186 mEasyFlingThresholdVelocity = (int) (EASY_FLING_THRESHOLD_VELOCITY * density);
Sunny Goyalcf25b522015-07-09 00:01:18 -0700187 mMinFlingVelocity = (int) (MIN_FLING_VELOCITY * density);
188 mMinSnapVelocity = (int) (MIN_SNAP_VELOCITY * density);
Sunny Goyala9f55462018-03-25 18:15:15 -0700189
Sunny Goyalc39db732021-04-03 01:20:21 -0700190 initEdgeEffect();
Sunny Goyaleaf7a952020-07-29 16:54:20 -0700191 setDefaultFocusHighlightEnabled(false);
Sunny Goyalc39db732021-04-03 01:20:21 -0700192 setWillNotDraw(false);
Winson Chung321e9ee2010-08-09 13:37:56 -0700193 }
194
Sunny Goyalc39db732021-04-03 01:20:21 -0700195 protected void initEdgeEffect() {
196 mEdgeGlowLeft = new EdgeEffectCompat(getContext());
197 mEdgeGlowRight = new EdgeEffectCompat(getContext());
Adam Cohenf9618852013-11-08 06:45:03 -0800198 }
199
Sunny Goyald0a6ae72016-06-16 12:29:03 -0700200 public void initParentViews(View parent) {
201 if (mPageIndicatorViewId > -1) {
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800202 mPageIndicator = parent.findViewById(mPageIndicatorViewId);
Sunny Goyalc64cfdd2016-05-18 14:12:02 -0700203 mPageIndicator.setMarkersCount(getChildCount());
Winson Chungd2be3812013-07-16 11:11:32 -0700204 }
205 }
206
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800207 public T getPageIndicator() {
Adam Cohenedb40762013-07-18 16:45:45 -0700208 return mPageIndicator;
209 }
210
Adam Cohen674531f2013-12-13 15:07:14 -0800211 /**
Tony Wickham29d853c2015-09-08 10:35:56 -0700212 * Returns the index of the currently displayed page. When in free scroll mode, this is the page
213 * that the user was on before entering free scroll mode (e.g. the home screen page they
Alex Chaub794ea62021-02-03 18:00:30 +0000214 * long-pressed on to enter the overview). Try using {@link #getDestinationPage()}
Tony Wickham29d853c2015-09-08 10:35:56 -0700215 * to get the page the user is currently scrolling over.
Winson Chung321e9ee2010-08-09 13:37:56 -0700216 */
Sunny Goyal83a8f042015-05-19 12:52:12 -0700217 public int getCurrentPage() {
Winson Chung86f77532010-08-24 11:08:22 -0700218 return mCurrentPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700219 }
Adam Cohen7d30a372013-07-01 17:03:59 -0700220
Hyunyoung Songb76cd622015-04-16 14:34:09 -0700221 /**
222 * Returns the index of page to be shown immediately afterwards.
223 */
Vadim Tryshevfedca432015-08-19 17:55:02 -0700224 public int getNextPage() {
Winson Chung360e63f2012-04-27 13:48:05 -0700225 return (mNextPage != INVALID_PAGE) ? mNextPage : mCurrentPage;
226 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700227
Adam Cohenf9c184a2016-01-15 16:47:43 -0800228 public int getPageCount() {
Winson Chung321e9ee2010-08-09 13:37:56 -0700229 return getChildCount();
230 }
231
Sunny Goyal83a8f042015-05-19 12:52:12 -0700232 public View getPageAt(int index) {
Winson Chung321e9ee2010-08-09 13:37:56 -0700233 return getChildAt(index);
234 }
235
Adam Cohenae4f1552011-10-20 00:15:42 -0700236 protected int indexToPage(int index) {
237 return index;
238 }
239
Winson Chung321e9ee2010-08-09 13:37:56 -0700240 /**
Winson Chungbbc60d82010-11-11 16:34:41 -0800241 * Updates the scroll of the current page immediately to its final scroll position. We use this
242 * in CustomizePagedView to allow tabs to share the same PagedView while resetting the scroll of
243 * the previous tab page.
244 */
245 protected void updateCurrentPageScroll() {
Adam Cohen0ffac432013-07-10 11:19:26 -0700246 // If the current page is invalid, just reset the scroll position to zero
Vinit Nayaka406f722019-12-19 11:50:55 -0800247 int newPosition = 0;
Adam Cohen0ffac432013-07-10 11:19:26 -0700248 if (0 <= mCurrentPage && mCurrentPage < getPageCount()) {
Vinit Nayaka406f722019-12-19 11:50:55 -0800249 newPosition = getScrollForPage(mCurrentPage);
Adam Cohen0ffac432013-07-10 11:19:26 -0700250 }
Vinit Nayaka406f722019-12-19 11:50:55 -0800251 mOrientationHandler.set(this, VIEW_SCROLL_TO, newPosition);
Sunny Goyalc39db732021-04-03 01:20:21 -0700252 mScroller.startScroll(mScroller.getCurrX(), 0, newPosition - mScroller.getCurrX(), 0);
Sunny Goyalc82c6392018-06-06 15:39:13 -0700253 forceFinishScroller(true);
Winson Chungbbc60d82010-11-11 16:34:41 -0800254 }
255
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700256 private void abortScrollerAnimation(boolean resetNextPage) {
Adam Cohen4fe4c932013-10-28 16:02:34 -0700257 mScroller.abortAnimation();
258 // We need to clean up the next page here to avoid computeScrollHelper from
259 // updating current page on the pass.
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700260 if (resetNextPage) {
261 mNextPage = INVALID_PAGE;
Sunny Goyal857b1b92018-03-05 10:49:05 -0800262 pageEndTransition();
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700263 }
Chet Haasebc2f0822012-10-26 17:59:53 -0700264 }
Adam Cohen4fe4c932013-10-28 16:02:34 -0700265
Tony Wickham8f7ead32016-04-07 18:46:44 -0700266 private void forceFinishScroller(boolean resetNextPage) {
Adam Cohen4fe4c932013-10-28 16:02:34 -0700267 mScroller.forceFinished(true);
268 // We need to clean up the next page here to avoid computeScrollHelper from
269 // updating current page on the pass.
Tony Wickham8f7ead32016-04-07 18:46:44 -0700270 if (resetNextPage) {
271 mNextPage = INVALID_PAGE;
Sunny Goyal857b1b92018-03-05 10:49:05 -0800272 pageEndTransition();
Tony Wickham8f7ead32016-04-07 18:46:44 -0700273 }
Adam Cohen4fe4c932013-10-28 16:02:34 -0700274 }
275
Adam Cohen6f127a62014-06-12 14:54:41 -0700276 private int validateNewPage(int newPage) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700277 newPage = ensureWithinScrollBounds(newPage);
Adam Cohen6f127a62014-06-12 14:54:41 -0700278 // Ensure that it is clamped by the actual set of children in all cases
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100279 newPage = Utilities.boundToRange(newPage, 0, getPageCount() - 1);
280
281 if (getPanelCount() > 1) {
282 // Always return left panel as new page
283 newPage = getLeftmostVisiblePageForIndex(newPage);
284 }
285 return newPage;
286 }
287
Andras Kloczl55edfe52021-05-14 12:21:30 +0200288 /**
289 * In most cases where panelCount is 1, this method will just return the page index that was
290 * passed in.
291 * But for example when two panel home is enabled we might need the leftmost visible page index
292 * because that page is the current page.
293 */
294 public int getLeftmostVisiblePageForIndex(int pageIndex) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100295 int panelCount = getPanelCount();
Andras Kloczl55edfe52021-05-14 12:21:30 +0200296 return pageIndex - pageIndex % panelCount;
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100297 }
298
299 /**
300 * Returns the number of pages that are shown at the same time.
301 */
302 protected int getPanelCount() {
303 return 1;
304 }
305
306 /**
Andras Kloczl55edfe52021-05-14 12:21:30 +0200307 * Returns an IntSet with the indices of the currently visible pages
308 */
309 @VisibleForTesting(otherwise = PACKAGE_PRIVATE)
310 public IntSet getVisiblePageIndices() {
311 IntSet visiblePageIndices = new IntSet();
312 int panelCount = getPanelCount();
313 int pageCount = getPageCount();
314
315 // If a device goes from one panel to two panel (i.e. unfolding a foldable device) while
316 // an odd indexed page is the current page, then the new leftmost visible page will be
317 // different from the old mCurrentPage.
318 int currentPage = getLeftmostVisiblePageForIndex(mCurrentPage);
319 for (int page = currentPage; page < currentPage + panelCount && page < pageCount; page++) {
320 visiblePageIndices.add(page);
321 }
322 return visiblePageIndices;
323 }
324
325 /**
Sunny Goyal59969372021-05-06 12:11:44 -0700326 * Executes the callback against each visible page
Andras Kloczl2bb51342021-03-20 01:13:45 +0100327 */
Sunny Goyal59969372021-05-06 12:11:44 -0700328 public void forEachVisiblePage(Consumer<View> callback) {
Andras Kloczl55edfe52021-05-14 12:21:30 +0200329 getVisiblePageIndices().forEach(pageIndex -> {
330 View page = getPageAt(pageIndex);
Andras Kloczl2bb51342021-03-20 01:13:45 +0100331 if (page != null) {
Sunny Goyal59969372021-05-06 12:11:44 -0700332 callback.accept(page);
Andras Kloczl2bb51342021-03-20 01:13:45 +0100333 }
Andras Kloczl55edfe52021-05-14 12:21:30 +0200334 });
Andras Kloczl2bb51342021-03-20 01:13:45 +0100335 }
336
337 /**
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100338 * Returns true if the view is on one of the current pages, false otherwise.
339 */
340 public boolean isVisible(View child) {
341 return getLeftmostVisiblePageForIndex(indexOfChild(child)) == mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700342 }
343
Chet Haasebc2f0822012-10-26 17:59:53 -0700344 /**
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700345 * @return The closest page to the provided page that is within mMinScrollX and mMaxScrollX.
346 */
347 private int ensureWithinScrollBounds(int page) {
348 int dir = !mIsRtl ? 1 : - 1;
349 int currScroll = getScrollForPage(page);
350 int prevScroll;
Vinit Nayaka406f722019-12-19 11:50:55 -0800351 while (currScroll < mMinScroll) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700352 page += dir;
353 prevScroll = currScroll;
354 currScroll = getScrollForPage(page);
355 if (currScroll <= prevScroll) {
356 Log.e(TAG, "validateNewPage: failed to find a page > mMinScrollX");
357 break;
358 }
359 }
Vinit Nayaka406f722019-12-19 11:50:55 -0800360 while (currScroll > mMaxScroll) {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700361 page -= dir;
362 prevScroll = currScroll;
363 currScroll = getScrollForPage(page);
364 if (currScroll >= prevScroll) {
365 Log.e(TAG, "validateNewPage: failed to find a page < mMaxScrollX");
366 break;
367 }
368 }
369 return page;
370 }
371
Tony Wickham03f27012019-04-25 14:22:54 -0700372 public void setCurrentPage(int currentPage) {
373 setCurrentPage(currentPage, INVALID_PAGE);
374 }
375
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700376 /**
Winson Chung86f77532010-08-24 11:08:22 -0700377 * Sets the current page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700378 */
Tony Wickham03f27012019-04-25 14:22:54 -0700379 public void setCurrentPage(int currentPage, int overridePrevPage) {
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800380 if (!mScroller.isFinished()) {
Adam Cohen8bdbaab2013-10-29 15:25:02 -0700381 abortScrollerAnimation(true);
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800382 }
Michael Jurkad3ef3062010-11-23 16:23:58 -0800383 // don't introduce any checks like mCurrentPage == currentPage here-- if we change the
384 // the default
385 if (getChildCount() == 0) {
Patrick Dubroy72e0d342010-11-09 15:23:28 -0800386 return;
387 }
Tony Wickham03f27012019-04-25 14:22:54 -0700388 int prevPage = overridePrevPage != INVALID_PAGE ? overridePrevPage : mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700389 mCurrentPage = validateNewPage(currentPage);
Winson Chung181c3dc2013-07-17 15:36:20 -0700390 updateCurrentPageScroll();
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700391 notifyPageSwitchListener(prevPage);
Winson Chunga12a2502010-12-20 14:41:35 -0800392 invalidate();
Winson Chung321e9ee2010-08-09 13:37:56 -0700393 }
394
Winson Chung8c87cd82013-07-23 16:20:10 -0700395 /**
Adam Cohen674531f2013-12-13 15:07:14 -0800396 * Should be called whenever the page changes. In the case of a scroll, we wait until the page
397 * has settled.
398 */
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700399 protected void notifyPageSwitchListener(int prevPage) {
Adam Cohen674531f2013-12-13 15:07:14 -0800400 updatePageIndicator();
401 }
402
403 private void updatePageIndicator() {
Sunny Goyal4cbf0462014-08-28 16:19:39 -0700404 if (mPageIndicator != null) {
Tony Mak4f521af2018-03-15 16:37:34 +0000405 mPageIndicator.setActiveMarker(getNextPage());
Winson Chungd2be3812013-07-16 11:11:32 -0700406 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700407 }
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700408 protected void pageBeginTransition() {
409 if (!mIsPageInTransition) {
410 mIsPageInTransition = true;
411 onPageBeginTransition();
Michael Jurkad74c9842011-07-10 12:44:21 -0700412 }
Patrick Dubroy1262e362010-10-06 15:49:50 -0700413 }
414
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700415 protected void pageEndTransition() {
Sunny Goyal05b59c02021-04-29 13:55:40 -0700416 if (mIsPageInTransition && !mIsBeingDragged && mScroller.isFinished()
Sunny Goyalb745a2a2021-04-30 13:38:22 -0700417 && (!isShown() || (mEdgeGlowLeft.isFinished() && mEdgeGlowRight.isFinished()))) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700418 mIsPageInTransition = false;
419 onPageEndTransition();
Michael Jurkad74c9842011-07-10 12:44:21 -0700420 }
Michael Jurka0142d492010-08-25 17:46:15 -0700421 }
422
Sunny Goyalb745a2a2021-04-30 13:38:22 -0700423 @Override
424 public void onVisibilityAggregated(boolean isVisible) {
425 pageEndTransition();
426 super.onVisibilityAggregated(isVisible);
427 }
428
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700429 protected boolean isPageInTransition() {
430 return mIsPageInTransition;
Adam Cohen26976d92011-03-22 15:33:33 -0700431 }
432
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700433 /**
434 * Called when the page starts moving as part of the scroll. Subclasses can override this
435 * to provide custom behavior during animation.
436 */
437 protected void onPageBeginTransition() {
Patrick Dubroy1262e362010-10-06 15:49:50 -0700438 }
439
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700440 /**
441 * Called when the page ends moving as part of the scroll. Subclasses can override this
442 * to provide custom behavior during animation.
443 */
444 protected void onPageEndTransition() {
vadimt4d93df52019-07-10 17:32:58 -0700445 AccessibilityManagerCompat.sendScrollFinishedEventToTest(getContext());
Tony Wickham619daaf2020-02-07 12:29:06 -0800446 AccessibilityManagerCompat.sendCustomAccessibilityEvent(getPageAt(mCurrentPage),
447 AccessibilityEvent.TYPE_VIEW_FOCUSED, null);
Tony Wickham62117d72020-03-26 16:56:26 -0700448 if (mOnPageTransitionEndCallback != null) {
449 mOnPageTransitionEndCallback.run();
450 mOnPageTransitionEndCallback = null;
451 }
452 }
453
454 /**
455 * Sets a callback to run once when the scrolling finishes. If there is currently
456 * no page in transition, then the callback is called immediately.
457 */
458 public void setOnPageTransitionEndCallback(@Nullable Runnable callback) {
459 if (mIsPageInTransition || callback == null) {
460 mOnPageTransitionEndCallback = callback;
461 } else {
462 callback.run();
463 }
Michael Jurka0142d492010-08-25 17:46:15 -0700464 }
465
Adam Cohen68d73932010-11-15 10:50:58 -0800466 @Override
Michael Jurka0142d492010-08-25 17:46:15 -0700467 public void scrollTo(int x, int y) {
Sunny Goyalc39db732021-04-03 01:20:21 -0700468 x = Utilities.boundToRange(x,
469 mOrientationHandler.getPrimaryValue(mMinScroll, 0), mMaxScroll);
470 y = Utilities.boundToRange(y,
471 mOrientationHandler.getPrimaryValue(0, mMinScroll), mMaxScroll);
Vinit Nayaka406f722019-12-19 11:50:55 -0800472 super.scrollTo(x, y);
Michael Jurka0142d492010-08-25 17:46:15 -0700473 }
474
Adam Cohen53805212013-10-01 10:39:23 -0700475 private void sendScrollAccessibilityEvent() {
Sunny Goyald0030b02017-12-08 15:07:24 -0800476 if (isObservedEventType(getContext(), AccessibilityEvent.TYPE_VIEW_SCROLLED)) {
Vadim Tryshevf4715972015-05-08 17:21:03 -0700477 if (mCurrentPage != getNextPage()) {
478 AccessibilityEvent ev =
479 AccessibilityEvent.obtain(AccessibilityEvent.TYPE_VIEW_SCROLLED);
Vadim Tryshev7066c122015-05-21 14:06:35 -0700480 ev.setScrollable(true);
481 ev.setScrollX(getScrollX());
482 ev.setScrollY(getScrollY());
Vinit Nayaka406f722019-12-19 11:50:55 -0800483 mOrientationHandler.setMaxScroll(ev, mMaxScroll);
Vadim Tryshevf4715972015-05-08 17:21:03 -0700484 sendAccessibilityEventUnchecked(ev);
Adam Cohen53805212013-10-01 10:39:23 -0700485 }
Adam Cohen53805212013-10-01 10:39:23 -0700486 }
487 }
488
Vadim Tryshev2c430b32018-04-04 14:45:21 -0700489 protected void announcePageForAccessibility() {
490 if (isAccessibilityEnabled(getContext())) {
491 // Notify the user when the page changes
492 announceForAccessibility(getCurrentPageDescription());
493 }
494 }
495
Winson Chung85425412021-05-10 16:24:14 -0700496 protected boolean computeScrollHelper() {
Winson Chung321e9ee2010-08-09 13:37:56 -0700497 if (mScroller.computeScrollOffset()) {
Winson Chung557d6ed2011-07-08 15:34:52 -0700498 // Don't bother scrolling if the page does not need to be moved
Sunny Goyalc39db732021-04-03 01:20:21 -0700499 int oldPos = mOrientationHandler.getPrimaryScroll(this);
500 int newPos = mScroller.getCurrX();
501 if (oldPos != newPos) {
502 mOrientationHandler.set(this, VIEW_SCROLL_TO, mScroller.getCurrX());
Winson Chung557d6ed2011-07-08 15:34:52 -0700503 }
Winson Chung85425412021-05-10 16:24:14 -0700504
505 if (mAllowOverScroll) {
506 if (newPos < mMinScroll && oldPos >= mMinScroll) {
507 mEdgeGlowLeft.onAbsorb((int) mScroller.getCurrVelocity());
508 mScroller.abortAnimation();
509 } else if (newPos > mMaxScroll && oldPos <= mMaxScroll) {
510 mEdgeGlowRight.onAbsorb((int) mScroller.getCurrVelocity());
511 mScroller.abortAnimation();
Sunny Goyalc39db732021-04-03 01:20:21 -0700512 }
Tony Wickham95cdb3a2016-02-18 14:37:07 -0800513 }
Adam Cohen53805212013-10-01 10:39:23 -0700514
Winson Chung85425412021-05-10 16:24:14 -0700515 // If the scroller has scrolled to the final position and there is no edge effect, then
516 // finish the scroller to skip waiting for additional settling
517 int finalPos = mOrientationHandler.getPrimaryValue(mScroller.getFinalX(),
518 mScroller.getFinalY());
519 if (newPos == finalPos && mEdgeGlowLeft.isFinished() && mEdgeGlowRight.isFinished()) {
520 mScroller.abortAnimation();
521 }
522
523 invalidate();
524 return true;
525 } else if (mNextPage != INVALID_PAGE) {
526 sendScrollAccessibilityEvent();
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700527 int prevPage = mCurrentPage;
Adam Cohen6f127a62014-06-12 14:54:41 -0700528 mCurrentPage = validateNewPage(mNextPage);
Winson Chung86f77532010-08-24 11:08:22 -0700529 mNextPage = INVALID_PAGE;
Hyunyoung Song3f5a11f2017-06-29 16:42:04 -0700530 notifyPageSwitchListener(prevPage);
Winson Chungb44b5242011-06-13 11:32:14 -0700531
Adam Cohen73aa9752010-11-24 16:26:58 -0800532 // We don't want to trigger a page end moving unless the page has settled
533 // and the user has stopped scrolling
Sunny Goyalaad33592018-08-07 17:20:35 -0700534 if (!mIsBeingDragged) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -0700535 pageEndTransition();
Adam Cohen73aa9752010-11-24 16:26:58 -0800536 }
Winson Chungc27d1bb2011-09-29 12:07:42 -0700537
Vadim Tryshev2c430b32018-04-04 14:45:21 -0700538 if (canAnnouncePageDescription()) {
539 announcePageForAccessibility();
Adam Cohen0ffac432013-07-10 11:19:26 -0700540 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700541 }
Michael Jurka0142d492010-08-25 17:46:15 -0700542 return false;
543 }
544
545 @Override
546 public void computeScroll() {
547 computeScrollHelper();
Winson Chung321e9ee2010-08-09 13:37:56 -0700548 }
549
Sunny Goyalce8809a2018-01-18 14:02:47 -0800550 public int getExpectedHeight() {
551 return getMeasuredHeight();
552 }
553
Adam Cohen410f3cd2013-09-22 12:09:32 -0700554 public int getNormalChildHeight() {
Sunny Goyalce8809a2018-01-18 14:02:47 -0800555 return getExpectedHeight() - getPaddingTop() - getPaddingBottom()
Sunny Goyalac00cba2017-11-13 15:58:01 -0800556 - mInsets.top - mInsets.bottom;
Adam Cohen410f3cd2013-09-22 12:09:32 -0700557 }
558
Sunny Goyalce8809a2018-01-18 14:02:47 -0800559 public int getExpectedWidth() {
560 return getMeasuredWidth();
561 }
562
Sunny Goyalbc683e92017-12-06 10:25:07 -0800563 public int getNormalChildWidth() {
Sunny Goyalce8809a2018-01-18 14:02:47 -0800564 return getExpectedWidth() - getPaddingLeft() - getPaddingRight()
Sunny Goyalbc683e92017-12-06 10:25:07 -0800565 - mInsets.left - mInsets.right;
566 }
567
Winson Chung321e9ee2010-08-09 13:37:56 -0700568 @Override
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800569 public void requestLayout() {
570 mIsLayoutValid = false;
571 super.requestLayout();
572 }
573
574 @Override
575 public void forceLayout() {
576 mIsLayoutValid = false;
577 super.forceLayout();
578 }
579
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100580 private int getPageWidthSize(int widthSize) {
581 return (widthSize - mInsets.left - mInsets.right) / getPanelCount();
582 }
583
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800584 @Override
Winson Chung321e9ee2010-08-09 13:37:56 -0700585 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
Sunny Goyal8e2133b2015-05-06 13:39:07 -0700586 if (getChildCount() == 0) {
Winson Chungf0ea4d32011-06-06 14:27:16 -0700587 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
588 return;
589 }
590
Adam Cohen7d30a372013-07-01 17:03:59 -0700591 // We measure the dimensions of the PagedView to be larger than the pages so that when we
592 // zoom out (and scale down), the view is still contained in the parent
Adam Cohen7d30a372013-07-01 17:03:59 -0700593 int widthMode = MeasureSpec.getMode(widthMeasureSpec);
594 int widthSize = MeasureSpec.getSize(widthMeasureSpec);
595 int heightMode = MeasureSpec.getMode(heightMeasureSpec);
Winson Chung8aad6102012-05-11 16:27:49 -0700596 int heightSize = MeasureSpec.getSize(heightMeasureSpec);
Adam Cohen410f3cd2013-09-22 12:09:32 -0700597
Adam Cohen7d30a372013-07-01 17:03:59 -0700598 if (widthMode == MeasureSpec.UNSPECIFIED || heightMode == MeasureSpec.UNSPECIFIED) {
599 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
600 return;
Winson Chung321e9ee2010-08-09 13:37:56 -0700601 }
602
Winson Chung8aad6102012-05-11 16:27:49 -0700603 // Return early if we aren't given a proper dimension
604 if (widthSize <= 0 || heightSize <= 0) {
605 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
606 return;
607 }
608
Winson Chung321e9ee2010-08-09 13:37:56 -0700609 // The children are given the same width and height as the workspace
Michael Jurka5f1c5092010-09-03 14:15:02 -0700610 // unless they were set to WRAP_CONTENT
Winson Chung785d2eb2011-04-14 16:08:02 -0700611 if (DEBUG) Log.d(TAG, "PagedView.onMeasure(): " + widthSize + ", " + heightSize);
Michael Jurka5f1c5092010-09-03 14:15:02 -0700612
Sunny Goyalac00cba2017-11-13 15:58:01 -0800613 int myWidthSpec = MeasureSpec.makeMeasureSpec(
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100614 getPageWidthSize(widthSize), MeasureSpec.EXACTLY);
Sunny Goyalac00cba2017-11-13 15:58:01 -0800615 int myHeightSpec = MeasureSpec.makeMeasureSpec(
Sunny Goyal228153d2018-01-04 15:35:22 -0800616 heightSize - mInsets.top - mInsets.bottom, MeasureSpec.EXACTLY);
Adam Cohen96d30a12013-07-16 18:13:21 -0700617
Sunny Goyalac00cba2017-11-13 15:58:01 -0800618 // measureChildren takes accounts for content padding, we only need to care about extra
619 // space due to insets.
620 measureChildren(myWidthSpec, myHeightSpec);
621 setMeasuredDimension(widthSize, heightSize);
Adam Cohen60b07122011-11-14 17:26:06 -0800622 }
623
Sunny Goyalcf25b522015-07-09 00:01:18 -0700624 @SuppressLint("DrawAllocation")
Winson Chung321e9ee2010-08-09 13:37:56 -0700625 @Override
Michael Jurka28750fb2010-09-24 17:43:49 -0700626 protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800627 mIsLayoutValid = true;
Vadim Trysheveb701c62018-05-14 16:00:15 -0700628 final int childCount = getChildCount();
629 boolean pageScrollChanged = false;
630 if (mPageScrolls == null || childCount != mPageScrolls.length) {
631 mPageScrolls = new int[childCount];
632 pageScrollChanged = true;
633 }
634
635 if (childCount == 0) {
Winson Chungf0ea4d32011-06-06 14:27:16 -0700636 return;
637 }
638
Winson Chung785d2eb2011-04-14 16:08:02 -0700639 if (DEBUG) Log.d(TAG, "PagedView.onLayout()");
Winson Chung321e9ee2010-08-09 13:37:56 -0700640
Vinit Nayaka406f722019-12-19 11:50:55 -0800641 boolean isScrollChanged = getPageScrolls(mPageScrolls, true, SIMPLE_SCROLL_LOGIC);
642 if (isScrollChanged) {
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700643 pageScrollChanged = true;
Winson Chung321e9ee2010-08-09 13:37:56 -0700644 }
Winson Chungc3665fa2011-09-14 17:56:27 -0700645
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700646 final LayoutTransition transition = getLayoutTransition();
647 // If the transition is running defer updating max scroll, as some empty pages could
648 // still be present, and a max scroll change could cause sudden jumps in scroll.
649 if (transition != null && transition.isRunning()) {
650 transition.addTransitionListener(new LayoutTransition.TransitionListener() {
651
652 @Override
653 public void startTransition(LayoutTransition transition, ViewGroup container,
654 View view, int transitionType) { }
655
656 @Override
657 public void endTransition(LayoutTransition transition, ViewGroup container,
658 View view, int transitionType) {
659 // Wait until all transitions are complete.
660 if (!transition.isRunning()) {
661 transition.removeTransitionListener(this);
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700662 updateMinAndMaxScrollX();
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700663 }
664 }
665 });
Adam Cohenf698c6e2013-07-17 18:44:25 -0700666 } else {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700667 updateMinAndMaxScrollX();
Adam Cohenf698c6e2013-07-17 18:44:25 -0700668 }
669
Sunny Goyalcb037ee2015-07-08 16:41:21 -0700670 if (mFirstLayout && mCurrentPage >= 0 && mCurrentPage < childCount) {
671 updateCurrentPageScroll();
672 mFirstLayout = false;
673 }
674
Sunny Goyal85a7fe02018-02-02 10:09:32 -0800675 if (mScroller.isFinished() && pageScrollChanged) {
Sunny Goyalc82c6392018-06-06 15:39:13 -0700676 setCurrentPage(getNextPage());
Adam Cohenf698c6e2013-07-17 18:44:25 -0700677 }
Winson Chunge3193b92010-09-10 11:44:42 -0700678 }
679
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700680 /**
681 * Initializes {@code outPageScrolls} with scroll positions for view at that index. The length
682 * of {@code outPageScrolls} should be same as the the childCount
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700683 */
684 protected boolean getPageScrolls(int[] outPageScrolls, boolean layoutChildren,
685 ComputePageScrollsLogic scrollLogic) {
686 final int childCount = getChildCount();
687
688 final int startIndex = mIsRtl ? childCount - 1 : 0;
689 final int endIndex = mIsRtl ? -1 : childCount;
690 final int delta = mIsRtl ? -1 : 1;
691
Vinit Nayaka406f722019-12-19 11:50:55 -0800692 final int pageCenter = mOrientationHandler.getCenterForPage(this, mInsets);
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700693
Vinit Nayaka406f722019-12-19 11:50:55 -0800694 final int scrollOffsetStart = mOrientationHandler.getScrollOffsetStart(this, mInsets);
695 final int scrollOffsetEnd = mOrientationHandler.getScrollOffsetEnd(this, mInsets);
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700696 boolean pageScrollChanged = false;
697
Vinit Nayaka406f722019-12-19 11:50:55 -0800698 for (int i = startIndex, childStart = scrollOffsetStart; i != endIndex; i += delta) {
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700699 final View child = getPageAt(i);
700 if (scrollLogic.shouldIncludeView(child)) {
Vinit Nayaka406f722019-12-19 11:50:55 -0800701 ChildBounds bounds = mOrientationHandler.getChildBounds(child, childStart,
702 pageCenter, layoutChildren);
703 final int primaryDimension = bounds.primaryDimension;
704 final int childPrimaryEnd = bounds.childPrimaryEnd;
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700705
Alex Chaub5c4d112021-03-29 17:37:53 +0100706 // In case the pages are of different width, align the page to left edge for non-RTL
707 // or right edge for RTL.
708 final int pageScroll =
709 mIsRtl ? childPrimaryEnd - scrollOffsetEnd : childStart - scrollOffsetStart;
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700710 if (outPageScrolls[i] != pageScroll) {
711 pageScrollChanged = true;
712 outPageScrolls[i] = pageScroll;
713 }
Vinit Nayaka406f722019-12-19 11:50:55 -0800714 childStart += primaryDimension + mPageSpacing + getChildGap();
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700715 }
716 }
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100717
718 int panelCount = getPanelCount();
719 if (panelCount > 1) {
720 for (int i = 0; i < childCount; i++) {
721 // In case we have multiple panels, always use left panel's page scroll for all
722 // panels on the screen.
723 int adjustedScroll = outPageScrolls[getLeftmostVisiblePageForIndex(i)];
724 if (outPageScrolls[i] != adjustedScroll) {
725 outPageScrolls[i] = adjustedScroll;
726 pageScrollChanged = true;
727 }
728 }
729 }
Sunny Goyal20a13ff2018-03-13 16:44:00 -0700730 return pageScrollChanged;
731 }
732
Sunny Goyala1fbd842015-05-20 13:40:27 -0700733 protected int getChildGap() {
734 return 0;
735 }
736
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700737 protected void updateMinAndMaxScrollX() {
Vinit Nayaka406f722019-12-19 11:50:55 -0800738 mMinScroll = computeMinScroll();
739 mMaxScroll = computeMaxScroll();
Tony Wickhamf549dab2016-05-16 09:54:06 -0700740 }
741
Vinit Nayaka406f722019-12-19 11:50:55 -0800742 protected int computeMinScroll() {
Tony Wickham66d1c2f2019-04-24 11:32:59 -0700743 return 0;
Tony50876bf2018-09-19 23:09:14 -0400744 }
745
Vinit Nayaka406f722019-12-19 11:50:55 -0800746 protected int computeMaxScroll() {
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700747 int childCount = getChildCount();
748 if (childCount > 0) {
Sunny Goyal70660032015-05-14 00:07:08 -0700749 final int index = mIsRtl ? 0 : childCount - 1;
Tony Wickhamf549dab2016-05-16 09:54:06 -0700750 return getScrollForPage(index);
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700751 } else {
Tony Wickhamf549dab2016-05-16 09:54:06 -0700752 return 0;
Sunny Goyal3e2ff8a2015-04-15 16:31:22 -0700753 }
754 }
755
Adam Cohen3b185e22013-10-29 14:45:58 -0700756 public void setPageSpacing(int pageSpacing) {
757 mPageSpacing = pageSpacing;
758 requestLayout();
759 }
760
Tony50876bf2018-09-19 23:09:14 -0400761 public int getPageSpacing() {
762 return mPageSpacing;
763 }
764
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800765 private void dispatchPageCountChanged() {
766 if (mPageIndicator != null) {
767 mPageIndicator.setMarkersCount(getChildCount());
Winson Chungd2be3812013-07-16 11:11:32 -0700768 }
Adam Cohen2591f6a2011-10-25 14:36:40 -0700769 // This ensures that when children are added, they get the correct transforms / alphas
770 // in accordance with any scroll effects.
Adam Cohen2591f6a2011-10-25 14:36:40 -0700771 invalidate();
772 }
773
Michael Jurka8b805b12012-04-18 14:23:14 -0700774 @Override
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800775 public void onViewAdded(View child) {
Winson Chungc7c51582018-02-23 17:58:36 -0800776 super.onViewAdded(child);
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800777 dispatchPageCountChanged();
778 }
779
780 @Override
781 public void onViewRemoved(View child) {
Winson Chungc7c51582018-02-23 17:58:36 -0800782 super.onViewRemoved(child);
Tonya361c722017-07-04 09:43:06 -0700783 mCurrentPage = validateNewPage(mCurrentPage);
Sunny Goyal0bd7f4f2018-02-01 09:53:35 -0800784 dispatchPageCountChanged();
Winson Chungd2be3812013-07-16 11:11:32 -0700785 }
786
Adam Cohen73894962011-10-31 13:17:17 -0700787 protected int getChildOffset(int index) {
Adam Cohen7d30a372013-07-01 17:03:59 -0700788 if (index < 0 || index > getChildCount() - 1) return 0;
Vinit Nayaka406f722019-12-19 11:50:55 -0800789 View pageAtIndex = getPageAt(index);
790 return mOrientationHandler.getChildStart(pageAtIndex);
Adam Cohen73894962011-10-31 13:17:17 -0700791 }
792
Alex Chau7944ee52021-01-08 19:07:25 +0000793 protected int getChildVisibleSize(int index) {
794 View layout = getPageAt(index);
795 return mOrientationHandler.getMeasuredSize(layout);
796 }
797
Winson Chung321e9ee2010-08-09 13:37:56 -0700798 @Override
799 public boolean requestChildRectangleOnScreen(View child, Rect rectangle, boolean immediate) {
Adam Cohenae4f1552011-10-20 00:15:42 -0700800 int page = indexToPage(indexOfChild(child));
Winson Chung86f77532010-08-24 11:08:22 -0700801 if (page != mCurrentPage || !mScroller.isFinished()) {
Vadim Trysheveeaa8ee2018-04-11 12:23:42 -0700802 if (immediate) {
803 setCurrentPage(page);
804 } else {
805 snapToPage(page);
806 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700807 return true;
808 }
809 return false;
810 }
811
812 @Override
813 protected boolean onRequestFocusInDescendants(int direction, Rect previouslyFocusedRect) {
Winson Chung86f77532010-08-24 11:08:22 -0700814 int focusablePage;
815 if (mNextPage != INVALID_PAGE) {
816 focusablePage = mNextPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700817 } else {
Winson Chung86f77532010-08-24 11:08:22 -0700818 focusablePage = mCurrentPage;
Winson Chung321e9ee2010-08-09 13:37:56 -0700819 }
Winson Chung86f77532010-08-24 11:08:22 -0700820 View v = getPageAt(focusablePage);
Winson Chung321e9ee2010-08-09 13:37:56 -0700821 if (v != null) {
Adam Cohen76fc0852011-06-17 13:26:23 -0700822 return v.requestFocus(direction, previouslyFocusedRect);
Winson Chung321e9ee2010-08-09 13:37:56 -0700823 }
824 return false;
825 }
826
827 @Override
828 public boolean dispatchUnhandledMove(View focused, int direction) {
Sunny Goyal0c4e3722015-12-01 13:21:49 -0800829 if (super.dispatchUnhandledMove(focused, direction)) {
830 return true;
831 }
832
833 if (mIsRtl) {
834 if (direction == View.FOCUS_LEFT) {
835 direction = View.FOCUS_RIGHT;
836 } else if (direction == View.FOCUS_RIGHT) {
837 direction = View.FOCUS_LEFT;
838 }
839 }
Winson Chung321e9ee2010-08-09 13:37:56 -0700840 if (direction == View.FOCUS_LEFT) {
Winson Chung86f77532010-08-24 11:08:22 -0700841 if (getCurrentPage() > 0) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100842 int nextPage = validateNewPage(getCurrentPage() - 1);
843 snapToPage(nextPage);
844 getChildAt(nextPage).requestFocus(direction);
Winson Chung321e9ee2010-08-09 13:37:56 -0700845 return true;
846 }
847 } else if (direction == View.FOCUS_RIGHT) {
Winson Chung86f77532010-08-24 11:08:22 -0700848 if (getCurrentPage() < getPageCount() - 1) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100849 int nextPage = validateNewPage(getCurrentPage() + 1);
850 snapToPage(nextPage);
851 getChildAt(nextPage).requestFocus(direction);
Winson Chung321e9ee2010-08-09 13:37:56 -0700852 return true;
853 }
854 }
Sunny Goyal0c4e3722015-12-01 13:21:49 -0800855 return false;
Winson Chung321e9ee2010-08-09 13:37:56 -0700856 }
857
858 @Override
859 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) {
Jon Miranda6a858172016-10-25 16:19:17 -0700860 if (getDescendantFocusability() == FOCUS_BLOCK_DESCENDANTS) {
861 return;
862 }
863
Andras Kloczl359d1ae2021-05-04 22:25:27 +0200864 // Add the current page's views as focusable and the next possible page's too. If the
865 // last focus change action was left then the left neighbour's views will be added, and
866 // if it was right then the right neighbour's views will be added.
867 // Unfortunately mCurrentPage can be outdated if there were multiple control actions in a
868 // short period of time, but mNextPage is up to date because it is always updated by
869 // method snapToPage.
870 int nextPage = getNextPage();
Adam Cohen0ffac432013-07-10 11:19:26 -0700871 // XXX-RTL: This will be fixed in a future CL
Andras Kloczl359d1ae2021-05-04 22:25:27 +0200872 if (nextPage >= 0 && nextPage < getPageCount()) {
873 getPageAt(nextPage).addFocusables(views, direction, focusableMode);
Winson Chung321e9ee2010-08-09 13:37:56 -0700874 }
875 if (direction == View.FOCUS_LEFT) {
Andras Kloczl359d1ae2021-05-04 22:25:27 +0200876 if (nextPage > 0) {
877 nextPage = validateNewPage(nextPage - 1);
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100878 getPageAt(nextPage).addFocusables(views, direction, focusableMode);
Winson Chung321e9ee2010-08-09 13:37:56 -0700879 }
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100880 } else if (direction == View.FOCUS_RIGHT) {
Andras Kloczl359d1ae2021-05-04 22:25:27 +0200881 if (nextPage < getPageCount() - 1) {
882 nextPage = validateNewPage(nextPage + 1);
Andras Kloczl8e57cce2021-02-11 23:51:19 +0100883 getPageAt(nextPage).addFocusables(views, direction, focusableMode);
Winson Chung321e9ee2010-08-09 13:37:56 -0700884 }
885 }
886 }
887
888 /**
889 * If one of our descendant views decides that it could be focused now, only
Winson Chung86f77532010-08-24 11:08:22 -0700890 * pass that along if it's on the current page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700891 *
Winson Chung86f77532010-08-24 11:08:22 -0700892 * This happens when live folders requery, and if they're off page, they
893 * end up calling requestFocus, which pulls it on page.
Winson Chung321e9ee2010-08-09 13:37:56 -0700894 */
895 @Override
896 public void focusableViewAvailable(View focused) {
Winson Chung86f77532010-08-24 11:08:22 -0700897 View current = getPageAt(mCurrentPage);
Winson Chung321e9ee2010-08-09 13:37:56 -0700898 View v = focused;
899 while (true) {
900 if (v == current) {
901 super.focusableViewAvailable(focused);
902 return;
903 }
904 if (v == this) {
905 return;
906 }
907 ViewParent parent = v.getParent();
908 if (parent instanceof View) {
909 v = (View)v.getParent();
910 } else {
911 return;
912 }
913 }
914 }
915
916 /**
917 * {@inheritDoc}
918 */
919 @Override
920 public void requestDisallowInterceptTouchEvent(boolean disallowIntercept) {
921 if (disallowIntercept) {
922 // We need to make sure to cancel our long press if
923 // a scrollable widget takes over touch events
Andras Kloczl7a1ca0b2021-04-08 16:08:16 +0200924 cancelCurrentPageLongPress();
Winson Chung321e9ee2010-08-09 13:37:56 -0700925 }
926 super.requestDisallowInterceptTouchEvent(disallowIntercept);
927 }
928
929 @Override
930 public boolean onInterceptTouchEvent(MotionEvent ev) {
931 /*
932 * This method JUST determines whether we want to intercept the motion.
933 * If we return true, onTouchEvent will be called and we do the actual
934 * scrolling there.
935 */
936
Winson Chung45e1d6e2010-11-09 17:19:49 -0800937 // Skip touch handling if there are no pages to swipe
Tony Wickhamb6841ac2019-07-22 12:39:59 -0700938 if (getChildCount() <= 0) return false;
Sunny Goyalc4bb3732019-06-20 11:34:14 -0700939
940 acquireVelocityTrackerAndAddMovement(ev);
Winson Chung45e1d6e2010-11-09 17:19:49 -0800941
Winson Chung321e9ee2010-08-09 13:37:56 -0700942 /*
943 * Shortcut the most recurring case: the user is in the dragging
944 * state and he is moving his finger. We want to intercept this
945 * motion.
946 */
947 final int action = ev.getAction();
Sunny Goyalaad33592018-08-07 17:20:35 -0700948 if ((action == MotionEvent.ACTION_MOVE) && mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -0700949 return true;
950 }
951
Winson Chung321e9ee2010-08-09 13:37:56 -0700952 switch (action & MotionEvent.ACTION_MASK) {
953 case MotionEvent.ACTION_MOVE: {
954 /*
955 * mIsBeingDragged == false, otherwise the shortcut would have caught it. Check
Vinit Nayaka406f722019-12-19 11:50:55 -0800956 * whether the user has moved far enough from their original down touch.
Winson Chung321e9ee2010-08-09 13:37:56 -0700957 */
Michael Jurka1ff706b2010-09-14 17:35:20 -0700958 if (mActivePointerId != INVALID_POINTER) {
959 determineScrollingStart(ev);
Michael Jurka1ff706b2010-09-14 17:35:20 -0700960 }
961 // if mActivePointerId is INVALID_POINTER, then we must have missed an ACTION_DOWN
Vinit Nayaka406f722019-12-19 11:50:55 -0800962 // event. in that case, treat the first occurrence of a move event as a ACTION_DOWN
Michael Jurka1ff706b2010-09-14 17:35:20 -0700963 // i.e. fall through to the next case (don't break)
964 // (We sometimes miss ACTION_DOWN events in Workspace because it ignores all events
965 // while it's small- this was causing a crash before we checked for INVALID_POINTER)
Adam Cohen93c97562013-09-26 13:48:01 -0700966 break;
Winson Chung321e9ee2010-08-09 13:37:56 -0700967 }
968
969 case MotionEvent.ACTION_DOWN: {
970 final float x = ev.getX();
971 final float y = ev.getY();
972 // Remember location of down touch
973 mDownMotionX = x;
Adam Cohen7d30a372013-07-01 17:03:59 -0700974 mDownMotionY = y;
Jon Mirandaf52af432020-04-10 17:25:57 -0700975 mDownMotionPrimary = mLastMotion = mOrientationHandler.getPrimaryDirection(ev, 0);
Vinit Nayaka406f722019-12-19 11:50:55 -0800976 mLastMotionRemainder = 0;
977 mTotalMotion = 0;
Winson Chung4941f652020-06-18 15:11:53 -0700978 mAllowEasyFling = false;
Winson Chung321e9ee2010-08-09 13:37:56 -0700979 mActivePointerId = ev.getPointerId(0);
Sunny Goyalc39db732021-04-03 01:20:21 -0700980 updateIsBeingDraggedOnTouchDown(ev);
Winson Chung321e9ee2010-08-09 13:37:56 -0700981 break;
982 }
983
Winson Chung321e9ee2010-08-09 13:37:56 -0700984 case MotionEvent.ACTION_UP:
Jeff Brown1d0867c2010-12-02 18:27:39 -0800985 case MotionEvent.ACTION_CANCEL:
Adam Cohen7d30a372013-07-01 17:03:59 -0700986 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -0700987 break;
988
989 case MotionEvent.ACTION_POINTER_UP:
990 onSecondaryPointerUp(ev);
Adam Cohen6342bba2011-03-10 11:33:35 -0800991 releaseVelocityTracker();
Winson Chung321e9ee2010-08-09 13:37:56 -0700992 break;
993 }
994
995 /*
996 * The only time we want to intercept motion events is if we are in the
997 * drag mode.
998 */
Sunny Goyalaad33592018-08-07 17:20:35 -0700999 return mIsBeingDragged;
Winson Chung321e9ee2010-08-09 13:37:56 -07001000 }
1001
Tony Wickhama0aee212019-09-18 09:24:03 -07001002 /**
1003 * If being flinged and user touches the screen, initiate drag; otherwise don't.
1004 */
Sunny Goyalc39db732021-04-03 01:20:21 -07001005 private void updateIsBeingDraggedOnTouchDown(MotionEvent ev) {
Tony Wickhama0aee212019-09-18 09:24:03 -07001006 // mScroller.isFinished should be false when being flinged.
Sunny Goyalc39db732021-04-03 01:20:21 -07001007 final int xDist = Math.abs(mScroller.getFinalX() - mScroller.getCurrX());
Winson Chung4941f652020-06-18 15:11:53 -07001008 final boolean finishedScrolling = (mScroller.isFinished() || xDist < mPageSlop / 3);
Tony Wickhama0aee212019-09-18 09:24:03 -07001009
1010 if (finishedScrolling) {
1011 mIsBeingDragged = false;
1012 if (!mScroller.isFinished() && !mFreeScroll) {
1013 setCurrentPage(getNextPage());
1014 pageEndTransition();
1015 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001016 mIsBeingDragged = !mEdgeGlowLeft.isFinished() || !mEdgeGlowRight.isFinished();
Tony Wickhama0aee212019-09-18 09:24:03 -07001017 } else {
1018 mIsBeingDragged = true;
1019 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001020
1021 // Catch the edge effect if it is active.
1022 float displacement = mOrientationHandler.getSecondaryValue(ev.getX(), ev.getY())
1023 / mOrientationHandler.getSecondaryValue(getWidth(), getHeight());
1024 if (!mEdgeGlowLeft.isFinished()) {
1025 mEdgeGlowLeft.onPullDistance(0f, 1f - displacement);
1026 }
1027 if (!mEdgeGlowRight.isFinished()) {
1028 mEdgeGlowRight.onPullDistance(0f, displacement);
1029 }
Tony Wickhama0aee212019-09-18 09:24:03 -07001030 }
1031
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001032 public boolean isHandlingTouch() {
Sunny Goyalaad33592018-08-07 17:20:35 -07001033 return mIsBeingDragged;
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001034 }
1035
Adam Cohenf8d28232011-02-01 21:47:00 -08001036 protected void determineScrollingStart(MotionEvent ev) {
1037 determineScrollingStart(ev, 1.0f);
1038 }
1039
Winson Chung321e9ee2010-08-09 13:37:56 -07001040 /*
1041 * Determines if we should change the touch state to start scrolling after the
1042 * user moves their touch point too far.
1043 */
Adam Cohenf8d28232011-02-01 21:47:00 -08001044 protected void determineScrollingStart(MotionEvent ev, float touchSlopScale) {
Adam Cohen7d30a372013-07-01 17:03:59 -07001045 // Disallow scrolling if we don't have a valid pointer index
Winson Chung321e9ee2010-08-09 13:37:56 -07001046 final int pointerIndex = ev.findPointerIndex(mActivePointerId);
Adam Cohen7d30a372013-07-01 17:03:59 -07001047 if (pointerIndex == -1) return;
1048
Vinit Nayaka406f722019-12-19 11:50:55 -08001049 final float primaryDirection = mOrientationHandler.getPrimaryDirection(ev, pointerIndex);
1050 final int diff = (int) Math.abs(primaryDirection - mLastMotion);
Adam Cohenf8d28232011-02-01 21:47:00 -08001051 final int touchSlop = Math.round(touchSlopScale * mTouchSlop);
Winson Chung4941f652020-06-18 15:11:53 -07001052 boolean moved = diff > touchSlop || ev.getAction() == ACTION_MOVE_ALLOW_EASY_FLING;
Winson Chung321e9ee2010-08-09 13:37:56 -07001053
Vinit Nayaka406f722019-12-19 11:50:55 -08001054 if (moved) {
Sunny Goyal5a1f53b2015-05-27 10:24:24 -07001055 // Scroll if the user moved far enough along the X axis
Sunny Goyalaad33592018-08-07 17:20:35 -07001056 mIsBeingDragged = true;
Vinit Nayaka406f722019-12-19 11:50:55 -08001057 mTotalMotion += Math.abs(mLastMotion - primaryDirection);
1058 mLastMotion = primaryDirection;
1059 mLastMotionRemainder = 0;
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001060 pageBeginTransition();
Tony Wickhamdadb3042016-02-24 11:07:00 -08001061 // Stop listening for things like pinches.
1062 requestDisallowInterceptTouchEvent(true);
Adam Cohenf8d28232011-02-01 21:47:00 -08001063 }
1064 }
1065
1066 protected void cancelCurrentPageLongPress() {
Sunny Goyal8e2133b2015-05-06 13:39:07 -07001067 // Try canceling the long press. It could also have been scheduled
1068 // by a distant descendant, so use the mAllowLongPress flag to block
1069 // everything
Sunny Goyal59969372021-05-06 12:11:44 -07001070 forEachVisiblePage(View::cancelLongPress);
Winson Chung321e9ee2010-08-09 13:37:56 -07001071 }
1072
Adam Cohenb5ba0972011-09-07 18:02:31 -07001073 protected float getScrollProgress(int screenCenter, View v, int page) {
Sunny Goyal228153d2018-01-04 15:35:22 -08001074 final int halfScreenSize = getMeasuredWidth() / 2;
Adam Cohenb5ba0972011-09-07 18:02:31 -07001075
Adam Cohenedb40762013-07-18 16:45:45 -07001076 int delta = screenCenter - (getScrollForPage(page) + halfScreenSize);
Adam Cohen3b185e22013-10-29 14:45:58 -07001077 int count = getChildCount();
1078
1079 final int totalDistance;
1080
1081 int adjacentPage = page + 1;
Sunny Goyal70660032015-05-14 00:07:08 -07001082 if ((delta < 0 && !mIsRtl) || (delta > 0 && mIsRtl)) {
Adam Cohen3b185e22013-10-29 14:45:58 -07001083 adjacentPage = page - 1;
1084 }
1085
1086 if (adjacentPage < 0 || adjacentPage > count - 1) {
1087 totalDistance = v.getMeasuredWidth() + mPageSpacing;
1088 } else {
1089 totalDistance = Math.abs(getScrollForPage(adjacentPage) - getScrollForPage(page));
1090 }
Adam Cohenb5ba0972011-09-07 18:02:31 -07001091
1092 float scrollProgress = delta / (totalDistance * 1.0f);
Sunny Goyal8e2133b2015-05-06 13:39:07 -07001093 scrollProgress = Math.min(scrollProgress, MAX_SCROLL_PROGRESS);
1094 scrollProgress = Math.max(scrollProgress, - MAX_SCROLL_PROGRESS);
Adam Cohenb5ba0972011-09-07 18:02:31 -07001095 return scrollProgress;
1096 }
1097
Adam Cohenedb40762013-07-18 16:45:45 -07001098 public int getScrollForPage(int index) {
Adam Cohen1f1f45d2013-10-02 09:40:18 -07001099 if (mPageScrolls == null || index >= mPageScrolls.length || index < 0) {
Adam Cohenedb40762013-07-18 16:45:45 -07001100 return 0;
1101 } else {
1102 return mPageScrolls[index];
1103 }
1104 }
1105
Adam Cohen564a2e72013-10-09 14:47:32 -07001106 // While layout transitions are occurring, a child's position may stray from its baseline
1107 // position. This method returns the magnitude of this stray at any given time.
1108 public int getLayoutTransitionOffsetForPage(int index) {
1109 if (mPageScrolls == null || index >= mPageScrolls.length || index < 0) {
1110 return 0;
1111 } else {
1112 View child = getChildAt(index);
Adam Cohen3b185e22013-10-29 14:45:58 -07001113
Sunny Goyal228153d2018-01-04 15:35:22 -08001114 int scrollOffset = mIsRtl ? getPaddingRight() : getPaddingLeft();
1115 int baselineX = mPageScrolls[index] + scrollOffset;
Adam Cohen564a2e72013-10-09 14:47:32 -07001116 return (int) (child.getX() - baselineX);
1117 }
1118 }
1119
Tony Wickham023f4042019-01-29 10:52:31 -08001120 public void setEnableFreeScroll(boolean freeScroll) {
Winson Chung0e449002019-04-26 11:09:58 -07001121 if (mFreeScroll == freeScroll) {
1122 return;
1123 }
1124
Tony Wickham8f7ead32016-04-07 18:46:44 -07001125 boolean wasFreeScroll = mFreeScroll;
Adam Cohenf358a4b2013-07-23 16:47:31 -07001126 mFreeScroll = freeScroll;
1127
Adam Cohenf9618852013-11-08 06:45:03 -08001128 if (mFreeScroll) {
Sunny Goyal4d519f22017-10-24 10:32:40 -07001129 setCurrentPage(getNextPage());
Tony Wickham8f7ead32016-04-07 18:46:44 -07001130 } else if (wasFreeScroll) {
Tony Wickhamaf33f2c2019-10-04 12:55:22 -07001131 if (getScrollForPage(getNextPage()) != getScrollX()) {
1132 snapToPage(getNextPage());
1133 }
Adam Cohenf358a4b2013-07-23 16:47:31 -07001134 }
Adam Cohenf358a4b2013-07-23 16:47:31 -07001135 }
1136
Sunny Goyal2f0ec852015-03-26 13:38:27 -07001137 protected void setEnableOverscroll(boolean enable) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001138 mAllowOverScroll = enable;
1139 }
1140
Winson Chung321e9ee2010-08-09 13:37:56 -07001141 @Override
1142 public boolean onTouchEvent(MotionEvent ev) {
Winson Chung45e1d6e2010-11-09 17:19:49 -08001143 // Skip touch handling if there are no pages to swipe
Tony Wickhamb6841ac2019-07-22 12:39:59 -07001144 if (getChildCount() <= 0) return false;
Winson Chung45e1d6e2010-11-09 17:19:49 -08001145
Michael Jurkab8f06722010-10-10 15:58:46 -07001146 acquireVelocityTrackerAndAddMovement(ev);
Winson Chung321e9ee2010-08-09 13:37:56 -07001147
1148 final int action = ev.getAction();
1149
1150 switch (action & MotionEvent.ACTION_MASK) {
1151 case MotionEvent.ACTION_DOWN:
Sunny Goyalc39db732021-04-03 01:20:21 -07001152 updateIsBeingDraggedOnTouchDown(ev);
Tony Wickhama0aee212019-09-18 09:24:03 -07001153
Winson Chung321e9ee2010-08-09 13:37:56 -07001154 /*
1155 * If being flinged and user touches, stop the fling. isFinished
1156 * will be false if being flinged.
1157 */
1158 if (!mScroller.isFinished()) {
Adam Cohen8bdbaab2013-10-29 15:25:02 -07001159 abortScrollerAnimation(false);
Winson Chung321e9ee2010-08-09 13:37:56 -07001160 }
1161
1162 // Remember where the motion event started
Vinit Nayaka406f722019-12-19 11:50:55 -08001163 mDownMotionX = ev.getX();
Sunny Goyal7c7be8c2018-03-07 19:58:07 -08001164 mDownMotionY = ev.getY();
Vinit Nayaka406f722019-12-19 11:50:55 -08001165 mDownMotionPrimary = mLastMotion = mOrientationHandler.getPrimaryDirection(ev, 0);
1166 mLastMotionRemainder = 0;
1167 mTotalMotion = 0;
Winson Chung4941f652020-06-18 15:11:53 -07001168 mAllowEasyFling = false;
Winson Chung321e9ee2010-08-09 13:37:56 -07001169 mActivePointerId = ev.getPointerId(0);
Sunny Goyalaad33592018-08-07 17:20:35 -07001170 if (mIsBeingDragged) {
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001171 pageBeginTransition();
Michael Jurka0142d492010-08-25 17:46:15 -07001172 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001173 break;
1174
Winson Chung4941f652020-06-18 15:11:53 -07001175 case ACTION_MOVE_ALLOW_EASY_FLING:
1176 // Start scrolling immediately
1177 determineScrollingStart(ev);
1178 mAllowEasyFling = true;
1179 break;
1180
1181 case MotionEvent.ACTION_MOVE:
1182 if (mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001183 // Scroll to follow the motion event
1184 final int pointerIndex = ev.findPointerIndex(mActivePointerId);
Adam Cohen7d30a372013-07-01 17:03:59 -07001185
1186 if (pointerIndex == -1) return true;
Sunny Goyalc39db732021-04-03 01:20:21 -07001187 float oldScroll = mOrientationHandler.getPrimaryScroll(this);
1188 float dx = ev.getX(pointerIndex);
1189 float dy = ev.getY(pointerIndex);
Adam Cohen7d30a372013-07-01 17:03:59 -07001190
Sunny Goyalc39db732021-04-03 01:20:21 -07001191 float direction = mOrientationHandler.getPrimaryValue(dx, dy);
Vinit Nayaka406f722019-12-19 11:50:55 -08001192 float delta = mLastMotion + mLastMotionRemainder - direction;
Sunny Goyalc39db732021-04-03 01:20:21 -07001193
1194 int width = getWidth();
1195 int height = getHeight();
1196 int size = mOrientationHandler.getPrimaryValue(width, height);
1197
1198 final float displacement = mOrientationHandler.getSecondaryValue(dx, dy)
1199 / mOrientationHandler.getSecondaryValue(width, height);
Vinit Nayaka406f722019-12-19 11:50:55 -08001200 mTotalMotion += Math.abs(delta);
Adam Cohenaefd4e12011-02-14 16:39:38 -08001201
Sunny Goyalc39db732021-04-03 01:20:21 -07001202 if (mAllowOverScroll) {
1203 float consumed = 0;
1204 if (delta < 0 && mEdgeGlowRight.getDistance() != 0f) {
1205 consumed = size * mEdgeGlowRight.onPullDistance(delta / size, displacement);
1206 } else if (delta > 0 && mEdgeGlowLeft.getDistance() != 0f) {
1207 consumed = -size * mEdgeGlowLeft.onPullDistance(
1208 -delta / size, 1 - displacement);
1209 }
1210 delta -= consumed;
1211 }
1212
Winson Chungc0844aa2011-02-02 15:25:58 -08001213 // Only scroll and update mLastMotionX if we have moved some discrete amount. We
1214 // keep the remainder because we are actually testing if we've moved from the last
1215 // scrolled position (which is discrete).
Sunny Goyalc39db732021-04-03 01:20:21 -07001216 mLastMotion = direction;
1217 int movedDelta = (int) delta;
1218 mLastMotionRemainder = delta - movedDelta;
Vinit Nayaka406f722019-12-19 11:50:55 -08001219
Sunny Goyalc39db732021-04-03 01:20:21 -07001220 if (delta != 0) {
1221 mOrientationHandler.set(this, VIEW_SCROLL_BY, movedDelta);
1222
1223 if (mAllowOverScroll) {
1224 final float pulledToX = oldScroll + delta;
1225
1226 if (pulledToX < mMinScroll) {
1227 mEdgeGlowLeft.onPullDistance(-delta / size, 1.f - displacement);
1228 if (!mEdgeGlowRight.isFinished()) {
1229 mEdgeGlowRight.onRelease();
1230 }
1231 } else if (pulledToX > mMaxScroll) {
1232 mEdgeGlowRight.onPullDistance(delta / size, displacement);
1233 if (!mEdgeGlowLeft.isFinished()) {
1234 mEdgeGlowLeft.onRelease();
1235 }
1236 }
1237
1238 if (!mEdgeGlowLeft.isFinished() || !mEdgeGlowRight.isFinished()) {
1239 postInvalidateOnAnimation();
1240 }
1241 }
1242
Winson Chung321e9ee2010-08-09 13:37:56 -07001243 } else {
1244 awakenScrollBars();
1245 }
Adam Cohen564976a2010-10-13 18:52:07 -07001246 } else {
Winson Chung321e9ee2010-08-09 13:37:56 -07001247 determineScrollingStart(ev);
1248 }
1249 break;
1250
1251 case MotionEvent.ACTION_UP:
Sunny Goyalaad33592018-08-07 17:20:35 -07001252 if (mIsBeingDragged) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001253 final int activePointerId = mActivePointerId;
1254 final int pointerIndex = ev.findPointerIndex(activePointerId);
Vinit Nayak93bf1fe2020-05-26 17:22:13 -07001255 if (pointerIndex == -1) return true;
1256
Vinit Nayaka406f722019-12-19 11:50:55 -08001257 final float primaryDirection = mOrientationHandler.getPrimaryDirection(ev,
1258 pointerIndex);
Sunny Goyal4bb8b062019-02-19 16:37:38 -08001259 final VelocityTracker velocityTracker = mVelocityTracker;
1260 velocityTracker.computeCurrentVelocity(1000, mMaximumVelocity);
Adam Cohenaefd4e12011-02-14 16:39:38 -08001261
Vinit Nayaka406f722019-12-19 11:50:55 -08001262 int velocity = (int) mOrientationHandler.getPrimaryVelocity(velocityTracker,
1263 mActivePointerId);
1264 int delta = (int) (primaryDirection - mDownMotionPrimary);
1265 int pageOrientedSize = mOrientationHandler.getMeasuredSize(getPageAt(mCurrentPage));
1266
1267 boolean isSignificantMove = Math.abs(delta) > pageOrientedSize *
1268 SIGNIFICANT_MOVE_THRESHOLD;
1269
1270 mTotalMotion += Math.abs(mLastMotion + mLastMotionRemainder - primaryDirection);
Winson Chung4941f652020-06-18 15:11:53 -07001271 boolean passedSlop = mAllowEasyFling || mTotalMotion > mPageSlop;
1272 boolean isFling = passedSlop && shouldFlingForVelocity(velocity);
Vinit Nayaka406f722019-12-19 11:50:55 -08001273 boolean isDeltaLeft = mIsRtl ? delta > 0 : delta < 0;
1274 boolean isVelocityLeft = mIsRtl ? velocity > 0 : velocity < 0;
Winson Chung4941f652020-06-18 15:11:53 -07001275 if (DEBUG_FAILED_QUICKSWITCH && !isFling && mAllowEasyFling) {
1276 Log.d("Quickswitch", "isFling=false vel=" + velocity
1277 + " threshold=" + mEasyFlingThresholdVelocity);
1278 }
Adam Cohen00481b32011-11-18 12:03:48 -08001279
Adam Cohenf358a4b2013-07-23 16:47:31 -07001280 if (!mFreeScroll) {
1281 // In the case that the page is moved far to one direction and then is flung
1282 // in the opposite direction, we use a threshold to determine whether we should
1283 // just return to the starting page, or if we should skip one further.
1284 boolean returnToOriginalPage = false;
Vinit Nayaka406f722019-12-19 11:50:55 -08001285 if (Math.abs(delta) > pageOrientedSize * RETURN_TO_ORIGINAL_PAGE_THRESHOLD &&
1286 Math.signum(velocity) != Math.signum(delta) && isFling) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001287 returnToOriginalPage = true;
1288 }
Adam Cohenaefd4e12011-02-14 16:39:38 -08001289
Adam Cohenf358a4b2013-07-23 16:47:31 -07001290 int finalPage;
1291 // We give flings precedence over large moves, which is why we short-circuit our
1292 // test for a large move if a fling has been registered. That is, a large
1293 // move to the left and fling to the right will register as a fling to the right.
Sunny Goyalb7b01352018-08-09 12:31:20 -07001294
Vinit Nayaka406f722019-12-19 11:50:55 -08001295 if (((isSignificantMove && !isDeltaLeft && !isFling) ||
1296 (isFling && !isVelocityLeft)) && mCurrentPage > 0) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +01001297 finalPage = returnToOriginalPage
1298 ? mCurrentPage : mCurrentPage - getPanelCount();
Vinit Nayaka406f722019-12-19 11:50:55 -08001299 snapToPageWithVelocity(finalPage, velocity);
1300 } else if (((isSignificantMove && isDeltaLeft && !isFling) ||
1301 (isFling && isVelocityLeft)) &&
Adam Cohenf358a4b2013-07-23 16:47:31 -07001302 mCurrentPage < getChildCount() - 1) {
Andras Kloczl8e57cce2021-02-11 23:51:19 +01001303 finalPage = returnToOriginalPage
1304 ? mCurrentPage : mCurrentPage + getPanelCount();
Vinit Nayaka406f722019-12-19 11:50:55 -08001305 snapToPageWithVelocity(finalPage, velocity);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001306 } else {
1307 snapToDestination();
Adam Cohenf358a4b2013-07-23 16:47:31 -07001308 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001309 } else {
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001310 if (!mScroller.isFinished()) {
1311 abortScrollerAnimation(true);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001312 }
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001313
Vinit Nayaka406f722019-12-19 11:50:55 -08001314 int initialScroll = mOrientationHandler.getPrimaryScroll(this);
1315 int maxScroll = mMaxScroll;
1316 int minScroll = mMinScroll;
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001317
Vinit Nayaka406f722019-12-19 11:50:55 -08001318 if (((initialScroll >= maxScroll) && (isVelocityLeft || !isFling)) ||
1319 ((initialScroll <= minScroll) && (!isVelocityLeft || !isFling))) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001320 mScroller.springBack(initialScroll, 0, minScroll, maxScroll, 0, 0);
Alex Chaub794ea62021-02-03 18:00:30 +00001321 mNextPage = getDestinationPage();
Sunny Goyalb7b01352018-08-09 12:31:20 -07001322 } else {
Sunny Goyalc39db732021-04-03 01:20:21 -07001323 int velocity1 = -velocity;
1324 // Continue a scroll or fling in progress
1325 mScroller.fling(initialScroll, 0, velocity1, 0, minScroll, maxScroll, 0, 0,
1326 Math.round(getWidth() * 0.5f * OVERSCROLL_DAMP_FACTOR), 0);
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001327
Sunny Goyalc39db732021-04-03 01:20:21 -07001328 int finalPos = mScroller.getFinalX();
Alex Chaub794ea62021-02-03 18:00:30 +00001329 mNextPage = getDestinationPage(finalPos);
Sunny Goyalc39db732021-04-03 01:20:21 -07001330 onNotSnappingToPageInFreeScroll();
Santiago Etchebehere260b4cb2018-06-15 16:42:19 -07001331 }
1332 invalidate();
Winson Chung321e9ee2010-08-09 13:37:56 -07001333 }
Winson Chung321e9ee2010-08-09 13:37:56 -07001334 }
Adam Cohen7d30a372013-07-01 17:03:59 -07001335
Sunny Goyalc39db732021-04-03 01:20:21 -07001336 mEdgeGlowLeft.onRelease();
1337 mEdgeGlowRight.onRelease();
Adam Cohen7d30a372013-07-01 17:03:59 -07001338 // End any intermediate reordering states
1339 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001340 break;
1341
1342 case MotionEvent.ACTION_CANCEL:
Sunny Goyalaad33592018-08-07 17:20:35 -07001343 if (mIsBeingDragged) {
Michael Jurkab8f06722010-10-10 15:58:46 -07001344 snapToDestination();
1345 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001346 mEdgeGlowLeft.onRelease();
1347 mEdgeGlowRight.onRelease();
Adam Cohen7d30a372013-07-01 17:03:59 -07001348 resetTouchState();
Winson Chung321e9ee2010-08-09 13:37:56 -07001349 break;
1350
1351 case MotionEvent.ACTION_POINTER_UP:
1352 onSecondaryPointerUp(ev);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001353 releaseVelocityTracker();
Winson Chung321e9ee2010-08-09 13:37:56 -07001354 break;
1355 }
1356
1357 return true;
1358 }
1359
Sunny Goyalc39db732021-04-03 01:20:21 -07001360 protected void onNotSnappingToPageInFreeScroll() { }
Alex Chaub794ea62021-02-03 18:00:30 +00001361
Vinit Nayaka406f722019-12-19 11:50:55 -08001362 protected boolean shouldFlingForVelocity(int velocity) {
Winson Chung4941f652020-06-18 15:11:53 -07001363 float threshold = mAllowEasyFling ? mEasyFlingThresholdVelocity : mFlingThresholdVelocity;
1364 return Math.abs(velocity) > threshold;
Sunny Goyal65d9ceb2017-05-08 09:17:42 -07001365 }
1366
Adam Cohen7d30a372013-07-01 17:03:59 -07001367 private void resetTouchState() {
1368 releaseVelocityTracker();
Sunny Goyalaad33592018-08-07 17:20:35 -07001369 mIsBeingDragged = false;
Adam Cohen7d30a372013-07-01 17:03:59 -07001370 mActivePointerId = INVALID_POINTER;
Adam Cohen7d30a372013-07-01 17:03:59 -07001371 }
1372
Winson Chung185d7162011-02-28 13:47:29 -08001373 @Override
1374 public boolean onGenericMotionEvent(MotionEvent event) {
1375 if ((event.getSource() & InputDevice.SOURCE_CLASS_POINTER) != 0) {
1376 switch (event.getAction()) {
1377 case MotionEvent.ACTION_SCROLL: {
1378 // Handle mouse (or ext. device) by shifting the page depending on the scroll
1379 final float vscroll;
1380 final float hscroll;
1381 if ((event.getMetaState() & KeyEvent.META_SHIFT_ON) != 0) {
1382 vscroll = 0;
1383 hscroll = event.getAxisValue(MotionEvent.AXIS_VSCROLL);
1384 } else {
1385 vscroll = -event.getAxisValue(MotionEvent.AXIS_VSCROLL);
1386 hscroll = event.getAxisValue(MotionEvent.AXIS_HSCROLL);
1387 }
Sunny Goyal8b37c572020-03-31 12:12:14 -07001388 if (!canScroll(Math.abs(vscroll), Math.abs(hscroll))) {
1389 return false;
Samuel Fufa59cba192019-08-22 18:31:34 -07001390 }
Winson Chung185d7162011-02-28 13:47:29 -08001391 if (hscroll != 0 || vscroll != 0) {
Sunny Goyal70660032015-05-14 00:07:08 -07001392 boolean isForwardScroll = mIsRtl ? (hscroll < 0 || vscroll < 0)
Adam Cohen0ffac432013-07-10 11:19:26 -07001393 : (hscroll > 0 || vscroll > 0);
1394 if (isForwardScroll) {
Winson Chung185d7162011-02-28 13:47:29 -08001395 scrollRight();
1396 } else {
1397 scrollLeft();
1398 }
1399 return true;
1400 }
1401 }
1402 }
1403 }
1404 return super.onGenericMotionEvent(event);
1405 }
1406
Sunny Goyal8b37c572020-03-31 12:12:14 -07001407 /**
1408 * Returns true if the paged view can scroll for the provided vertical and horizontal
1409 * scroll values
1410 */
1411 protected boolean canScroll(float absVScroll, float absHScroll) {
1412 ActivityContext ac = ActivityContext.lookupContext(getContext());
1413 return (ac == null || AbstractFloatingView.getTopOpenView(ac) == null);
Samuel Fufa59cba192019-08-22 18:31:34 -07001414 }
1415
Michael Jurkab8f06722010-10-10 15:58:46 -07001416 private void acquireVelocityTrackerAndAddMovement(MotionEvent ev) {
1417 if (mVelocityTracker == null) {
1418 mVelocityTracker = VelocityTracker.obtain();
1419 }
1420 mVelocityTracker.addMovement(ev);
1421 }
1422
1423 private void releaseVelocityTracker() {
1424 if (mVelocityTracker != null) {
Adam Cohenf358a4b2013-07-23 16:47:31 -07001425 mVelocityTracker.clear();
Michael Jurkab8f06722010-10-10 15:58:46 -07001426 mVelocityTracker.recycle();
1427 mVelocityTracker = null;
1428 }
1429 }
1430
Winson Chung321e9ee2010-08-09 13:37:56 -07001431 private void onSecondaryPointerUp(MotionEvent ev) {
Winson Chung4941f652020-06-18 15:11:53 -07001432 final int pointerIndex = ev.getActionIndex();
Winson Chung321e9ee2010-08-09 13:37:56 -07001433 final int pointerId = ev.getPointerId(pointerIndex);
1434 if (pointerId == mActivePointerId) {
1435 // This was our active pointer going up. Choose a new
1436 // active pointer and adjust accordingly.
1437 // TODO: Make this decision more intelligent.
1438 final int newPointerIndex = pointerIndex == 0 ? 1 : 0;
Vinit Nayaka406f722019-12-19 11:50:55 -08001439 mLastMotion = mDownMotionPrimary = mOrientationHandler.getPrimaryDirection(ev,
1440 newPointerIndex);
1441 mLastMotionRemainder = 0;
Winson Chung321e9ee2010-08-09 13:37:56 -07001442 mActivePointerId = ev.getPointerId(newPointerIndex);
1443 if (mVelocityTracker != null) {
1444 mVelocityTracker.clear();
1445 }
1446 }
Jeff Brown1d0867c2010-12-02 18:27:39 -08001447 }
1448
Winson Chung321e9ee2010-08-09 13:37:56 -07001449 @Override
1450 public void requestChildFocus(View child, View focused) {
1451 super.requestChildFocus(child, focused);
Andras Kloczl359d1ae2021-05-04 22:25:27 +02001452
1453 // In case the device is controlled by a controller, mCurrentPage isn't updated properly
1454 // which results in incorrect navigation
1455 int nextPage = getNextPage();
1456 if (nextPage != mCurrentPage) {
1457 setCurrentPage(nextPage);
1458 }
1459
Adam Cohenae4f1552011-10-20 00:15:42 -07001460 int page = indexToPage(indexOfChild(child));
Winson Chung97d85d22011-04-13 11:27:36 -07001461 if (page >= 0 && page != getCurrentPage() && !isInTouchMode()) {
Winson Chung86f77532010-08-24 11:08:22 -07001462 snapToPage(page);
Winson Chung321e9ee2010-08-09 13:37:56 -07001463 }
1464 }
1465
Alex Chaub794ea62021-02-03 18:00:30 +00001466 public int getDestinationPage() {
1467 return getDestinationPage(mOrientationHandler.getPrimaryScroll(this));
1468 }
1469
Alex Chaudedbc8a2021-03-17 16:53:26 +00001470 protected int getDestinationPage(int primaryScroll) {
1471 return getPageNearestToCenterOfScreen(primaryScroll);
Alex Chaub794ea62021-02-03 18:00:30 +00001472 }
1473
Sunny Goyal228153d2018-01-04 15:35:22 -08001474 public int getPageNearestToCenterOfScreen() {
Vinit Nayaka406f722019-12-19 11:50:55 -08001475 return getPageNearestToCenterOfScreen(mOrientationHandler.getPrimaryScroll(this));
Tony Wickham8f7ead32016-04-07 18:46:44 -07001476 }
1477
Alex Chaudedbc8a2021-03-17 16:53:26 +00001478 private int getPageNearestToCenterOfScreen(int primaryScroll) {
1479 int screenCenter = getScreenCenter(primaryScroll);
Adam Cohen22f823d2011-09-01 17:22:18 -07001480 int minDistanceFromScreenCenter = Integer.MAX_VALUE;
Winson Chung321e9ee2010-08-09 13:37:56 -07001481 int minDistanceFromScreenCenterIndex = -1;
Winson Chung321e9ee2010-08-09 13:37:56 -07001482 final int childCount = getChildCount();
1483 for (int i = 0; i < childCount; ++i) {
Tony Wickham7383d4e2020-07-07 19:25:25 -07001484 int distanceFromScreenCenter = Math.abs(
1485 getDisplacementFromScreenCenter(i, screenCenter));
Winson Chung321e9ee2010-08-09 13:37:56 -07001486 if (distanceFromScreenCenter < minDistanceFromScreenCenter) {
1487 minDistanceFromScreenCenter = distanceFromScreenCenter;
1488 minDistanceFromScreenCenterIndex = i;
1489 }
1490 }
Adam Cohend19d3ca2010-09-15 14:43:42 -07001491 return minDistanceFromScreenCenterIndex;
1492 }
1493
Tony Wickham7383d4e2020-07-07 19:25:25 -07001494 private int getDisplacementFromScreenCenter(int childIndex, int screenCenter) {
Alex Chaudedbc8a2021-03-17 16:53:26 +00001495 int childSize = Math.round(getChildVisibleSize(childIndex));
Tony Wickham7383d4e2020-07-07 19:25:25 -07001496 int halfChildSize = (childSize / 2);
1497 int childCenter = getChildOffset(childIndex) + halfChildSize;
1498 return childCenter - screenCenter;
1499 }
1500
1501 protected int getDisplacementFromScreenCenter(int childIndex) {
Alex Chaudedbc8a2021-03-17 16:53:26 +00001502 int primaryScroll = mOrientationHandler.getPrimaryScroll(this);
1503 int screenCenter = getScreenCenter(primaryScroll);
Tony Wickham7383d4e2020-07-07 19:25:25 -07001504 return getDisplacementFromScreenCenter(childIndex, screenCenter);
1505 }
1506
Alex Chaudedbc8a2021-03-17 16:53:26 +00001507 private int getScreenCenter(int primaryScroll) {
1508 float primaryScale = mOrientationHandler.getPrimaryScale(this);
1509 float primaryPivot = mOrientationHandler.getPrimaryValue(getPivotX(), getPivotY());
1510 int pageOrientationSize = mOrientationHandler.getMeasuredSize(this);
1511 return Math.round(primaryScroll + (pageOrientationSize / 2f - primaryPivot) / primaryScale
1512 + primaryPivot);
1513 }
1514
Adam Cohend19d3ca2010-09-15 14:43:42 -07001515 protected void snapToDestination() {
Sunny Goyalc39db732021-04-03 01:20:21 -07001516 snapToPage(getDestinationPage(), PAGE_SNAP_ANIMATION_DURATION);
Winson Chung321e9ee2010-08-09 13:37:56 -07001517 }
1518
Adam Cohene0f66b52010-11-23 15:06:07 -08001519 // We want the duration of the page snap animation to be influenced by the distance that
1520 // the screen has to travel, however, we don't want this duration to be effected in a
1521 // purely linear fashion. Instead, we use this method to moderate the effect that the distance
1522 // of travel has on the overall snap duration.
Sunny Goyal4d113a52015-05-27 10:05:28 -07001523 private float distanceInfluenceForSnapDuration(float f) {
Adam Cohene0f66b52010-11-23 15:06:07 -08001524 f -= 0.5f; // center the values about 0.
1525 f *= 0.3f * Math.PI / 2.0f;
1526 return (float) Math.sin(f);
1527 }
1528
Winson Chung05a31ed2018-02-08 17:08:43 -08001529 protected boolean snapToPageWithVelocity(int whichPage, int velocity) {
Adam Cohen6f127a62014-06-12 14:54:41 -07001530 whichPage = validateNewPage(whichPage);
Vinit Nayaka406f722019-12-19 11:50:55 -08001531 int halfScreenSize = mOrientationHandler.getMeasuredSize(this) / 2;
Adam Cohene0f66b52010-11-23 15:06:07 -08001532
Vinit Nayaka406f722019-12-19 11:50:55 -08001533 final int newLoc = getScrollForPage(whichPage);
Sunny Goyalc39db732021-04-03 01:20:21 -07001534 int delta = newLoc - mOrientationHandler.getPrimaryScroll(this);
Adam Cohene0f66b52010-11-23 15:06:07 -08001535 int duration = 0;
1536
Sunny Goyal4d113a52015-05-27 10:05:28 -07001537 if (Math.abs(velocity) < mMinFlingVelocity) {
Adam Cohene0f66b52010-11-23 15:06:07 -08001538 // If the velocity is low enough, then treat this more as an automatic page advance
1539 // as opposed to an apparent physical response to flinging
Winson Chung05a31ed2018-02-08 17:08:43 -08001540 return snapToPage(whichPage, PAGE_SNAP_ANIMATION_DURATION);
Adam Cohene0f66b52010-11-23 15:06:07 -08001541 }
1542
1543 // Here we compute a "distance" that will be used in the computation of the overall
1544 // snap duration. This is a function of the actual distance that needs to be traveled;
1545 // we keep this value close to half screen size in order to reduce the variance in snap
1546 // duration as a function of the distance the page needs to travel.
Michael Jurka20b7ca92011-06-07 20:09:16 -07001547 float distanceRatio = Math.min(1f, 1.0f * Math.abs(delta) / (2 * halfScreenSize));
Adam Cohene0f66b52010-11-23 15:06:07 -08001548 float distance = halfScreenSize + halfScreenSize *
1549 distanceInfluenceForSnapDuration(distanceRatio);
1550
1551 velocity = Math.abs(velocity);
Adam Cohen265b9a62011-12-07 14:37:18 -08001552 velocity = Math.max(mMinSnapVelocity, velocity);
Adam Cohene0f66b52010-11-23 15:06:07 -08001553
1554 // we want the page's snap velocity to approximately match the velocity at which the
1555 // user flings, so we scale the duration by a value near to the derivative of the scroll
Michael Jurka20b7ca92011-06-07 20:09:16 -07001556 // interpolator at zero, ie. 5. We use 4 to make it a little slower.
1557 duration = 4 * Math.round(1000 * Math.abs(distance / velocity));
Adam Cohene0f66b52010-11-23 15:06:07 -08001558
Sunny Goyalc39db732021-04-03 01:20:21 -07001559 return snapToPage(whichPage, delta, duration);
Michael Jurka0142d492010-08-25 17:46:15 -07001560 }
1561
Winson Chung05a31ed2018-02-08 17:08:43 -08001562 public boolean snapToPage(int whichPage) {
1563 return snapToPage(whichPage, PAGE_SNAP_ANIMATION_DURATION);
Winson Chung321e9ee2010-08-09 13:37:56 -07001564 }
1565
Winson Chung05a31ed2018-02-08 17:08:43 -08001566 public boolean snapToPageImmediately(int whichPage) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001567 return snapToPage(whichPage, PAGE_SNAP_ANIMATION_DURATION, true);
Adam Cohen7d30a372013-07-01 17:03:59 -07001568 }
1569
Winson Chung05a31ed2018-02-08 17:08:43 -08001570 public boolean snapToPage(int whichPage, int duration) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001571 return snapToPage(whichPage, duration, false);
Adam Cohen7d30a372013-07-01 17:03:59 -07001572 }
1573
Sunny Goyalc39db732021-04-03 01:20:21 -07001574 protected boolean snapToPage(int whichPage, int duration, boolean immediate) {
Adam Cohen6f127a62014-06-12 14:54:41 -07001575 whichPage = validateNewPage(whichPage);
Winson Chung321e9ee2010-08-09 13:37:56 -07001576
Vinit Nayaka406f722019-12-19 11:50:55 -08001577 int newLoc = getScrollForPage(whichPage);
Sunny Goyalc39db732021-04-03 01:20:21 -07001578 final int delta = newLoc - mOrientationHandler.getPrimaryScroll(this);
1579 return snapToPage(whichPage, delta, duration, immediate);
Michael Jurka0142d492010-08-25 17:46:15 -07001580 }
1581
Winson Chung05a31ed2018-02-08 17:08:43 -08001582 protected boolean snapToPage(int whichPage, int delta, int duration) {
Sunny Goyalc39db732021-04-03 01:20:21 -07001583 return snapToPage(whichPage, delta, duration, false);
Adam Cohen7d30a372013-07-01 17:03:59 -07001584 }
Michael Jurka0142d492010-08-25 17:46:15 -07001585
Sunny Goyalc39db732021-04-03 01:20:21 -07001586 protected boolean snapToPage(int whichPage, int delta, int duration, boolean immediate) {
Sunny Goyal9bb8ffb2018-05-24 17:11:16 -07001587 if (mFirstLayout) {
1588 setCurrentPage(whichPage);
1589 return false;
1590 }
Tony Wickhamd58c2d52018-05-04 12:10:55 -07001591
Zak Cohen3eeb41d2020-02-14 14:15:13 -08001592 if (FeatureFlags.IS_STUDIO_BUILD) {
Tony Wickhamcb3f8702018-08-27 17:36:03 -07001593 duration *= Settings.Global.getFloat(getContext().getContentResolver(),
1594 Settings.Global.WINDOW_ANIMATION_SCALE, 1);
Tony Wickhamd58c2d52018-05-04 12:10:55 -07001595 }
1596
Adam Cohen6f127a62014-06-12 14:54:41 -07001597 whichPage = validateNewPage(whichPage);
1598
Adam Cohen7d30a372013-07-01 17:03:59 -07001599 mNextPage = whichPage;
Michael Jurka0142d492010-08-25 17:46:15 -07001600
Winson Chung321e9ee2010-08-09 13:37:56 -07001601 awakenScrollBars(duration);
Adam Cohen7d30a372013-07-01 17:03:59 -07001602 if (immediate) {
1603 duration = 0;
1604 } else if (duration == 0) {
Winson Chung321e9ee2010-08-09 13:37:56 -07001605 duration = Math.abs(delta);
1606 }
1607
Sunny Goyal9ccafbf2016-10-26 13:06:08 -07001608 if (duration != 0) {
1609 pageBeginTransition();
1610 }
1611
Adam Cohenf358a4b2013-07-23 16:47:31 -07001612 if (!mScroller.isFinished()) {
Adam Cohenf9618852013-11-08 06:45:03 -08001613 abortScrollerAnimation(false);
Adam Cohenf358a4b2013-07-23 16:47:31 -07001614 }
Adam Cohenf9618852013-11-08 06:45:03 -08001615
Sunny Goyalc39db732021-04-03 01:20:21 -07001616 mScroller.startScroll(mOrientationHandler.getPrimaryScroll(this), 0, delta, 0, duration);
Adam Cohen674531f2013-12-13 15:07:14 -08001617 updatePageIndicator();
Adam Cohen7d30a372013-07-01 17:03:59 -07001618
1619 // Trigger a compute() to finish switching pages if necessary
1620 if (immediate) {
1621 computeScroll();
Sunny Goyal76dbf6f2017-01-03 14:55:47 -08001622 pageEndTransition();
Adam Cohen7d30a372013-07-01 17:03:59 -07001623 }
1624
Winson Chung321e9ee2010-08-09 13:37:56 -07001625 invalidate();
Winson Chung05a31ed2018-02-08 17:08:43 -08001626 return Math.abs(delta) > 0;
Winson Chung321e9ee2010-08-09 13:37:56 -07001627 }
1628
Vadim Tryshev98913d02018-05-18 18:41:34 -07001629 public boolean scrollLeft() {
1630 if (getNextPage() > 0) {
1631 snapToPage(getNextPage() - 1);
1632 return true;
1633 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001634 return mAllowOverScroll;
Winson Chung321e9ee2010-08-09 13:37:56 -07001635 }
1636
Vadim Tryshev98913d02018-05-18 18:41:34 -07001637 public boolean scrollRight() {
1638 if (getNextPage() < getChildCount() - 1) {
1639 snapToPage(getNextPage() + 1);
1640 return true;
1641 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001642 return mAllowOverScroll;
Winson Chung321e9ee2010-08-09 13:37:56 -07001643 }
1644
Vadim Trysheve6bbefb2018-04-03 13:38:06 -07001645 @Override
1646 public CharSequence getAccessibilityClassName() {
1647 // Some accessibility services have special logic for ScrollView. Since we provide same
1648 // accessibility info as ScrollView, inform the service to handle use the same way.
1649 return ScrollView.class.getName();
1650 }
1651
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001652 protected boolean isPageOrderFlipped() {
1653 return false;
1654 }
1655
Winson Chung6a0f57d2011-06-29 20:10:49 -07001656 /* Accessibility */
Sunny Goyalcf25b522015-07-09 00:01:18 -07001657 @SuppressWarnings("deprecation")
Winson Chung6a0f57d2011-06-29 20:10:49 -07001658 @Override
1659 public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) {
1660 super.onInitializeAccessibilityNodeInfo(info);
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001661 final boolean pagesFlipped = isPageOrderFlipped();
Pinyao Tingaf6daa22019-09-18 22:18:03 +00001662 int offset = (mAllowOverScroll ? 0 : 1);
1663 info.setScrollable(getPageCount() > offset);
1664 if (getCurrentPage() < getPageCount() - offset) {
yingleiw02cc8482019-08-02 16:14:27 -07001665 info.addAction(pagesFlipped ?
1666 AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_BACKWARD
1667 : AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_FORWARD);
1668 info.addAction(mIsRtl ?
1669 AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_LEFT
1670 : AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_RIGHT);
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001671 }
Pinyao Tingaf6daa22019-09-18 22:18:03 +00001672 if (getCurrentPage() >= offset) {
yingleiw02cc8482019-08-02 16:14:27 -07001673 info.addAction(pagesFlipped ?
1674 AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_FORWARD
1675 : AccessibilityNodeInfo.AccessibilityAction.ACTION_SCROLL_BACKWARD);
1676 info.addAction(mIsRtl ?
1677 AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_RIGHT
1678 : AccessibilityNodeInfo.AccessibilityAction.ACTION_PAGE_LEFT);
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001679 }
Vadim Tryshev7af0d442015-05-15 08:48:11 -07001680 // Accessibility-wise, PagedView doesn't support long click, so disabling it.
1681 // Besides disabling the accessibility long-click, this also prevents this view from getting
1682 // accessibility focus.
1683 info.setLongClickable(false);
Sunny Goyala52ecb02016-12-16 15:04:51 -08001684 info.removeAction(AccessibilityNodeInfo.AccessibilityAction.ACTION_LONG_CLICK);
Winson Chung6a0f57d2011-06-29 20:10:49 -07001685 }
1686
1687 @Override
Alan Viverette254139a2013-10-08 13:13:46 -07001688 public void sendAccessibilityEvent(int eventType) {
1689 // Don't let the view send real scroll events.
1690 if (eventType != AccessibilityEvent.TYPE_VIEW_SCROLLED) {
1691 super.sendAccessibilityEvent(eventType);
1692 }
1693 }
1694
1695 @Override
Winson Chung6a0f57d2011-06-29 20:10:49 -07001696 public void onInitializeAccessibilityEvent(AccessibilityEvent event) {
1697 super.onInitializeAccessibilityEvent(event);
Pinyao Tingaf6daa22019-09-18 22:18:03 +00001698 event.setScrollable(mAllowOverScroll || getPageCount() > 1);
Winson Chung6a0f57d2011-06-29 20:10:49 -07001699 }
1700
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001701 @Override
1702 public boolean performAccessibilityAction(int action, Bundle arguments) {
1703 if (super.performAccessibilityAction(action, arguments)) {
1704 return true;
1705 }
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001706 final boolean pagesFlipped = isPageOrderFlipped();
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001707 switch (action) {
1708 case AccessibilityNodeInfo.ACTION_SCROLL_FORWARD: {
Vadim Tryshev98913d02018-05-18 18:41:34 -07001709 if (pagesFlipped ? scrollLeft() : scrollRight()) {
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001710 return true;
1711 }
1712 } break;
1713 case AccessibilityNodeInfo.ACTION_SCROLL_BACKWARD: {
Vadim Tryshev98913d02018-05-18 18:41:34 -07001714 if (pagesFlipped ? scrollRight() : scrollLeft()) {
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001715 return true;
1716 }
yingleiw02cc8482019-08-02 16:14:27 -07001717 } break;
1718 case android.R.id.accessibilityActionPageRight: {
1719 if (!mIsRtl) {
1720 return scrollRight();
1721 } else {
1722 return scrollLeft();
1723 }
Vadim Tryshev0fc07132018-05-04 12:08:54 -07001724 }
yingleiw02cc8482019-08-02 16:14:27 -07001725 case android.R.id.accessibilityActionPageLeft: {
1726 if (!mIsRtl) {
1727 return scrollLeft();
1728 } else {
1729 return scrollRight();
1730 }
1731 }
Svetoslav Ganov08055f62012-05-15 11:06:36 -07001732 }
1733 return false;
1734 }
1735
Vadim Tryshev2c430b32018-04-04 14:45:21 -07001736 protected boolean canAnnouncePageDescription() {
1737 return true;
1738 }
1739
Adam Cohen0ffac432013-07-10 11:19:26 -07001740 protected String getCurrentPageDescription() {
Sunny Goyalf4f89ef2015-09-02 15:06:12 -07001741 return getContext().getString(R.string.default_scroll_format,
Adam Cohen0ffac432013-07-10 11:19:26 -07001742 getNextPage() + 1, getChildCount());
1743 }
1744
Tony Mak2e564402018-02-27 17:19:34 +00001745 protected float getDownMotionX() {
1746 return mDownMotionX;
1747 }
1748
1749 protected float getDownMotionY() {
1750 return mDownMotionY;
1751 }
1752
Sunny Goyal20a13ff2018-03-13 16:44:00 -07001753 protected interface ComputePageScrollsLogic {
1754
1755 boolean shouldIncludeView(View view);
1756 }
Vadim Tryshev528b9e02018-05-24 18:22:03 -07001757
1758 public int[] getVisibleChildrenRange() {
1759 float visibleLeft = 0;
1760 float visibleRight = visibleLeft + getMeasuredWidth();
1761 float scaleX = getScaleX();
1762 if (scaleX < 1 && scaleX > 0) {
1763 float mid = getMeasuredWidth() / 2;
1764 visibleLeft = mid - ((mid - visibleLeft) / scaleX);
1765 visibleRight = mid + ((visibleRight - mid) / scaleX);
1766 }
1767
1768 int leftChild = -1;
1769 int rightChild = -1;
1770 final int childCount = getChildCount();
1771 for (int i = 0; i < childCount; i++) {
1772 final View child = getPageAt(i);
1773
1774 float left = child.getLeft() + child.getTranslationX() - getScrollX();
1775 if (left <= visibleRight && (left + child.getMeasuredWidth()) >= visibleLeft) {
1776 if (leftChild == -1) {
1777 leftChild = i;
1778 }
1779 rightChild = i;
1780 }
1781 }
1782 mTmpIntPair[0] = leftChild;
1783 mTmpIntPair[1] = rightChild;
1784 return mTmpIntPair;
1785 }
Sunny Goyalc39db732021-04-03 01:20:21 -07001786
1787 @Override
1788 public void draw(Canvas canvas) {
1789 super.draw(canvas);
1790 drawEdgeEffect(canvas);
Sunny Goyal05b59c02021-04-29 13:55:40 -07001791 pageEndTransition();
Sunny Goyalc39db732021-04-03 01:20:21 -07001792 }
1793
1794 protected void drawEdgeEffect(Canvas canvas) {
1795 if (mAllowOverScroll && (!mEdgeGlowRight.isFinished() || !mEdgeGlowLeft.isFinished())) {
1796 final int width = getWidth();
1797 final int height = getHeight();
1798 if (!mEdgeGlowLeft.isFinished()) {
1799 final int restoreCount = canvas.save();
1800 canvas.rotate(-90);
1801 canvas.translate(-height, Math.min(mMinScroll, getScrollX()));
1802 mEdgeGlowLeft.setSize(height, width);
1803 if (mEdgeGlowLeft.draw(canvas)) {
1804 postInvalidateOnAnimation();
1805 }
1806 canvas.restoreToCount(restoreCount);
1807 }
1808 if (!mEdgeGlowRight.isFinished()) {
1809 final int restoreCount = canvas.save();
1810 canvas.rotate(90, width, 0);
1811 canvas.translate(width, -(Math.max(mMaxScroll, getScrollX())));
1812
1813 mEdgeGlowRight.setSize(height, width);
1814 if (mEdgeGlowRight.draw(canvas)) {
1815 postInvalidateOnAnimation();
1816 }
1817 canvas.restoreToCount(restoreCount);
1818 }
1819 }
1820 }
Adam Cohen5084cba2013-09-03 12:01:16 -07001821}