ListViewAutoScrollHelper

Kotlin |Java

open class ListViewAutoScrollHelper : AutoScrollHelper

kotlin.Any
↳	androidx.core.widget.AutoScrollHelper
	↳	androidx.core.widget.ListViewAutoScrollHelper

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

Summary

Inherited constants

From class AutoScrollHelper Int EDGE_TYPE_INSIDE Edge type that specifies an activation area starting at the view bounds and extending inward. Moving outside the view bounds will stop scrolling. Int EDGE_TYPE_INSIDE_EXTEND Edge type that specifies an activation area starting at the view bounds and extending inward. After activation begins, moving outside the view bounds will continue scrolling. Int EDGE_TYPE_OUTSIDE Edge type that specifies an activation area starting at the view bounds and extending outward. Moving inside the view bounds will stop scrolling. Float NO_MAX Constant passed to setMaximumEdges, setMaximumVelocity, or setMinimumVelocity. Using this value ensures that the computed relative value is always used without constraining to a particular minimum or maximum value. Float NO_MIN Constant passed to setMaximumEdges, or setMaximumVelocity, or setMinimumVelocity. Using this value ensures that the computed relative value is always used without constraining to a particular minimum or maximum value. Float RELATIVE_UNSPECIFIED Constant passed to setRelativeEdges or setRelativeVelocity. Using this value ensures that the computed relative value is ignored and the absolute maximum value is always used.

Public constructors
<init>(@NonNull target: ListView)

Public methods
open Boolean	canTargetScrollHorizontally(direction: Int)
open Boolean	canTargetScrollVertically(direction: Int)
open Unit	scrollTargetBy(deltaX: Int, deltaY: Int)

Inherited functions

From class AutoScrollHelper Boolean isEnabled() Boolean isExclusive() Indicates whether the scroll helper handles touch events exclusively during scrolling. Boolean onTouch(v: View!, event: MotionEvent!) Handles touch events by activating automatic scrolling, adjusting scroll velocity, or stopping. If isExclusive() is false, always returns false so that the host view may handle touch events. Otherwise, returns true when automatic scrolling is active and false otherwise. AutoScrollHelper setActivationDelay(delayMillis: Int) Sets the delay after entering an activation edge before activation of auto-scrolling. By default, the activation delay is set to ViewConfiguration#getTapTimeout(). Specifying a delay of zero will start auto-scrolling immediately after the touch position enters an activation edge. AutoScrollHelper setEdgeType(type: Int) Sets the activation edge type, one of: EDGE_TYPE_INSIDE for edges that respond to touches inside the bounds of the host view. If touch moves outside the bounds, scrolling will stop. EDGE_TYPE_INSIDE_EXTEND for inside edges that continued to scroll when touch moves outside the bounds of the host view. EDGE_TYPE_OUTSIDE for edges that only respond to touches that move outside the bounds of the host view. AutoScrollHelper! setEnabled(enabled: Boolean) Sets whether the scroll helper is enabled and should respond to touch events. AutoScrollHelper! setExclusive(exclusive: Boolean) Enables or disables exclusive handling of touch events during scrolling. By default, exclusive handling is disabled and the target view receives all touch events. When enabled, onTouch will return true if the helper is currently scrolling and false otherwise. AutoScrollHelper setMaximumEdges(horizontalMax: Float, verticalMax: Float) Sets the absolute maximum edge size. If relative edge size is not specified, activation edges will always be the maximum edge size. If both relative and maximum edges are specified, the maximum edge will be used to constrain the calculated relative edge size. AutoScrollHelper setMaximumVelocity(horizontalMax: Float, verticalMax: Float) Sets the absolute maximum scrolling velocity. If relative velocity is