ViewCompat

const val ACCESSIBILITY_LIVE_REGION_ASSERTIVE = 2: Int

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

Use with setAccessibilityLiveRegion.

const val ACCESSIBILITY_LIVE_REGION_NONE = 0: Int

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.

const val ACCESSIBILITY_LIVE_REGION_POLITE = 1: Int

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

Use with setAccessibilityLiveRegion.

const val IMPORTANT_FOR_ACCESSIBILITY_AUTO = 0: Int

Automatically determine whether a view is important for accessibility.

const val IMPORTANT_FOR_ACCESSIBILITY_NO = 2: Int

The view is not important for accessibility.

const val IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS = 4: Int

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

const val IMPORTANT_FOR_ACCESSIBILITY_YES = 1: Int

The view is important for accessibility.

const val IMPORTANT_FOR_CONTENT_CAPTURE_AUTO = 0: Int

Automatically determine whether a view is important for content capture.

const val IMPORTANT_FOR_CONTENT_CAPTURE_NO = 2: Int

The view is not important for content capture, but its children (if any) will be traversed.

const val IMPORTANT_FOR_CONTENT_CAPTURE_NO_EXCLUDE_DESCENDANTS = 8: Int

The view is not important for content capture, and its children (if any) will not be traversed.

const val IMPORTANT_FOR_CONTENT_CAPTURE_YES = 1: Int

The view is important for content capture, and its children (if any) will be traversed.

const val IMPORTANT_FOR_CONTENT_CAPTURE_YES_EXCLUDE_DESCENDANTS = 4: Int

The view is important for content capture, but its children (if any) will not be traversed.

const val LAYER_TYPE_HARDWARE = 2: Int

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.

const val LAYER_TYPE_NONE = 0: Int

Indicates that the view does not have a layer.

const val LAYER_TYPE_SOFTWARE = 1: Int

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

const val LAYOUT_DIRECTION_INHERIT = 2: Int

Horizontal layout direction of this view is inherited from its parent. Use with setLayoutDirection.

const val LAYOUT_DIRECTION_LOCALE = 3: Int

Horizontal layout direction of this view is from deduced from the default language script for the locale. Use with setLayoutDirection.

const val LAYOUT_DIRECTION_LTR = 0: Int

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

const val LAYOUT_DIRECTION_RTL = 1: Int

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

const val MEASURED_HEIGHT_STATE_SHIFT = 16: Int

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 and the childState argument of resolveSizeAndState.

const val MEASURED_SIZE_MASK = 16777215: Int

Bits of getMeasuredWidthAndState and getMeasuredWidthAndState that provide the actual measured size.

const val MEASURED_STATE_MASK = -16777216: Int

Bits of getMeasuredWidthAndState and getMeasuredWidthAndState that provide the additional state bits.

const val MEASURED_STATE_TOO_SMALL = 16777216: Int

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

const val OVER_SCROLL_ALWAYS = 0: Int

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

const val OVER_SCROLL_IF_CONTENT_SCROLLS = 1: Int

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.

const val OVER_SCROLL_NEVER = 2: Int

Never allow a user to over-scroll this view.

const val SCROLL_AXIS_HORIZONTAL = 1: Int

Indicates scrolling along the horizontal axis.

const val SCROLL_AXIS_NONE = 0: Int

Indicates no axis of view scrolling.

const val SCROLL_AXIS_VERTICAL = 2: Int

Indicates scrolling along the vertical axis.

const val SCROLL_INDICATOR_BOTTOM = 2: Int

Scroll indicator direction for the bottom edge of the view.

const val SCROLL_INDICATOR_END = 32: Int

Scroll indicator direction for the ending edge of the view.

const val SCROLL_INDICATOR_LEFT = 4: Int

Scroll indicator direction for the left edge of the view.

const val SCROLL_INDICATOR_RIGHT = 8: Int

Scroll indicator direction for the right edge of the view.

const val SCROLL_INDICATOR_START = 16: Int

Scroll indicator direction for the starting edge of the view.

const val SCROLL_INDICATOR_TOP = 1: Int

Scroll indicator direction for the top edge of the view.

const val TYPE_NON_TOUCH = 1: Int

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.

const val TYPE_TOUCH = 0: Int

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

java-static fun addAccessibilityAction(
    view: View,
    label: CharSequence,
    command: AccessibilityViewCommand
): Int

Adds an accessibility action that can be performed on a node associated with a view. A view can only have 32 actions created with this API.

java-static fun addKeyboardNavigationClusters(
    view: View,
    views: (Mutable)Collection<View!>,
    direction: Int
): Unit

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.

java-static fun addOnUnhandledKeyEventListener(
    view: View,
    listener: ViewCompat.OnUnhandledKeyEventListenerCompat
): Unit

Adds a listener which will receive unhandled KeyEvents. This must be called on the UI thread.

java-static fun addOverlayView(overlayHost: ViewGroup, overlay: View): Unit

Convenience method to add overlay to overlayHost's overlay and assign the disjointParent in the overlay hierarchy.

java-static fun animate(view: View): ViewPropertyAnimatorCompat

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

@ReplaceWith(expression = "view.canScrollHorizontally(direction)")
java-static fun canScrollHorizontally(view: View!, direction: Int): Boolean

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

@ReplaceWith(expression = "view.canScrollVertically(direction)")
java-static fun canScrollVertically(view: View!, direction: Int): Boolean

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

java-static fun cancelDragAndDrop(v: View): Unit

Cancel the drag and drop operation.

java-static fun combineMeasuredStates(curState: Int, newState: Int): Int

Merge two states as returned by getMeasuredState.

java-static fun computeSystemWindowInsets(
    view: View,
    insets: WindowInsetsCompat,
    outLocalInsets: Rect
): WindowInsetsCompat

Compute insets that should be consumed by this view and the ones that should propagate to those under it.

java-static fun dispatchApplyWindowInsets(view: View, insets: WindowInsetsCompat): WindowInsetsCompat

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.

java-static fun dispatchFinishTemporaryDetach(view: View): Unit

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

java-static fun dispatchNestedFling(
    view: View,
    velocityX: Float,
    velocityY: Float,
    consumed: Boolean
): Boolean

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.

java-static fun dispatchNestedPreFling(view: View, velocityX: Float, velocityY: Float): Boolean

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.

java-static fun dispatchNestedPreScroll(
    view: View,
    dx: Int,
    dy: Int,
    consumed: IntArray?,
    offsetInWindow: IntArray?
): Boolean

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 using the touch input type.

java-static fun dispatchNestedPreScroll(
    view: View,
    dx: Int,
    dy: Int,
    consumed: IntArray?,
    offsetInWindow: IntArray?,
    type: Int
): Boolean

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.

java-static fun dispatchNestedScroll(
    view: View,
    dxConsumed: Int,
    dyConsumed: Int,
    dxUnconsumed: Int,
    dyUnconsumed: Int,
    offsetInWindow: IntArray?
): Boolean

Dispatch one step of a nested scroll in progress.

This version of the method just calls dispatchNestedScroll using the touch input type.

java-static fun dispatchNestedScroll(
    view: View,
    dxConsumed: Int,
    dyConsumed: Int,
    dxUnconsumed: Int,
    dyUnconsumed: Int,
    offsetInWindow: IntArray?,
    type: Int
): Boolean

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.

java-static fun dispatchNestedScroll(
    view: View,
    dxConsumed: Int,
    dyConsumed: Int,
    dxUnconsumed: Int,
    dyUnconsumed: Int,
    offsetInWindow: IntArray?,
    type: Int,
    consumed: IntArray
): Unit

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.

A non-null consumed int array of length 2 may be passed in to enable nested scrolling parents to report how much of the scroll distance was consumed. The original caller (where the input event was received to start the scroll) should initialize the values to be 0, in order to tell how much was actually consumed up the hierarchy of scrolling parents.

java-static fun dispatchStartTemporaryDetach(view: View): Unit

Notify a view that it is being temporarily detached.

java-static fun enableAccessibleClickableSpanSupport(view: View): Unit

Allow accessibility services to find and activate clickable spans in the application.

android.text.style.ClickableSpan is automatically supported from API 26. For compatibility back to API 19, this should be enabled.

android.text.style.URLSpan, a subclass of ClickableSpans, is automatically supported and does not need this enabled.

Do not put ClickableSpans in setContentDescription or setStateDescription. These links are only visible to accessibility services in getText, which should be modifiable using helper methods on UI elements. For example, use setText to modify the text of TextViews.

java-static fun generateViewId(): Int

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

java-static fun getAccessibilityDelegate(view: View): AccessibilityDelegateCompat?

Get the current accessibility delegate.

@ReplaceWith(expression = "view.getAccessibilityLiveRegion()")
java-static fun getAccessibilityLiveRegion(view: View): Int

Gets the live region mode for the specified View.

java-static fun getAccessibilityNodeProvider(view: View): AccessibilityNodeProviderCompat?

Gets the provider for managing a virtual view hierarchy rooted at this View and reported to android.accessibilityservice.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 its getAccessibilityNodeProvider is responsible for handling this call.

@UiThread
java-static fun getAccessibilityPaneTitle(view: View): CharSequence?

Get the title of the pane for purposes of accessibility.

@ReplaceWith(expression = "view.getAlpha()")
java-static fun getAlpha(view: View!): Float

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.

java-static fun getAutofillId(v: View): AutofillIdCompat?

Gets the unique, logical identifier of this view in the activity, for autofill purposes.

The autofill id is created on demand, unless it is explicitly set by setAutofillId.

See setAutofillId for more info. Compatibility behavior:

• SDK 26 and above, this method matches platform behavior.
• SDK 25 and below, this method always return null.

java-static fun getBackgroundTintList(view: View): ColorStateList?

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.

java-static fun getBackgroundTintMode(view: View): PorterDuff.Mode?

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.

@ReplaceWith(expression = "view.getClipBounds()")
java-static fun getClipBounds(view: View): Rect?

Returns a copy of the current setClipBounds.

Prior to API 18 this will return null.

java-static fun getContentCaptureSession(v: View): ContentCaptureSessionCompat?

Gets the session used to notify content capture events. Compatibility behavior:

• SDK 29 and above, this method matches platform behavior.
• SDK 28 and below, this method always return null.

@ReplaceWith(expression = "view.getDisplay()")
java-static fun getDisplay(view: View): Display?

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.

java-static fun getElevation(view: View): Float

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

@ReplaceWith(expression = "view.getFitsSystemWindows()")
java-static fun getFitsSystemWindows(view: View): Boolean

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

@ReplaceWith(expression = "view.getImportantForAccessibility()")
java-static fun getImportantForAccessibility(view: View): Int

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.

java-static fun getImportantForAutofill(v: View): Int

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

See setImportantForAutofill and isImportantForAutofill 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.

java-static fun getImportantForContentCapture(v: View): Int

Gets the mode for determining whether this view is important for content capture.

See setImportantForContentCapture and isImportantForContentCapture for more info about this mode. Compatibility behavior:

• SDK 30 and above, this method matches platform behavior.
• SDK 29 and below, this method always return IMPORTANT_FOR_CONTENT_CAPTURE_AUTO.

ref android.R.styleable#View_importantForContentCapture

@ReplaceWith(expression = "view.getLabelFor()")
java-static fun getLabelFor(view: View): Int

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

@ReplaceWith(expression = "view.getLayerType()")
java-static fun getLayerType(view: View!): Int

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 for more information on the different types of layers.

@ReplaceWith(expression = "view.getLayoutDirection()")
java-static fun getLayoutDirection(view: View): Int

Returns the resolved layout direction for this view.

@ReplaceWith(expression = "view.getMatrix()")
java-static fun getMatrix(view: View!): Matrix?

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

@ReplaceWith(expression = "view.getMeasuredHeightAndState()")
java-static fun getMeasuredHeightAndState(view: View!): Int

Return the full height measurement information for this view as computed by the most recent call to measure. 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.

@ReplaceWith(expression = "view.getMeasuredState()")
java-static fun getMeasuredState(view: View!): Int

Return only the state bits of getMeasuredWidthAndState and getMeasuredHeightAndState, 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.

@ReplaceWith(expression = "view.getMeasuredWidthAndState()")
java-static fun getMeasuredWidthAndState(view: View!): Int

Return the full width measurement information for this view as computed by the most recent call to measure. 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.

@ReplaceWith(expression = "view.getMinimumHeight()")
java-static fun getMinimumHeight(view: View): Int

Returns the minimum height of the view.

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

@ReplaceWith(expression = "view.getMinimumWidth()")
java-static fun getMinimumWidth(view: View): Int

Returns the minimum width of the view.

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

java-static fun getNextClusterForwardId(view: View): Int

Gets the ID of the next keyboard navigation cluster root.

java-static fun getOnReceiveContentMimeTypes(view: View): Array<String!>?

Returns the MIME types accepted by the listener configured on the given view via setOnReceiveContentListener. By default returns null.

Different features (e.g. pasting from the clipboard, inserting stickers from the soft keyboard, etc) may optionally use this metadata to conditionally alter their behavior. For example, a soft keyboard may choose to hide its UI for inserting GIFs for a particular input field if the MIME types returned here for that field don't include "image/gif" or "image/*".

Note: Comparisons of MIME types should be performed using utilities such as compareMimeTypes rather than simple string equality, in order to correctly handle patterns such as "text/*", "image/*", etc. Note that MIME type matching in the Android framework is case-sensitive, unlike formal RFC MIME types. As a result, you should always write your MIME types with lowercase letters, or use normalizeMimeType to ensure that it is converted to lowercase.

@ReplaceWith(expression = "view.getOverScrollMode()")
java-static fun getOverScrollMode(view: View!): Int

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.

@ReplaceWith(expression = "view.getPaddingEnd()")
java-static fun getPaddingEnd(view: View): @Px Int

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.

@ReplaceWith(expression = "view.getPaddingStart()")
java-static fun getPaddingStart(view: View): @Px Int

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.

@ReplaceWith(expression = "view.getParentForAccessibility()")
java-static fun getParentForAccessibility(view: View): ViewParent?

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.

@ReplaceWith(expression = "view.getPivotX()")
java-static fun getPivotX(view: View!): Float

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

@ReplaceWith(expression = "view.getPivotY()")
java-static fun getPivotY(view: View!): Float

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

java-static fun getRootWindowInsets(view: View): WindowInsetsCompat?

Provide original WindowInsetsCompat that are dispatched to the view hierarchy. The insets are only available if the view is attached.

On devices running API 20 and below, this method always returns null.

java-static fun getScrollIndicators(view: View): Int

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.

@UiThread
java-static fun getStateDescription(view: View): CharSequence?

Returns the View's state description.

Note: Do not override this method, as it will have no effect on the state description presented to accessibility services. You must call setStateDescription to modify the state description.