added in version 22.2.0
belongs to Maven artifact com.android.support:design:27.1.0

Summary: Nested Classes | Constants | Ctors | Methods | Inherited Methods | [Expand All]

SwipeDismissBehavior

This package is part of the Android support library which is no longer maintained. The support library has been superseded by AndroidX which is part of Jetpack. We recommend using the AndroidX libraries in all new projects. You should also consider migrating existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library class mappings.

public class SwipeDismissBehavior
extends Behavior<V extends View>

java.lang.Object
↳	android.support.design.widget.CoordinatorLayout.Behavior<V extends android.view.View>
	↳	android.support.design.widget.SwipeDismissBehavior<V extends android.view.View>

---

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

Summary

Nested classes
interface	SwipeDismissBehavior.OnDismissListener Callback interface used to notify the application that the view has been dismissed.

Constants
int	STATE_DRAGGING A view is currently being dragged.
int	STATE_IDLE A view is not currently being dragged or animating as a result of a fling/snap.
int	STATE_SETTLING A view is currently settling into place as a result of a fling or predefined non-interactive motion.
int	SWIPE_DIRECTION_ANY Swipe direction which allows swiping in either direction.
int	SWIPE_DIRECTION_END_TO_START Swipe direction that only allows swiping in the direction of end-to-start.
int	SWIPE_DIRECTION_START_TO_END Swipe direction that only allows swiping in the direction of start-to-end.

Public constructors
SwipeDismissBehavior()

Public methods
boolean	canSwipeDismissView(View view) Called when the user's input indicates that they want to swipe the given view.
int	getDragState() Retrieve the current drag state of this behavior.
boolean	onInterceptTouchEvent(CoordinatorLayout parent, V child, MotionEvent event) Respond to CoordinatorLayout touch events before they are dispatched to child views.
boolean	onTouchEvent(CoordinatorLayout parent, V child, MotionEvent event) Respond to CoordinatorLayout touch events after this Behavior has started intercepting them.
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	setListener(SwipeDismissBehavior.OnDismissListener listener) 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	setStartAlphaSwipeDistance(float fraction) The minimum swipe distance before the view's alpha is modified.
void	setSwipeDirection(int direction) Sets the swipe direction for this behavior.

Inherited methods
From class android.support.design.widget.CoordinatorLayout.Behavior boolean blocksInteractionBelow(CoordinatorLayout parent, V child) Determine whether interaction with views behind the given child in the child order should be blocked. boolean getInsetDodgeRect(CoordinatorLayout parent, V child, Rect rect) Called when a view is set to dodge view insets. int getScrimColor(CoordinatorLayout parent, V child) Supply a scrim color that will be painted behind the associated child view. float getScrimOpacity(CoordinatorLayout parent, V child) Determine the current opacity of the scrim behind a given child view A scrim may be used to indicate that the other elements beneath it are not currently interactive or actionable, drawing user focus and attention to the views above the scrim. static Object getTag(View child) Get the behavior-specific tag object with the given child view. boolean layoutDependsOn(CoordinatorLayout parent, V child, View dependency) Determine whether the supplied child view has another specific sibling view as a layout dependency. WindowInsetsCompat onApplyWindowInsets(CoordinatorLayout coordinatorLayout, V child, WindowInsetsCompat insets) Called when the window insets have changed. void onAttachedToLayoutParams(CoordinatorLayout.LayoutParams params) Called when the Behavior has been attached to a LayoutParams instance. boolean onDependentViewChanged(CoordinatorLayout parent, V child, View dependency) Respond to a change in a child's dependent view This method is called whenever a dependent view changes in size or position outside of the standard layout flow. void onDependentViewRemoved(CoordinatorLayout parent, V child, View dependency) Respond to a child's dependent view being removed. void onDetachedFromLayoutParams() Called when the Behavior has been detached from its holding LayoutParams instance. boolean onInterceptTouchEvent(CoordinatorLayout parent, V child, MotionEvent ev) Respond to CoordinatorLayout touch events before they are dispatched to child views. boolean onLayoutChild(CoordinatorLayout parent, V child, int layoutDirection) Called when the parent CoordinatorLayout is about the lay out the given child view. boolean onMeasureChild(CoordinatorLayout parent, V child, int parentWidthMeasureSpec, int widthUsed, int parentHeightMeasureSpec, int heightUsed) Called when the parent CoordinatorLayout is about to measure the given child view. boolean onNestedFling(CoordinatorLayout coordinatorLayout, V child, View target, float velocityX, float velocityY, boolean consumed) Called when a nested scrolling child is starting a fling or an action that would be a fling. boolean onNestedPreFling(CoordinatorLayout coordinatorLayout, V child, View target, float velocityX, float velocityY) Called when a nested scrolling child is about to start a fling. void onNestedPreScroll(CoordinatorLayout coordinatorLayout, V child, View target, int dx, int dy, int[] consumed) This method was deprecated in API level 26.1.0. You should now override onNestedPreScroll(CoordinatorLayout, View, View, int, int, int[], int). This method will still continue to be called if the type is TYPE_TOUCH. void onNestedPreScroll(CoordinatorLayout coordinatorLayout, V child, View target, int dx, int dy, int[] consumed, int type) Called when a nested scroll in progress is about to update, before the target has consumed any of the scrolled distance. void onNestedScroll(CoordinatorLayout coordinatorLayout, V child, View target, int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed) This method was deprecated in API level 26.1.0. You should now override onNestedScroll(CoordinatorLayout, View, View, int, int, int, int, int). This method will still continue to be called if the type is TYPE_TOUCH. void onNestedScroll(CoordinatorLayout coordinatorLayout, V child, View target, int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed, int type) Called when a nested scroll in progress has updated and the target has scrolled or attempted to scroll. void onNestedScrollAccepted(CoordinatorLayout coordinatorLayout, V child, View directTargetChild, View target, int axes, int type) Called when a nested scroll has been accepted by the CoordinatorLayout. void onNestedScrollAccepted(CoordinatorLayout coordinatorLayout, V child, View directTargetChild, View target, int axes) This method was deprecated in API level 26.1.0. You should now override onNestedScrollAccepted(CoordinatorLayout, View, View, View, int, int). This method will still continue to be called if the type is TYPE_TOUCH. boolean onRequestChildRectangleOnScreen(CoordinatorLayout coordinatorLayout, V child, Rect rectangle, boolean immediate) Called when a child of the view associated with this behavior wants a particular rectangle to be positioned onto the screen. void onRestoreInstanceState(CoordinatorLayout parent, V child, Parcelable state) Hook allowing a behavior to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState(CoordinatorLayout, V). Parcelable onSaveInstanceState(CoordinatorLayout parent, V child) Hook allowing a behavior to generate a representation of its internal state that can later be used to create a new instance with that same state. boolean onStartNestedScroll(CoordinatorLayout coordinatorLayout, V child, View directTargetChild, View target, int axes) This method was deprecated in API level 26.1.0. You should now override onStartNestedScroll(CoordinatorLayout, View, View, View, int, int). This method will still continue to be called if the type is TYPE_TOUCH. boolean onStartNestedScroll(CoordinatorLayout coordinatorLayout, V child, View directTargetChild, View target, int axes, int type) Called when a descendant of the CoordinatorLayout attempts to initiate a nested scroll. void onStopNestedScroll(CoordinatorLayout coordinatorLayout, V child, View target) This method was deprecated in API level 26.1.0. You should now override onStopNestedScroll(CoordinatorLayout, View, View, int). This method will still continue to be called if the type is TYPE_TOUCH. void onStopNestedScroll(CoordinatorLayout coordinatorLayout, V child, View target, int type) Called when a nested scroll has ended. boolean onTouchEvent(CoordinatorLayout parent, V child, MotionEvent ev) Respond to CoordinatorLayout touch events after this Behavior has started intercepting them. static void setTag(View child, Object tag) Associate a Behavior-specific tag object with the given child view.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()

Constants

STATE_DRAGGING

added in version 22.2.0

int STATE_DRAGGING

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

Constant Value: 1 (0x00000001)

STATE_IDLE

added in version 22.2.0

int STATE_IDLE

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

Constant Value: 0 (0x00000000)

STATE_SETTLING

added in version 22.2.0

int STATE_SETTLING

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

Constant Value: 2 (0x00000002)

SWIPE_DIRECTION_ANY

added in version 22.2.0

int SWIPE_DIRECTION_ANY

Swipe direction which allows swiping in either direction.

Constant Value: 2 (0x00000002)

SWIPE_DIRECTION_END_TO_START

added in version 22.2.0

int SWIPE_DIRECTION_END_TO_START

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.

Constant Value: 1 (0x00000001)

SWIPE_DIRECTION_START_TO_END

added in version 22.2.0

int SWIPE_DIRECTION_START_TO_END

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.

Constant Value: 0 (0x00000000)

Public constructors

SwipeDismissBehavior

added in version 22.2.0

SwipeDismissBehavior ()

Public methods

canSwipeDismissView

added in version 23.4.0

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

added in version 22.2.0

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

onInterceptTouchEvent

added in version 22.2.0

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

Respond to CoordinatorLayout touch events before they are dispatched to child views.

Behaviors can use this to monitor inbound touch events until one decides to intercept the rest of the event stream to take an action on its associated child view. This method will return false until it detects the proper intercept conditions, then return true once those conditions have occurred.

Once a Behavior intercepts touch events, the rest of the event stream will be sent to the onTouchEvent(CoordinatorLayout, V, MotionEvent) method.

This method will be called regardless of the visibility of the associated child of the behavior. If you only wish to handle touch events when the child is visible, you should add a check to isShown() on the given child.

The default implementation of this method always returns false.

Parameters
parent	CoordinatorLayout: the parent view currently receiving this touch event
child	V: the child view associated with this Behavior
event	MotionEvent: the MotionEvent describing the touch event being processed

Returns
boolean	true if this Behavior would like to intercept and take over the event stream. The default always returns false.

onTouchEvent

added in version 22.2.0

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

Respond to CoordinatorLayout touch events after this Behavior has started intercepting them.

Behaviors may intercept touch events in order to help the CoordinatorLayout manipulate its child views. For example, a Behavior may allow a user to drag a UI pane open or closed. This method should perform actual mutations of view layout state.

This method will be called regardless of the visibility of the associated child of the behavior. If you only wish to handle touch events when the child is visible, you should add a check to isShown() on the given child.

Parameters
parent	CoordinatorLayout: the parent view currently receiving this touch event
child	V: the child view associated with this Behavior
event	MotionEvent: the MotionEvent describing the touch event being processed

Returns
boolean	true if this Behavior handled this touch event and would like to continue receiving events in this stream. The default always returns false.

setDragDismissDistance

added in version 22.2.0

void setDragDismissDistance (float distance)

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

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

setEndAlphaSwipeDistance

added in version 22.2.0

void setEndAlphaSwipeDistance (float fraction)

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

Parameters
fraction	float: the distance as a fraction of the view's width.

setListener

added in version 22.2.0

void setListener (SwipeDismissBehavior.OnDismissListener listener)

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

Parameters
listener	SwipeDismissBehavior.OnDismissListener: the listener to use.

setSensitivity

added in version 22.2.0

void setSensitivity (float sensitivity)

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

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

setStartAlphaSwipeDistance

added in version 22.2.0

void setStartAlphaSwipeDistance (float fraction)

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

Parameters
fraction	float: the distance as a fraction of the view's width.

setSwipeDirection

added in version 22.2.0

void setSwipeDirection (int direction)

Sets the swipe direction for this behavior.

Parameters
direction	int: one of the SWIPE_DIRECTION_START_TO_END, SWIPE_DIRECTION_END_TO_START or SWIPE_DIRECTION_ANY

• Annotations

  • CoordinatorLayout.DefaultBehavior

• Interfaces

  • AppBarLayout.OnOffsetChangedListener
  • BaseTransientBottomBar.ContentViewCallback
  • BottomNavigationView.OnNavigationItemReselectedListener
  • BottomNavigationView.OnNavigationItemSelectedListener
  • CoordinatorLayout.AttachedBehavior
  • NavigationView.OnNavigationItemSelectedListener
  • SwipeDismissBehavior.OnDismissListener
  • TabLayout.OnTabSelectedListener

• Classes

  • AppBarLayout
  • AppBarLayout.Behavior
  • AppBarLayout.Behavior.DragCallback
  • AppBarLayout.Behavior.SavedState
  • AppBarLayout.LayoutParams
  • AppBarLayout.ScrollingViewBehavior
  • BaseTransientBottomBar
  • BaseTransientBottomBar.BaseCallback
  • BottomNavigationView
  • BottomSheetBehavior
  • BottomSheetBehavior.BottomSheetCallback
  • BottomSheetBehavior.SavedState
  • BottomSheetDialog
  • BottomSheetDialogFragment
  • CollapsingToolbarLayout
  • CollapsingToolbarLayout.LayoutParams
  • CoordinatorLayout
  • CoordinatorLayout.Behavior
  • CoordinatorLayout.LayoutParams
  • CoordinatorLayout.SavedState
  • FloatingActionButton
  • FloatingActionButton.Behavior
  • FloatingActionButton.OnVisibilityChangedListener
  • NavigationView
  • NavigationView.SavedState
  • Snackbar
  • Snackbar.Callback
  • SwipeDismissBehavior
  • TabItem
  • TabLayout
  • TabLayout.Tab
  • TabLayout.TabLayoutOnPageChangeListener
  • TabLayout.ViewPagerOnTabSelectedListener
  • TextInputEditText
  • TextInputLayout