added in version 22.1.0
belongs to Maven artifact com.android.support:support-compat:28.0.0-alpha1

Summary: Constants | Protected Ctors | Methods | Inherited Methods | [Expand All]

ViewCompat

public class ViewCompat
extends Object

java.lang.Object
↳	android.support.v4.view.ViewCompat

Known Direct Subclasses

ViewCompat

Helper for accessing features in View.

Summary

Constants
`int`	`ACCESSIBILITY_LIVE_REGION_ASSERTIVE` Live region mode specifying that accessibility services should interrupt ongoing speech to immediately announce changes to this view.
`int`	`ACCESSIBILITY_LIVE_REGION_NONE` Live region mode specifying that accessibility services should not automatically announce changes to this view.
`int`	`ACCESSIBILITY_LIVE_REGION_POLITE` Live region mode specifying that accessibility services should announce changes to this view.
`int`	`IMPORTANT_FOR_ACCESSIBILITY_AUTO` Automatically determine whether a view is important for accessibility.
`int`	`IMPORTANT_FOR_ACCESSIBILITY_NO` The view is not important for accessibility.
`int`	`IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS` The view is not important for accessibility, nor are any of its descendant views.
`int`	`IMPORTANT_FOR_ACCESSIBILITY_YES` The view is important for accessibility.
`int`	`LAYER_TYPE_HARDWARE` This constant was deprecated in API level 26.1.0. Use `LAYER_TYPE_HARDWARE` directly.
`int`	`LAYER_TYPE_NONE` This constant was deprecated in API level 26.1.0. Use `LAYER_TYPE_NONE` directly.
`int`	`LAYER_TYPE_SOFTWARE` This constant was deprecated in API level 26.1.0. Use `LAYER_TYPE_SOFTWARE` directly.
`int`	`LAYOUT_DIRECTION_INHERIT` Horizontal layout direction of this view is inherited from its parent.
`int`	`LAYOUT_DIRECTION_LOCALE` Horizontal layout direction of this view is from deduced from the default language script for the locale.
`int`	`LAYOUT_DIRECTION_LTR` Horizontal layout direction of this view is from Left to Right.
`int`	`LAYOUT_DIRECTION_RTL` Horizontal layout direction of this view is from Right to Left.
`int`	`MEASURED_HEIGHT_STATE_SHIFT` This constant was deprecated in API level 26.1.0. Use `MEASURED_HEIGHT_STATE_SHIFT` directly.
`int`	`MEASURED_SIZE_MASK` This constant was deprecated in API level 26.1.0. Use `MEASURED_SIZE_MASK` directly.
`int`	`MEASURED_STATE_MASK` This constant was deprecated in API level 26.1.0. Use `MEASURED_STATE_MASK` directly.
`int`	`MEASURED_STATE_TOO_SMALL` This constant was deprecated in API level 26.1.0. Use `MEASURED_STATE_TOO_SMALL` directly.
`int`	`OVER_SCROLL_ALWAYS` This constant was deprecated in API level 25.1.0. Use `OVER_SCROLL_ALWAYS` directly. This constant will be removed in a future release.
`int`	`OVER_SCROLL_IF_CONTENT_SCROLLS` This constant was deprecated in API level 25.1.0. Use `OVER_SCROLL_IF_CONTENT_SCROLLS` directly. This constant will be removed in a future release.
`int`	`OVER_SCROLL_NEVER` This constant was deprecated in API level 25.1.0. Use `OVER_SCROLL_NEVER` directly. This constant will be removed in a future release.
`int`	`SCROLL_AXIS_HORIZONTAL` Indicates scrolling along the horizontal axis.
`int`	`SCROLL_AXIS_NONE` Indicates no axis of view scrolling.
`int`	`SCROLL_AXIS_VERTICAL` Indicates scrolling along the vertical axis.
`int`	`SCROLL_INDICATOR_BOTTOM` Scroll indicator direction for the bottom edge of the view.
`int`	`SCROLL_INDICATOR_END` Scroll indicator direction for the ending edge of the view.
`int`	`SCROLL_INDICATOR_LEFT` Scroll indicator direction for the left edge of the view.
`int`	`SCROLL_INDICATOR_RIGHT` Scroll indicator direction for the right edge of the view.
`int`	`SCROLL_INDICATOR_START` Scroll indicator direction for the starting edge of the view.
`int`	`SCROLL_INDICATOR_TOP` Scroll indicator direction for the top edge of the view.
`int`	`TYPE_NON_TOUCH` Indicates that the input type for the gesture is caused by something which is not a user touching a screen.
`int`	`TYPE_TOUCH` Indicates that the input type for the gesture is from a user touching the screen.

Protected constructors
`ViewCompat()`

Public methods
`static void`	`addKeyboardNavigationClusters(View view, Collection<View> views, int direction)` Adds any keyboard navigation cluster roots that are descendants of `view` ( including `view` if it is a cluster root itself) to `views`.
`static ViewPropertyAnimatorCompat`	`animate(View view)` This method returns a ViewPropertyAnimator object, which can be used to animate specific properties on this View.
`static boolean`	`canScrollHorizontally(View view, int direction)` This method was deprecated in API level 26.1.0. Use `canScrollHorizontally(int)` directly.
`static boolean`	`canScrollVertically(View view, int direction)` This method was deprecated in API level 26.1.0. Use `canScrollVertically(int)` directly.
`static void`	`cancelDragAndDrop(View v)` Cancel the drag and drop operation.
`static int`	`combineMeasuredStates(int curState, int newState)` This method was deprecated in API level 26.1.0. Use `combineMeasuredStates(int, int)` directly.
`static WindowInsetsCompat`	`dispatchApplyWindowInsets(View view, WindowInsetsCompat insets)` Request to apply the given window insets to this view or another view in its subtree.
`static void`	`dispatchFinishTemporaryDetach(View view)` Notify a view that its temporary detach has ended; the view is now reattached.
`static boolean`	`dispatchNestedFling(View view, float velocityX, float velocityY, boolean consumed)` Dispatch a fling to a nested scrolling parent.
`static boolean`	`dispatchNestedPreFling(View view, float velocityX, float velocityY)` Dispatch a fling to a nested scrolling parent before it is processed by this view.
`static boolean`	`dispatchNestedPreScroll(View view, int dx, int dy, int[] consumed, int[] offsetInWindow, int type)` Dispatch one step of a nested scroll in progress before this view consumes any portion of it.
`static boolean`	`dispatchNestedPreScroll(View view, int dx, int dy, int[] consumed, int[] offsetInWindow)` Dispatch one step of a nested scroll in progress before this view consumes any portion of it.
`static boolean`	`dispatchNestedScroll(View view, int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed, int[] offsetInWindow, int type)` Dispatch one step of a nested scroll in progress.
`static boolean`	`dispatchNestedScroll(View view, int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed, int[] offsetInWindow)` Dispatch one step of a nested scroll in progress.
`static void`	`dispatchStartTemporaryDetach(View view)` Notify a view that it is being temporarily detached.
`static int`	`generateViewId()` Generate a value suitable for use in `setId(int)`.
`static int`	`getAccessibilityLiveRegion(View view)` Gets the live region mode for the specified View.
`static AccessibilityNodeProviderCompat`	`getAccessibilityNodeProvider(View view)` Gets the provider for managing a virtual view hierarchy rooted at this View and reported to `AccessibilityService`s that explore the window content.
`static float`	`getAlpha(View view)` This method was deprecated in API level 26.1.0. Use `getAlpha()` directly.
`static ColorStateList`	`getBackgroundTintList(View view)` Return the tint applied to the background drawable, if specified.
`static PorterDuff.Mode`	`getBackgroundTintMode(View view)` Return the blending mode used to apply the tint to the background drawable, if specified.
`static Rect`	`getClipBounds(View view)` Returns a copy of the current `setClipBounds(View, Rect)`.
`static Display`	`getDisplay(View view)` Gets the logical display to which the view's window has been attached.
`static float`	`getElevation(View view)` The base elevation of this view relative to its parent, in pixels.
`static boolean`	`getFitsSystemWindows(View v)` Returns true if this view should adapt to fit system window insets.
`static int`	`getImportantForAccessibility(View view)` 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.
`static int`	`getImportantForAutofill(View v)` Gets the mode for determining whether this view is important for autofill.
`static int`	`getLabelFor(View view)` Gets the id of a view for which a given view serves as a label for accessibility purposes.
`static int`	`getLayerType(View view)` This method was deprecated in API level 26.1.0. Use `getLayerType()` directly.
`static int`	`getLayoutDirection(View view)` Returns the resolved layout direction for this view.
`static Matrix`	`getMatrix(View view)` This method was deprecated in API level 26.1.0. Use `getMatrix()` directly.
`static int`	`getMeasuredHeightAndState(View view)` This method was deprecated in API level 26.1.0. Use `getMeasuredHeightAndState()` directly.
`static int`	`getMeasuredState(View view)` This method was deprecated in API level 26.1.0. Use `getMeasuredState()` directly.
`static int`	`getMeasuredWidthAndState(View view)` This method was deprecated in API level 26.1.0. Use `getMeasuredWidth()` directly.
`static int`	`getMinimumHeight(View view)` Returns the minimum height of the view.
`static int`	`getMinimumWidth(View view)` Returns the minimum width of the view.
`static int`	`getNextClusterForwardId(View view)` Gets the ID of the next keyboard navigation cluster root.
`static int`	`getOverScrollMode(View v)` This method was deprecated in API level 25.1.0. Call `getOverScrollMode()` directly. This method will be removed in a future release.
`static int`	`getPaddingEnd(View view)` Returns the end padding of the specified view depending on its resolved layout direction.
`static int`	`getPaddingStart(View view)` Returns the start padding of the specified view depending on its resolved layout direction.
`static ViewParent`	`getParentForAccessibility(View view)` Gets the parent for accessibility purposes.
`static float`	`getPivotX(View view)` This method was deprecated in API level 26.1.0. Use `getPivotX()` directly.
`static float`	`getPivotY(View view)` This method was deprecated in API level 26.1.0. Use `getPivotY()` directly.
`static float`	`getRotation(View view)` This method was deprecated in API level 26.1.0. Use `getRotation()` directly.
`static float`	`getRotationX(View view)` This method was deprecated in API level 26.1.0. Use `getRotationX()` directly.
`static float`	`getRotationY(View view)` This method was deprecated in API level 26.1.0. Use `getRotationY()` directly.
`static float`	`getScaleX(View view)` This method was deprecated in API level 26.1.0. Use `getScaleX()` directly.
`static float`	`getScaleY(View view)` This method was deprecated in API level 26.1.0. Use `getScaleY()` directly.
`static int`	`getScrollIndicators(View view)` Returns a bitmask representing the enabled scroll indicators.
`static String`	`getTransitionName(View view)` Returns the name of the View to be used to identify Views in Transitions.
`static float`	`getTranslationX(View view)` This method was deprecated in API level 26.1.0. Use `getTranslationX()` directly.
`static float`	`getTranslationY(View view)` This method was deprecated in API level 26.1.0. Use `getTranslationY()` directly.
`static float`	`getTranslationZ(View view)` The depth location of this view relative to its `elevation`.
`static int`	`getWindowSystemUiVisibility(View view)` Returns the current system UI visibility that is currently set for the entire window.
`static float`	`getX(View view)` This method was deprecated in API level 26.1.0. Use `getX()` directly.
`static float`	`getY(View view)` This method was deprecated in API level 26.1.0. Use `getY()` directly.
`static float`	`getZ(View view)` The visual z position of this view, in pixels.
`static boolean`	`hasAccessibilityDelegate(View v)` Checks whether provided View has an accessibility delegate attached to it.
`static boolean`	`hasExplicitFocusable(View view)` Returns true if this view is focusable or if it contains a reachable View for which `hasExplicitFocusable()` returns `true`.
`static boolean`	`hasNestedScrollingParent(View view, int type)` Returns true if this view has a nested scrolling parent.
`static boolean`	`hasNestedScrollingParent(View view)` Returns true if this view has a nested scrolling parent.
`static boolean`	`hasOnClickListeners(View view)` Returns whether the provided view has an attached `View.OnClickListener`.
`static boolean`	`hasOverlappingRendering(View view)` Returns whether this View has content which overlaps.
`static boolean`	`hasTransientState(View view)` 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.
`static boolean`	`isAttachedToWindow(View view)` Returns true if the provided view is currently attached to a window.
`static boolean`	`isFocusedByDefault(View view)` Returns whether `view` should receive focus when the focus is restored for the view hierarchy containing it.
`static boolean`	`isImportantForAccessibility(View view)` Computes whether this view should be exposed for accessibility.
`static boolean`	`isImportantForAutofill(View v)` Hints the Android System whether the `AssistStructure.ViewNode` associated with this view is considered important for autofill purposes.
`static boolean`	`isInLayout(View view)` Returns whether the view hierarchy is currently undergoing a layout pass.
`static boolean`	`isKeyboardNavigationCluster(View view)` Returns whether `view` is a root of a keyboard navigation cluster.
`static boolean`	`isLaidOut(View view)` Returns true if `view` has been through at least one layout since it was last attached to or detached from a window.
`static boolean`	`isLayoutDirectionResolved(View view)` Returns whether layout direction has been resolved.
`static boolean`	`isNestedScrollingEnabled(View view)` Returns true if nested scrolling is enabled for this view.
`static boolean`	`isOpaque(View view)` This method was deprecated in API level 25.1.0. Use `isOpaque()` directly. This method will be removed in a future release.
`static boolean`	`isPaddingRelative(View view)` Return if the padding as been set through relative values `View.setPaddingRelative(int, int, int, int)` or thru
`static void`	`jumpDrawablesToCurrentState(View v)` This method was deprecated in API level 26.1.0. Use `jumpDrawablesToCurrentState()` directly.
`static View`	`keyboardNavigationClusterSearch(View view, View currentCluster, int direction)` Find the nearest keyboard navigation cluster in the specified direction.
`static void`	`offsetLeftAndRight(View view, int offset)` Offset this view's horizontal location by the specified amount of pixels.
`static void`	`offsetTopAndBottom(View view, int offset)` Offset this view's vertical location by the specified number of pixels.
`static WindowInsetsCompat`	`onApplyWindowInsets(View view, WindowInsetsCompat insets)` Called when the view should apply `WindowInsetsCompat` according to its internal policy.
`static void`	`onInitializeAccessibilityEvent(View v, AccessibilityEvent event)` This method was deprecated in API level 26.1.0. Call `onInitializeAccessibilityEvent(AccessibilityEvent)` directly. This method will be removed in a future release.
`static void`	`onInitializeAccessibilityNodeInfo(View v, AccessibilityNodeInfoCompat info)` Initializes an `AccessibilityNodeInfoCompat` with information about this view.
`static void`	`onPopulateAccessibilityEvent(View v, AccessibilityEvent event)` This method was deprecated in API level 26.1.0. Call `onPopulateAccessibilityEvent(AccessibilityEvent)` directly. This method will be removed in a future release.
`static boolean`	`performAccessibilityAction(View view, int action, Bundle arguments)` Performs the specified accessibility action on the view.
`static void`	`postInvalidateOnAnimation(View view, 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.
`static void`	`postInvalidateOnAnimation(View view)` Cause an invalidate to happen on the next animation time step, typically the next display frame.
`static void`	`postOnAnimation(View view, Runnable action)` Causes the Runnable to execute on the next animation time step.
`static void`	`postOnAnimationDelayed(View view, Runnable action, long delayMillis)` Causes the Runnable to execute on the next animation time step, after the specified amount of time elapses.
`static void`	`requestApplyInsets(View view)` Ask that a new dispatch of `View.onApplyWindowInsets(WindowInsets)` be performed.
`static <T extends View> T`	`requireViewById(View view, int id)` Finds the first descendant view with the given ID, the view itself if the ID matches `getId()`, or throws an IllegalArgumentException if the ID is invalid or there is no matching view in the hierarchy.
`static int`	`resolveSizeAndState(int size, int measureSpec, int childMeasuredState)` This method was deprecated in API level 26.1.0. Use `resolveSizeAndState(int, int, int)` directly.
`static boolean`	`restoreDefaultFocus(View view)` Gives focus to the default-focus view in the view hierarchy rooted at `view`.
`static void`	`setAccessibilityDelegate(View v, AccessibilityDelegateCompat delegate)` Sets a delegate for implementing accessibility support via composition (as opposed to inheritance).
`static void`	`setAccessibilityLiveRegion(View view, int mode)` Sets the live region mode for the specified view.
`static void`	`setActivated(View view, boolean activated)` This method was deprecated in API level 26.1.0. Use `setActivated(boolean)` directly.
`static void`	`setAlpha(View view, float value)` This method was deprecated in API level 26.1.0. Use `setAlpha(float)` directly.
`static void`	`setAutofillHints(View v, String... autofillHints)` Sets the hints that help an `AutofillService` determine how to autofill the view with the user's data.
`static void`	`setBackground(View view, Drawable background)` Set the background of the `view` to a given Drawable, or remove the background.
`static void`	`setBackgroundTintList(View view, ColorStateList tintList)` Applies a tint to the background drawable.
`static void`	`setBackgroundTintMode(View view, PorterDuff.Mode mode)` Specifies the blending mode used to apply the tint specified by `setBackgroundTintList(android.view.View, android.content.res.ColorStateList)` to the background drawable.
`static void`	`setChildrenDrawingOrderEnabled(ViewGroup viewGroup, boolean enabled)` This method was deprecated in API level 27.1.0. Use `setChildrenDrawingOrderEnabled(boolean)` directly.
`static void`	`setClipBounds(View view, Rect clipBounds)` Sets a rectangular area on this view to which the view will be clipped when it is drawn.
`static void`	`setElevation(View view, float elevation)` Sets the base elevation of this view, in pixels.
`static void`	`setFitsSystemWindows(View view, boolean fitSystemWindows)` This method was deprecated in API level 26.1.0. Use `setFitsSystemWindows(boolean)` directly.
`static void`	`setFocusedByDefault(View view, boolean isFocusedByDefault)` Sets whether `view` should receive focus when the focus is restored for the view hierarchy containing it.
`static void`	`setHasTransientState(View view, boolean hasTransientState)` Set whether this view is currently tracking transient state that the framework should attempt to preserve when possible.
`static void`	`setImportantForAccessibility(View view, 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.
`static void`	`setImportantForAutofill(View v, int mode)` Sets the mode for determining whether this view is considered important for autofill.
`static void`	`setKeyboardNavigationCluster(View view, boolean isCluster)` Set whether `view` is a root of a keyboard navigation cluster.
`static void`	`setLabelFor(View view, int labeledId)` Sets the id of a view for which a given view serves as a label for accessibility purposes.
`static void`	`setLayerPaint(View view, 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`).
`static void`	`setLayerType(View view, int layerType, Paint paint)` This method was deprecated in API level 26.1.0. Use `setLayerType(int, Paint)` directly.
`static void`	`setLayoutDirection(View view, int layoutDirection)` Set the layout direction for this view.
`static void`	`setNestedScrollingEnabled(View view, boolean enabled)` Enable or disable nested scrolling for this view.
`static void`	`setNextClusterForwardId(View view, int nextClusterForwardId)` Sets the ID of the next keyboard navigation cluster root view.
`static void`	`setOnApplyWindowInsetsListener(View v, OnApplyWindowInsetsListener listener)` Set an `OnApplyWindowInsetsListener` to take over the policy for applying window insets to this view.
`static void`	`setOverScrollMode(View v, int overScrollMode)` This method was deprecated in API level 25.1.0. Call `setOverScrollMode(int)` directly. This method will be removed in a future release.
`static void`	`setPaddingRelative(View view, int start, int top, int end, int bottom)` Sets the relative padding.
`static void`	`setPivotX(View view, float value)` This method was deprecated in API level 26.1.0. Use `setPivotX(float)` directly.
`static void`	`setPivotY(View view, float value)` This method was deprecated in API level 26.1.0. Use `setPivotX(float)` directly.
`static void`	`setPointerIcon(View view, PointerIconCompat pointerIcon)` Set the pointer icon for the current view.
`static void`	`setRotation(View view, float value)` This method was deprecated in API level 26.1.0. Use `setRotation(float)` directly.
`static void`	`setRotationX(View view, float value)` This method was deprecated in API level 26.1.0. Use `setRotationX(float)` directly.
`static void`	`setRotationY(View view, float value)` This method was deprecated in API level 26.1.0. Use `setRotationY(float)` directly.
`static void`	`setSaveFromParentEnabled(View v, boolean enabled)` This method was deprecated in API level 26.1.0. Use `setSaveFromParentEnabled(boolean)` directly.
`static void`	`setScaleX(View view, float value)` This method was deprecated in API level 26.1.0. Use `setScaleX(float)` directly.
`static void`	`setScaleY(View view, float value)` This method was deprecated in API level 26.1.0. Use `setScaleY(float)` directly.
`static void`	`setScrollIndicators(View view, int indicators, int mask)` Sets the state of the scroll indicators specified by the mask.
`static void`	`setScrollIndicators(View view, int indicators)` Sets the state of all scroll indicators.
`static void`	`setTooltipText(View view, CharSequence tooltipText)` Sets the tooltip for the view.
`static void`	`setTransitionName(View view, String transitionName)` Sets the name of the View to be used to identify Views in Transitions.
`static void`	`setTranslationX(View view, float value)` This method was deprecated in API level 26.1.0. Use `setTranslationX(float)` directly.
`static void`	`setTranslationY(View view, float value)` This method was deprecated in API level 26.1.0. Use `setTranslationY(float)` directly.
`static void`	`setTranslationZ(View view, float translationZ)` Sets the depth location of this view relative to its `elevation`.
`static void`	`setX(View view, float value)` This method was deprecated in API level 26.1.0. Use `setX(float)` directly.
`static void`	`setY(View view, float value)` This method was deprecated in API level 26.1.0. Use `setY(float)` directly.
`static void`	`setZ(View view, float z)` Sets the visual z position of this view, in pixels.
`static boolean`	`startDragAndDrop(View v, ClipData data, View.DragShadowBuilder shadowBuilder, Object localState, int flags)` Start the drag and drop operation.
`static boolean`	`startNestedScroll(View view, int axes, int type)` Begin a nestable scroll operation along the given axes.
`static boolean`	`startNestedScroll(View view, int axes)` Begin a nestable scroll operation along the given axes.
`static void`	`stopNestedScroll(View view, int type)` Stop a nested scroll in progress.
`static void`	`stopNestedScroll(View view)` Stop a nested scroll in progress.
`static void`	`updateDragShadow(View v, View.DragShadowBuilder shadowBuilder)` Update the drag shadow while drag and drop is in progress.

Inherited methods

From class


  
    java.lang.Object

Constants

ACCESSIBILITY_LIVE_REGION_ASSERTIVE

added in version 22.1.0

int ACCESSIBILITY_LIVE_REGION_ASSERTIVE

Live region mode specifying that accessibility services should interrupt ongoing speech to immediately announce changes to this view.

Use with setAccessibilityLiveRegion(View, int).

Constant Value: 2 (0x00000002)

ACCESSIBILITY_LIVE_REGION_NONE

added in version 22.1.0

int ACCESSIBILITY_LIVE_REGION_NONE

Live region mode specifying that accessibility services should not automatically announce changes to this view. This is the default live region mode for most views.

Use with setAccessibilityLiveRegion(View, int).

Constant Value: 0 (0x00000000)

ACCESSIBILITY_LIVE_REGION_POLITE

added in version 22.1.0

int ACCESSIBILITY_LIVE_REGION_POLITE

Live region mode specifying that accessibility services should announce changes to this view.

Use with setAccessibilityLiveRegion(View, int).

Constant Value: 1 (0x00000001)

IMPORTANT_FOR_ACCESSIBILITY_AUTO

added in version 22.1.0

int IMPORTANT_FOR_ACCESSIBILITY_AUTO

Automatically determine whether a view is important for accessibility.

Constant Value: 0 (0x00000000)

IMPORTANT_FOR_ACCESSIBILITY_NO

added in version 22.1.0

int IMPORTANT_FOR_ACCESSIBILITY_NO

The view is not important for accessibility.

Constant Value: 2 (0x00000002)

IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS

added in version 22.1.0

int IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS

The view is not important for accessibility, nor are any of its descendant views.

Constant Value: 4 (0x00000004)

IMPORTANT_FOR_ACCESSIBILITY_YES

added in version 22.1.0

int IMPORTANT_FOR_ACCESSIBILITY_YES

The view is important for accessibility.

Constant Value: 1 (0x00000001)

LAYER_TYPE_HARDWARE

added in version 22.1.0

int LAYER_TYPE_HARDWARE

This constant was deprecated in API level 26.1.0.
Use LAYER_TYPE_HARDWARE directly.

Indicates that the view has a hardware layer. A hardware layer is backed by a hardware specific texture (generally Frame Buffer Objects or FBO on OpenGL hardware) and causes the view to be rendered using Android's hardware rendering pipeline, but only if hardware acceleration is turned on for the view hierarchy. When hardware acceleration is turned off, hardware layers behave exactly as software layers.

A hardware layer is useful to apply a specific color filter and/or blending mode and/or translucency to a view and all its children.

A hardware layer can be used to cache a complex view tree into a texture and reduce the complexity of drawing operations. For instance, when animating a complex view tree with a translation, a hardware layer can be used to render the view tree only once.

A hardware layer can also be used to increase the rendering quality when rotation transformations are applied on a view. It can also be used to prevent potential clipping issues when applying 3D transforms on a view.

Constant Value: 2 (0x00000002)

LAYER_TYPE_NONE

added in version 22.1.0

int LAYER_TYPE_NONE

This constant was deprecated in API level 26.1.0.
Use LAYER_TYPE_NONE directly.

Indicates that the view does not have a layer.

Constant Value: 0 (0x00000000)

LAYER_TYPE_SOFTWARE

added in version 22.1.0

int LAYER_TYPE_SOFTWARE

This constant was deprecated in API level 26.1.0.
Use LAYER_TYPE_SOFTWARE directly.

Indicates that the view has a software layer. A software layer is backed by a bitmap and causes the view to be rendered using Android's software rendering pipeline, even if hardware acceleration is enabled.

Software layers have various usages:

When the application is not using hardware acceleration, a software layer is useful to apply a specific color filter and/or blending mode and/or translucency to a view and all its children.

When the application is using hardware acceleration, a software layer is useful to render drawing primitives not supported by the hardware accelerated pipeline. It can also be used to cache a complex view tree into a texture and reduce the complexity of drawing operations. For instance, when animating a complex view tree with a translation, a software layer can be used to render the view tree only once.

Software layers should be avoided when the affected view tree updates often. Every update will require to re-render the software layer, which can potentially be slow (particularly when hardware acceleration is turned on since the layer will have to be uploaded into a hardware texture after every update.)

Constant Value: 1 (0x00000001)

LAYOUT_DIRECTION_INHERIT

added in version 22.1.0

int LAYOUT_DIRECTION_INHERIT

Horizontal layout direction of this view is inherited from its parent. Use with setLayoutDirection(View, int).

Constant Value: 2 (0x00000002)

LAYOUT_DIRECTION_LOCALE

added in version 22.1.0

int LAYOUT_DIRECTION_LOCALE

Horizontal layout direction of this view is from deduced from the default language script for the locale. Use with setLayoutDirection(View, int).

Constant Value: 3 (0x00000003)

LAYOUT_DIRECTION_LTR

added in version 22.1.0

int LAYOUT_DIRECTION_LTR

Horizontal layout direction of this view is from Left to Right.

Constant Value: 0 (0x00000000)

LAYOUT_DIRECTION_RTL

added in version 22.1.0

int LAYOUT_DIRECTION_RTL

Horizontal layout direction of this view is from Right to Left.

Constant Value: 1 (0x00000001)

MEASURED_HEIGHT_STATE_SHIFT

added in version 22.1.0

int MEASURED_HEIGHT_STATE_SHIFT

This constant was deprecated in API level 26.1.0.
Use MEASURED_HEIGHT_STATE_SHIFT directly.

Bit shift of MEASURED_STATE_MASK to get to the height bits for functions that combine both width and height into a single int, such as getMeasuredState(View) and the childState argument of resolveSizeAndState(int, int, int).

Constant Value: 16 (0x00000010)

MEASURED_SIZE_MASK

added in version 22.1.0

int MEASURED_SIZE_MASK

This constant was deprecated in API level 26.1.0.
Use MEASURED_SIZE_MASK directly.

Bits of getMeasuredWidthAndState(View) and getMeasuredWidthAndState(View) that provide the actual measured size.

Constant Value: 16777215 (0x00ffffff)

MEASURED_STATE_MASK

added in version 22.1.0

int MEASURED_STATE_MASK

This constant was deprecated in API level 26.1.0.
Use MEASURED_STATE_MASK directly.

Bits of getMeasuredWidthAndState(View) and getMeasuredWidthAndState(View) that provide the additional state bits.

Constant Value: -16777216 (0xff000000)

MEASURED_STATE_TOO_SMALL

added in version 22.1.0

int MEASURED_STATE_TOO_SMALL

This constant was deprecated in API level 26.1.0.
Use MEASURED_STATE_TOO_SMALL directly.

Bit of getMeasuredWidthAndState(View) and getMeasuredWidthAndState(View) that indicates the measured size is smaller that the space the view would like to have.

Constant Value: 16777216 (0x01000000)

OVER_SCROLL_ALWAYS

added in version 22.1.0

int OVER_SCROLL_ALWAYS

This constant was deprecated in API level 25.1.0.
Use OVER_SCROLL_ALWAYS directly. This constant will be removed in a future release.

Always allow a user to over-scroll this view, provided it is a view that can scroll.

Constant Value: 0 (0x00000000)

OVER_SCROLL_IF_CONTENT_SCROLLS

added in version 22.1.0

int OVER_SCROLL_IF_CONTENT_SCROLLS

This constant was deprecated in API level 25.1.0.
Use OVER_SCROLL_IF_CONTENT_SCROLLS directly. This constant will be removed in a future release.

Allow a user to over-scroll this view only if the content is large enough to meaningfully scroll, provided it is a view that can scroll.

Constant Value: 1 (0x00000001)

OVER_SCROLL_NEVER

added in version 22.1.0

int OVER_SCROLL_NEVER

This constant was deprecated in API level 25.1.0.
Use OVER_SCROLL_NEVER directly. This constant will be removed in a future release.

Never allow a user to over-scroll this view.

Constant Value: 2 (0x00000002)

SCROLL_AXIS_HORIZONTAL

added in version 22.1.0

int SCROLL_AXIS_HORIZONTAL

Indicates scrolling along the horizontal axis.

Constant Value: 1 (0x00000001)

SCROLL_AXIS_NONE

added in version 22.1.0

int SCROLL_AXIS_NONE

Indicates no axis of view scrolling.

Constant Value: 0 (0x00000000)

SCROLL_AXIS_VERTICAL

added in version 22.1.0

int SCROLL_AXIS_VERTICAL

Indicates scrolling along the vertical axis.

Constant Value: 2 (0x00000002)

SCROLL_INDICATOR_BOTTOM

added in version 24.1.0

int SCROLL_INDICATOR_BOTTOM

Scroll indicator direction for the bottom edge of the view.

See also:

Constant Value: 2 (0x00000002)

SCROLL_INDICATOR_END

added in version 24.1.0

int SCROLL_INDICATOR_END

Scroll indicator direction for the ending edge of the view.

See also:

Constant Value: 32 (0x00000020)

SCROLL_INDICATOR_LEFT

added in version 24.1.0

int SCROLL_INDICATOR_LEFT

Scroll indicator direction for the left edge of the view.

See also:

Constant Value: 4 (0x00000004)

SCROLL_INDICATOR_RIGHT

added in version 24.1.0

int SCROLL_INDICATOR_RIGHT

Scroll indicator direction for the right edge of the view.

See also:

Constant Value: 8 (0x00000008)

SCROLL_INDICATOR_START

added in version 24.1.0

int SCROLL_INDICATOR_START

Scroll indicator direction for the starting edge of the view.

See also:

Constant Value: 16 (0x00000010)

SCROLL_INDICATOR_TOP

added in version 24.1.0

int SCROLL_INDICATOR_TOP

Scroll indicator direction for the top edge of the view.

See also:

Constant Value: 1 (0x00000001)

TYPE_NON_TOUCH

added in version 26.1.0

int TYPE_NON_TOUCH

Indicates that the input type for the gesture is caused by something which is not a user touching a screen. This is usually from a fling which is settling.

Constant Value: 1 (0x00000001)

TYPE_TOUCH

added in version 26.1.0

int TYPE_TOUCH

Indicates that the input type for the gesture is from a user touching the screen.

Constant Value: 0 (0x00000000)

Protected constructors

ViewCompat

added in version 22.1.0

ViewCompat ()

Public methods

addKeyboardNavigationClusters

added in version 26.1.0

void addKeyboardNavigationClusters (View view, 
                Collection<View> views, 
                int direction)

Adds any keyboard navigation cluster roots that are descendants of view ( including view if it is a cluster root itself) to views. Does nothing on API < 26.

Parameters
`view`	`View`
`views`	`Collection`: collection of keyboard navigation cluster roots found so far.
`direction`	`int`: direction to look.

animate

added in version 22.1.0

ViewPropertyAnimatorCompat animate (View view)

This method returns a ViewPropertyAnimator object, which can be used to animate specific properties on this View.

Parameters
`view`	`View`

Returns
`ViewPropertyAnimatorCompat`	ViewPropertyAnimator The ViewPropertyAnimator associated with this View.

canScrollHorizontally

added in version 22.1.0

boolean canScrollHorizontally (View view, 
                int direction)

This method was deprecated in API level 26.1.0.
Use canScrollHorizontally(int) directly.

Check if this view can be scrolled horizontally in a certain direction.

Parameters
`view`	`View`: The View against which to invoke the method.
`direction`	`int`: Negative to check scrolling left, positive to check scrolling right.

Returns
`boolean`	true if this view can be scrolled in the specified direction, false otherwise.

canScrollVertically

added in version 22.1.0

boolean canScrollVertically (View view, 
                int direction)

This method was deprecated in API level 26.1.0.
Use canScrollVertically(int) directly.

Check if this view can be scrolled vertically in a certain direction.

Parameters
`view`	`View`: The View against which to invoke the method.
`direction`	`int`: Negative to check scrolling up, positive to check scrolling down.

Returns
`boolean`	true if this view can be scrolled in the specified direction, false otherwise.

cancelDragAndDrop

added in version 24.1.0

void cancelDragAndDrop (View v)

Cancel the drag and drop operation.

Parameters
`v`	`View`

combineMeasuredStates

added in version 22.1.0

int combineMeasuredStates (int curState, 
                int newState)

This method was deprecated in API level 26.1.0.
Use combineMeasuredStates(int, int) directly.

Merge two states as returned by getMeasuredState(View).

Parameters
`curState`	`int`: The current state as returned from a view or the result of combining multiple views.
`newState`	`int`: The new view state to combine.

Returns
`int`	Returns a new integer reflecting the combination of the two states.

dispatchApplyWindowInsets

added in version 22.1.0

WindowInsetsCompat dispatchApplyWindowInsets (View view, 
                WindowInsetsCompat insets)

Request to apply the given window insets to this view or another view in its subtree.

This method should be called by clients wishing to apply insets corresponding to areas obscured by window decorations or overlays. This can include the status and navigation bars, action bars, input methods and more. New inset categories may be added in the future. The method returns the insets provided minus any that were applied by this view or its children.

Parameters
`view`	`View`
`insets`	`WindowInsetsCompat`: Insets to apply

Returns
`WindowInsetsCompat`	The provided insets minus the insets that were consumed

dispatchFinishTemporaryDetach

added in version 22.1.0

void dispatchFinishTemporaryDetach (View view)

Notify a view that its temporary detach has ended; the view is now reattached.

Parameters
`view`	`View`

dispatchNestedFling

added in version 22.1.0

boolean dispatchNestedFling (View view, 
                float velocityX, 
                float velocityY, 
                boolean consumed)

Dispatch a fling to a nested scrolling parent.

This method should be used to indicate that a nested scrolling child has detected suitable conditions for a fling. Generally this means that a touch scroll has ended with a velocity in the direction of scrolling that meets or exceeds the minimum fling velocity along a scrollable axis.

If a nested scrolling child view would normally fling but it is at the edge of its own content, it can use this method to delegate the fling to its nested scrolling parent instead. The parent may optionally consume the fling or observe a child fling.

Parameters
`view`	`View`
`velocityX`	`float`: Horizontal fling velocity in pixels per second
`velocityY`	`float`: Vertical fling velocity in pixels per second
`consumed`	`boolean`: true if the child consumed the fling, false otherwise

Returns
`boolean`	true if the nested scrolling parent consumed or otherwise reacted to the fling

dispatchNestedPreFling

added in version 22.1.0

boolean dispatchNestedPreFling (View view, 
                float velocityX, 
                float velocityY)

Dispatch a fling to a nested scrolling parent before it is processed by this view.

Nested pre-fling events are to nested fling events what touch intercept is to touch and what nested pre-scroll is to nested scroll. dispatchNestedPreFling offsets an opportunity for the parent view in a nested fling to fully consume the fling before the child view consumes it. If this method returns true, a nested parent view consumed the fling and this view should not scroll as a result.

For a better user experience, only one view in a nested scrolling chain should consume the fling at a time. If a parent view consumed the fling this method will return false. Custom view implementations should account for this in two ways:

If a custom view is paged and needs to settle to a fixed page-point, do not call dispatchNestedPreFling; consume the fling and settle to a valid position regardless.
If a nested parent does consume the fling, this view should not scroll at all, even to settle back to a valid idle position.

Views should also not offer fling velocities to nested parent views along an axis where scrolling is not currently supported; a ScrollView should not offer a horizontal fling velocity to its parents since scrolling along that axis is not permitted and carrying velocity along that motion does not make sense.

Parameters
`view`	`View`
`velocityX`	`float`: Horizontal fling velocity in pixels per second
`velocityY`	`float`: Vertical fling velocity in pixels per second

Returns
`boolean`	true if a nested scrolling parent consumed the fling

dispatchNestedPreScroll

added in version 26.1.0

boolean dispatchNestedPreScroll (View view, 
                int dx, 
                int dy, 
                int[] consumed, 
                int[] offsetInWindow, 
                int type)

Dispatch one step of a nested scroll in progress before this view consumes any portion of it.

Nested pre-scroll events are to nested scroll events what touch intercept is to touch. dispatchNestedPreScroll offers an opportunity for the parent view in a nested scrolling operation to consume some or all of the scroll operation before the child view consumes it.

Parameters
`view`	`View`
`dx`	`int`: Horizontal scroll distance in pixels
`dy`	`int`: Vertical scroll distance in pixels
`consumed`	`int`: Output. If not null, consumed[0] will contain the consumed component of dx and consumed[1] the consumed dy.
`offsetInWindow`	`int`: Optional. If not null, on return this will contain the offset in local view coordinates of this view from before this operation to after it completes. View implementations may use this to adjust expected input coordinate tracking.
`type`	`int`: the type of input which cause this scroll event

Returns
`boolean`	true if the parent consumed some or all of the scroll delta

See also:

dispatchNestedScroll(View, int, int, int, int, int[])

dispatchNestedPreScroll

added in version 22.1.0

boolean dispatchNestedPreScroll (View view, 
                int dx, 
                int dy, 
                int[] consumed, 
                int[] offsetInWindow)

Dispatch one step of a nested scroll in progress before this view consumes any portion of it.

This version of the method just calls dispatchNestedPreScroll(View, int, int, int[], int[], int) using the touch input type.

Parameters
`view`	`View`
`dx`	`int`: Horizontal scroll distance in pixels
`dy`	`int`: Vertical scroll distance in pixels
`consumed`	`int`: Output. If not null, consumed[0] will contain the consumed component of dx and consumed[1] the consumed dy.
`offsetInWindow`	`int`: Optional. If not null, on return this will contain the offset in local view coordinates of this view from before this operation to after it completes. View implementations may use this to adjust expected input coordinate tracking.

Returns
`boolean`	true if the parent consumed some or all of the scroll delta

dispatchNestedScroll

added in version 26.1.0

boolean dispatchNestedScroll (View view, 
                int dxConsumed, 
                int dyConsumed, 
                int dxUnconsumed, 
                int dyUnconsumed, 
                int[] offsetInWindow, 
                int type)

Dispatch one step of a nested scroll in progress.

Implementations of views that support nested scrolling should call this to report info about a scroll in progress to the current nested scrolling parent. If a nested scroll is not currently in progress or nested scrolling is not enabled for this view this method does nothing.

Compatible View implementations should also call dispatchNestedPreScroll before consuming a component of the scroll event themselves.

Parameters
`view`	`View`
`dxConsumed`	`int`: Horizontal distance in pixels consumed by this view during this scroll step
`dyConsumed`	`int`: Vertical distance in pixels consumed by this view during this scroll step
`dxUnconsumed`	`int`: Horizontal scroll distance in pixels not consumed by this view
`dyUnconsumed`	`int`: Horizontal scroll distance in pixels not consumed by this view
`offsetInWindow`	`int`: Optional. If not null, on return this will contain the offset in local view coordinates of this view from before this operation to after it completes. View implementations may use this to adjust expected input coordinate tracking.
`type`	`int`: the type of input which cause this scroll event

Returns
`boolean`	true if the event was dispatched, false if it could not be dispatched.

See also:

dispatchNestedPreScroll(View, int, int, int[], int[])

dispatchNestedScroll

added in version 22.1.0

boolean dispatchNestedScroll (View view, 
                int dxConsumed, 
                int dyConsumed, 
                int dxUnconsumed, 
                int dyUnconsumed, 
                int[] offsetInWindow)

Dispatch one step of a nested scroll in progress.

This version of the method just calls dispatchNestedScroll(View, int, int, int, int, int[], int) using the touch input type.

Parameters
`view`	`View`
`dxConsumed`	`int`: Horizontal distance in pixels consumed by this view during this scroll step
`dyConsumed`	`int`: Vertical distance in pixels consumed by this view during this scroll step
`dxUnconsumed`	`int`: Horizontal scroll distance in pixels not consumed by this view
`dyUnconsumed`	`int`: Horizontal scroll distance in pixels not consumed by this view
`offsetInWindow`	`int`: Optional. If not null, on return this will contain the offset in local view coordinates of this view from before this operation to after it completes. View implementations may use this to adjust expected input coordinate tracking.

Returns
`boolean`	true if the event was dispatched, false if it could not be dispatched.

dispatchStartTemporaryDetach

added in version 22.1.0

void dispatchStartTemporaryDetach (View view)

Notify a view that it is being temporarily detached.

Parameters
`view`	`View`

generateViewId

added in version 27.1.0

int generateViewId ()

Generate a value suitable for use in setId(int). This value will not collide with ID values generated at build time by aapt for R.id.

Returns
`int`	a generated ID value

getAccessibilityLiveRegion

added in version 22.1.0

int getAccessibilityLiveRegion (View view)

Gets the live region mode for the specified View.

Parameters
`view`	`View`: The view from which to obtain the live region mode

Returns
`int`	The live region mode for the view.

See also:

setAccessibilityLiveRegion(View, int)

getAccessibilityNodeProvider

added in version 22.1.0

AccessibilityNodeProviderCompat getAccessibilityNodeProvider (View view)

Gets the provider for managing a virtual view hierarchy rooted at this View and reported to AccessibilityServices that explore the window content.

If this method returns an instance, this instance is responsible for managing AccessibilityNodeInfoCompats describing the virtual sub-tree rooted at this View including the one representing the View itself. Similarly the returned instance is responsible for performing accessibility actions on any virtual view or the root view itself.

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

Parameters
`view`	`View`: The view whose property to get.

Returns
`AccessibilityNodeProviderCompat`	The provider.

See also:

AccessibilityNodeProviderCompat

getAlpha

added in version 22.1.0

float getAlpha (View view)

This method was deprecated in API level 26.1.0.
Use getAlpha() directly.

The opacity of the view. This is a value from 0 to 1, where 0 means the view is completely transparent and 1 means the view is completely opaque.

By default this is 1.0f.

Parameters
`view`	`View`

Returns
`float`	The opacity of the view.

getBackgroundTintList

added in version 22.1.0

ColorStateList getBackgroundTintList (View view)

Return the tint applied to the background drawable, if specified.

Only returns meaningful info when running on API v21 or newer, or if view implements the TintableBackgroundView interface.

Parameters
`view`	`View`

Returns
`ColorStateList`

getBackgroundTintMode

added in version 22.1.0

PorterDuff.Mode getBackgroundTintMode (View view)

Return the blending mode used to apply the tint to the background drawable, if specified.

Only returns meaningful info when running on API v21 or newer, or if view implements the TintableBackgroundView interface.

Parameters
`view`	`View`

Returns
`PorterDuff.Mode`

getClipBounds

added in version 24.1.0

Rect getClipBounds (View view)

Returns a copy of the current setClipBounds(View, Rect).

Prior to API 18 this will return null.

Parameters
`view`	`View`

Returns
`Rect`	A copy of the current clip bounds if clip bounds are set, otherwise null.

getDisplay

added in version 25.1.0

Display getDisplay (View view)

Gets the logical display to which the view's window has been attached.

Compatibility:

API < 17: Returns the default display when the view is attached. Otherwise, null.

Parameters
`view`	`View`

Returns
`Display`	The logical display, or null if the view is not currently attached to a window.

getElevation

added in version 22.1.0

float getElevation (View view)

The base elevation of this view relative to its parent, in pixels.

Parameters
`view`	`View`

Returns
`float`	The base depth position of the view, in pixels.

getFitsSystemWindows

added in version 22.1.0

boolean getFitsSystemWindows (View v)

Returns true if this view should adapt to fit system window insets. This method will always return false before API 16 (Jellybean).

Parameters
`v`	`View`

Returns
`boolean`

getImportantForAccessibility

added in version 22.1.0

int getImportantForAccessibility (View view)

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.

Parameters
`view`	`View`: The view whose property to get.

Returns
`int`	The mode for determining whether a View is important for accessibility.

See also:

getImportantForAutofill

added in version 27.1.0

int getImportantForAutofill (View v)

Gets the mode for determining whether this view is important for autofill.

See setImportantForAutofill(View, int) and isImportantForAutofill(View) for more info about this mode.

This method is only supported on API >= 26. On API 25 and below, it will always return IMPORTANT_FOR_AUTOFILL_AUTO.

Parameters
`v`	`View`

Returns
`int`	`IMPORTANT_FOR_AUTOFILL_AUTO` by default, or value passed to `setImportantForAutofill(View, int)`.

getLabelFor

added in version 22.1.0

int getLabelFor (View view)

Gets the id of a view for which a given view serves as a label for accessibility purposes.

Parameters
`view`	`View`: The view on which to invoke the corresponding method.

Returns
`int`	The labeled view id.

getLayerType

added in version 22.1.0

int getLayerType (View view)

This method was deprecated in API level 26.1.0.
Use getLayerType() directly.

Indicates what type of layer is currently associated with this view. By default a view does not have a layer, and the layer type is LAYER_TYPE_NONE. Refer to the documentation of setLayerType(android.view.View, int, android.graphics.Paint) for more information on the different types of layers.

Parameters
`view`	`View`: The view to fetch the layer type from

Returns
`int`	`LAYER_TYPE_NONE`, `LAYER_TYPE_SOFTWARE` or `LAYER_TYPE_HARDWARE`

See also:

getLayoutDirection

added in version 22.1.0

int getLayoutDirection (View view)

Returns the resolved layout direction for this view.

Parameters
`view`	`View`: View to get layout direction for

Returns
`int`	`LAYOUT_DIRECTION_RTL` if the layout direction is RTL or returns `LAYOUT_DIRECTION_LTR` if the layout direction is not RTL. For compatibility, this will return `LAYOUT_DIRECTION_LTR` if API version is lower than Jellybean MR1 (API 17)

getMatrix

added in version 24.1.0

Matrix getMatrix (View view)

This method was deprecated in API level 26.1.0.
Use getMatrix() directly.

The transform matrix of this view, which is calculated based on the current rotation, scale, and pivot properties.

Parameters
`view`	`View`: The view whose Matrix will be returned

Returns
`Matrix`	The current transform matrix for the view

See also:

getMeasuredHeightAndState

added in version 22.1.0

int getMeasuredHeightAndState (View view)

This method was deprecated in API level 26.1.0.
Use getMeasuredHeightAndState() directly.

Return the full height measurement information for this view as computed by the most recent call to measure(int, int). This result is a bit mask as defined by MEASURED_SIZE_MASK and MEASURED_STATE_TOO_SMALL. This should be used during measurement and layout calculations only. Use getHeight() to see how wide a view is after layout.

Parameters
`view`	`View`

Returns
`int`	The measured width of this view as a bit mask.

getMeasuredState

added in version 22.1.0

int getMeasuredState (View view)

This method was deprecated in API level 26.1.0.
Use getMeasuredState() directly.

Return only the state bits of getMeasuredWidthAndState(View) and getMeasuredHeightAndState(View), combined into one integer. The width component is in the regular bits MEASURED_STATE_MASK and the height component is at the shifted bits MEASURED_HEIGHT_STATE_SHIFT>>MEASURED_STATE_MASK.

Parameters
`view`	`View`

Returns
`int`

getMeasuredWidthAndState

added in version 22.1.0

int getMeasuredWidthAndState (View view)

This method was deprecated in API level 26.1.0.
Use getMeasuredWidth() directly.

Return the full width measurement information for this view as computed by the most recent call to measure(int, int). This result is a bit mask as defined by MEASURED_SIZE_MASK and MEASURED_STATE_TOO_SMALL. This should be used during measurement and layout calculations only. Use getWidth() to see how wide a view is after layout.

Parameters
`view`	`View`

Returns
`int`	The measured width of this view as a bit mask.

getMinimumHeight

added in version 22.1.0

int getMinimumHeight (View view)

Returns the minimum height of the view.

Prior to API 16, this method may return 0 on some platforms.

Parameters
`view`	`View`

Returns
`int`	the minimum height the view will try to be.

getMinimumWidth

added in version 22.1.0

int getMinimumWidth (View view)

Returns the minimum width of the view.

Prior to API 16, this method may return 0 on some platforms.

Parameters
`view`	`View`

Returns
`int`	the minimum width the view will try to be.

getNextClusterForwardId

added in version 26.1.0

int getNextClusterForwardId (View view)

Gets the ID of the next keyboard navigation cluster root.

Parameters
`view`	`View`

Returns
`int`	the next keyboard navigation cluster ID, or `NO_ID` if the framework should decide automatically or API < 26.

getOverScrollMode

added in version 22.1.0

int getOverScrollMode (View v)

This method was deprecated in API level 25.1.0.
Call getOverScrollMode() directly. This method will be removed in a future release.

Returns the over-scroll mode for this view. The result will be one of OVER_SCROLL_ALWAYS (default), OVER_SCROLL_IF_CONTENT_SCROLLS (allow over-scrolling only if the view content is larger than the container), or OVER_SCROLL_NEVER.

Parameters
`v`	`View`: The View against which to invoke the method.

Returns
`int`	This view's over-scroll mode.

getPaddingEnd

added in version 22.1.0

int getPaddingEnd (View view)

Returns the end padding of the specified view depending on its resolved layout direction. If there are inset and enabled scrollbars, this value may include the space required to display the scrollbars as well.

Parameters
`view`	`View`: The view to get padding for

Returns
`int`	the end padding in pixels

getPaddingStart

added in version 22.1.0

int getPaddingStart (View view)

Returns the start padding of the specified view depending on its resolved layout direction. If there are inset and enabled scrollbars, this value may include the space required to display the scrollbars as well.

Parameters
`view`	`View`: The view to get padding for

Returns
`int`	the start padding in pixels

getParentForAccessibility

added in version 22.1.0

ViewParent getParentForAccessibility (View view)

Gets the parent for accessibility purposes. Note that the parent for accessibility is not necessary the immediate parent. It is the first predecessor that is important for accessibility.

Parameters
`view`	`View`: View to retrieve parent for

Returns
`ViewParent`	The parent for use in accessibility inspection

getPivotX

added in version 22.1.0

float getPivotX (View view)

This method was deprecated in API level 26.1.0.
Use getPivotX() directly.

The x location of the point around which the view is rotated and scaled.

Parameters
`view`	`View`

Returns
`float`

getPivotY

added in version 22.1.0

float getPivotY (View view)

This method was deprecated in API level 26.1.0.
Use getPivotY() directly.

The y location of the point around which the view is rotated and scaled.

Parameters
`view`	`View`

Returns
`float`	The y location of the pivot point.

getRotation

added in version 22.1.0

float getRotation (View view)

This method was deprecated in API level 26.1.0.
Use getRotation() directly.

Parameters
`view`	`View`

Returns
`float`

getRotationX

added in version 22.1.0

float getRotationX (View view)

This method was deprecated in API level 26.1.0.
Use getRotationX() directly.

Parameters
`view`	`View`

Returns
`float`

getRotationY

added in version 22.1.0

float getRotationY (View view)

This method was deprecated in API level 26.1.0.
Use getRotationY() directly.

Parameters
`view`	`View`

Returns
`float`

getScaleX

added in version 22.1.0

float getScaleX (View view)

This method was deprecated in API level 26.1.0.
Use getScaleX() directly.

Parameters
`view`	`View`

Returns
`float`

getScaleY

added in version 22.1.0

float getScaleY (View view)

This method was deprecated in API level 26.1.0.
Use getScaleY() directly.

Parameters
`view`	`View`

Returns
`float`

getScrollIndicators

added in version 24.1.0

int getScrollIndicators (View view)

Returns a bitmask representing the enabled scroll indicators.

For example, if the top and left scroll indicators are enabled and all other indicators are disabled, the return value will be ViewCompat.SCROLL_INDICATOR_TOP | ViewCompat.SCROLL_INDICATOR_LEFT.

To check whether the bottom scroll indicator is enabled, use the value of (ViewCompat.getScrollIndicators(view) & ViewCompat.SCROLL_INDICATOR_BOTTOM) != 0.

Parameters
`view`	`View`

Returns
`int`	a bitmask representing the enabled scroll indicators

getTransitionName

added in version 22.1.0

String getTransitionName (View view)

Returns the name of the View to be used to identify Views in Transitions. Names should be unique in the View hierarchy.

This returns null if the View has not been given a name.

Parameters
`view`	`View`: The View against which to invoke the method.

Returns
`String`	The name used of the View to be used to identify Views in Transitions or null if no name has been given.

getTranslationX

added in version 22.1.0

float getTranslationX (View view)

This method was deprecated in API level 26.1.0.
Use getTranslationX() directly.

The horizontal location of this view relative to its left position. This position is post-layout, in addition to wherever the object's layout placed it.

Parameters
`view`	`View`

Returns
`float`	The horizontal position of this view relative to its left position, in pixels.

getTranslationY

added in version 22.1.0

float getTranslationY (View view)

This method was deprecated in API level 26.1.0.
Use getTranslationY() directly.

The vertical location of this view relative to its top position. This position is post-layout, in addition to wherever the object's layout placed it.

Parameters
`view`	`View`

Returns
`float`	The vertical position of this view relative to its top position, in pixels.

getTranslationZ

added in version 22.1.0

float getTranslationZ (View view)

The depth location of this view relative to its elevation.

Parameters
`view`	`View`

Returns
`float`	The depth of this view relative to its elevation.

getWindowSystemUiVisibility

added in version 22.1.0

int getWindowSystemUiVisibility (View view)

Returns the current system UI visibility that is currently set for the entire window.

Parameters
`view`	`View`

Returns
`int`

getX

added in version 22.1.0

float getX (View view)

This method was deprecated in API level 26.1.0.
Use getX() directly.

Parameters
`view`	`View`

Returns
`float`

getY

added in version 22.1.0

float getY (View view)

This method was deprecated in API level 26.1.0.
Use getY() directly.

Parameters
`view`	`View`

Returns
`float`

getZ

added in version 22.1.0

float getZ (View view)

The visual z position of this view, in pixels. This is equivalent to the translationZ property plus the current elevation property.

Parameters
`view`	`View`

Returns
`float`	The visual z position of this view, in pixels.

hasAccessibilityDelegate

added in version 22.1.0

boolean hasAccessibilityDelegate (View v)

Checks whether provided View has an accessibility delegate attached to it.

Parameters
`v`	`View`: The View instance to check

Returns
`boolean`	True if the View has an accessibility delegate

hasExplicitFocusable

added in version 26.1.0

boolean hasExplicitFocusable (View view)

Returns true if this view is focusable or if it contains a reachable View for which hasExplicitFocusable() returns true. A "reachable hasExplicitFocusable()" is a view whose parents do not block descendants focus. Only VISIBLE views for which getFocusable() would return FOCUSABLE are considered focusable.

This method preserves the pre-O behavior of hasFocusable() in that only views explicitly set focusable will cause this method to return true. A view set to FOCUSABLE_AUTO that resolves to focusable will not.

Parameters
`view`	`View`

Returns
`boolean`	`true` if the view is focusable or if the view contains a focusable view, `false` otherwise

hasNestedScrollingParent

added in version 26.1.0

boolean hasNestedScrollingParent (View view, 
                int type)

Returns true if this view has a nested scrolling parent.

The presence of a nested scrolling parent indicates that this view has initiated a nested scroll and it was accepted by an ancestor view further up the view hierarchy.

Parameters
`view`	`View`
`type`	`int`: the type of input which cause this scroll event

Returns
`boolean`	whether this view has a nested scrolling parent

hasNestedScrollingParent

added in version 22.1.0

boolean hasNestedScrollingParent (View view)

Returns true if this view has a nested scrolling parent.

This version of the method just calls hasNestedScrollingParent(View, int) using the touch input type.

Parameters
`view`	`View`

Returns
`boolean`	whether this view has a nested scrolling parent

hasOnClickListeners

added in version 24.1.0

boolean hasOnClickListeners (View view)

Returns whether the provided view has an attached View.OnClickListener.

Parameters
`view`	`View`

Returns
`boolean`	true if there is a listener, false if there is none.

hasOverlappingRendering

added in version 24.1.0

boolean hasOverlappingRendering (View view)

Returns whether this View has content which overlaps.

This function, intended to be overridden by specific View types, is an optimization when alpha is set on a view. If rendering overlaps in a view with alpha < 1, that view is drawn to an offscreen buffer and then composited into place, which can be expensive. If the view has no overlapping rendering, the view can draw each primitive with the appropriate alpha value directly. An example of overlapping rendering is a TextView with a background image, such as a Button. An example of non-overlapping rendering is a TextView with no background, or an ImageView with only the foreground image. The default implementation returns true; subclasses should override if they have cases which can be optimized.

Parameters
`view`	`View`

Returns
`boolean`	true if the content in this view might overlap, false otherwise.

hasTransientState

added in version 22.1.0

boolean hasTransientState (View view)

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.

Parameters
`view`	`View`: View to check for transient state

Returns
`boolean`	true if the view has transient state

isAttachedToWindow

added in version 24.1.0

boolean isAttachedToWindow (View view)

Returns true if the provided view is currently attached to a window.

Parameters
`view`	`View`

Returns
`boolean`

isFocusedByDefault

added in version 26.1.0

boolean isFocusedByDefault (View view)

Returns whether view should receive focus when the focus is restored for the view hierarchy containing it. Returns false on API < 26.

Focus gets restored for a view hierarchy when the root of the hierarchy gets added to a window or serves as a target of cluster navigation.

Parameters
`view`	`View`

Returns
`boolean`	`true` if `view` is the default-focus view, `false` otherwise.

isImportantForAccessibility

added in version 25.1.0

boolean isImportantForAccessibility (View view)

Computes whether this view should be exposed for accessibility. In general, views that are interactive or provide information are exposed while views that serve only as containers are hidden.

If an ancestor of this view has importance IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS, this method returns false.

Otherwise, the value is computed according to the view's getImportantForAccessibility(View) value:

IMPORTANT_FOR_ACCESSIBILITY_NO or IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS, return false
IMPORTANT_FOR_ACCESSIBILITY_YES, return true
IMPORTANT_FOR_ACCESSIBILITY_AUTO, return true if view satisfies any of the following:
- Is actionable, e.g. isClickable(), isLongClickable(), or isFocusable()
- Has an AccessibilityDelegateCompat
- Has an interaction listener, e.g. View.OnTouchListener, View.OnKeyListener, etc.
- Is an accessibility live region, e.g. getAccessibilityLiveRegion(View) is not ACCESSIBILITY_LIVE_REGION_NONE.

Note: Prior to API 21, this method will always return true.

Parameters
`view`	`View`

Returns
`boolean`	Whether the view is exposed for accessibility.

See also:

isImportantForAutofill

added in version 27.1.0

boolean isImportantForAutofill (View v)

Hints the Android System whether the AssistStructure.ViewNode associated with this view is considered important for autofill purposes.

Generally speaking, a view is important for autofill if:

The view can be autofilled by an AutofillService.
The view contents can help an AutofillService determine how other views can be autofilled.

isInLayout

added in version 24.1.0

boolean isInLayout (View view)

Returns whether the view hierarchy is currently undergoing a layout pass. This information is useful to avoid situations such as calling requestLayout() during a layout pass.

Compatibility:

API < 18: Always returns false

Parameters
`view`	`View`

Returns
`boolean`	whether the view hierarchy is currently undergoing a layout pass

isKeyboardNavigationCluster

added in version 26.1.0

boolean isKeyboardNavigationCluster (View view)

Returns whether view is a root of a keyboard navigation cluster. Always returns false on API < 26.

Parameters
`view`	`View`

Returns
`boolean`	`true` if this view is a root of a cluster, or `false` otherwise.

isLaidOut

added in version 22.1.0

boolean isLaidOut (View view)

Returns true if view has been through at least one layout since it was last attached to or detached from a window.

Parameters
`view`	`View`

Returns
`boolean`

isLayoutDirectionResolved

added in version 24.1.0

boolean isLayoutDirectionResolved (View view)

Returns whether layout direction has been resolved.

Compatibility:

API < 19: Always returns false

Parameters
`view`	`View`

Returns
`boolean`	true if layout direction has been resolved.

isNestedScrollingEnabled

added in version 22.1.0

boolean isNestedScrollingEnabled (View view)

Returns true if nested scrolling is enabled for this view.

If nested scrolling is enabled and this View class implementation supports it, this view will act as a nested scrolling child view when applicable, forwarding data about the scroll operation in progress to a compatible and cooperating nested scrolling parent.

Parameters
`view`	`View`

Returns
`boolean`	true if nested scrolling is enabled

See also:

setNestedScrollingEnabled(View, boolean)

isOpaque

added in version 22.1.0

boolean isOpaque (View view)

This method was deprecated in API level 25.1.0.
Use isOpaque() directly. This method will be removed in a future release.

Indicates whether this View is opaque. An opaque View guarantees that it will draw all the pixels overlapping its bounds using a fully opaque color.

Parameters
`view`	`View`

Returns
`boolean`	True if this View is guaranteed to be fully opaque, false otherwise.

isPaddingRelative

added in version 22.1.0

boolean isPaddingRelative (View view)

Return if the padding as been set through relative values View.setPaddingRelative(int, int, int, int) or thru

Parameters
`view`	`View`

Returns
`boolean`	true if the padding is relative or false if it is not.

jumpDrawablesToCurrentState

added in version 22.1.0

void jumpDrawablesToCurrentState (View v)

This method was deprecated in API level 26.1.0.
Use jumpDrawablesToCurrentState() directly.

On API 11 devices and above, call Drawable.jumpToCurrentState() on all Drawable objects associated with this view.

On API 21 and above, also calls StateListAnimator#jumpToCurrentState() if there is a StateListAnimator attached to this view.

Parameters
`v`	`View`

keyboardNavigationClusterSearch

added in version 26.1.0

View keyboardNavigationClusterSearch (View view, 
                View currentCluster, 
                int direction)

Find the nearest keyboard navigation cluster in the specified direction. This does not actually give focus to that cluster.

Parameters
`view`	`View`
`currentCluster`	`View`: The starting point of the search. `null` means the current cluster is not found yet.
`direction`	`int`: Direction to look.

Returns
`View`	the nearest keyboard navigation cluster in the specified direction, or `null` if one can't be found or if API < 26.

offsetLeftAndRight

added in version 24.1.0

void offsetLeftAndRight (View view, 
                int offset)

Offset this view's horizontal location by the specified amount of pixels.

Parameters
`view`	`View`
`offset`	`int`: the number of pixels to offset the view by

offsetTopAndBottom

added in version 24.1.0

void offsetTopAndBottom (View view, 
                int offset)

Offset this view's vertical location by the specified number of pixels.

Parameters
`view`	`View`
`offset`	`int`: the number of pixels to offset the view by

onApplyWindowInsets

added in version 22.1.0

WindowInsetsCompat onApplyWindowInsets (View view, 
                WindowInsetsCompat insets)

Called when the view should apply WindowInsetsCompat according to its internal policy.

Clients may supply an OnApplyWindowInsetsListener to a view. If one is set it will be called during dispatch instead of this method. The listener may optionally call this method from its own implementation if it wishes to apply the view's default insets policy in addition to its own.

Parameters
`view`	`View`: The View against which to invoke the method.
`insets`	`WindowInsetsCompat`: Insets to apply

Returns
`WindowInsetsCompat`	The supplied insets with any applied insets consumed

onInitializeAccessibilityEvent

added in version 22.1.0

void onInitializeAccessibilityEvent (View v, 
                AccessibilityEvent event)

This method was deprecated in API level 26.1.0.
Call onInitializeAccessibilityEvent(AccessibilityEvent) directly. This method will be removed in a future release.

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 AccessibilityDelegateCompat has been specified via calling setAccessibilityDelegate(View, AccessibilityDelegateCompat), its onInitializeAccessibilityEvent(View, AccessibilityEvent) is responsible for handling this call.

Parameters
`v`	`View`: The View against which to invoke the method.
`event`	`AccessibilityEvent`: The event to initialize.

See also:

onInitializeAccessibilityNodeInfo

added in version 22.1.0

void onInitializeAccessibilityNodeInfo (View v, 
                AccessibilityNodeInfoCompat info)

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

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

Parameters
`v`	`View`: The View against which to invoke the method.
`info`	`AccessibilityNodeInfoCompat`: The instance to initialize.

onPopulateAccessibilityEvent

added in version 22.1.0

void onPopulateAccessibilityEvent (View v, 
                AccessibilityEvent event)

This method was deprecated in API level 26.1.0.
Call onPopulateAccessibilityEvent(AccessibilityEvent) directly. This method will be removed in a future release.

Called from dispatchPopulateAccessibilityEvent(AccessibilityEvent) giving a chance to this View to populate the accessibility event with its text content. While this method is free to modify event attributes other than text content, doing so should normally be performed in onInitializeAccessibilityEvent(AccessibilityEvent).

Example: Adding formatted date string to an accessibility event in addition to the text added by the super implementation:

 public void onPopulateAccessibilityEvent(AccessibilityEvent event) {
     super.onPopulateAccessibilityEvent(event);
     final int flags = DateUtils.FORMAT_SHOW_DATE | DateUtils.FORMAT_SHOW_WEEKDAY;
     String selectedDateUtterance = DateUtils.formatDateTime(mContext,
         mCurrentDate.getTimeInMillis(), flags);
     event.getText().add(selectedDateUtterance);
 }

If an AccessibilityDelegateCompat has been specified via calling setAccessibilityDelegate(View, AccessibilityDelegateCompat) its onPopulateAccessibilityEvent(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
`v`	`View`: The View against which to invoke the method.
`event`	`AccessibilityEvent`: The accessibility event which to populate.

See also:

performAccessibilityAction

added in version 22.1.0

boolean performAccessibilityAction (View view, 
                int action, 
                Bundle arguments)

Performs the specified accessibility action on the view. For possible accessibility actions look at AccessibilityNodeInfoCompat.

If an AccessibilityDelegateCompat has been specified via calling setAccessibilityDelegate(View, AccessibilityDelegateCompat) its performAccessibilityAction(View, int, Bundle) is responsible for handling this call.

Parameters
`view`	`View`
`action`	`int`: The action to perform.
`arguments`	`Bundle`: Optional action arguments.

Returns
`boolean`	Whether the action was performed.

postInvalidateOnAnimation

added in version 22.1.0

void postInvalidateOnAnimation (View view, 
                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.

This method can be invoked from outside of the UI thread only when this View is attached to a window.

Parameters
`view`	`View`: View to invalidate
`left`	`int`: The left coordinate of the rectangle to invalidate.
`top`	`int`: The top coordinate of the rectangle to invalidate.
`right`	`int`: The right coordinate of the rectangle to invalidate.
`bottom`	`int`: The bottom coordinate of the rectangle to invalidate.

postInvalidateOnAnimation

added in version 22.1.0

void postInvalidateOnAnimation (View view)

Cause an invalidate to happen on the next animation time step, typically the next display frame.

This method can be invoked from outside of the UI thread only when this View is attached to a window.

Parameters
`view`	`View`: View to invalidate

postOnAnimation

added in version 22.1.0

void postOnAnimation (View view, 
                Runnable action)

Causes the Runnable to execute on the next animation time step. The runnable will be run on the user interface thread.

This method can be invoked from outside of the UI thread only when this View is attached to a window.

Parameters
`view`	`View`: View to post this Runnable to
`action`	`Runnable`: The Runnable that will be executed.

postOnAnimationDelayed

added in version 22.1.0

void postOnAnimationDelayed (View view, 
                Runnable action, 
                long delayMillis)

Causes the Runnable to execute on the next animation time step, after the specified amount of time elapses. The runnable will be run on the user interface thread.

This method can be invoked from outside of the UI thread only when this View is attached to a window.

Parameters
`view`	`View`: The view to post this Runnable to
`action`	`Runnable`: The Runnable that will be executed.
`delayMillis`	`long`: The delay (in milliseconds) until the Runnable will be executed.

requestApplyInsets

added in version 22.1.0

void requestApplyInsets (View view)

Ask that a new dispatch of View.onApplyWindowInsets(WindowInsets) be performed. This falls back to View.requestFitSystemWindows() where available.

Parameters
`view`	`View`

requireViewById

added in version 27.1.0

T requireViewById (View view, 
                int id)

Finds the first descendant view with the given ID, the view itself if the ID matches getId(), or throws an IllegalArgumentException if the ID is invalid or there is no matching view in the hierarchy.

Note: In most cases -- depending on compiler support -- the resulting view is automatically cast to the target class type. If the target class type is unconstrained, an explicit cast may be necessary.

Parameters
`view`	`View`
`id`	`int`: the ID to search for

Returns
`T`	a view with given ID

See also:

findViewById(int)

resolveSizeAndState

added in version 22.1.0

int resolveSizeAndState (int size, 
                int measureSpec, 
                int childMeasuredState)

This method was deprecated in API level 26.1.0.
Use resolveSizeAndState(int, int, int) directly.

Utility to reconcile a desired size and state, with constraints imposed by a MeasureSpec. Will take the desired size, unless a different size is imposed by the constraints. The returned value is a compound integer, with the resolved size in the MEASURED_SIZE_MASK bits and optionally the bit MEASURED_STATE_TOO_SMALL set if the resulting size is smaller than the size the view wants to be.

Parameters
`size`	`int`: How big the view wants to be
`measureSpec`	`int`: Constraints imposed by the parent
`childMeasuredState`	`int`

Returns
`int`	Size information bit mask as defined by `MEASURED_SIZE_MASK` and `MEASURED_STATE_TOO_SMALL`.

restoreDefaultFocus

added in version 26.1.0

boolean restoreDefaultFocus (View view)

Gives focus to the default-focus view in the view hierarchy rooted at view. If the default-focus view cannot be found or if API < 26, this falls back to calling requestFocus(int).

Parameters
`view`	`View`

Returns
`boolean`	`true` if `view` or one of its descendants took focus, `false` otherwise.

setAccessibilityDelegate

added in version 22.1.0

void setAccessibilityDelegate (View v, 
                AccessibilityDelegateCompat delegate)

Sets a delegate for implementing accessibility support via composition (as opposed to inheritance). For more details, see AccessibilityDelegateCompat.

Note: On platform versions prior to API 23, delegate methods on views in the android.widget.* package are called before host methods. This prevents certain properties such as class name from being modified by overriding onInitializeAccessibilityNodeInfo(View, AccessibilityNodeInfoCompat), as any changes will be overwritten by the host class.

Starting in API 23, delegate methods are called after host methods, which all properties to be modified without being overwritten by the host class.

Parameters
`v`	`View`
`delegate`	`AccessibilityDelegateCompat`: the object to which accessibility method calls should be delegated

See also:

AccessibilityDelegateCompat

setAccessibilityLiveRegion

added in version 22.1.0

void setAccessibilityLiveRegion (View view, 
                int mode)

Sets the live region mode for the specified view. This indicates to accessibility services whether they should automatically notify the user about changes to the view's content description or text, or to the content descriptions or text of the view's children (where applicable).

For example, in a login screen with a TextView that displays an "incorrect password" notification, that view should be marked as a live region with mode ACCESSIBILITY_LIVE_REGION_POLITE.

To disable change notifications for this view, use ACCESSIBILITY_LIVE_REGION_NONE. This is the default live region mode for most views.

To indicate that the user should be notified of changes, use ACCESSIBILITY_LIVE_REGION_POLITE.

If the view's changes should interrupt ongoing speech and notify the user immediately, use ACCESSIBILITY_LIVE_REGION_ASSERTIVE.

Parameters

view

View: The view on which to set the live region mode

mode

int: The live region mode for this view, one of:

setActivated

added in version 22.1.0

void setActivated (View view, 
                boolean activated)

This method was deprecated in API level 26.1.0.
Use setActivated(boolean) directly.

Changes the activated state of this view. A view can be activated or not. Note that activation is not the same as selection. Selection is a transient property, representing the view (hierarchy) the user is currently interacting with. Activation is a longer-term state that the user can move views in and out of.

Parameters
`view`	`View`
`activated`	`boolean`: true if the view must be activated, false otherwise

setAlpha

added in version 22.1.0

void setAlpha (View view, 
                float value)

This method was deprecated in API level 26.1.0.
Use setAlpha(float) directly.

Sets the opacity of the view. This is a value from 0 to 1, where 0 means the view is completely transparent and 1 means the view is completely opaque.

Note that setting alpha to a translucent value (0 < alpha < 1) can have significant performance implications, especially for large views. It is best to use the alpha property sparingly and transiently, as in the case of fading animations.

Parameters
`view`	`View`
`value`	`float`: The opacity of the view. Value is between 0.0 and 1.0 inclusive.

setAutofillHints

added in version 27.1.0

void setAutofillHints (View v, 
                String... autofillHints)

Sets the hints that help an AutofillService determine how to autofill the view with the user's data.

Typically, there is only one way to autofill a view, but there could be more than one. For example, if the application accepts either an username or email address to identify an user.

These hints are not validated by the Android System, but passed "as is" to the service. Hence, they can have any value, but it's recommended to use the AUTOFILL_HINT_ constants such as: AUTOFILL_HINT_USERNAME, AUTOFILL_HINT_PASSWORD, AUTOFILL_HINT_EMAIL_ADDRESS, AUTOFILL_HINT_NAME, AUTOFILL_HINT_PHONE, AUTOFILL_HINT_POSTAL_ADDRESS, AUTOFILL_HINT_POSTAL_CODE, AUTOFILL_HINT_CREDIT_CARD_NUMBER, AUTOFILL_HINT_CREDIT_CARD_SECURITY_CODE, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DATE, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DAY, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_MONTH or AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_YEAR.

This method is only supported on API >= 26. On API 25 and below, it is a no-op

Parameters
`v`	`View`
`autofillHints`	`String`: The autofill hints to set. If the array is emtpy, `null` is set.

setBackground

added in version 25.1.0

void setBackground (View view, 
                Drawable background)

Set the background of the view to a given Drawable, or remove the background. If the background has padding, view's padding is set to the background's padding. However, when a background is removed, this View's padding isn't touched. If setting the padding is desired, please usesetPadding(int, int, int, int).

Parameters
`view`	`View`
`background`	`Drawable`

setBackgroundTintList

added in version 22.1.0

void setBackgroundTintList (View view, 
                ColorStateList tintList)

Applies a tint to the background drawable.

This will always take effect when running on API v21 or newer. When running on platforms previous to API v21, it will only take effect if view implements the TintableBackgroundView interface.

Parameters
`view`	`View`
`tintList`	`ColorStateList`

setBackgroundTintMode

added in version 22.1.0

void setBackgroundTintMode (View view, 
                PorterDuff.Mode mode)

Specifies the blending mode used to apply the tint specified by setBackgroundTintList(android.view.View, android.content.res.ColorStateList) to the background drawable. The default mode is SRC_IN.

This will always take effect when running on API v21 or newer. When running on platforms previous to API v21, it will only take effect if view implement the TintableBackgroundView interface.

Parameters
`view`	`View`
`mode`	`PorterDuff.Mode`

setChildrenDrawingOrderEnabled

added in version 22.1.0

void setChildrenDrawingOrderEnabled (ViewGroup viewGroup, 
                boolean enabled)

This method was deprecated in API level 27.1.0.
Use setChildrenDrawingOrderEnabled(boolean) directly.

Tells the ViewGroup whether to draw its children in the order defined by the method ViewGroup.getChildDrawingOrder(int, int).

Parameters

viewGroup

ViewGroup

enabled

boolean: true if the order of the children when drawing is determined by getChildDrawingOrder(int, int), false otherwise

Prior to API 7 this will have no effect.

setClipBounds

added in version 24.1.0

void setClipBounds (View view, 
                Rect clipBounds)

Sets a rectangular area on this view to which the view will be clipped when it is drawn. Setting the value to null will remove the clip bounds and the view will draw normally, using its full bounds.

Prior to API 18 this does nothing.

Parameters
`view`	`View`: The view to set clipBounds.
`clipBounds`	`Rect`: The rectangular area, in the local coordinates of this view, to which future drawing operations will be clipped.

setElevation

added in version 22.1.0

void setElevation (View view, 
                float elevation)

Sets the base elevation of this view, in pixels.

Parameters
`view`	`View`
`elevation`	`float`

setFitsSystemWindows

added in version 22.1.0

void setFitsSystemWindows (View view, 
                boolean fitSystemWindows)

This method was deprecated in API level 26.1.0.
Use setFitsSystemWindows(boolean) directly.

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. See that method for more details.

Parameters
`view`	`View`
`fitSystemWindows`	`boolean`

setFocusedByDefault

added in version 26.1.0

void setFocusedByDefault (View view, 
                boolean isFocusedByDefault)

Sets whether view should receive focus when the focus is restored for the view hierarchy containing it.

Focus gets restored for a view hierarchy when the root of the hierarchy gets added to a window or serves as a target of cluster navigation.

Does nothing on API < 26.

Parameters
`view`	`View`
`isFocusedByDefault`	`boolean`: `true` to set `view` as the default-focus view, `false` otherwise.

setHasTransientState

added in version 22.1.0

void setHasTransientState (View view, 
                boolean hasTransientState)

Set whether this view is currently tracking transient state that the framework should attempt to preserve when possible.

Parameters
`view`	`View`: View tracking transient state
`hasTransientState`	`boolean`: true if this view has transient state

setImportantForAccessibility

added in version 22.1.0

void setImportantForAccessibility (View view, 
                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.

Note: If the current platform version does not support the IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS mode, then IMPORTANT_FOR_ACCESSIBILITY_NO will be used as it is the closest terms of semantics.

Parameters
`view`	`View`: The view whose property to set.
`mode`	`int`: How to determine whether this view is important for accessibility.

See also:

setImportantForAutofill

added in version 27.1.0

void setImportantForAutofill (View v, 
                int mode)

Sets the mode for determining whether this view is considered important for autofill.

The platform determines the importance for autofill automatically but you can use this method to customize the behavior. For example:

When the view contents is irrelevant for autofill (for example, a text field used in a "Captcha" challenge), it should be IMPORTANT_FOR_AUTOFILL_NO.
When both the view and its children are irrelevant for autofill (for example, the root view of an activity containing a spreadhseet editor), it should be IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS.
When the view content is relevant for autofill but its children aren't (for example, a credit card expiration date represented by a custom view that overrides the proper autofill methods and has 2 children representing the month and year), it should be IMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTS.

NOTE: setting the mode as does IMPORTANT_FOR_AUTOFILL_NO or IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS does not guarantee the view (and its children) will be always be considered not important; for example, when the user explicitly makes an autofill request, all views are considered important. See isImportantForAutofill(View) for more details about how the View's importance for autofill is used.

This method is only supported on API >= 26. On API 25 and below, it is a no-op

Parameters

v View

mode int: IMPORTANT_FOR_AUTOFILL_AUTO, IMPORTANT_FOR_AUTOFILL_YES, IMPORTANT_FOR_AUTOFILL_NO, IMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTS, or IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS.

setKeyboardNavigationCluster

added in version 26.1.0

void setKeyboardNavigationCluster (View view, boolean isCluster)

Set whether view is a root of a keyboard navigation cluster. Does nothing if API < 26.

Parameters

view View

isCluster boolean: true to mark view as the root of a cluster, false to unmark.

setLabelFor

added in version 22.1.0

void setLabelFor (View view, int labeledId)

Sets the id of a view for which a given view serves as a label for accessibility purposes.

Parameters

view View: The view on which to invoke the corresponding method.

labeledId int: The labeled view id.

setLayerPaint

added in version 22.1.0

void setLayerPaint (View view, 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). Changed properties of the Paint provided to setLayerType(android.view.View, int, android.graphics.Paint) will be used the next time the View is redrawn, but setLayerPaint(android.view.View, android.graphics.Paint) must be called to ensure that the view gets redrawn immediately.
A layer is associated with an optional Paint instance that controls how the layer is composed on screen. The following properties of the paint are taken into account when composing the layer:

Translucency (alpha)

Blending mode

Color filter

If this view has an alpha value set to < 1.0 by calling View#setAlpha(float), the alpha value of the layer's paint is replaced by this view's alpha value. Calling View#setAlpha(float) is therefore equivalent to setting a hardware layer on this view and providing a paint with the desired alpha value.

Parameters

view View: View to set a layer paint for

paint Paint: The paint used to compose the layer. This argument is optional and can be null. It is ignored when the layer type is LAYER_TYPE_NONE

See also:

setLayerType(View, int, android.graphics.Paint)

setLayerType

added in version 22.1.0

void setLayerType (View view, int layerType, Paint paint)

This method was deprecated in API level 26.1.0.
Use setLayerType(int, Paint) directly.

Specifies the type of layer backing this view. The layer can be disabled, software or hardware.

A layer is associated with an optional Paint instance that controls how the layer is composed on screen. The following properties of the paint are taken into account when composing the layer:

Translucency (alpha)

Blending mode

Color filter

If this view has an alpha value set to < 1.0 by calling setAlpha(float), the alpha value of the layer's paint is replaced by this view's alpha value. Calling setAlpha(float) is therefore equivalent to setting a hardware layer on this view and providing a paint with the desired alpha value.

Refer to the documentation of disabled, software and hardware for more information on when and how to use layers.

Parameters

view View: View to set the layer type for

layerType int: The type of layer to use with this view, must be one of LAYER_TYPE_NONE, LAYER_TYPE_SOFTWARE or LAYER_TYPE_HARDWARE

paint Paint: The paint used to compose the layer. This argument is optional and can be null. It is ignored when the layer type is LAYER_TYPE_NONE

setLayoutDirection

added in version 22.1.0

void setLayoutDirection (View view, int layoutDirection)

Set the layout direction for this view. This will propagate a reset of layout direction resolution to the view's children and resolve layout direction for this view.

Parameters

view View: View to set layout direction for

layoutDirection int: the layout direction to set. Should be one of: LAYOUT_DIRECTION_LTR, LAYOUT_DIRECTION_RTL, LAYOUT_DIRECTION_INHERIT, LAYOUT_DIRECTION_LOCALE. Resolution will be done if the value is set to LAYOUT_DIRECTION_INHERIT. The resolution proceeds up the parent chain of the view to get the value. If there is no parent, then it will return the default LAYOUT_DIRECTION_LTR.

setNestedScrollingEnabled

added in version 22.1.0

void setNestedScrollingEnabled (View view, boolean enabled)

Enable or disable nested scrolling for this view.
If this property is set to true the view will be permitted to initiate nested scrolling operations with a compatible parent view in the current hierarchy. If this view does not implement nested scrolling this will have no effect. Disabling nested scrolling while a nested scroll is in progress has the effect of stopping the nested scroll.

Parameters

view View

enabled boolean: true to enable nested scrolling, false to disable

See also:

isNestedScrollingEnabled(View)

setNextClusterForwardId

added in version 26.1.0

void setNextClusterForwardId (View view, int nextClusterForwardId)

Sets the ID of the next keyboard navigation cluster root view. Does nothing if view is not a keyboard navigation cluster or if API < 26.

Parameters

view View

nextClusterForwardId int: next cluster ID, or NO_ID if the framework should decide automatically.

setOnApplyWindowInsetsListener

added in version 22.1.0

void setOnApplyWindowInsetsListener (View v, OnApplyWindowInsetsListener listener)

Set an OnApplyWindowInsetsListener to take over the policy for applying window insets to this view. This will only take effect on devices with API 21 or above.

Parameters

v View

listener OnApplyWindowInsetsListener

setOverScrollMode

added in version 22.1.0

void setOverScrollMode (View v, int overScrollMode)

This method was deprecated in API level 25.1.0.
Call setOverScrollMode(int) directly. This method will be removed in a future release.

Set the over-scroll mode for this view. Valid over-scroll modes are OVER_SCROLL_ALWAYS (default), OVER_SCROLL_IF_CONTENT_SCROLLS (allow over-scrolling only if the view content is larger than the container), or OVER_SCROLL_NEVER. Setting the over-scroll mode of a view will have an effect only if the view is capable of scrolling.

Parameters

v View: The View against which to invoke the method.

overScrollMode int: The new over-scroll mode for this view.

setPaddingRelative

added in version 22.1.0

void setPaddingRelative (View view, int start, int top, int end, int bottom)

Sets the relative padding. The view may add on the space required to display the scrollbars, depending on the style and visibility of the scrollbars. So the values returned from getPaddingStart(View), getPaddingTop(), getPaddingEnd(View) and getPaddingBottom() may be different from the values set in this call.

Parameters

view View: The view on which to set relative padding

start int: the start padding in pixels

top int: the top padding in pixels

end int: the end padding in pixels

bottom int: the bottom padding in pixels

setPivotX

added in version 22.1.0

void setPivotX (View view, float value)

This method was deprecated in API level 26.1.0.
Use setPivotX(float) directly.

Sets the x location of the point around which the view is rotated and scaled. By default, the pivot point is centered on the object. Setting this property disables this behavior and causes the view to use only the explicitly set pivotX and pivotY values.

Parameters

view View

value float: The x location of the pivot point.

setPivotY

added in version 22.1.0

void setPivotY (View view, float value)

This method was deprecated in API level 26.1.0.
Use setPivotX(float) directly.

Sets the y location of the point around which the view is rotated and scaled. By default, the pivot point is centered on the object. Setting this property disables this behavior and causes the view to use only the explicitly set pivotX and pivotY values.

Parameters

view View

value float: The y location of the pivot point.

setPointerIcon

added in version 24.1.0

void setPointerIcon (View view, PointerIconCompat pointerIcon)

Set the pointer icon for the current view.

Parameters

view View

pointerIcon PointerIconCompat: A PointerIconCompat instance which will be shown when the mouse hovers.

setRotation

added in version 22.1.0

void setRotation (View view, float value)

This method was deprecated in API level 26.1.0.
Use setRotation(float) directly.

Sets the degrees that the view is rotated around the pivot point. Increasing values result in clockwise rotation.

Parameters

view View

value float: The degrees of rotation.

setRotationX

added in version 22.1.0

void setRotationX (View view, float value)

This method was deprecated in API level 26.1.0.
Use setRotationX(float) directly.

Sets the degrees that the view is rotated around the horizontal axis through the pivot point. Increasing values result in clockwise rotation from the viewpoint of looking down the x axis.

Parameters

view View

value float: The degrees of X rotation.

setRotationY

added in version 22.1.0

void setRotationY (View view, float value)

This method was deprecated in API level 26.1.0.
Use setRotationY(float) directly.

Sets the degrees that the view is rotated around the vertical axis through the pivot point. Increasing values result in counter-clockwise rotation from the viewpoint of looking down the y axis.

Parameters

view View

value float: The degrees of Y rotation.

setSaveFromParentEnabled

added in version 22.1.0

void setSaveFromParentEnabled (View v, boolean enabled)

This method was deprecated in API level 26.1.0.
Use setSaveFromParentEnabled(boolean) directly.

Controls whether the entire hierarchy under this view will save its state when a state saving traversal occurs from its parent.

Parameters

v View

enabled boolean: Set to false to disable state saving, or true (the default) to allow it.

setScaleX

added in version 22.1.0

void setScaleX (View view, float value)

This method was deprecated in API level 26.1.0.
Use setScaleX(float) directly.

Sets the amount that the view is scaled in x around the pivot point, as a proportion of the view's unscaled width. A value of 1 means that no scaling is applied.

Parameters

view View

value float: The scaling factor.

setScaleY

added in version 22.1.0

void setScaleY (View view, float value)

This method was deprecated in API level 26.1.0.
Use setScaleY(float) directly.

Sets the amount that the view is scaled in Y around the pivot point, as a proportion of the view's unscaled width. A value of 1 means that no scaling is applied.

Parameters

view View

value float: The scaling factor.

setScrollIndicators

added in version 24.1.0

void setScrollIndicators (View view, int indicators, int mask)

Sets the state of the scroll indicators specified by the mask. To change all scroll indicators at once, see setScrollIndicators(View, int).
When a scroll indicator is enabled, it will be displayed if the view can scroll in the direction of the indicator.
Multiple indicator types may be enabled or disabled by passing the logical OR of the desired types. If multiple types are specified, they will all be set to the same enabled state.
For example, to enable the top scroll indicatorExample: setScrollIndicators

Parameters

view View

indicators int: the indicator direction, or the logical OR of multiple indicator directions. One or more of:

SCROLL_INDICATOR_TOP

SCROLL_INDICATOR_BOTTOM

SCROLL_INDICATOR_LEFT

SCROLL_INDICATOR_RIGHT

SCROLL_INDICATOR_START

SCROLL_INDICATOR_END

mask int

See also:

setScrollIndicators(View, int)
getScrollIndicators(View)

setScrollIndicators

added in version 24.1.0

void setScrollIndicators (View view, int indicators)

Sets the state of all scroll indicators.
See setScrollIndicators(View, int, int) for usage information.

Parameters

view View

indicators int: a bitmask of indicators that should be enabled, or 0 to disable all indicators

See also:

setScrollIndicators(View, int, int)
getScrollIndicators(View)

setTooltipText

added in version 26.1.0

void setTooltipText (View view, CharSequence tooltipText)

Sets the tooltip for the view.
Prior to API 26 this does nothing. Use TooltipCompat class from v7 appcompat library for a compatible tooltip implementation.

Parameters

view View

tooltipText CharSequence: the tooltip text

setTransitionName

added in version 22.1.0

void setTransitionName (View view, String transitionName)

Sets the name of the View to be used to identify Views in Transitions. Names should be unique in the View hierarchy.

Parameters

view View: The View against which to invoke the method.

transitionName String: The name of the View to uniquely identify it for Transitions.

setTranslationX

added in version 22.1.0

void setTranslationX (View view, float value)

This method was deprecated in API level 26.1.0.
Use setTranslationX(float) directly.

Sets the horizontal location of this view relative to its left position. This effectively positions the object post-layout, in addition to wherever the object's layout placed it.

Parameters

view View

value float: The horizontal position of this view relative to its left position, in pixels.

setTranslationY

added in version 22.1.0

void setTranslationY (View view, float value)

This method was deprecated in API level 26.1.0.
Use setTranslationY(float) directly.

Sets the vertical location of this view relative to its top position. This effectively positions the object post-layout, in addition to wherever the object's layout placed it.

Parameters

view View

value float: The vertical position of this view relative to its top position, in pixels.

setTranslationZ

added in version 22.1.0

void setTranslationZ (View view, float translationZ)

Sets the depth location of this view relative to its elevation.

Parameters

view View

translationZ float

setX

added in version 22.1.0

void setX (View view, float value)

This method was deprecated in API level 26.1.0.
Use setX(float) directly.

Sets the visual x position of this view, in pixels. This is equivalent to setting the translationX property to be the difference between the x value passed in and the current left property of the view as determined by the layout bounds.

Parameters

view View

value float: The visual x position of this view, in pixels.

setY

added in version 22.1.0

void setY (View view, float value)

This method was deprecated in API level 26.1.0.
Use setY(float) directly.

Sets the visual y position of this view, in pixels. This is equivalent to setting the translationY property to be the difference between the y value passed in and the current top property of the view as determined by the layout bounds.

Parameters

view View

value float: The visual y position of this view, in pixels.

setZ

added in version 24.1.0

void setZ (View view, float z)

Sets the visual z position of this view, in pixels. This is equivalent to setting the translationZ property to be the difference between the x value passed in and the current elevation property.
Compatibility:

API < 21: No-op

Parameters

view View

z float: The visual z position of this view, in pixels.

startDragAndDrop

added in version 24.1.0

boolean startDragAndDrop (View v, ClipData data, View.DragShadowBuilder shadowBuilder, Object localState, int flags)

Start the drag and drop operation.

Parameters

v View

data ClipData

shadowBuilder View.DragShadowBuilder

localState Object

flags int

Returns

boolean

startNestedScroll

added in version 26.1.0

boolean startNestedScroll (View view, int axes, int type)

Begin a nestable scroll operation along the given axes.
A view starting a nested scroll promises to abide by the following contract:

The view will call startNestedScroll upon initiating a scroll operation. In the case of a touch scroll this corresponds to the initial ACTION_DOWN. In the case of touch scrolling the nested scroll will be terminated automatically in the same manner as requestDisallowInterceptTouchEvent(boolean). In the event of programmatic scrolling the caller must explicitly call stopNestedScroll(View) to indicate the end of the nested scroll.

If startNestedScroll returns true, a cooperative parent was found. If it returns false the caller may ignore the rest of this contract until the next scroll. Calling startNestedScroll while a nested scroll is already in progress will return true.

At each incremental step of the scroll the caller should invoke dispatchNestedPreScroll once it has calculated the requested scrolling delta. If it returns true the nested scrolling parent at least partially consumed the scroll and the caller should adjust the amount it scrolls by.

After applying the remainder of the scroll delta the caller should invoke dispatchNestedScroll, passing both the delta consumed and the delta unconsumed. A nested scrolling parent may treat these values differently. See onNestedScroll(View, int, int, int, int).

Parameters

view View

axes int: Flags consisting of a combination of SCROLL_AXIS_HORIZONTAL and/or SCROLL_AXIS_VERTICAL.

type int: the type of input which cause this scroll event

Returns

boolean true if a cooperative parent was found and nested scrolling has been enabled for the current gesture.

See also:

stopNestedScroll(View)
dispatchNestedPreScroll(View, int, int, int[], int[])
dispatchNestedScroll(View, int, int, int, int, int[])

startNestedScroll

added in version 22.1.0

boolean startNestedScroll (View view, int axes)

Begin a nestable scroll operation along the given axes.
This version of the method just calls startNestedScroll(View, int, int) using the touch input type.

Parameters

view View

axes int: Flags consisting of a combination of SCROLL_AXIS_HORIZONTAL and/or SCROLL_AXIS_VERTICAL.

Returns

boolean true if a cooperative parent was found and nested scrolling has been enabled for the current gesture.

stopNestedScroll

added in version 26.1.0

void stopNestedScroll (View view, int type)

Stop a nested scroll in progress.
Calling this method when a nested scroll is not currently in progress is harmless.

Parameters

view View

type int: the type of input which cause this scroll event

See also:

startNestedScroll(View, int)

stopNestedScroll

added in version 22.1.0

void stopNestedScroll (View view)

Stop a nested scroll in progress.
This version of the method just calls stopNestedScroll(View, int) using the touch input type.

Parameters

view View

See also:

startNestedScroll(View, int)

updateDragShadow

added in version 24.1.0

void updateDragShadow (View v, View.DragShadowBuilder shadowBuilder)

Update the drag shadow while drag and drop is in progress.

Parameters

v View

shadowBuilder View.DragShadowBuilder

Annotations

ViewPager.DecorView

Interfaces

ActionProvider.VisibilityListener

AsyncLayoutInflater.OnInflateFinishedListener

LayoutInflaterFactory

MenuItemCompat.OnActionExpandListener

NestedScrollingChild

NestedScrollingChild2

NestedScrollingParent

NestedScrollingParent2

OnApplyWindowInsetsListener

ScrollingView

TintableBackgroundView

ViewPager.OnAdapterChangeListener

ViewPager.OnPageChangeListener

ViewPager.PageTransformer

ViewPropertyAnimatorListener

ViewPropertyAnimatorUpdateListener

Classes

AbsSavedState

AccessibilityDelegateCompat

ActionProvider

AsyncLayoutInflater

GestureDetectorCompat

GravityCompat

InputDeviceCompat

LayoutInflaterCompat

MarginLayoutParamsCompat

MenuCompat

MenuItemCompat

MotionEventCompat

NestedScrollingChildHelper

NestedScrollingParentHelper

PagerAdapter

PagerTabStrip

PagerTitleStrip

PointerIconCompat

ScaleGestureDetectorCompat

VelocityTrackerCompat

ViewCompat

ViewConfigurationCompat

ViewGroupCompat

ViewPager

ViewPager.LayoutParams

ViewPager.SavedState

ViewPager.SimpleOnPageChangeListener

ViewParentCompat

ViewPropertyAnimatorCompat

ViewPropertyAnimatorListenerAdapter

WindowCompat

WindowInsetsCompat

Parameters
`v`	`View`
`mode`	`int`: `IMPORTANT_FOR_AUTOFILL_AUTO`, `IMPORTANT_FOR_AUTOFILL_YES`, `IMPORTANT_FOR_AUTOFILL_NO`, `IMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTS`, or `IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS`.

Parameters
`view`	`View`
`isCluster`	`boolean`: `true` to mark `view` as the root of a cluster, `false` to unmark.

Parameters
`view`	`View`: The view on which to invoke the corresponding method.
`labeledId`	`int`: The labeled view id.

Parameters
`view`	`View`: View to set a layer paint for
`paint`	`Paint`: The paint used to compose the layer. This argument is optional and can be null. It is ignored when the layer type is `LAYER_TYPE_NONE`

Parameters
`view`	`View`: View to set the layer type for
`layerType`	`int`: The type of layer to use with this view, must be one of `LAYER_TYPE_NONE`, `LAYER_TYPE_SOFTWARE` or `LAYER_TYPE_HARDWARE`
`paint`	`Paint`: The paint used to compose the layer. This argument is optional and can be null. It is ignored when the layer type is `LAYER_TYPE_NONE`

Parameters
`view`	`View`: View to set layout direction for
`layoutDirection`	`int`: the layout direction to set. Should be one of: `LAYOUT_DIRECTION_LTR`, `LAYOUT_DIRECTION_RTL`, `LAYOUT_DIRECTION_INHERIT`, `LAYOUT_DIRECTION_LOCALE`. Resolution will be done if the value is set to LAYOUT_DIRECTION_INHERIT. The resolution proceeds up the parent chain of the view to get the value. If there is no parent, then it will return the default `LAYOUT_DIRECTION_LTR`.

Parameters
`view`	`View`
`nextClusterForwardId`	`int`: next cluster ID, or `NO_ID` if the framework should decide automatically.

Parameters
`v`	`View`: The View against which to invoke the method.
`overScrollMode`	`int`: The new over-scroll mode for this view.

Parameters
`view`	`View`: The view on which to set relative padding
`start`	`int`: the start padding in pixels
`top`	`int`: the top padding in pixels
`end`	`int`: the end padding in pixels
`bottom`	`int`: the bottom padding in pixels

Parameters
`view`	`View`
`pointerIcon`	`PointerIconCompat`: A PointerIconCompat instance which will be shown when the mouse hovers.

Parameters
`v`	`View`
`enabled`	`boolean`: Set to false to disable state saving, or true (the default) to allow it.

Parameters
`view`	`View`
`indicators`	`int`: a bitmask of indicators that should be enabled, or `0` to disable all indicators

Parameters
`view`	`View`: The View against which to invoke the method.
`transitionName`	`String`: The name of the View to uniquely identify it for Transitions.

Parameters
`view`	`View`
`z`	`float`: The visual z position of this view, in pixels.

Parameters
`v`	`View`
`data`	`ClipData`
`shadowBuilder`	`View.DragShadowBuilder`
`localState`	`Object`
`flags`	`int`

Parameters
`view`	`View`
`axes`	`int`: Flags consisting of a combination of `SCROLL_AXIS_HORIZONTAL` and/or `SCROLL_AXIS_VERTICAL`.
`type`	`int`: the type of input which cause this scroll event