Garfield Tan | 84bd0f1 | 2016-09-12 14:18:32 -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 | |
Steve McKay | bd9f05a | 2016-10-10 10:18:36 -0700 | [diff] [blame] | 17 | package com.android.documentsui; |
Garfield Tan | 84bd0f1 | 2016-09-12 14:18:32 -0700 | [diff] [blame] | 18 | |
Felipe Leme | 9de5807 | 2018-01-19 16:40:04 -0800 | [diff] [blame] | 19 | import static com.android.documentsui.base.SharedMinimal.DEBUG; |
Garfield Tan | 84bd0f1 | 2016-09-12 14:18:32 -0700 | [diff] [blame] | 20 | |
Garfield Tan | 84bd0f1 | 2016-09-12 14:18:32 -0700 | [diff] [blame] | 21 | import android.app.Activity; |
Garfield Tan | 84bd0f1 | 2016-09-12 14:18:32 -0700 | [diff] [blame] | 22 | import android.util.Log; |
| 23 | import android.view.ActionMode; |
Garfield Tan | 84bd0f1 | 2016-09-12 14:18:32 -0700 | [diff] [blame] | 24 | import android.view.Menu; |
| 25 | import android.view.MenuItem; |
| 26 | import android.view.View; |
| 27 | |
shawnlin | 8dafe61 | 2019-08-14 20:10:18 +0800 | [diff] [blame] | 28 | import androidx.annotation.IdRes; |
| 29 | import androidx.annotation.Nullable; |
Riddle Hsu | 0c37598 | 2018-06-21 22:06:43 +0800 | [diff] [blame] | 30 | import androidx.recyclerview.selection.MutableSelection; |
| 31 | import androidx.recyclerview.selection.SelectionTracker; |
| 32 | import androidx.recyclerview.selection.SelectionTracker.SelectionObserver; |
| 33 | |
shawnlin | 8dafe61 | 2019-08-14 20:10:18 +0800 | [diff] [blame] | 34 | import com.android.documentsui.MenuManager.SelectionDetails; |
| 35 | import com.android.documentsui.base.EventHandler; |
| 36 | import com.android.documentsui.base.Menus; |
| 37 | import com.android.documentsui.ui.MessageBuilder; |
| 38 | |
Garfield Tan | 84bd0f1 | 2016-09-12 14:18:32 -0700 | [diff] [blame] | 39 | /** |
| 40 | * A controller that listens to selection changes and manages life cycles of action modes. |
| 41 | */ |
Riddle Hsu | 0c37598 | 2018-06-21 22:06:43 +0800 | [diff] [blame] | 42 | public class ActionModeController extends SelectionObserver<String> |
Steve McKay | 365e3cb | 2017-08-31 10:27:08 -0700 | [diff] [blame] | 43 | implements ActionMode.Callback, ActionModeAddons { |
Garfield Tan | 84bd0f1 | 2016-09-12 14:18:32 -0700 | [diff] [blame] | 44 | |
| 45 | private static final String TAG = "ActionModeController"; |
| 46 | |
Steve McKay | 5b0a2c1 | 2016-10-07 11:22:31 -0700 | [diff] [blame] | 47 | private final Activity mActivity; |
Riddle Hsu | 0c37598 | 2018-06-21 22:06:43 +0800 | [diff] [blame] | 48 | private final SelectionTracker<String> mSelectionMgr; |
Garfield Tan | 84bd0f1 | 2016-09-12 14:18:32 -0700 | [diff] [blame] | 49 | private final MenuManager mMenuManager; |
Steve McKay | 5b0a2c1 | 2016-10-07 11:22:31 -0700 | [diff] [blame] | 50 | private final MessageBuilder mMessages; |
Garfield Tan | 84bd0f1 | 2016-09-12 14:18:32 -0700 | [diff] [blame] | 51 | |
Steve McKay | bd9f05a | 2016-10-10 10:18:36 -0700 | [diff] [blame] | 52 | private final ContentScope mScope = new ContentScope(); |
Riddle Hsu | 0c37598 | 2018-06-21 22:06:43 +0800 | [diff] [blame] | 53 | private final MutableSelection<String> mSelected = new MutableSelection<>(); |
Garfield Tan | 84bd0f1 | 2016-09-12 14:18:32 -0700 | [diff] [blame] | 54 | |
| 55 | private @Nullable ActionMode mActionMode; |
| 56 | private @Nullable Menu mMenu; |
| 57 | |
Steve McKay | 5b0a2c1 | 2016-10-07 11:22:31 -0700 | [diff] [blame] | 58 | public ActionModeController( |
| 59 | Activity activity, |
Riddle Hsu | 0c37598 | 2018-06-21 22:06:43 +0800 | [diff] [blame] | 60 | SelectionTracker<String> selectionMgr, |
Garfield Tan | 84bd0f1 | 2016-09-12 14:18:32 -0700 | [diff] [blame] | 61 | MenuManager menuManager, |
Steve McKay | 5b0a2c1 | 2016-10-07 11:22:31 -0700 | [diff] [blame] | 62 | MessageBuilder messages) { |
| 63 | |
| 64 | mActivity = activity; |
Garfield Tan | 84bd0f1 | 2016-09-12 14:18:32 -0700 | [diff] [blame] | 65 | mSelectionMgr = selectionMgr; |
| 66 | mMenuManager = menuManager; |
Steve McKay | 5b0a2c1 | 2016-10-07 11:22:31 -0700 | [diff] [blame] | 67 | mMessages = messages; |
Garfield Tan | 84bd0f1 | 2016-09-12 14:18:32 -0700 | [diff] [blame] | 68 | } |
| 69 | |
| 70 | @Override |
| 71 | public void onSelectionChanged() { |
Steve McKay | 2d19a69 | 2017-08-22 09:05:08 -0700 | [diff] [blame] | 72 | mSelectionMgr.copySelection(mSelected); |
Garfield Tan | 84bd0f1 | 2016-09-12 14:18:32 -0700 | [diff] [blame] | 73 | if (mSelected.size() > 0) { |
| 74 | if (mActionMode == null) { |
Jason Chang | 96f886b | 2019-03-29 17:59:02 +0800 | [diff] [blame] | 75 | if (DEBUG) { |
| 76 | Log.d(TAG, "Starting action mode."); |
| 77 | } |
Steve McKay | 5b0a2c1 | 2016-10-07 11:22:31 -0700 | [diff] [blame] | 78 | mActionMode = mActivity.startActionMode(this); |
Tony Huang | ddf0b51 | 2019-09-05 16:23:49 +0800 | [diff] [blame] | 79 | final View closeButton = mActivity.findViewById(R.id.action_mode_close_button); |
| 80 | if (closeButton != null) { |
| 81 | closeButton.setContentDescription(mActivity.getString(android.R.string.cancel)); |
| 82 | } |
Garfield Tan | 84bd0f1 | 2016-09-12 14:18:32 -0700 | [diff] [blame] | 83 | } |
| 84 | updateActionMenu(); |
| 85 | } else { |
| 86 | if (mActionMode != null) { |
Jason Chang | 96f886b | 2019-03-29 17:59:02 +0800 | [diff] [blame] | 87 | if (DEBUG) { |
| 88 | Log.d(TAG, "Finishing action mode."); |
| 89 | } |
Garfield Tan | 84bd0f1 | 2016-09-12 14:18:32 -0700 | [diff] [blame] | 90 | mActionMode.finish(); |
| 91 | } |
| 92 | } |
| 93 | |
| 94 | if (mActionMode != null) { |
| 95 | assert(!mSelected.isEmpty()); |
Steve McKay | 5b0a2c1 | 2016-10-07 11:22:31 -0700 | [diff] [blame] | 96 | final String title = mMessages.getQuantityString( |
Garfield Tan | 84bd0f1 | 2016-09-12 14:18:32 -0700 | [diff] [blame] | 97 | R.plurals.elements_selected, mSelected.size()); |
| 98 | mActionMode.setTitle(title); |
Ben Lin | c8739d9 | 2016-11-02 11:54:53 -0700 | [diff] [blame] | 99 | mActivity.getWindow().setTitle(title); |
Garfield Tan | 84bd0f1 | 2016-09-12 14:18:32 -0700 | [diff] [blame] | 100 | } |
| 101 | } |
| 102 | |
| 103 | @Override |
| 104 | public void onSelectionRestored() { |
Steve McKay | 365e3cb | 2017-08-31 10:27:08 -0700 | [diff] [blame] | 105 | onSelectionChanged(); |
Steve McKay | e77c037 | 2017-08-18 14:29:40 -0700 | [diff] [blame] | 106 | } |
| 107 | |
Garfield Tan | 84bd0f1 | 2016-09-12 14:18:32 -0700 | [diff] [blame] | 108 | // Called when the user exits the action mode |
| 109 | @Override |
| 110 | public void onDestroyActionMode(ActionMode mode) { |
Steve McKay | 4f78ba6 | 2016-10-04 16:48:49 -0700 | [diff] [blame] | 111 | if (mActionMode == null) { |
Jason Chang | 96f886b | 2019-03-29 17:59:02 +0800 | [diff] [blame] | 112 | if (DEBUG) { |
| 113 | Log.w(TAG, "Received call to destroy action mode on alien mode object."); |
| 114 | } |
Steve McKay | 4f78ba6 | 2016-10-04 16:48:49 -0700 | [diff] [blame] | 115 | } |
| 116 | |
| 117 | assert(mActionMode.equals(mode)); |
| 118 | |
Jason Chang | 96f886b | 2019-03-29 17:59:02 +0800 | [diff] [blame] | 119 | if (DEBUG) { |
| 120 | Log.d(TAG, "Handling action mode destroyed."); |
| 121 | } |
Garfield Tan | 84bd0f1 | 2016-09-12 14:18:32 -0700 | [diff] [blame] | 122 | mActionMode = null; |
Steve McKay | 4f78ba6 | 2016-10-04 16:48:49 -0700 | [diff] [blame] | 123 | mMenu = null; |
| 124 | |
Garfield Tan | 84bd0f1 | 2016-09-12 14:18:32 -0700 | [diff] [blame] | 125 | mSelectionMgr.clearSelection(); |
Garfield Tan | 84bd0f1 | 2016-09-12 14:18:32 -0700 | [diff] [blame] | 126 | |
Ben Lin | 859e42f | 2017-03-31 12:10:16 -0700 | [diff] [blame] | 127 | // Reset window title back to activity title, i.e. Root name |
| 128 | mActivity.getWindow().setTitle(mActivity.getTitle()); |
| 129 | |
Garfield Tan | 84bd0f1 | 2016-09-12 14:18:32 -0700 | [diff] [blame] | 130 | // Re-enable TalkBack for the toolbars, as they are no longer covered by action mode. |
Steve McKay | bd9f05a | 2016-10-10 10:18:36 -0700 | [diff] [blame] | 131 | mScope.accessibilityImportanceSetter.setAccessibilityImportance( |
Garfield Tan | 84bd0f1 | 2016-09-12 14:18:32 -0700 | [diff] [blame] | 132 | View.IMPORTANT_FOR_ACCESSIBILITY_AUTO, R.id.toolbar, R.id.roots_toolbar); |
| 133 | } |
| 134 | |
| 135 | @Override |
| 136 | public boolean onCreateActionMode(ActionMode mode, Menu menu) { |
| 137 | int size = mSelectionMgr.getSelection().size(); |
Ben Lin | ff7f3ae | 2017-04-25 16:08:52 -0700 | [diff] [blame] | 138 | mode.getMenuInflater().inflate(R.menu.action_mode_menu, menu); |
Tony Huang | 057e987 | 2018-11-05 11:23:00 +0800 | [diff] [blame] | 139 | mode.setTitle(mActivity.getResources().getQuantityString(R.plurals.selected_count, size)); |
Garfield Tan | 84bd0f1 | 2016-09-12 14:18:32 -0700 | [diff] [blame] | 140 | |
| 141 | if (size > 0) { |
| 142 | |
| 143 | // Hide the toolbars if action mode is enabled, so TalkBack doesn't navigate to |
| 144 | // these controls when using linear navigation. |
Steve McKay | bd9f05a | 2016-10-10 10:18:36 -0700 | [diff] [blame] | 145 | mScope.accessibilityImportanceSetter.setAccessibilityImportance( |
Garfield Tan | 84bd0f1 | 2016-09-12 14:18:32 -0700 | [diff] [blame] | 146 | View.IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS, |
| 147 | R.id.toolbar, |
| 148 | R.id.roots_toolbar); |
| 149 | return true; |
| 150 | } |
| 151 | |
| 152 | return false; |
| 153 | } |
| 154 | |
| 155 | @Override |
| 156 | public boolean onPrepareActionMode(ActionMode mode, Menu menu) { |
| 157 | mMenu = menu; |
| 158 | updateActionMenu(); |
| 159 | return true; |
| 160 | } |
| 161 | |
| 162 | private void updateActionMenu() { |
| 163 | assert(mMenu != null); |
Steve McKay | bd9f05a | 2016-10-10 10:18:36 -0700 | [diff] [blame] | 164 | mMenuManager.updateActionMenu(mMenu, mScope.selectionDetails); |
Garfield Tan | 84bd0f1 | 2016-09-12 14:18:32 -0700 | [diff] [blame] | 165 | Menus.disableHiddenItems(mMenu); |
| 166 | } |
| 167 | |
| 168 | @Override |
| 169 | public boolean onActionItemClicked(ActionMode mode, MenuItem item) { |
Steve McKay | bd9f05a | 2016-10-10 10:18:36 -0700 | [diff] [blame] | 170 | return mScope.menuItemClicker.accept(item); |
Garfield Tan | 84bd0f1 | 2016-09-12 14:18:32 -0700 | [diff] [blame] | 171 | } |
| 172 | |
| 173 | private static void setImportantForAccessibility( |
| 174 | Activity activity, int accessibilityImportance, @IdRes int[] viewIds) { |
| 175 | for (final int id : viewIds) { |
| 176 | final View v = activity.findViewById(id); |
| 177 | if (v != null) { |
| 178 | v.setImportantForAccessibility(accessibilityImportance); |
| 179 | } |
| 180 | } |
| 181 | } |
| 182 | |
| 183 | @FunctionalInterface |
| 184 | private interface AccessibilityImportanceSetter { |
| 185 | void setAccessibilityImportance(int accessibilityImportance, @IdRes int... viewIds); |
| 186 | } |
Steve McKay | c8889af | 2016-09-23 11:22:41 -0700 | [diff] [blame] | 187 | |
Steve McKay | bd9f05a | 2016-10-10 10:18:36 -0700 | [diff] [blame] | 188 | @Override |
| 189 | public void finishActionMode() { |
| 190 | if (mActionMode != null) { |
| 191 | mActionMode.finish(); |
| 192 | mActionMode = null; |
| 193 | } else { |
| 194 | Log.w(TAG, "Tried to finish a null action mode."); |
| 195 | } |
| 196 | } |
| 197 | |
Steve McKay | 5b0a2c1 | 2016-10-07 11:22:31 -0700 | [diff] [blame] | 198 | public ActionModeController reset( |
Ben Lin | 11a2c13 | 2017-05-03 18:46:37 -0700 | [diff] [blame] | 199 | SelectionDetails selectionDetails, EventHandler<MenuItem> menuItemClicker) { |
Steve McKay | 5b0a2c1 | 2016-10-07 11:22:31 -0700 | [diff] [blame] | 200 | assert(mActionMode == null); |
| 201 | assert(mMenu == null); |
| 202 | |
Steve McKay | bd9f05a | 2016-10-10 10:18:36 -0700 | [diff] [blame] | 203 | mScope.menuItemClicker = menuItemClicker; |
| 204 | mScope.selectionDetails = selectionDetails; |
Steve McKay | bd9f05a | 2016-10-10 10:18:36 -0700 | [diff] [blame] | 205 | mScope.accessibilityImportanceSetter = |
Steve McKay | 5b0a2c1 | 2016-10-07 11:22:31 -0700 | [diff] [blame] | 206 | (int accessibilityImportance, @IdRes int[] viewIds) -> { |
| 207 | setImportantForAccessibility( |
| 208 | mActivity, accessibilityImportance, viewIds); |
| 209 | }; |
| 210 | |
| 211 | return this; |
| 212 | } |
| 213 | |
Steve McKay | bd9f05a | 2016-10-10 10:18:36 -0700 | [diff] [blame] | 214 | private static final class ContentScope { |
Steve McKay | 5b0a2c1 | 2016-10-07 11:22:31 -0700 | [diff] [blame] | 215 | private EventHandler<MenuItem> menuItemClicker; |
| 216 | private SelectionDetails selectionDetails; |
Steve McKay | 5b0a2c1 | 2016-10-07 11:22:31 -0700 | [diff] [blame] | 217 | private AccessibilityImportanceSetter accessibilityImportanceSetter; |
| 218 | } |
Garfield Tan | 84bd0f1 | 2016-09-12 14:18:32 -0700 | [diff] [blame] | 219 | } |