Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

am f169bae8: am f8d37ab6: Merge "docs: add emphasis to adding a search button in activity UI" into honeycomb-mr2

Browse Source 
* commit 'f169bae87df61ad91bda0c547a59fdaeda1bed10':
  docs: add emphasis to adding a search button in activity UI
This commit is contained in:
Scott Main
2011-06-23 13:15:58 -07:00
committed by Android Git Automerger
parent 44b48a377d f169bae87d
commit 7c58d671d5
2 changed files with 37 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/html/guide/topics/search/index.jd
View File

@@ -52,7 +52,13 @@ example of the search dialog with optional search suggestions.</p>
<p class="note"><strong>Note</strong>: The search framework does <em>not</em> provide APIs to
search your data. To perform a search, you need to use APIs appropriate for your data. For example,
if your data is stored in an SQLite database, you should use the {@link android.database.sqlite}
APIs to perform searches.</p>
APIs to perform searches.
<br/><br/>
Also, there is no guarantee that every device provides a dedicated SEARCH button to invoke the
search interface in your application. When using the search dialog or a custom interface, you
must always provide a search button in your UI that activates the search interface. For more
information, see <a href="search-dialog.html#InvokingTheSearchDialog">Invoking the search
dialog</a>.</p>
<p>The following documents show you how to use Android's framework to implement search:</p>

65
docs/html/guide/topics/search/search-dialog.jd
View File

@@ -17,29 +17,30 @@ access</li>
<h2>In this document</h2>
<ol>
<li><a href="#TheBasics">The Basics</a></li>
<li><a href="#SearchableConfiguration">Creating a Searchable Configuration</a></li>
<li><a href="#SearchableActivity">Creating a Searchable Activity</a>
<ol>
<li><a href="#DeclaringSearchableActivity">Declaring a searchable activity</a></li>
<li><a href="#EnableSearch">Enabling the search dialog and search widget</a></li>
<li><a href="#PerformingSearch">Performing a search</a></li>
</ol>
</li>
<li><a href="#UsingTheSearchDialog">Using the Search Dialog</a>
<ol>
<li><a href="#LifeCycle">The impact of the search dialog on your activity lifecycle</a></li>
<li><a href="#SearchContextData">Passing search context data</a></li>
</ol>
</li>
<li><a href="#UsingSearchWidget">Using the Search Widget</a>
<ol>
<li><a href="#ConfiguringWidget">Configuring the search widget</a></li>
<li><a href="#WidgetFeatures">Other search widget features</a></li>
</ol>
</li>
<li><a href="#VoiceSearch">Adding Voice Search</a></li>
<li><a href="#SearchSuggestions">Adding Search Suggestions</a></li>
<li><a href="#TheBasics">The Basics</a></li>
<li><a href="#SearchableConfiguration">Creating a Searchable Configuration</a></li>
<li><a href="#SearchableActivity">Creating a Searchable Activity</a>
<ol>
<li><a href="#DeclaringSearchableActivity">Declaring a searchable activity</a></li>
<li><a href="#PerformingSearch">Performing a search</a></li>
</ol>
</li>
<li><a href="#SearchDialog">Using the Search Dialog</a>
<ol>
<li><a href="#InvokingTheSearchDialog">Invoking the search dialog</a></li>
<li><a href="#LifeCycle">The impact of the search dialog on your activity lifecycle</a></li>
<li><a href="#SearchContextData">Passing search context data</a></li>
</ol>
</li>
<li><a href="#UsingSearchWidget">Using the Search Widget</a>
<ol>
<li><a href="#ConfiguringWidget">Configuring the search widget</a></li>
<li><a href="#WidgetFeatures">Other search widget features</a></li>
<li><a href="#UsingBoth">Using both the widget and the dialog</a></li>
</ol>
</li>
<li><a href="#VoiceSearch">Adding Voice Search</a></li>
<li><a href="#SearchSuggestions">Adding Search Suggestions</a></li>
</ol>
<h2>Key classes</h2>
@@ -494,13 +495,13 @@ searches.</p>
<h3 id="InvokingTheSearchDialog">Invoking the search dialog</h3>
<p>As mentioned above, the device SEARCH button and {@link android.app.Activity#onSearchRequested
onSearchRequested()} method will open the search dialog, as long as the current activity
has declared the searchable activity to use, as shown in the previous section.</p>
<p>As mentioned above, the device SEARCH button will open the search dialog as long as the current
activity has declared in the manifest the searchable activity to use.</p>
<p>However, you should not assume that a SEARCH button is available on the user's device. You
should always provide another search button in your UI that activates the search dialog by calling
{@link android.app.Activity#onSearchRequested()}.</p>
<p>However, some devices do not include a dedicated SEARCH button, so you should not assume that
it's always available. When using the search dialog, you must <strong>always provide another search
button in your UI</strong> that activates the search dialog by calling {@link
android.app.Activity#onSearchRequested()}.</p>
<p>For instance, you should either provide a menu item in your <a
href="{@docRoot}guide/topics/ui/menus.html#options-menu">Options Menu</a> or a button in your
@@ -510,12 +511,6 @@ href="{@docRoot}shareables/search_icons.zip">search_icons.zip</a> file includes
medium and high density screens, which you can use for your search menu item or button (low-density
screens scale-down the hdpi image by one half). </p>
<!-- ... maybe this should go into the Creating Menus document ....
<p>If you chose to provide a shortcut key for the menu item, using {@link
android.view.MenuItem#setAlphabeticShortcut(char)}, then SearchManager.MENU_KEY is the recommended
key character, representing the default search key.</p>
-->
<p>You can also enable "type-to-search" functionality, which activates the search dialog when the
user starts typing on the keyboard&mdash;the keystrokes are inserted into the search dialog. You can
enable type-to-search in your activity by calling