com.nhaarman.listviewanimations.itemmanipulation.swipedismiss

Class SwipeDismissAdapter

java.lang.Object

android.widget.BaseAdapter

com.nhaarman.listviewanimations.BaseAdapterDecorator

com.nhaarman.listviewanimations.itemmanipulation.swipedismiss.SwipeDismissAdapter

All Implemented Interfaces:

Adapter, ListAdapter, SectionIndexer, SpinnerAdapter, com.nhaarman.listviewanimations.util.Insertable, com.nhaarman.listviewanimations.util.ListViewWrapperSetter, com.nhaarman.listviewanimations.util.Swappable

public class SwipeDismissAdapter
extends com.nhaarman.listviewanimations.BaseAdapterDecorator

Adds an option to swipe items in an AbsListView away. Do not call View.setOnTouchListener(android.view.View.OnTouchListener) on your AbsListView!

Field Summary

Fields inherited from interface android.widget.Adapter

IGNORE_ITEM_VIEW_TYPE, NO_SELECTION

Constructor Summary

Constructors

Constructor and Description
SwipeDismissAdapter(BaseAdapter baseAdapter, OnDismissCallback onDismissCallback) Create a new SwipeDismissAdapter.

Method Summary

Methods

Modifier and Type	Method and Description
void	dismiss(int position) Dismisses the View corresponding to given position.
SwipeDismissTouchListener	getDismissTouchListener() Returns the SwipeDismissTouchListener that is used by this SwipeDismissAdapter.
void	notifyDataSetChanged()
void	setDismissableManager(DismissableManager dismissableManager) Sets the DismissableManager to specify which views can or cannot be swiped.
void	setListViewWrapper(com.nhaarman.listviewanimations.util.ListViewWrapper listViewWrapper)
void	setParentIsHorizontalScrollContainer() If the adapter's 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	setSwipeTouchChildResId(int childResId) If the adapter's 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.

Methods inherited from class com.nhaarman.listviewanimations.BaseAdapterDecorator

add, areAllItemsEnabled, getCount, getDecoratedBaseAdapter, getDropDownView, getItem, getItemId, getItemViewType, getListViewWrapper, getPositionForSection, getRootAdapter, getSectionForPosition, getSections, getView, getViewTypeCount, hasStableIds, isEmpty, isEnabled, notifyDataSetChanged, notifyDataSetInvalidated, registerDataSetObserver, setAbsListView, swapItems, unregisterDataSetObserver

Methods inherited from class java.lang.Object

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

Constructor Detail

SwipeDismissAdapter

public SwipeDismissAdapter(BaseAdapter baseAdapter,
                   OnDismissCallback onDismissCallback)

Create a new SwipeDismissAdapter.

Parameters:

baseAdapter - the to use

onDismissCallback - the OnDismissCallback to be notified of dismissed items.

Method Detail

setListViewWrapper

public void setListViewWrapper(com.nhaarman.listviewanimations.util.ListViewWrapper listViewWrapper)

Specified by:

setListViewWrapper in interface com.nhaarman.listviewanimations.util.ListViewWrapperSetter

Overrides:

setListViewWrapper in class com.nhaarman.listviewanimations.BaseAdapterDecorator

setDismissableManager

public void setDismissableManager(DismissableManager dismissableManager)

Sets the DismissableManager to specify which views can or cannot be swiped.

Parameters:

dismissableManager - null for no restrictions.

setParentIsHorizontalScrollContainer

public void setParentIsHorizontalScrollContainer()

If the adapter's 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.

setSwipeTouchChildResId

public void setSwipeTouchChildResId(int childResId)

If the adapter's 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.

If a AbsListView view has a child with the given resource id, the user can still swipe the list item by touching that child. If the user touches an area outside that child (but inside the list item view), then the swipe will not happen and the parent will do its job instead (scrolling horizontally).

Parameters:

childResId - The resource id of the list items' child that the user should touch to be able to swipe the list items.

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.

getDismissTouchListener

public SwipeDismissTouchListener getDismissTouchListener()

Returns the SwipeDismissTouchListener that is used by this SwipeDismissAdapter.

Returns:

null if setListViewWrapper(com.nhaarman.listviewanimations.util.ListViewWrapper) has not been called yet.

notifyDataSetChanged

public void notifyDataSetChanged()

Overrides:

notifyDataSetChanged in class com.nhaarman.listviewanimations.BaseAdapterDecorator