com.handmark.pulltorefresh.library

Class OverscrollHelper

java.lang.Object

com.handmark.pulltorefresh.library.OverscrollHelper

public final class OverscrollHelper
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
OverscrollHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static void	overScrollBy(PullToRefreshBase<?> view, int deltaX, int scrollX, int deltaY, int scrollY, boolean isTouchEvent) Helper method for Overscrolling that encapsulates all of the necessary function.
static void	overScrollBy(PullToRefreshBase<?> view, int deltaX, int scrollX, int deltaY, int scrollY, int scrollRange, boolean isTouchEvent) Helper method for Overscrolling that encapsulates all of the necessary function.
static void	overScrollBy(PullToRefreshBase<?> view, int deltaX, int scrollX, int deltaY, int scrollY, int scrollRange, int fuzzyThreshold, float scaleFactor, boolean isTouchEvent) Helper method for Overscrolling that encapsulates all of the necessary function.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OverscrollHelper

public OverscrollHelper()

Method Detail

overScrollBy

public static void overScrollBy(PullToRefreshBase<?> view,
                int deltaX,
                int scrollX,
                int deltaY,
                int scrollY,
                boolean isTouchEvent)

Helper method for Overscrolling that encapsulates all of the necessary function.

This should only be used on AdapterView's such as ListView as it just calls through to overScrollBy() with the scrollRange = 0. AdapterView's do not have a scroll range (i.e. getScrollY() doesn't work).

Parameters:

view - - PullToRefreshView that is calling this.

deltaX - - Change in X in pixels, passed through from from overScrollBy call

scrollX - - Current X scroll value in pixels before applying deltaY, passed through from from overScrollBy call

deltaY - - Change in Y in pixels, passed through from from overScrollBy call

scrollY - - Current Y scroll value in pixels before applying deltaY, passed through from from overScrollBy call

isTouchEvent - - true if this scroll operation is the result of a touch event, passed through from from overScrollBy call

overScrollBy

public static void overScrollBy(PullToRefreshBase<?> view,
                int deltaX,
                int scrollX,
                int deltaY,
                int scrollY,
                int scrollRange,
                boolean isTouchEvent)

Helper method for Overscrolling that encapsulates all of the necessary function. This version of the call is used for Views that need to specify a Scroll Range but scroll back to it's edge correctly.

Parameters:

view - - PullToRefreshView that is calling this.

deltaX - - Change in X in pixels, passed through from from overScrollBy call

scrollX - - Current X scroll value in pixels before applying deltaY, passed through from from overScrollBy call

deltaY - - Change in Y in pixels, passed through from from overScrollBy call

scrollY - - Current Y scroll value in pixels before applying deltaY, passed through from from overScrollBy call

scrollRange - - Scroll Range of the View, specifically needed for ScrollView

isTouchEvent - - true if this scroll operation is the result of a touch event, passed through from from overScrollBy call

overScrollBy

public static void overScrollBy(PullToRefreshBase<?> view,
                int deltaX,
                int scrollX,
                int deltaY,
                int scrollY,
                int scrollRange,
                int fuzzyThreshold,
                float scaleFactor,
                boolean isTouchEvent)

Helper method for Overscrolling that encapsulates all of the necessary function. This is the advanced version of the call.

Parameters:

view - - PullToRefreshView that is calling this.

deltaX - - Change in X in pixels, passed through from from overScrollBy call

scrollX - - Current X scroll value in pixels before applying deltaY, passed through from from overScrollBy call

deltaY - - Change in Y in pixels, passed through from from overScrollBy call

scrollY - - Current Y scroll value in pixels before applying deltaY, passed through from from overScrollBy call

scrollRange - - Scroll Range of the View, specifically needed for ScrollView

fuzzyThreshold - - Threshold for which the values how fuzzy we should treat the other values. Needed for WebView as it doesn't always scroll back to it's edge. 0 = no fuzziness.

scaleFactor - - Scale Factor for overscroll amount

isTouchEvent - - true if this scroll operation is the result of a touch event, passed through from from overScrollBy call