SwipeDismissBehavior - Android SDK

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>

Class Overview

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
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.

[Expand]

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.
final int	getScrimColor(CoordinatorLayout parent, V child) Supply a scrim color that will be painted behind the associated child view.
final 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	isDirty(CoordinatorLayout parent, V child) Determine whether the given child view should be considered dirty.
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.
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.
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) 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) 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 nestedScrollAxes) Called when a nested scroll has been accepted by the CoordinatorLayout.
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 nestedScrollAxes) Called when a descendant of the CoordinatorLayout attempts to initiate a nested scroll.
void	onStopNestedScroll(CoordinatorLayout coordinatorLayout, V child, View target) 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() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Constants

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.

Constant Value: 1 (0x00000001)

public static final int STATE_IDLE

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

Constant Value: 0 (0x00000000)

public static final 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)

public static final int SWIPE_DIRECTION_ANY

Swipe direction which allows swiping in either direction.

Constant Value: 2 (0x00000002)

public static final 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)

public static final 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

public SwipeDismissBehavior ()

Public Methods

public int getDragState ()

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

Returns

The current drag state

public 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.

The default implementation of this method always returns false.

Parameters

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

Returns

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

public 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.

Parameters

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

Returns

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

public void setDragDismissDistance (float distance)

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

Parameters

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

public void setEndAlphaSwipeDistance (float fraction)

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

Parameters

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

public void setListener (SwipeDismissBehavior.OnDismissListener listener)

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

Parameters

listener	the listener to use.

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 occured yet.

Parameters

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

public void setStartAlphaSwipeDistance (float fraction)

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

Parameters

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

public void setSwipeDirection (int direction)

Sets the swipe direction for this behavior.

Parameters

direction	one of the `SWIPE_DIRECTION_START_TO_END`, `SWIPE_DIRECTION_END_TO_START` or `SWIPE_DIRECTION_ANY`

Results

Annotations

Interfaces

Classes

SwipeDismissBehavior

Class Overview

Summary

Constants

public static final int STATE_DRAGGING

public static final int STATE_IDLE

public static final int STATE_SETTLING

public static final int SWIPE_DIRECTION_ANY

public static final int SWIPE_DIRECTION_END_TO_START

public static final int SWIPE_DIRECTION_START_TO_END

Public Constructors

public SwipeDismissBehavior ()

Public Methods

public int getDragState ()

Returns

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

Parameters

Returns

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

Parameters

Returns

public void setDragDismissDistance (float distance)

Parameters

public void setEndAlphaSwipeDistance (float fraction)

Parameters

public void setListener (SwipeDismissBehavior.OnDismissListener listener)

Parameters

public void setSensitivity (float sensitivity)

Parameters

public void setStartAlphaSwipeDistance (float fraction)

Parameters

public void setSwipeDirection (int direction)

Parameters