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