SearchManager.java revision af5b406ad62af6f9d9e9f9f278683fb42015a4a2
1/* 2 * Copyright (C) 2007 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 17package android.app; 18 19import android.content.ActivityNotFoundException; 20import android.content.ComponentName; 21import android.content.ContentResolver; 22import android.content.Context; 23import android.content.DialogInterface; 24import android.content.Intent; 25import android.database.Cursor; 26import android.net.Uri; 27import android.os.Bundle; 28import android.os.Handler; 29import android.os.RemoteException; 30import android.os.ServiceManager; 31import android.text.TextUtils; 32import android.util.Log; 33import android.view.KeyEvent; 34 35import java.util.List; 36 37/** 38 * This class provides access to the system search services. 39 * 40 * <p>In practice, you won't interact with this class directly, as search 41 * services are provided through methods in {@link android.app.Activity Activity} 42 * and the {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH} 43 * {@link android.content.Intent Intent}. 44 * If you do require direct access to the SearchManager, do not instantiate 45 * this class directly. Instead, retrieve it through 46 * {@link android.content.Context#getSystemService 47 * context.getSystemService(Context.SEARCH_SERVICE)}. 48 * 49 * <div class="special"> 50 * <p>For a guide to using the search dialog and adding search 51 * suggestions in your application, see the Dev Guide topic about <strong><a 52 * href="{@docRoot}guide/topics/search/index.html">Search</a></strong>.</p> 53 * </div> 54 */ 55public class SearchManager 56 implements DialogInterface.OnDismissListener, DialogInterface.OnCancelListener 57{ 58 59 private static final boolean DBG = false; 60 private static final String TAG = "SearchManager"; 61 62 /** 63 * This is a shortcut definition for the default menu key to use for invoking search. 64 * 65 * See Menu.Item.setAlphabeticShortcut() for more information. 66 */ 67 public final static char MENU_KEY = 's'; 68 69 /** 70 * This is a shortcut definition for the default menu key to use for invoking search. 71 * 72 * See Menu.Item.setAlphabeticShortcut() for more information. 73 */ 74 public final static int MENU_KEYCODE = KeyEvent.KEYCODE_S; 75 76 /** 77 * Intent extra data key: Use this key with 78 * {@link android.content.Intent#getStringExtra 79 * content.Intent.getStringExtra()} 80 * to obtain the query string from Intent.ACTION_SEARCH. 81 */ 82 public final static String QUERY = "query"; 83 84 /** 85 * Intent extra data key: Use this key with 86 * {@link android.content.Intent#getStringExtra 87 * content.Intent.getStringExtra()} 88 * to obtain the query string typed in by the user. 89 * This may be different from the value of {@link #QUERY} 90 * if the intent is the result of selecting a suggestion. 91 * In that case, {@link #QUERY} will contain the value of 92 * {@link #SUGGEST_COLUMN_QUERY} for the suggestion, and 93 * {@link #USER_QUERY} will contain the string typed by the 94 * user. 95 */ 96 public final static String USER_QUERY = "user_query"; 97 98 /** 99 * Intent extra data key: Use this key with Intent.ACTION_SEARCH and 100 * {@link android.content.Intent#getBundleExtra 101 * content.Intent.getBundleExtra()} 102 * to obtain any additional app-specific data that was inserted by the 103 * activity that launched the search. 104 */ 105 public final static String APP_DATA = "app_data"; 106 107 /** 108 * Intent extra data key: Use {@link android.content.Intent#getBundleExtra 109 * content.Intent.getBundleExtra(SEARCH_MODE)} to get the search mode used 110 * to launch the intent. 111 * The only current value for this is {@link #MODE_GLOBAL_SEARCH_SUGGESTION}. 112 * 113 * @hide 114 */ 115 public final static String SEARCH_MODE = "search_mode"; 116 117 /** 118 * Intent extra data key: Use this key with Intent.ACTION_SEARCH and 119 * {@link android.content.Intent#getIntExtra content.Intent.getIntExtra()} 120 * to obtain the keycode that the user used to trigger this query. It will be zero if the 121 * user simply pressed the "GO" button on the search UI. This is primarily used in conjunction 122 * with the keycode attribute in the actionkey element of your searchable.xml configuration 123 * file. 124 */ 125 public final static String ACTION_KEY = "action_key"; 126 127 /** 128 * Intent extra data key: This key will be used for the extra populated by the 129 * {@link #SUGGEST_COLUMN_INTENT_EXTRA_DATA} column. 130 */ 131 public final static String EXTRA_DATA_KEY = "intent_extra_data_key"; 132 133 /** 134 * Boolean extra data key for {@link #INTENT_ACTION_GLOBAL_SEARCH} intents. If {@code true}, 135 * the initial query should be selected when the global search activity is started, so 136 * that the user can easily replace it with another query. 137 */ 138 public final static String EXTRA_SELECT_QUERY = "select_query"; 139 140 /** 141 * Boolean extra data key for {@link Intent#ACTION_WEB_SEARCH} intents. If {@code true}, 142 * this search should open a new browser window, rather than using an existing one. 143 */ 144 public final static String EXTRA_NEW_SEARCH = "new_search"; 145 146 /** 147 * Boolean extra data key for a suggestion provider to return in {@link Cursor#getExtras} to 148 * indicate that the search is not complete yet. This can be used by the search UI 149 * to indicate that a search is in progress. The suggestion provider can return partial results 150 * this way and send a change notification on the cursor when more results are available. 151 */ 152 public final static String CURSOR_EXTRA_KEY_IN_PROGRESS = "in_progress"; 153 154 /** 155 * Intent extra data key: Use this key with Intent.ACTION_SEARCH and 156 * {@link android.content.Intent#getStringExtra content.Intent.getStringExtra()} 157 * to obtain the action message that was defined for a particular search action key and/or 158 * suggestion. It will be null if the search was launched by typing "enter", touched the the 159 * "GO" button, or other means not involving any action key. 160 */ 161 public final static String ACTION_MSG = "action_msg"; 162 163 /** 164 * Flag to specify that the entry can be used for query refinement, i.e., the query text 165 * in the search field can be replaced with the text in this entry, when a query refinement 166 * icon is clicked. The suggestion list should show such a clickable icon beside the entry. 167 * <p>Use this flag as a bit-field for {@link #SUGGEST_COLUMN_FLAGS}. 168 */ 169 public final static int FLAG_QUERY_REFINEMENT = 1 << 0; 170 171 /** 172 * Uri path for queried suggestions data. This is the path that the search manager 173 * will use when querying your content provider for suggestions data based on user input 174 * (e.g. looking for partial matches). 175 * Typically you'll use this with a URI matcher. 176 */ 177 public final static String SUGGEST_URI_PATH_QUERY = "search_suggest_query"; 178 179 /** 180 * MIME type for suggestions data. You'll use this in your suggestions content provider 181 * in the getType() function. 182 */ 183 public final static String SUGGEST_MIME_TYPE = 184 "vnd.android.cursor.dir/vnd.android.search.suggest"; 185 186 /** 187 * Uri path for shortcut validation. This is the path that the search manager will use when 188 * querying your content provider to refresh a shortcutted suggestion result and to check if it 189 * is still valid. When asked, a source may return an up to date result, or no result. No 190 * result indicates the shortcut refers to a no longer valid sugggestion. 191 * 192 * @see #SUGGEST_COLUMN_SHORTCUT_ID 193 */ 194 public final static String SUGGEST_URI_PATH_SHORTCUT = "search_suggest_shortcut"; 195 196 /** 197 * MIME type for shortcut validation. You'll use this in your suggestions content provider 198 * in the getType() function. 199 */ 200 public final static String SHORTCUT_MIME_TYPE = 201 "vnd.android.cursor.item/vnd.android.search.suggest"; 202 203 /** 204 * Column name for suggestions cursor. <i>Unused - can be null or column can be omitted.</i> 205 */ 206 public final static String SUGGEST_COLUMN_FORMAT = "suggest_format"; 207 /** 208 * Column name for suggestions cursor. <i>Required.</i> This is the primary line of text that 209 * will be presented to the user as the suggestion. 210 */ 211 public final static String SUGGEST_COLUMN_TEXT_1 = "suggest_text_1"; 212 /** 213 * Column name for suggestions cursor. <i>Optional.</i> If your cursor includes this column, 214 * then all suggestions will be provided in a two-line format. The second line of text is in 215 * a much smaller appearance. 216 */ 217 public final static String SUGGEST_COLUMN_TEXT_2 = "suggest_text_2"; 218 219 /** 220 * Column name for suggestions cursor. <i>Optional.</i> This is a URL that will be shown 221 * as the second line of text instead of {@link #SUGGEST_COLUMN_TEXT_2}. This is a separate 222 * column so that the search UI knows to display the text as a URL, e.g. by using a different 223 * color. If this column is absent, or has the value {@code null}, 224 * {@link #SUGGEST_COLUMN_TEXT_2} will be used instead. 225 */ 226 public final static String SUGGEST_COLUMN_TEXT_2_URL = "suggest_text_2_url"; 227 228 /** 229 * Column name for suggestions cursor. <i>Optional.</i> If your cursor includes this column, 230 * then all suggestions will be provided in a format that includes space for two small icons, 231 * one at the left and one at the right of each suggestion. The data in the column must 232 * be a resource ID of a drawable, or a URI in one of the following formats: 233 * 234 * <ul> 235 * <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li> 236 * <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li> 237 * <li>file ({@link android.content.ContentResolver#SCHEME_FILE})</li> 238 * </ul> 239 * 240 * See {@link android.content.ContentResolver#openAssetFileDescriptor(Uri, String)} 241 * for more information on these schemes. 242 */ 243 public final static String SUGGEST_COLUMN_ICON_1 = "suggest_icon_1"; 244 /** 245 * Column name for suggestions cursor. <i>Optional.</i> If your cursor includes this column, 246 * then all suggestions will be provided in a format that includes space for two small icons, 247 * one at the left and one at the right of each suggestion. The data in the column must 248 * be a resource ID of a drawable, or a URI in one of the following formats: 249 * 250 * <ul> 251 * <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li> 252 * <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li> 253 * <li>file ({@link android.content.ContentResolver#SCHEME_FILE})</li> 254 * </ul> 255 * 256 * See {@link android.content.ContentResolver#openAssetFileDescriptor(Uri, String)} 257 * for more information on these schemes. 258 */ 259 public final static String SUGGEST_COLUMN_ICON_2 = "suggest_icon_2"; 260 /** 261 * Column name for suggestions cursor. <i>Optional.</i> If this column exists <i>and</i> 262 * this element exists at the given row, this is the action that will be used when 263 * forming the suggestion's intent. If the element is not provided, the action will be taken 264 * from the android:searchSuggestIntentAction field in your XML metadata. <i>At least one of 265 * these must be present for the suggestion to generate an intent.</i> Note: If your action is 266 * the same for all suggestions, it is more efficient to specify it using XML metadata and omit 267 * it from the cursor. 268 */ 269 public final static String SUGGEST_COLUMN_INTENT_ACTION = "suggest_intent_action"; 270 /** 271 * Column name for suggestions cursor. <i>Optional.</i> If this column exists <i>and</i> 272 * this element exists at the given row, this is the data that will be used when 273 * forming the suggestion's intent. If the element is not provided, the data will be taken 274 * from the android:searchSuggestIntentData field in your XML metadata. If neither source 275 * is provided, the Intent's data field will be null. Note: If your data is 276 * the same for all suggestions, or can be described using a constant part and a specific ID, 277 * it is more efficient to specify it using XML metadata and omit it from the cursor. 278 */ 279 public final static String SUGGEST_COLUMN_INTENT_DATA = "suggest_intent_data"; 280 /** 281 * Column name for suggestions cursor. <i>Optional.</i> If this column exists <i>and</i> 282 * this element exists at the given row, this is the data that will be used when 283 * forming the suggestion's intent. If not provided, the Intent's extra data field will be null. 284 * This column allows suggestions to provide additional arbitrary data which will be included as 285 * an extra under the key {@link #EXTRA_DATA_KEY}. 286 */ 287 public final static String SUGGEST_COLUMN_INTENT_EXTRA_DATA = "suggest_intent_extra_data"; 288 /** 289 * Column name for suggestions cursor. <i>Optional.</i> If this column exists <i>and</i> 290 * this element exists at the given row, then "/" and this value will be appended to the data 291 * field in the Intent. This should only be used if the data field has already been set to an 292 * appropriate base string. 293 */ 294 public final static String SUGGEST_COLUMN_INTENT_DATA_ID = "suggest_intent_data_id"; 295 /** 296 * Column name for suggestions cursor. <i>Required if action is 297 * {@link android.content.Intent#ACTION_SEARCH ACTION_SEARCH}, optional otherwise.</i> If this 298 * column exists <i>and</i> this element exists at the given row, this is the data that will be 299 * used when forming the suggestion's query. 300 */ 301 public final static String SUGGEST_COLUMN_QUERY = "suggest_intent_query"; 302 303 /** 304 * Column name for suggestions cursor. <i>Optional.</i> This column is used to indicate whether 305 * a search suggestion should be stored as a shortcut, and whether it should be refreshed. If 306 * missing, the result will be stored as a shortcut and never validated. If set to 307 * {@link #SUGGEST_NEVER_MAKE_SHORTCUT}, the result will not be stored as a shortcut. 308 * Otherwise, the shortcut id will be used to check back for an up to date suggestion using 309 * {@link #SUGGEST_URI_PATH_SHORTCUT}. 310 */ 311 public final static String SUGGEST_COLUMN_SHORTCUT_ID = "suggest_shortcut_id"; 312 313 /** 314 * Column name for suggestions cursor. <i>Optional.</i> This column is used to specify 315 * that a spinner should be shown in lieu of an icon2 while the shortcut of this suggestion 316 * is being refreshed. 317 */ 318 public final static String SUGGEST_COLUMN_SPINNER_WHILE_REFRESHING = 319 "suggest_spinner_while_refreshing"; 320 321 /** 322 * Column name for suggestions cursor. <i>Optional.</i> This column is used to specify 323 * additional flags per item. Multiple flags can be specified. 324 * <p> 325 * Must be one of {@link #FLAG_QUERY_REFINEMENT} or 0 to indicate no flags. 326 * </p> 327 */ 328 public final static String SUGGEST_COLUMN_FLAGS = "suggest_flags"; 329 330 /** 331 * Column value for suggestion column {@link #SUGGEST_COLUMN_SHORTCUT_ID} when a suggestion 332 * should not be stored as a shortcut in global search. 333 */ 334 public final static String SUGGEST_NEVER_MAKE_SHORTCUT = "_-1"; 335 336 /** 337 * Query parameter added to suggestion queries to limit the number of suggestions returned. 338 * This limit is only advisory and suggestion providers may chose to ignore it. 339 */ 340 public final static String SUGGEST_PARAMETER_LIMIT = "limit"; 341 342 /** 343 * Intent action for starting the global search activity. 344 * The global search provider should handle this intent. 345 * 346 * Supported extra data keys: {@link #QUERY}, 347 * {@link #EXTRA_SELECT_QUERY}, 348 * {@link #APP_DATA}. 349 */ 350 public final static String INTENT_ACTION_GLOBAL_SEARCH 351 = "android.search.action.GLOBAL_SEARCH"; 352 353 /** 354 * Intent action for starting the global search settings activity. 355 * The global search provider should handle this intent. 356 */ 357 public final static String INTENT_ACTION_SEARCH_SETTINGS 358 = "android.search.action.SEARCH_SETTINGS"; 359 360 /** 361 * Intent action for starting a web search provider's settings activity. 362 * Web search providers should handle this intent if they have provider-specific 363 * settings to implement. 364 */ 365 public final static String INTENT_ACTION_WEB_SEARCH_SETTINGS 366 = "android.search.action.WEB_SEARCH_SETTINGS"; 367 368 /** 369 * Intent action broadcasted to inform that the searchables list or default have changed. 370 * Components should handle this intent if they cache any searchable data and wish to stay 371 * up to date on changes. 372 */ 373 public final static String INTENT_ACTION_SEARCHABLES_CHANGED 374 = "android.search.action.SEARCHABLES_CHANGED"; 375 376 /** 377 * Intent action broadcasted to inform that the search settings have changed in some way. 378 * Either searchables have been enabled or disabled, or a different web search provider 379 * has been chosen. 380 */ 381 public final static String INTENT_ACTION_SEARCH_SETTINGS_CHANGED 382 = "android.search.action.SETTINGS_CHANGED"; 383 384 /** 385 * This means that context is voice, and therefore the SearchDialog should 386 * continue showing the microphone until the user indicates that he/she does 387 * not want to re-speak (e.g. by typing). 388 * 389 * @hide 390 */ 391 public final static String CONTEXT_IS_VOICE = "android.search.CONTEXT_IS_VOICE"; 392 393 /** 394 * This means that the voice icon should not be shown at all, because the 395 * current search engine does not support voice search. 396 * @hide 397 */ 398 public final static String DISABLE_VOICE_SEARCH 399 = "android.search.DISABLE_VOICE_SEARCH"; 400 401 /** 402 * Reference to the shared system search service. 403 */ 404 private static ISearchManager mService; 405 406 private final Context mContext; 407 408 /** 409 * The package associated with this seach manager. 410 */ 411 private String mAssociatedPackage; 412 413 // package private since they are used by the inner class SearchManagerCallback 414 /* package */ final Handler mHandler; 415 /* package */ OnDismissListener mDismissListener = null; 416 /* package */ OnCancelListener mCancelListener = null; 417 418 private SearchDialog mSearchDialog; 419 420 /*package*/ SearchManager(Context context, Handler handler) { 421 mContext = context; 422 mHandler = handler; 423 mService = ISearchManager.Stub.asInterface( 424 ServiceManager.getService(Context.SEARCH_SERVICE)); 425 } 426 427 /** 428 * Launch search UI. 429 * 430 * <p>The search manager will open a search widget in an overlapping 431 * window, and the underlying activity may be obscured. The search 432 * entry state will remain in effect until one of the following events: 433 * <ul> 434 * <li>The user completes the search. In most cases this will launch 435 * a search intent.</li> 436 * <li>The user uses the back, home, or other keys to exit the search.</li> 437 * <li>The application calls the {@link #stopSearch} 438 * method, which will hide the search window and return focus to the 439 * activity from which it was launched.</li> 440 * 441 * <p>Most applications will <i>not</i> use this interface to invoke search. 442 * The primary method for invoking search is to call 443 * {@link android.app.Activity#onSearchRequested Activity.onSearchRequested()} or 444 * {@link android.app.Activity#startSearch Activity.startSearch()}. 445 * 446 * @param initialQuery A search string can be pre-entered here, but this 447 * is typically null or empty. 448 * @param selectInitialQuery If true, the intial query will be preselected, which means that 449 * any further typing will replace it. This is useful for cases where an entire pre-formed 450 * query is being inserted. If false, the selection point will be placed at the end of the 451 * inserted query. This is useful when the inserted query is text that the user entered, 452 * and the user would expect to be able to keep typing. <i>This parameter is only meaningful 453 * if initialQuery is a non-empty string.</i> 454 * @param launchActivity The ComponentName of the activity that has launched this search. 455 * @param appSearchData An application can insert application-specific 456 * context here, in order to improve quality or specificity of its own 457 * searches. This data will be returned with SEARCH intent(s). Null if 458 * no extra data is required. 459 * @param globalSearch If false, this will only launch the search that has been specifically 460 * defined by the application (which is usually defined as a local search). If no default 461 * search is defined in the current application or activity, global search will be launched. 462 * If true, this will always launch a platform-global (e.g. web-based) search instead. 463 * 464 * @see android.app.Activity#onSearchRequested 465 * @see #stopSearch 466 */ 467 public void startSearch(String initialQuery, 468 boolean selectInitialQuery, 469 ComponentName launchActivity, 470 Bundle appSearchData, 471 boolean globalSearch) { 472 if (globalSearch) { 473 startGlobalSearch(initialQuery, selectInitialQuery, appSearchData); 474 return; 475 } 476 477 ensureSearchDialog(); 478 479 mSearchDialog.show(initialQuery, selectInitialQuery, launchActivity, appSearchData); 480 } 481 482 private void ensureSearchDialog() { 483 if (mSearchDialog == null) { 484 mSearchDialog = new SearchDialog(mContext, this); 485 mSearchDialog.setOnCancelListener(this); 486 mSearchDialog.setOnDismissListener(this); 487 } 488 } 489 490 /** 491 * Starts the global search activity. 492 */ 493 /* package */ void startGlobalSearch(String initialQuery, boolean selectInitialQuery, 494 Bundle appSearchData) { 495 ComponentName globalSearchActivity = getGlobalSearchActivity(); 496 if (globalSearchActivity == null) { 497 Log.w(TAG, "No global search activity found."); 498 return; 499 } 500 Intent intent = new Intent(INTENT_ACTION_GLOBAL_SEARCH); 501 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK); 502 intent.setComponent(globalSearchActivity); 503 // Make sure that we have a Bundle to put source in 504 if (appSearchData == null) { 505 appSearchData = new Bundle(); 506 } else { 507 appSearchData = new Bundle(appSearchData); 508 } 509 // Set source to package name of app that starts global search, if not set already. 510 if (!appSearchData.containsKey("source")) { 511 appSearchData.putString("source", mContext.getPackageName()); 512 } 513 intent.putExtra(APP_DATA, appSearchData); 514 if (!TextUtils.isEmpty(initialQuery)) { 515 intent.putExtra(QUERY, initialQuery); 516 } 517 if (selectInitialQuery) { 518 intent.putExtra(EXTRA_SELECT_QUERY, selectInitialQuery); 519 } 520 try { 521 if (DBG) Log.d(TAG, "Starting global search: " + intent.toUri(0)); 522 mContext.startActivity(intent); 523 } catch (ActivityNotFoundException ex) { 524 Log.e(TAG, "Global search activity not found: " + globalSearchActivity); 525 } 526 } 527 528 /** 529 * Gets the name of the global search activity. 530 * 531 * @hide 532 */ 533 public ComponentName getGlobalSearchActivity() { 534 try { 535 return mService.getGlobalSearchActivity(); 536 } catch (RemoteException ex) { 537 Log.e(TAG, "getGlobalSearchActivity() failed: " + ex); 538 return null; 539 } 540 } 541 542 /** 543 * Gets the name of the web search activity. 544 * 545 * @return The name of the default activity for web searches. This activity 546 * can be used to get web search suggestions. Returns {@code null} if 547 * there is no default web search activity. 548 * 549 * @hide 550 */ 551 public ComponentName getWebSearchActivity() { 552 try { 553 return mService.getWebSearchActivity(); 554 } catch (RemoteException ex) { 555 Log.e(TAG, "getWebSearchActivity() failed: " + ex); 556 return null; 557 } 558 } 559 560 /** 561 * Similar to {@link #startSearch} but actually fires off the search query after invoking 562 * the search dialog. Made available for testing purposes. 563 * 564 * @param query The query to trigger. If empty, request will be ignored. 565 * @param launchActivity The ComponentName of the activity that has launched this search. 566 * @param appSearchData An application can insert application-specific 567 * context here, in order to improve quality or specificity of its own 568 * searches. This data will be returned with SEARCH intent(s). Null if 569 * no extra data is required. 570 * 571 * @see #startSearch 572 */ 573 public void triggerSearch(String query, 574 ComponentName launchActivity, 575 Bundle appSearchData) { 576 if (!mAssociatedPackage.equals(launchActivity.getPackageName())) { 577 throw new IllegalArgumentException("invoking app search on a different package " + 578 "not associated with this search manager"); 579 } 580 if (query == null || TextUtils.getTrimmedLength(query) == 0) { 581 Log.w(TAG, "triggerSearch called with empty query, ignoring."); 582 return; 583 } 584 startSearch(query, false, launchActivity, appSearchData, false); 585 mSearchDialog.launchQuerySearch(); 586 } 587 588 /** 589 * Terminate search UI. 590 * 591 * <p>Typically the user will terminate the search UI by launching a 592 * search or by canceling. This function allows the underlying application 593 * or activity to cancel the search prematurely (for any reason). 594 * 595 * <p>This function can be safely called at any time (even if no search is active.) 596 * 597 * @see #startSearch 598 */ 599 public void stopSearch() { 600 if (mSearchDialog != null) { 601 mSearchDialog.cancel(); 602 } 603 } 604 605 /** 606 * Determine if the Search UI is currently displayed. 607 * 608 * This is provided primarily for application test purposes. 609 * 610 * @return Returns true if the search UI is currently displayed. 611 * 612 * @hide 613 */ 614 public boolean isVisible() { 615 return mSearchDialog == null? false : mSearchDialog.isShowing(); 616 } 617 618 /** 619 * See {@link SearchManager#setOnDismissListener} for configuring your activity to monitor 620 * search UI state. 621 */ 622 public interface OnDismissListener { 623 /** 624 * This method will be called when the search UI is dismissed. To make use of it, you must 625 * implement this method in your activity, and call 626 * {@link SearchManager#setOnDismissListener} to register it. 627 */ 628 public void onDismiss(); 629 } 630 631 /** 632 * See {@link SearchManager#setOnCancelListener} for configuring your activity to monitor 633 * search UI state. 634 */ 635 public interface OnCancelListener { 636 /** 637 * This method will be called when the search UI is canceled. To make use if it, you must 638 * implement this method in your activity, and call 639 * {@link SearchManager#setOnCancelListener} to register it. 640 */ 641 public void onCancel(); 642 } 643 644 /** 645 * Set or clear the callback that will be invoked whenever the search UI is dismissed. 646 * 647 * @param listener The {@link OnDismissListener} to use, or null. 648 */ 649 public void setOnDismissListener(final OnDismissListener listener) { 650 mDismissListener = listener; 651 } 652 653 /** 654 * Set or clear the callback that will be invoked whenever the search UI is canceled. 655 * 656 * @param listener The {@link OnCancelListener} to use, or null. 657 */ 658 public void setOnCancelListener(OnCancelListener listener) { 659 mCancelListener = listener; 660 } 661 662 /** 663 * @deprecated This method is an obsolete internal implementation detail. Do not use. 664 */ 665 @Deprecated 666 public void onCancel(DialogInterface dialog) { 667 if (mCancelListener != null) { 668 mCancelListener.onCancel(); 669 } 670 } 671 672 /** 673 * @deprecated This method is an obsolete internal implementation detail. Do not use. 674 */ 675 @Deprecated 676 public void onDismiss(DialogInterface dialog) { 677 if (mDismissListener != null) { 678 mDismissListener.onDismiss(); 679 } 680 } 681 682 /** 683 * Gets information about a searchable activity. 684 * 685 * @param componentName The activity to get searchable information for. 686 * @return Searchable information, or <code>null</code> if the activity does not 687 * exist, or is not searchable. 688 */ 689 public SearchableInfo getSearchableInfo(ComponentName componentName) { 690 try { 691 return mService.getSearchableInfo(componentName); 692 } catch (RemoteException ex) { 693 Log.e(TAG, "getSearchableInfo() failed: " + ex); 694 return null; 695 } 696 } 697 698 /** 699 * Gets a cursor with search suggestions. 700 * 701 * @param searchable Information about how to get the suggestions. 702 * @param query The search text entered (so far). 703 * @return a cursor with suggestions, or <code>null</null> the suggestion query failed. 704 * 705 * @hide because SearchableInfo is not part of the API. 706 */ 707 public Cursor getSuggestions(SearchableInfo searchable, String query) { 708 return getSuggestions(searchable, query, -1); 709 } 710 711 /** 712 * Gets a cursor with search suggestions. 713 * 714 * @param searchable Information about how to get the suggestions. 715 * @param query The search text entered (so far). 716 * @param limit The query limit to pass to the suggestion provider. This is advisory, 717 * the returned cursor may contain more rows. Pass {@code -1} for no limit. 718 * @return a cursor with suggestions, or <code>null</null> the suggestion query failed. 719 * 720 * @hide because SearchableInfo is not part of the API. 721 */ 722 public Cursor getSuggestions(SearchableInfo searchable, String query, int limit) { 723 if (searchable == null) { 724 return null; 725 } 726 727 String authority = searchable.getSuggestAuthority(); 728 if (authority == null) { 729 return null; 730 } 731 732 Uri.Builder uriBuilder = new Uri.Builder() 733 .scheme(ContentResolver.SCHEME_CONTENT) 734 .authority(authority) 735 .query("") // TODO: Remove, workaround for a bug in Uri.writeToParcel() 736 .fragment(""); // TODO: Remove, workaround for a bug in Uri.writeToParcel() 737 738 // if content path provided, insert it now 739 final String contentPath = searchable.getSuggestPath(); 740 if (contentPath != null) { 741 uriBuilder.appendEncodedPath(contentPath); 742 } 743 744 // append standard suggestion query path 745 uriBuilder.appendPath(SearchManager.SUGGEST_URI_PATH_QUERY); 746 747 // get the query selection, may be null 748 String selection = searchable.getSuggestSelection(); 749 // inject query, either as selection args or inline 750 String[] selArgs = null; 751 if (selection != null) { // use selection if provided 752 selArgs = new String[] { query }; 753 } else { // no selection, use REST pattern 754 uriBuilder.appendPath(query); 755 } 756 757 if (limit > 0) { 758 uriBuilder.appendQueryParameter(SUGGEST_PARAMETER_LIMIT, String.valueOf(limit)); 759 } 760 761 Uri uri = uriBuilder.build(); 762 763 // finally, make the query 764 return mContext.getContentResolver().query(uri, null, selection, selArgs, null); 765 } 766 767 /** 768 * Returns a list of the searchable activities that can be included in global search. 769 * 770 * @return a list containing searchable information for all searchable activities 771 * that have the <code>android:includeInGlobalSearch</code> attribute set 772 * in their searchable meta-data. 773 */ 774 public List<SearchableInfo> getSearchablesInGlobalSearch() { 775 try { 776 return mService.getSearchablesInGlobalSearch(); 777 } catch (RemoteException e) { 778 Log.e(TAG, "getSearchablesInGlobalSearch() failed: " + e); 779 return null; 780 } 781 } 782 783} 784