Save the date! Android Dev Summit is coming to Mountain View, CA on November 7-8, 2018.
added in version 1.0.0
belongs to Maven artifact androidx.core:core:1.1.0-alpha01

ListViewAutoScrollHelper

public class ListViewAutoScrollHelper
extends AutoScrollHelper

java.lang.Object
   ↳ androidx.core.widget.AutoScrollHelper
     ↳ androidx.core.widget.ListViewAutoScrollHelper


An implementation of AutoScrollHelper that knows how to scroll through a ListView.

Summary

Inherited constants

Public constructors

ListViewAutoScrollHelper(ListView target)

Public methods

boolean canTargetScrollHorizontally(int direction)

Override this method to return whether the target view can be scrolled horizontally in a certain direction.

boolean canTargetScrollVertically(int direction)

Override this method to return whether the target view can be scrolled vertically in a certain direction.

void scrollTargetBy(int deltaX, int deltaY)

Override this method to scroll the target view by the specified number of pixels.

Inherited methods

Public constructors

ListViewAutoScrollHelper

added in version 1.0.0
public ListViewAutoScrollHelper (ListView target)

Parameters
target ListView

Public methods

canTargetScrollHorizontally

added in version 1.0.0
public 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 1.0.0
public 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 1.0.0
public 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.