com.telerik.widget.list

Class SwipeRefreshBehavior

java.lang.Object

com.telerik.widget.list.ListViewBehavior

com.telerik.widget.list.SwipeRefreshBehavior

public class SwipeRefreshBehavior
extends ListViewBehavior

Represents a ListViewBehavior that can be used to allow the end user to refresh a list of items by swiping from the top of the list.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SwipeRefreshBehavior.SwipeRefreshListener Interface definition for a callback to be invoked when a refresh is requested.

Constructor Summary

Constructors

Constructor and Description
SwipeRefreshBehavior()

Method Summary

Modifier and Type	Method and Description
void	addListener(SwipeRefreshBehavior.SwipeRefreshListener listener) Adds a listener to be called when items refresh is requested.
void	endRefresh(boolean scrollToStart) A method that is used to notify the behavior that the refresh is complete.
void	init(Context context) Method that can be used to force the initialization of the swipeRefresh() before the behavior is attached to RadListView instance.
boolean	isInProgress() Returns true if the current behavior is in progress.
boolean	onActionUpOrCancel(boolean isCanceled) Called when a previous gesture ends on up or cancel.
void	onAttached(RadListView listView) Called when the behavior is attached to RadListView with addBehavior(ListViewBehavior).
void	onDetached(RadListView listView) Called when the behavior is detached to RadListView with removeBehavior(ListViewBehavior).
void	onLayout(boolean changed, int left, int top, int right, int bottom) Called when RadListView's onLayout method is called.
void	onLongPress(MotionEvent motionEvent) Called when the long press gesture is detected by RadListView's ListViewGestureListener.
void	removeListener(SwipeRefreshBehavior.SwipeRefreshListener listener) Removes a listener that is called when items refresh is requested.
SwipeRefreshLayout	swipeRefresh() Gets the instance of SwipeRefreshLayout that is used by this behavior.

Methods inherited from class com.telerik.widget.list.ListViewBehavior

bindViewHolder, createViewHolder, getItemViewType, managesViewHolders, onDispatchDraw, onFling, onInterceptTouchEvent, onLongPressDrag, onLongPressDragEnded, onScrolled, onShortPressDrag, onTapUp

Methods inherited from class java.lang.Object

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

Constructor Detail

SwipeRefreshBehavior

public SwipeRefreshBehavior()

Method Detail

swipeRefresh

public SwipeRefreshLayout swipeRefresh()

Gets the instance of SwipeRefreshLayout that is used by this behavior. Note that this layout will be initialized when the behavior is attached to RadListView. If you need to access it before that you can manually initialize it with init(android.content.Context).

Returns:

the swipe refresh layout

addListener

public void addListener(SwipeRefreshBehavior.SwipeRefreshListener listener)

Adds a listener to be called when items refresh is requested.

Parameters:

listener - the new listener.

removeListener

public void removeListener(SwipeRefreshBehavior.SwipeRefreshListener listener)

Removes a listener that is called when items refresh is requested.

Parameters:

listener - the listener to remove.

endRefresh

public void endRefresh(boolean scrollToStart)

A method that is used to notify the behavior that the refresh is complete. This will hide the loading indicator.

Parameters:

scrollToStart - a boolean value which defines whether the list should be automatically scrolled to top to display the refreshed list from the beginning.

init

public void init(Context context)

Method that can be used to force the initialization of the swipeRefresh() before the behavior is attached to RadListView instance.

Parameters:

context - context to be used

isInProgress

public boolean isInProgress()

Description copied from class: ListViewBehavior

Returns true if the current behavior is in progress.

Overrides:

isInProgress in class ListViewBehavior

onAttached

public void onAttached(RadListView listView)

Description copied from class: ListViewBehavior

Called when the behavior is attached to RadListView with addBehavior(ListViewBehavior).

Overrides:

onAttached in class ListViewBehavior

Parameters:

listView - The parent list view

onDetached

public void onDetached(RadListView listView)

Description copied from class: ListViewBehavior

Called when the behavior is detached to RadListView with removeBehavior(ListViewBehavior).

Overrides:

onDetached in class ListViewBehavior

Parameters:

listView - The parent list view

onLongPress

public void onLongPress(MotionEvent motionEvent)

Description copied from class: ListViewBehavior

Called when the long press gesture is detected by RadListView's ListViewGestureListener.

Overrides:

onLongPress in class ListViewBehavior

Parameters:

motionEvent - The motion event

onActionUpOrCancel

public boolean onActionUpOrCancel(boolean isCanceled)

Description copied from class: ListViewBehavior

Called when a previous gesture ends on up or cancel.

Overrides:

onActionUpOrCancel in class ListViewBehavior

Parameters:

isCanceled - whether the gesture was cancelled

onLayout

public void onLayout(boolean changed,
                     int left,
                     int top,
                     int right,
                     int bottom)

Description copied from class: ListViewBehavior

Called when RadListView's onLayout method is called.

Derived classes with children should override this method and call layout on each of their children.

Overrides:

onLayout in class ListViewBehavior

Parameters:

changed - This is a new size or position for this view

left - Left position, relative to parent

top - Top position, relative to parent

right - Right position, relative to parent

bottom - Bottom position, relative to parent