ViewCompat

Added in 1.1.0

class ViewCompat

Helper for accessing features in View.

Summary

Nested types

Interface definition for a callback to be invoked when a hardware key event hasn't been handled by the view hierarchy.

Constants
const Int

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

Live region mode specifying that accessibility services should not automatically announce changes to this view.
const Int

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

This property is deprecated.

Use IMPORTANT_FOR_ACCESSIBILITY_AUTO directly.
const Int

This property is deprecated.

Use IMPORTANT_FOR_ACCESSIBILITY_NO directly.
const Int

This property is deprecated.

Use IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS directly.
const Int

This property is deprecated.

Use IMPORTANT_FOR_ACCESSIBILITY_YES directly.
const Int

Automatically determine whether a view is important for content capture.
const Int

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

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

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

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

This property is deprecated.

Use LAYER_TYPE_HARDWARE directly.
const Int

This property is deprecated.

Use LAYER_TYPE_NONE directly.
const Int

This property is deprecated.

Use LAYER_TYPE_SOFTWARE directly.
const Int

This property is deprecated.

Use LAYOUT_DIRECTION_INHERIT directly.
const Int

This property is deprecated.

Use LAYOUT_DIRECTION_LOCALE directly.
const Int

This property is deprecated.

Use LAYOUT_DIRECTION_LTR directly.
const Int

This property is deprecated.

Use LAYOUT_DIRECTION_RTL directly.
const Int

This property is deprecated.

Use MEASURED_HEIGHT_STATE_SHIFT directly.
const Int

This property is deprecated.

Use MEASURED_SIZE_MASK directly.
const Int

This property is deprecated.

Use MEASURED_STATE_MASK directly.
const Int

This property is deprecated.

Use MEASURED_STATE_TOO_SMALL directly.
const Int

This property is deprecated.

Use OVER_SCROLL_ALWAYS directly.
const Int

This property is deprecated.

Use OVER_SCROLL_IF_CONTENT_SCROLLS directly.
const Int

This property is deprecated.

Use OVER_SCROLL_NEVER directly.
const Int

Indicates scrolling along the horizontal axis.
const Int

Indicates no axis of view scrolling.
const Int

Indicates scrolling along the vertical axis.
const Int

Scroll indicator direction for the bottom edge of the view.
const Int

Scroll indicator direction for the ending edge of the view.
const Int

Scroll indicator direction for the left edge of the view.
const Int

Scroll indicator direction for the right edge of the view.
const Int

Scroll indicator direction for the starting edge of the view.
const Int

Scroll indicator direction for the top edge of the view.
const Int

Indicates that the input type for the gesture is caused by something which is not a user touching a screen.
const Int

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

Protected constructors

This function is deprecated.

This is a utility class and it shouldn't be instantiated.

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

Adds an accessibility action that can be performed on a node associated with a view.
java-static Unit
addKeyboardNavigationClusters(
    view: View,
    views: (Mutable)Collection<View!>,
    direction: Int
)

Adds any keyboard navigation cluster roots that are descendants of view ( including view if it is a cluster root itself) to views.
java-static Unit

Adds a listener which will receive unhandled KeyEvents.
java-static Unit
addOverlayView(overlayHost: ViewGroup, overlay: View)

Convenience method to add overlay to overlayHost's overlay and assign the disjointParent in the overlay hierarchy.
java-static ViewPropertyAnimatorCompat
animate(view: View)

This function is deprecated.

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

This function is deprecated.

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

This function is deprecated.

Use canScrollVertically directly.
java-static Unit

Cancel the drag and drop operation.
java-static Int
combineMeasuredStates(curState: Int, newState: Int)

This function is deprecated.

Use combineMeasuredStates directly.
java-static WindowInsetsCompat
computeSystemWindowInsets(
    view: View,
    insets: WindowInsetsCompat,
    outLocalInsets: Rect
)

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

Request to apply the given window insets to this view or another view in its subtree.
java-static Unit

Notify a view that its temporary detach has ended; the view is now reattached.
java-static Boolean
dispatchNestedFling(
    view: View,
    velocityX: Float,
    velocityY: Float,
    consumed: Boolean
)

Dispatch a fling to a nested scrolling parent.
java-static Boolean
dispatchNestedPreFling(view: View, velocityX: Float, velocityY: Float)

Dispatch a fling to a nested scrolling parent before it is processed by this view.
java-static Boolean
dispatchNestedPreScroll(
    view: View,
    dx: Int,
    dy: Int,
    consumed: IntArray?,
    offsetInWindow: IntArray?
)

Dispatch one step of a nested scroll in progress before this view consumes any portion of it.
java-static Boolean
dispatchNestedPreScroll(
    view: View,
    dx: Int,
    dy: Int,
    consumed: IntArray?,
    offsetInWindow: IntArray?,
    type: Int
)

Dispatch one step of a nested scroll in progress before this view consumes any portion of it.
java-static Boolean
dispatchNestedScroll(
    view: View,
    dxConsumed: Int,
    dyConsumed: Int,
    dxUnconsumed: Int,
    dyUnconsumed: Int,
    offsetInWindow: IntArray?
)

Dispatch one step of a nested scroll in progress.
java-static Boolean
dispatchNestedScroll(
    view: View,
    dxConsumed: Int,
    dyConsumed: Int,
    dxUnconsumed: Int,
    dyUnconsumed: Int,
    offsetInWindow: IntArray?,
    type: Int
)

Dispatch one step of a nested scroll in progress.
java-static Unit
dispatchNestedScroll(
    view: View,
    dxConsumed: Int,
    dyConsumed: Int,
    dxUnconsumed: Int,
    dyUnconsumed: Int,
    offsetInWindow: IntArray?,
    type: Int,
    consumed: IntArray
)

Dispatch one step of a nested scroll in progress.
java-static Unit

Notify a view that it is being temporarily detached.
java-static Unit

Allow accessibility services to find and activate clickable spans in the application.
java-static Int

This function is deprecated.

Call generateViewId directly.
java-static AccessibilityDelegateCompat?

Get the current accessibility delegate.
java-static Int
@ReplaceWith(expression = "view.getAccessibilityLiveRegion()")
getAccessibilityLiveRegion(view: View)

This function is deprecated.

Call getAccessibilityLiveRegion directly.
java-static 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.
java-static CharSequence?

Get the title of the pane for purposes of accessibility.
java-static Float
@ReplaceWith(expression = "view.getAlpha()")
getAlpha(view: View!)

This function is deprecated.

Use getAlpha directly.
java-static AutofillIdCompat?

Gets the unique, logical identifier of this view in the activity, for autofill purposes.
java-static ColorStateList?

Return the tint applied to the background drawable, if specified.
java-static PorterDuff.Mode?

Return the blending mode used to apply the tint to the background drawable, if specified.
java-static Rect?
@ReplaceWith(expression = "view.getClipBounds()")
getClipBounds(view: View)

This function is deprecated.

Call getClipBounds directly.
java-static ContentCaptureSessionCompat?

Gets the session used to notify content capture events.
java-static Display?
@ReplaceWith(expression = "view.getDisplay()")
getDisplay(view: View)

This function is deprecated.

Call getDisplay directly.
java-static Float

The base elevation of this view relative to its parent, in pixels.
java-static Boolean
@ReplaceWith(expression = "view.getFitsSystemWindows()")
getFitsSystemWindows(view: View)

This function is deprecated.

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

This function is deprecated.

Call getImportantForAccessibility directly.
java-static Int

Gets the mode for determining whether this view is important for autofill.
java-static Int

Gets the mode for determining whether this view is important for content capture.
java-static Int
@ReplaceWith(expression = "view.getLabelFor()")
getLabelFor(view: View)

This function is deprecated.

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

This function is deprecated.

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

This function is deprecated.

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

This function is deprecated.

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

This function is deprecated.

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

This function is deprecated.

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

This function is deprecated.

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

This function is deprecated.

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

This function is deprecated.

Call getMinimumWidth directly.
java-static Int

Gets the ID of the next keyboard navigation cluster root.
java-static Array<String!>?

Returns the MIME types accepted by the listener configured on the given view via setOnReceiveContentListener.
java-static Int
@ReplaceWith(expression = "view.getOverScrollMode()")
getOverScrollMode(view: View!)

This function is deprecated.

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

This function is deprecated.

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

This function is deprecated.

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

This function is deprecated.

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

This function is deprecated.

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

This function is deprecated.

Use getPivotY directly.
java-static WindowInsetsCompat?

Provide original WindowInsetsCompat that are dispatched to the view hierarchy.
java-static Float
@ReplaceWith(expression = "view.getRotation()")
getRotation(view: View!)

This function is deprecated.

Use getRotation directly.
java-static Float
@ReplaceWith(expression = "view.getRotationX()")
getRotationX(view: View!)

This function is deprecated.

Use getRotationX directly.
java-static Float
@ReplaceWith(expression = "view.getRotationY()")
getRotationY(view: View!)

This function is deprecated.

Use getRotationY directly.
java-static Float
@ReplaceWith(expression = "view.getScaleX()")
getScaleX(view: View!)

This function is deprecated.

Use getScaleX directly.
java-static Float
@ReplaceWith(expression = "view.getScaleY()")
getScaleY(view: View!)

This function is deprecated.

Use getScaleY directly.
java-static Int

Returns a bitmask representing the enabled scroll indicators.
java-static CharSequence?

Returns the View's state description.
java-static (Mutable)List<Rect!>

Retrieve the list of areas within this view's post-layout coordinate space where the system should not intercept touch or other pointing device gestures.
java-static String?

Returns the name of the View to be used to identify Views in Transitions.
java-static Float
@ReplaceWith(expression = "view.getTranslationX()")
getTranslationX(view: View!)

This function is deprecated.

Use getTranslationX directly.
java-static Float
@ReplaceWith(expression = "view.getTranslationY()")
getTranslationY(view: View!)

This function is deprecated.

Use getTranslationY directly.
java-static Float

The depth location of this view relative to its elevation.
java-static WindowInsetsControllerCompat?

This function is deprecated.

Prefer getInsetsController to explicitly specify the window (such as when the view is in a dialog).
java-static Int
@ReplaceWith(expression = "view.getWindowSystemUiVisibility()")
getWindowSystemUiVisibility(view: View)

This function is deprecated.

SystemUiVisibility flags are deprecated.
java-static Float
@ReplaceWith(expression = "view.getX()")
getX(view: View!)

This function is deprecated.

Use getX directly.
java-static Float
@ReplaceWith(expression = "view.getY()")
getY(view: View!)

This function is deprecated.

Use getY directly.
java-static Float
getZ(view: View)

The visual z position of this view, in pixels.
java-static Boolean

Checks whether provided View has an accessibility delegate attached to it.
java-static Boolean

Returns true if this view is focusable or if it contains a reachable View for which hasExplicitFocusable returns true.
java-static Boolean

Returns true if this view has a nested scrolling parent.
java-static Boolean

Returns true if this view has a nested scrolling parent.
java-static Boolean
@ReplaceWith(expression = "view.hasOnClickListeners()")
hasOnClickListeners(view: View)

This function is deprecated.

Call hasOnClickListeners directly.
java-static Boolean
@ReplaceWith(expression = "view.hasOverlappingRendering()")
hasOverlappingRendering(view: View)

This function is deprecated.

Call hasOverlappingRendering directly.
java-static Boolean
@ReplaceWith(expression = "view.hasTransientState()")
hasTransientState(view: View)

This function is deprecated.

Call hasTransientState directly.
java-static Boolean

Gets whether this view is a heading for accessibility purposes.
java-static Boolean
@ReplaceWith(expression = "view.isAttachedToWindow()")
isAttachedToWindow(view: View)

This function is deprecated.

Call isAttachedToWindow directly.
java-static Boolean

Returns whether view should receive focus when the focus is restored for the view hierarchy containing it.
java-static Boolean

Computes whether this view should be exposed for accessibility.
java-static Boolean

Hints the Android System whether the android.app.assist.AssistStructure.ViewNode associated with this view is considered important for autofill purposes.
java-static Boolean

Hints the Android System whether this view is considered important for content capture, based on the value explicitly set by setImportantForContentCapture and heuristics when it's IMPORTANT_FOR_CONTENT_CAPTURE_AUTO.
java-static Boolean
@ReplaceWith(expression = "view.isInLayout()")
isInLayout(view: View)

This function is deprecated.

Call isInLayout directly.
java-static Boolean

Returns whether view is a root of a keyboard navigation cluster.
java-static Boolean
@ReplaceWith(expression = "view.isLaidOut()")
isLaidOut(view: View)

This function is deprecated.

Call isLaidOut directly.
java-static Boolean
@ReplaceWith(expression = "view.isLayoutDirectionResolved()")
isLayoutDirectionResolved(view: View)

This function is deprecated.

Call isLayoutDirectionResolved directly.
java-static Boolean

Returns true if nested scrolling is enabled for this view.
java-static Boolean
@ReplaceWith(expression = "view.isOpaque()")
isOpaque(view: View!)

This function is deprecated.

Use isOpaque directly.
java-static Boolean
@ReplaceWith(expression = "view.isPaddingRelative()")
isPaddingRelative(view: View)

This function is deprecated.

Call isPaddingRelative directly.
java-static Boolean

Returns whether the view should be treated as a focusable unit by screen reader accessibility tools.
java-static Unit
@ReplaceWith(expression = "view.jumpDrawablesToCurrentState()")
jumpDrawablesToCurrentState(view: View!)

This function is deprecated.

Use jumpDrawablesToCurrentState directly.
java-static View?
keyboardNavigationClusterSearch(
    view: View,
    currentCluster: View?,
    direction: Int
)

Find the nearest keyboard navigation cluster in the specified direction.
java-static Unit
offsetLeftAndRight(view: View, offset: Int)

Offset this view's horizontal location by the specified amount of pixels.
java-static Unit
offsetTopAndBottom(view: View, offset: Int)

Offset this view's vertical location by the specified number of pixels.
java-static WindowInsetsCompat

Called when the view should apply WindowInsetsCompat according to its internal policy.
java-static Unit
@ReplaceWith(expression = "v.onInitializeAccessibilityEvent(event)")
onInitializeAccessibilityEvent(v: View!, event: AccessibilityEvent!)

This function is deprecated.

Call onInitializeAccessibilityEvent directly.
java-static Unit
@ReplaceWith(expression = "v.onInitializeAccessibilityNodeInfo(info.unwrap())")
onInitializeAccessibilityNodeInfo(
    v: View,
    info: AccessibilityNodeInfoCompat
)

This function is deprecated.

Call onInitializeAccessibilityNodeInfo directly.
java-static Unit
@ReplaceWith(expression = "v.onPopulateAccessibilityEvent(event)")
onPopulateAccessibilityEvent(v: View!, event: AccessibilityEvent!)

This function is deprecated.

Call onPopulateAccessibilityEvent directly.
java-static Boolean
@ReplaceWith(expression = "view.performAccessibilityAction(action, arguments)")
performAccessibilityAction(view: View, action: Int, arguments: Bundle?)

This function is deprecated.

Call performAccessibilityAction directly.
java-static Boolean
performHapticFeedback(view: View, feedbackConstant: Int)

Perform a haptic feedback to the user for the view.
java-static Boolean
performHapticFeedback(view: View, feedbackConstant: Int, flags: Int)

Perform a haptic feedback to the user for the view.
java-static ContentInfoCompat?

Receives the given content.
java-static Unit
@ReplaceWith(expression = "view.postInvalidateOnAnimation()")
postInvalidateOnAnimation(view: View)

This function is deprecated.

Call postInvalidateOnAnimation directly.
java-static Unit
@ReplaceWith(expression = "view.postInvalidateOnAnimation(left, top, right, bottom)")
postInvalidateOnAnimation(
    view: View,
    left: Int,
    top: Int,
    right: Int,
    bottom: Int
)

This function is deprecated.

Call postInvalidateOnAnimation directly.
java-static Unit
@ReplaceWith(expression = "view.postOnAnimation(action)")
postOnAnimation(view: View, action: Runnable)

This function is deprecated.

Call postOnAnimation directly.
java-static Unit
@ReplaceWith(expression = "view.postOnAnimationDelayed(action, delayMillis)")
postOnAnimationDelayed(view: View, action: Runnable, delayMillis: Long)

This function is deprecated.

Call postOnAnimationDelayed directly.
java-static Unit
removeAccessibilityAction(view: View, actionId: Int)

Removes an accessibility action that can be performed on a node associated with a view.
java-static Unit

Removes a listener which will receive unhandled KeyEvents.
java-static Unit
replaceAccessibilityAction(
    view: View,
    replacedAction: AccessibilityNodeInfoCompat.AccessibilityActionCompat,
    label: CharSequence?,
    command: AccessibilityViewCommand?
)

Replaces an action.
java-static Unit

Ask that a new dispatch of View.onApplyWindowInsets(WindowInsets) be performed.
java-static T
<T : View?> requireViewById(view: View, id: @IdRes Int)

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.
java-static Int
resolveSizeAndState(size: Int, measureSpec: Int, childMeasuredState: Int)

This function is deprecated.

Use resolveSizeAndState directly.
java-static Boolean

Gives focus to the default-focus view in the view hierarchy rooted at view.
java-static Unit
saveAttributeDataForStyleable(
    view: View,
    context: Context,
    styleable: IntArray,
    attrs: AttributeSet?,
    t: TypedArray,
    defStyleAttr: Int,
    defStyleRes: Int
)

Stores debugging information about attributes.
java-static Unit

Sets a delegate for implementing accessibility support via composition (as opposed to inheritance).
java-static Unit

Set if view is a heading for a section of content for accessibility purposes.
java-static Unit
@ReplaceWith(expression = "view.setAccessibilityLiveRegion(mode)")
setAccessibilityLiveRegion(view: View, mode: Int)

This function is deprecated.

Call setAccessibilityLiveRegion directly.
java-static Unit
@UiThread
setAccessibilityPaneTitle(
    view: View,
    accessibilityPaneTitle: CharSequence?
)

Visually distinct portion of a window with window-like semantics are considered panes for accessibility purposes.
java-static Unit
@ReplaceWith(expression = "view.setActivated(activated)")
setActivated(view: View!, activated: Boolean)

This function is deprecated.

Use setActivated directly.
java-static Unit
@ReplaceWith(expression = "view.setAlpha(value)")
setAlpha(view: View!, value: @FloatRange(from = 0.0, to = 1.0) Float)

This function is deprecated.

Use setAlpha directly.
java-static Unit
setAutofillHints(view: View, autofillHints: Array<String!>?)

Sets the hints that help an android.service.autofill.AutofillService determine how to autofill the view with the user's data.
java-static Unit

Sets the unique, logical identifier of this view in the activity, for autofill purposes.
java-static Unit
@ReplaceWith(expression = "view.setBackground(background)")
setBackground(view: View, background: Drawable?)

This function is deprecated.

Call setBackground directly.
java-static Unit

Applies a tint to the background drawable.
java-static Unit

Specifies the blending mode used to apply the tint specified by setBackgroundTintList to the background drawable.
java-static Unit

This function is deprecated.

Use setChildrenDrawingOrderEnabled directly.
java-static Unit
@ReplaceWith(expression = "view.setClipBounds(clipBounds)")
setClipBounds(view: View, clipBounds: Rect?)

This function is deprecated.

Call setClipBounds directly.
java-static Unit
setContentCaptureSession(
    v: View,
    contentCaptureSession: ContentCaptureSessionCompat?
)

Sets the (optional) ContentCaptureSession associated with this view.
java-static Unit
setElevation(view: View, elevation: Float)
java-static Unit
@ReplaceWith(expression = "view.setFitsSystemWindows(fitSystemWindows)")
setFitsSystemWindows(view: View!, fitSystemWindows: Boolean)

This function is deprecated.

Use setFitsSystemWindows directly.
java-static Unit
setFocusedByDefault(view: View, isFocusedByDefault: Boolean)

Sets whether view should receive focus when the focus is restored for the view hierarchy containing it.
java-static Unit
@ReplaceWith(expression = "view.setHasTransientState(hasTransientState)")
setHasTransientState(view: View, hasTransientState: Boolean)

This function is deprecated.

Call setHasTransientState directly.
java-static Unit
@ReplaceWith(expression = "view.setImportantForAccessibility(mode)")
@UiThread
setImportantForAccessibility(view: View, mode: Int)

This function is deprecated.

Call setImportantForAccessibility directly.
java-static Unit

Sets the mode for determining whether this view is considered important for autofill.
java-static Unit

Sets the mode for determining whether this view is considered important for content capture.
java-static Unit

Set whether view is a root of a keyboard navigation cluster.
java-static Unit
@ReplaceWith(expression = "view.setLabelFor(labeledId)")
setLabelFor(view: View, labeledId: @IdRes Int)

This function is deprecated.

Call setLabelFor directly.
java-static Unit
@ReplaceWith(expression = "view.setLayerPaint(paint)")
setLayerPaint(view: View, paint: Paint?)

This function is deprecated.

Call setLayerPaint directly.
java-static Unit
@ReplaceWith(expression = "view.setLayerType(layerType, paint)")
setLayerType(view: View!, layerType: Int, paint: Paint!)

This function is deprecated.

Use setLayerType directly.
java-static Unit
@ReplaceWith(expression = "view.setLayoutDirection(layoutDirection)")
setLayoutDirection(view: View, layoutDirection: Int)

This function is deprecated.

Call setLayoutDirection directly.
java-static Unit

Enable or disable nested scrolling for this view.
java-static Unit
setNextClusterForwardId(view: View, nextClusterForwardId: Int)

Sets the ID of the next keyboard navigation cluster root view.
java-static Unit

Set an OnApplyWindowInsetsListener to take over the policy for applying window insets to this view.
java-static Unit
setOnReceiveContentListener(
    view: View,
    mimeTypes: Array<String!>?,
    listener: OnReceiveContentListener?
)

Sets the listener to be used to handle insertion of content into the given view.
java-static Unit
@ReplaceWith(expression = "view.setOverScrollMode(overScrollMode)")
setOverScrollMode(view: View!, overScrollMode: Int)

This function is deprecated.

Call setOverScrollMode directly.
java-static Unit
@ReplaceWith(expression = "view.setPaddingRelative(start, top, end, bottom)")
setPaddingRelative(
    view: View,
    start: @Px Int,
    top: @Px Int,
    end: @Px Int,
    bottom: @Px Int
)

This function is deprecated.

Call setPaddingRelative directly.
java-static Unit
@ReplaceWith(expression = "view.setPivotX(value)")
setPivotX(view: View!, value: Float)

This function is deprecated.

Use setPivotX directly.
java-static Unit
@ReplaceWith(expression = "view.setPivotY(value)")
setPivotY(view: View!, value: Float)

This function is deprecated.

Use setPivotX directly.
java-static Unit
setPointerIcon(view: View, pointerIcon: PointerIconCompat?)

Set the pointer icon for the current view.
java-static Unit
@ReplaceWith(expression = "view.setRotation(value)")
setRotation(view: View!, value: Float)

This function is deprecated.

Use setRotation directly.
java-static Unit
@ReplaceWith(expression = "view.setRotationX(value)")
setRotationX(view: View!, value: Float)

This function is deprecated.

Use setRotationX directly.
java-static Unit
@ReplaceWith(expression = "view.setRotationY(value)")
setRotationY(view: View!, value: Float)

This function is deprecated.

Use setRotationY directly.
java-static Unit
@ReplaceWith(expression = "view.setSaveFromParentEnabled(enabled)")
setSaveFromParentEnabled(view: View!, enabled: Boolean)

This function is deprecated.

Use setSaveFromParentEnabled directly.
java-static Unit
@ReplaceWith(expression = "view.setScaleX(value)")
setScaleX(view: View!, value: Float)

This function is deprecated.

Use setScaleX directly.
java-static Unit
@ReplaceWith(expression = "view.setScaleY(value)")
setScaleY(view: View!, value: Float)

This function is deprecated.

Use setScaleY directly.
java-static Unit
@UiThread
setScreenReaderFocusable(view: View, screenReaderFocusable: Boolean)

Sets whether this View should be a focusable element for screen readers and include non-focusable Views from its subtree when providing feedback.
java-static Unit
setScrollIndicators(view: View, indicators: Int)

Sets the state of all scroll indicators.
java-static Unit
setScrollIndicators(view: View, indicators: Int, mask: Int)

Sets the state of the scroll indicators specified by the mask.
java-static Unit
@UiThread
setStateDescription(view: View, stateDescription: CharSequence?)

Sets the state description of this node.
java-static Unit

Sets a list of areas within this view's post-layout coordinate space where the system should not intercept touch or other pointing device gestures.
java-static Unit
setTooltipText(view: View, tooltipText: CharSequence?)

Sets the tooltip for the view.
java-static Unit
setTransitionName(view: View, transitionName: String?)

Sets the name of the View to be used to identify Views in Transitions.
java-static Unit
@ReplaceWith(expression = "view.setTranslationX(value)")
setTranslationX(view: View!, value: Float)

This function is deprecated.

Use setTranslationX directly.
java-static Unit
@ReplaceWith(expression = "view.setTranslationY(value)")
setTranslationY(view: View!, value: Float)

This function is deprecated.

Use setTranslationY directly.
java-static Unit
setTranslationZ(view: View, translationZ: Float)

Sets the depth location of this view relative to its elevation.
java-static Unit

Sets a WindowInsetsAnimationCompat.Callback to be notified about animations of windows that cause insets.
java-static Unit
@ReplaceWith(expression = "view.setX(value)")
setX(view: View!, value: Float)

This function is deprecated.

Use setX directly.
java-static Unit
@ReplaceWith(expression = "view.setY(value)")
setY(view: View!, value: Float)

This function is deprecated.

Use setY directly.
java-static Unit
setZ(view: View, z: Float)

Sets the visual z position of this view, in pixels.
java-static Boolean
startDragAndDrop(
    v: View,
    data: ClipData?,
    shadowBuilder: View.DragShadowBuilder,
    myLocalState: Any?,
    flags: Int
)

Start the drag and drop operation.
java-static Boolean
startNestedScroll(view: View, axes: Int)

Begin a nestable scroll operation along the given axes.
java-static Boolean
startNestedScroll(view: View, axes: Int, type: Int)

Begin a nestable scroll operation along the given axes.
java-static Unit

Stop a nested scroll in progress.
java-static Unit
stopNestedScroll(view: View, type: Int)

Stop a nested scroll in progress.
java-static Unit

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

Constants

ACCESSIBILITY_LIVE_REGION_ASSERTIVE

Added in 1.1.0
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.

ACCESSIBILITY_LIVE_REGION_NONE

Added in 1.1.0
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.

ACCESSIBILITY_LIVE_REGION_POLITE

Added in 1.1.0
const val ACCESSIBILITY_LIVE_REGION_POLITE = 1: Int

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

Use with setAccessibilityLiveRegion.

IMPORTANT_FOR_ACCESSIBILITY_AUTO

Added in 1.1.0
Deprecated in 1.13.0
const val IMPORTANT_FOR_ACCESSIBILITY_AUTO = 0: Int

Automatically determine whether a view is important for accessibility.

IMPORTANT_FOR_ACCESSIBILITY_NO

Added in 1.1.0
Deprecated in 1.13.0
const val IMPORTANT_FOR_ACCESSIBILITY_NO = 2: Int

The view is not important for accessibility.

IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS

Added in 1.1.0
Deprecated in 1.13.0
const val IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS = 4: Int

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

IMPORTANT_FOR_ACCESSIBILITY_YES

Added in 1.1.0
Deprecated in 1.13.0
const val IMPORTANT_FOR_ACCESSIBILITY_YES = 1: Int

The view is important for accessibility.

IMPORTANT_FOR_CONTENT_CAPTURE_AUTO

Added in 1.11.0
const val IMPORTANT_FOR_CONTENT_CAPTURE_AUTO = 0: Int

Automatically determine whether a view is important for content capture.

IMPORTANT_FOR_CONTENT_CAPTURE_NO

Added in 1.11.0
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.

IMPORTANT_FOR_CONTENT_CAPTURE_NO_EXCLUDE_DESCENDANTS

Added in 1.11.0
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.

IMPORTANT_FOR_CONTENT_CAPTURE_YES

Added in 1.11.0
const val IMPORTANT_FOR_CONTENT_CAPTURE_YES = 1: Int

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

IMPORTANT_FOR_CONTENT_CAPTURE_YES_EXCLUDE_DESCENDANTS

Added in 1.11.0
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.

LAYER_TYPE_HARDWARE

Added in 1.1.0
Deprecated in 1.1.0
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.

LAYER_TYPE_NONE

Added in 1.1.0
Deprecated in 1.1.0
const val LAYER_TYPE_NONE = 0: Int

Indicates that the view does not have a layer.

LAYER_TYPE_SOFTWARE

Added in 1.1.0
Deprecated in 1.1.0
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.)

LAYOUT_DIRECTION_INHERIT

Added in 1.1.0
Deprecated in 1.13.0
const val LAYOUT_DIRECTION_INHERIT = 2: Int

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

LAYOUT_DIRECTION_LOCALE

Added in 1.1.0
Deprecated in 1.13.0
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.

LAYOUT_DIRECTION_LTR

Added in 1.1.0
Deprecated in 1.13.0
const val LAYOUT_DIRECTION_LTR = 0: Int

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

LAYOUT_DIRECTION_RTL

Added in 1.1.0
Deprecated in 1.13.0
const val LAYOUT_DIRECTION_RTL = 1: Int

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

MEASURED_HEIGHT_STATE_SHIFT

Added in 1.1.0
Deprecated in 1.1.0
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.

MEASURED_SIZE_MASK

Added in 1.1.0
Deprecated in 1.1.0
const val MEASURED_SIZE_MASK = 16777215: Int

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

MEASURED_STATE_MASK

Added in 1.1.0
Deprecated in 1.1.0
const val MEASURED_STATE_MASK = -16777216: Int

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

MEASURED_STATE_TOO_SMALL

Added in 1.1.0
Deprecated in 1.1.0
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.

OVER_SCROLL_ALWAYS

Added in 1.1.0
Deprecated in 1.1.0
const val OVER_SCROLL_ALWAYS = 0: Int

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

OVER_SCROLL_IF_CONTENT_SCROLLS

Added in 1.1.0
Deprecated in 1.1.0
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.

OVER_SCROLL_NEVER

Added in 1.1.0
Deprecated in 1.1.0
const val OVER_SCROLL_NEVER = 2: Int

Never allow a user to over-scroll this view.

SCROLL_AXIS_HORIZONTAL

Added in 1.1.0
const val SCROLL_AXIS_HORIZONTAL = 1: Int

Indicates scrolling along the horizontal axis.

SCROLL_AXIS_NONE

Added in 1.1.0
const val SCROLL_AXIS_NONE = 0: Int

Indicates no axis of view scrolling.

SCROLL_AXIS_VERTICAL

Added in 1.1.0
const val SCROLL_AXIS_VERTICAL = 2: Int

Indicates scrolling along the vertical axis.

SCROLL_INDICATOR_BOTTOM

Added in 1.1.0
const val SCROLL_INDICATOR_BOTTOM = 2: Int

Scroll indicator direction for the bottom edge of the view.

See also
setScrollIndicators
setScrollIndicators
getScrollIndicators

SCROLL_INDICATOR_END

Added in 1.1.0
const val SCROLL_INDICATOR_END = 32: Int

Scroll indicator direction for the ending edge of the view.

See also
setScrollIndicators
setScrollIndicators
getScrollIndicators

SCROLL_INDICATOR_LEFT

Added in 1.1.0
const val SCROLL_INDICATOR_LEFT = 4: Int

Scroll indicator direction for the left edge of the view.

See also
setScrollIndicators
setScrollIndicators
getScrollIndicators

SCROLL_INDICATOR_RIGHT

Added in 1.1.0
const val SCROLL_INDICATOR_RIGHT = 8: Int

Scroll indicator direction for the right edge of the view.

See also
setScrollIndicators
setScrollIndicators
getScrollIndicators

SCROLL_INDICATOR_START

Added in 1.1.0
const val SCROLL_INDICATOR_START = 16: Int

Scroll indicator direction for the starting edge of the view.

See also
setScrollIndicators
setScrollIndicators
getScrollIndicators

SCROLL_INDICATOR_TOP

Added in 1.1.0
const val SCROLL_INDICATOR_TOP = 1: Int

Scroll indicator direction for the top edge of the view.

See also
setScrollIndicators
setScrollIndicators
getScrollIndicators

TYPE_NON_TOUCH

Added in 1.1.0
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.

TYPE_TOUCH

Added in 1.1.0
const val TYPE_TOUCH = 0: Int

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

Protected constructors

ViewCompat

Added in 1.1.0
Deprecated in 1.5.0
protected ViewCompat()

Public functions

addAccessibilityAction

Added in 1.1.0
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.

Parameters
view: View

The view.
label: CharSequence

The user facing description of the action. If an action with the same label already exists, it will be replaced.
command: AccessibilityViewCommand

The command performed when the service requests the action.
Returns
Int

The id associated with the action, or NO_ID if the action could not be created. This id can be used to remove the action.

Compatibility:

  • API <21: No-op

addKeyboardNavigationClusters

Added in 1.1.0
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.

Parameters
view: View

view on which to make the change.
views: (Mutable)Collection<View!>

collection of keyboard navigation cluster roots found so far.
direction: Int

direction to look.

addOnUnhandledKeyEventListener

Added in 1.1.0
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.

Parameters
view: View

view on which to add the listener.
listener: ViewCompat.OnUnhandledKeyEventListenerCompat

a receiver of unhandled KeyEvents.
See also
removeOnUnhandledKeyEventListener

addOverlayView

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.

Parameters
overlayHost: ViewGroup

The view to add an overlay to
overlay: View

The view to overlay onto overlayHost
See also
add

animate

Added in 1.1.0
Deprecated in 1.13.0
java-static fun animate(view: View): ViewPropertyAnimatorCompat

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

Returns
ViewPropertyAnimatorCompat

ViewPropertyAnimator The ViewPropertyAnimator associated with this View.

canScrollHorizontally

Added in 1.1.0
Deprecated in 1.1.0
@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.

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 1.1.0
Deprecated in 1.1.0
@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.

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 1.1.0
java-static fun cancelDragAndDrop(v: View): Unit

Cancel the drag and drop operation.

combineMeasuredStates

Added in 1.1.0
Deprecated in 1.1.0
java-static fun combineMeasuredStates(curState: Int, newState: Int): Int

Merge two states as returned by getMeasuredState.

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.

computeSystemWindowInsets

Added in 1.3.0
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.

Parameters
view: View

view for which insets need to be computed.
insets: WindowInsetsCompat

Insets currently being processed by this View, likely received as a parameter to onApplyWindowInsets.
outLocalInsets: Rect

A Rect that will receive the insets that should be consumed by this view
Returns
WindowInsetsCompat

Insets that should be passed along to views under this one

dispatchApplyWindowInsets

Added in 1.1.0
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.

Parameters
view: View

view for which to dispatch the request.
insets: WindowInsetsCompat

Insets to apply
Returns
WindowInsetsCompat

The provided insets minus the insets that were consumed

dispatchFinishTemporaryDetach

Added in 1.1.0
java-static fun dispatchFinishTemporaryDetach(view: View): Unit

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

dispatchNestedFling

Added in 1.1.0
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.

Parameters
view: View

view for which to dispatch the fling.
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 1.1.0
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.

Parameters
view: View

view for which to dispatch the fling.
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 1.1.0
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.

Parameters
view: View

view for which to dispatch the scroll.
dx: Int

Horizontal scroll distance in pixels
dy: Int

Vertical scroll distance in pixels
consumed: IntArray?

Output. If not null, consumed[0] will contain the consumed component of dx and consumed[1] the consumed dy.
offsetInWindow: IntArray?

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

dispatchNestedPreScroll

Added in 1.1.0
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.

Parameters
view: View

view for which to dispatch the scroll.
dx: Int

Horizontal scroll distance in pixels
dy: Int

Vertical scroll distance in pixels
consumed: IntArray?

Output. If not null, consumed[0] will contain the consumed component of dx and consumed[1] the consumed dy.
offsetInWindow: IntArray?

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

dispatchNestedScroll

Added in 1.1.0
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.

Parameters
view: View

view for which to dispatch the scroll.
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: IntArray?

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.

dispatchNestedScroll

Added in 1.1.0
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.

Parameters
view: View

view for which to dispatch the scroll.
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: IntArray?

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, and therefore the scroll distance was consumed
See also
dispatchNestedPreScroll

dispatchNestedScroll

Added in 1.1.0
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.

Parameters
view: View

view for which to dispatch the scroll.
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: IntArray?

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
consumed: IntArray

Output, If not null, consumed[0] will contain the consumed component of dx and consumed[1] the consumed dy.

dispatchStartTemporaryDetach

Added in 1.1.0
java-static fun dispatchStartTemporaryDetach(view: View): Unit

Notify a view that it is being temporarily detached.

enableAccessibleClickableSpanSupport

Added in 1.1.0
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.

Parameters
view: View

The view

Compatibility:

  • API <19: No-op

generateViewId

Added in 1.1.0
Deprecated in 1.13.0
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.

Returns
Int

a generated ID value

getAccessibilityDelegate

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

Get the current accessibility delegate.

Parameters
view: View

The view whose delegate is of interest
Returns
AccessibilityDelegateCompat?

A compat wrapper for the current delegate. If no delegate is attached, you may still get an object that is being used to provide backward compatibility. Returns null if there is no delegate attached.
See also
setAccessibilityDelegate

getAccessibilityLiveRegion

Added in 1.1.0
Deprecated in 1.13.0
@ReplaceWith(expression = "view.getAccessibilityLiveRegion()")
java-static fun getAccessibilityLiveRegion(view: View): Int

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

getAccessibilityNodeProvider

Added in 1.1.0
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.

Parameters
view: View

The view whose property to get.
Returns
AccessibilityNodeProviderCompat?

The provider.
See also
AccessibilityNodeProviderCompat

getAccessibilityPaneTitle

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

Get the title of the pane for purposes of accessibility.

Parameters
view: View

The view queried for it's pane title.

Compatibility:

  • API <19: Always returns null
Returns
CharSequence?

The current pane title. {@see #setAccessibilityPaneTitle}.

getAlpha

Added in 1.1.0
Deprecated in 1.1.0
@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.

Returns
Float

The opacity of the view.

getAutofillId

Added in 1.11.0
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.
Parameters
v: View

The View against which to invoke the method.
Returns
AutofillIdCompat?

The View's autofill id.

getBackgroundTintList

Added in 1.1.0
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.

getBackgroundTintMode

Added in 1.1.0
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.

getClipBounds

Added in 1.1.0
Deprecated in 1.13.0
@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.

Returns
Rect?

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

getContentCaptureSession

Added in 1.11.0
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.
Parameters
v: View

The View against which to invoke the method.
Returns
ContentCaptureSessionCompat?

session explicitly set by setContentCaptureSession, inherited by ancestors, default session or null if content capture is disabled for this view.

getDisplay

Added in 1.1.0
Deprecated in 1.13.0
@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.
Returns
Display?

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

getElevation

Added in 1.1.0
java-static fun getElevation(view: View): Float

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

Parameters
view: View

view for which to get the elevation.
Returns
Float

The base depth position of the view, in pixels.

getFitsSystemWindows

Added in 1.1.0
Deprecated in 1.13.0
@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).

Parameters
view: View

view for which to get the state.

getImportantForAccessibility

Added in 1.1.0
Deprecated in 1.13.0
@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.

Parameters
view: View

The view whose property to get.
Returns
Int

The mode for determining whether a View is important for accessibility.
See also
IMPORTANT_FOR_ACCESSIBILITY_YES
IMPORTANT_FOR_ACCESSIBILITY_NO
IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS
IMPORTANT_FOR_ACCESSIBILITY_AUTO

getImportantForAutofill

Added in 1.1.0
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.

Parameters
v: View

The View against which to invoke the method.
Returns
Int

IMPORTANT_FOR_AUTOFILL_AUTO by default, or value passed to setImportantForAutofill. importantForAutofill

getImportantForContentCapture

Added in 1.11.0
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:

ref android.R.styleable#View_importantForContentCapture

Parameters
v: View

The View against which to invoke the method.
Returns
Int

IMPORTANT_FOR_CONTENT_CAPTURE_AUTO by default, or value passed to setImportantForContentCapture.

getLabelFor

Added in 1.1.0
Deprecated in 1.13.0
@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.

Parameters
view: View

The view on which to invoke the corresponding method.
Returns
Int

The labeled view id.

getLayerType

Added in 1.1.0
Deprecated in 1.1.0
@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.

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
setLayerType
LAYER_TYPE_NONE
LAYER_TYPE_SOFTWARE
LAYER_TYPE_HARDWARE

getLayoutDirection

Added in 1.1.0
Deprecated in 1.13.0
@ReplaceWith(expression = "view.getLayoutDirection()")
java-static fun getLayoutDirection(view: View): Int

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 1.1.0
Deprecated in 1.1.0
@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.

Parameters
view: View!

The view whose Matrix will be returned
Returns
Matrix?

The current transform matrix for the view
See also
getRotation
getScaleX
getScaleY
getPivotX
getPivotY

getMeasuredHeightAndState

Added in 1.1.0
Deprecated in 1.1.0
@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.

Returns
Int

The measured width of this view as a bit mask.

getMeasuredState

Added in 1.1.0
Deprecated in 1.1.0
@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.

getMeasuredWidthAndState

Added in 1.1.0
Deprecated in 1.1.0
@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.

Returns
Int

The measured width of this view as a bit mask.

getMinimumHeight

Added in 1.1.0
Deprecated in 1.13.0
@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.

Returns
Int

the minimum height the view will try to be.

getMinimumWidth

Added in 1.1.0
Deprecated in 1.13.0
@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.

Returns
Int

the minimum width the view will try to be.

getNextClusterForwardId

Added in 1.1.0
java-static fun getNextClusterForwardId(view: View): Int

Gets the ID of the next keyboard navigation cluster root.

Returns
Int

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

getOnReceiveContentMimeTypes

Added in 1.5.0
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.

Parameters
view: View

The target view.
Returns
Array<String!>?

The MIME types accepted by the OnReceiveContentListener for the given view (may include patterns such as "image/*").

getOverScrollMode

Added in 1.1.0
Deprecated in 1.1.0
@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.

Parameters
view: View!

The View against which to invoke the method.
Returns
Int

This view's over-scroll mode.

getPaddingEnd

Added in 1.1.0
Deprecated in 1.13.0
@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.

Parameters
view: View

The view to get padding for
Returns
@Px Int

the end padding in pixels

getPaddingStart

Added in 1.1.0
Deprecated in 1.13.0
@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.

Parameters
view: View

The view to get padding for
Returns
@Px Int

the start padding in pixels

getParentForAccessibility

Added in 1.1.0
Deprecated in 1.13.0
@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.

Parameters
view: View

View to retrieve parent for
Returns
ViewParent?

The parent for use in accessibility inspection

getPivotX

Added in 1.1.0
Deprecated in 1.1.0
@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.

Parameters
view: View!

view for which to get the pivot.

getPivotY

Added in 1.1.0
Deprecated in 1.1.0
@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.

Parameters
view: View!

view for which to get the pivot.
Returns
Float

The y location of the pivot point.

getRootWindowInsets

Added in 1.3.0
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.

Returns
WindowInsetsCompat?

WindowInsetsCompat from the top of the view hierarchy or null if View is detached

getRotation

Added in 1.1.0
Deprecated in 1.1.0
@ReplaceWith(expression = "view.getRotation()")
java-static fun getRotation(view: View!): Float
Parameters
view: View!

view for which to get the rotation.

getRotationX

Added in 1.1.0
Deprecated in 1.1.0
@ReplaceWith(expression = "view.getRotationX()")
java-static fun getRotationX(view: View!): Float
Parameters
view: View!

view for which to get the rotation.

getRotationY

Added in 1.1.0
Deprecated in 1.1.0
@ReplaceWith(expression = "view.getRotationY()")
java-static fun getRotationY(view: View!): Float
Parameters
view: View!

view for which to get the rotation.

getScaleX

Added in 1.1.0
Deprecated in 1.1.0
@ReplaceWith(expression = "view.getScaleX()")
java-static fun getScaleX(view: View!): Float
Parameters
view: View!

view for which to get the scale.

getScaleY

Added in 1.1.0
Deprecated in 1.1.0
@ReplaceWith(expression = "view.getScaleY()")
java-static fun getScaleY(view: View!): Float
Parameters
view: View!

view for which to get the scale.

getScrollIndicators

Added in 1.1.0
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.

Parameters
view: View

view for which to get the state.
Returns
Int

a bitmask representing the enabled scroll indicators

getStateDescription

Added in 1.5.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.

Parameters
view: View

view for which to get the description
Returns
CharSequence?

the state description
See also
setStateDescription

getSystemGestureExclusionRects

Added in 1.2.0
java-static fun getSystemGestureExclusionRects(view: View): (Mutable)List<Rect!>

Retrieve the list of areas within this view's post-layout coordinate space where the system should not intercept touch or other pointing device gestures.

On devices running API 28 and below, this method always returns an empty list.

Parameters
view: View

view for which to get the exclusion rects.
See also
getSystemGestureExclusionRects

getTransitionName

Added in 1.1.0
java-static fun getTransitionName(view: View): String?

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 1.1.0
Deprecated in 1.1.0
@ReplaceWith(expression = "view.getTranslationX()")
java-static fun getTranslationX(view: View!): Float

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.

Returns
Float

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

getTranslationY

Added in 1.1.0
Deprecated in 1.1.0
@ReplaceWith(expression = "view.getTranslationY()")
java-static fun getTranslationY(view: View!): Float

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.

Returns
Float

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

getTranslationZ

Added in 1.1.0
java-static fun getTranslationZ(view: View): Float

The depth location of this view relative to its elevation.

Parameters
view: View

view for which to get the translation.
Returns
Float

The depth of this view relative to its elevation.

getWindowInsetsController

Added in 1.5.0
Deprecated in 1.8.0
java-static fun getWindowInsetsController(view: View): WindowInsetsControllerCompat?

Retrieves a WindowInsetsControllerCompat of the window this view is attached to.

Returns
WindowInsetsControllerCompat?

A WindowInsetsControllerCompat or null if the view is neither attached to a window nor a view tree with a decor.
See also
getInsetsController

getWindowSystemUiVisibility

Added in 1.1.0
Deprecated in 1.7.0
@ReplaceWith(expression = "view.getWindowSystemUiVisibility()")
java-static fun getWindowSystemUiVisibility(view: View): Int

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

Parameters
view: View

view for which to get the visibility.

getX

Added in 1.1.0
Deprecated in 1.1.0
@ReplaceWith(expression = "view.getX()")
java-static fun getX(view: View!): Float
Parameters
view: View!

view for which to get the X.

getY

Added in 1.1.0
Deprecated in 1.1.0
@ReplaceWith(expression = "view.getY()")
java-static fun getY(view: View!): Float
Parameters
view: View!

view for which to get the Y.

getZ

Added in 1.1.0
java-static fun getZ(view: View): Float

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

Parameters
view: View

view for which to get the position.
Returns
Float

The visual z position of this view, in pixels.

hasAccessibilityDelegate

Added in 1.1.0
java-static fun hasAccessibilityDelegate(view: View): Boolean

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

Parameters
view: View

The View instance to check
Returns
Boolean

True if the View has an accessibility delegate

hasExplicitFocusable

Added in 1.1.0
java-static fun hasExplicitFocusable(view: View): Boolean

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

view on which to make the change.
Returns
Boolean

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

hasNestedScrollingParent

Added in 1.1.0
java-static fun hasNestedScrollingParent(view: View): Boolean

Returns true if this view has a nested scrolling parent.

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

Parameters
view: View

view for which to check the parent.
Returns
Boolean

whether this view has a nested scrolling parent

hasNestedScrollingParent

Added in 1.1.0
java-static fun hasNestedScrollingParent(view: View, type: Int): Boolean

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

view for which to check the parent.
type: Int

the type of input which cause this scroll event
Returns
Boolean

whether this view has a nested scrolling parent

hasOnClickListeners

Added in 1.1.0
Deprecated in 1.13.0
@ReplaceWith(expression = "view.hasOnClickListeners()")
java-static fun hasOnClickListeners(view: View): Boolean

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

Returns
Boolean

true if there is a listener, false if there is none.

hasOverlappingRendering

Added in 1.1.0
Deprecated in 1.13.0
@ReplaceWith(expression = "view.hasOverlappingRendering()")
java-static fun hasOverlappingRendering(view: View): Boolean

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

view for which to get the state.
Returns
Boolean

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

hasTransientState

Added in 1.1.0
Deprecated in 1.13.0
@ReplaceWith(expression = "view.hasTransientState()")
java-static fun hasTransientState(view: View): Boolean

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

isAccessibilityHeading

Added in 1.1.0
@UiThread
java-static fun isAccessibilityHeading(view: View): Boolean

Gets whether this view is a heading for accessibility purposes.

Parameters
view: View

The view checked if it is a heading.

Compatibility:

  • API <28: Always returns false
Returns
Boolean

true if the view is a heading, false otherwise.

isAttachedToWindow

Added in 1.1.0
Deprecated in 1.13.0
@ReplaceWith(expression = "view.isAttachedToWindow()")
java-static fun isAttachedToWindow(view: View): Boolean

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

isFocusedByDefault

Added in 1.1.0
java-static fun isFocusedByDefault(view: View): Boolean

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

view for which to check the state.
Returns
Boolean

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

isImportantForAccessibility

Added in 1.1.0
java-static fun isImportantForAccessibility(view: View): Boolean

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 value:

  1. IMPORTANT_FOR_ACCESSIBILITY_NO or IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS, return false
  2. IMPORTANT_FOR_ACCESSIBILITY_YES, return true
  3. IMPORTANT_FOR_ACCESSIBILITY_AUTO, return true if view satisfies any of the following:

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

Parameters
view: View

view for which to check the state.
Returns
Boolean

Whether the view is exposed for accessibility.
See also
setImportantForAccessibility
getImportantForAccessibility

isImportantForAutofill

Added in 1.1.0
java-static fun isImportantForAutofill(v: View): Boolean

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

Generally speaking, a view is important for autofill if:

  1. The view can be autofilled by an android.service.autofill.AutofillService.
  2. The view contents can help an android.service.autofill.AutofillService determine how other views can be autofilled.

For example, view containers should typically return false for performance reasons (since the important info is provided by their children), but if its properties have relevant information (for example, a resource id called credentials, it should return true. On the other hand, views representing labels or editable fields should typically return true, but in some cases they could return false (for example, if they're part of a "Captcha" mechanism).

The value returned by this method depends on the value returned by getImportantForAutofill:

  1. if it returns IMPORTANT_FOR_AUTOFILL_YES or IMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTS, then it returns true
  2. if it returns IMPORTANT_FOR_AUTOFILL_NO or IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS, then it returns false
  3. if it returns IMPORTANT_FOR_AUTOFILL_AUTO, then it uses some simple heuristics that can return true in some cases (like a container with a resource id), but false in most.
  4. otherwise, it returns false.

When a view is considered important for autofill:

  • The view might automatically trigger an autofill request when focused on.
  • The contents of the view are included in the android.view.ViewStructure used in an autofill request.

On the other hand, when a view is considered not important for autofill:

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

Parameters
v: View

The View against which to invoke the method.
Returns
Boolean

whether the view is considered important for autofill.
See also
setImportantForAutofill
IMPORTANT_FOR_AUTOFILL_AUTO
IMPORTANT_FOR_AUTOFILL_YES
IMPORTANT_FOR_AUTOFILL_NO
IMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTS
IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS
requestAutofill

isImportantForContentCapture

Added in 1.11.0
java-static fun isImportantForContentCapture(v: View): Boolean

Hints the Android System whether this view is considered important for content capture, based on the value explicitly set by setImportantForContentCapture and heuristics when it's IMPORTANT_FOR_CONTENT_CAPTURE_AUTO.

See ContentCaptureManager for more info about content capture. Compatibility behavior:

  • SDK 30 and above, this method matches platform behavior.
  • SDK 29 and below, this method always return false.
Parameters
v: View

The View against which to invoke the method.
Returns
Boolean

whether the view is considered important for content capture.
See also
setImportantForContentCapture(int)
IMPORTANT_FOR_CONTENT_CAPTURE_AUTO
IMPORTANT_FOR_CONTENT_CAPTURE_YES
IMPORTANT_FOR_CONTENT_CAPTURE_NO
IMPORTANT_FOR_CONTENT_CAPTURE_YES_EXCLUDE_DESCENDANTS
IMPORTANT_FOR_CONTENT_CAPTURE_NO_EXCLUDE_DESCENDANTS

isInLayout

Added in 1.1.0
Deprecated in 1.13.0
@ReplaceWith(expression = "view.isInLayout()")
java-static fun isInLayout(view: View): Boolean

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
Returns
Boolean

whether the view hierarchy is currently undergoing a layout pass

isKeyboardNavigationCluster

Added in 1.1.0
java-static fun isKeyboardNavigationCluster(view: View): Boolean

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

Parameters
view: View

view for which to check the cluster.
Returns
Boolean

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

isLaidOut

Added in 1.1.0
Deprecated in 1.13.0
@ReplaceWith(expression = "view.isLaidOut()")
java-static fun isLaidOut(view: View): Boolean

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

isLayoutDirectionResolved

Added in 1.1.0
Deprecated in 1.13.0
@ReplaceWith(expression = "view.isLayoutDirectionResolved()")
java-static fun isLayoutDirectionResolved(view: View): Boolean

Returns whether layout direction has been resolved.

Compatibility:

  • API <19: Always returns false
Returns
Boolean

true if layout direction has been resolved.

isNestedScrollingEnabled

Added in 1.1.0
java-static fun isNestedScrollingEnabled(view: View): Boolean

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.

Returns
Boolean

true if nested scrolling is enabled
See also
setNestedScrollingEnabled

isOpaque

Added in 1.1.0
Deprecated in 1.1.0
@ReplaceWith(expression = "view.isOpaque()")
java-static fun isOpaque(view: View!): Boolean

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!

view for which to check the state.
Returns
Boolean

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

isPaddingRelative

Added in 1.1.0
Deprecated in 1.13.0
@ReplaceWith(expression = "view.isPaddingRelative()")
java-static fun isPaddingRelative(view: View): Boolean

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

Parameters
view: View

view for which to get the state.
Returns
Boolean

true if the padding is relative or false if it is not.

isScreenReaderFocusable

Added in 1.1.0
@UiThread
java-static fun isScreenReaderFocusable(view: View): Boolean

Returns whether the view should be treated as a focusable unit by screen reader accessibility tools.

Parameters
view: View

The view to check for screen reader focusability.

Compatibility:

  • API <19: Always returns false
Returns
Boolean

Whether the view should be treated as a focusable unit by screen reader.
See also
setScreenReaderFocusable

jumpDrawablesToCurrentState

Added in 1.1.0
Deprecated in 1.1.0
@ReplaceWith(expression = "view.jumpDrawablesToCurrentState()")
java-static fun jumpDrawablesToCurrentState(view: View!): Unit

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
view: View!

view for which to jump the drawable state.

keyboardNavigationClusterSearch

Added in 1.1.0
java-static fun keyboardNavigationClusterSearch(
    view: View,
    currentCluster: View?,
    direction: Int
): View?

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

Parameters
view: View

view on which to do the search.
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 1.1.0
java-static fun offsetLeftAndRight(view: View, offset: Int): Unit

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

Parameters
view: View

view which needs to be offset.
offset: Int

the number of pixels to offset the view by

offsetTopAndBottom

Added in 1.1.0
java-static fun offsetTopAndBottom(view: View, offset: Int): Unit

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

Parameters
view: View

view that needs to be offset.
offset: Int

the number of pixels to offset the view by

onApplyWindowInsets

Added in 1.1.0
java-static fun onApplyWindowInsets(view: View, insets: WindowInsetsCompat): WindowInsetsCompat

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 1.1.0
Deprecated in 1.1.0
@ReplaceWith(expression = "v.onInitializeAccessibilityEvent(event)")
java-static fun onInitializeAccessibilityEvent(v: View!, event: AccessibilityEvent!): Unit

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, its onInitializeAccessibilityEvent 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
sendAccessibilityEvent
dispatchPopulateAccessibilityEvent

onInitializeAccessibilityNodeInfo

Added in 1.1.0
Deprecated in 1.13.0
@ReplaceWith(expression = "v.onInitializeAccessibilityNodeInfo(info.unwrap())")
java-static fun onInitializeAccessibilityNodeInfo(
    v: View,
    info: AccessibilityNodeInfoCompat
): Unit

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

If an AccessibilityDelegateCompat has been specified via calling setAccessibilityDelegate, its onInitializeAccessibilityNodeInfo 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 1.1.0
Deprecated in 1.1.0
@ReplaceWith(expression = "v.onPopulateAccessibilityEvent(event)")
java-static fun onPopulateAccessibilityEvent(v: View!, event: AccessibilityEvent!): Unit

Called from dispatchPopulateAccessibilityEvent giving a chance to this View to populate the accessibility event with its text content.

Note: This method should only be used with getText. Avoid mutating other event state in this method. Instead, follow the practices described in dispatchPopulateAccessibilityEvent. In general, put UI metadata in the node for services to easily query, than in events.

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 its onPopulateAccessibilityEvent 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
sendAccessibilityEvent
dispatchPopulateAccessibilityEvent

performAccessibilityAction

Added in 1.1.0
Deprecated in 1.13.0
@ReplaceWith(expression = "view.performAccessibilityAction(action, arguments)")
java-static fun performAccessibilityAction(view: View, action: Int, arguments: Bundle?): Boolean

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

If an AccessibilityDelegateCompat has been specified via calling setAccessibilityDelegate its performAccessibilityAction is responsible for handling this call.

Note: Avoid setting accessibility focus with ACTION_ACCESSIBILITY_FOCUS. This is intended to be controlled by screen readers. Apps changing focus can confuse screen readers, and the resulting behavior can vary by device and screen reader version.

Parameters
view: View

view on which to perform the action.
action: Int

The action to perform.
arguments: Bundle?

Optional action arguments.
Returns
Boolean

Whether the action was performed.

performHapticFeedback

Added in 1.11.0
java-static fun performHapticFeedback(view: View, feedbackConstant: Int): Boolean

Perform a haptic feedback to the user for the view.

The framework will provide haptic feedback for some built in actions, such as long presses, but you may wish to provide feedback for your own widget.

The feedback will only be performed if isHapticFeedbackEnabled is true. Note: Check compatibility support for each feedback constant described at HapticFeedbackConstantsCompat.

Parameters
view: View

The view.
feedbackConstant: Int

One of the constants defined in HapticFeedbackConstantsCompat
Returns
Boolean

Whether the feedback might be performed - generally this result should be ignored

performHapticFeedback

Added in 1.11.0
java-static fun performHapticFeedback(view: View, feedbackConstant: Int, flags: Int): Boolean

Perform a haptic feedback to the user for the view.

This is similar to performHapticFeedback, with additional options. Note: Check compatibility support for each feedback constant described at HapticFeedbackConstantsCompat.

Parameters
view: View

The view.
feedbackConstant: Int

One of the constants defined in HapticFeedbackConstantsCompat
flags: Int

Additional flags as per HapticFeedbackConstantsCompat
Returns
Boolean

Whether the feedback might be performed - generally this result should be ignored

performReceiveContent

Added in 1.5.0
java-static fun performReceiveContent(view: View, payload: ContentInfoCompat): ContentInfoCompat?

Receives the given content.

If a listener is set, invokes the listener. If the listener returns a non-null result, executes the fallback handling for the portion of the content returned by the listener.

If no listener is set, executes the fallback handling.

The fallback handling is defined by the target view if the view implements OnReceiveContentViewBehavior, or is simply a no-op.

Parameters
view: View

The target view.
payload: ContentInfoCompat

The content to insert and related metadata.
Returns
ContentInfoCompat?

The portion of the passed-in content that was not handled (may be all, some, or none of the passed-in content).

postInvalidateOnAnimation

Added in 1.1.0
Deprecated in 1.13.0
@ReplaceWith(expression = "view.postInvalidateOnAnimation()")
java-static fun postInvalidateOnAnimation(view: View): Unit

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

postInvalidateOnAnimation

Added in 1.1.0
Deprecated in 1.13.0
@ReplaceWith(expression = "view.postInvalidateOnAnimation(left, top, right, bottom)")
java-static fun postInvalidateOnAnimation(
    view: View,
    left: Int,
    top: Int,
    right: Int,
    bottom: Int
): Unit

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.

postOnAnimation

Added in 1.1.0
Deprecated in 1.13.0
@ReplaceWith(expression = "view.postOnAnimation(action)")
java-static fun postOnAnimation(view: View, action: Runnable): Unit

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 1.1.0
Deprecated in 1.13.0
@ReplaceWith(expression = "view.postOnAnimationDelayed(action, delayMillis)")
java-static fun postOnAnimationDelayed(view: View, action: Runnable, delayMillis: Long): Unit

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.

removeAccessibilityAction

Added in 1.1.0
java-static fun removeAccessibilityAction(view: View, actionId: Int): Unit

Removes an accessibility action that can be performed on a node associated with a view. If the action was not already added to the view, calling this method has no effect.

Parameters
view: View

The view
actionId: Int

The actionId of the action to be removed.

removeOnUnhandledKeyEventListener

Added in 1.1.0
java-static fun removeOnUnhandledKeyEventListener(
    view: View,
    listener: ViewCompat.OnUnhandledKeyEventListenerCompat
): Unit

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

Parameters
view: View

view from which to remove the listener.
listener: ViewCompat.OnUnhandledKeyEventListenerCompat

a receiver of unhandled KeyEvents.
See also
addOnUnhandledKeyEventListener

replaceAccessibilityAction

Added in 1.1.0
java-static fun replaceAccessibilityAction(
    view: View,
    replacedAction: AccessibilityNodeInfoCompat.AccessibilityActionCompat,
    label: CharSequence?,
    command: AccessibilityViewCommand?
): Unit

Replaces an action. This can be used to change the default behavior or label of the action specified. If label and command are both null, the action will be removed.

Parameters
view: View

The view.
replacedAction: AccessibilityNodeInfoCompat.AccessibilityActionCompat

The action to be replaced.
label: CharSequence?

The user facing description of the action or null.
command: AccessibilityViewCommand?

The command performed when the service requests the action.

Compatibility:

  • API <21: No-op

requestApplyInsets

Added in 1.1.0
java-static fun requestApplyInsets(view: View): Unit

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

Parameters
view: View

view for which to send the request.

requireViewById

Added in 1.1.0
java-static fun <T : View?> requireViewById(view: View, id: @IdRes Int): T

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

the view to start the search from.
id: @IdRes Int

the ID to search for
Returns
T

a view with given ID
See also
findViewById

resolveSizeAndState

Added in 1.1.0
Deprecated in 1.1.0
java-static fun resolveSizeAndState(size: Int, measureSpec: Int, childMeasuredState: Int): Int

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

Size information bit mask for the view's children.
Returns
Int

Size information bit mask as defined by MEASURED_SIZE_MASK and MEASURED_STATE_TOO_SMALL.

restoreDefaultFocus

Added in 1.1.0
java-static fun restoreDefaultFocus(view: View): Boolean

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.

Parameters
view: View

view on which to make the change.
Returns
Boolean

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

saveAttributeDataForStyleable

Added in 1.3.0
java-static fun saveAttributeDataForStyleable(
    view: View,
    context: Context,
    styleable: IntArray,
    attrs: AttributeSet?,
    t: TypedArray,
    defStyleAttr: Int,
    defStyleRes: Int
): Unit

Stores debugging information about attributes. This should be called in a constructor by every custom View that uses a custom styleable. If the custom view does not call it, then the custom attributes used by this view will not be visible in layout inspection tools. No-op before API 29.

Parameters
view: View

view for which to save the data.
context: Context

Context under which this view is created.
styleable: IntArray

A reference to styleable array R.styleable.Foo
attrs: AttributeSet?

AttributeSet used to construct this view.
t: TypedArray

Resolved TypedArray returned by a call to obtainAttributes.
defStyleAttr: Int

Default style attribute passed into the view constructor.
defStyleRes: Int

Default style resource passed into the view constructor.

setAccessibilityDelegate

Added in 1.1.0
java-static fun setAccessibilityDelegate(v: View, delegate: AccessibilityDelegateCompat?): Unit

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

If an AccessibilityDelegateCompat is already attached to the view, and this method sets the delegate to null, an empty delegate will be attached to ensure that other compatibility behavior continues to work for this view.

Parameters
v: View

view for which to set the delegate.
delegate: AccessibilityDelegateCompat?

the object to which accessibility method calls should be delegated
See also
AccessibilityDelegateCompat

setAccessibilityHeading

Added in 1.1.0
@UiThread
java-static fun setAccessibilityHeading(view: View, isHeading: Boolean): Unit

Set if view is a heading for a section of content for accessibility purposes.

Parameters
view: View

The view to set if it is a heading.
isHeading: Boolean

true if the view is a heading, false otherwise.

Compatibility:

  • API <28: No-op

setAccessibilityLiveRegion

Added in 1.1.0
Deprecated in 1.13.0
@ReplaceWith(expression = "view.setAccessibilityLiveRegion(mode)")
java-static fun setAccessibilityLiveRegion(view: View, mode: Int): Unit

Sets the live region mode for this 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).

To indicate that the user should be notified of changes, use ACCESSIBILITY_LIVE_REGION_POLITE. Announcements from this region are queued and do not disrupt ongoing speech.

For example, selecting an option in a dropdown menu may update a panel below with the updated content. This panel may be marked as a live region with ACCESSIBILITY_LIVE_REGION_POLITE to notify users of the change.

For notifying users about errors, such as in a login screen with text that displays an "incorrect password" notification, that view should send an AccessibilityEvent of type CONTENT_CHANGE_TYPE_ERROR and set setError instead. Custom widgets should expose error-setting methods that support accessibility automatically. For example, instead of explicitly sending this event when using a TextView, use setError.

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

If the view's changes should interrupt ongoing speech and notify the user immediately, use ACCESSIBILITY_LIVE_REGION_ASSERTIVE. This may result in disruptive announcements from an accessibility service, so it should generally be used only to convey information that is time-sensitive or critical for use of the application. Examples may include an incoming call or an emergency alert.

Parameters
view: View

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

The live region mode for this view, one of:

setAccessibilityPaneTitle

Added in 1.1.0
@UiThread
java-static fun setAccessibilityPaneTitle(
    view: View,
    accessibilityPaneTitle: CharSequence?
): Unit

Visually distinct portion of a window with window-like semantics are considered panes for accessibility purposes. One example is the content view of a large fragment that is replaced. In order for accessibility services to understand a pane's window-like behavior, panes should have descriptive titles. Views with pane titles produce TYPE_WINDOW_STATE_CHANGEDs when they appear, disappear, or change title.

When transitioning from one Activity to another, instead of using setAccessibilityPaneTitle(), set a descriptive title for your activity's window by using android:label for the matching entry in your application’s manifest or updating the title at runtime with .

To set the pane title in xml, use android:accessibilityPaneTitle.

Parameters
view: View

The view whose pane title should be set.
accessibilityPaneTitle: CharSequence?

The pane's title. Setting to null indicates that this View is not a pane.

Compatibility:

  • API <19: No-op
{@see AccessibilityNodeInfo#setPaneTitle(CharSequence)}

setActivated

Added in 1.1.0
Deprecated in 1.1.0
@ReplaceWith(expression = "view.setActivated(activated)")
java-static fun setActivated(view: View!, activated: Boolean): Unit

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!

view for which to set the state.
activated: Boolean

true if the view must be activated, false otherwise

setAlpha

Added in 1.1.0
Deprecated in 1.1.0
@ReplaceWith(expression = "view.setAlpha(value)")
java-static fun setAlpha(view: View!, value: @FloatRange(from = 0.0, to = 1.0) Float): Unit

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

Parameters
view: View!

view to set the alpha on.
value: @FloatRange(from = 0.0, to = 1.0) Float

The opacity of the view.

setAutofillHints

java-static fun setAutofillHints(view: View, autofillHints: Array<String!>?): Unit

Sets the hints that help an android.service.autofill.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
view: View

view for which to set the hints.
autofillHints: Array<String!>?

The autofill hints to set. If the array is emtpy, null is set. autofillHints

setAutofillId

Added in 1.11.0
java-static fun setAutofillId(v: View, id: AutofillIdCompat?): Unit

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

The autofill id is created on demand, and this method should only be called when a view is reused after dispatchProvideAutofillStructure is called, as that method creates a snapshot of the view that is passed along to the autofill service.

This method is typically used when view subtrees are recycled to represent different content* —in this case, the autofill id can be saved before the view content is swapped out, and restored later when it's swapped back in. For example: 

EditText reusableView = ...;
ViewGroup parentView = ...;
AutofillManager afm = ...;

// Swap out the view and change its contents
AutofillId oldId = reusableView.getAutofillId();
CharSequence oldText = reusableView.getText();
parentView.removeView(reusableView);
AutofillId newId = afm.getNextAutofillId();
reusableView.setText("New I am");
reusableView.setAutofillId(newId);
parentView.addView(reusableView);

// Later, swap the old content back in
parentView.removeView(reusableView);
reusableView.setAutofillId(oldId);
reusableView.setText(oldText);
parentView.addView(reusableView);

NOTE: If this view is a descendant of an android.widget.AdapterView, the system may reset its autofill id when this view is recycled. If the autofill ids need to be stable, they should be set again in getView. Compatibility behavior:

  • SDK 28 and above, this method matches platform behavior.
  • SDK 27 and below, this method does nothing.
Parameters
v: View

The View against which to invoke the method.
id: AutofillIdCompat?

an autofill ID that is unique in the android.app.Activity hosting the view, or null to reset it. Usually it's an id previously allocated to another view (and obtained through getAutofillId), or a new value obtained through getNextAutofillId.
Throws
java.lang.IllegalStateException

if the view is already attached to a window.
java.lang.IllegalArgumentException

if the id is an autofill id associated with a virtual view.

setBackground

Added in 1.1.0
Deprecated in 1.13.0
@ReplaceWith(expression = "view.setBackground(background)")
java-static fun setBackground(view: View, background: Drawable?): Unit

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 use setPadding(int, int, int, int).

Parameters
view: View

view for which to set the background.
background: Drawable?

the drawable to use as view background.

setBackgroundTintList

Added in 1.1.0
java-static fun setBackgroundTintList(view: View, tintList: ColorStateList?): Unit

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.

setBackgroundTintMode

Added in 1.1.0
java-static fun setBackgroundTintMode(view: View, mode: PorterDuff.Mode?): Unit

Specifies the blending mode used to apply the tint specified by setBackgroundTintList 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.

setChildrenDrawingOrderEnabled

Added in 1.1.0
Deprecated in 1.1.0
java-static fun setChildrenDrawingOrderEnabled(viewGroup: ViewGroup!, enabled: Boolean): Unit

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

Parameters
viewGroup: ViewGroup!

the ViewGroup for which to set the mode.
enabled: Boolean

true if the order of the children when drawing is determined by getChildDrawingOrder, false otherwise

Prior to API 7 this will have no effect.

setClipBounds

Added in 1.1.0
Deprecated in 1.13.0
@ReplaceWith(expression = "view.setClipBounds(clipBounds)")
java-static fun setClipBounds(view: View, clipBounds: Rect?): Unit

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.

setContentCaptureSession

Added in 1.11.0
java-static fun setContentCaptureSession(
    v: View,
    contentCaptureSession: ContentCaptureSessionCompat?
): Unit

Sets the (optional) ContentCaptureSession associated with this view.

This method should be called when you need to associate a ContentCaptureContext to the content capture events associated with this view or its view hierarchy (if it's a ViewGroup).

For example, if your activity is associated with a web domain, first you would need to set the context for the main DOM: 

  ContentCaptureSession mainSession = rootView.getContentCaptureSession();
  mainSession.setContentCaptureContext(ContentCaptureContext.forLocusId(Uri.parse(myUrl));

Then if the page had an IFRAME, you would create a new session for it: 

  ContentCaptureSession iframeSession = mainSession.createContentCaptureSession(
      ContentCaptureContext.forLocusId(Uri.parse(iframeUrl)));
  iframeView.setContentCaptureSession(iframeSession);
 Compatibility behavior:
  • SDK 29 and above, this method matches platform behavior.
  • SDK 28 and below, this method does nothing.
Parameters
v: View

The View against which to invoke the method.
contentCaptureSession: ContentCaptureSessionCompat?

a session created by createContentCaptureSession.

setElevation

Added in 1.1.0
java-static fun setElevation(view: View, elevation: Float): Unit
Parameters
view: View

view for which to set the elevation.
elevation: Float

view elevation in pixels. Sets the base elevation of this view, in pixels.

setFitsSystemWindows

Added in 1.1.0
Deprecated in 1.1.0
@ReplaceWith(expression = "view.setFitsSystemWindows(fitSystemWindows)")
java-static fun setFitsSystemWindows(view: View!, fitSystemWindows: Boolean): Unit

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

Parameters
view: View!

view for which to set the state.
fitSystemWindows: Boolean

whether or not this view should account for system screen decorations.

setFocusedByDefault

Added in 1.1.0
java-static fun setFocusedByDefault(view: View, isFocusedByDefault: Boolean): Unit

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

view for which to set the state.
isFocusedByDefault: Boolean

true to set view as the default-focus view, false otherwise.

setHasTransientState

Added in 1.1.0
Deprecated in 1.13.0
@ReplaceWith(expression = "view.setHasTransientState(hasTransientState)")
java-static fun setHasTransientState(view: View, hasTransientState: Boolean): Unit

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 1.1.0
Deprecated in 1.13.0
@ReplaceWith(expression = "view.setImportantForAccessibility(mode)")
@UiThread
java-static fun setImportantForAccessibility(view: View, mode: Int): Unit

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
IMPORTANT_FOR_ACCESSIBILITY_YES
IMPORTANT_FOR_ACCESSIBILITY_NO
IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS
IMPORTANT_FOR_ACCESSIBILITY_AUTO

setImportantForAutofill

Added in 1.1.0
java-static fun setImportantForAutofill(v: View, mode: Int): Unit

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:

  1. 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.
  2. 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.
  3. 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 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

The View against which to invoke the method.
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. importantForAutofill

setImportantForContentCapture

Added in 1.11.0
java-static fun setImportantForContentCapture(v: View, mode: Int): Unit

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

The platform determines the importance for autofill automatically but you can use this method to customize the behavior. Typically, a view that provides text should be marked as IMPORTANT_FOR_CONTENT_CAPTURE_YES. Compatibility behavior:

  • SDK 30 and above, this method matches platform behavior.
  • SDK 29 and below, this method does nothing.

ref android.R.styleable#View_importantForContentCapture

Parameters
v: View

The View against which to invoke the method.
mode: Int

IMPORTANT_FOR_CONTENT_CAPTURE_AUTO, IMPORTANT_FOR_CONTENT_CAPTURE_YES, IMPORTANT_FOR_CONTENT_CAPTURE_NO, IMPORTANT_FOR_CONTENT_CAPTURE_YES_EXCLUDE_DESCENDANTS, or IMPORTANT_FOR_CONTENT_CAPTURE_NO_EXCLUDE_DESCENDANTS.

setKeyboardNavigationCluster

Added in 1.1.0
java-static fun setKeyboardNavigationCluster(view: View, isCluster: Boolean): Unit

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

Parameters
view: View

view for which to set the cluster.
isCluster: Boolean

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

setLabelFor

Added in 1.1.0
Deprecated in 1.13.0
@ReplaceWith(expression = "view.setLabelFor(labeledId)")
java-static fun setLabelFor(view: View, labeledId: @IdRes Int): Unit

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: @IdRes Int

The labeled view id.

setLayerPaint

Added in 1.1.0
Deprecated in 1.13.0
@ReplaceWith(expression = "view.setLayerPaint(paint)")
java-static fun setLayerPaint(view: View, paint: Paint?): Unit

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 will be used the next time the View is redrawn, but setLayerPaint must be called to ensure that the view gets redrawn immediately.

A layer is associated with an optional android.graphics.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:

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

setLayerType

Added in 1.1.0
Deprecated in 1.1.0
@ReplaceWith(expression = "view.setLayerType(layerType, paint)")
java-static fun setLayerType(view: View!, layerType: Int, paint: Paint!): Unit

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

A layer is associated with an optional android.graphics.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:

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 1.1.0
Deprecated in 1.13.0
@ReplaceWith(expression = "view.setLayoutDirection(layoutDirection)")
java-static fun setLayoutDirection(view: View, layoutDirection: Int): Unit

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 1.1.0
java-static fun setNestedScrollingEnabled(view: View, enabled: Boolean): Unit

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

view for which to set the state.
enabled: Boolean

true to enable nested scrolling, false to disable
See also
isNestedScrollingEnabled

setNextClusterForwardId

Added in 1.1.0
java-static fun setNextClusterForwardId(view: View, nextClusterForwardId: Int): Unit

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

view for which to set the ID.
nextClusterForwardId: Int

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

setOnApplyWindowInsetsListener

Added in 1.1.0
java-static fun setOnApplyWindowInsetsListener(
    view: View,
    listener: OnApplyWindowInsetsListener?
): Unit

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
view: View

view on which to the listener.
listener: OnApplyWindowInsetsListener?

listener for the applied window insets.

setOnReceiveContentListener

Added in 1.5.0
java-static fun setOnReceiveContentListener(
    view: View,
    mimeTypes: Array<String!>?,
    listener: OnReceiveContentListener?
): Unit

Sets the listener to be used to handle insertion of content into the given view.

Depending on the type of view, this listener may be invoked for different scenarios. For example, for an AppCompatEditText, this listener will be invoked for the following scenarios:

  1. Paste from the clipboard (e.g. "Paste" or "Paste as plain text" action in the insertion/selection menu)
  2. Content insertion from the keyboard (from commitContent)
  3. Drag and drop (drop events from onDragEvent)

When setting a listener, clients must also declare the accepted MIME types. The listener will still be invoked even if the MIME type of the content is not one of the declared MIME types (e.g. if the user pastes content whose type is not one of the declared MIME types). In that case, the listener may reject the content (defer to the default platform behavior) or execute some other fallback logic (e.g. show an appropriate message to the user). The declared MIME types serve as a hint to allow different features to optionally alter their behavior. For example, a soft keyboard may optionally choose to hide its UI for inserting GIFs for a particular input field if the MIME types set here for that field don't include "image/gif" or "image/*".

Note: 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.

Parameters
view: View

The target view.
mimeTypes: Array<String!>?

The MIME types accepted by the given listener. These may use patterns such as "image/*", but may not start with a wildcard. This argument must not be null or empty if a non-null listener is passed in.
listener: OnReceiveContentListener?

The listener to use. This can be null to reset to the default behavior.

setOverScrollMode

Added in 1.1.0
Deprecated in 1.1.0
@ReplaceWith(expression = "view.setOverScrollMode(overScrollMode)")
java-static fun setOverScrollMode(view: View!, overScrollMode: Int): Unit

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
view: View!

The View against which to invoke the method.
overScrollMode: Int

The new over-scroll mode for this view.

setPaddingRelative

Added in 1.1.0
Deprecated in 1.13.0
@ReplaceWith(expression = "view.setPaddingRelative(start, top, end, bottom)")
java-static fun setPaddingRelative(
    view: View,
    start: @Px Int,
    top: @Px Int,
    end: @Px Int,
    bottom: @Px Int
): Unit

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, getPaddingTop, getPaddingEnd and getPaddingBottom may be different from the values set in this call.

Parameters
view: View

The view on which to set relative padding
start: @Px Int

the start padding in pixels
top: @Px Int

the top padding in pixels
end: @Px Int

the end padding in pixels
bottom: @Px Int

the bottom padding in pixels

setPivotX

Added in 1.1.0
Deprecated in 1.1.0
@ReplaceWith(expression = "view.setPivotX(value)")
java-static fun setPivotX(view: View!, value: Float): Unit

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!

view for which to set the pivot.
value: Float

The x location of the pivot point.

setPivotY

Added in 1.1.0
Deprecated in 1.1.0
@ReplaceWith(expression = "view.setPivotY(value)")
java-static fun setPivotY(view: View!, value: Float): Unit

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!

view for which to set the pivot.
value: Float

The y location of the pivot point.

setPointerIcon

Added in 1.1.0
java-static fun setPointerIcon(view: View, pointerIcon: PointerIconCompat?): Unit

Set the pointer icon for the current view.

Parameters
view: View

view for which to set the pointer icon.
pointerIcon: PointerIconCompat?

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

setRotation

Added in 1.1.0
Deprecated in 1.1.0
@ReplaceWith(expression = "view.setRotation(value)")
java-static fun setRotation(view: View!, value: Float): Unit

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

Parameters
view: View!

view to set the rotation on.
value: Float

The degrees of rotation.

setRotationX

Added in 1.1.0
Deprecated in 1.1.0
@ReplaceWith(expression = "view.setRotationX(value)")
java-static fun setRotationX(view: View!, value: Float): Unit

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!

view to set the rotation on.
value: Float

The degrees of X rotation.

setRotationY

Added in 1.1.0
Deprecated in 1.1.0
@ReplaceWith(expression = "view.setRotationY(value)")
java-static fun setRotationY(view: View!, value: Float): Unit

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!

view to set the rotation on.
value: Float

The degrees of Y rotation.

setSaveFromParentEnabled

Added in 1.1.0
Deprecated in 1.1.0
@ReplaceWith(expression = "view.setSaveFromParentEnabled(enabled)")
java-static fun setSaveFromParentEnabled(view: View!, enabled: Boolean): Unit

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

Parameters
view: View!

view for which to set the state.
enabled: Boolean

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

setScaleX

Added in 1.1.0
Deprecated in 1.1.0
@ReplaceWith(expression = "view.setScaleX(value)")
java-static fun setScaleX(view: View!, value: Float): Unit

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!

view to set the scale on.
value: Float

The scaling factor.

setScaleY

Added in 1.1.0
Deprecated in 1.1.0
@ReplaceWith(expression = "view.setScaleY(value)")
java-static fun setScaleY(view: View!, value: Float): Unit

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!

view to set the scale on.
value: Float

The scaling factor.

setScreenReaderFocusable

Added in 1.1.0
@UiThread
java-static fun setScreenReaderFocusable(view: View, screenReaderFocusable: Boolean): Unit

Sets whether this View should be a focusable element for screen readers and include non-focusable Views from its subtree when providing feedback.

Note: this is similar to using android:focusable, but does not impact input focus behavior.

This can be used to group related content.

Parameters
view: View

The view whose title should be set
screenReaderFocusable: Boolean

Whether the view should be treated as a unit by screen reader accessibility tools.

Compatibility:

  • API <19: No-op

setScrollIndicators

Added in 1.1.0
java-static fun setScrollIndicators(view: View, indicators: Int): Unit

Sets the state of all scroll indicators.

See setScrollIndicators for usage information.

Parameters
view: View

view for which to set the state.
indicators: Int

a bitmask of indicators that should be enabled, or 0 to disable all indicators
See also
setScrollIndicators
getScrollIndicators

setScrollIndicators

Added in 1.1.0
java-static fun setScrollIndicators(view: View, indicators: Int, mask: Int): Unit

Sets the state of the scroll indicators specified by the mask. To change all scroll indicators at once, see setScrollIndicators.

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

view for which to set the state.
indicators: Int

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

mask: Int

the mask for scroll indicators.
See also
setScrollIndicators
getScrollIndicators

setStateDescription

Added in 1.5.0
@UiThread
java-static fun setStateDescription(view: View, stateDescription: CharSequence?): Unit

Sets the state description of this node.

Note: Cannot be called from an android.accessibilityservice.AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

State refers to a frequently changing property of the View, such as an enabled/disabled state of a button or the audio level of a volume slider.

This should omit role or content. Role refers to the kind of user-interface element the View is, such as a Button or Checkbox. Content is the meaningful text and graphics that should be described by setContentDescription or android:contentDescription. It is expected that a content description mostly remains constant, while a state description updates from time to time.

Parameters
view: View

view for which to set the description.
stateDescription: CharSequence?

the state description of this node.
Throws
java.lang.IllegalStateException

If called from an AccessibilityService.
See also
setStateDescription
setContentDescription

setSystemGestureExclusionRects

Added in 1.2.0
java-static fun setSystemGestureExclusionRects(view: View, rects: (Mutable)List<Rect!>): Unit

Sets a list of areas within this view's post-layout coordinate space where the system should not intercept touch or other pointing device gestures. This method should be called by onLayout or onDraw.

On devices running API 28 and below, this method has no effect.

Parameters
view: View

view for which to set the exclusion rects.
rects: (Mutable)List<Rect!>

A list of precision gesture regions that this view needs to function correctly
See also
setSystemGestureExclusionRects

setTooltipText

Added in 1.1.0
java-static fun setTooltipText(view: View, tooltipText: CharSequence?): Unit

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

view for which to set the tooltip.
tooltipText: CharSequence?

the tooltip text

setTransitionName

Added in 1.1.0
java-static fun setTransitionName(view: View, transitionName: String?): Unit

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 1.1.0
Deprecated in 1.1.0
@ReplaceWith(expression = "view.setTranslationX(value)")
java-static fun setTranslationX(view: View!, value: Float): Unit

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!

view for which to set the translation.
value: Float

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

setTranslationY

Added in 1.1.0
Deprecated in 1.1.0
@ReplaceWith(expression = "view.setTranslationY(value)")
java-static fun setTranslationY(view: View!, value: Float): Unit

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.

name android:translationY

Parameters
view: View!

view for which to set the translation.
value: Float

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

setTranslationZ

Added in 1.1.0
java-static fun setTranslationZ(view: View, translationZ: Float): Unit

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

Parameters
view: View

view for which to set the translation.
translationZ: Float

the depth of location of this view relative its elevation.

setWindowInsetsAnimationCallback

Added in 1.5.0
java-static fun setWindowInsetsAnimationCallback(
    view: View,
    callback: WindowInsetsAnimationCompat.Callback?
): Unit

Sets a WindowInsetsAnimationCompat.Callback to be notified about animations of windows that cause insets.

The callback's dispatch mode will affect whether animation callbacks are dispatched to the children of this view.

Prior to API 30, if an OnApplyWindowInsetsListener is used on the same view, be sure to always use the ViewCompat version of setOnApplyWindowInsetsListener, otherwise the listener will be overridden by this method.

The insets dispatch needs to reach this view for the listener to be called. If any view consumed the insets earlier in the dispatch, this won't be called.

Prior to API 21, this method has no effect.

Parameters
view: View

view for which to set the callback.
callback: WindowInsetsAnimationCompat.Callback?

The callback to set, or null to remove the currently installed callback

setX

Added in 1.1.0
Deprecated in 1.1.0
@ReplaceWith(expression = "view.setX(value)")
java-static fun setX(view: View!, value: Float): Unit

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!

view to set the position on.
value: Float

The visual x position of this view, in pixels.

setY

Added in 1.1.0
Deprecated in 1.1.0
@ReplaceWith(expression = "view.setY(value)")
java-static fun setY(view: View!, value: Float): Unit

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!

view to set the position on.
value: Float

The visual y position of this view, in pixels.

setZ

Added in 1.1.0
java-static fun setZ(view: View, z: Float): Unit

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

view for which to set the position.
z: Float

The visual z position of this view, in pixels.

startDragAndDrop

Added in 1.1.0
java-static fun startDragAndDrop(
    v: View,
    data: ClipData?,
    shadowBuilder: View.DragShadowBuilder,
    myLocalState: Any?,
    flags: Int
): Boolean

Start the drag and drop operation.

startNestedScroll

Added in 1.1.0
java-static fun startNestedScroll(view: View, axes: Int): Boolean

Begin a nestable scroll operation along the given axes.

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

Parameters
view: View

view for which to start the scroll.
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.

startNestedScroll

Added in 1.1.0
java-static fun startNestedScroll(view: View, axes: Int, type: Int): Boolean

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. In the event of programmatic scrolling the caller must explicitly call stopNestedScroll 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.

Parameters
view: View

view on which to start the scroll.
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
dispatchNestedPreScroll
dispatchNestedScroll

stopNestedScroll

Added in 1.1.0
java-static fun stopNestedScroll(view: View): Unit

Stop a nested scroll in progress.

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

Parameters
view: View

view for which to stop the scroll.
See also
startNestedScroll

stopNestedScroll

Added in 1.1.0
java-static fun stopNestedScroll(view: View, type: Int): Unit

Stop a nested scroll in progress.

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

Parameters
view: View

view for which to stop the scroll.
type: Int

the type of input which cause this scroll event
See also
startNestedScroll

updateDragShadow

Added in 1.1.0
java-static fun updateDragShadow(v: View, shadowBuilder: View.DragShadowBuilder): Unit

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