com.telerik.widget.list

Class SwipeActionsBehavior

java.lang.Object

com.telerik.widget.list.ListViewBehavior

com.telerik.widget.list.SwipeActionsBehavior

public class SwipeActionsBehavior
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
class	SwipeActionsBehavior.SwipeActionEvent This class is used to encapsulate information about swipe-actions events that occur during the process swiping and releasing an item.
static interface	SwipeActionsBehavior.SwipeActionsListener Interface definition for a callback to be invoked when swipe behavior is working.
static class	SwipeActionsBehavior.SwipeActionsState Defines the possible states for the SwipeActionsBehavior.
static class	SwipeActionsBehavior.SwipeDockMode Lists the possible dock modes for a swiped item.

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
SwipeActionsBehavior()

Method Summary

Modifier and Type	Method and Description
void	addListener(SwipeActionsBehavior.SwipeActionsListener listener) Adds a listener to be called during the cycle of a swipe gesture.
void	bindViewHolder(ListViewHolder holder, int i) Binds the provided ListViewHolder instance to the dataitem at the specified index.
ListViewHolder	createViewHolder(ViewGroup parent, int suggestedViewType) Creates a ListViewHolder instance for the corresponding view type.
void	endExecute() A method that is used to notify the behavior that the execution is complete.
void	endExecute(boolean forceReset) A method that is used to notify the behavior that the execution is complete.
SwipeActionsBehavior.SwipeDockMode	getDockMode() Gets the dock mode for the item being swiped.
int	getSwipeLimitEnd() Gets an integer defining the swipe position from the end (right or bottom) beyond which the item cannot be dragged.
int	getSwipeLimitStart() Gets an integer defining the swipe position from the start (left or top) beyond which the item cannot be dragged.
SwipeActionsBehavior.SwipeActionsState	getSwipeState() Returns a value from the SwipeActionsBehavior.SwipeActionsState enum determining the current state of the SwipeActionsBehavior.
boolean	isInProgress() Returns true if the current behavior is in progress.
boolean	managesViewHolders() Gets a boolean value determining whether the behavior takes care of creating and binding view holders.
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).
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	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.
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(SwipeActionsBehavior.SwipeActionsListener listener) Removes a listener that is called during the cycle of a swipe gesture.
void	setDockMode(SwipeActionsBehavior.SwipeDockMode dockMode) Sets the dock mode for the item being swiped.
void	setSwipeLimitEnd(int swipeLimitEnd) Sets an integer defining the swipe position from the end (right or bottom) beyond which the item cannot be dragged.
void	setSwipeLimitStart(int swipeLimitStart) Sets an integer defining the swipe position from the start (left or top) beyond which the item cannot be dragged.
void	setSwipeThresholdEnd(int swipeThreshold) Sets an integer defining the swipe position from the end (right or bottom) where, when dragged beyond, the swiped item will stick at.
void	setSwipeThresholdStart(int swipeThreshold) Sets an integer defining the swipe position from the start (left or top) where, when dragged beyond, the swiped item will stick at.

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

getItemViewType, onDispatchDraw, 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

SwipeActionsBehavior

public SwipeActionsBehavior()

Method Detail

addListener

public void addListener(SwipeActionsBehavior.SwipeActionsListener listener)

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

Parameters:

listener - the new listener.

removeListener

public void removeListener(SwipeActionsBehavior.SwipeActionsListener listener)

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

Parameters:

listener - the listener to remove.

setSwipeThresholdStart

public void setSwipeThresholdStart(int swipeThreshold)

Sets an integer defining the swipe position from the start (left or top) where, when dragged beyond, the swiped item will stick at.

Parameters:

swipeThreshold - the swipe position at which to stick.

setSwipeThresholdEnd

public void setSwipeThresholdEnd(int swipeThreshold)

Sets an integer defining the swipe position from the end (right or bottom) where, when dragged beyond, the swiped item will stick at.

Parameters:

swipeThreshold - the swipe position at which to stick.

getSwipeLimitStart

public int getSwipeLimitStart()

Gets an integer defining the swipe position from the start (left or top) beyond which the item cannot be dragged.

setSwipeLimitStart

public void setSwipeLimitStart(int swipeLimitStart)

Sets an integer defining the swipe position from the start (left or top) beyond which the item cannot be dragged.

Parameters:

swipeLimitStart - an integer representing the swipe limit.

getSwipeLimitEnd

public int getSwipeLimitEnd()

Gets an integer defining the swipe position from the end (right or bottom) beyond which the item cannot be dragged.

setSwipeLimitEnd

public void setSwipeLimitEnd(int swipeLimitEnd)

Sets an integer defining the swipe position from the end (right or bottom) beyond which the item cannot be dragged.

Parameters:

swipeLimitEnd - an integer representing the swipe limit.

getDockMode

public SwipeActionsBehavior.SwipeDockMode getDockMode()

Gets the dock mode for the item being swiped.

Returns:

a value from the SwipeActionsBehavior.SwipeDockMode enum which defines the dock mode.

setDockMode

public void setDockMode(SwipeActionsBehavior.SwipeDockMode dockMode)

Sets the dock mode for the item being swiped.

Parameters:

dockMode - a value from the SwipeActionsBehavior.SwipeDockMode enum which defines the dock mode.

managesViewHolders

public boolean managesViewHolders()

Description copied from class: ListViewBehavior

Gets a boolean value determining whether the behavior takes care of creating and binding view holders.

Overrides:

managesViewHolders in class ListViewBehavior

Returns:

true if view holders are managed by the behavior; false otherwise.

createViewHolder

public ListViewHolder createViewHolder(ViewGroup parent,
                                       int suggestedViewType)

Description copied from class: ListViewBehavior

Creates a ListViewHolder instance for the corresponding view type.

Overrides:

createViewHolder in class ListViewBehavior

Parameters:

parent - the parent of the view hosted by the view holder.

suggestedViewType - the type of view to create a view holder for.

Returns:

the new ListViewHolder instance.

bindViewHolder

public void bindViewHolder(ListViewHolder holder,
                           int i)

Description copied from class: ListViewBehavior

Binds the provided ListViewHolder instance to the dataitem at the specified index.

Overrides:

bindViewHolder in class ListViewBehavior

Parameters:

holder - the ListViewHolder instance to bind.

i - the index of the data item in the source collection.

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.

endExecute

public void endExecute(boolean forceReset)

A method that is used to notify the behavior that the execution is complete. The forceReset argument can be used to instruct the SwipeActionsBehavior that the swiped item must be reset to its original position without animation. Calling this method with forceReset equal to true will immediately reset the behavior to its SwipeActionsBehavior.SwipeActionsState.IDLE state.

Parameters:

forceReset - true for force reset, otherwise false.

getSwipeState

public SwipeActionsBehavior.SwipeActionsState getSwipeState()

Returns a value from the SwipeActionsBehavior.SwipeActionsState enum determining the current state of the SwipeActionsBehavior.

Returns:

the SwipeActionsBehavior.SwipeActionsState value.

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

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

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

onInterceptTouchEvent

public boolean onInterceptTouchEvent(MotionEvent motionEvent)

Overrides:

onInterceptTouchEvent in class ListViewBehavior