Added in API level 31

Summary: Ctors | Methods | Inherited Methods

ScrollCaptureTarget

Kotlin |Java

public final class ScrollCaptureTarget
extends Object

java.lang.Object
↳	android.view.ScrollCaptureTarget

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

Summary

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

Public methods
`ScrollCaptureCallback`	`getCallback()`
`View`	`getContainingView()`
`int`	`getHint()`
`Rect`	`getLocalVisibleRect()` Returns the visible bounds of the containing view.
`Point`	`getPositionInWindow()`
`Rect`	`getScrollBounds()`
`void`	`setScrollBounds(Rect scrollBounds)` Sets the scroll bounds rect to the intersection of provided rect and the current bounds of the `containing view`.
`String`	`toString()` Returns a string representation of the object.
`void`	`updatePositionInWindow()` Refresh the local visible bounds and its offset within the window, based on the current state of the `containing view`.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

ScrollCaptureTarget

Added in API level 31

public ScrollCaptureTarget (View scrollTarget, 
                Rect localVisibleRect, 
                Point positionInWindow, 
                ScrollCaptureCallback callback)

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

public ScrollCaptureCallback getCallback ()

Returns
`ScrollCaptureCallback`	the `ScrollCaptureCallback` for this target. This value cannot be `null`.

getContainingView

Added in API level 31

public View getContainingView ()

Returns
`View`	the `containing view` for this `callback` This value cannot be `null`.

getHint

Added in API level 31

public int getHint ()

Returns
`int`	the hint that the `containing view` had during the scroll capture search. Value is either `0` or a combination of the following: `View.SCROLL_CAPTURE_HINT_AUTO` `View.SCROLL_CAPTURE_HINT_EXCLUDE` `View.SCROLL_CAPTURE_HINT_INCLUDE` `View.SCROLL_CAPTURE_HINT_EXCLUDE_DESCENDANTS`

See also:

View.getScrollCaptureHint()

getLocalVisibleRect

Added in API level 31

public Rect getLocalVisibleRect ()

Returns the visible bounds of the containing view.

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

getPositionInWindow

Added in API level 31

public Point getPositionInWindow ()

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

public Rect getScrollBounds ()

Returns
`Rect`	the `scroll bounds` for this `callback` This value may be `null`.

See also:

ScrollCaptureCallback.onScrollCaptureSearch(CancellationSignal, Consumer)

setScrollBounds

Added in API level 31

public void setScrollBounds (Rect scrollBounds)

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

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

updatePositionInWindow

Added in API level 31

public void updatePositionInWindow ()

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.