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