# Print output for @column tags ?> ScrollCaptureTarget - Android SDK | Android Developers

Most visited

Recently visited

ScrollCaptureTarget

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

Public constructors

ScrollCaptureTarget

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

public ScrollCaptureCallback getCallback ()

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

getContainingView

public View getContainingView ()

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

getHint

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 View.SCROLL_CAPTURE_HINT_AUTO, View.SCROLL_CAPTURE_HINT_EXCLUDE, View.SCROLL_CAPTURE_HINT_INCLUDE, and View.SCROLL_CAPTURE_HINT_EXCLUDE_DESCENDANTS

See also:

getLocalVisibleRect

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

public Point getPositionInWindow ()

Returns
Point the position of the visible bounds of the containing view within the window This value cannot be null.

getScrollBounds

public Rect getScrollBounds ()

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

See also:

setScrollBounds

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

public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of the object.

updatePositionInWindow

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.