Ben Lin | b8c54e7 | 2016-06-10 12:13:27 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2016 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.documentsui; |
| 18 | |
| 19 | import android.content.Context; |
Ben Lin | b8c54e7 | 2016-06-10 12:13:27 -0700 | [diff] [blame] | 20 | import android.util.AttributeSet; |
| 21 | import android.view.GestureDetector; |
Ben Lin | 340ab17 | 2017-01-27 11:41:26 -0800 | [diff] [blame] | 22 | import android.view.KeyEvent; |
Ben Lin | b8c54e7 | 2016-06-10 12:13:27 -0700 | [diff] [blame] | 23 | import android.view.LayoutInflater; |
| 24 | import android.view.MotionEvent; |
| 25 | import android.view.View; |
| 26 | import android.view.ViewGroup; |
| 27 | import android.widget.ImageView; |
Ben Lin | b8c54e7 | 2016-06-10 12:13:27 -0700 | [diff] [blame] | 28 | |
Tony Huang | 03401d3 | 2019-04-17 16:37:16 +0800 | [diff] [blame] | 29 | import androidx.recyclerview.widget.LinearLayoutManager; |
| 30 | import androidx.recyclerview.widget.RecyclerView; |
| 31 | |
Ben Lin | b8c54e7 | 2016-06-10 12:13:27 -0700 | [diff] [blame] | 32 | import com.android.documentsui.NavigationViewManager.Breadcrumb; |
| 33 | import com.android.documentsui.NavigationViewManager.Environment; |
Steve McKay | d080506 | 2016-09-15 14:30:38 -0700 | [diff] [blame] | 34 | import com.android.documentsui.base.DocumentInfo; |
| 35 | import com.android.documentsui.base.RootInfo; |
Ben Lin | a355d19 | 2017-03-03 14:11:57 -0800 | [diff] [blame] | 36 | import com.android.documentsui.dirlist.AccessibilityEventRouter; |
Ben Lin | b8c54e7 | 2016-06-10 12:13:27 -0700 | [diff] [blame] | 37 | |
| 38 | import java.util.function.Consumer; |
Ben Lin | e4ffd06 | 2017-01-19 15:10:49 -0800 | [diff] [blame] | 39 | import java.util.function.IntConsumer; |
Ben Lin | b8c54e7 | 2016-06-10 12:13:27 -0700 | [diff] [blame] | 40 | |
| 41 | /** |
| 42 | * Horizontal implementation of breadcrumb used for tablet / desktop device layouts |
| 43 | */ |
Ben Lin | ba1cb3d | 2016-06-20 17:08:22 -0700 | [diff] [blame] | 44 | public final class HorizontalBreadcrumb extends RecyclerView |
| 45 | implements Breadcrumb, ItemDragListener.DragHost { |
| 46 | |
| 47 | private static final int USER_NO_SCROLL_OFFSET_THRESHOLD = 5; |
Ben Lin | b8c54e7 | 2016-06-10 12:13:27 -0700 | [diff] [blame] | 48 | |
| 49 | private LinearLayoutManager mLayoutManager; |
| 50 | private BreadcrumbAdapter mAdapter; |
Ben Lin | e4ffd06 | 2017-01-19 15:10:49 -0800 | [diff] [blame] | 51 | private IntConsumer mClickListener; |
Ben Lin | b8c54e7 | 2016-06-10 12:13:27 -0700 | [diff] [blame] | 52 | |
| 53 | public HorizontalBreadcrumb(Context context, AttributeSet attrs, int defStyleAttr) { |
| 54 | super(context, attrs, defStyleAttr); |
| 55 | } |
| 56 | |
| 57 | public HorizontalBreadcrumb(Context context, AttributeSet attrs) { |
| 58 | super(context, attrs); |
| 59 | } |
| 60 | |
| 61 | public HorizontalBreadcrumb(Context context) { |
| 62 | super(context); |
| 63 | } |
| 64 | |
| 65 | @Override |
| 66 | public void setup(Environment env, |
Steve McKay | d9caa6a | 2016-09-15 16:36:45 -0700 | [diff] [blame] | 67 | com.android.documentsui.base.State state, |
Ben Lin | e4ffd06 | 2017-01-19 15:10:49 -0800 | [diff] [blame] | 68 | IntConsumer listener) { |
Ben Lin | b8c54e7 | 2016-06-10 12:13:27 -0700 | [diff] [blame] | 69 | |
Ben Lin | e4ffd06 | 2017-01-19 15:10:49 -0800 | [diff] [blame] | 70 | mClickListener = listener; |
Ben Lin | b8c54e7 | 2016-06-10 12:13:27 -0700 | [diff] [blame] | 71 | mLayoutManager = new LinearLayoutManager( |
| 72 | getContext(), LinearLayoutManager.HORIZONTAL, false); |
Ben Lin | ba1cb3d | 2016-06-20 17:08:22 -0700 | [diff] [blame] | 73 | mAdapter = new BreadcrumbAdapter( |
Ben Lin | 340ab17 | 2017-01-27 11:41:26 -0800 | [diff] [blame] | 74 | state, env, new ItemDragListener<>(this), this::onKey); |
Ben Lin | e4ffd06 | 2017-01-19 15:10:49 -0800 | [diff] [blame] | 75 | // Since we are using GestureDetector to detect click events, a11y services don't know which views |
| 76 | // are clickable because we aren't using View.OnClickListener. Thus, we need to use a custom |
| 77 | // accessibility delegate to route click events correctly. See AccessibilityClickEventRouter |
| 78 | // for more details on how we are routing these a11y events. |
| 79 | setAccessibilityDelegateCompat( |
Ben Lin | a355d19 | 2017-03-03 14:11:57 -0800 | [diff] [blame] | 80 | new AccessibilityEventRouter(this, |
Tony Huang | 03401d3 | 2019-04-17 16:37:16 +0800 | [diff] [blame] | 81 | (View child) -> onAccessibilityClick(child), null)); |
Ben Lin | b8c54e7 | 2016-06-10 12:13:27 -0700 | [diff] [blame] | 82 | |
| 83 | setLayoutManager(mLayoutManager); |
| 84 | addOnItemTouchListener(new ClickListener(getContext(), this::onSingleTapUp)); |
| 85 | } |
| 86 | |
| 87 | @Override |
| 88 | public void show(boolean visibility) { |
| 89 | if (visibility) { |
| 90 | setVisibility(VISIBLE); |
Ben Lin | ba1cb3d | 2016-06-20 17:08:22 -0700 | [diff] [blame] | 91 | boolean shouldScroll = !hasUserDefineScrollOffset(); |
| 92 | if (getAdapter() == null) { |
| 93 | setAdapter(mAdapter); |
| 94 | } else { |
| 95 | int currentItemCount = mAdapter.getItemCount(); |
| 96 | int lastItemCount = mAdapter.getLastItemSize(); |
| 97 | if (currentItemCount > lastItemCount) { |
| 98 | mAdapter.notifyItemRangeInserted(lastItemCount, |
| 99 | currentItemCount - lastItemCount); |
| 100 | mAdapter.notifyItemChanged(lastItemCount - 1); |
| 101 | } else if (currentItemCount < lastItemCount) { |
| 102 | mAdapter.notifyItemRangeRemoved(currentItemCount, |
| 103 | lastItemCount - currentItemCount); |
| 104 | mAdapter.notifyItemChanged(currentItemCount - 1); |
| 105 | } |
| 106 | } |
| 107 | if (shouldScroll) { |
| 108 | mLayoutManager.scrollToPosition(mAdapter.getItemCount() - 1); |
| 109 | } |
Ben Lin | b8c54e7 | 2016-06-10 12:13:27 -0700 | [diff] [blame] | 110 | } else { |
| 111 | setVisibility(GONE); |
| 112 | setAdapter(null); |
| 113 | } |
Ben Lin | ba1cb3d | 2016-06-20 17:08:22 -0700 | [diff] [blame] | 114 | mAdapter.updateLastItemSize(); |
| 115 | } |
| 116 | |
| 117 | private boolean hasUserDefineScrollOffset() { |
| 118 | final int maxOffset = computeHorizontalScrollRange() - computeHorizontalScrollExtent(); |
| 119 | return (maxOffset - computeHorizontalScrollOffset() > USER_NO_SCROLL_OFFSET_THRESHOLD); |
Ben Lin | b8c54e7 | 2016-06-10 12:13:27 -0700 | [diff] [blame] | 120 | } |
| 121 | |
Ben Lin | e4ffd06 | 2017-01-19 15:10:49 -0800 | [diff] [blame] | 122 | private boolean onAccessibilityClick(View child) { |
| 123 | int pos = getChildAdapterPosition(child); |
| 124 | if (pos != getAdapter().getItemCount() - 1) { |
| 125 | mClickListener.accept(pos); |
| 126 | return true; |
| 127 | } |
| 128 | return false; |
| 129 | } |
| 130 | |
Ben Lin | 340ab17 | 2017-01-27 11:41:26 -0800 | [diff] [blame] | 131 | private boolean onKey(View v, int keyCode, KeyEvent event) { |
| 132 | switch (keyCode) { |
| 133 | case KeyEvent.KEYCODE_ENTER: |
| 134 | return onAccessibilityClick(v); |
| 135 | default: |
| 136 | return false; |
| 137 | } |
| 138 | } |
| 139 | |
Ben Lin | b8c54e7 | 2016-06-10 12:13:27 -0700 | [diff] [blame] | 140 | @Override |
| 141 | public void postUpdate() { |
| 142 | } |
| 143 | |
Ben Lin | ba1cb3d | 2016-06-20 17:08:22 -0700 | [diff] [blame] | 144 | @Override |
| 145 | public void runOnUiThread(Runnable runnable) { |
| 146 | post(runnable); |
| 147 | } |
| 148 | |
| 149 | @Override |
Garfield Tan | da2c0f0 | 2017-04-11 13:47:58 -0700 | [diff] [blame] | 150 | public void setDropTargetHighlight(View v, boolean highlight) { |
Ben Lin | ba1cb3d | 2016-06-20 17:08:22 -0700 | [diff] [blame] | 151 | RecyclerView.ViewHolder vh = getChildViewHolder(v); |
| 152 | if (vh instanceof BreadcrumbHolder) { |
| 153 | ((BreadcrumbHolder) vh).setHighlighted(highlight); |
| 154 | } |
| 155 | } |
| 156 | |
| 157 | @Override |
Garfield Tan | da2c0f0 | 2017-04-11 13:47:58 -0700 | [diff] [blame] | 158 | public void onDragEntered(View v) { |
Ben Lin | 7f72a3c | 2016-09-27 16:37:28 -0700 | [diff] [blame] | 159 | // do nothing |
| 160 | } |
| 161 | |
| 162 | @Override |
Garfield Tan | da2c0f0 | 2017-04-11 13:47:58 -0700 | [diff] [blame] | 163 | public void onDragExited(View v) { |
Ben Lin | d020212 | 2016-11-10 18:00:12 -0800 | [diff] [blame] | 164 | // do nothing |
| 165 | } |
| 166 | |
| 167 | @Override |
Ben Lin | ba1cb3d | 2016-06-20 17:08:22 -0700 | [diff] [blame] | 168 | public void onViewHovered(View v) { |
| 169 | int pos = getChildAdapterPosition(v); |
| 170 | if (pos != mAdapter.getItemCount() - 1) { |
Ben Lin | e4ffd06 | 2017-01-19 15:10:49 -0800 | [diff] [blame] | 171 | mClickListener.accept(pos); |
Ben Lin | ba1cb3d | 2016-06-20 17:08:22 -0700 | [diff] [blame] | 172 | } |
| 173 | } |
| 174 | |
Garfield Tan | da2c0f0 | 2017-04-11 13:47:58 -0700 | [diff] [blame] | 175 | @Override |
| 176 | public void onDragEnded() { |
| 177 | // do nothing |
| 178 | } |
| 179 | |
Ben Lin | b8c54e7 | 2016-06-10 12:13:27 -0700 | [diff] [blame] | 180 | private void onSingleTapUp(MotionEvent e) { |
| 181 | View itemView = findChildViewUnder(e.getX(), e.getY()); |
| 182 | int pos = getChildAdapterPosition(itemView); |
| 183 | if (pos != mAdapter.getItemCount() - 1) { |
Ben Lin | e4ffd06 | 2017-01-19 15:10:49 -0800 | [diff] [blame] | 184 | mClickListener.accept(pos); |
Ben Lin | b8c54e7 | 2016-06-10 12:13:27 -0700 | [diff] [blame] | 185 | } |
| 186 | } |
| 187 | |
| 188 | private static final class BreadcrumbAdapter |
| 189 | extends RecyclerView.Adapter<BreadcrumbHolder> { |
| 190 | |
Ben Lin | ba1cb3d | 2016-06-20 17:08:22 -0700 | [diff] [blame] | 191 | private final Environment mEnv; |
Steve McKay | d9caa6a | 2016-09-15 16:36:45 -0700 | [diff] [blame] | 192 | private final com.android.documentsui.base.State mState; |
Ben Lin | ba1cb3d | 2016-06-20 17:08:22 -0700 | [diff] [blame] | 193 | private final OnDragListener mDragListener; |
Ben Lin | 340ab17 | 2017-01-27 11:41:26 -0800 | [diff] [blame] | 194 | private final View.OnKeyListener mClickListener; |
Ben Lin | ba1cb3d | 2016-06-20 17:08:22 -0700 | [diff] [blame] | 195 | // We keep the old item size so the breadcrumb will only re-render views that are necessary |
| 196 | private int mLastItemSize; |
Ben Lin | b8c54e7 | 2016-06-10 12:13:27 -0700 | [diff] [blame] | 197 | |
Steve McKay | d9caa6a | 2016-09-15 16:36:45 -0700 | [diff] [blame] | 198 | public BreadcrumbAdapter(com.android.documentsui.base.State state, |
Ben Lin | ba1cb3d | 2016-06-20 17:08:22 -0700 | [diff] [blame] | 199 | Environment env, |
Ben Lin | 340ab17 | 2017-01-27 11:41:26 -0800 | [diff] [blame] | 200 | OnDragListener dragListener, |
| 201 | View.OnKeyListener clickListener) { |
Ben Lin | b8c54e7 | 2016-06-10 12:13:27 -0700 | [diff] [blame] | 202 | mState = state; |
| 203 | mEnv = env; |
Ben Lin | ba1cb3d | 2016-06-20 17:08:22 -0700 | [diff] [blame] | 204 | mDragListener = dragListener; |
Ben Lin | 340ab17 | 2017-01-27 11:41:26 -0800 | [diff] [blame] | 205 | mClickListener = clickListener; |
Ben Lin | ba1cb3d | 2016-06-20 17:08:22 -0700 | [diff] [blame] | 206 | mLastItemSize = mState.stack.size(); |
Ben Lin | b8c54e7 | 2016-06-10 12:13:27 -0700 | [diff] [blame] | 207 | } |
| 208 | |
| 209 | @Override |
| 210 | public BreadcrumbHolder onCreateViewHolder(ViewGroup parent, int viewType) { |
| 211 | View v = LayoutInflater.from(parent.getContext()) |
| 212 | .inflate(R.layout.navigation_breadcrumb_item, null); |
| 213 | return new BreadcrumbHolder(v); |
| 214 | } |
| 215 | |
| 216 | @Override |
| 217 | public void onBindViewHolder(BreadcrumbHolder holder, int position) { |
| 218 | final DocumentInfo doc = getItem(position); |
Ben Lin | 9cad635 | 2016-07-06 11:58:05 -0700 | [diff] [blame] | 219 | final int horizontalPadding = (int) holder.itemView.getResources() |
| 220 | .getDimension(R.dimen.breadcrumb_item_padding); |
Ben Lin | b8c54e7 | 2016-06-10 12:13:27 -0700 | [diff] [blame] | 221 | |
| 222 | if (position == 0) { |
| 223 | final RootInfo root = mEnv.getCurrentRoot(); |
| 224 | holder.title.setText(root.title); |
Ben Lin | 9cad635 | 2016-07-06 11:58:05 -0700 | [diff] [blame] | 225 | holder.title.setPadding(0, 0, horizontalPadding, 0); |
Ben Lin | b8c54e7 | 2016-06-10 12:13:27 -0700 | [diff] [blame] | 226 | } else { |
| 227 | holder.title.setText(doc.displayName); |
Ben Lin | 9cad635 | 2016-07-06 11:58:05 -0700 | [diff] [blame] | 228 | holder.title.setPadding(horizontalPadding, 0, horizontalPadding, 0); |
Ben Lin | b8c54e7 | 2016-06-10 12:13:27 -0700 | [diff] [blame] | 229 | } |
| 230 | |
| 231 | if (position == getItemCount() - 1) { |
| 232 | holder.arrow.setVisibility(View.GONE); |
Ben Lin | ba1cb3d | 2016-06-20 17:08:22 -0700 | [diff] [blame] | 233 | } else { |
| 234 | holder.arrow.setVisibility(View.VISIBLE); |
Ben Lin | b8c54e7 | 2016-06-10 12:13:27 -0700 | [diff] [blame] | 235 | } |
Ben Lin | ba1cb3d | 2016-06-20 17:08:22 -0700 | [diff] [blame] | 236 | holder.itemView.setOnDragListener(mDragListener); |
Ben Lin | 340ab17 | 2017-01-27 11:41:26 -0800 | [diff] [blame] | 237 | holder.itemView.setOnKeyListener(mClickListener); |
Ben Lin | b8c54e7 | 2016-06-10 12:13:27 -0700 | [diff] [blame] | 238 | } |
| 239 | |
| 240 | private DocumentInfo getItem(int position) { |
Garfield Tan | 2a83742 | 2016-10-19 11:50:45 -0700 | [diff] [blame] | 241 | return mState.stack.get(position); |
Ben Lin | b8c54e7 | 2016-06-10 12:13:27 -0700 | [diff] [blame] | 242 | } |
| 243 | |
| 244 | @Override |
| 245 | public int getItemCount() { |
| 246 | return mState.stack.size(); |
| 247 | } |
Ben Lin | ba1cb3d | 2016-06-20 17:08:22 -0700 | [diff] [blame] | 248 | |
| 249 | public int getLastItemSize() { |
| 250 | return mLastItemSize; |
| 251 | } |
| 252 | |
| 253 | public void updateLastItemSize() { |
| 254 | mLastItemSize = mState.stack.size(); |
| 255 | } |
Ben Lin | b8c54e7 | 2016-06-10 12:13:27 -0700 | [diff] [blame] | 256 | } |
| 257 | |
| 258 | private static class BreadcrumbHolder extends RecyclerView.ViewHolder { |
| 259 | |
Ben Lin | ba1cb3d | 2016-06-20 17:08:22 -0700 | [diff] [blame] | 260 | protected DragOverTextView title; |
Ben Lin | b8c54e7 | 2016-06-10 12:13:27 -0700 | [diff] [blame] | 261 | protected ImageView arrow; |
| 262 | |
| 263 | public BreadcrumbHolder(View itemView) { |
| 264 | super(itemView); |
Ben Lin | ba1cb3d | 2016-06-20 17:08:22 -0700 | [diff] [blame] | 265 | title = (DragOverTextView) itemView.findViewById(R.id.breadcrumb_text); |
Ben Lin | b8c54e7 | 2016-06-10 12:13:27 -0700 | [diff] [blame] | 266 | arrow = (ImageView) itemView.findViewById(R.id.breadcrumb_arrow); |
| 267 | } |
Ben Lin | ba1cb3d | 2016-06-20 17:08:22 -0700 | [diff] [blame] | 268 | |
| 269 | /** |
| 270 | * Highlights the associated item view. |
| 271 | * @param highlighted |
| 272 | */ |
| 273 | public void setHighlighted(boolean highlighted) { |
| 274 | title.setHighlight(highlighted); |
| 275 | } |
Ben Lin | b8c54e7 | 2016-06-10 12:13:27 -0700 | [diff] [blame] | 276 | } |
| 277 | |
| 278 | private static final class ClickListener extends GestureDetector |
| 279 | implements OnItemTouchListener { |
| 280 | |
| 281 | public ClickListener(Context context, Consumer<MotionEvent> listener) { |
| 282 | super(context, new SimpleOnGestureListener() { |
| 283 | @Override |
| 284 | public boolean onSingleTapUp(MotionEvent e) { |
| 285 | listener.accept(e); |
| 286 | return true; |
| 287 | } |
| 288 | }); |
| 289 | } |
| 290 | |
| 291 | @Override |
| 292 | public boolean onInterceptTouchEvent(RecyclerView rv, MotionEvent e) { |
| 293 | onTouchEvent(e); |
| 294 | return false; |
| 295 | } |
| 296 | |
| 297 | @Override |
| 298 | public void onTouchEvent(RecyclerView rv, MotionEvent e) { |
| 299 | onTouchEvent(e); |
| 300 | } |
| 301 | |
| 302 | @Override |
| 303 | public void onRequestDisallowInterceptTouchEvent(boolean disallowIntercept) { |
| 304 | } |
| 305 | } |
| 306 | } |