SwipeTouchListener (ListViewAnimations Library (master))

java.lang.Object
- com.nhaarman.listviewanimations.itemmanipulation.swipedismiss.SwipeTouchListener

All Implemented Interfaces:

View.OnTouchListener, TouchEventHandler

Direct Known Subclasses:

SwipeDismissTouchListener
```
public abstract class SwipeTouchListener
extends Object
implements View.OnTouchListener, TouchEventHandler
```
An View.OnTouchListener that makes the list items in a AbsListView swipeable. Implementations of this class should implement afterViewFling(android.view.View, int) to specify what to do after an item has been swiped.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`SwipeTouchListener(com.nhaarman.listviewanimations.util.ListViewWrapper listViewWrapper)` Constructs a new `SwipeTouchListener` 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 abstract void`	`afterViewFling(View view, int position)` Called after the fling animation of a succesful swipe ends.
`protected void`	`beforeViewFling(View view, int position)` Called when the user lifted their finger off the screen, and the `View` should be swiped away.
`void`	`disableSwipe()` Disables the swipe behavior.
`void`	`enableSwipe()` Enables the swipe behavior.
`void`	`fling(int position)` Flings the `View` corresponding to given position out of sight.
`protected int`	`getActiveSwipeCount()` Returns the number of active swipe animations.
`com.nhaarman.listviewanimations.util.ListViewWrapper`	`getListViewWrapper()`
`protected View`	`getSwipeView(View view)` Returns the `View` that should be swiped away.
`boolean`	`isInteracting()`
`boolean`	`isSwiping()` Returns whether the user is currently swiping an item.
`void`	`notifyDataSetChanged()` Notifies this `SwipeTouchListener` that the adapter contents have changed.
`protected void`	`onCancelSwipe(View view, int position)` Called when the swipe movement is canceled.
`protected void`	`onStartSwipe(View view, int position)` Called when the user starts swiping a `View`.
`boolean`	`onTouch(View view, MotionEvent event)`
`boolean`	`onTouchEvent(MotionEvent event)`
`protected void`	`restoreViewPresentation(View view)` Restores the `View`'s `alpha` and `translationX` values.
`void`	`setDismissableManager(DismissableManager dismissableManager)` Sets the `DismissableManager` to specify which views can or cannot be swiped.
`void`	`setMinimumAlpha(float minimumAlpha)` Set the minimum value of the alpha property swiping Views should have.
`void`	`setParentIsHorizontalScrollContainer()` If the `AbsListView` is hosted inside a parent(/grand-parent/etc) that can scroll horizontally, horizontal swipes won't work, because the parent will prevent touch-events from reaching the `AbsListView`.
`void`	`setTouchChild(int childResId)` Sets the resource id of a child view that should be touched to engage swipe.
`protected abstract 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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SwipeTouchListener
```
protected SwipeTouchListener(com.nhaarman.listviewanimations.util.ListViewWrapper listViewWrapper)
```
    Constructs a new SwipeTouchListener for the given AbsListView.
- Method Detail
  - setDismissableManager
```
public void setDismissableManager(DismissableManager dismissableManager)
```
    Sets the DismissableManager to specify which views can or cannot be swiped.
    
    Parameters:
    dismissableManager - null for no restrictions.
  - setMinimumAlpha
```
public void setMinimumAlpha(float minimumAlpha)
```
    Set the minimum value of the alpha property swiping Views should have.
    
    Parameters:
    minimumAlpha - the alpha value between 0.0f and 1.0f.
  - setParentIsHorizontalScrollContainer
```
public void setParentIsHorizontalScrollContainer()
```
    If the AbsListView is hosted inside a parent(/grand-parent/etc) that can scroll horizontally, horizontal swipes won't work, because the parent will prevent touch-events from reaching the AbsListView.
    Call this method to fix this behavior. Note that this will prevent the parent from scrolling horizontally when the user touches anywhere in a list item.
  - setTouchChild
```
public void setTouchChild(int childResId)
```
    Sets the resource id of a child view that should be touched to engage swipe. When the user touches a region outside of that view, no swiping will occur.
    
    Parameters:
    childResId - The resource id of the list items' child that the user should touch to be able to swipe the list items.
  - notifyDataSetChanged
```
public void notifyDataSetChanged()
```
    Notifies this SwipeTouchListener that the adapter contents have changed.
  - isSwiping
```
public boolean isSwiping()
```
    Returns whether the user is currently swiping an item.
    
    Returns:
    true if the user is swiping an item.
  - getListViewWrapper
```
public com.nhaarman.listviewanimations.util.ListViewWrapper getListViewWrapper()
```
  - enableSwipe
```
public void enableSwipe()
```
    Enables the swipe behavior.
  - disableSwipe
```
public void disableSwipe()
```
    Disables the swipe behavior.
  - fling
```
public void fling(int position)
```
    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.
    
    Parameters:
    position - the position of the item in the ListAdapter. Must be visible.
  - isInteracting
```
public boolean isInteracting()
```
    Specified by:
    
    isInteracting in interface TouchEventHandler
  - onTouchEvent
```
public boolean onTouchEvent(MotionEvent event)
```
    Specified by:
    
    onTouchEvent in interface TouchEventHandler
  - onTouch
```
public boolean onTouch(View view,
              MotionEvent event)
```
    Specified by:
    
    onTouch in interface View.OnTouchListener
  - onStartSwipe
```
protected void onStartSwipe(View view,
                int position)
```
    Called when the user starts swiping a View.
    
    Parameters:
    view - the View that is being swiped.
    position - the position of the item in the ListAdapter corresponding to the View.
  - onCancelSwipe
```
protected void onCancelSwipe(View view,
                 int position)
```
    Called when the swipe movement is canceled. A restore animation starts at this point.
    
    Parameters:
    view - the View that was swiped.
    position - the position of the item in the ListAdapter corresponding to the View.
  - afterCancelSwipe
```
protected void afterCancelSwipe(View view,
                    int position)
```
    Called after the restore animation of a canceled swipe movement ends.
    
    Parameters:
    view - the View that is being swiped.
    position - the position of the item in the ListAdapter corresponding to the View.
  - beforeViewFling
```
protected void beforeViewFling(View view,
                   int position)
```
    Called when the user lifted their finger off the screen, and the View should be swiped away. A fling animation starts at this point.
    
    Parameters:
    view - the View that is being flinged.
    position - the position of the item in the ListAdapter corresponding to the View.
  - willLeaveDataSetOnFling
```
protected abstract 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.
    
    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 abstract void afterViewFling(View view,
                  int position)
```
    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.
    
    Parameters:
    view - the View that is being swiped.
    position - the position of the item in the ListAdapter corresponding to the View.
  - restoreViewPresentation
```
protected void restoreViewPresentation(View view)
```
    Restores the View's alpha and translationX values. Users of this class should call this method when recycling Views.
    
    Parameters:
    view - the View whose presentation should be restored.
  - getActiveSwipeCount
```
protected int getActiveSwipeCount()
```
    Returns the number of active swipe animations.
  - getSwipeView
```
protected View getSwipeView(View view)
```
    Returns the View that should be swiped away. Must be a child of given View, or the View itself.
    
    Parameters:
    view - the parent View.

Class SwipeTouchListener

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SwipeTouchListener

Method Detail

setDismissableManager

setMinimumAlpha

setParentIsHorizontalScrollContainer

setTouchChild

notifyDataSetChanged

isSwiping

getListViewWrapper

enableSwipe

disableSwipe

fling

isInteracting

onTouchEvent

onTouch

onStartSwipe

onCancelSwipe

afterCancelSwipe

beforeViewFling

willLeaveDataSetOnFling

afterViewFling

restoreViewPresentation

getActiveSwipeCount

getSwipeView