com.handmark.pulltorefresh.library

Interface IPullToRefresh<T extends android.view.View>

All Known Implementing Classes:

PullToRefreshAdapterViewBase, PullToRefreshBase, PullToRefreshExpandableListView, PullToRefreshGridView, PullToRefreshHorizontalScrollView, PullToRefreshListView, PullToRefreshScrollView, PullToRefreshWebView, PullToRefreshWebView2

public interface IPullToRefresh<T extends android.view.View>

Method Summary

Methods

Modifier and Type	Method and Description
boolean	demo() Demos the Pull-to-Refresh functionality to the user so that they are aware it is there.
PullToRefreshBase.Mode	getCurrentMode() Get the mode that this view is currently in.
boolean	getFilterTouchEvents() Returns whether the Touch Events are filtered or not.
ILoadingLayout	getLoadingLayoutProxy() Returns a proxy object which allows you to call methods on all of the LoadingLayouts (the Views which show when Pulling/Refreshing).
ILoadingLayout	getLoadingLayoutProxy(boolean includeStart, boolean includeEnd) Returns a proxy object which allows you to call methods on the LoadingLayouts (the Views which show when Pulling/Refreshing).
PullToRefreshBase.Mode	getMode() Get the mode that this view has been set to.
T	getRefreshableView() Get the Wrapped Refreshable View.
boolean	getShowViewWhileRefreshing() Get whether the 'Refreshing' View should be automatically shown when refreshing.
PullToRefreshBase.State	getState()
boolean	isPullToRefreshEnabled() Whether Pull-to-Refresh is enabled
boolean	isPullToRefreshOverScrollEnabled() Gets whether Overscroll support is enabled.
boolean	isRefreshing() Returns whether the Widget is currently in the Refreshing mState
boolean	isScrollingWhileRefreshingEnabled() Returns whether the widget has enabled scrolling on the Refreshable View while refreshing.
void	onRefreshComplete() Mark the current Refresh as complete.
void	setFilterTouchEvents(boolean filterEvents) Set the Touch Events to be filtered or not.
void	setMode(PullToRefreshBase.Mode mode) Set the mode of Pull-to-Refresh that this view will use.
void	setOnPullEventListener(PullToRefreshBase.OnPullEventListener<T> listener) Set OnPullEventListener for the Widget
void	setOnRefreshListener(PullToRefreshBase.OnRefreshListener<T> listener) Set OnRefreshListener for the Widget
void	setOnRefreshListener(PullToRefreshBase.OnRefreshListener2<T> listener) Set OnRefreshListener for the Widget
void	setPullToRefreshOverScrollEnabled(boolean enabled) Sets whether Overscroll support is enabled.
void	setRefreshing() Sets the Widget to be in the refresh state.
void	setRefreshing(boolean doScroll) Sets the Widget to be in the refresh state.
void	setScrollAnimationInterpolator(android.view.animation.Interpolator interpolator) Sets the Animation Interpolator that is used for animated scrolling.
void	setScrollingWhileRefreshingEnabled(boolean scrollingWhileRefreshingEnabled) By default the Widget disables scrolling on the Refreshable View while refreshing.
void	setShowViewWhileRefreshing(boolean showView) A mutator to enable/disable whether the 'Refreshing' View should be automatically shown when refreshing.

Method Detail

demo

boolean demo()

Demos the Pull-to-Refresh functionality to the user so that they are aware it is there. This could be useful when the user first opens your app, etc. The animation will only happen if the Refresh View (ListView, ScrollView, etc) is in a state where a Pull-to-Refresh could occur by a user's touch gesture (i.e. scrolled to the top/bottom).

Returns:

true - if the Demo has been started, false if not.

getCurrentMode

PullToRefreshBase.Mode getCurrentMode()

Get the mode that this view is currently in. This is only really useful when using Mode.BOTH.

Returns:

Mode that the view is currently in

getFilterTouchEvents

boolean getFilterTouchEvents()

Returns whether the Touch Events are filtered or not. If true is returned, then the View will only use touch events where the difference in the Y-axis is greater than the difference in the X-axis. This means that the View will not interfere when it is used in a horizontal scrolling View (such as a ViewPager).

Returns:

boolean - true if the View is filtering Touch Events

getLoadingLayoutProxy

ILoadingLayout getLoadingLayoutProxy()

Returns a proxy object which allows you to call methods on all of the LoadingLayouts (the Views which show when Pulling/Refreshing).

You should not keep the result of this method any longer than you need it.

Returns:

Object which will proxy any calls you make on it, to all of the LoadingLayouts.

getLoadingLayoutProxy

ILoadingLayout getLoadingLayoutProxy(boolean includeStart,
                                   boolean includeEnd)

Returns a proxy object which allows you to call methods on the LoadingLayouts (the Views which show when Pulling/Refreshing). The actual LoadingLayout(s) which will be affected, are chosen by the parameters you give.

You should not keep the result of this method any longer than you need it.

Parameters:

includeStart - - Whether to include the Start/Header Views

includeEnd - - Whether to include the End/Footer Views

Returns:

Object which will proxy any calls you make on it, to the LoadingLayouts included.

getMode

PullToRefreshBase.Mode getMode()

Get the mode that this view has been set to. If this returns Mode.BOTH, you can use getCurrentMode() to check which mode the view is currently in

Returns:

Mode that the view has been set to

getRefreshableView

T getRefreshableView()

Get the Wrapped Refreshable View. Anything returned here has already been added to the content view.

Returns:

The View which is currently wrapped

getShowViewWhileRefreshing

boolean getShowViewWhileRefreshing()

Get whether the 'Refreshing' View should be automatically shown when refreshing. Returns true by default.

Returns:

- true if the Refreshing View will be show

getState

PullToRefreshBase.State getState()

Returns:

- The state that the View is currently in.

isPullToRefreshEnabled

boolean isPullToRefreshEnabled()

Whether Pull-to-Refresh is enabled

Returns:

enabled

isPullToRefreshOverScrollEnabled

boolean isPullToRefreshOverScrollEnabled()

Gets whether Overscroll support is enabled. This is different to Android's standard Overscroll support (the edge-glow) which is available from GINGERBREAD onwards

Returns:

true - if both PullToRefresh-OverScroll and Android's inbuilt OverScroll are enabled

isRefreshing

boolean isRefreshing()

Returns whether the Widget is currently in the Refreshing mState

Returns:

true if the Widget is currently refreshing

isScrollingWhileRefreshingEnabled

boolean isScrollingWhileRefreshingEnabled()

Returns whether the widget has enabled scrolling on the Refreshable View while refreshing.

Returns:

true if the widget has enabled scrolling while refreshing

onRefreshComplete

void onRefreshComplete()

Mark the current Refresh as complete. Will Reset the UI and hide the Refreshing View

setFilterTouchEvents

void setFilterTouchEvents(boolean filterEvents)

Set the Touch Events to be filtered or not. If set to true, then the View will only use touch events where the difference in the Y-axis is greater than the difference in the X-axis. This means that the View will not interfere when it is used in a horizontal scrolling View (such as a ViewPager), but will restrict which types of finger scrolls will trigger the View.

Parameters:

filterEvents - - true if you want to filter Touch Events. Default is true.

setMode

void setMode(PullToRefreshBase.Mode mode)

Set the mode of Pull-to-Refresh that this view will use.

Parameters:

mode - - Mode to set the View to

setOnPullEventListener

void setOnPullEventListener(PullToRefreshBase.OnPullEventListener<T> listener)

Set OnPullEventListener for the Widget

Parameters:

listener - - Listener to be used when the Widget has a pull event to propogate.

setOnRefreshListener

void setOnRefreshListener(PullToRefreshBase.OnRefreshListener<T> listener)

Set OnRefreshListener for the Widget

Parameters:

listener - - Listener to be used when the Widget is set to Refresh

setOnRefreshListener

void setOnRefreshListener(PullToRefreshBase.OnRefreshListener2<T> listener)

Set OnRefreshListener for the Widget

Parameters:

listener - - Listener to be used when the Widget is set to Refresh

setPullToRefreshOverScrollEnabled

void setPullToRefreshOverScrollEnabled(boolean enabled)

Sets whether Overscroll support is enabled. This is different to Android's standard Overscroll support (the edge-glow). This setting only takes effect when running on device with Android v2.3 or greater.

Parameters:

enabled - - true if you want Overscroll enabled

setRefreshing

void setRefreshing()

Sets the Widget to be in the refresh state. The UI will be updated to show the 'Refreshing' view, and be scrolled to show such.

setRefreshing

void setRefreshing(boolean doScroll)

Sets the Widget to be in the refresh state. The UI will be updated to show the 'Refreshing' view.

Parameters:

doScroll - - true if you want to force a scroll to the Refreshing view.

setScrollAnimationInterpolator

void setScrollAnimationInterpolator(android.view.animation.Interpolator interpolator)

Sets the Animation Interpolator that is used for animated scrolling. Defaults to a DecelerateInterpolator

Parameters:

interpolator - - Interpolator to use

setScrollingWhileRefreshingEnabled

void setScrollingWhileRefreshingEnabled(boolean scrollingWhileRefreshingEnabled)

By default the Widget disables scrolling on the Refreshable View while refreshing. This method can change this behaviour.

Parameters:

scrollingWhileRefreshingEnabled - - true if you want to enable scrolling while refreshing

setShowViewWhileRefreshing

void setShowViewWhileRefreshing(boolean showView)

A mutator to enable/disable whether the 'Refreshing' View should be automatically shown when refreshing.

Parameters:

showView -