LinearSnapHelper

Kotlin |Java

open class LinearSnapHelper : SnapHelper

kotlin.Any
↳	androidx.recyclerview.widget.RecyclerView.OnFlingListener
	↳	androidx.recyclerview.widget.SnapHelper
		↳	androidx.recyclerview.widget.LinearSnapHelper

Implementation of the SnapHelper supporting snapping in either vertical or horizontal orientation.

The implementation will snap the center of the target child view to the center of the attached RecyclerView. If you intend to change this behavior then override SnapHelper#calculateDistanceToFinalSnap.

Summary

Public constructors
`<init>()` Implementation of the `SnapHelper` supporting snapping in either vertical or horizontal orientation.

Public methods
open IntArray?	`calculateDistanceToFinalSnap(@NonNull layoutManager: RecyclerView.LayoutManager, @NonNull targetView: View)`
open View?	`findSnapView(layoutManager: RecyclerView.LayoutManager!)`
open Int	`findTargetSnapPosition(layoutManager: RecyclerView.LayoutManager!, velocityX: Int, velocityY: Int)`

Inherited functions

From class SnapHelper

`Unit`	`attachToRecyclerView(@Nullable recyclerView: RecyclerView?)` Attaches the `SnapHelper` to the provided RecyclerView, by calling `RecyclerView#setOnFlingListener(RecyclerView.OnFlingListener)`. You can call this method with `null` to detach it from the current RecyclerView.
`IntArray!`	`calculateScrollDistance(velocityX: Int, velocityY: Int)` Calculated the estimated scroll distance in each direction given velocities on both axes.
`RecyclerView.SmoothScroller?`	`createScroller(@NonNull layoutManager: RecyclerView.LayoutManager)` Creates a scroller to be used in the snapping implementation.
`LinearSmoothScroller?`	`createSnapScroller(@NonNull layoutManager: RecyclerView.LayoutManager)` Creates a scroller to be used in the snapping implementation.
`Boolean`	`onFling(velocityX: Int, velocityY: Int)`

Public constructors

<init>

LinearSnapHelper()

Implementation of the SnapHelper supporting snapping in either vertical or horizontal orientation.

Public methods

calculateDistanceToFinalSnap

open fun calculateDistanceToFinalSnap(
    @NonNull layoutManager: RecyclerView.LayoutManager, 
    @NonNull targetView: View
): IntArray?

findSnapView

open fun findSnapView(layoutManager: RecyclerView.LayoutManager!): View?

findTargetSnapPosition

open fun findTargetSnapPosition(
    layoutManager: RecyclerView.LayoutManager!, 
    velocityX: Int, 
    velocityY: Int
): Int