Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)

Added in API level 11

public class

SearchView

extends LinearLayout
implements CollapsibleActionView

java.lang.Object
↳	android.view.View
	↳	android.view.ViewGroup
		↳	android.widget.LinearLayout
			↳	android.widget.SearchView

Class Overview

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 ActionBar as an action view for a collapsible menu item, it needs to be set to iconified by default using setIconifiedByDefault(true) . This is the default, so nothing needs to be done.

If you want the search field to always be visible, then call setIconifiedByDefault(false).

Developer Guides

For information about using SearchView , read the Search developer guide.

Summary

Nested Classes
interface	SearchView.OnCloseListener
interface	SearchView.OnQueryTextListener	Callbacks for changes to the query text.
interface	SearchView.OnSuggestionListener	Callback interface for selection events on suggestions.

XML Attributes
Attribute Name	Related Method	Description
android:iconifiedByDefault	setIconifiedByDefault(boolean)	The default state of the SearchView.
android:imeOptions	setImeOptions(int)	The IME options to set on the query text field.
android:inputType	setInputType(int)	The input type to set on the query text field.
android:maxWidth	setMaxWidth(int)	An optional maximum width of the SearchView.
android:queryHint	setQueryHint(CharSequence)	An optional query hint string to be displayed in the empty query field.

[Expand]

Inherited XML Attributes

From class android.widget.LinearLayout

From class android.view.ViewGroup

From class android.view.View

[Expand]

Inherited Constants

From class android.widget.LinearLayout

From class android.view.ViewGroup

From class android.view.View

[Expand]

Inherited Fields

From class android.view.View

Public Constructors
	SearchView ( Context context)
	SearchView ( Context context, AttributeSet attrs)

Public Methods
int	getImeOptions () Returns the IME options set on the query text field.
int	getInputType () Returns the input type set on the query text field.
int	getMaxWidth () Gets the specified maximum width in pixels, if set.
CharSequence	getQuery () Returns the query string currently in the text field.
CharSequence	getQueryHint () Gets the hint text to display in the query text field.
CursorAdapter	getSuggestionsAdapter () Returns the adapter used for suggestions, if any.
boolean	isIconfiedByDefault () Returns the default iconified state of the search field.
boolean	isIconified () Returns the current iconified state of the SearchView.
boolean	isQueryRefinementEnabled () Returns whether query refinement is enabled for all items or only specific ones.
boolean	isSubmitButtonEnabled () Returns whether the submit button is enabled when necessary or never displayed.
void	onActionViewCollapsed () Called when this view is collapsed as an action view.
void	onActionViewExpanded () Called when this view is expanded as an action view.
void	onInitializeAccessibilityEvent ( AccessibilityEvent event) Initializes an `AccessibilityEvent` with information about this View which is the event source.
void	onInitializeAccessibilityNodeInfo ( AccessibilityNodeInfo info) Initializes an `AccessibilityNodeInfo` with information about this view.
boolean	onKeyDown (int keyCode, KeyEvent event) Handles the key down event for dealing with action keys.
void	onRtlPropertiesChanged (int layoutDirection) Called when any RTL property (layout direction or text direction or text alignment) has been changed.
void	onWindowFocusChanged (boolean hasWindowFocus) Called when the window containing this view gains or loses focus.
void	setIconified (boolean iconify) Iconifies or expands the SearchView.
void	setIconifiedByDefault (boolean iconified) Sets the default or resting state of the search field.
void	setImeOptions (int imeOptions) Sets the IME options on the query text field.
void	setInputType (int inputType) Sets the input type on the query text field.
void	setMaxWidth (int maxpixels) Makes the view at most this many pixels wide
void	setOnCloseListener ( SearchView.OnCloseListener listener) Sets a listener to inform when the user closes the SearchView.
void	setOnQueryTextFocusChangeListener ( View.OnFocusChangeListener listener) Sets a listener to inform when the focus of the query text field changes.
void	setOnQueryTextListener ( SearchView.OnQueryTextListener listener) Sets a listener for user actions within the SearchView.
void	setOnSearchClickListener ( View.OnClickListener listener) Sets a listener to inform when the search button is pressed.
void	setOnSuggestionListener ( SearchView.OnSuggestionListener listener) Sets a listener to inform when a suggestion is focused or clicked.
void	setQuery ( CharSequence query, boolean submit) Sets a query string in the text field and optionally submits the query as well.
void	setQueryHint ( CharSequence hint) Sets the hint text to display in the query text field.
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.
void	setSearchableInfo ( SearchableInfo searchable) Sets the SearchableInfo for this SearchView.
void	setSubmitButtonEnabled (boolean enabled) Enables showing a submit button when the query is non-empty.
void	setSuggestionsAdapter ( CursorAdapter adapter) You can set a custom adapter if you wish.

Protected Methods
void	onDetachedFromWindow () This is called when the view is detached from a window.
void	onMeasure (int widthMeasureSpec, int heightMeasureSpec) Measure the view and its content to determine the measured width and the measured height.

[Expand]

Inherited Methods

From class android.widget.LinearLayout

From class android.view.ViewGroup

From class android.view.View

void	)">addChildrenForAccessibility ( ArrayList < View > children) Adds the children of a given View for accessibility.
void	, int, int)">addFocusables ( ArrayList < View > views, int direction, int focusableMode) Adds any focusable views that are descendants of this view (possibly including this view if it is focusable itself) to views.
void	, int)">addFocusables ( ArrayList < View > views, int direction) Add any focusable views that are descendants of this view (possibly including this view if it is focusable itself) to views.
void	addOnAttachStateChangeListener ( View.OnAttachStateChangeListener listener) Add a listener for attach state changes.
void	addOnLayoutChangeListener ( View.OnLayoutChangeListener listener) Add a listener that will be called when the bounds of the view change due to layout processing.
void	)">addTouchables ( ArrayList < View > views) Add any touchable views that are descendants of this view (possibly including this view if it is touchable itself) to views.
ViewPropertyAnimator	animate () This method returns a ViewPropertyAnimator object, which can be used to animate specific properties on this View.
void	announceForAccessibility ( CharSequence text) Convenience method for sending a `TYPE_ANNOUNCEMENT` `AccessibilityEvent` to make an announcement which is related to some sort of a context change for which none of the events representing UI transitions is a good fit.
boolean	awakenScrollBars (int startDelay) Trigger the scrollbars to draw.
boolean	awakenScrollBars (int startDelay, boolean invalidate) Trigger the scrollbars to draw.
boolean	awakenScrollBars () Trigger the scrollbars to draw.
void	bringToFront () Change the view's z order in the tree, so it's on top of other sibling views.
void	buildDrawingCache () Calling this method is equivalent to calling `buildDrawingCache(false)` .
void	buildDrawingCache (boolean autoScale) Forces the drawing cache to be built if the drawing cache is invalid.
void	buildLayer () Forces this view's layer to be created and this view to be rendered into its layer.
boolean	callOnClick () Directly call any attached OnClickListener.
boolean	canResolveLayoutDirection () Check if layout direction resolution can be done.
boolean	canResolveTextAlignment () Check if text alignment resolution can be done.
boolean	canResolveTextDirection () Check if text direction resolution can be done.
boolean	canScrollHorizontally (int direction) Check if this view can be scrolled horizontally in a certain direction.
boolean	canScrollVertically (int direction) Check if this view can be scrolled vertically in a certain direction.
void	cancelLongPress () Cancels a pending long press.
final void	cancelPendingInputEvents () Cancel any deferred high-level input events that were previously posted to the event queue.
boolean	checkInputConnectionProxy ( View view) Called by the `InputMethodManager` when a view who is not the current input connection target is trying to make a call on the manager.
void	clearAnimation () Cancels any animations for this view.
void	clearFocus () Called when this view wants to give up focus.
static int	combineMeasuredStates (int curState, int newState) Merge two states as returned by `getMeasuredState()` .
int	computeHorizontalScrollExtent () Compute the horizontal extent of the horizontal scrollbar's thumb within the horizontal range.
int	computeHorizontalScrollOffset () Compute the horizontal offset of the horizontal scrollbar's thumb within the horizontal range.
int	computeHorizontalScrollRange () Compute the horizontal range that the horizontal scrollbar represents.
void	computeScroll () Called by a parent to request that a child update its values for mScrollX and mScrollY if necessary.
int	computeVerticalScrollExtent () Compute the vertical extent of the horizontal scrollbar's thumb within the vertical range.
int	computeVerticalScrollOffset () Compute the vertical offset of the vertical scrollbar's thumb within the horizontal range.
int	computeVerticalScrollRange () Compute the vertical range that the vertical scrollbar represents.
AccessibilityNodeInfo	createAccessibilityNodeInfo () Returns an `AccessibilityNodeInfo` representing this view from the point of view of an `AccessibilityService` .
void	createContextMenu ( ContextMenu menu) Show the context menu for this view.
void	destroyDrawingCache () Frees the resources used by the drawing cache.
WindowInsets	dispatchApplyWindowInsets ( WindowInsets insets) Request to apply the given window insets to this view or another view in its subtree.
void	dispatchConfigurationChanged ( Configuration newConfig) Dispatch a notification about a resource configuration change down the view hierarchy.
void	dispatchDisplayHint (int hint) Dispatch a hint about whether this view is displayed.
boolean	dispatchDragEvent ( DragEvent event) Detects if this View is enabled and has a drag event listener.
void	dispatchDraw ( Canvas canvas) Called by draw to draw the child views.
boolean	dispatchGenericFocusedEvent ( MotionEvent event) Dispatch a generic motion event to the currently focused view.
boolean	dispatchGenericMotionEvent ( MotionEvent event) Dispatch a generic motion event.
boolean	dispatchGenericPointerEvent ( MotionEvent event) Dispatch a generic motion event to the view under the first pointer.
boolean	dispatchHoverEvent ( MotionEvent event) Dispatch a hover event.
boolean	dispatchKeyEvent ( KeyEvent event) Dispatch a key event to the next view on the focus path.
boolean	dispatchKeyEventPreIme ( KeyEvent event) Dispatch a key event before it is processed by any input method associated with the view hierarchy.
boolean	dispatchKeyShortcutEvent ( KeyEvent event) Dispatches a key shortcut event.
boolean	dispatchPopulateAccessibilityEvent ( AccessibilityEvent event) Dispatches an `AccessibilityEvent` to the `View` first and then to its children for adding their text content to the event.
void	)">dispatchRestoreInstanceState ( SparseArray < Parcelable > container) Called by `)">restoreHierarchyState(android.util.SparseArray)` to retrieve the state for this view and its children.
void	)">dispatchSaveInstanceState ( SparseArray < Parcelable > container) Called by `)">saveHierarchyState(android.util.SparseArray)` to store the state for this view and its children.
void	dispatchSetActivated (boolean activated) Dispatch setActivated to all of this View's children.
void	dispatchSetPressed (boolean pressed) Dispatch setPressed to all of this View's children.
void	dispatchSetSelected (boolean selected) Dispatch setSelected to all of this View's children.
void	dispatchSystemUiVisibilityChanged (int visibility) Dispatch callbacks to `setOnSystemUiVisibilityChangeListener(View.OnSystemUiVisibilityChangeListener)` down the view hierarchy.
boolean	dispatchTouchEvent ( MotionEvent event) Pass the touch screen motion event down to the target view, or this view if it is the target.
boolean	dispatchTrackballEvent ( MotionEvent event) Pass a trackball motion event down to the focused view.
boolean	dispatchUnhandledMove ( View focused, int direction) This method is the last chance for the focused view and its ancestors to respond to an arrow key.
void	dispatchVisibilityChanged ( View changedView, int visibility) Dispatch a view visibility change down the view hierarchy.
void	dispatchWindowFocusChanged (boolean hasFocus) Called when the window containing this view gains or loses window focus.
void	dispatchWindowSystemUiVisiblityChanged (int visible) Dispatch callbacks to `onWindowSystemUiVisibilityChanged(int)` down the view hierarchy.
void	dispatchWindowVisibilityChanged (int visibility) Dispatch a window visibility change down the view hierarchy.
void	draw ( Canvas canvas) Manually render this view (and all of its children) to the given Canvas.
void	drawableStateChanged () This function is called whenever the state of the view changes in such a way that it impacts the state of drawables being shown.
View	findFocus () Find the view in the hierarchy rooted at this view that currently has focus.
final View	findViewById (int id) Look for a child view with the given id.
final View	findViewWithTag ( Object tag) Look for a child view with the given tag.
void	, java.lang.CharSequence, int)">findViewsWithText ( ArrayList < View > outViews, CharSequence searched, int flags) Finds the Views that contain given text.
boolean	fitSystemWindows ( Rect insets) This method was deprecated in API level 20. As of API XX use `dispatchApplyWindowInsets(WindowInsets)` to apply insets to views. Views should override `onApplyWindowInsets(WindowInsets)` or use `setOnApplyWindowInsetsListener(android.view.View.OnApplyWindowInsetsListener)` to implement handling their own insets.
View	focusSearch (int direction) Find the nearest view in the specified direction that can take focus.
void	forceLayout () Forces this view to be laid out during the next layout pass.
static int	generateViewId () Generate a value suitable for use in `setId(int)` .
int	getAccessibilityLiveRegion () Gets the live region mode for this View.
AccessibilityNodeProvider	getAccessibilityNodeProvider () Gets the provider for managing a virtual view hierarchy rooted at this View and reported to `AccessibilityService` s that explore the window content.
float	getAlpha () The opacity of the view.
Animation	getAnimation () Get the animation currently associated with this view.
IBinder	getApplicationWindowToken () Retrieve a unique token identifying the top-level "real" window of the window that this view is attached to.
Drawable	getBackground () Gets the background drawable
int	getBaseline () Return the offset of the widget's text baseline from the widget's top boundary.
final int	getBottom () Bottom position of this view relative to its parent.
float	getBottomFadingEdgeStrength () Returns the strength, or intensity, of the bottom faded edge.
int	getBottomPaddingOffset () Amount by which to extend the bottom fading region.
float	getCameraDistance () Gets the distance along the Z axis from the camera to this view.
Rect	getClipBounds () Returns a copy of the current `clipBounds` .
CharSequence	getContentDescription () Gets the `View` description.
final Context	getContext () Returns the context the view is running in, through which it can access the current theme, resources, etc.
ContextMenu.ContextMenuInfo	getContextMenuInfo () Views should implement this if they have extra information to associate with the context menu.
static int	getDefaultSize (int size, int measureSpec) Utility to return a default size.
Display	getDisplay () Gets the logical display to which the view's window has been attached.
final int[]	getDrawableState () Return an array of resource IDs of the drawable states representing the current state of the view.
Bitmap	getDrawingCache (boolean autoScale) Returns the bitmap in which this view drawing is cached.
Bitmap	getDrawingCache () Calling this method is equivalent to calling `getDrawingCache(false)` .
int	getDrawingCacheBackgroundColor ()
int	getDrawingCacheQuality () Returns the quality of the drawing cache.
void	getDrawingRect ( Rect outRect) Return the visible drawing bounds of your view.
long	getDrawingTime () Return the time at which the drawing of the view hierarchy started.
boolean	getFilterTouchesWhenObscured () Gets whether the framework should discard touches when the view's window is obscured by another visible window.
boolean	getFitsSystemWindows () Check for state of `setFitsSystemWindows(boolean)` .
ArrayList < View >	getFocusables (int direction) Find and return all focusable views that are descendants of this view, possibly including this view if it is focusable itself.
void	getFocusedRect ( Rect r) When a view has focus and the user navigates away from it, the next view is searched for starting from the rectangle filled in by this method.
boolean	getGlobalVisibleRect ( Rect r, Point globalOffset) If some part of this view is not clipped by any of its parents, then return that area in r in global (root) coordinates.
final boolean	getGlobalVisibleRect ( Rect r)
Handler	getHandler ()
final int	getHeight () Return the height of your view.
void	getHitRect ( Rect outRect) Hit rectangle in parent's coordinates
int	getHorizontalFadingEdgeLength () Returns the size of the horizontal faded edges used to indicate that more content in this view is visible.
int	getHorizontalScrollbarHeight () Returns the height of the horizontal scrollbar.
int	getId () Returns this view's identifier.
int	getImportantForAccessibility () Gets the mode for determining whether this View is important for accessibility which is if it fires accessibility events and if it is reported to accessibility services that query the screen.
boolean	getKeepScreenOn () Returns whether the screen should remain on, corresponding to the current value of `KEEP_SCREEN_ON` .
KeyEvent.DispatcherState	getKeyDispatcherState () Return the global `KeyEvent.DispatcherState` for this view's window.
int	getLabelFor () Gets the id of a view for which this view serves as a label for accessibility purposes.
int	getLayerType () Indicates what type of layer is currently associated with this view.
int	getLayoutDirection () Returns the resolved layout direction for this view.
ViewGroup.LayoutParams	getLayoutParams () Get the LayoutParams associated with this view.
final int	getLeft () Left position of this view relative to its parent.
float	getLeftFadingEdgeStrength () Returns the strength, or intensity, of the left faded edge.
int	getLeftPaddingOffset () Amount by which to extend the left fading region.
final boolean	getLocalVisibleRect ( Rect r)
void	getLocationInWindow (int[] location) Computes the coordinates of this view in its window.
void	getLocationOnScreen (int[] location) Computes the coordinates of this view on the screen.
Matrix	getMatrix () The transform matrix of this view, which is calculated based on the current roation, scale, and pivot properties.
final int	getMeasuredHeight () Like `getMeasuredHeightAndState()` , but only returns the raw width component (that is the result is masked by `MEASURED_SIZE_MASK` ).
final int	getMeasuredHeightAndState () Return the full height measurement information for this view as computed by the most recent call to `measure(int, int)` .
final int	getMeasuredState () Return only the state bits of `getMeasuredWidthAndState()` and `getMeasuredHeightAndState()` , combined into one integer.
final int	getMeasuredWidth () Like `getMeasuredWidthAndState()` , but only returns the raw width component (that is the result is masked by `MEASURED_SIZE_MASK` ).
final int	getMeasuredWidthAndState () Return the full width measurement information for this view as computed by the most recent call to `measure(int, int)` .
int	getMinimumHeight () Returns the minimum height of the view.
int	getMinimumWidth () Returns the minimum width of the view.
int	getNextFocusDownId () Gets the id of the view to use when the next focus is `FOCUS_DOWN` .
int	getNextFocusForwardId () Gets the id of the view to use when the next focus is `FOCUS_FORWARD` .
int	getNextFocusLeftId () Gets the id of the view to use when the next focus is `FOCUS_LEFT` .
int	getNextFocusRightId () Gets the id of the view to use when the next focus is `FOCUS_RIGHT` .
int	getNextFocusUpId () Gets the id of the view to use when the next focus is `FOCUS_UP` .
View.OnFocusChangeListener	getOnFocusChangeListener () Returns the focus-change callback registered for this view.
int	getOverScrollMode () Returns the over-scroll mode for this view.
ViewOverlay	getOverlay () Returns the overlay for this view, creating it if it does not yet exist.
int	getPaddingBottom () Returns the bottom padding of this view.
int	getPaddingEnd () Returns the end padding of this view depending on its resolved layout direction.
int	getPaddingLeft () Returns the left padding of this view.
int	getPaddingRight () Returns the right padding of this view.
int	getPaddingStart () Returns the start padding of this view depending on its resolved layout direction.
int	getPaddingTop () Returns the top padding of this view.
final ViewParent	getParent () Gets the parent of this view.
ViewParent	getParentForAccessibility () Gets the parent for accessibility purposes.
float	getPivotX () The x location of the point around which the view is `rotated` and `scaled` .
float	getPivotY () The y location of the point around which the view is `rotated` and `scaled` .
Resources	getResources () Returns the resources associated with this view.
final int	getRight () Right position of this view relative to its parent.
float	getRightFadingEdgeStrength () Returns the strength, or intensity, of the right faded edge.
int	getRightPaddingOffset () Amount by which to extend the right fading region.
View	getRootView () Finds the topmost view in the current view hierarchy.
float	getRotation () The degrees that the view is rotated around the pivot point.
float	getRotationX () The degrees that the view is rotated around the horizontal axis through the pivot point.
float	getRotationY () The degrees that the view is rotated around the vertical axis through the pivot point.
float	getScaleX () The amount that the view is scaled in x around the pivot point, as a proportion of the view's unscaled width.
float	getScaleY () The amount that the view is scaled in y around the pivot point, as a proportion of the view's unscaled height.
int	getScrollBarDefaultDelayBeforeFade () Returns the delay before scrollbars fade.
int	getScrollBarFadeDuration () Returns the scrollbar fade duration.
int	getScrollBarSize () Returns the scrollbar size.
int	getScrollBarStyle () Returns the current scrollbar style.
final int	getScrollX () Return the scrolled left position of this view.
final int	getScrollY () Return the scrolled top position of this view.
int	getSolidColor () Override this if your view is known to always be drawn on top of a solid color background, and needs to draw fading edges.
int	getSuggestedMinimumHeight () Returns the suggested minimum height that the view should use.
int	getSuggestedMinimumWidth () Returns the suggested minimum width that the view should use.
int	getSystemUiVisibility () Returns the last `setSystemUiVisibility(int)` that this view has requested.
Object	getTag (int key) Returns the tag associated with this view and the specified key.
Object	getTag () Returns this view's tag.
int	getTextAlignment () Return the resolved text alignment.
int	getTextDirection () Return the resolved text direction.
final int	getTop () Top position of this view relative to its parent.
float	getTopFadingEdgeStrength () Returns the strength, or intensity, of the top faded edge.
int	getTopPaddingOffset () Amount by which to extend the top fading region.
TouchDelegate	getTouchDelegate () Gets the TouchDelegate for this View.
ArrayList < View >	getTouchables () Find and return all touchable views that are descendants of this view, possibly including this view if it is touchable itself.
float	getTranslationX () The horizontal location of this view relative to its `left` position.
float	getTranslationY () The vertical location of this view relative to its `top` position.
int	getVerticalFadingEdgeLength () Returns the size of the vertical faded edges used to indicate that more content in this view is visible.
int	getVerticalScrollbarPosition ()
int	getVerticalScrollbarWidth () Returns the width of the vertical scrollbar.
ViewTreeObserver	getViewTreeObserver () Returns the ViewTreeObserver for this view's hierarchy.
int	getVisibility () Returns the visibility status for this view.
final int	getWidth () Return the width of the your view.
int	getWindowAttachCount ()
WindowId	getWindowId () Retrieve the `WindowId` for the window this view is currently attached to.
int	getWindowSystemUiVisibility () Returns the current system UI visibility that is currently set for the entire window.
IBinder	getWindowToken () Retrieve a unique token identifying the window this view is attached to.
int	getWindowVisibility () Returns the current visibility of the window this view is attached to (either `GONE` , `INVISIBLE` , or `VISIBLE` ).
void	getWindowVisibleDisplayFrame ( Rect outRect) Retrieve the overall visible display size in which the window this view is attached to has been positioned in.
float	getX () The visual x position of this view, in pixels.
float	getY () The visual y position of this view, in pixels.
boolean	hasFocus () Returns true if this view has focus iteself, or is the ancestor of the view that has focus.
boolean	hasFocusable () Returns true if this view is focusable or if it contains a reachable View for which `hasFocusable()` returns true.
boolean	hasOnClickListeners () Return whether this view has an attached OnClickListener.
boolean	hasOverlappingRendering () Returns whether this View has content which overlaps.
boolean	hasTransientState () Indicates whether the view is currently tracking transient state that the app should not need to concern itself with saving and restoring, but that the framework should take special note to preserve when possible.
boolean	hasWindowFocus () Returns true if this view is in a window that currently has window focus.
static View	inflate ( Context context, int resource, ViewGroup root) Inflate a view from an XML resource.
void	initializeFadingEdge ( TypedArray a) Initializes the fading edges from a given set of styled attributes.
void	initializeScrollbars ( TypedArray a) Initializes the scrollbars from a given set of styled attributes.
void	invalidate ( Rect dirty) Mark the area defined by dirty as needing to be drawn.
void	invalidate (int l, int t, int r, int b) Mark the area defined by the rect (l,t,r,b) as needing to be drawn.
void	invalidate () Invalidate the whole view.
void	invalidateDrawable ( Drawable drawable) Invalidates the specified Drawable.
boolean	isActivated () Indicates the activation state of this view.
boolean	isAttachedToWindow () Returns true if this view is currently attached to a window.
boolean	isClickable () Indicates whether this view reacts to click events or not.
boolean	isDirty () True if this view has changed since the last time being drawn.
boolean	isDrawingCacheEnabled () Indicates whether the drawing cache is enabled for this view.
boolean	isDuplicateParentStateEnabled () Indicates whether this duplicates its drawable state from its parent.
boolean	isEnabled () Returns the enabled status for this view.
final boolean	isFocusable () Returns whether this View is able to take focus.
final boolean	isFocusableInTouchMode () When a view is focusable, it may not want to take focus when in touch mode.
boolean	isFocused () Returns true if this view has focus
boolean	isHapticFeedbackEnabled ()
boolean	isHardwareAccelerated () Indicates whether this view is attached to a hardware accelerated window or not.
boolean	isHorizontalFadingEdgeEnabled () Indicate whether the horizontal edges are faded when the view is scrolled horizontally.
boolean	isHorizontalScrollBarEnabled () Indicate whether the horizontal scrollbar should be drawn or not.
boolean	isHovered () Returns true if the view is currently hovered.
boolean	isInEditMode () Indicates whether this View is currently in edit mode.
boolean	isInLayout () Returns whether the view hierarchy is currently undergoing a layout pass.
boolean	isInTouchMode () Returns whether the device is currently in touch mode.
boolean	isLaidOut () Returns true if this view has been through at least one layout since it was last attached to or detached from a window.
boolean	isLayoutDirectionResolved ()
boolean	isLayoutRequested () Indicates whether or not this view's layout will be requested during the next hierarchy layout pass.
boolean	isLongClickable () Indicates whether this view reacts to long click events or not.
boolean	isOpaque () Indicates whether this View is opaque.
boolean	isPaddingOffsetRequired () If the View draws content inside its padding and enables fading edges, it needs to support padding offsets.
boolean	isPaddingRelative () Return if the padding as been set thru relative values `setPaddingRelative(int, int, int, int)` or thru
boolean	isPressed () Indicates whether the view is currently in pressed state.
boolean	isSaveEnabled () Indicates whether this view will save its state (that is, whether its `onSaveInstanceState()` method will be called).
boolean	isSaveFromParentEnabled () Indicates whether the entire hierarchy under this view will save its state when a state saving traversal occurs from its parent.
boolean	isScrollContainer () Indicates whether this view is one of the set of scrollable containers in its window.
boolean	isScrollbarFadingEnabled () Returns true if scrollbars will fade when this view is not scrolling
boolean	isSelected () Indicates the selection state of this view.
boolean	isShown () Returns the visibility of this view and all of its ancestors
boolean	isSoundEffectsEnabled ()
boolean	isTextAlignmentResolved ()
boolean	isTextDirectionResolved ()
boolean	isVerticalFadingEdgeEnabled () Indicate whether the vertical edges are faded when the view is scrolled horizontally.
boolean	isVerticalScrollBarEnabled () Indicate whether the vertical scrollbar should be drawn or not.
void	jumpDrawablesToCurrentState () Call `Drawable.jumpToCurrentState()` on all Drawable objects associated with this view.
void	layout (int l, int t, int r, int b) Assign a size and position to a view and all of its descendants This is the second phase of the layout mechanism.
final void	measure (int widthMeasureSpec, int heightMeasureSpec) This is called to find out how big a view should be.
static int[]	mergeDrawableStates (int[] baseState, int[] additionalState) Merge your own state values in `additionalState` into the base state values `baseState` that were returned by `onCreateDrawableState(int)` .
void	offsetLeftAndRight (int offset) Offset this view's horizontal location by the specified amount of pixels.
void	offsetTopAndBottom (int offset) Offset this view's vertical location by the specified number of pixels.
void	onAnimationEnd () Invoked by a parent ViewGroup to notify the end of the animation currently associated with this view.
void	onAnimationStart () Invoked by a parent ViewGroup to notify the start of the animation currently associated with this view.
WindowInsets	onApplyWindowInsets ( WindowInsets insets) Called when the view should apply `WindowInsets` according to its internal policy.
void	onAttachedToWindow () This is called when the view is attached to a window.
void	onCancelPendingInputEvents () Called as the result of a call to `cancelPendingInputEvents()` on this view or a parent view.
boolean	onCheckIsTextEditor () Check whether the called view is a text editor, in which case it would make sense to automatically display a soft input window for it.
void	onConfigurationChanged ( Configuration newConfig) Called when the current configuration of the resources being used by the application have changed.
void	onCreateContextMenu ( ContextMenu menu) Views should implement this if the view itself is going to add items to the context menu.
int[]	onCreateDrawableState (int extraSpace) Generate the new `Drawable` state for this view.
InputConnection	onCreateInputConnection ( EditorInfo outAttrs) Create a new InputConnection for an InputMethod to interact with the view.
void	onDetachedFromWindow () This is called when the view is detached from a window.
void	onDisplayHint (int hint) Gives this view a hint about whether is displayed or not.
boolean	onDragEvent ( DragEvent event) Handles drag events sent by the system following a call to `startDrag()` .
void	onDraw ( Canvas canvas) Implement this to do your drawing.
final void	onDrawScrollBars ( Canvas canvas) Request the drawing of the horizontal and the vertical scrollbar.
boolean	onFilterTouchEventForSecurity ( MotionEvent event) Filter the touch event to apply security policies.
void	onFinishInflate () Finalize inflating a view from XML.
void	onFinishTemporaryDetach () Called after `onStartTemporaryDetach()` when the container is done changing the view.
void	onFocusChanged (boolean gainFocus, int direction, Rect previouslyFocusedRect) Called by the view system when the focus state of this view changes.
boolean	onGenericMotionEvent ( MotionEvent event) Implement this method to handle generic motion events.
void	onHoverChanged (boolean hovered) Implement this method to handle hover state changes.
boolean	onHoverEvent ( MotionEvent event) Implement this method to handle hover events.
void	onInitializeAccessibilityEvent ( AccessibilityEvent event) Initializes an `AccessibilityEvent` with information about this View which is the event source.
void	onInitializeAccessibilityNodeInfo ( AccessibilityNodeInfo info) Initializes an `AccessibilityNodeInfo` with information about this view.
boolean	onKeyDown (int keyCode, KeyEvent event) Default implementation of `KeyEvent.Callback.onKeyDown()` : perform press of the view when `KEYCODE_DPAD_CENTER` or `KEYCODE_ENTER` is released, if the view is enabled and clickable.
boolean	onKeyLongPress (int keyCode, KeyEvent event) Default implementation of `KeyEvent.Callback.onKeyLongPress()` : always returns false (doesn't handle the event).
boolean	onKeyMultiple (int keyCode, int repeatCount, KeyEvent event) Default implementation of `KeyEvent.Callback.onKeyMultiple()` : always returns false (doesn't handle the event).
boolean	onKeyPreIme (int keyCode, KeyEvent event) Handle a key event before it is processed by any input method associated with the view hierarchy.
boolean	onKeyShortcut (int keyCode, KeyEvent event) Called on the focused view when a key shortcut event is not handled.
boolean	onKeyUp (int keyCode, KeyEvent event) Default implementation of `KeyEvent.Callback.onKeyUp()` : perform clicking of the view when `KEYCODE_DPAD_CENTER` or `KEYCODE_ENTER` is released.
void	onLayout (boolean changed, int left, int top, int right, int bottom) Called from layout when this view should assign a size and position to each of its children.
void	onMeasure (int widthMeasureSpec, int heightMeasureSpec) Measure the view and its content to determine the measured width and the measured height.
void	onOverScrolled (int scrollX, int scrollY, boolean clampedX, boolean clampedY) Called by `overScrollBy(int, int, int, int, int, int, int, int, boolean)` to respond to the results of an over-scroll operation.
void	onPopulateAccessibilityEvent ( AccessibilityEvent event) Called from `dispatchPopulateAccessibilityEvent(AccessibilityEvent)` giving a chance to this View to populate the accessibility event with its text content.
void	onRestoreInstanceState ( Parcelable state) Hook allowing a view to re-apply a representation of its internal state that had previously been generated by `onSaveInstanceState()` .
void	onRtlPropertiesChanged (int layoutDirection) Called when any RTL property (layout direction or text direction or text alignment) has been changed.
Parcelable	onSaveInstanceState () Hook allowing a view to generate a representation of its internal state that can later be used to create a new instance with that same state.
void	onScreenStateChanged (int screenState) This method is called whenever the state of the screen this view is attached to changes.
void	onScrollChanged (int l, int t, int oldl, int oldt) This is called in response to an internal scroll in this view (i.e., the view scrolled its own contents).
boolean	onSetAlpha (int alpha) Invoked if there is a Transform that involves alpha.
void	onSizeChanged (int w, int h, int oldw, int oldh) This is called during layout when the size of this view has changed.
void	onStartTemporaryDetach () This is called when a container is going to temporarily detach a child, with `ViewGroup.detachViewFromParent` .
boolean	onTouchEvent ( MotionEvent event) Implement this method to handle touch screen motion events.
boolean	onTrackballEvent ( MotionEvent event) Implement this method to handle trackball motion events.
void	onVisibilityChanged ( View changedView, int visibility) Called when the visibility of the view or an ancestor of the view is changed.
void	onWindowFocusChanged (boolean hasWindowFocus) Called when the window containing this view gains or loses focus.
void	onWindowSystemUiVisibilityChanged (int visible) Override to find out when the window's requested system UI visibility has changed, that is the value returned by `getWindowSystemUiVisibility()` .
void	onWindowVisibilityChanged (int visibility) Called when the window containing has change its visibility (between `GONE` , `INVISIBLE` , and `VISIBLE` ).
boolean	overScrollBy (int deltaX, int deltaY, int scrollX, int scrollY, int scrollRangeX, int scrollRangeY, int maxOverScrollX, int maxOverScrollY, boolean isTouchEvent) Scroll the view with standard behavior for scrolling beyond the normal content boundaries.
boolean	performAccessibilityAction (int action, Bundle arguments) Performs the specified accessibility action on the view.
boolean	performClick () Call this view's OnClickListener, if it is defined.
boolean	performHapticFeedback (int feedbackConstant) BZZZTT!!1! Provide haptic feedback to the user for this view.
boolean	performHapticFeedback (int feedbackConstant, int flags) BZZZTT!!1! Like `performHapticFeedback(int)` , with additional options.
boolean	performLongClick () Call this view's OnLongClickListener, if it is defined.
void	playSoundEffect (int soundConstant) Play a sound effect for this view.
boolean	post ( Runnable action) Causes the Runnable to be added to the message queue.
boolean	postDelayed ( Runnable action, long delayMillis) Causes the Runnable to be added to the message queue, to be run after the specified amount of time elapses.
void	postInvalidate (int left, int top, int right, int bottom) Cause an invalidate of the specified area to happen on a subsequent cycle through the event loop.
void	postInvalidate () Cause an invalidate to happen on a subsequent cycle through the event loop.
void	postInvalidateDelayed (long delayMilliseconds, int left, int top, int right, int bottom) Cause an invalidate of the specified area to happen on a subsequent cycle through the event loop.
void	postInvalidateDelayed (long delayMilliseconds) Cause an invalidate to happen on a subsequent cycle through the event loop.
void	postInvalidateOnAnimation (int left, int top, int right, int bottom) Cause an invalidate of the specified area to happen on the next animation time step, typically the next display frame.
void	postInvalidateOnAnimation () Cause an invalidate to happen on the next animation time step, typically the next display frame.
void	postOnAnimation ( Runnable action) Causes the Runnable to execute on the next animation time step.
void	postOnAnimationDelayed ( Runnable action, long delayMillis) Causes the Runnable to execute on the next animation time step, after the specified amount of time elapses.
void	refreshDrawableState () Call this to force a view to update its drawable state.
boolean	removeCallbacks ( Runnable action) Removes the specified Runnable from the message queue.
void	removeOnAttachStateChangeListener ( View.OnAttachStateChangeListener listener) Remove a listener for attach state changes.
void	removeOnLayoutChangeListener ( View.OnLayoutChangeListener listener) Remove a listener for layout changes.
void	requestApplyInsets () Ask that a new dispatch of `onApplyWindowInsets(WindowInsets)` be performed.
void	requestFitSystemWindows () This method was deprecated in API level 20. Use `requestApplyInsets()` for newer platform versions.
boolean	requestFocus (int direction, Rect previouslyFocusedRect) Call this to try to give focus to a specific view or to one of its descendants and give it hints about the direction and a specific rectangle that the focus is coming from.
final boolean	requestFocus (int direction) Call this to try to give focus to a specific view or to one of its descendants and give it a hint about what direction focus is heading.
final boolean	requestFocus () Call this to try to give focus to a specific view or to one of its descendants.
final boolean	requestFocusFromTouch () Call this to try to give focus to a specific view or to one of its descendants.
void	requestLayout () Call this when something has changed which has invalidated the layout of this view.
boolean	requestRectangleOnScreen ( Rect rectangle) Request that a rectangle of this view be visible on the screen, scrolling if necessary just enough.
boolean	requestRectangleOnScreen ( Rect rectangle, boolean immediate) Request that a rectangle of this view be visible on the screen, scrolling if necessary just enough.
static int	resolveSize (int size, int measureSpec) Version of `resolveSizeAndState(int, int, int)` returning only the `MEASURED_SIZE_MASK` bits of the result.
static int	resolveSizeAndState (int size, int measureSpec, int childMeasuredState) Utility to reconcile a desired size and state, with constraints imposed by a MeasureSpec.
void	)">restoreHierarchyState ( SparseArray < Parcelable > container) Restore this view hierarchy's frozen state from the given container.
void	)">saveHierarchyState ( SparseArray < Parcelable > container) Store this view hierarchy's frozen state into the given container.
void	scheduleDrawable ( Drawable who, Runnable what, long when) Schedules an action on a drawable to occur at a specified time.
void	scrollBy (int x, int y) Move the scrolled position of your view.
void	scrollTo (int x, int y) Set the scrolled position of your view.
void	sendAccessibilityEvent (int eventType) Sends an accessibility event of the given type.
void	sendAccessibilityEventUnchecked ( AccessibilityEvent event) This method behaves exactly as `sendAccessibilityEvent(int)` but takes as an argument an empty `AccessibilityEvent` and does not perform a check whether accessibility is enabled.
void	setAccessibilityDelegate ( View.AccessibilityDelegate delegate) Sets a delegate for implementing accessibility support via composition as opposed to inheritance.
void	setAccessibilityLiveRegion (int mode) Sets the live region mode for this view.
void	setActivated (boolean activated) Changes the activated state of this view.
void	setAlpha (float alpha) Sets the opacity of the view.
void	setAnimation ( Animation animation) Sets the next animation to play for this view.
void	setBackground ( Drawable background) Set the background to a given Drawable, or remove the background.
void	setBackgroundColor (int color) Sets the background color for this view.
void	setBackgroundDrawable ( Drawable background) This method was deprecated in API level 16. use `setBackground(Drawable)` instead
void	setBackgroundResource (int resid) Set the background to a given resource.
final void	setBottom (int bottom) Sets the bottom position of this view relative to its parent.
void	setCameraDistance (float distance) Sets the distance along the Z axis (orthogonal to the X/Y plane on which views are drawn) from the camera to this view.
void	setClickable (boolean clickable) Enables or disables click events for this view.
void	setClipBounds ( Rect clipBounds) Sets a rectangular area on this view to which the view will be clipped when it is drawn.
void	setContentDescription ( CharSequence contentDescription) Sets the `View` description.
void	setDrawingCacheBackgroundColor (int color) Setting a solid background color for the drawing cache's bitmaps will improve performance and memory usage.
void	setDrawingCacheEnabled (boolean enabled) Enables or disables the drawing cache.
void	setDrawingCacheQuality (int quality) Set the drawing cache quality of this view.
void	setDuplicateParentStateEnabled (boolean enabled) Enables or disables the duplication of the parent's state into this view.
void	setEnabled (boolean enabled) Set the enabled state of this view.
void	setFadingEdgeLength (int length) Set the size of the faded edge used to indicate that more content in this view is available.
void	setFilterTouchesWhenObscured (boolean enabled) Sets whether the framework should discard touches when the view's window is obscured by another visible window.
void	setFitsSystemWindows (boolean fitSystemWindows) Sets whether or not this view should account for system screen decorations such as the status bar and inset its content; that is, controlling whether the default implementation of `fitSystemWindows(Rect)` will be executed.
void	setFocusable (boolean focusable) Set whether this view can receive the focus.
void	setFocusableInTouchMode (boolean focusableInTouchMode) Set whether this view can receive focus while in touch mode.
void	setHapticFeedbackEnabled (boolean hapticFeedbackEnabled) Set whether this view should have haptic feedback for events such as long presses.
void	setHasTransientState (boolean hasTransientState) Set whether this view is currently tracking transient state that the framework should attempt to preserve when possible.
void	setHorizontalFadingEdgeEnabled (boolean horizontalFadingEdgeEnabled) Define whether the horizontal edges should be faded when this view is scrolled horizontally.
void	setHorizontalScrollBarEnabled (boolean horizontalScrollBarEnabled) Define whether the horizontal scrollbar should be drawn or not.
void	setHovered (boolean hovered) Sets whether the view is currently hovered.
void	setId (int id) Sets the identifier for this view.
void	setImportantForAccessibility (int mode) Sets how to determine whether this view is important for accessibility which is if it fires accessibility events and if it is reported to accessibility services that query the screen.
void	setKeepScreenOn (boolean keepScreenOn) Controls whether the screen should remain on, modifying the value of `KEEP_SCREEN_ON` .
void	setLabelFor (int id) Sets the id of a view for which this view serves as a label for accessibility purposes.
void	setLayerPaint ( Paint paint) Updates the `Paint` object used with the current layer (used only if the current layer type is not set to `LAYER_TYPE_NONE` ).
void	setLayerType (int layerType, Paint paint) Specifies the type of layer backing this view.
void	setLayoutDirection (int layoutDirection) Set the layout direction for this view.
void	setLayoutParams ( ViewGroup.LayoutParams params) Set the layout parameters associated with this view.
final void	setLeft (int left) Sets the left position of this view relative to its parent.
void	setLongClickable (boolean longClickable) Enables or disables long click events for this view.
final void	setMeasuredDimension (int measuredWidth, int measuredHeight) This method must be called by `onMeasure(int, int)` to store the measured width and measured height.
void	setMinimumHeight (int minHeight) Sets the minimum height of the view.
void	setMinimumWidth (int minWidth) Sets the minimum width of the view.
void	setNextFocusDownId (int nextFocusDownId) Sets the id of the view to use when the next focus is `FOCUS_DOWN` .
void	setNextFocusForwardId (int nextFocusForwardId) Sets the id of the view to use when the next focus is `FOCUS_FORWARD` .
void	setNextFocusLeftId (int nextFocusLeftId) Sets the id of the view to use when the next focus is `FOCUS_LEFT` .
void	setNextFocusRightId (int nextFocusRightId) Sets the id of the view to use when the next focus is `FOCUS_RIGHT` .
void	setNextFocusUpId (int nextFocusUpId) Sets the id of the view to use when the next focus is `FOCUS_UP` .
void	setOnApplyWindowInsetsListener ( View.OnApplyWindowInsetsListener listener) Set an `View.OnApplyWindowInsetsListener` to take over the policy for applying window insets to this view.
void	setOnClickListener ( View.OnClickListener l) Register a callback to be invoked when this view is clicked.
void	setOnCreateContextMenuListener ( View.OnCreateContextMenuListener l) Register a callback to be invoked when the context menu for this view is being built.
void	setOnDragListener ( View.OnDragListener l) Register a drag event listener callback object for this View.
void	setOnFocusChangeListener ( View.OnFocusChangeListener l) Register a callback to be invoked when focus of this view changed.
void	setOnGenericMotionListener ( View.OnGenericMotionListener l) Register a callback to be invoked when a generic motion event is sent to this view.
void	setOnHoverListener ( View.OnHoverListener l) Register a callback to be invoked when a hover event is sent to this view.
void	setOnKeyListener ( View.OnKeyListener l) Register a callback to be invoked when a hardware key is pressed in this view.
void	setOnLongClickListener ( View.OnLongClickListener l) Register a callback to be invoked when this view is clicked and held.
void	setOnSystemUiVisibilityChangeListener ( View.OnSystemUiVisibilityChangeListener l) Set a listener to receive callbacks when the visibility of the system bar changes.
void	setOnTouchListener ( View.OnTouchListener l) Register a callback to be invoked when a touch event is sent to this view.
void	setOverScrollMode (int overScrollMode) Set the over-scroll mode for this view.
void	setPadding (int left, int top, int right, int bottom) Sets the padding.
void	setPaddingRelative (int start, int top, int end, int bottom) Sets the relative padding.
void	setPivotX (float pivotX) Sets the x location of the point around which the view is `rotated` and `scaled` .
void	setPivotY (float pivotY) Sets the y location of the point around which the view is `rotated` and `scaled` .
void	setPressed (boolean pressed) Sets the pressed state for this view.
final void	setRight (int right) Sets the right position of this view relative to its parent.
void	setRotation (float rotation) Sets the degrees that the view is rotated around the pivot point.
void	setRotationX (float rotationX) Sets the degrees that the view is rotated around the horizontal axis through the pivot point.
void	setRotationY (float rotationY) Sets the degrees that the view is rotated around the vertical axis through the pivot point.
void	setSaveEnabled (boolean enabled) Controls whether the saving of this view's state is enabled (that is, whether its `onSaveInstanceState()` method will be called).
void	setSaveFromParentEnabled (boolean enabled) Controls whether the entire hierarchy under this view will save its state when a state saving traversal occurs from its parent.
void	setScaleX (float scaleX) Sets the amount that the view is scaled in x around the pivot point, as a proportion of the view's unscaled width.
void	setScaleY (float scaleY) Sets the amount that the view is scaled in Y around the pivot point, as a proportion of the view's unscaled width.
void	setScrollBarDefaultDelayBeforeFade (int scrollBarDefaultDelayBeforeFade) Define the delay before scrollbars fade.
void	setScrollBarFadeDuration (int scrollBarFadeDuration) Define the scrollbar fade duration.
void	setScrollBarSize (int scrollBarSize) Define the scrollbar size.
void	setScrollBarStyle (int style) Specify the style of the scrollbars.
void	setScrollContainer (boolean isScrollContainer) Change whether this view is one of the set of scrollable containers in its window.
void	setScrollX (int value) Set the horizontal scrolled position of your view.
void	setScrollY (int value) Set the vertical scrolled position of your view.
void	setScrollbarFadingEnabled (boolean fadeScrollbars) Define whether scrollbars will fade when the view is not scrolling.
void	setSelected (boolean selected) Changes the selection state of this view.
void	setSoundEffectsEnabled (boolean soundEffectsEnabled) Set whether this view should have sound effects enabled for events such as clicking and touching.
void	setSystemUiVisibility (int visibility) Request that the visibility of the status bar or other screen/window decorations be changed.
void	setTag (int key, Object tag) Sets a tag associated with this view and a key.
void	setTag ( Object tag) Sets the tag associated with this view.
void	setTextAlignment (int textAlignment) Set the text alignment.
void	setTextDirection (int textDirection) Set the text direction.
final void	setTop (int top) Sets the top position of this view relative to its parent.
void	setTouchDelegate ( TouchDelegate delegate) Sets the TouchDelegate for this View.
void	setTranslationX (float translationX) Sets the horizontal location of this view relative to its `left` position.
void	setTranslationY (float translationY) Sets the vertical location of this view relative to its `top` position.
void	setVerticalFadingEdgeEnabled (boolean verticalFadingEdgeEnabled) Define whether the vertical edges should be faded when this view is scrolled vertically.
void	setVerticalScrollBarEnabled (boolean verticalScrollBarEnabled) Define whether the vertical scrollbar should be drawn or not.
void	setVerticalScrollbarPosition (int position) Set the position of the vertical scroll bar.
void	setVisibility (int visibility) Set the enabled state of this view.
void	setWillNotCacheDrawing (boolean willNotCacheDrawing) When a View's drawing cache is enabled, drawing is redirected to an offscreen bitmap.
void	setWillNotDraw (boolean willNotDraw) If this view doesn't do any drawing on its own, set this flag to allow further optimizations.
void	setX (float x) Sets the visual x position of this view, in pixels.
void	setY (float y) Sets the visual y position of this view, in pixels.
boolean	showContextMenu () Bring up the context menu for this view.
ActionMode	startActionMode ( ActionMode.Callback callback) Start an action mode.
void	startAnimation ( Animation animation) Start the specified animation now.
final boolean	startDrag ( ClipData data, View.DragShadowBuilder shadowBuilder, Object myLocalState, int flags) Starts a drag and drop operation.
String	toString () Returns a string containing a concise, human-readable description of this object.
void	unscheduleDrawable ( Drawable who) Unschedule any events associated with the given Drawable.
void	unscheduleDrawable ( Drawable who, Runnable what) Cancels a scheduled action on a drawable.
boolean	verifyDrawable ( Drawable who) If your view subclass is displaying its own Drawable objects, it should override this function and return true for any Drawable it is displaying.
boolean	willNotCacheDrawing () Returns whether or not this View can cache its drawing or not.
boolean	willNotDraw () Returns whether or not this View draws on its own.

From class java.lang.Object

Object	clone () Creates and returns a copy of this `Object` .
boolean	equals ( Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize () Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class <?>	getClass () Returns the unique instance of `Class` that represents this object's class.
int	hashCode () Returns an integer hash code for this object.
final void	notify () Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll () Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString () Returns a string containing a concise, human-readable description of this object.
final void	wait () Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait (long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait (long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface android.graphics.drawable.Drawable.Callback

From interface android.view.CollapsibleActionView

From interface android.view.KeyEvent.Callback

abstract boolean	onKeyDown (int keyCode, KeyEvent event) Called when a key down event has occurred.
abstract boolean	onKeyLongPress (int keyCode, KeyEvent event) Called when a long press has occurred.
abstract boolean	onKeyMultiple (int keyCode, int count, KeyEvent event) Called when multiple down/up pairs of the same key have occurred in a row.
abstract boolean	onKeyUp (int keyCode, KeyEvent event) Called when a key up event has occurred.

From interface android.view.ViewManager

From interface android.view.ViewParent

abstract void	bringChildToFront ( View child) Change the z order of the child so it's on top of all other children.
abstract boolean	canResolveLayoutDirection () Tells if this view parent can resolve the layout direction.
abstract boolean	canResolveTextAlignment () Tells if this view parent can resolve the text alignment.
abstract boolean	canResolveTextDirection () Tells if this view parent can resolve the text direction.
abstract void	childDrawableStateChanged ( View child) This method is called on the parent when a child's drawable state has changed.
abstract void	childHasTransientStateChanged ( View child, boolean hasTransientState) Called when a child view now has or no longer is tracking transient state.
abstract void	clearChildFocus ( View child) Called when a child of this parent is giving up focus
abstract void	createContextMenu ( ContextMenu menu) Have the parent populate the specified context menu if it has anything to add (and then recurse on its parent).
abstract View	focusSearch ( View v, int direction) Find the nearest view in the specified direction that wants to take focus
abstract void	focusableViewAvailable ( View v) Tells the parent that a new focusable view has become available.
abstract boolean	getChildVisibleRect ( View child, Rect r, Point offset) Compute the visible part of a rectangular region defined in terms of a child view's coordinates.
abstract int	getLayoutDirection () Return this view parent layout direction.
abstract ViewParent	getParent () Returns the parent if it exists, or null.
abstract ViewParent	getParentForAccessibility () Gets the parent of a given View for accessibility.
abstract int	getTextAlignment () Return this view parent text alignment.
abstract int	getTextDirection () Return this view parent text direction.
abstract void	invalidateChild ( View child, Rect r) All or part of a child is dirty and needs to be redrawn.
abstract ViewParent	invalidateChildInParent (int[] location, Rect r) All or part of a child is dirty and needs to be redrawn.
abstract boolean	isLayoutDirectionResolved () Tells if this view parent layout direction is resolved.
abstract boolean	isLayoutRequested () Indicates whether layout was requested on this view parent.
abstract boolean	isTextAlignmentResolved () Tells if this view parent text alignment is resolved.
abstract boolean	isTextDirectionResolved () Tells if this view parent text direction is resolved.
abstract void	notifySubtreeAccessibilityStateChanged ( View child, View source, int changeType) Notifies a view parent that the accessibility state of one of its descendants has changed and that the structure of the subtree is different.
abstract void	recomputeViewAttributes ( View child) Tell view hierarchy that the global view attributes need to be re-evaluated.
abstract void	requestChildFocus ( View child, View focused) Called when a child of this parent wants focus
abstract boolean	requestChildRectangleOnScreen ( View child, Rect rectangle, boolean immediate) Called when a child of this group wants a particular rectangle to be positioned onto the screen.
abstract void	requestDisallowInterceptTouchEvent (boolean disallowIntercept) Called when a child does not want this parent and its ancestors to intercept touch events with `onInterceptTouchEvent(MotionEvent)` .
abstract void	requestFitSystemWindows () Ask that a new dispatch of `View.fitSystemWindows(Rect)` be performed.
abstract void	requestLayout () Called when something has changed which has invalidated the layout of a child of this view parent.
abstract boolean	requestSendAccessibilityEvent ( View child, AccessibilityEvent event) Called by a child to request from its parent to send an `AccessibilityEvent` .
abstract void	requestTransparentRegion ( View child) Called when a child wants the view hierarchy to gather and report transparent regions to the window compositor.
abstract boolean	showContextMenuForChild ( View originalView) Bring up a context menu for the specified view or its ancestors.
abstract ActionMode	startActionModeForChild ( View originalView, ActionMode.Callback callback) Start an action mode for the specified view.

From interface android.view.accessibility.AccessibilityEventSource

XML Attributes

android:iconifiedByDefault

The default state of the SearchView. If true, it will be iconified when not in use and expanded when clicked.

Must be a boolean value, either " true " or " false ".

This may also be a reference to a resource (in the form " @[ package :] type : name ") or theme attribute (in the form " ?[ package :][ type :] name ") containing a value of this type.

This corresponds to the global attribute resource symbol iconifiedByDefault .

Related Methods

setIconifiedByDefault(boolean)

android:imeOptions

The IME options to set on the query text field.

Must be one or more (separated by '|') of the following constant values.

Constant	Value	Description
`normal`	0x00000000	There are no special semantics associated with this editor.
`actionUnspecified`	0x00000000	There is no specific action associated with this editor, let the editor come up with its own if it can. Corresponds to `IME_NULL` .
`actionNone`	0x00000001	This editor has no action associated with it. Corresponds to `IME_ACTION_NONE` .
`actionGo`	0x00000002	The action key performs a "go" operation to take the user to the target of the text they typed. Typically used, for example, when entering a URL. Corresponds to `IME_ACTION_GO` .
`actionSearch`	0x00000003	The action key performs a "search" operation, taking the user to the results of searching for the text the have typed (in whatever context is appropriate). Corresponds to `IME_ACTION_SEARCH` .
`actionSend`	0x00000004	The action key performs a "send" operation, delivering the text to its target. This is typically used when composing a message. Corresponds to `IME_ACTION_SEND` .
`actionNext`	0x00000005	The action key performs a "next" operation, taking the user to the next field that will accept text. Corresponds to `IME_ACTION_NEXT` .
`actionDone`	0x00000006	The action key performs a "done" operation, closing the soft input method. Corresponds to `IME_ACTION_DONE` .
`actionPrevious`	0x00000007	The action key performs a "previous" operation, taking the user to the previous field that will accept text. Corresponds to `IME_ACTION_PREVIOUS` .
`flagNoFullscreen`	0x2000000	Used to request that the IME never go into fullscreen mode. Applications need to be aware that the flag is not a guarantee, and not all IMEs will respect it. Corresponds to `IME_FLAG_NO_FULLSCREEN` .
`flagNavigatePrevious`	0x4000000	Like flagNavigateNext, but specifies there is something interesting that a backward navigation can focus on. If the user selects the IME's facility to backward navigate, this will show up in the application as an actionPrevious at `InputConnection.performEditorAction(int)` . Corresponds to `IME_FLAG_NO_FULLSCREEN` .
`flagNavigateNext`	0x8000000	Used to specify that there is something interesting that a forward navigation can focus on. This is like using actionNext, except allows the IME to be multiline (with an enter key) as well as provide forward navigation. Note that some IMEs may not be able to do this, especially when running on a small screen where there is little space. In that case it does not need to present a UI for this option. Like actionNext, if the user selects the IME's facility to forward navigate, this will show up in the application at `InputConnection.performEditorAction(int)` . Corresponds to `IME_FLAG_NAVIGATE_NEXT` .
`flagNoExtractUi`	0x10000000	Used to specify that the IME does not need to show its extracted text UI. For input methods that may be fullscreen, often when in landscape mode, this allows them to be smaller and let part of the application be shown behind. Though there will likely be limited access to the application available from the user, it can make the experience of a (mostly) fullscreen IME less jarring. Note that when this flag is specified the IME may not be set up to be able to display text, so it should only be used in situations where this is not needed. Corresponds to `IME_FLAG_NO_EXTRACT_UI` .
`flagNoAccessoryAction`	0x20000000	Used in conjunction with a custom action, this indicates that the action should not be available as an accessory button when the input method is full-screen. Note that by setting this flag, there can be cases where the action is simply never available to the user. Setting this generally means that you think showing text being edited is more important than the action you have supplied. Corresponds to `IME_FLAG_NO_ACCESSORY_ACTION` .
`flagNoEnterAction`	0x40000000	Used in conjunction with a custom action, this indicates that the action should not be available in-line as a replacement for the "enter" key. Typically this is because the action has such a significant impact or is not recoverable enough that accidentally hitting it should be avoided, such as sending a message. Note that `TextView` will automatically set this flag for you on multi-line text views. Corresponds to `IME_FLAG_NO_ENTER_ACTION` .
`flagForceAscii`	0x80000000	Used to request that the IME should be capable of inputting ASCII characters. The intention of this flag is to ensure that the user can type Roman alphabet characters in a `TextView` used for, typically, account ID or password input. It is expected that IMEs normally are able to input ASCII even without being told so (such IMEs already respect this flag in a sense), but there could be some cases they aren't when, for instance, only non-ASCII input languagaes like Arabic, Greek, Hebrew, Russian are enabled in the IME. Applications need to be aware that the flag is not a guarantee, and not all IMEs will respect it. However, it is strongly recommended for IME authors to respect this flag especially when their IME could end up with a state that has only non-ASCII input languages enabled. Corresponds to `IME_FLAG_FORCE_ASCII` .

This corresponds to the global attribute resource symbol imeOptions .

Related Methods

setImeOptions(int)

android:inputType

The input type to set on the query text field.

Must be one or more (separated by '|') of the following constant values.

Constant	Value	Description
`none`	0x00000000	There is no content type. The text is not editable.
`text`	0x00000001	Just plain old text. Corresponds to `TYPE_CLASS_TEXT` \| `TYPE_TEXT_VARIATION_NORMAL` .
`textCapCharacters`	0x00001001	Can be combined with `text` and its variations to request capitalization of all characters. Corresponds to `TYPE_TEXT_FLAG_CAP_CHARACTERS` .
`textCapWords`	0x00002001	Can be combined with `text` and its variations to request capitalization of the first character of every word. Corresponds to `TYPE_TEXT_FLAG_CAP_WORDS` .
`textCapSentences`	0x00004001	Can be combined with `text` and its variations to request capitalization of the first character of every sentence. Corresponds to `TYPE_TEXT_FLAG_CAP_SENTENCES` .
`textAutoCorrect`	0x00008001	Can be combined with `text` and its variations to request auto-correction of text being input. Corresponds to `TYPE_TEXT_FLAG_AUTO_CORRECT` .
`textAutoComplete`	0x00010001	Can be combined with `text` and its variations to specify that this field will be doing its own auto-completion and talking with the input method appropriately. Corresponds to `TYPE_TEXT_FLAG_AUTO_COMPLETE` .
`textMultiLine`	0x00020001	Can be combined with `text` and its variations to allow multiple lines of text in the field. If this flag is not set, the text field will be constrained to a single line. Corresponds to `TYPE_TEXT_FLAG_MULTI_LINE` .
`textImeMultiLine`	0x00040001	Can be combined with `text` and its variations to indicate that though the regular text view should not be multiple lines, the IME should provide multiple lines if it can. Corresponds to `TYPE_TEXT_FLAG_IME_MULTI_LINE` .
`textNoSuggestions`	0x00080001	Can be combined with `text` and its variations to indicate that the IME should not show any dictionary-based word suggestions. Corresponds to `TYPE_TEXT_FLAG_NO_SUGGESTIONS` .
`textUri`	0x00000011	Text that will be used as a URI. Corresponds to `TYPE_CLASS_TEXT` \| `TYPE_TEXT_VARIATION_URI` .
`textEmailAddress`	0x00000021	Text that will be used as an e-mail address. Corresponds to `TYPE_CLASS_TEXT` \| `TYPE_TEXT_VARIATION_EMAIL_ADDRESS` .
`textEmailSubject`	0x00000031	Text that is being supplied as the subject of an e-mail. Corresponds to `TYPE_CLASS_TEXT` \| `TYPE_TEXT_VARIATION_EMAIL_SUBJECT` .
`textShortMessage`	0x00000041	Text that is the content of a short message. Corresponds to `TYPE_CLASS_TEXT` \| `TYPE_TEXT_VARIATION_SHORT_MESSAGE` .
`textLongMessage`	0x00000051	Text that is the content of a long message. Corresponds to `TYPE_CLASS_TEXT` \| `TYPE_TEXT_VARIATION_LONG_MESSAGE` .
`textPersonName`	0x00000061	Text that is the name of a person. Corresponds to `TYPE_CLASS_TEXT` \| `TYPE_TEXT_VARIATION_PERSON_NAME` .
`textPostalAddress`	0x00000071	Text that is being supplied as a postal mailing address. Corresponds to `TYPE_CLASS_TEXT` \| `TYPE_TEXT_VARIATION_POSTAL_ADDRESS` .
`textPassword`	0x00000081	Text that is a password. Corresponds to `TYPE_CLASS_TEXT` \| `TYPE_TEXT_VARIATION_PASSWORD` .
`textVisiblePassword`	0x00000091	Text that is a password that should be visible. Corresponds to `TYPE_CLASS_TEXT` \| `TYPE_TEXT_VARIATION_VISIBLE_PASSWORD` .
`textWebEditText`	0x000000a1	Text that is being supplied as text in a web form. Corresponds to `TYPE_CLASS_TEXT` \| `TYPE_TEXT_VARIATION_WEB_EDIT_TEXT` .
`textFilter`	0x000000b1	Text that is filtering some other data. Corresponds to `TYPE_CLASS_TEXT` \| `TYPE_TEXT_VARIATION_FILTER` .
`textPhonetic`	0x000000c1	Text that is for phonetic pronunciation, such as a phonetic name field in a contact entry. Corresponds to `TYPE_CLASS_TEXT` \| `TYPE_TEXT_VARIATION_PHONETIC` .
`textWebEmailAddress`	0x000000d1	Text that will be used as an e-mail address on a web form. Corresponds to `TYPE_CLASS_TEXT` \| `TYPE_TEXT_VARIATION_WEB_EMAIL_ADDRESS` .
`textWebPassword`	0x000000e1	Text that will be used as a password on a web form. Corresponds to `TYPE_CLASS_TEXT` \| `TYPE_TEXT_VARIATION_WEB_PASSWORD` .
`number`	0x00000002	A numeric only field. Corresponds to `TYPE_CLASS_NUMBER` \| `TYPE_NUMBER_VARIATION_NORMAL` .
`numberSigned`	0x00001002	Can be combined with `number` and its other options to allow a signed number. Corresponds to `TYPE_CLASS_NUMBER` \| `TYPE_NUMBER_FLAG_SIGNED` .
`numberDecimal`	0x00002002	Can be combined with `number` and its other options to allow a decimal (fractional) number. Corresponds to `TYPE_CLASS_NUMBER` \| `TYPE_NUMBER_FLAG_DECIMAL` .
`numberPassword`	0x00000012	A numeric password field. Corresponds to `TYPE_CLASS_NUMBER` \| `TYPE_NUMBER_VARIATION_PASSWORD` .
`phone`	0x00000003	For entering a phone number. Corresponds to `TYPE_CLASS_PHONE` .
`datetime`	0x00000004	For entering a date and time. Corresponds to `TYPE_CLASS_DATETIME` \| `TYPE_DATETIME_VARIATION_NORMAL` .
`date`	0x00000014	For entering a date. Corresponds to `TYPE_CLASS_DATETIME` \| `TYPE_DATETIME_VARIATION_DATE` .
`time`	0x00000024	For entering a time. Corresponds to `TYPE_CLASS_DATETIME` \| `TYPE_DATETIME_VARIATION_TIME` .

This corresponds to the global attribute resource symbol inputType .

Related Methods

setInputType(int)

android:maxWidth

An optional maximum width of the SearchView.

Must be a dimension value, which is a floating point number appended with a unit such as " 14.5sp ". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), mm (millimeters).

This may also be a reference to a resource (in the form " @[ package :] type : name ") or theme attribute (in the form " ?[ package :][ type :] name ") containing a value of this type.

This corresponds to the global attribute resource symbol maxWidth .

Related Methods

setMaxWidth(int)

android:queryHint

An optional query hint string to be displayed in the empty query field.

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.

This may also be a reference to a resource (in the form " @[ package :] type : name ") or theme attribute (in the form " ?[ package :][ type :] name ") containing a value of this type.

This corresponds to the global attribute resource symbol queryHint .

Related Methods

setQueryHint(CharSequence)

Public Constructors

public SearchView ( Context context)

Added in API level 11

public SearchView ( Context context, AttributeSet attrs)

Added in API level 11

Public Methods

public int getImeOptions ()

Added in API level 16

Returns the IME options set on the query text field.

Related XML Attributes

android:imeOptions

Returns

the ime options

public int getInputType ()

Added in API level 16

Returns the input type set on the query text field.

Related XML Attributes

android:inputType

Returns

the input type

public int getMaxWidth ()

Added in API level 16

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

Related XML Attributes

android:maxWidth

Returns

the maximum width of the view

public CharSequence getQuery ()

Added in API level 11

Returns the query string currently in the text field.

Returns

the query string

public CharSequence getQueryHint ()

Added in API level 16

Gets the hint text to display in the query text field.

Related XML Attributes

android:queryHint

Returns

the query hint text, if specified, null otherwise.

public CursorAdapter getSuggestionsAdapter ()

Added in API level 11

Returns the adapter used for suggestions, if any.

Returns

the suggestions adapter

public boolean isIconfiedByDefault ()

Added in API level 11

Returns the default iconified state of the search field.

Related XML Attributes

android:iconifiedByDefault

public boolean isIconified ()

Added in API level 11

Returns the current iconified state of the SearchView.

Returns

true if the SearchView is currently iconified, false if the search field is fully visible.

public boolean isQueryRefinementEnabled ()

Added in API level 11

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

Returns

true if enabled for all items, false otherwise.

public boolean isSubmitButtonEnabled ()

Added in API level 11

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

Returns

whether the submit button is enabled automatically when necessary

public void onActionViewCollapsed ()

Added in API level 14

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

public void onActionViewExpanded ()

Added in API level 14

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

public void onInitializeAccessibilityEvent ( AccessibilityEvent event)

Added in API level 14

Initializes an AccessibilityEvent with information about this View which is the event source. In other words, the source of an accessibility event is the view whose state change triggered firing the event.

Example: Setting the password property of an event in addition to properties set by the super implementation:

          public void onInitializeAccessibilityEvent(AccessibilityEvent event) {
     super.onInitializeAccessibilityEvent(event);
     event.setPassword(true);
 }

If an View.AccessibilityDelegate has been specified via calling setAccessibilityDelegate(AccessibilityDelegate) its onInitializeAccessibilityEvent(View, AccessibilityEvent) is responsible for handling this call.

Note: Always call the super implementation before adding information to the event, in case the default implementation has basic information to add.

Parameters

event	The event to initialize.

public void onInitializeAccessibilityNodeInfo ( AccessibilityNodeInfo info)

Added in API level 14

Initializes an AccessibilityNodeInfo with information about this view. The base implementation sets:

Subclasses should override this method, call the super implementation, and set additional attributes.

If an View.AccessibilityDelegate has been specified via calling setAccessibilityDelegate(AccessibilityDelegate) its onInitializeAccessibilityNodeInfo(View, AccessibilityNodeInfo) is responsible for handling this call.

Parameters

info	The instance to initialize.

public boolean onKeyDown (int keyCode, KeyEvent event)

Added in API level 11

Handles the key down event for dealing with action keys.

Parameters

keyCode	This is the keycode of the typed key, and is the same value as found in the KeyEvent parameter.
event	The complete event record for the typed key

Returns

true if the event was handled here, or false if not.

public void onRtlPropertiesChanged (int layoutDirection)

Added in API level 17

Called when any RTL property (layout direction or text direction or text alignment) has been changed. Subclasses need to override this method to take care of cached information that depends on the resolved layout direction, or to inform child views that inherit their layout direction. The default implementation does nothing.

Parameters

layoutDirection	the direction of the layout

public void onWindowFocusChanged (boolean hasWindowFocus)

Added in API level 11

Called when the window containing this view gains or loses focus. Note that this is separate from view focus: to receive key events, both your view and its window must have focus. If a window is displayed on top of yours that takes input focus, then your own window will lose focus but the view focus will remain unchanged.

Parameters

hasWindowFocus	True if the window containing this view now has focus, false otherwise.

public void setIconified (boolean iconify)

Added in API level 11

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.

Parameters

iconify	a true value will collapse the SearchView to an icon, while a false will expand it.

public void setIconifiedByDefault (boolean iconified)

Added in API level 11

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

android:iconifiedByDefault

Parameters

iconified	whether the search field should be iconified by default

public void setImeOptions (int imeOptions)

Added in API level 14

Sets the IME options on the query text field.

Related XML Attributes

android:imeOptions

Parameters

imeOptions	the options to set on the query text field

public void setInputType (int inputType)

Added in API level 14

Sets the input type on the query text field.

Related XML Attributes

android:inputType

Parameters

inputType	the input type to set on the query text field

public void setMaxWidth (int maxpixels)

Added in API level 11

Makes the view at most this many pixels wide

Related XML Attributes

android:maxWidth

public void setOnCloseListener ( SearchView.OnCloseListener listener)

Added in API level 11

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

Parameters

listener	the listener to call when the user closes the SearchView.

public void setOnQueryTextFocusChangeListener ( View.OnFocusChangeListener listener)

Added in API level 11

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

Parameters

listener	the listener to inform of focus changes.

public void setOnQueryTextListener ( SearchView.OnQueryTextListener listener)

Added in API level 11

Sets a listener for user actions within the SearchView.

Parameters

listener	the listener object that receives callbacks when the user performs actions in the SearchView such as clicking on buttons or typing a query.

public void setOnSearchClickListener ( View.OnClickListener listener)

Added in API level 11

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.

Parameters

listener	the listener to inform when the search button is clicked or the text field is programmatically de-iconified.

public void setOnSuggestionListener ( SearchView.OnSuggestionListener listener)

Added in API level 11

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

Parameters

listener	the listener to inform of suggestion selection events.

public void setQuery ( CharSequence query, boolean submit)

Added in API level 11

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

Parameters

query	the query string. This replaces any query text already present in the text field.
submit	whether to submit the query right now or only update the contents of text field.

public void setQueryHint ( CharSequence hint)

Added in API level 11

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

Related XML Attributes

android:queryHint

Parameters

hint	the hint text to display

public void setQueryRefinementEnabled (boolean enable)

Added in API level 11

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.

Parameters

enable	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.

public void setSearchableInfo ( SearchableInfo searchable)

Added in API level 11

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.

Parameters

searchable	a SearchableInfo can be retrieved from the SearchManager, for a specific activity or a global search provider.

public void setSubmitButtonEnabled (boolean enabled)

Added in API level 11

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.

Parameters

enabled	true to show a submit button for submitting queries, false if a submit button is not required.

public void setSuggestionsAdapter ( CursorAdapter adapter)

Added in API level 11

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.

Protected Methods

protected void onDetachedFromWindow ()

Added in API level 11

This is called when the view is detached from a window. At this point it no longer has a surface for drawing.

protected void onMeasure (int widthMeasureSpec, int heightMeasureSpec)

Added in API level 11

Measure the view and its content to determine the measured width and the measured height. This method is invoked by measure(int, int) and should be overriden by subclasses to provide accurate and efficient measurement of their contents.

CONTRACT: When overriding this method, you must call setMeasuredDimension(int, int) to store the measured width and height of this view. Failure to do so will trigger an IllegalStateException , thrown by measure(int, int) . Calling the superclass' onMeasure(int, int) is a valid use.

The base class implementation of measure defaults to the background size, unless a larger size is allowed by the MeasureSpec. Subclasses should override onMeasure(int, int) to provide better measurements of their content.

If this method is overridden, it is the subclass's responsibility to make sure the measured height and width are at least the view's minimum height and width ( getSuggestedMinimumHeight() and getSuggestedMinimumWidth() ).

Parameters

widthMeasureSpec	horizontal space requirements as imposed by the parent. The requirements are encoded with `View.MeasureSpec` .
heightMeasureSpec	vertical space requirements as imposed by the parent. The requirements are encoded with `View.MeasureSpec` .

Results

Interfaces

Classes

Enums

Exceptions

SearchView

Class Overview

Developer Guides

See Also

Summary

XML Attributes

android:iconifiedByDefault

Related Methods

android:imeOptions

Related Methods

android:inputType

Related Methods

android:maxWidth

Related Methods

android:queryHint

Related Methods

Public Constructors

public SearchView ( Context context)

public SearchView ( Context context, AttributeSet attrs)

Public Methods

public int getImeOptions ()

Related XML Attributes

Returns

See Also

public int getInputType ()

Related XML Attributes

Returns

public int getMaxWidth ()

Related XML Attributes

Returns

public CharSequence getQuery ()

Returns

public CharSequence getQueryHint ()

Related XML Attributes

Returns

public CursorAdapter getSuggestionsAdapter ()

Returns

public boolean isIconfiedByDefault ()

Related XML Attributes

public boolean isIconified ()

Returns

public boolean isQueryRefinementEnabled ()

Returns

public boolean isSubmitButtonEnabled ()

Returns

public void onActionViewCollapsed ()

public void onActionViewExpanded ()

public void onInitializeAccessibilityEvent ( AccessibilityEvent event)

Parameters

public void onInitializeAccessibilityNodeInfo ( AccessibilityNodeInfo info)

Parameters

public boolean onKeyDown (int keyCode, KeyEvent event)

Parameters

Returns

public void onRtlPropertiesChanged (int layoutDirection)

Parameters

public void onWindowFocusChanged (boolean hasWindowFocus)

Parameters

public void setIconified (boolean iconify)

Parameters

public void setIconifiedByDefault (boolean iconified)

Related XML Attributes

Parameters

public void setImeOptions (int imeOptions)

Related XML Attributes

Parameters

See Also

public void setInputType (int inputType)

Related XML Attributes

Parameters

See Also

public void setMaxWidth (int maxpixels)

Related XML Attributes

public void setOnCloseListener ( SearchView.OnCloseListener listener)

Parameters