SearchView

SearchView

SearchView (Context context)

SearchView

SearchView (Context context, 
                AttributeSet attrs)

SearchView

SearchView (Context context, 
                AttributeSet attrs, 
                int defStyleAttr)

getImeOptions

int getImeOptions ()

Returns the IME options set on the query text field.

Related XML Attributes:

• SearchView_android_imeOptions

getInputType

int getInputType ()

Returns the input type set on the query text field.

Related XML Attributes:

• SearchView_android_inputType

getMaxWidth

int getMaxWidth ()

Gets the specified maximum width in pixels, if set. Returns zero if no maximum width was specified.

Related XML Attributes:

• SearchView_android_maxWidth

getQuery

CharSequence getQuery ()

Returns the query string currently in the text field.

getQueryHint

CharSequence getQueryHint ()

Returns the hint text that will be displayed in the query text field.

The displayed query hint is chosen in the following order:

1. Non-null value set with setQueryHint(CharSequence)
2. Value specified in XML using app:queryHint
3. Valid string resource ID exposed by the SearchableInfo via getHintId()
4. Default hint provided by the theme against which the view was inflated

Related XML Attributes:

• SearchView_queryHint

getSuggestionsAdapter

CursorAdapter getSuggestionsAdapter ()

Returns the adapter used for suggestions, if any.

isIconfiedByDefault

boolean isIconfiedByDefault ()

Returns the default iconified state of the search field.

Related XML Attributes:

• SearchView_iconifiedByDefault

isIconified

boolean isIconified ()

Returns the current iconified state of the SearchView.

isQueryRefinementEnabled

boolean isQueryRefinementEnabled ()

Returns whether query refinement is enabled for all items or only specific ones.

isSubmitButtonEnabled

boolean isSubmitButtonEnabled ()

Returns whether the submit button is enabled when necessary or never displayed.

onActionViewCollapsed

void onActionViewCollapsed ()

Called when this view is collapsed as an action view. See collapseActionView().

onActionViewExpanded

void onActionViewExpanded ()

Called when this view is expanded as an action view. See expandActionView().

setIconified

void setIconified (boolean iconify)

Iconifies or expands the SearchView. Any query text is cleared when iconified. This is a temporary state and does not override the default iconified state set by setIconifiedByDefault(boolean). If the default state is iconified, then a false here will only be valid until the user closes the field. And if the default state is expanded, then a true here will only clear the text field and not close it.

setIconifiedByDefault

void setIconifiedByDefault (boolean iconified)

Sets the default or resting state of the search field. If true, a single search icon is shown by default and expands to show the text field and other buttons when pressed. Also, if the default state is iconified, then it collapses to that state when the close button is pressed. Changes to this property will take effect immediately.

The default value is true.

Related XML Attributes:

• SearchView_iconifiedByDefault

setImeOptions

void setImeOptions (int imeOptions)

Sets the IME options on the query text field.

Related XML Attributes:

• SearchView_android_imeOptions

setInputType

void setInputType (int inputType)

Sets the input type on the query text field.

Related XML Attributes:

• SearchView_android_inputType

setMaxWidth

void setMaxWidth (int maxpixels)

Makes the view at most this many pixels wide

Related XML Attributes:

• SearchView_android_maxWidth

setOnCloseListener

void setOnCloseListener (SearchView.OnCloseListener listener)

Sets a listener to inform when the user closes the SearchView.

setOnQueryTextFocusChangeListener

void setOnQueryTextFocusChangeListener (View.OnFocusChangeListener listener)

Sets a listener to inform when the focus of the query text field changes.

setOnQueryTextListener

void setOnQueryTextListener (SearchView.OnQueryTextListener listener)

Sets a listener for user actions within the SearchView.

setOnSearchClickListener

void setOnSearchClickListener (View.OnClickListener listener)

Sets a listener to inform when the search button is pressed. This is only relevant when the text field is not visible by default. Calling setIconified(false) can also cause this listener to be informed.

setOnSuggestionListener

void setOnSuggestionListener (SearchView.OnSuggestionListener listener)

Sets a listener to inform when a suggestion is focused or clicked.

setQuery

void setQuery (CharSequence query, 
                boolean submit)

Sets a query string in the text field and optionally submits the query as well.

setQueryHint

void setQueryHint (CharSequence hint)

Sets the hint text to display in the query text field. This overrides any hint specified in the SearchableInfo.

This value may be specified as an empty string to prevent any query hint from being displayed.

Related XML Attributes:

• SearchView_queryHint

setQueryRefinementEnabled

void setQueryRefinementEnabled (boolean enable)

Specifies if a query refinement button should be displayed alongside each suggestion or if it should depend on the flags set in the individual items retrieved from the suggestions provider. Clicking on the query refinement button will replace the text in the query text field with the text from the suggestion. This flag only takes effect if a SearchableInfo has been specified with setSearchableInfo(SearchableInfo) and not when using a custom adapter.

setSearchableInfo

void setSearchableInfo (SearchableInfo searchable)

Sets the SearchableInfo for this SearchView. Properties in the SearchableInfo are used to display labels, hints, suggestions, create intents for launching search results screens and controlling other affordances such as a voice button.

setSubmitButtonEnabled

void setSubmitButtonEnabled (boolean enabled)

Enables showing a submit button when the query is non-empty. In cases where the SearchView is being used to filter the contents of the current activity and doesn't launch a separate results activity, then the submit button should be disabled.

setSuggestionsAdapter

void setSuggestionsAdapter (CursorAdapter adapter)

You can set a custom adapter if you wish. Otherwise the default adapter is used to display the suggestions from the suggestions provider associated with the SearchableInfo.

onLayout

void onLayout (boolean changed, 
                int left, 
                int top, 
                int right, 
                int bottom)