# ListViewAutoScrollHelper
added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
belongs to Maven artifact com.android.support:support-compat:28.0.0-alpha1
Summary:[Inherited Constants](https://developer.android.com/reference/android/support/v4/widget/ListViewAutoScrollHelper#inhconstants)\|[Ctors](https://developer.android.com/reference/android/support/v4/widget/ListViewAutoScrollHelper#pubctors)\|[Methods](https://developer.android.com/reference/android/support/v4/widget/ListViewAutoScrollHelper#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/support/v4/widget/ListViewAutoScrollHelper#inhmethods)\|[\[Expand All\]](https://developer.android.com/reference/android/support/v4/widget/ListViewAutoScrollHelper#)
# ListViewAutoScrollHelper
| This package is part of the Android[support library](https://developer.android.com/topic/libraries/support-library)which is no longer maintained. The support library has been superseded by[AndroidX](https://developer.android.com/jetpack/androidx)which is part of[Jetpack](https://developer.android.com/jetpack). We recommend using the AndroidX libraries in all new projects. You should also consider[migrating](https://developer.android.com/jetpack/androidx/migrate)existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library[class mappings](https://developer.android.com/jetpack/androidx/migrate/class-mappings).
`
public
class
ListViewAutoScrollHelper
`
`
``
extends `[AutoScrollHelper](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper)`
``
`
|---|---|----------------------------------------------------|
| java.lang.Object |||
| ↳ | [android.support.v4.widget.AutoScrollHelper](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper) ||
| | ↳ | android.support.v4.widget.ListViewAutoScrollHelper |
*** ** * ** ***
An implementation of[AutoScrollHelper](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper)that knows how to scroll through a[ListView](https://developer.android.com/reference/android/widget/ListView.html).
## Summary
| ### Inherited constants |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [](https://developer.android.com/reference/android/support/v4/widget/ListViewAutoScrollHelper#)From class` `[android.support.v4.widget.AutoScrollHelper](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper)` ` |---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | [EDGE_TYPE_INSIDE](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#EDGE_TYPE_INSIDE) Edge type that specifies an activation area starting at the view bounds and extending inward. | | `int` | [EDGE_TYPE_INSIDE_EXTEND](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#EDGE_TYPE_INSIDE_EXTEND) Edge type that specifies an activation area starting at the view bounds and extending inward. | | `int` | [EDGE_TYPE_OUTSIDE](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#EDGE_TYPE_OUTSIDE) Edge type that specifies an activation area starting at the view bounds and extending outward. | | `float` | [NO_MAX](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#NO_MAX) Constant passed to[setMaximumEdges(float, float)](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#setMaximumEdges(float, float)),[setMaximumVelocity(float, float)](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#setMaximumVelocity(float, float)), or[setMinimumVelocity(float, float)](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#setMinimumVelocity(float, float)). | | `float` | [NO_MIN](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#NO_MIN) Constant passed to[setMaximumEdges(float, float)](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#setMaximumEdges(float, float)), or[setMaximumVelocity(float, float)](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#setMaximumVelocity(float, float)), or[setMinimumVelocity(float, float)](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#setMinimumVelocity(float, float)). | | `float` | [RELATIVE_UNSPECIFIED](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#RELATIVE_UNSPECIFIED) Constant passed to[setRelativeEdges(float, float)](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#setRelativeEdges(float, float))or[setRelativeVelocity(float, float)](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#setRelativeVelocity(float, float)). | |
| ### Public constructors ||
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[ListViewAutoScrollHelper](https://developer.android.com/reference/android/support/v4/widget/ListViewAutoScrollHelper#ListViewAutoScrollHelper(android.widget.ListView))`(`[ListView](https://developer.android.com/reference/android/widget/ListView.html)` target) ` |
| ### Public methods ||
|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` boolean` | ` `[canTargetScrollHorizontally](https://developer.android.com/reference/android/support/v4/widget/ListViewAutoScrollHelper#canTargetScrollHorizontally(int))`(int direction) ` Override this method to return whether the target view can be scrolled horizontally in a certain direction. |
| ` boolean` | ` `[canTargetScrollVertically](https://developer.android.com/reference/android/support/v4/widget/ListViewAutoScrollHelper#canTargetScrollVertically(int))`(int direction) ` Override this method to return whether the target view can be scrolled vertically in a certain direction. |
| ` void` | ` `[scrollTargetBy](https://developer.android.com/reference/android/support/v4/widget/ListViewAutoScrollHelper#scrollTargetBy(int, int))`(int deltaX, int deltaY) ` Override this method to scroll the target view by the specified number of pixels. |
| ### Inherited methods |
|-----------------------|---|
| [](https://developer.android.com/reference/android/support/v4/widget/ListViewAutoScrollHelper#)From class` `[android.support.v4.widget.AutoScrollHelper](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper)` ` |-----------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract boolean` | ` `[canTargetScrollHorizontally](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#canTargetScrollHorizontally(int))`(int direction) ` Override this method to return whether the target view can be scrolled horizontally in a certain direction. | | ` abstract boolean` | ` `[canTargetScrollVertically](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#canTargetScrollVertically(int))`(int direction) ` Override this method to return whether the target view can be scrolled vertically in a certain direction. | | ` boolean` | ` `[isEnabled](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#isEnabled())`() ` | | ` boolean` | ` `[isExclusive](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#isExclusive())`() ` Indicates whether the scroll helper handles touch events exclusively during scrolling. | | ` boolean` | ` `[onTouch](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#onTouch(android.view.View, android.view.MotionEvent))`(`[View](https://developer.android.com/reference/android/view/View.html)` v, `[MotionEvent](https://developer.android.com/reference/android/view/MotionEvent.html)` event) ` Handles touch events by activating automatic scrolling, adjusting scroll velocity, or stopping. | | ` abstract void` | ` `[scrollTargetBy](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#scrollTargetBy(int, int))`(int deltaX, int deltaY) ` Override this method to scroll the target view by the specified number of pixels. | | ` `[AutoScrollHelper](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper) | ` `[setActivationDelay](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#setActivationDelay(int))`(int delayMillis) ` Sets the delay after entering an activation edge before activation of auto-scrolling. | | ` `[AutoScrollHelper](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper) | ` `[setEdgeType](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#setEdgeType(int))`(int type) ` Sets the activation edge type, one of: - [EDGE_TYPE_INSIDE](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#EDGE_TYPE_INSIDE)for edges that respond to touches inside the bounds of the host view.
| | ` `[AutoScrollHelper](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper) | ` `[setEnabled](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#setEnabled(boolean))`(boolean enabled) ` Sets whether the scroll helper is enabled and should respond to touch events. | | ` `[AutoScrollHelper](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper) | ` `[setExclusive](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#setExclusive(boolean))`(boolean exclusive) ` Enables or disables exclusive handling of touch events during scrolling. | | ` `[AutoScrollHelper](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper) | ` `[setMaximumEdges](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#setMaximumEdges(float, float))`(float horizontalMax, float verticalMax) ` Sets the absolute maximum edge size. | | ` `[AutoScrollHelper](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper) | ` `[setMaximumVelocity](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#setMaximumVelocity(float, float))`(float horizontalMax, float verticalMax) ` Sets the absolute maximum scrolling velocity. | | ` `[AutoScrollHelper](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper) | ` `[setMinimumVelocity](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#setMinimumVelocity(float, float))`(float horizontalMin, float verticalMin) ` Sets the absolute minimum scrolling velocity. | | ` `[AutoScrollHelper](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper) | ` `[setRampDownDuration](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#setRampDownDuration(int))`(int durationMillis) ` Sets the amount of time after de-activation of auto-scrolling that is takes to slow to a stop. | | ` `[AutoScrollHelper](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper) | ` `[setRampUpDuration](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#setRampUpDuration(int))`(int durationMillis) ` Sets the amount of time after activation of auto-scrolling that is takes to reach target velocity for the current touch position. | | ` `[AutoScrollHelper](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper) | ` `[setRelativeEdges](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#setRelativeEdges(float, float))`(float horizontal, float vertical) ` Sets the activation edge size relative to the host view's dimensions. | | ` `[AutoScrollHelper](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper) | ` `[setRelativeVelocity](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper#setRelativeVelocity(float, float))`(float horizontal, float vertical) ` Sets the target scrolling velocity relative to the host view's dimensions. | ||
| [](https://developer.android.com/reference/android/support/v4/widget/ListViewAutoScrollHelper#)From class` java.lang.Object ` |-------------------|-------------------------------| | ` Object` | ` clone() ` | | ` boolean` | ` equals(Object arg0) ` | | ` void` | ` finalize() ` | | ` final Class` | ` getClass() ` | | ` int` | ` hashCode() ` | | ` final void` | ` notify() ` | | ` final void` | ` notifyAll() ` | | ` String` | ` toString() ` | | ` final void` | ` wait(long arg0, int arg1) ` | | ` final void` | ` wait(long arg0) ` | | ` final void` | ` wait() ` | ||
| [](https://developer.android.com/reference/android/support/v4/widget/ListViewAutoScrollHelper#)From interface` `[android.view.View.OnTouchListener](https://developer.android.com/reference/android/view/View.OnTouchListener.html)` ` |---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract boolean` | ` onTouch(`[View](https://developer.android.com/reference/android/view/View.html)` arg0, `[MotionEvent](https://developer.android.com/reference/android/view/MotionEvent.html)` arg1) ` | ||
## Public constructors
### ListViewAutoScrollHelper
added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
ListViewAutoScrollHelper (ListView target)
```
| Parameters ||
|----------|-------------------|
| `target` | `ListView`
|
## Public methods
### canTargetScrollHorizontally
added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
boolean canTargetScrollHorizontally (int direction)
```
Override this method to return whether the target view can be scrolled horizontally in a certain direction.
| Parameters ||
|-------------|------------------------------------------------------------------------------------|
| `direction` | `int`: Negative to check scrolling left, positive to check scrolling right.
|
| Returns ||
|-----------|-------------------------------------------------------------------------------------------|
| `boolean` | true if the target view is able to horizontally scroll in the specified direction.
|
### canTargetScrollVertically
added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
boolean canTargetScrollVertically (int direction)
```
Override this method to return whether the target view can be scrolled vertically in a certain direction.
| Parameters ||
|-------------|---------------------------------------------------------------------------------|
| `direction` | `int`: Negative to check scrolling up, positive to check scrolling down.
|
| Returns ||
|-----------|-----------------------------------------------------------------------------------------|
| `boolean` | true if the target view is able to vertically scroll in the specified direction.
|
### scrollTargetBy
added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions)
```
void scrollTargetBy (int deltaX,
int deltaY)
```
Override this method to scroll the target view by the specified number of pixels.
| Parameters ||
|----------|---------------------------------------------------------------|
| `deltaX` | `int`: The number of pixels to scroll by horizontally.
|
| `deltaY` | `int`: The number of pixels to scroll by vertically.
|
-
## Interfaces
- [DrawerLayout.DrawerListener](https://developer.android.com/reference/android/support/v4/widget/DrawerLayout.DrawerListener)
- [NestedScrollView.OnScrollChangeListener](https://developer.android.com/reference/android/support/v4/widget/NestedScrollView.OnScrollChangeListener)
- [SimpleCursorAdapter.CursorToStringConverter](https://developer.android.com/reference/android/support/v4/widget/SimpleCursorAdapter.CursorToStringConverter)
- [SimpleCursorAdapter.ViewBinder](https://developer.android.com/reference/android/support/v4/widget/SimpleCursorAdapter.ViewBinder)
- [SlidingPaneLayout.PanelSlideListener](https://developer.android.com/reference/android/support/v4/widget/SlidingPaneLayout.PanelSlideListener)
- [SwipeRefreshLayout.OnChildScrollUpCallback](https://developer.android.com/reference/android/support/v4/widget/SwipeRefreshLayout.OnChildScrollUpCallback)
- [SwipeRefreshLayout.OnRefreshListener](https://developer.android.com/reference/android/support/v4/widget/SwipeRefreshLayout.OnRefreshListener)
- [TintableCompoundButton](https://developer.android.com/reference/android/support/v4/widget/TintableCompoundButton)
-
## Classes
- [AutoScrollHelper](https://developer.android.com/reference/android/support/v4/widget/AutoScrollHelper)
- [CircularProgressDrawable](https://developer.android.com/reference/android/support/v4/widget/CircularProgressDrawable)
- [CompoundButtonCompat](https://developer.android.com/reference/android/support/v4/widget/CompoundButtonCompat)
- [ContentLoadingProgressBar](https://developer.android.com/reference/android/support/v4/widget/ContentLoadingProgressBar)
- [CursorAdapter](https://developer.android.com/reference/android/support/v4/widget/CursorAdapter)
- [DrawerLayout](https://developer.android.com/reference/android/support/v4/widget/DrawerLayout)
- [DrawerLayout.LayoutParams](https://developer.android.com/reference/android/support/v4/widget/DrawerLayout.LayoutParams)
- [DrawerLayout.SavedState](https://developer.android.com/reference/android/support/v4/widget/DrawerLayout.SavedState)
- [DrawerLayout.SimpleDrawerListener](https://developer.android.com/reference/android/support/v4/widget/DrawerLayout.SimpleDrawerListener)
- [EdgeEffectCompat](https://developer.android.com/reference/android/support/v4/widget/EdgeEffectCompat)
- [ExploreByTouchHelper](https://developer.android.com/reference/android/support/v4/widget/ExploreByTouchHelper)
- [ImageViewCompat](https://developer.android.com/reference/android/support/v4/widget/ImageViewCompat)
- [ListPopupWindowCompat](https://developer.android.com/reference/android/support/v4/widget/ListPopupWindowCompat)
- [ListViewAutoScrollHelper](https://developer.android.com/reference/android/support/v4/widget/ListViewAutoScrollHelper)
- [ListViewCompat](https://developer.android.com/reference/android/support/v4/widget/ListViewCompat)
- [NestedScrollView](https://developer.android.com/reference/android/support/v4/widget/NestedScrollView)
- [PopupMenuCompat](https://developer.android.com/reference/android/support/v4/widget/PopupMenuCompat)
- [PopupWindowCompat](https://developer.android.com/reference/android/support/v4/widget/PopupWindowCompat)
- [ResourceCursorAdapter](https://developer.android.com/reference/android/support/v4/widget/ResourceCursorAdapter)
- [ScrollerCompat](https://developer.android.com/reference/android/support/v4/widget/ScrollerCompat)
- [SimpleCursorAdapter](https://developer.android.com/reference/android/support/v4/widget/SimpleCursorAdapter)
- [SlidingPaneLayout](https://developer.android.com/reference/android/support/v4/widget/SlidingPaneLayout)
- [SlidingPaneLayout.LayoutParams](https://developer.android.com/reference/android/support/v4/widget/SlidingPaneLayout.LayoutParams)
- [SlidingPaneLayout.SimplePanelSlideListener](https://developer.android.com/reference/android/support/v4/widget/SlidingPaneLayout.SimplePanelSlideListener)
- [Space](https://developer.android.com/reference/android/support/v4/widget/Space)
- [SwipeRefreshLayout](https://developer.android.com/reference/android/support/v4/widget/SwipeRefreshLayout)
- [TextViewCompat](https://developer.android.com/reference/android/support/v4/widget/TextViewCompat)
- [ViewDragHelper](https://developer.android.com/reference/android/support/v4/widget/ViewDragHelper)
- [ViewDragHelper.Callback](https://developer.android.com/reference/android/support/v4/widget/ViewDragHelper.Callback)