Winson Chung | 9480415 | 2015-05-08 13:06:44 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2015 The Android Open Source Project |
| 3 | * |
| 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 | |
| 17 | package com.android.launcher3; |
| 18 | |
| 19 | import android.content.Context; |
Winson Chung | 9480415 | 2015-05-08 13:06:44 -0700 | [diff] [blame] | 20 | import android.util.AttributeSet; |
vadimt | ac752e3 | 2020-03-24 17:58:03 -0700 | [diff] [blame] | 21 | import android.util.Log; |
Winson Chung | 9480415 | 2015-05-08 13:06:44 -0700 | [diff] [blame] | 22 | import android.view.MotionEvent; |
Sunny Goyal | f1fbc3f | 2017-10-10 15:21:15 -0700 | [diff] [blame] | 23 | import android.view.View; |
Sunny Goyal | 5d9fb0e | 2016-10-08 17:43:48 -0700 | [diff] [blame] | 24 | import android.view.ViewGroup; |
| 25 | |
Samuel Fufa | f5a4deb | 2020-03-04 16:24:06 -0800 | [diff] [blame] | 26 | import androidx.recyclerview.widget.RecyclerView; |
| 27 | |
vadimt | 758a1d9 | 2019-09-04 12:08:27 -0700 | [diff] [blame] | 28 | import com.android.launcher3.compat.AccessibilityManagerCompat; |
vadimt | ac752e3 | 2020-03-24 17:58:03 -0700 | [diff] [blame] | 29 | import com.android.launcher3.testing.TestProtocol; |
Sunny Goyal | 89d5c5a | 2017-06-23 16:12:50 -0700 | [diff] [blame] | 30 | import com.android.launcher3.views.RecyclerViewFastScroller; |
Winson Chung | 9480415 | 2015-05-08 13:06:44 -0700 | [diff] [blame] | 31 | |
Winson Chung | b177744 | 2015-06-16 13:35:04 -0700 | [diff] [blame] | 32 | |
Winson Chung | 9480415 | 2015-05-08 13:06:44 -0700 | [diff] [blame] | 33 | /** |
Hyunyoung Song | ac5f6af | 2015-05-29 12:00:44 -0700 | [diff] [blame] | 34 | * A base {@link RecyclerView}, which does the following: |
| 35 | * <ul> |
| 36 | * <li> NOT intercept a touch unless the scrolling velocity is below a predefined threshold. |
| 37 | * <li> Enable fast scroller. |
| 38 | * </ul> |
Winson Chung | 9480415 | 2015-05-08 13:06:44 -0700 | [diff] [blame] | 39 | */ |
Sunny Goyal | 3661bfa | 2018-03-01 16:29:15 -0800 | [diff] [blame] | 40 | public abstract class BaseRecyclerView extends RecyclerView { |
Winson Chung | 9480415 | 2015-05-08 13:06:44 -0700 | [diff] [blame] | 41 | |
Sunny Goyal | 89d5c5a | 2017-06-23 16:12:50 -0700 | [diff] [blame] | 42 | protected RecyclerViewFastScroller mScrollbar; |
Sunny Goyal | 9e4c359 | 2017-06-07 14:05:08 -0700 | [diff] [blame] | 43 | |
Winson Chung | 5f4e0fd | 2015-05-22 11:12:27 -0700 | [diff] [blame] | 44 | public BaseRecyclerView(Context context) { |
Winson Chung | 9480415 | 2015-05-08 13:06:44 -0700 | [diff] [blame] | 45 | this(context, null); |
| 46 | } |
| 47 | |
Winson Chung | 5f4e0fd | 2015-05-22 11:12:27 -0700 | [diff] [blame] | 48 | public BaseRecyclerView(Context context, AttributeSet attrs) { |
Winson Chung | 9480415 | 2015-05-08 13:06:44 -0700 | [diff] [blame] | 49 | this(context, attrs, 0); |
| 50 | } |
| 51 | |
Winson Chung | 5f4e0fd | 2015-05-22 11:12:27 -0700 | [diff] [blame] | 52 | public BaseRecyclerView(Context context, AttributeSet attrs, int defStyleAttr) { |
Winson Chung | 9480415 | 2015-05-08 13:06:44 -0700 | [diff] [blame] | 53 | super(context, attrs, defStyleAttr); |
Winson Chung | 9480415 | 2015-05-08 13:06:44 -0700 | [diff] [blame] | 54 | } |
| 55 | |
Winson Chung | 9480415 | 2015-05-08 13:06:44 -0700 | [diff] [blame] | 56 | @Override |
Sunny Goyal | 5d9fb0e | 2016-10-08 17:43:48 -0700 | [diff] [blame] | 57 | protected void onAttachedToWindow() { |
| 58 | super.onAttachedToWindow(); |
Mario Bertschler | ac9408a | 2017-10-18 10:31:36 -0700 | [diff] [blame] | 59 | bindFastScrollbar(); |
| 60 | } |
| 61 | |
| 62 | public void bindFastScrollbar() { |
| 63 | ViewGroup parent = (ViewGroup) getParent().getParent(); |
Sunny Goyal | 89d5c5a | 2017-06-23 16:12:50 -0700 | [diff] [blame] | 64 | mScrollbar = parent.findViewById(R.id.fast_scroller); |
Mario Bertschler | ac9408a | 2017-10-18 10:31:36 -0700 | [diff] [blame] | 65 | mScrollbar.setRecyclerView(this, parent.findViewById(R.id.fast_scroller_popup)); |
Mario Bertschler | 2d3157a | 2017-11-27 13:10:44 -0800 | [diff] [blame] | 66 | onUpdateScrollbar(0); |
Sunny Goyal | 5d9fb0e | 2016-10-08 17:43:48 -0700 | [diff] [blame] | 67 | } |
| 68 | |
Sunny Goyal | 3661bfa | 2018-03-01 16:29:15 -0800 | [diff] [blame] | 69 | public RecyclerViewFastScroller getScrollbar() { |
| 70 | return mScrollbar; |
Winson Chung | 9480415 | 2015-05-08 13:06:44 -0700 | [diff] [blame] | 71 | } |
| 72 | |
Sunny Goyal | f1fbc3f | 2017-10-10 15:21:15 -0700 | [diff] [blame] | 73 | public int getScrollBarTop() { |
| 74 | return getPaddingTop(); |
| 75 | } |
| 76 | |
Winson Chung | 9480415 | 2015-05-08 13:06:44 -0700 | [diff] [blame] | 77 | /** |
Sunny Goyal | 00e1068 | 2016-10-18 14:23:46 +0100 | [diff] [blame] | 78 | * Returns the height of the fast scroll bar |
Winson | c088049 | 2015-08-21 11:16:27 -0700 | [diff] [blame] | 79 | */ |
Sunny Goyal | 89d5c5a | 2017-06-23 16:12:50 -0700 | [diff] [blame] | 80 | public int getScrollbarTrackHeight() { |
Mario Bertschler | 2d3157a | 2017-11-27 13:10:44 -0800 | [diff] [blame] | 81 | return mScrollbar.getHeight() - getScrollBarTop() - getPaddingBottom(); |
Winson | c088049 | 2015-08-21 11:16:27 -0700 | [diff] [blame] | 82 | } |
| 83 | |
| 84 | /** |
Winson Chung | b177744 | 2015-06-16 13:35:04 -0700 | [diff] [blame] | 85 | * Returns the available scroll height: |
| 86 | * AvailableScrollHeight = Total height of the all items - last page height |
Winson Chung | b177744 | 2015-06-16 13:35:04 -0700 | [diff] [blame] | 87 | */ |
Winson | b655b88 | 2016-07-11 18:59:18 -0700 | [diff] [blame] | 88 | protected abstract int getAvailableScrollHeight(); |
Winson Chung | b177744 | 2015-06-16 13:35:04 -0700 | [diff] [blame] | 89 | |
| 90 | /** |
| 91 | * Returns the available scroll bar height: |
| 92 | * AvailableScrollBarHeight = Total height of the visible view - thumb height |
| 93 | */ |
| 94 | protected int getAvailableScrollBarHeight() { |
Sunny Goyal | 00e1068 | 2016-10-18 14:23:46 +0100 | [diff] [blame] | 95 | int availableScrollBarHeight = getScrollbarTrackHeight() - mScrollbar.getThumbHeight(); |
Winson Chung | b177744 | 2015-06-16 13:35:04 -0700 | [diff] [blame] | 96 | return availableScrollBarHeight; |
| 97 | } |
| 98 | |
Hyunyoung Song | ac5f6af | 2015-05-29 12:00:44 -0700 | [diff] [blame] | 99 | /** |
Winson Chung | b177744 | 2015-06-16 13:35:04 -0700 | [diff] [blame] | 100 | * Updates the scrollbar thumb offset to match the visible scroll of the recycler view. It does |
| 101 | * this by mapping the available scroll area of the recycler view to the available space for the |
| 102 | * scroll bar. |
| 103 | * |
Winson | b655b88 | 2016-07-11 18:59:18 -0700 | [diff] [blame] | 104 | * @param scrollY the current scroll y |
Hyunyoung Song | ac5f6af | 2015-05-29 12:00:44 -0700 | [diff] [blame] | 105 | */ |
Winson | b655b88 | 2016-07-11 18:59:18 -0700 | [diff] [blame] | 106 | protected void synchronizeScrollBarThumbOffsetToViewScroll(int scrollY, |
| 107 | int availableScrollHeight) { |
Winson Chung | b177744 | 2015-06-16 13:35:04 -0700 | [diff] [blame] | 108 | // Only show the scrollbar if there is height to be scrolled |
| 109 | if (availableScrollHeight <= 0) { |
Sunny Goyal | 5d9fb0e | 2016-10-08 17:43:48 -0700 | [diff] [blame] | 110 | mScrollbar.setThumbOffsetY(-1); |
Winson Chung | b177744 | 2015-06-16 13:35:04 -0700 | [diff] [blame] | 111 | return; |
Hyunyoung Song | ac5f6af | 2015-05-29 12:00:44 -0700 | [diff] [blame] | 112 | } |
Hyunyoung Song | ac5f6af | 2015-05-29 12:00:44 -0700 | [diff] [blame] | 113 | |
Winson Chung | b177744 | 2015-06-16 13:35:04 -0700 | [diff] [blame] | 114 | // Calculate the current scroll position, the scrollY of the recycler view accounts for the |
| 115 | // view padding, while the scrollBarY is drawn right up to the background padding (ignoring |
| 116 | // padding) |
Sunny Goyal | 00e1068 | 2016-10-18 14:23:46 +0100 | [diff] [blame] | 117 | int scrollBarY = |
| 118 | (int) (((float) scrollY / availableScrollHeight) * getAvailableScrollBarHeight()); |
Hyunyoung Song | ac5f6af | 2015-05-29 12:00:44 -0700 | [diff] [blame] | 119 | |
Winson Chung | b177744 | 2015-06-16 13:35:04 -0700 | [diff] [blame] | 120 | // Calculate the position and size of the scroll bar |
Sunny Goyal | 5d9fb0e | 2016-10-08 17:43:48 -0700 | [diff] [blame] | 121 | mScrollbar.setThumbOffsetY(scrollBarY); |
Winson Chung | 4b9f979 | 2015-06-12 18:02:52 -0700 | [diff] [blame] | 122 | } |
| 123 | |
| 124 | /** |
Sunny Goyal | f1fbc3f | 2017-10-10 15:21:15 -0700 | [diff] [blame] | 125 | * Returns whether the view itself will handle the touch event or not. |
| 126 | * @param ev MotionEvent in {@param eventSource} |
| 127 | */ |
| 128 | public boolean shouldContainerScroll(MotionEvent ev, View eventSource) { |
Sunny Goyal | ae6e318 | 2019-04-30 12:04:37 -0700 | [diff] [blame] | 129 | float[] point = new float[2]; |
| 130 | point[0] = ev.getX(); |
| 131 | point[1] = ev.getY(); |
Sunny Goyal | f1fbc3f | 2017-10-10 15:21:15 -0700 | [diff] [blame] | 132 | Utilities.mapCoordInSelfToDescendant(mScrollbar, eventSource, point); |
| 133 | // IF the MotionEvent is inside the thumb, container should not be pulled down. |
Sunny Goyal | ae6e318 | 2019-04-30 12:04:37 -0700 | [diff] [blame] | 134 | if (mScrollbar.shouldBlockIntercept((int) point[0], (int) point[1])) { |
Sunny Goyal | f1fbc3f | 2017-10-10 15:21:15 -0700 | [diff] [blame] | 135 | return false; |
| 136 | } |
| 137 | |
| 138 | // IF scroller is at the very top OR there is no scroll bar because there is probably not |
| 139 | // enough items to scroll, THEN it's okay for the container to be pulled down. |
| 140 | if (getCurrentScrollY() == 0) { |
| 141 | return true; |
| 142 | } |
Samuel Fufa | f5a4deb | 2020-03-04 16:24:06 -0800 | [diff] [blame] | 143 | return getAdapter() == null || getAdapter().getItemCount() == 0; |
Sunny Goyal | f1fbc3f | 2017-10-10 15:21:15 -0700 | [diff] [blame] | 144 | } |
| 145 | |
| 146 | /** |
Winson | c088049 | 2015-08-21 11:16:27 -0700 | [diff] [blame] | 147 | * @return whether fast scrolling is supported in the current state. |
Winson | 646c236 | 2015-09-03 11:46:11 -0700 | [diff] [blame] | 148 | */ |
Sunny Goyal | 89d5c5a | 2017-06-23 16:12:50 -0700 | [diff] [blame] | 149 | public boolean supportsFastScrolling() { |
Winson | 646c236 | 2015-09-03 11:46:11 -0700 | [diff] [blame] | 150 | return true; |
| 151 | } |
| 152 | |
| 153 | /** |
Hyunyoung Song | ac5f6af | 2015-05-29 12:00:44 -0700 | [diff] [blame] | 154 | * Maps the touch (from 0..1) to the adapter position that should be visible. |
| 155 | * <p>Override in each subclass of this base class. |
Winson | c088049 | 2015-08-21 11:16:27 -0700 | [diff] [blame] | 156 | * |
| 157 | * @return the scroll top of this recycler view. |
Hyunyoung Song | ac5f6af | 2015-05-29 12:00:44 -0700 | [diff] [blame] | 158 | */ |
Peter Schiller | 2e22b5d | 2016-07-12 12:45:10 -0700 | [diff] [blame] | 159 | public abstract int getCurrentScrollY(); |
Winson | c088049 | 2015-08-21 11:16:27 -0700 | [diff] [blame] | 160 | |
| 161 | /** |
| 162 | * Maps the touch (from 0..1) to the adapter position that should be visible. |
| 163 | * <p>Override in each subclass of this base class. |
| 164 | */ |
Sunny Goyal | 89d5c5a | 2017-06-23 16:12:50 -0700 | [diff] [blame] | 165 | public abstract String scrollToPositionAtProgress(float touchFraction); |
Hyunyoung Song | ac5f6af | 2015-05-29 12:00:44 -0700 | [diff] [blame] | 166 | |
| 167 | /** |
| 168 | * Updates the bounds for the scrollbar. |
| 169 | * <p>Override in each subclass of this base class. |
| 170 | */ |
Sunny Goyal | 89d5c5a | 2017-06-23 16:12:50 -0700 | [diff] [blame] | 171 | public abstract void onUpdateScrollbar(int dy); |
Hyunyoung Song | ac5f6af | 2015-05-29 12:00:44 -0700 | [diff] [blame] | 172 | |
| 173 | /** |
Winson Chung | b177744 | 2015-06-16 13:35:04 -0700 | [diff] [blame] | 174 | * <p>Override in each subclass of this base class. |
Hyunyoung Song | ac5f6af | 2015-05-29 12:00:44 -0700 | [diff] [blame] | 175 | */ |
Sunny Goyal | 89d5c5a | 2017-06-23 16:12:50 -0700 | [diff] [blame] | 176 | public void onFastScrollCompleted() {} |
vadimt | 758a1d9 | 2019-09-04 12:08:27 -0700 | [diff] [blame] | 177 | |
| 178 | @Override |
| 179 | public void onScrollStateChanged(int state) { |
| 180 | super.onScrollStateChanged(state); |
| 181 | |
vadimt | ac752e3 | 2020-03-24 17:58:03 -0700 | [diff] [blame] | 182 | if (TestProtocol.sDebugTracing) { |
| 183 | Log.d(TestProtocol.NO_SCROLL_END_WIDGETS, "onScrollStateChanged: " + state); |
| 184 | } |
| 185 | |
vadimt | 758a1d9 | 2019-09-04 12:08:27 -0700 | [diff] [blame] | 186 | if (state == SCROLL_STATE_IDLE) { |
| 187 | AccessibilityManagerCompat.sendScrollFinishedEventToTest(getContext()); |
| 188 | } |
| 189 | } |
Winson Chung | 9480415 | 2015-05-08 13:06:44 -0700 | [diff] [blame] | 190 | } |