OverScroller

OverScroller

OverScroller(context: Context!)

Creates an OverScroller with a viscous fluid scroll interpolator and flywheel.

OverScroller

OverScroller(
    context: Context!, 
    interpolator: Interpolator!)

Creates an OverScroller with flywheel enabled.

OverScroller

OverScroller(
    context: Context!, 
    interpolator: Interpolator!, 
    bounceCoefficientX: Float, 
    bounceCoefficientY: Float)

Deprecated: Use OverScroller(android.content.Context,android.view.animation.Interpolator) instead.

Creates an OverScroller with flywheel enabled.

OverScroller

OverScroller(
    context: Context!, 
    interpolator: Interpolator!, 
    bounceCoefficientX: Float, 
    bounceCoefficientY: Float, 
    flywheel: Boolean)

Deprecated: Use OverScroller(android.content.Context,android.view.animation.Interpolator) instead.

Creates an OverScroller.

abortAnimation

open fun abortAnimation(): Unit

Stops the animation. Contrary to forceFinished(boolean), aborting the animating causes the scroller to move to the final x and y positions.

computeScrollOffset

open fun computeScrollOffset(): Boolean

Call this when you want to know the new location. If it returns true, the animation is not yet finished.

fling

open fun fling(
    startX: Int, 
    startY: Int, 
    velocityX: Int, 
    velocityY: Int, 
    minX: Int, 
    maxX: Int, 
    minY: Int, 
    maxY: Int
): Unit

fling

open fun fling(
    startX: Int, 
    startY: Int, 
    velocityX: Int, 
    velocityY: Int, 
    minX: Int, 
    maxX: Int, 
    minY: Int, 
    maxY: Int, 
    overX: Int, 
    overY: Int
): Unit

Start scrolling based on a fling gesture. The distance traveled will depend on the initial velocity of the fling.

forceFinished

fun forceFinished(finished: Boolean): Unit

Force the finished field to a particular value. Contrary to abortAnimation(), forcing the animation to finished does NOT cause the scroller to move to the final x and y position.

getCurrVelocity

open fun getCurrVelocity(): Float

Returns the absolute value of the current velocity.

getCurrX

fun getCurrX(): Int

Returns the current X offset in the scroll.

getCurrY

fun getCurrY(): Int

Returns the current Y offset in the scroll.

getFinalX

fun getFinalX(): Int

Returns where the scroll will end. Valid only for "fling" scrolls.

getFinalY

fun getFinalY(): Int

Returns where the scroll will end. Valid only for "fling" scrolls.

getStartX

fun getStartX(): Int

Returns the start X offset in the scroll.

getStartY

fun getStartY(): Int

Returns the start Y offset in the scroll.

isFinished

fun isFinished(): Boolean

Returns whether the scroller has finished scrolling.

isOverScrolled

open fun isOverScrolled(): Boolean

Returns whether the current Scroller is currently returning to a valid position. Valid bounds were provided by the fling(int,int,int,int,int,int,int,int,int,int) method. One should check this value before calling startScroll(int,int,int,int) as the interpolation currently in progress to restore a valid position will then be stopped. The caller has to take into account the fact that the started scroll will start from an overscrolled position.

notifyHorizontalEdgeReached

open fun notifyHorizontalEdgeReached(
    startX: Int, 
    finalX: Int, 
    overX: Int
): Unit

Notify the scroller that we've reached a horizontal boundary. Normally the information to handle this will already be known when the animation is started, such as in a call to one of the fling functions. However there are cases where this cannot be known in advance. This function will transition the current motion and animate from startX to finalX as appropriate.

notifyVerticalEdgeReached

open fun notifyVerticalEdgeReached(
    startY: Int, 
    finalY: Int, 
    overY: Int
): Unit

Notify the scroller that we've reached a vertical boundary. Normally the information to handle this will already be known when the animation is started, such as in a call to one of the fling functions. However there are cases where this cannot be known in advance. This function will animate a parabolic motion from startY to finalY.

setFriction

fun setFriction(friction: Float): Unit

The amount of friction applied to flings. The default value is ViewConfiguration#getScrollFriction.

springBack

open fun springBack(
    startX: Int, 
    startY: Int, 
    minX: Int, 
    maxX: Int, 
    minY: Int, 
    maxY: Int
): Boolean

Call this when you want to 'spring back' into a valid coordinate range.

startScroll

open fun startScroll(
    startX: Int, 
    startY: Int, 
    dx: Int, 
    dy: Int
): Unit

Start scrolling by providing a starting point and the distance to travel. The scroll will use the default value of 250 milliseconds for the duration.

startScroll

open fun startScroll(
    startX: Int, 
    startY: Int, 
    dx: Int, 
    dy: Int, 
    duration: Int
): Unit

Start scrolling by providing a starting point and the distance to travel.