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; |
Hyunyoung Song | ac5f6af | 2015-05-29 12:00:44 -0700 | [diff] [blame] | 20 | import android.graphics.Canvas; |
Winson Chung | 9480415 | 2015-05-08 13:06:44 -0700 | [diff] [blame] | 21 | import android.support.v7.widget.RecyclerView; |
| 22 | import android.util.AttributeSet; |
| 23 | import android.view.MotionEvent; |
Sunny Goyal | 5d9fb0e | 2016-10-08 17:43:48 -0700 | [diff] [blame] | 24 | import android.view.ViewGroup; |
Sunny Goyal | 89d5c5a | 2017-06-23 16:12:50 -0700 | [diff] [blame] | 25 | import android.widget.TextView; |
Sunny Goyal | 5d9fb0e | 2016-10-08 17:43:48 -0700 | [diff] [blame] | 26 | |
Sunny Goyal | 89d5c5a | 2017-06-23 16:12:50 -0700 | [diff] [blame] | 27 | import com.android.launcher3.views.RecyclerViewFastScroller; |
Winson Chung | 9480415 | 2015-05-08 13:06:44 -0700 | [diff] [blame] | 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 | */ |
Winson Chung | b177744 | 2015-06-16 13:35:04 -0700 | [diff] [blame] | 37 | public abstract class BaseRecyclerView extends RecyclerView |
Winson Chung | 9480415 | 2015-05-08 13:06:44 -0700 | [diff] [blame] | 38 | implements RecyclerView.OnItemTouchListener { |
| 39 | |
Sunny Goyal | 89d5c5a | 2017-06-23 16:12:50 -0700 | [diff] [blame] | 40 | protected RecyclerViewFastScroller mScrollbar; |
Sunny Goyal | 9e4c359 | 2017-06-07 14:05:08 -0700 | [diff] [blame] | 41 | |
Winson Chung | 5f4e0fd | 2015-05-22 11:12:27 -0700 | [diff] [blame] | 42 | public BaseRecyclerView(Context context) { |
Winson Chung | 9480415 | 2015-05-08 13:06:44 -0700 | [diff] [blame] | 43 | this(context, null); |
| 44 | } |
| 45 | |
Winson Chung | 5f4e0fd | 2015-05-22 11:12:27 -0700 | [diff] [blame] | 46 | public BaseRecyclerView(Context context, AttributeSet attrs) { |
Winson Chung | 9480415 | 2015-05-08 13:06:44 -0700 | [diff] [blame] | 47 | this(context, attrs, 0); |
| 48 | } |
| 49 | |
Winson Chung | 5f4e0fd | 2015-05-22 11:12:27 -0700 | [diff] [blame] | 50 | public BaseRecyclerView(Context context, AttributeSet attrs, int defStyleAttr) { |
Winson Chung | 9480415 | 2015-05-08 13:06:44 -0700 | [diff] [blame] | 51 | super(context, attrs, defStyleAttr); |
Winson Chung | 9480415 | 2015-05-08 13:06:44 -0700 | [diff] [blame] | 52 | } |
| 53 | |
Winson Chung | 9480415 | 2015-05-08 13:06:44 -0700 | [diff] [blame] | 54 | @Override |
| 55 | protected void onFinishInflate() { |
| 56 | super.onFinishInflate(); |
| 57 | addOnItemTouchListener(this); |
| 58 | } |
| 59 | |
Sunny Goyal | 5d9fb0e | 2016-10-08 17:43:48 -0700 | [diff] [blame] | 60 | @Override |
| 61 | protected void onAttachedToWindow() { |
| 62 | super.onAttachedToWindow(); |
Sunny Goyal | 89d5c5a | 2017-06-23 16:12:50 -0700 | [diff] [blame] | 63 | ViewGroup parent = (ViewGroup) getParent(); |
| 64 | mScrollbar = parent.findViewById(R.id.fast_scroller); |
| 65 | mScrollbar.setRecyclerView(this, (TextView) parent.findViewById(R.id.fast_scroller_popup)); |
Sunny Goyal | 5d9fb0e | 2016-10-08 17:43:48 -0700 | [diff] [blame] | 66 | } |
| 67 | |
Hyunyoung Song | ac5f6af | 2015-05-29 12:00:44 -0700 | [diff] [blame] | 68 | /** |
| 69 | * We intercept the touch handling only to support fast scrolling when initiated from the |
| 70 | * scroll bar. Otherwise, we fall back to the default RecyclerView touch handling. |
| 71 | */ |
Winson Chung | 9480415 | 2015-05-08 13:06:44 -0700 | [diff] [blame] | 72 | @Override |
| 73 | public boolean onInterceptTouchEvent(RecyclerView rv, MotionEvent ev) { |
Hyunyoung Song | ac5f6af | 2015-05-29 12:00:44 -0700 | [diff] [blame] | 74 | return handleTouchEvent(ev); |
Winson Chung | 9480415 | 2015-05-08 13:06:44 -0700 | [diff] [blame] | 75 | } |
| 76 | |
| 77 | @Override |
| 78 | public void onTouchEvent(RecyclerView rv, MotionEvent ev) { |
Hyunyoung Song | ac5f6af | 2015-05-29 12:00:44 -0700 | [diff] [blame] | 79 | handleTouchEvent(ev); |
| 80 | } |
| 81 | |
| 82 | /** |
| 83 | * Handles the touch event and determines whether to show the fast scroller (or updates it if |
| 84 | * it is already showing). |
| 85 | */ |
| 86 | private boolean handleTouchEvent(MotionEvent ev) { |
Sunny Goyal | 89d5c5a | 2017-06-23 16:12:50 -0700 | [diff] [blame] | 87 | // Move to mScrollbar's coordinate system. |
| 88 | int left = getLeft() - mScrollbar.getLeft(); |
| 89 | int top = getTop() - mScrollbar.getTop(); |
| 90 | ev.offsetLocation(left, top); |
| 91 | try { |
| 92 | return mScrollbar.handleTouchEvent(ev); |
| 93 | } finally { |
| 94 | ev.offsetLocation(-left, -top); |
Hyunyoung Song | ac5f6af | 2015-05-29 12:00:44 -0700 | [diff] [blame] | 95 | } |
Winson Chung | 9480415 | 2015-05-08 13:06:44 -0700 | [diff] [blame] | 96 | } |
| 97 | |
| 98 | public void onRequestDisallowInterceptTouchEvent(boolean disallowIntercept) { |
| 99 | // DO NOT REMOVE, NEEDED IMPLEMENTATION FOR M BUILDS |
| 100 | } |
| 101 | |
| 102 | /** |
Sunny Goyal | 00e1068 | 2016-10-18 14:23:46 +0100 | [diff] [blame] | 103 | * Returns the height of the fast scroll bar |
Winson | c088049 | 2015-08-21 11:16:27 -0700 | [diff] [blame] | 104 | */ |
Sunny Goyal | 89d5c5a | 2017-06-23 16:12:50 -0700 | [diff] [blame] | 105 | public int getScrollbarTrackHeight() { |
Sunny Goyal | dc19a07 | 2017-05-12 08:17:35 -0700 | [diff] [blame] | 106 | return getHeight() - getPaddingTop() - getPaddingBottom(); |
Winson | c088049 | 2015-08-21 11:16:27 -0700 | [diff] [blame] | 107 | } |
| 108 | |
| 109 | /** |
Winson Chung | b177744 | 2015-06-16 13:35:04 -0700 | [diff] [blame] | 110 | * Returns the available scroll height: |
| 111 | * AvailableScrollHeight = Total height of the all items - last page height |
Winson Chung | b177744 | 2015-06-16 13:35:04 -0700 | [diff] [blame] | 112 | */ |
Winson | b655b88 | 2016-07-11 18:59:18 -0700 | [diff] [blame] | 113 | protected abstract int getAvailableScrollHeight(); |
Winson Chung | b177744 | 2015-06-16 13:35:04 -0700 | [diff] [blame] | 114 | |
| 115 | /** |
| 116 | * Returns the available scroll bar height: |
| 117 | * AvailableScrollBarHeight = Total height of the visible view - thumb height |
| 118 | */ |
| 119 | protected int getAvailableScrollBarHeight() { |
Sunny Goyal | 00e1068 | 2016-10-18 14:23:46 +0100 | [diff] [blame] | 120 | int availableScrollBarHeight = getScrollbarTrackHeight() - mScrollbar.getThumbHeight(); |
Winson Chung | b177744 | 2015-06-16 13:35:04 -0700 | [diff] [blame] | 121 | return availableScrollBarHeight; |
| 122 | } |
| 123 | |
| 124 | /** |
Winson | c088049 | 2015-08-21 11:16:27 -0700 | [diff] [blame] | 125 | * Returns the scrollbar for this recycler view. |
| 126 | */ |
Sunny Goyal | 89d5c5a | 2017-06-23 16:12:50 -0700 | [diff] [blame] | 127 | public RecyclerViewFastScroller getScrollBar() { |
Winson | c088049 | 2015-08-21 11:16:27 -0700 | [diff] [blame] | 128 | return mScrollbar; |
| 129 | } |
| 130 | |
Hyunyoung Song | ac5f6af | 2015-05-29 12:00:44 -0700 | [diff] [blame] | 131 | @Override |
| 132 | protected void dispatchDraw(Canvas canvas) { |
Sunny Goyal | 89d5c5a | 2017-06-23 16:12:50 -0700 | [diff] [blame] | 133 | onUpdateScrollbar(0); |
Hyunyoung Song | ac5f6af | 2015-05-29 12:00:44 -0700 | [diff] [blame] | 134 | super.dispatchDraw(canvas); |
Hyunyoung Song | ac5f6af | 2015-05-29 12:00:44 -0700 | [diff] [blame] | 135 | } |
| 136 | |
| 137 | /** |
Winson Chung | b177744 | 2015-06-16 13:35:04 -0700 | [diff] [blame] | 138 | * Updates the scrollbar thumb offset to match the visible scroll of the recycler view. It does |
| 139 | * this by mapping the available scroll area of the recycler view to the available space for the |
| 140 | * scroll bar. |
| 141 | * |
Winson | b655b88 | 2016-07-11 18:59:18 -0700 | [diff] [blame] | 142 | * @param scrollY the current scroll y |
Hyunyoung Song | ac5f6af | 2015-05-29 12:00:44 -0700 | [diff] [blame] | 143 | */ |
Winson | b655b88 | 2016-07-11 18:59:18 -0700 | [diff] [blame] | 144 | protected void synchronizeScrollBarThumbOffsetToViewScroll(int scrollY, |
| 145 | int availableScrollHeight) { |
Winson Chung | b177744 | 2015-06-16 13:35:04 -0700 | [diff] [blame] | 146 | // Only show the scrollbar if there is height to be scrolled |
| 147 | if (availableScrollHeight <= 0) { |
Sunny Goyal | 5d9fb0e | 2016-10-08 17:43:48 -0700 | [diff] [blame] | 148 | mScrollbar.setThumbOffsetY(-1); |
Winson Chung | b177744 | 2015-06-16 13:35:04 -0700 | [diff] [blame] | 149 | return; |
Hyunyoung Song | ac5f6af | 2015-05-29 12:00:44 -0700 | [diff] [blame] | 150 | } |
Hyunyoung Song | ac5f6af | 2015-05-29 12:00:44 -0700 | [diff] [blame] | 151 | |
Winson Chung | b177744 | 2015-06-16 13:35:04 -0700 | [diff] [blame] | 152 | // Calculate the current scroll position, the scrollY of the recycler view accounts for the |
| 153 | // view padding, while the scrollBarY is drawn right up to the background padding (ignoring |
| 154 | // padding) |
Sunny Goyal | 00e1068 | 2016-10-18 14:23:46 +0100 | [diff] [blame] | 155 | int scrollBarY = |
| 156 | (int) (((float) scrollY / availableScrollHeight) * getAvailableScrollBarHeight()); |
Hyunyoung Song | ac5f6af | 2015-05-29 12:00:44 -0700 | [diff] [blame] | 157 | |
Winson Chung | b177744 | 2015-06-16 13:35:04 -0700 | [diff] [blame] | 158 | // Calculate the position and size of the scroll bar |
Sunny Goyal | 5d9fb0e | 2016-10-08 17:43:48 -0700 | [diff] [blame] | 159 | mScrollbar.setThumbOffsetY(scrollBarY); |
Winson Chung | 4b9f979 | 2015-06-12 18:02:52 -0700 | [diff] [blame] | 160 | } |
| 161 | |
| 162 | /** |
Winson | c088049 | 2015-08-21 11:16:27 -0700 | [diff] [blame] | 163 | * @return whether fast scrolling is supported in the current state. |
Winson | 646c236 | 2015-09-03 11:46:11 -0700 | [diff] [blame] | 164 | */ |
Sunny Goyal | 89d5c5a | 2017-06-23 16:12:50 -0700 | [diff] [blame] | 165 | public boolean supportsFastScrolling() { |
Winson | 646c236 | 2015-09-03 11:46:11 -0700 | [diff] [blame] | 166 | return true; |
| 167 | } |
| 168 | |
| 169 | /** |
Hyunyoung Song | ac5f6af | 2015-05-29 12:00:44 -0700 | [diff] [blame] | 170 | * Maps the touch (from 0..1) to the adapter position that should be visible. |
| 171 | * <p>Override in each subclass of this base class. |
Winson | c088049 | 2015-08-21 11:16:27 -0700 | [diff] [blame] | 172 | * |
| 173 | * @return the scroll top of this recycler view. |
Hyunyoung Song | ac5f6af | 2015-05-29 12:00:44 -0700 | [diff] [blame] | 174 | */ |
Peter Schiller | 2e22b5d | 2016-07-12 12:45:10 -0700 | [diff] [blame] | 175 | public abstract int getCurrentScrollY(); |
Winson | c088049 | 2015-08-21 11:16:27 -0700 | [diff] [blame] | 176 | |
| 177 | /** |
| 178 | * Maps the touch (from 0..1) to the adapter position that should be visible. |
| 179 | * <p>Override in each subclass of this base class. |
| 180 | */ |
Sunny Goyal | 89d5c5a | 2017-06-23 16:12:50 -0700 | [diff] [blame] | 181 | public abstract String scrollToPositionAtProgress(float touchFraction); |
Hyunyoung Song | ac5f6af | 2015-05-29 12:00:44 -0700 | [diff] [blame] | 182 | |
| 183 | /** |
| 184 | * Updates the bounds for the scrollbar. |
| 185 | * <p>Override in each subclass of this base class. |
| 186 | */ |
Sunny Goyal | 89d5c5a | 2017-06-23 16:12:50 -0700 | [diff] [blame] | 187 | public abstract void onUpdateScrollbar(int dy); |
Hyunyoung Song | ac5f6af | 2015-05-29 12:00:44 -0700 | [diff] [blame] | 188 | |
| 189 | /** |
Winson Chung | b177744 | 2015-06-16 13:35:04 -0700 | [diff] [blame] | 190 | * <p>Override in each subclass of this base class. |
Hyunyoung Song | ac5f6af | 2015-05-29 12:00:44 -0700 | [diff] [blame] | 191 | */ |
Sunny Goyal | 89d5c5a | 2017-06-23 16:12:50 -0700 | [diff] [blame] | 192 | public void onFastScrollCompleted() {} |
Winson Chung | 9480415 | 2015-05-08 13:06:44 -0700 | [diff] [blame] | 193 | } |