# SwipeDismissBehavior added in[version 22.2.0](https://developer.android.com/topic/libraries/support-library/revisions) belongs to Maven artifact com.android.support:design:27.1.0 Summary:[Nested Classes](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#nestedclasses)\|[Constants](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#constants)\|[Ctors](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#pubctors)\|[Methods](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#inhmethods)\|[\[Expand All\]](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#) # SwipeDismissBehavior | This package is part of the Android[support library](https://developer.android.com/topic/libraries/support-library)which is no longer maintained. The support library has been superseded by[AndroidX](https://developer.android.com/jetpack/androidx)which is part of[Jetpack](https://developer.android.com/jetpack). We recommend using the AndroidX libraries in all new projects. You should also consider[migrating](https://developer.android.com/jetpack/androidx/migrate)existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library[class mappings](https://developer.android.com/jetpack/androidx/migrate/class-mappings). ` public class SwipeDismissBehavior ` ` `` extends `[Behavior](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior)` `` ` |---|---|----------------------------------------------------------------------------------------------------------------------------------------------------| | java.lang.Object ||| | ↳ | [android.support.design.widget.CoordinatorLayout.Behavior](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior)\ || | | ↳ | android.support.design.widget.SwipeDismissBehavior\ |
*** ** * ** *** An interaction behavior plugin for child views of[CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout)to provide support for the 'swipe-to-dismiss' gesture. ## Summary | ### Nested classes || |--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` interface` | [SwipeDismissBehavior.OnDismissListener](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior.OnDismissListener) Callback interface used to notify the application that the view has been dismissed. | | ### Constants || |-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | [STATE_DRAGGING](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#STATE_DRAGGING) A view is currently being dragged. | | `int` | [STATE_IDLE](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#STATE_IDLE) A view is not currently being dragged or animating as a result of a fling/snap. | | `int` | [STATE_SETTLING](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#STATE_SETTLING) A view is currently settling into place as a result of a fling or predefined non-interactive motion. | | `int` | [SWIPE_DIRECTION_ANY](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#SWIPE_DIRECTION_ANY) Swipe direction which allows swiping in either direction. | | `int` | [SWIPE_DIRECTION_END_TO_START](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#SWIPE_DIRECTION_END_TO_START) Swipe direction that only allows swiping in the direction of end-to-start. | | `int` | [SWIPE_DIRECTION_START_TO_END](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#SWIPE_DIRECTION_START_TO_END) Swipe direction that only allows swiping in the direction of start-to-end. | | ### Public constructors || |---------------------------------------------------------------------------------------------------------------------------------------------------|---| | ` `[SwipeDismissBehavior](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#SwipeDismissBehavior())`() ` | | ### Public methods || |------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` boolean` | ` `[canSwipeDismissView](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#canSwipeDismissView(android.view.View))`(`[View](https://developer.android.com/reference/android/view/View.html)` view) ` Called when the user's input indicates that they want to swipe the given view. | | ` int` | ` `[getDragState](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#getDragState())`() ` Retrieve the current drag state of this behavior. | | ` boolean` | ` `[onInterceptTouchEvent](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#onInterceptTouchEvent(android.support.design.widget.CoordinatorLayout, V, android.view.MotionEvent))`(`[CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout)` parent, V child, `[MotionEvent](https://developer.android.com/reference/android/view/MotionEvent.html)` event) ` Respond to CoordinatorLayout touch events before they are dispatched to child views. | | ` boolean` | ` `[onTouchEvent](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#onTouchEvent(android.support.design.widget.CoordinatorLayout, V, android.view.MotionEvent))`(`[CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout)` parent, V child, `[MotionEvent](https://developer.android.com/reference/android/view/MotionEvent.html)` event) ` Respond to CoordinatorLayout touch events after this Behavior has started[intercepting](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onInterceptTouchEvent(android.support.design.widget.CoordinatorLayout, V, android.view.MotionEvent))them. | | ` void` | ` `[setDragDismissDistance](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#setDragDismissDistance(float))`(float distance) ` Set the threshold for telling if a view has been dragged enough to be dismissed. | | ` void` | ` `[setEndAlphaSwipeDistance](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#setEndAlphaSwipeDistance(float))`(float fraction) ` The maximum swipe distance for the view's alpha is modified. | | ` void` | ` `[setListener](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#setListener(android.support.design.widget.SwipeDismissBehavior.OnDismissListener))`(`[SwipeDismissBehavior.OnDismissListener](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior.OnDismissListener)` listener) ` Set the listener to be used when a dismiss event occurs. | | ` void` | ` `[setSensitivity](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#setSensitivity(float))`(float sensitivity) ` Set the sensitivity used for detecting the start of a swipe. | | ` void` | ` `[setStartAlphaSwipeDistance](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#setStartAlphaSwipeDistance(float))`(float fraction) ` The minimum swipe distance before the view's alpha is modified. | | ` void` | ` `[setSwipeDirection](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#setSwipeDirection(int))`(int direction) ` Sets the swipe direction for this behavior. | | ### Inherited methods | |-----------------------|---| | [![](https://developer.android.com/static/assets/images/styles/disclosure_down.png)](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#)From class` `[android.support.design.widget.CoordinatorLayout.Behavior](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior)` ` |-------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` boolean` | ` `[blocksInteractionBelow](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#blocksInteractionBelow(android.support.design.widget.CoordinatorLayout, V))`(`[CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout)` parent, V child) ` Determine whether interaction with views behind the given child in the child order should be blocked. | | ` boolean` | ` `[getInsetDodgeRect](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#getInsetDodgeRect(android.support.design.widget.CoordinatorLayout, V, android.graphics.Rect))`(`[CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout)` parent, V child, `[Rect](https://developer.android.com/reference/android/graphics/Rect.html)` rect) ` Called when a view is set to dodge view insets. | | ` int` | ` `[getScrimColor](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#getScrimColor(android.support.design.widget.CoordinatorLayout, V))`(`[CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout)` parent, V child) ` Supply a scrim color that will be painted behind the associated child view. | | ` float` | ` `[getScrimOpacity](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#getScrimOpacity(android.support.design.widget.CoordinatorLayout, V))`(`[CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/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](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#getTag(android.view.View))`(`[View](https://developer.android.com/reference/android/view/View.html)` child) ` Get the behavior-specific tag object with the given child view. | | ` boolean` | ` `[layoutDependsOn](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#layoutDependsOn(android.support.design.widget.CoordinatorLayout, V, android.view.View))`(`[CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout)` parent, V child, `[View](https://developer.android.com/reference/android/view/View.html)` dependency) ` Determine whether the supplied child view has another specific sibling view as a layout dependency. | | ` `[WindowInsetsCompat](https://developer.android.com/reference/android/support/v4/view/WindowInsetsCompat) | ` `[onApplyWindowInsets](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onApplyWindowInsets(android.support.design.widget.CoordinatorLayout, V, android.support.v4.view.WindowInsetsCompat))`(`[CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout)` coordinatorLayout, V child, `[WindowInsetsCompat](https://developer.android.com/reference/android/support/v4/view/WindowInsetsCompat)` insets) ` Called when the window insets have changed. | | ` void` | ` `[onAttachedToLayoutParams](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onAttachedToLayoutParams(android.support.design.widget.CoordinatorLayout.LayoutParams))`(`[CoordinatorLayout.LayoutParams](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.LayoutParams)` params) ` Called when the Behavior has been attached to a LayoutParams instance. | | ` boolean` | ` `[onDependentViewChanged](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onDependentViewChanged(android.support.design.widget.CoordinatorLayout, V, android.view.View))`(`[CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout)` parent, V child, `[View](https://developer.android.com/reference/android/view/View.html)` 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](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onDependentViewRemoved(android.support.design.widget.CoordinatorLayout, V, android.view.View))`(`[CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout)` parent, V child, `[View](https://developer.android.com/reference/android/view/View.html)` dependency) ` Respond to a child's dependent view being removed. | | ` void` | ` `[onDetachedFromLayoutParams](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onDetachedFromLayoutParams())`() ` Called when the Behavior has been detached from its holding LayoutParams instance. | | ` boolean` | ` `[onInterceptTouchEvent](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onInterceptTouchEvent(android.support.design.widget.CoordinatorLayout, V, android.view.MotionEvent))`(`[CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout)` parent, V child, `[MotionEvent](https://developer.android.com/reference/android/view/MotionEvent.html)` ev) ` Respond to CoordinatorLayout touch events before they are dispatched to child views. | | ` boolean` | ` `[onLayoutChild](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onLayoutChild(android.support.design.widget.CoordinatorLayout, V, int))`(`[CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout)` parent, V child, int layoutDirection) ` Called when the parent CoordinatorLayout is about the lay out the given child view. | | ` boolean` | ` `[onMeasureChild](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onMeasureChild(android.support.design.widget.CoordinatorLayout, V, int, int, int, int))`(`[CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/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](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onNestedFling(android.support.design.widget.CoordinatorLayout, V, android.view.View, float, float, boolean))`(`[CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout)` coordinatorLayout, V child, `[View](https://developer.android.com/reference/android/view/View.html)` 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](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onNestedPreFling(android.support.design.widget.CoordinatorLayout, V, android.view.View, float, float))`(`[CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout)` coordinatorLayout, V child, `[View](https://developer.android.com/reference/android/view/View.html)` target, float velocityX, float velocityY) ` Called when a nested scrolling child is about to start a fling. | | ` void` | ` `[onNestedPreScroll](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onNestedPreScroll(android.support.design.widget.CoordinatorLayout, V, android.view.View, int, int, int[]))`(`[CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout)` coordinatorLayout, V child, `[View](https://developer.android.com/reference/android/view/View.html)` 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)](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onNestedPreScroll(android.support.design.widget.CoordinatorLayout, V, android.view.View, int, int, int[], int)). This method will still continue to be called if the type is[TYPE_TOUCH](https://developer.android.com/reference/android/support/v4/view/ViewCompat#TYPE_TOUCH).* | | ` void` | ` `[onNestedPreScroll](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onNestedPreScroll(android.support.design.widget.CoordinatorLayout, V, android.view.View, int, int, int[], int))`(`[CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout)` coordinatorLayout, V child, `[View](https://developer.android.com/reference/android/view/View.html)` 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](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onNestedScroll(android.support.design.widget.CoordinatorLayout, V, android.view.View, int, int, int, int))`(`[CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout)` coordinatorLayout, V child, `[View](https://developer.android.com/reference/android/view/View.html)` 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)](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onNestedScroll(android.support.design.widget.CoordinatorLayout, V, android.view.View, int, int, int, int, int)). This method will still continue to be called if the type is[TYPE_TOUCH](https://developer.android.com/reference/android/support/v4/view/ViewCompat#TYPE_TOUCH).* | | ` void` | ` `[onNestedScroll](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onNestedScroll(android.support.design.widget.CoordinatorLayout, V, android.view.View, int, int, int, int, int))`(`[CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout)` coordinatorLayout, V child, `[View](https://developer.android.com/reference/android/view/View.html)` 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](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onNestedScrollAccepted(android.support.design.widget.CoordinatorLayout, V, android.view.View, android.view.View, int, int))`(`[CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout)` coordinatorLayout, V child, `[View](https://developer.android.com/reference/android/view/View.html)` directTargetChild, `[View](https://developer.android.com/reference/android/view/View.html)` target, int axes, int type) ` Called when a nested scroll has been accepted by the CoordinatorLayout. | | ` void` | ` `[onNestedScrollAccepted](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onNestedScrollAccepted(android.support.design.widget.CoordinatorLayout, V, android.view.View, android.view.View, int))`(`[CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout)` coordinatorLayout, V child, `[View](https://developer.android.com/reference/android/view/View.html)` directTargetChild, `[View](https://developer.android.com/reference/android/view/View.html)` target, int axes) ` *This method was deprecated in API level 26.1.0. You should now override[onNestedScrollAccepted(CoordinatorLayout, View, View, View, int, int)](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onNestedScrollAccepted(android.support.design.widget.CoordinatorLayout, V, android.view.View, android.view.View, int, int)). This method will still continue to be called if the type is[TYPE_TOUCH](https://developer.android.com/reference/android/support/v4/view/ViewCompat#TYPE_TOUCH).* | | ` boolean` | ` `[onRequestChildRectangleOnScreen](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onRequestChildRectangleOnScreen(android.support.design.widget.CoordinatorLayout, V, android.graphics.Rect, boolean))`(`[CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout)` coordinatorLayout, V child, `[Rect](https://developer.android.com/reference/android/graphics/Rect.html)` 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](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onRestoreInstanceState(android.support.design.widget.CoordinatorLayout, V, android.os.Parcelable))`(`[CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout)` parent, V child, `[Parcelable](https://developer.android.com/reference/android/os/Parcelable.html)` state) ` Hook allowing a behavior to re-apply a representation of its internal state that had previously been generated by[onSaveInstanceState(CoordinatorLayout, V)](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onSaveInstanceState(android.support.design.widget.CoordinatorLayout, V)). | | ` `[Parcelable](https://developer.android.com/reference/android/os/Parcelable.html) | ` `[onSaveInstanceState](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onSaveInstanceState(android.support.design.widget.CoordinatorLayout, V))`(`[CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/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](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onStartNestedScroll(android.support.design.widget.CoordinatorLayout, V, android.view.View, android.view.View, int))`(`[CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout)` coordinatorLayout, V child, `[View](https://developer.android.com/reference/android/view/View.html)` directTargetChild, `[View](https://developer.android.com/reference/android/view/View.html)` target, int axes) ` *This method was deprecated in API level 26.1.0. You should now override[onStartNestedScroll(CoordinatorLayout, View, View, View, int, int)](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onStartNestedScroll(android.support.design.widget.CoordinatorLayout, V, android.view.View, android.view.View, int, int)). This method will still continue to be called if the type is[TYPE_TOUCH](https://developer.android.com/reference/android/support/v4/view/ViewCompat#TYPE_TOUCH).* | | ` boolean` | ` `[onStartNestedScroll](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onStartNestedScroll(android.support.design.widget.CoordinatorLayout, V, android.view.View, android.view.View, int, int))`(`[CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout)` coordinatorLayout, V child, `[View](https://developer.android.com/reference/android/view/View.html)` directTargetChild, `[View](https://developer.android.com/reference/android/view/View.html)` target, int axes, int type) ` Called when a descendant of the CoordinatorLayout attempts to initiate a nested scroll. | | ` void` | ` `[onStopNestedScroll](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onStopNestedScroll(android.support.design.widget.CoordinatorLayout, V, android.view.View))`(`[CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout)` coordinatorLayout, V child, `[View](https://developer.android.com/reference/android/view/View.html)` target) ` *This method was deprecated in API level 26.1.0. You should now override[onStopNestedScroll(CoordinatorLayout, View, View, int)](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onStopNestedScroll(android.support.design.widget.CoordinatorLayout, V, android.view.View, int)). This method will still continue to be called if the type is[TYPE_TOUCH](https://developer.android.com/reference/android/support/v4/view/ViewCompat#TYPE_TOUCH).* | | ` void` | ` `[onStopNestedScroll](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onStopNestedScroll(android.support.design.widget.CoordinatorLayout, V, android.view.View, int))`(`[CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout)` coordinatorLayout, V child, `[View](https://developer.android.com/reference/android/view/View.html)` target, int type) ` Called when a nested scroll has ended. | | ` boolean` | ` `[onTouchEvent](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onTouchEvent(android.support.design.widget.CoordinatorLayout, V, android.view.MotionEvent))`(`[CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout)` parent, V child, `[MotionEvent](https://developer.android.com/reference/android/view/MotionEvent.html)` ev) ` Respond to CoordinatorLayout touch events after this Behavior has started[intercepting](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onInterceptTouchEvent(android.support.design.widget.CoordinatorLayout, V, android.view.MotionEvent))them. | | ` static void` | ` `[setTag](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#setTag(android.view.View, java.lang.Object))`(`[View](https://developer.android.com/reference/android/view/View.html)` child, Object tag) ` Associate a Behavior-specific tag object with the given child view. | || | [![](https://developer.android.com/static/assets/images/styles/disclosure_down.png)](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#)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](https://developer.android.com/topic/libraries/support-library/revisions) ``` 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](https://developer.android.com/topic/libraries/support-library/revisions) ``` 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](https://developer.android.com/topic/libraries/support-library/revisions) ``` 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](https://developer.android.com/topic/libraries/support-library/revisions) ``` 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](https://developer.android.com/topic/libraries/support-library/revisions) ``` 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](https://developer.android.com/topic/libraries/support-library/revisions) ``` 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](https://developer.android.com/topic/libraries/support-library/revisions) ``` SwipeDismissBehavior () ```

## Public methods ### canSwipeDismissView added in[version 23.4.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` 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](https://developer.android.com/topic/libraries/support-library/revisions) ``` int getDragState () ``` Retrieve the current drag state of this behavior. This will return one of[STATE_IDLE](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#STATE_IDLE),[STATE_DRAGGING](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#STATE_DRAGGING)or[STATE_SETTLING](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#STATE_SETTLING).
| Returns || |-------|-------------------------------| | `int` | The current drag state
| ### onInterceptTouchEvent added in[version 22.2.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` 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)](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onTouchEvent(android.support.design.widget.CoordinatorLayout, V, android.view.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()](https://developer.android.com/reference/android/view/View.html#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](https://developer.android.com/topic/libraries/support-library/revisions) ``` boolean onTouchEvent (CoordinatorLayout parent, V child, MotionEvent event) ``` Respond to CoordinatorLayout touch events after this Behavior has started[intercepting](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior#onInterceptTouchEvent(android.support.design.widget.CoordinatorLayout, V, android.view.MotionEvent))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()](https://developer.android.com/reference/android/view/View.html#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](https://developer.android.com/topic/libraries/support-library/revisions) ``` 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](https://developer.android.com/topic/libraries/support-library/revisions) ``` 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](https://developer.android.com/topic/libraries/support-library/revisions) ``` 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](https://developer.android.com/topic/libraries/support-library/revisions) ``` 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](https://developer.android.com/topic/libraries/support-library/revisions) ``` 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](https://developer.android.com/topic/libraries/support-library/revisions) ``` void setSwipeDirection (int direction) ``` Sets the swipe direction for this behavior.
| Parameters || |-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `direction` | `int`: one of the[SWIPE_DIRECTION_START_TO_END](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#SWIPE_DIRECTION_START_TO_END),[SWIPE_DIRECTION_END_TO_START](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#SWIPE_DIRECTION_END_TO_START)or[SWIPE_DIRECTION_ANY](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior#SWIPE_DIRECTION_ANY)
| - ## Annotations - [CoordinatorLayout.DefaultBehavior](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.DefaultBehavior) - ## Interfaces - [AppBarLayout.OnOffsetChangedListener](https://developer.android.com/reference/android/support/design/widget/AppBarLayout.OnOffsetChangedListener) - [BaseTransientBottomBar.ContentViewCallback](https://developer.android.com/reference/android/support/design/widget/BaseTransientBottomBar.ContentViewCallback) - [BottomNavigationView.OnNavigationItemReselectedListener](https://developer.android.com/reference/android/support/design/widget/BottomNavigationView.OnNavigationItemReselectedListener) - [BottomNavigationView.OnNavigationItemSelectedListener](https://developer.android.com/reference/android/support/design/widget/BottomNavigationView.OnNavigationItemSelectedListener) - [CoordinatorLayout.AttachedBehavior](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.AttachedBehavior) - [NavigationView.OnNavigationItemSelectedListener](https://developer.android.com/reference/android/support/design/widget/NavigationView.OnNavigationItemSelectedListener) - [SwipeDismissBehavior.OnDismissListener](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior.OnDismissListener) - [TabLayout.OnTabSelectedListener](https://developer.android.com/reference/android/support/design/widget/TabLayout.OnTabSelectedListener) - ## Classes - [AppBarLayout](https://developer.android.com/reference/android/support/design/widget/AppBarLayout) - [AppBarLayout.Behavior](https://developer.android.com/reference/android/support/design/widget/AppBarLayout.Behavior) - [AppBarLayout.Behavior.DragCallback](https://developer.android.com/reference/android/support/design/widget/AppBarLayout.Behavior.DragCallback) - [AppBarLayout.Behavior.SavedState](https://developer.android.com/reference/android/support/design/widget/AppBarLayout.Behavior.SavedState) - [AppBarLayout.LayoutParams](https://developer.android.com/reference/android/support/design/widget/AppBarLayout.LayoutParams) - [AppBarLayout.ScrollingViewBehavior](https://developer.android.com/reference/android/support/design/widget/AppBarLayout.ScrollingViewBehavior) - [BaseTransientBottomBar](https://developer.android.com/reference/android/support/design/widget/BaseTransientBottomBar) - [BaseTransientBottomBar.BaseCallback](https://developer.android.com/reference/android/support/design/widget/BaseTransientBottomBar.BaseCallback) - [BottomNavigationView](https://developer.android.com/reference/android/support/design/widget/BottomNavigationView) - [BottomSheetBehavior](https://developer.android.com/reference/android/support/design/widget/BottomSheetBehavior) - [BottomSheetBehavior.BottomSheetCallback](https://developer.android.com/reference/android/support/design/widget/BottomSheetBehavior.BottomSheetCallback) - [BottomSheetBehavior.SavedState](https://developer.android.com/reference/android/support/design/widget/BottomSheetBehavior.SavedState) - [BottomSheetDialog](https://developer.android.com/reference/android/support/design/widget/BottomSheetDialog) - [BottomSheetDialogFragment](https://developer.android.com/reference/android/support/design/widget/BottomSheetDialogFragment) - [CollapsingToolbarLayout](https://developer.android.com/reference/android/support/design/widget/CollapsingToolbarLayout) - [CollapsingToolbarLayout.LayoutParams](https://developer.android.com/reference/android/support/design/widget/CollapsingToolbarLayout.LayoutParams) - [CoordinatorLayout](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout) - [CoordinatorLayout.Behavior](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.Behavior) - [CoordinatorLayout.LayoutParams](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.LayoutParams) - [CoordinatorLayout.SavedState](https://developer.android.com/reference/android/support/design/widget/CoordinatorLayout.SavedState) - [FloatingActionButton](https://developer.android.com/reference/android/support/design/widget/FloatingActionButton) - [FloatingActionButton.Behavior](https://developer.android.com/reference/android/support/design/widget/FloatingActionButton.Behavior) - [FloatingActionButton.OnVisibilityChangedListener](https://developer.android.com/reference/android/support/design/widget/FloatingActionButton.OnVisibilityChangedListener) - [NavigationView](https://developer.android.com/reference/android/support/design/widget/NavigationView) - [NavigationView.SavedState](https://developer.android.com/reference/android/support/design/widget/NavigationView.SavedState) - [Snackbar](https://developer.android.com/reference/android/support/design/widget/Snackbar) - [Snackbar.Callback](https://developer.android.com/reference/android/support/design/widget/Snackbar.Callback) - [SwipeDismissBehavior](https://developer.android.com/reference/android/support/design/widget/SwipeDismissBehavior) - [TabItem](https://developer.android.com/reference/android/support/design/widget/TabItem) - [TabLayout](https://developer.android.com/reference/android/support/design/widget/TabLayout) - [TabLayout.Tab](https://developer.android.com/reference/android/support/design/widget/TabLayout.Tab) - [TabLayout.TabLayoutOnPageChangeListener](https://developer.android.com/reference/android/support/design/widget/TabLayout.TabLayoutOnPageChangeListener) - [TabLayout.ViewPagerOnTabSelectedListener](https://developer.android.com/reference/android/support/design/widget/TabLayout.ViewPagerOnTabSelectedListener) - [TextInputEditText](https://developer.android.com/reference/android/support/design/widget/TextInputEditText) - [TextInputLayout](https://developer.android.com/reference/android/support/design/widget/TextInputLayout)