SwipeDismissBehavior

public class SwipeDismissBehavior<V extends View>

Known direct subclasses

An interaction behavior plugin for child views of CoordinatorLayout to provide support for the 'swipe-to-dismiss' gesture.

Summary

Nested types

Callback interface used to notify the application that the view has been dismissed.

Constants
static final int

A view is currently being dragged.
static final int

A view is not currently being dragged or animating as a result of a fling/snap.
static final int

A view is currently settling into place as a result of a fling or predefined non-interactive motion.
static final int

Swipe direction which allows swiping in either direction.
static final int

Swipe direction that only allows swiping in the direction of end-to-start.
static final int

Swipe direction that only allows swiping in the direction of start-to-end.

Public fields
SwipeDismissBehavior.OnDismissListener

Public constructors

Public methods
boolean

Called when the user's input indicates that they want to swipe the given view.
int

Retrieve the current drag state of this behavior.
SwipeDismissBehavior.OnDismissListener
boolean
onInterceptTouchEvent(
    CoordinatorLayout parent,
    V child,
    MotionEvent event
)
boolean
onLayoutChild(CoordinatorLayout parent, V child, int layoutDirection)
boolean
onTouchEvent(CoordinatorLayout parent, V child, MotionEvent event)
void
setDragDismissDistance(float distance)

Set the threshold for telling if a view has been dragged enough to be dismissed.
void
setEndAlphaSwipeDistance(float fraction)

The maximum swipe distance for the view's alpha is modified.
void

Set the listener to be used when a dismiss event occurs.
void
setSensitivity(float sensitivity)

Set the sensitivity used for detecting the start of a swipe.
void

The minimum swipe distance before the view's alpha is modified.
void
setSwipeDirection(int direction)

Sets the swipe direction for this behavior.

Constants

STATE_DRAGGING

public static final int STATE_DRAGGING

A view is currently being dragged. The position is currently changing as a result of user input or simulated user input.

STATE_IDLE

public static final int STATE_IDLE

A view is not currently being dragged or animating as a result of a fling/snap.

STATE_SETTLING

public static final int STATE_SETTLING

A view is currently settling into place as a result of a fling or predefined non-interactive motion.

SWIPE_DIRECTION_ANY

public static final int SWIPE_DIRECTION_ANY = 2

Swipe direction which allows swiping in either direction.

SWIPE_DIRECTION_END_TO_START

public static final int SWIPE_DIRECTION_END_TO_START = 1

Swipe direction that only allows swiping in the direction of end-to-start. That is right-to-left in LTR or left-to-right in RTL.

SWIPE_DIRECTION_START_TO_END

public static final int SWIPE_DIRECTION_START_TO_END = 0

Swipe direction that only allows swiping in the direction of start-to-end. That is left-to-right in LTR, or right-to-left in RTL.

Public fields

listener

public SwipeDismissBehavior.OnDismissListener listener

Public constructors

SwipeDismissBehavior

public SwipeDismissBehavior()

Public methods

canSwipeDismissView

public boolean canSwipeDismissView(View view)

Called when the user's input indicates that they want to swipe the given view.

Parameters
View view

View the user is attempting to swipe
Returns
boolean

true if the view can be dismissed via swiping, false otherwise

getDragState

public int getDragState()

Retrieve the current drag state of this behavior. This will return one of STATE_IDLE, STATE_DRAGGING or STATE_SETTLING.

Returns
int

The current drag state

getListener

public SwipeDismissBehavior.OnDismissListener getListener()

onInterceptTouchEvent

public boolean onInterceptTouchEvent(
    CoordinatorLayout parent,
    V child,
    MotionEvent event
)

onLayoutChild

public boolean onLayoutChild(CoordinatorLayout parent, V child, int layoutDirection)

onTouchEvent

public boolean onTouchEvent(CoordinatorLayout parent, V child, MotionEvent event)

setDragDismissDistance

public void setDragDismissDistance(float distance)

Set the threshold for telling if a view has been dragged enough to be dismissed.

Parameters
float distance

a ratio of a view's width, values are clamped to 0 >= x <= 1f;

setEndAlphaSwipeDistance

public void setEndAlphaSwipeDistance(float fraction)

The maximum swipe distance for the view's alpha is modified.

Parameters
float fraction

the distance as a fraction of the view's width.

setListener

public void setListener(SwipeDismissBehavior.OnDismissListener listener)

Set the listener to be used when a dismiss event occurs.

Parameters
SwipeDismissBehavior.OnDismissListener listener

the listener to use.

setSensitivity

public void setSensitivity(float sensitivity)

Set the sensitivity used for detecting the start of a swipe. This only takes effect if no touch handling has occurred yet.

Parameters
float sensitivity

Multiplier for how sensitive we should be about detecting the start of a drag. Larger values are more sensitive. 1.0f is normal.

setStartAlphaSwipeDistance

public void setStartAlphaSwipeDistance(float fraction)

The minimum swipe distance before the view's alpha is modified.

Parameters
float fraction

the distance as a fraction of the view's width.

setSwipeDirection

public void setSwipeDirection(int direction)

Sets the swipe direction for this behavior.

Parameters
int direction

one of the SWIPE_DIRECTION_START_TO_END, SWIPE_DIRECTION_END_TO_START or SWIPE_DIRECTION_ANY