public final class SearchViewCompat
extends Object
java.lang.Object | |
↳ | android.support.v4.widget.SearchViewCompat |
Helper用于访问以向后兼容的方式在API级别4之后引入的 SearchView
功能。
Nested classes |
|
---|---|
class |
SearchViewCompat.OnCloseListenerCompat 关闭查询UI的回调。 |
class |
SearchViewCompat.OnQueryTextListenerCompat 对查询文本进行更改的回调。 |
Public methods |
|
---|---|
static CharSequence |
getQuery(View searchView) 返回当前在文本字段中的查询字符串。 |
static boolean |
isIconified(View searchView) 返回SearchView的当前图标化状态。 |
static boolean |
isQueryRefinementEnabled(View searchView) 返回是否为所有项目或仅特定项目启用查询优化。 |
static boolean |
isSubmitButtonEnabled(View searchView) 返回提交按钮在必要时是启用还是从不显示。 |
static View |
newSearchView(Context context) 创建一个新的SearchView。 |
static void |
setIconified(View searchView, boolean iconify) 图标化或扩展SearchView。 |
static void |
setImeOptions(View searchView, int imeOptions) 在查询文本字段上设置IME选项。 |
static void |
setInputType(View searchView, int inputType) 在查询文本字段上设置输入类型。 |
static void |
setMaxWidth(View searchView, int maxpixels) 最多可以使视图的像素很宽 |
static void |
setOnCloseListener(View searchView, SearchViewCompat.OnCloseListenerCompat listener) 设置侦听器以通知用户何时关闭SearchView。 |
static void |
setOnQueryTextListener(View searchView, SearchViewCompat.OnQueryTextListenerCompat listener) 在SearchView中为用户操作设置侦听器。 |
static void |
setQuery(View searchView, CharSequence query, boolean submit) 在文本字段中设置查询字符串,并可以选择提交查询。 |
static void |
setQueryHint(View searchView, CharSequence hint) 设置要在查询文本字段中显示的提示文本。 |
static void |
setQueryRefinementEnabled(View searchView, boolean enable) 指定是否应该在每个建议旁边显示查询细化按钮,还是应该依赖于从建议提供程序检索的各个项目中设置的标志。 |
static void |
setSearchableInfo(View searchView, ComponentName searchableComponent) 为此SearchView设置SearchableInfo。 |
static void |
setSubmitButtonEnabled(View searchView, boolean enabled) 当查询非空时启用显示提交按钮。 |
Inherited methods |
|
---|---|
From class java.lang.Object
|
CharSequence getQuery (View searchView)
返回当前在文本字段中的查询字符串。
Parameters | |
---|---|
searchView |
View : The SearchView to operate on. |
Returns | |
---|---|
CharSequence |
the query string |
boolean isIconified (View searchView)
返回SearchView的当前图标化状态。
Parameters | |
---|---|
searchView |
View : The SearchView to operate on. |
Returns | |
---|---|
boolean |
true if the SearchView is currently iconified, false if the search field is fully visible. |
boolean isQueryRefinementEnabled (View searchView)
返回是否为所有项目或仅特定项目启用查询优化。
Parameters | |
---|---|
searchView |
View : The SearchView to operate on. |
Returns | |
---|---|
boolean |
true if enabled for all items, false otherwise. |
boolean isSubmitButtonEnabled (View searchView)
返回提交按钮在必要时是启用还是从不显示。
Parameters | |
---|---|
searchView |
View : The SearchView to operate on. |
Returns | |
---|---|
boolean |
whether the submit button is enabled automatically when necessary |
View newSearchView (Context context)
创建一个新的SearchView。
Parameters | |
---|---|
context |
Context : The Context the view is running in. |
Returns | |
---|---|
View |
A SearchView instance if the class is present on the current platform, null otherwise. |
void setIconified (View searchView, boolean iconify)
图标化或扩展SearchView。 图标化后,任何查询文本都会被清除。 这是一个临时状态,并且不会覆盖setIconifiedByDefault(boolean)设置的默认图标化状态。 如果默认状态是图标化的,那么此处的错误将仅在用户关闭该字段之前有效。 如果默认状态被展开,那么这里的真实只会清除文本字段而不会关闭它。
Parameters | |
---|---|
searchView |
View : The SearchView to operate on. |
iconify |
boolean : a true value will collapse the SearchView to an icon, while a false will expand it. |
void setImeOptions (View searchView, int imeOptions)
在查询文本字段上设置IME选项。 如果在ICE_CREAM_SANDWICH
平台上调用,则这是无操作。
Parameters | |
---|---|
searchView |
View : The SearchView to operate on. |
imeOptions |
int : the options to set on the query text field |
也可以看看:
void setInputType (View searchView, int inputType)
在查询文本字段上设置输入类型。 如果在ICE_CREAM_SANDWICH
平台上调用,则这是无操作。
Parameters | |
---|---|
searchView |
View : The SearchView to operate on. |
inputType |
int : the input type to set on the query text field |
也可以看看:
void setMaxWidth (View searchView, int maxpixels)
最多可以使视图的像素很宽
Parameters | |
---|---|
searchView |
View : The SearchView to operate on. |
maxpixels |
int
|
void setOnCloseListener (View searchView, SearchViewCompat.OnCloseListenerCompat listener)
设置侦听器以通知用户何时关闭SearchView。
Parameters | |
---|---|
searchView |
View : The SearchView in which to register the listener. |
listener |
SearchViewCompat.OnCloseListenerCompat : the listener to call when the user closes the SearchView. |
void setOnQueryTextListener (View searchView, SearchViewCompat.OnQueryTextListenerCompat listener)
在SearchView中为用户操作设置侦听器。
Parameters | |
---|---|
searchView |
View : The SearchView in which to register the listener. |
listener |
SearchViewCompat.OnQueryTextListenerCompat : the listener object that receives callbacks when the user performs actions in the SearchView such as clicking on buttons or typing a query. |
void setQuery (View searchView, CharSequence query, boolean submit)
在文本字段中设置查询字符串,并可以选择提交查询。
Parameters | |
---|---|
searchView |
View : The SearchView to operate on. |
query |
CharSequence : the query string. This replaces any query text already present in the text field. |
submit |
boolean : whether to submit the query right now or only update the contents of text field. |
void setQueryHint (View searchView, CharSequence hint)
设置要在查询文本字段中显示的提示文本。 这将覆盖SearchableInfo中指定的任何提示。
Parameters | |
---|---|
searchView |
View : The SearchView to operate on. |
hint |
CharSequence : the hint text to display |
void setQueryRefinementEnabled (View searchView, boolean enable)
指定是否应该在每个建议旁边显示查询细化按钮,还是应该依赖于从建议提供程序检索的各个项目中设置的标志。 点击查询优化按钮将查询文本字段中的文本替换为来自建议的文本。 如果已使用setSearchableInfo(View, ComponentName)
指定setSearchableInfo(View, ComponentName)
,而不使用自定义适配器,则此标志仅生效。
Parameters | |
---|---|
searchView |
View : The SearchView to operate on. |
enable |
boolean : true if all items should have a query refinement button, false if only those items that have a query refinement flag set should have the button. |
void setSearchableInfo (View searchView, ComponentName searchableComponent)
为此SearchView设置SearchableInfo。 SearchableInfo中的属性用于显示标签,提示,建议,创建启动搜索结果屏幕和控制其他功能(如语音按钮)的意图。
Parameters | |
---|---|
searchView |
View : The SearchView to operate on. |
searchableComponent |
ComponentName : The application component whose SearchableInfo should be loaded and applied to the SearchView. |
void setSubmitButtonEnabled (View searchView, boolean enabled)
当查询非空时启用显示提交按钮。 如果SearchView用于过滤当前活动的内容并且不启动单独的结果活动,则应该禁用提交按钮。
Parameters | |
---|---|
searchView |
View : The SearchView to operate on. |
enabled |
boolean : true to show a submit button for submitting queries, false if a submit button is not required. |