SwipeDismissFrameLayout

public class SwipeDismissFrameLayout
extends FrameLayout

java.lang.Object
   ↳ android.view.View
     ↳ android.view.ViewGroup
       ↳ android.widget.FrameLayout
         ↳ android.support.wearable.view.SwipeDismissFrameLayout

This class is deprecated.
use the androidx.wear.widget.SwipeDismissFrameLayout provided by the Jetpack Wear library instead.

A layout enabling left-to-right swipe-to-dismiss, intended for use within an activity.

At least one listener must be added to act on a dismissal action. A listener will typically remove a containing view or fragment from the current activity.

To suppress a swipe-dismiss gesture, at least one contained view must be scrollable, indicating that it would like to consume any horizontal touch gestures in that direction. In this case this view will only allow swipe-to-dismiss on the very edge of the left-hand-side of the screen. If you wish to entirely disable the swipe-to-dismiss gesture, setDismissEnabled(boolean) can be used for more direct control over the feature.

Summary

Nested classes

class SwipeDismissFrameLayout.Callback

This class is deprecated. use the androidx.wear.widget.SwipeDismissFrameLayout provided by the Jetpack Wear library instead.  

Constants

float DEFAULT_DISMISS_DRAG_WIDTH_RATIO

Inherited constants

Inherited fields

Public constructors

SwipeDismissFrameLayout(Context context)

Simple constructor to use when creating a view from code.

SwipeDismissFrameLayout(Context context, AttributeSet attrs)

Constructor that is called when inflating a view from XML.

SwipeDismissFrameLayout(Context context, AttributeSet attrs, int defStyle)

Perform inflation from XML and apply a class-specific base style from a theme attribute.

Public methods

void addCallback(SwipeDismissFrameLayout.Callback callback)

Adds a callback for dismissal.

boolean canScrollHorizontally(int direction)
void dismiss(boolean decelerate)

Triggers a dismiss operation.

boolean isDismissEnabled()

Returns true if swipe to dismiss is currently enabled for this view, false otherwise.

boolean isSwipeable()

Returns true if the layout reacts to swipe gestures.

boolean onInterceptTouchEvent(MotionEvent ev)
boolean onTouchEvent(MotionEvent ev)
void removeCallback(SwipeDismissFrameLayout.Callback callback)

Removes a callback that was added with addCallback(Callback).

void reset()

Resets this view to the original state.

void setDismissEnabled(boolean isDismissEnabled)

Enable or disable the swipe-to-dismiss functionality.

void setDismissMinDragWidthRatio(float ratio)
void setOnDismissedListener(SwipeDismissLayout.OnDismissedListener listener)
void setOnPreSwipeListener(SwipeDismissLayout.OnPreSwipeListener listener)
void setOnSwipeProgressChangedListener(SwipeDismissLayout.OnSwipeProgressChangedListener listener)
void setSwipeable(boolean swipeable)

Sets the layout to swipeable or not.

Protected methods

boolean canScroll(View v, boolean checkV, float dx, float x, float y)

Tests scrollability within child views of v in the direction of dx.

void cancel()

Inherited methods

Constants

DEFAULT_DISMISS_DRAG_WIDTH_RATIO

public static final float DEFAULT_DISMISS_DRAG_WIDTH_RATIO

Constant Value: 0.33

Public constructors

SwipeDismissFrameLayout

public SwipeDismissFrameLayout (Context context)

Simple constructor to use when creating a view from code.

Parameters
context Context: The Context the view is running in, through which it can access the current theme, resources, etc.

SwipeDismissFrameLayout

public SwipeDismissFrameLayout (Context context, 
                AttributeSet attrs)

Constructor that is called when inflating a view from XML. This is called when a view is being constructed from an XML file, supplying attributes that were specified in the XML file. This version uses a default style of 0, so the only attribute values applied are those in the Context's Theme and the given AttributeSet.

The method onFinishInflate() will be called after all children have been added.

Parameters
context Context: The Context the view is running in, through which it can access the current theme, resources, etc.
attrs AttributeSet: The attributes of the XML tag that is inflating the view.

SwipeDismissFrameLayout

public SwipeDismissFrameLayout (Context context, 
                AttributeSet attrs, 
                int defStyle)

Perform inflation from XML and apply a class-specific base style from a theme attribute. This constructor allows subclasses to use their own base style when they are inflating.

Parameters
context Context: The Context the view is running in, through which it can access the current theme, resources, etc.
attrs AttributeSet: The attributes of the XML tag that is inflating the view.
defStyle int: An attribute in the current theme that contains a reference to a style resource that supplies default values for the view. Can be 0 to not look for defaults.

Public methods

addCallback

public void addCallback (SwipeDismissFrameLayout.Callback callback)

Adds a callback for dismissal.

Parameters
callback SwipeDismissFrameLayout.Callback

canScrollHorizontally

public boolean canScrollHorizontally (int direction)

Parameters
direction int

Returns
boolean

dismiss

public void dismiss (boolean decelerate)

Triggers a dismiss operation.

Parameters
decelerate boolean: whether the view should be dismissed with a deceleration animation.

isDismissEnabled

public boolean isDismissEnabled ()

Returns true if swipe to dismiss is currently enabled for this view, false otherwise.

Returns
boolean

isSwipeable

public boolean isSwipeable ()

Returns true if the layout reacts to swipe gestures.

Returns
boolean

onInterceptTouchEvent

public boolean onInterceptTouchEvent (MotionEvent ev)

Parameters
ev MotionEvent

Returns
boolean

onTouchEvent

public boolean onTouchEvent (MotionEvent ev)

Parameters
ev MotionEvent

Returns
boolean

removeCallback

public void removeCallback (SwipeDismissFrameLayout.Callback callback)

Removes a callback that was added with addCallback(Callback).

Parameters
callback SwipeDismissFrameLayout.Callback

reset

public void reset ()

Resets this view to the original state.

setDismissEnabled

public void setDismissEnabled (boolean isDismissEnabled)

Enable or disable the swipe-to-dismiss functionality.

Parameters
isDismissEnabled boolean: whether the view should or should not enable itself to be swiped.

setDismissMinDragWidthRatio

public void setDismissMinDragWidthRatio (float ratio)

Parameters
ratio float

setOnDismissedListener

public void setOnDismissedListener (SwipeDismissLayout.OnDismissedListener listener)

Parameters
listener SwipeDismissLayout.OnDismissedListener

setOnPreSwipeListener

public void setOnPreSwipeListener (SwipeDismissLayout.OnPreSwipeListener listener)

Parameters
listener SwipeDismissLayout.OnPreSwipeListener

setOnSwipeProgressChangedListener

public void setOnSwipeProgressChangedListener (SwipeDismissLayout.OnSwipeProgressChangedListener listener)

Parameters
listener SwipeDismissLayout.OnSwipeProgressChangedListener

setSwipeable

public void setSwipeable (boolean swipeable)

Sets the layout to swipeable or not. This effectively turns the functionality of this layout on or off.

Parameters
swipeable boolean: whether the layout should react to the swipe gesture.

Protected methods

canScroll

protected boolean canScroll (View v, 
                boolean checkV, 
                float dx, 
                float x, 
                float y)

Tests scrollability within child views of v in the direction of dx.

Parameters
v View: View to test for horizontal scrollability
checkV boolean: Whether the view v passed should itself be checked for scrollability (true), or just its children (false).
dx float: Delta scrolled in pixels. Only the sign of this is used.
x float: X coordinate of the active touch point
y float: Y coordinate of the active touch point
Returns
boolean true if child views of v can be scrolled by delta of dx.

cancel

protected void cancel ()