Android的搜索框架实例详解
基础知识
android的搜索框架将代您管理的搜索对话框,您不需要自己去开发一个搜索框,不需要担心要把搜索框放什么位置,也不需要担心搜索框影响您当前的界面。所有的这些工作都由searchmanager类来为您处理(以下简称“搜索管理器”),它管理的android搜索对话框的整个生命周期,并执行您的应用程序将发送的搜索请求,返回相应的搜索关键字。
当用户执行一个搜索,搜索管理器将使用一个专门的intent把搜索查询的关键字传给您在配置文件中配置的处理搜索结果的activity。从本质上讲,所有你需要的就是一个activity来接收intent,然后执行搜索,并给出结果。具体来说,你需要的做的事就包括以下内容:
一个搜索配置
我们用个xml配置文件来对搜索对话框进行配置,包括一些功能的配置,如文本框,设置语音搜索和搜索建议中显示的提示文字等。
一个用来处理搜索请求的activity
这个activity用来接收搜索查询的内容,然后搜索您的数据并显示搜索结果。
一种用户执行搜索的途径
默认情况下,一旦你配置了一个可搜索的activity,设备搜索键(如果有)将调用搜索对话框。然而,你应该始终提供另一种手段,让用户可以调用搜索对话框,如在选项菜单中的搜索按钮或其他用户界面上的按钮,因为不是所有的设备提供一个专门的搜索键。
创建一个搜索对话框配置文件
搜索框配置文件是一个用来配置您的应用程序中搜索框的设置的xml文件,这个文件一般命名为searchable.xml,并且必须保存在项目的res/xml/目录下。
配置文件的根节点必须为,可以有一个或多个属性。如下所示:
<?xml version="1.0" encoding="utf-8"?> <searchable xmlns:android="http://schemas.android.com/apk/res/android" android:label="@string/searchlabel" android:hint="@string/searchhint"> </searchable>
上面的配置文件中,除android:hint属性外,其它都是一个搜索对话框必须的配置项,android:label是一个必须的属性,它的值为一个string资源引用,不能直接用字符串,通常会是应用程序的名称(尽管它是一个必须的属性,但通常情况下是不显示出来的,除非你开启了搜索建议功能)。android:hint是配置搜索框的输入提示信息,也必须引用string.xml中配置的字符串资源,不能直接使用字符串。
可以配置很多的属性,但大部分属性都只是在使用搜索建议和语音搜索时进行配置,尽管如此,我们建议你一定要配置android:hint,用于提示用户需要输入的信息。
接下来,你需要把这个配置文件放到你的应用程序中。
创建一个可用于搜索的activity
当用户从一个搜索框执行搜索时,搜索管理器(search manager)会通过action_search intent 把要搜索的内容(关键字)发送到一个可执行搜索的activity。这个acitivity查询数据并显示结果。
定义一个可搜索的activity
如果你还没有准备好,那么就创建一个用来执行搜索的activity,声明它可以响应action_search intent ,并且增加搜索框配置信息。为此,你需要添加一个元素和一个元素在你的manifest文件中的节点。如下所示:
<application ... > <activity android:name=".mysearchableactivity" > <intent-filter> <action android:name="android.intent.action.search" /> </intent-filter> <meta-data android:name="android.app.searchable" android:resource="@xml/searchable"/> </activity> ... </application>
中的android:name属性值必须为”android.app.searchable”,android:resource属性值必须引用上面提到的res/xml/目录下的搜索配置文件(本例中的res/xml/searchable.xml)。
请注意,只有配置了上面的meta-data节点的activity的节点才能执行搜索,如果想在整个应用程序中都可以调用搜索框,可以进行如下配置:
<application ... > <activity android:name=".mysearchableactivity" > <intent-filter> <action android:name="android.intent.action.search" /> </intent-filter> <meta-data android:name="android.app.searchable" android:resource="@xml/searchable"/> </activity> <activity android:name=".anotheractivity" ... > </activity> <!—这个配置就可以让你在整个应用程序中调用搜索框 --> <meta-data android:name="android.app.default_searchable" android:value=".mysearchableactivity" /> ... </application>
上面代码中android:name=”android.app.default_searchable” 定义一个响应搜索框搜索请求的名称,android:value指定是由哪个activity响应并执行搜索。当我们在应用程序中的 otheracitivity中执行搜索请求时,mysearchableactivity将会被加载用于执行搜索并显示搜索结果。
执行一个搜索
当一个activity声明为可搜索时,执行实际的搜索包括三个步骤:接收查询,检索你的数据,并提交结果。
通常情况下,你的搜索结果需要在一个listview中展现,所以你用于执行搜索的acitivity要继承listactivity,这样,可以方便的访问listview的api。
接收搜索查询
当从搜索对话框执行搜索时,刚才配置的可用于搜索的acitivity将会被intent激活,同时带着一些搜索相关的参数,你需要检查intent并做出搜索响应,如下所示:
@override public void oncreate(bundle savedinstancestate) { super.oncreate(savedinstancestate); setcontentview(r.layout.search); intent intent = getintent(); //判断是否是搜索请求 if (intent.action_search.equals(intent.getaction())) { //获取搜索的查询内容(关键字) string query = intent.getstringextra(searchmanager.query); //执行相应的查询动作 domysearch(query); } }
domysearch()方法将根据关键字查询数据库,或从网络上查询数据,如果是耗时的搜索,你还需要使用进度条,来告诉用户搜索正在进行,最后返回结果后,可以调用listview的setadapter()方法将结果显示在listview中。
调用搜索对话框
你可以从应用程序中的任何一个地方调用onsearchrequested()方法激活搜索框,比如从菜单中或者一个按钮等。你也要以在 oncreate()方法中调用setdefaultkeymode(default_keys_search_local),这样,当用户按下键盘上的按键时,将会自动激活搜索框。
搜索框和普通对话框一样,浮动在屏幕的最上方,它不会改变任何activity堆栈状态,没有任何activity生命周期中的方法会被调用,只是当搜索框出现就,正在运行的activity会失去输入焦点。
如果你要在执行搜索时,进行别的操作,可以重写onsearchrequested()方法,如下所示:
@override public boolean onsearchrequested() { //这个方法中干你想干的事,比如做一些被始化工作 pausesomestuff(); return super.onsearchrequested(); }
如果当前的activity就是响应搜索请求的activity时,会有以下两种情况:
默认情况下,action_search intent将会创建一个新的activity,并调用oncreate()方法,这个新的activity会显示在最前面,你将同时有两个 activity实例。当你按“返回”键里,会回到没有执行搜索前的一个activity。
另一种情况是配置了android:launchmode=”singletop”的activity,这时,我们需要在 onnewintent(intent)方法中处理搜索请求,如下所示:
@override public void oncreate(bundle savedinstancestate) { super.oncreate(savedinstancestate); setcontentview(r.layout.search); handleintent(getintent()); } @override protected void onnewintent(intent intent) { setintent(intent); handleintent(intent); } private void handleintent(intent intent) { if (intent.action_search.equals(intent.getaction())) { string query = intent.getstringextra(searchmanager.query); domysearch(query); } }
相应的activity配置如下
<activity android:name=".mysearchableactivity" android:launchmode="singletop" > <intent-filter> <action android:name="android.intent.action.search" /> </intent-filter> <meta-data android:name="android.app.searchable" android:resource="@xml/searchable"/> </activity>
如何给搜索框增加参数
要给搜索框传递参数,我们需要重写onsearchrequested()方法,如下所示:
@override public boolean onsearchrequested() { bundle appdata = new bundle(); appdata.putboolean(mysearchableactivity.jargon, true); startsearch(null, false, appdata, false); return true; }
我们的activity在收到搜索框的搜索请求时,通过如下方法获取参数:
bundle appdata = getintent().getbundleextra(searchmanager.app_data); if (appdata != null) { boolean jargon = appdata.getboolean(mysearchableactivity.jargon); }
最后我们来看看如何使用android的语音搜索:
只需要对我们的搜索配置文件做如下改动,你的搜索就支持语音搜索了,配置文件如下所示:
<?xml version="1.0" encoding="utf-8"?> <searchable xmlns:android="http://schemas.android.com/apk/res/android" android:label="@string/searchlabel" android:hint="@string/searchhint" android:voicesearchmode="showvoicesearchbutton|launchrecognizer"> </searchable>
以上所述是小编给大家介绍的android的搜索框架实例详解,希望对大家有所帮助
上一篇: 用vs调试sql存储过程图文介绍