Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2013 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 | |
Steve McKay | d9caa6a | 2016-09-15 16:36:45 -0700 | [diff] [blame] | 19 | import static com.android.documentsui.base.Shared.DEBUG; |
Ben Kwa | 543a292 | 2016-03-22 11:11:46 -0700 | [diff] [blame] | 20 | |
Aga Wronska | af5ace5 | 2016-02-17 13:50:42 -0800 | [diff] [blame] | 21 | import android.annotation.Nullable; |
| 22 | import android.os.Bundle; |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 23 | import android.provider.DocumentsContract.Root; |
| 24 | import android.text.TextUtils; |
| 25 | import android.util.Log; |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 26 | import android.view.Menu; |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 27 | import android.view.MenuItem; |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 28 | import android.view.MenuItem.OnActionExpandListener; |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 29 | import android.view.View; |
| 30 | import android.view.View.OnClickListener; |
| 31 | import android.view.View.OnFocusChangeListener; |
| 32 | import android.widget.SearchView; |
| 33 | import android.widget.SearchView.OnQueryTextListener; |
| 34 | |
Steve McKay | d080506 | 2016-09-15 14:30:38 -0700 | [diff] [blame] | 35 | import com.android.documentsui.base.RootInfo; |
Steve McKay | d9caa6a | 2016-09-15 16:36:45 -0700 | [diff] [blame] | 36 | import com.android.documentsui.base.Shared; |
Garfield, Tan | 11d2348 | 2016-08-05 09:33:29 -0700 | [diff] [blame] | 37 | import com.android.documentsui.sorting.SortModel; |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 38 | |
| 39 | /** |
| 40 | * Manages searching UI behavior. |
| 41 | */ |
Ben Lin | 7c35b03 | 2016-05-31 13:24:01 -0700 | [diff] [blame] | 42 | public class SearchViewManager implements |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 43 | SearchView.OnCloseListener, OnQueryTextListener, OnClickListener, OnFocusChangeListener, |
| 44 | OnActionExpandListener { |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 45 | |
| 46 | public interface SearchManagerListener { |
Aga Wronska | af5ace5 | 2016-02-17 13:50:42 -0800 | [diff] [blame] | 47 | void onSearchChanged(@Nullable String query); |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 48 | void onSearchFinished(); |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 49 | } |
| 50 | |
Ben Lin | 7c35b03 | 2016-05-31 13:24:01 -0700 | [diff] [blame] | 51 | private static final String TAG = "SearchManager"; |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 52 | |
| 53 | private SearchManagerListener mListener; |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 54 | private boolean mSearchExpanded; |
Aga Wronska | af5ace5 | 2016-02-17 13:50:42 -0800 | [diff] [blame] | 55 | private String mCurrentSearch; |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 56 | private boolean mIgnoreNextClose; |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 57 | private boolean mFullBar; |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 58 | |
Steve McKay | 18d01e8 | 2016-02-03 11:15:57 -0800 | [diff] [blame] | 59 | private DocumentsToolbar mActionBar; |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 60 | private MenuItem mMenuItem; |
| 61 | private SearchView mSearchView; |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 62 | |
Garfield, Tan | 11d2348 | 2016-08-05 09:33:29 -0700 | [diff] [blame] | 63 | // We need to disable sorting during search. |
| 64 | private SortModel mSortModel; |
| 65 | |
| 66 | public SearchViewManager( |
| 67 | SearchManagerListener listener, @Nullable Bundle savedState, SortModel sortModel) { |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 68 | mListener = listener; |
Aga Wronska | af5ace5 | 2016-02-17 13:50:42 -0800 | [diff] [blame] | 69 | mCurrentSearch = savedState != null ? savedState.getString(Shared.EXTRA_QUERY) : null; |
Garfield, Tan | 11d2348 | 2016-08-05 09:33:29 -0700 | [diff] [blame] | 70 | mSortModel = sortModel; |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 71 | } |
| 72 | |
| 73 | public void setSearchMangerListener(SearchManagerListener listener) { |
| 74 | mListener = listener; |
| 75 | } |
| 76 | |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 77 | public void install(DocumentsToolbar actionBar, boolean isFullBarSearch) { |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 78 | mActionBar = actionBar; |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 79 | mMenuItem = actionBar.getSearchMenu(); |
| 80 | mSearchView = (SearchView) mMenuItem.getActionView(); |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 81 | |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 82 | mSearchView.setOnQueryTextListener(this); |
| 83 | mSearchView.setOnCloseListener(this); |
| 84 | mSearchView.setOnSearchClickListener(this); |
| 85 | mSearchView.setOnQueryTextFocusChangeListener(this); |
| 86 | |
| 87 | mFullBar = isFullBarSearch; |
| 88 | if (mFullBar) { |
| 89 | mMenuItem.setShowAsActionFlags(MenuItem.SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW |
| 90 | | MenuItem.SHOW_AS_ACTION_ALWAYS); |
| 91 | mMenuItem.setOnActionExpandListener(this); |
| 92 | } |
Aga Wronska | af5ace5 | 2016-02-17 13:50:42 -0800 | [diff] [blame] | 93 | |
| 94 | restoreSearch(); |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 95 | } |
| 96 | |
| 97 | /** |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 98 | * Used to hide menu icons, when the search is being restored. Needed because search restoration |
| 99 | * is done before onPrepareOptionsMenu(Menu menu) that is overriding the icons visibility. |
| 100 | */ |
| 101 | public void updateMenu() { |
| 102 | if (isSearching() && mFullBar) { |
| 103 | Menu menu = mActionBar.getMenu(); |
| 104 | menu.setGroupVisible(R.id.group_hide_when_searching, false); |
| 105 | } |
| 106 | } |
| 107 | |
| 108 | /** |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 109 | * @param root Info about the current directory. |
| 110 | */ |
| 111 | void update(RootInfo root) { |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 112 | if (mMenuItem == null) { |
Ben Kwa | 543a292 | 2016-03-22 11:11:46 -0700 | [diff] [blame] | 113 | if (DEBUG) Log.d(TAG, "update called before Search MenuItem installed."); |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 114 | return; |
| 115 | } |
| 116 | |
Aga Wronska | af5ace5 | 2016-02-17 13:50:42 -0800 | [diff] [blame] | 117 | if (mCurrentSearch != null) { |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 118 | mMenuItem.expandActionView(); |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 119 | |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 120 | mSearchView.setIconified(false); |
| 121 | mSearchView.clearFocus(); |
| 122 | mSearchView.setQuery(mCurrentSearch, false); |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 123 | } else { |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 124 | mSearchView.clearFocus(); |
| 125 | if (!mSearchView.isIconified()) { |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 126 | mIgnoreNextClose = true; |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 127 | mSearchView.setIconified(true); |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 128 | } |
| 129 | |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 130 | if (mMenuItem.isActionViewExpanded()) { |
| 131 | mMenuItem.collapseActionView(); |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 132 | } |
| 133 | } |
| 134 | |
| 135 | showMenu(root != null |
| 136 | && ((root.flags & Root.FLAG_SUPPORTS_SEARCH) != 0)); |
| 137 | } |
| 138 | |
Garfield Tan | 2567603 | 2016-09-19 13:52:35 -0700 | [diff] [blame] | 139 | public void showMenu(boolean visible) { |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 140 | if (mMenuItem == null) { |
Ben Kwa | 543a292 | 2016-03-22 11:11:46 -0700 | [diff] [blame] | 141 | if (DEBUG) Log.d(TAG, "showMenu called before Search MenuItem installed."); |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 142 | return; |
| 143 | } |
| 144 | |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 145 | if (!visible) { |
Aga Wronska | af5ace5 | 2016-02-17 13:50:42 -0800 | [diff] [blame] | 146 | mCurrentSearch = null; |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 147 | } |
Aga Wronska | af5ace5 | 2016-02-17 13:50:42 -0800 | [diff] [blame] | 148 | |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 149 | mMenuItem.setVisible(visible); |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 150 | } |
| 151 | |
| 152 | /** |
| 153 | * Cancels current search operation. Triggers clearing and collapsing the SearchView. |
| 154 | * |
| 155 | * @return True if it cancels search. False if it does not operate search currently. |
| 156 | */ |
| 157 | boolean cancelSearch() { |
| 158 | if (isExpanded() || isSearching()) { |
| 159 | // If the query string is not empty search view won't get iconified |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 160 | mSearchView.setQuery("", false); |
| 161 | |
| 162 | if (mFullBar) { |
| 163 | onClose(); |
| 164 | } else { |
| 165 | // Causes calling onClose(). onClose() is triggering directory content update. |
| 166 | mSearchView.setIconified(true); |
| 167 | } |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 168 | return true; |
| 169 | } |
| 170 | return false; |
| 171 | } |
| 172 | |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 173 | /** |
| 174 | * Sets search view into the searching state. Used to restore state after device orientation |
| 175 | * change. |
| 176 | */ |
Aga Wronska | af5ace5 | 2016-02-17 13:50:42 -0800 | [diff] [blame] | 177 | private void restoreSearch() { |
| 178 | if (isSearching()) { |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 179 | if(mFullBar) { |
| 180 | mMenuItem.expandActionView(); |
| 181 | } else { |
| 182 | mSearchView.setIconified(false); |
| 183 | } |
Aga Wronska | af5ace5 | 2016-02-17 13:50:42 -0800 | [diff] [blame] | 184 | onSearchExpanded(); |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 185 | mSearchView.setQuery(mCurrentSearch, false); |
| 186 | mSearchView.clearFocus(); |
Aga Wronska | af5ace5 | 2016-02-17 13:50:42 -0800 | [diff] [blame] | 187 | } |
| 188 | } |
| 189 | |
| 190 | private void onSearchExpanded() { |
| 191 | mSearchExpanded = true; |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 192 | if(mFullBar) { |
| 193 | Menu menu = mActionBar.getMenu(); |
| 194 | menu.setGroupVisible(R.id.group_hide_when_searching, false); |
| 195 | } |
Garfield, Tan | 11d2348 | 2016-08-05 09:33:29 -0700 | [diff] [blame] | 196 | |
| 197 | mSortModel.setSortEnabled(false); |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 198 | } |
| 199 | |
| 200 | /** |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 201 | * Clears the search. Triggers refreshing of the directory content. |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 202 | * @return True if the default behavior of clearing/dismissing SearchView should be overridden. |
| 203 | * False otherwise. |
| 204 | */ |
| 205 | @Override |
| 206 | public boolean onClose() { |
| 207 | mSearchExpanded = false; |
| 208 | if (mIgnoreNextClose) { |
| 209 | mIgnoreNextClose = false; |
| 210 | return false; |
| 211 | } |
| 212 | |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 213 | // Refresh the directory if a search was done |
Aga Wronska | af5ace5 | 2016-02-17 13:50:42 -0800 | [diff] [blame] | 214 | if (mCurrentSearch != null) { |
| 215 | mCurrentSearch = null; |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 216 | if (mListener != null) { |
Aga Wronska | af5ace5 | 2016-02-17 13:50:42 -0800 | [diff] [blame] | 217 | mListener.onSearchChanged(mCurrentSearch); |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 218 | } |
| 219 | } |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 220 | |
| 221 | if(mFullBar) { |
| 222 | mMenuItem.collapseActionView(); |
| 223 | } |
| 224 | mListener.onSearchFinished(); |
| 225 | |
Garfield, Tan | 11d2348 | 2016-08-05 09:33:29 -0700 | [diff] [blame] | 226 | mSortModel.setSortEnabled(true); |
| 227 | |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 228 | return false; |
| 229 | } |
| 230 | |
| 231 | /** |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 232 | * Called when owning activity is saving state to be used to restore state during creation. |
| 233 | * @param state Bundle to save state too |
| 234 | */ |
| 235 | public void onSaveInstanceState(Bundle state) { |
| 236 | state.putString(Shared.EXTRA_QUERY, mCurrentSearch); |
| 237 | } |
| 238 | |
| 239 | /** |
| 240 | * Sets mSearchExpanded. Called when search icon is clicked to start search for both search view |
| 241 | * modes. |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 242 | */ |
| 243 | @Override |
| 244 | public void onClick(View v) { |
Aga Wronska | af5ace5 | 2016-02-17 13:50:42 -0800 | [diff] [blame] | 245 | onSearchExpanded(); |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 246 | } |
| 247 | |
| 248 | @Override |
| 249 | public boolean onQueryTextSubmit(String query) { |
Aga Wronska | af5ace5 | 2016-02-17 13:50:42 -0800 | [diff] [blame] | 250 | mCurrentSearch = query; |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 251 | mSearchView.clearFocus(); |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 252 | if (mListener != null) { |
Aga Wronska | af5ace5 | 2016-02-17 13:50:42 -0800 | [diff] [blame] | 253 | mListener.onSearchChanged(mCurrentSearch); |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 254 | } |
| 255 | return true; |
| 256 | } |
| 257 | |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 258 | /** |
| 259 | * Used to detect and handle back button pressed event when search is expanded. |
| 260 | */ |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 261 | @Override |
| 262 | public void onFocusChange(View v, boolean hasFocus) { |
| 263 | if (!hasFocus) { |
Aga Wronska | af5ace5 | 2016-02-17 13:50:42 -0800 | [diff] [blame] | 264 | if (mCurrentSearch == null) { |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 265 | mSearchView.setIconified(true); |
| 266 | } else if (TextUtils.isEmpty(mSearchView.getQuery())) { |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 267 | cancelSearch(); |
| 268 | } |
| 269 | } |
| 270 | } |
| 271 | |
| 272 | @Override |
| 273 | public boolean onQueryTextChange(String newText) { |
| 274 | return false; |
| 275 | } |
Aga Wronska | af5ace5 | 2016-02-17 13:50:42 -0800 | [diff] [blame] | 276 | |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 277 | @Override |
| 278 | public boolean onMenuItemActionCollapse(MenuItem item) { |
| 279 | Menu menu = mActionBar.getMenu(); |
| 280 | menu.setGroupVisible(R.id.group_hide_when_searching, true); |
| 281 | |
| 282 | // Handles case when search view is collapsed by using the arrow on the left of the bar |
| 283 | if (isExpanded() || isSearching()) { |
| 284 | cancelSearch(); |
| 285 | return false; |
| 286 | } |
| 287 | return true; |
| 288 | } |
| 289 | |
| 290 | @Override |
| 291 | public boolean onMenuItemActionExpand(MenuItem item) { |
| 292 | return true; |
| 293 | } |
| 294 | |
Aga Wronska | af5ace5 | 2016-02-17 13:50:42 -0800 | [diff] [blame] | 295 | String getCurrentSearch() { |
| 296 | return mCurrentSearch; |
| 297 | } |
| 298 | |
Steve McKay | 16e0c1f | 2016-09-15 12:41:13 -0700 | [diff] [blame] | 299 | public boolean isSearching() { |
Aga Wronska | 8e21daa | 2016-03-24 18:22:09 -0700 | [diff] [blame] | 300 | return mCurrentSearch != null; |
| 301 | } |
| 302 | |
| 303 | boolean isExpanded() { |
| 304 | return mSearchExpanded; |
| 305 | } |
Aga Wronska | 8788dad | 2016-01-15 17:30:15 -0800 | [diff] [blame] | 306 | } |