android SearchView

SearchView一個爲用戶提供輸入搜索查詢和提交請求給搜索提供者的用戶界面部件。顯示查詢建議或結果列表，若是有的話，運行用戶選擇一條查詢建議或結果並啓動與其相關的操做。

內部類

　　interface SearchView.OnCloseListener

　　（譯者注：當用戶關閉SearchView時觸發的回調函數）

interface SearchView.OnQueryTextListener

當查詢文本改變時的回調函數。

　　interface SearchView.OnSuggestionListener

　　在建議上選擇事件時的回調接口。

XML屬性

屬性名稱	描述
android:iconifiedByDefault	設置SearchView的默認狀態。 若是爲true，在沒有被使用和點擊展開時它將被圖形化。
android:maxWidth	SearchView的可選擇的最大寬度
android:queryHint	當查詢條件爲空時顯示的一個提示字符串。

公共方法

public CharSequence getQuery ()

　　返回當前文本域中的查詢字符串

　　　　返回值

　　　　　　查詢字符串

public CursorAdapter getSuggestionsAdapter ()

若是有的話，返回用於搜索建議的適配器。

　　　　返回值

　　　　　　查詢適配器

　　public boolean isIconfiedByDefault ()

返回查詢區域默認的圖標狀態。

public boolean isIconified ()

返回SearchView當前的圖標狀態

　　　　返回值

若是SearchView目前是圖標狀態，返回true，若是查詢區域是徹底可見的返回false

public boolean isQueryRefinementEnabled ()

返回查詢優化是不是對全部的條目都起做用或者只是對特別的幾個起做用

　　　　返回值

　　　　　　若是是對全部的條目起做用，剛返回true，不然返回false。

　　public boolean isSubmitButtonEnabled ()

返回當提交按鈕在必須的時候是否可用或者從不顯示

　　　　返回值

　　　　　　提交按鈕在必須的時候是否自動啓用

public boolean onKeyDown (int keyCode, KeyEvent event)

是否處理操做鍵按下事件

參數

keyCode 鍵入的鍵盤值，同時和鍵盤事件中的參數相同

event 輸入鍵的完整事件記錄

　　　　返回值

　　　　　　若是事件在這裏被處理，返回true，不處理返回false

public void setIconified (boolean iconify)

　　圖標化或者展開SearchView。當圖標化時任何查詢條件都被清除。這是一個臨時的狀態，不會重寫被setIconifiedByDefault(boolean)設置的默認圖標狀態。若是默認的是圖標化狀態，則在用戶關閉這個區域前都是false。若是默認的是展開狀態，這裏就是true，同時清除文本區域，但不關閉它。

參數

iconify true值會把SearchView收縮成一個圖標，false值會展開它

　　　　返回值

　　　　　　查詢字符串

public void setIconifiedByDefault (boolean iconified)

　　設置搜索欄的默認狀態或者靜止狀態。若是是true，當被按下時，一個單一的搜索圖標就會被默認顯示，同時顯示文本字段和其餘按鈕。若是默認的狀態是圖標，在按下關閉按鈕時它就會收縮成那個狀態。這個屬性的改變會當即生效。

　　　　參數

　　　　　　iconified 搜索欄是否默認被圖標化

public void setMaxWidth (int maxpixels)

以最寬的像素相看

　　　　相關的XML屬性

android:maxWidth

public void setOnCloseListener (SearchView.OnCloseListener listener)

當用戶關閉SearchView時設置一個監聽器通知用戶

參數

listener 設置用戶關閉SearchView時的監聽器

public void setOnQueryTextFocusChangeListener (View.OnFocusChangeListener listener)

　　設置當查詢區域字段改變時通知用戶的監聽器

參數

listener 設置焦點更改時的監聽器

　　public void setOnQueryTextListener (SearchView.OnQueryTextListener listener)

　　爲用戶在SearchView內的操做設置監聽器

參數

listener 當用戶在SearchView操做時好比說點擊按鈕或者輸入查詢內容時，設置接收回調的監聽器對象

　　public void setOnSearchClickListener (View.OnClickListener listener)

　　設置按鈕被按下時的監聽器。在默認狀況下當文本字段不可見時才起做用，調用setIconified(false)也能夠通知這個監聽器。

參數

listener 當搜索按鈕被點擊或者文本字段編輯取消圖形化時通知監聽器

　　public void setOnSuggestionListener (SearchView.OnSuggestionListener listener)

　　設置當一條搜索建議被選中或者點擊的時候的監聽器

參數

listener 選擇搜索建議事件的監聽器

　　public void setQuery (CharSequence query, boolean submit)

　　設置文本區域的一個查詢字符串並選擇提交和查詢。

參數

query 查詢字符串。代替在文本區域已經存在的查詢文本

submit 是否當即提交查詢或者只更新文本區域的內容

　　public void setQueryHint (CharSequence hint)

　　設置在查詢文本區域的提示文本。將覆蓋SearchableInfo中的任何提示。

　　　　相關XML屬性

android:queryHint

參數

　　hint 要顯示的提示文本

　　public void setQueryRefinementEnabled (boolean enable)

　　指定若是精確查詢按鈕是否在每條建議的旁邊顯示或者是否根據運營商建議中的設置在個別項目的標誌決定。點擊精確查詢的按鈕會用建議中的文本替換查詢文本區域中的字段。這個標誌只是在一個SearchableInfo中指定setSearchableInfo(SearchableInfo)且不使用定製的適配器時起做用。

參數

　　　　　　 enable 若是全部的條目都有一個精確查詢按鈕剛爲true，若是隻有帶精確查詢標誌的條目須要按鈕，則爲false。

　　　　參見

SUGGEST_COLUMN_FLAGS

FLAG_QUERY_REFINEMENT

　　public void setSearchableInfo (SearchableInfo searchable)

　　給SearchView設置SearchableInfo。SearchableInfo中的屬性用來顯示標籤，提示(hints)，搜索建議，建立打開查詢結果和控制其餘功能好比一個聲音按鈕的intents。

參數

　　 searchable 對於一個特殊的activiey或者，能從SearchManager中檢索的SearchableInfo，全局的搜索提供者。

　　public void setSubmitButtonEnabled (boolean enabled)

　　當查詢不爲空時，顯示一個提交按鈕。若是SearchView被用來填充當前activity的內容，而且不會啓動一個單獨的activity，這裏提交按鈕會消失。

參數

　　enabled 設置爲True時顯示一個提交請求的按鈕，當不須要請求按鈕時設置爲false。

　　public void setSuggestionsAdapter (CursorAdapter adapter)

　　若是你願意，你能夠設置一個定製的適配器。不然使用默認的適配器來顯示和SearchableInfo相關的建議提供者的建議。

　　　　參見

setSearchableInfo(SearchableInfo)

補充

文章精選

Android ApiDemo示例解析(36)：App->Search->Invoke Search

SearchView默認擴展

SearchViewを使用してListViewのアイテムにフィルターをかける

SearchView.OnCloseListener

譯者署名：xiaoQLu

譯者連接：http://www.cnblogs.com/xiaoQLu

版本：Android 3.0 r1

結構

繼承關係

public static interface SearchView.OnCloseListener

android.widget.SearchView.OnCloseListener

公共方法

public abstract boolean onClose()

　　當用戶嘗試關閉SearchView的時候調用本方法。

　　　　返回值

若是用戶想重寫默認清除文本域的動做，返回true，不然返回false。

SearchView.OnQueryTextListener

譯者署名：xiaoQLu

譯者連接：http://www.cnblogs.com/xiaoQLu

版本：Android 3.0 r1

結構

繼承關係

public static interface SearchView.OnQueryTextListener

android.widget.SearchView.OnQueryTextListener

類概述

查詢內容發生改變時調用

公共方法

public abstract boolean onQueryTextChange (String newText)

　　當用戶改變查詢內容的時候調用

參數

　　newText 查詢的文本字段的新內容

　　　　返回值

若是SearchView執行默認的動做，顯示可能出現的建議，剛返回false。若是動做由監聽器處理，剛返回true

public abstract boolean onQueryTextSubmit (String query)

當用戶提交請求時調用。這多是由於在鍵盤上按下一個鍵或者點擊一個提交按鈕。這個監聽器能夠經過返回true來重寫標準的動做，指明由它來處理提交請求。不然返回false讓SearchView把這個請求轉發到與之關聯的intent去處理。

參數

　　 query 要提交的查詢內容

返回值

若是查詢請求被監聽器處理，剛返回true，若是SearchView執行默認的動做則返回false

SearchView.OnSuggestionListener

譯者署名：xiaoQLu

譯者連接：http://www.cnblogs.com/xiaoQLu

版本：Android 2.3 r1

結構

繼承關係

Public static interface SearchView.OnSuggestionListener

android.widget.SearchView.OnSuggestionListener

類概述

選中搜索建議時的回調接口。當SearchableInfo 經過setSearchableInfo(SearchableInfo).特別指定時，才調用這些回調函數。

公共方法

public abstract boolean onSuggestionClick (int position)

　　當點擊一條搜索建議時調用

參數

　　position 在建議列表中的點擊項的絕對位置。

　　　　返回值

若是監聽器處理這個事件，而且重寫默認的處理方法，處理髮送的intent請求或者是在這條目中指定的查詢請求，剛返回true。不然返回false。

public abstract boolean onSuggestionSelect (int position)

　　經過導航選中搜索建議時調用

參數

　　position 在建議列表中絕對位置。

　　　　返回值

　　　　　　 若是監聽器處理這個事件，而且重寫基於選中條目的處理方法，剛返回 true 。不然返回 false 。