Added in API level 31

ScrollCaptureTarget

class ScrollCaptureTarget
kotlin.Any
   ↳ android.view.ScrollCaptureTarget

A target collects the set of contextual information for a ScrollCaptureHandler discovered during a scroll capture search.

Summary

Public constructors
ScrollCaptureTarget(scrollTarget: View, localVisibleRect: Rect, positionInWindow: Point, callback: ScrollCaptureCallback)
Public methods
ScrollCaptureCallback

View

Int

Rect

Returns the visible bounds of the containing view.
Point

Rect?

Unit
setScrollBounds(scrollBounds: Rect?)

Sets the scroll bounds rect to the intersection of provided rect and the current bounds of the containing view.
String

Unit

Refresh the local visible bounds and its offset within the window, based on the current state of the containing view.

Public constructors

ScrollCaptureTarget

Added in API level 31
ScrollCaptureTarget(
    scrollTarget: View, 
    localVisibleRect: Rect, 
    positionInWindow: Point, 
    callback: ScrollCaptureCallback)
Parameters
scrollTarget View: This value cannot be null.
localVisibleRect Rect: This value cannot be null.
positionInWindow Point: This value cannot be null.
callback ScrollCaptureCallback: This value cannot be null.

Public methods

getCallback

Added in API level 31
fun getCallback(): ScrollCaptureCallback
Return
ScrollCaptureCallback the ScrollCaptureCallback for this target This value cannot be null.

getContainingView

Added in API level 31
fun getContainingView(): View
Return
View the containing view for this callback This value cannot be null.

getHint

Added in API level 31
fun getHint(): Int
Return
Int the hint that the containing view had during the scroll capture search Value is either 0 or a combination of android.view.View#SCROLL_CAPTURE_HINT_AUTO, android.view.View#SCROLL_CAPTURE_HINT_EXCLUDE, android.view.View#SCROLL_CAPTURE_HINT_INCLUDE, and android.view.View#SCROLL_CAPTURE_HINT_EXCLUDE_DESCENDANTS

getLocalVisibleRect

Added in API level 31
fun getLocalVisibleRect(): Rect

Returns the visible bounds of the containing view.

Return
Rect the visible bounds of the containing view in view-local coordinates This value cannot be null.

getPositionInWindow

Added in API level 31
fun getPositionInWindow(): Point
Return
Point the position of the visible bounds of the containing view within the window This value cannot be null.

getScrollBounds

Added in API level 31
fun getScrollBounds(): Rect?
Return
Rect? the scroll bounds for this callback This value may be null.

setScrollBounds

Added in API level 31
fun setScrollBounds(scrollBounds: Rect?): Unit

Sets the scroll bounds rect to the intersection of provided rect and the current bounds of the containing view.

Parameters
scrollBounds Rect?: This value may be null.

toString

Added in API level 31
fun toString(): String
Return
String a string representation of the object.

updatePositionInWindow

Added in API level 31
fun updatePositionInWindow(): Unit

Refresh the local visible bounds and its offset within the window, based on the current state of the containing view.
This method must be called on the thread that originally created this UI element. This is typically the main thread of your app.