SearchView
open class SearchView : LinearLayoutCompat, CollapsibleActionView
kotlin.Any | ||||
↳ | android.view.View | |||
↳ | android.view.ViewGroup | |||
↳ | androidx.appcompat.widget.LinearLayoutCompat | |||
↳ | androidx.appcompat.widget.SearchView |
A widget that provides a user interface for the user to enter a search query and submit a request to a search provider. Shows a list of query suggestions or results, if available, and allows the user to pick a suggestion or result to launch into.
When the SearchView is used in an androidx.appcompat.app.ActionBar
as an action view, it's collapsed by default, so you must provide an icon for the action.
If you want the search field to always be visible, then call setIconifiedByDefault(false)
.
Summary
Nested classes | |
---|---|
abstract | |
abstract |
Callbacks for changes to the query text. |
abstract |
Callback interface for selection events on suggestions. |
Inherited constants | |
---|---|
Public constructors | |
---|---|
<init>(@NonNull context: Context, @Nullable attrs: AttributeSet?) |
|
<init>(@NonNull context: Context, @Nullable attrs: AttributeSet?, defStyleAttr: Int) |
Public methods | |
---|---|
open Unit | |
open Int |
Returns the IME options set on the query text field. |
open Int |
Returns the input type set on the query text field. |
open Int |
Gets the specified maximum width in pixels, if set. |
open CharSequence! |
getQuery() Returns the query string currently in the text field. |
open CharSequence? |
Returns the hint text that will be displayed in the query text field. |
open CursorAdapter! |
Returns the adapter used for suggestions, if any. |
open Boolean |
Returns the default iconified state of the search field. |
open Boolean |
Returns the current iconified state of the SearchView. |
open Boolean |
Returns whether query refinement is enabled for all items or only specific ones. |
open Boolean |
Returns whether the submit button is enabled when necessary or never displayed. |
open Unit |
Called when this view is collapsed as an action view. |
open Unit |
Called when this view is expanded as an action view. |
open Unit |
onWindowFocusChanged(hasWindowFocus: Boolean) |
open Boolean |
requestFocus(direction: Int, previouslyFocusedRect: Rect!) |
open Unit |
setIconified(iconify: Boolean) Iconifies or expands the SearchView. |
open Unit |
setIconifiedByDefault(iconified: Boolean) Sets the default or resting state of the search field. |
open Unit |
setImeOptions(imeOptions: Int) Sets the IME options on the query text field. |
open Unit |
setInputType(inputType: Int) Sets the input type on the query text field. |
open Unit |