Stay organized with collections Save and categorize content based on your preferences.
added in version 22.1.0
belongs to Maven artifact com.android.support:support-compat:28.0.0-alpha1

ViewCompat

public class ViewCompat
extends Object

java.lang.Object
   ↳ android.support.v4.view.ViewCompat
Known Direct Subclasses


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