com.telerik.widget.list

Class SwipeExecuteBehavior

java.lang.Object

com.telerik.widget.list.ListViewBehavior

com.telerik.widget.list.SwipeExecuteBehavior

public class SwipeExecuteBehavior
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	SwipeExecuteBehavior.SwipeExecuteListener Interface definition for a callback to be invoked when swipe behavior is working.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_SWIPE_LIMIT
static int	DEFAULT_SWIPE_OFFSET

Constructor Summary

Constructors

Constructor and Description
SwipeExecuteBehavior()

Method Summary

Modifier and Type	Method and Description
void	addListener(SwipeExecuteBehavior.SwipeExecuteListener listener) Adds a listener to be called during the cycle of a swipe gesture.
void	addSwipeDrawable(int offset, Drawable drawable)
void	clearSwipeDrawables()
void	endExecute() A method that is used to notify the behavior that the execution is complete.
int	ensureWithinSwipeLimits(int currentSwipe)
int	getSwipeLimitEnd()
int	getSwipeLimitStart()
int	getSwipeOffset() Gets the current value for the final offset that is set to a swiped item when the swipe gesture ends.
boolean	isAutoDissolve() Gets a value that determines if the swiped item will automatically fade as it reaches the end.
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	onDispatchDraw(Canvas canvas) Called when RadListView's onDispatchDraw method is called.
boolean	onFling(MotionEvent motionEvent, MotionEvent motionEvent2, float v, float v2) Called when the fling gesture is detected by RadListView's ListViewGestureListener.
boolean	onInterceptTouchEvent(MotionEvent motionEvent)
void	onLongPress(MotionEvent motionEvent) Called when the long press gesture is detected by RadListView's ListViewGestureListener.
boolean	onShortPressDrag(float startX, float startY, float currentX, float currentY) Called when the drag gesture is detected by RadListView's ListViewGestureListener.
boolean	onTapUp(MotionEvent motionEvent) Called when the tap up gesture is detected by RadListView's ListViewGestureListener.
void	removeListener(SwipeExecuteBehavior.SwipeExecuteListener listener) Removes a listener that is called during the cycle of a swipe gesture.
boolean	removeSwipeDrawable(int offset)
void	setAutoDissolve(boolean autoDissolve) Sets a value that determines if the swiped item will automatically fade as it reaches the end.
void	setSwipeLimitEnd(int swipeLimitEnd)
void	setSwipeLimitStart(int swipeLimitStart)
void	setSwipeOffset(int swipeOffset) Sets a value for the final offset that is set to a swiped item when the swipe gesture ends.

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

bindViewHolder, createViewHolder, getItemViewType, managesViewHolders, onLayout, onLongPressDrag, onLongPressDragEnded, onScrolled

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SWIPE_OFFSET

public static final int DEFAULT_SWIPE_OFFSET

See Also:

Constant Field Values

DEFAULT_SWIPE_LIMIT

public static final int DEFAULT_SWIPE_LIMIT

See Also:

Constant Field Values

Constructor Detail

SwipeExecuteBehavior

public SwipeExecuteBehavior()

Method Detail

addListener

public void addListener(SwipeExecuteBehavior.SwipeExecuteListener listener)

Adds a listener to be called during the cycle of a swipe gesture.

Parameters:

listener - the new listener.

removeListener

public void removeListener(SwipeExecuteBehavior.SwipeExecuteListener listener)

Removes a listener that is called during the cycle of a swipe gesture.

Parameters:

listener - the listener to remove.

getSwipeOffset

public int getSwipeOffset()

Gets the current value for the final offset that is set to a swiped item when the swipe gesture ends. For example if you need to display a 300 pixel wide button on the left, that is part of your swipe content, you can set the offset to 300. If your button is on the right, then the offset should be set to -300. Note that when this is set to the default value which is DEFAULT_SWIPE_OFFSET, the behavior will try to manually calculate the final offset.

Returns:

the current value for swipe offset for a swiped item.

setSwipeOffset

public void setSwipeOffset(int swipeOffset)

Sets a value for the final offset that is set to a swiped item when the swipe gesture ends. For example if you need to display a 300 pixel wide button on the left, that is part of your swipe content, you can set the offset to 300. If your button is on the right, then the offset should be set to -300. Note that when this is set to the default value which is DEFAULT_SWIPE_OFFSET, the behavior will try to manually calculate the final offset.

Parameters:

swipeOffset - the final swipe offset for a swiped item.

getSwipeLimitStart

public int getSwipeLimitStart()

setSwipeLimitStart

public void setSwipeLimitStart(int swipeLimitStart)

getSwipeLimitEnd

public int getSwipeLimitEnd()

setSwipeLimitEnd

public void setSwipeLimitEnd(int swipeLimitEnd)

isAutoDissolve

public boolean isAutoDissolve()

Gets a value that determines if the swiped item will automatically fade as it reaches the end. This can be useful to hint the end user that the item is about to be removed. The default value is true.

Returns:

whether the swiped item will auto fade.

setAutoDissolve

public void setAutoDissolve(boolean autoDissolve)

Sets a value that determines if the swiped item will automatically fade as it reaches the end. This can be useful to hint the end user that the item is about to be removed. The default value is true.

Parameters:

autoDissolve - whether the swiped item will auto fade.

endExecute

public void endExecute()

A method that is used to notify the behavior that the execution is complete. This will return the swiped item to its initial position.

addSwipeDrawable

public void addSwipeDrawable(int offset,
                             Drawable drawable)

removeSwipeDrawable

public boolean removeSwipeDrawable(int offset)

clearSwipeDrawables

public void clearSwipeDrawables()

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

onFling

public boolean onFling(MotionEvent motionEvent,
                       MotionEvent motionEvent2,
                       float v,
                       float v2)

Description copied from class: ListViewBehavior

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

Overrides:

onFling in class ListViewBehavior

Parameters:

motionEvent - The first down motion event that started the fling.

motionEvent2 - The move motion event that triggered the current onFling.

v - The velocity of this fling measured in pixels per second along the x axis.

v2 - The velocity of this fling measured in pixels per second along the y axis.

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

onShortPressDrag

public boolean onShortPressDrag(float startX,
                                float startY,
                                float currentX,
                                float currentY)

Description copied from class: ListViewBehavior

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

Overrides:

onShortPressDrag in class ListViewBehavior

Parameters:

startX - the x coordinate where the gesture started

startY - the y coordinate where the gesture started

currentX - the x coordinate where the gesture occurring now

currentY - the y coordinate where the gesture occurring now

onTapUp

public boolean onTapUp(MotionEvent motionEvent)

Description copied from class: ListViewBehavior

Called when the tap up gesture is detected by RadListView's ListViewGestureListener.

Overrides:

onTapUp in class ListViewBehavior

Parameters:

motionEvent - The motion event

onDispatchDraw

public void onDispatchDraw(Canvas canvas)

Description copied from class: ListViewBehavior

Called when RadListView's onDispatchDraw method is called.

Overrides:

onDispatchDraw in class ListViewBehavior

Parameters:

canvas - the canvas on which to draw the view

ensureWithinSwipeLimits

public int ensureWithinSwipeLimits(int currentSwipe)

onInterceptTouchEvent

public boolean onInterceptTouchEvent(MotionEvent motionEvent)

Overrides:

onInterceptTouchEvent in class ListViewBehavior