com.nhaarman.listviewanimations.itemmanipulation.swipedismiss

Class SwipeDismissTouchListener

java.lang.Object

com.nhaarman.listviewanimations.itemmanipulation.swipedismiss.SwipeTouchListener

com.nhaarman.listviewanimations.itemmanipulation.swipedismiss.SwipeDismissTouchListener

All Implemented Interfaces:

View.OnTouchListener, TouchEventHandler

Direct Known Subclasses:

SwipeUndoTouchListener

public class SwipeDismissTouchListener
extends SwipeTouchListener

A SwipeTouchListener that directly dismisses the items when swiped.

Constructor Summary

Constructors

Constructor and Description
SwipeDismissTouchListener(com.nhaarman.listviewanimations.util.ListViewWrapper listViewWrapper, OnDismissCallback callback) Constructs a new SwipeDismissTouchListener for the given AbsListView.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	afterCancelSwipe(View view, int position) Called after the restore animation of a canceled swipe movement ends.
protected void	afterViewFling(View view, int position) Called after the fling animation of a succesful swipe ends.
protected void	directDismiss(int position)
void	dismiss(int position) Dismisses the View corresponding to given position.
protected void	finalizeDismiss() If necessary, notifies the OnDismissCallback to remove dismissed object from the adapter, and restores the View presentations.
void	fling(int position) Flings the View corresponding to given position out of sight.
protected int	getActiveDismissCount()
long	getDismissAnimationTime()
protected void	notifyCallback(List<Integer> dismissedPositions) Notifies the OnDismissCallback of dismissed items.
protected void	performDismiss(View view, int position) Animates the dismissed list item to zero-height and fires the dismiss callback when all dismissed list item animations have completed.
protected void	restoreViewPresentation(View view) Restores the View's alpha and translationX values.
protected void	restoreViewPresentations(Iterable<View> views) Restores the presentation of given Views by calling restoreViewPresentation(android.view.View).
protected boolean	willLeaveDataSetOnFling(View view, int position) Returns whether flinging the item at given position in the current state would cause it to be removed from the data set.

Methods inherited from class com.nhaarman.listviewanimations.itemmanipulation.swipedismiss.SwipeTouchListener

beforeViewFling, disableSwipe, enableSwipe, getActiveSwipeCount, getListViewWrapper, getSwipeView, isInteracting, isSwiping, notifyDataSetChanged, onCancelSwipe, onStartSwipe, onTouch, onTouchEvent, setDismissableManager, setMinimumAlpha, setParentIsHorizontalScrollContainer, setTouchChild

Methods inherited from class java.lang.Object

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

Constructor Detail

SwipeDismissTouchListener

public SwipeDismissTouchListener(com.nhaarman.listviewanimations.util.ListViewWrapper listViewWrapper,
                         OnDismissCallback callback)

Constructs a new SwipeDismissTouchListener for the given AbsListView.

Parameters:

listViewWrapper - The ListViewWrapper containing the ListView whose items should be dismissable.

callback - The callback to trigger when the user has indicated that he

Method Detail

dismiss

public void dismiss(int position)

Dismisses the View corresponding to given position. Calling this method has the same effect as manually swiping an item off the screen.

Parameters:

position - the position of the item in the ListAdapter. Must be visible.

fling

public void fling(int position)

Description copied from class: SwipeTouchListener

Flings the View corresponding to given position out of sight. Calling this method has the same effect as manually swiping an item off the screen.

Overrides:

fling in class SwipeTouchListener

Parameters:

position - the position of the item in the ListAdapter. Must be visible.

directDismiss

protected void directDismiss(int position)

afterCancelSwipe

protected void afterCancelSwipe(View view,
                    int position)

Description copied from class: SwipeTouchListener

Called after the restore animation of a canceled swipe movement ends.

Overrides:

afterCancelSwipe in class SwipeTouchListener

Parameters:

view - the View that is being swiped.

position - the position of the item in the ListAdapter corresponding to the View.

willLeaveDataSetOnFling

protected boolean willLeaveDataSetOnFling(View view,
                              int position)

Description copied from class: SwipeTouchListener

Returns whether flinging the item at given position in the current state would cause it to be removed from the data set.

Specified by:

willLeaveDataSetOnFling in class SwipeTouchListener

Parameters:

view - the View that would be flinged.

position - the position of the item in the ListAdapter corresponding to the View.

Returns:

true if the item would leave the data set, false otherwise.

afterViewFling

protected void afterViewFling(View view,
                  int position)

Description copied from class: SwipeTouchListener

Called after the fling animation of a succesful swipe ends. Users of this class should implement any finalizing behavior at this point, such as notifying the adapter.

Specified by:

afterViewFling in class SwipeTouchListener

Parameters:

view - the View that is being swiped.

position - the position of the item in the ListAdapter corresponding to the View.

performDismiss

protected void performDismiss(View view,
                  int position)

Animates the dismissed list item to zero-height and fires the dismiss callback when all dismissed list item animations have completed.

Parameters:

view - the dismissed View.

finalizeDismiss

protected void finalizeDismiss()

If necessary, notifies the OnDismissCallback to remove dismissed object from the adapter, and restores the View presentations.

notifyCallback

protected void notifyCallback(List<Integer> dismissedPositions)

Notifies the OnDismissCallback of dismissed items.

Parameters:

dismissedPositions - the positions that have been dismissed.

restoreViewPresentations

protected void restoreViewPresentations(Iterable<View> views)

Restores the presentation of given Views by calling restoreViewPresentation(android.view.View).

restoreViewPresentation

protected void restoreViewPresentation(View view)

Description copied from class: SwipeTouchListener

Restores the View's alpha and translationX values. Users of this class should call this method when recycling Views.

Overrides:

restoreViewPresentation in class SwipeTouchListener

Parameters:

view - the View whose presentation should be restored.

getActiveDismissCount

protected int getActiveDismissCount()

getDismissAnimationTime

public long getDismissAnimationTime()