SwipeDismissFrameLayout

Artifact: androidx.wear:wear

View Source

Added in 1.1.0

---

Kotlin |Java

@UiThread
public class SwipeDismissFrameLayout extends DismissibleFrameLayout

java.lang.Object
↳	android.view.View
	↳	android.view.ViewGroup
		↳	android.widget.FrameLayout
			↳	androidx.wear.widget.DismissibleFrameLayout
				↳	androidx.wear.widget.SwipeDismissFrameLayout

---

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, setSwipeable can be used for more direct control over the feature.

Summary

Nested types
@UiThread public abstract class SwipeDismissFrameLayout.Callback Implement this callback to act on particular stages of the dismissal.

Constants
static final float	DEFAULT_DISMISS_DRAG_WIDTH_RATIO = 0.33f

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.
SwipeDismissFrameLayout(     Context context,     AttributeSet attrs,     int defStyle,     int defStyleRes ) 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.
float	getDismissMinDragWidthRatio() Gets the minimum ratio of the screen after which the swipe gesture is treated as swipe-to-dismiss.
boolean	isSwipeable() Returns true if the frame layout can be dismissed by swipe gestures.
void	removeCallback(SwipeDismissFrameLayout.Callback callback) Removes a callback that was added with addCallback.
void	setDismissMinDragWidthRatio(float ratio) Sets the minimum ratio of the screen after which the swipe gesture is treated as swipe-to-dismiss.
void	setSwipeable(boolean swipeable) Set the layout to be dismissible by swipe or not.

Protected methods
void	performDismissCanceledCallbacks()
void	performDismissFinishedCallbacks()
void	performDismissStartedCallbacks()

Inherited Constants
From android.view.View static final int ACCESSIBILITY_DATA_SENSITIVE_AUTO = 0 static final int ACCESSIBILITY_DATA_SENSITIVE_NO = 2 static final int ACCESSIBILITY_DATA_SENSITIVE_YES = 1 static final int ACCESSIBILITY_LIVE_REGION_ASSERTIVE = 2 static final int ACCESSIBILITY_LIVE_REGION_NONE = 0 static final int ACCESSIBILITY_LIVE_REGION_POLITE = 1 static final Property<View, Float> ALPHA static final int AUTOFILL_FLAG_INCLUDE_NOT_IMPORTANT_VIEWS = 1 static final String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DATE = "creditCardExpirationDate" static final String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DAY = "creditCardExpirationDay" static final String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_MONTH = "creditCardExpirationMonth" static final String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_YEAR = "creditCardExpirationYear" static final String AUTOFILL_HINT_CREDIT_CARD_NUMBER = "creditCardNumber" static final String AUTOFILL_HINT_CREDIT_CARD_SECURITY_CODE = "creditCardSecurityCode" static final String AUTOFILL_HINT_EMAIL_ADDRESS = "emailAddress" static final String AUTOFILL_HINT_NAME = "name" static final String AUTOFILL_HINT_PASSWORD = "password" static final String AUTOFILL_HINT_PHONE = "phone" static final String AUTOFILL_HINT_POSTAL_ADDRESS = "postalAddress" static final String AUTOFILL_HINT_POSTAL_CODE = "postalCode" static final String AUTOFILL_HINT_USERNAME = "username" static final int AUTOFILL_TYPE_DATE = 4 static final int AUTOFILL_TYPE_LIST = 3 static final int AUTOFILL_TYPE_NONE = 0 static final int AUTOFILL_TYPE_TEXT = 1 static final int AUTOFILL_TYPE_TOGGLE = 2 static final int CONTENT_SENSITIVITY_AUTO = 0 static final int CONTENT_SENSITIVITY_NOT_SENSITIVE = 2 static final int CONTENT_SENSITIVITY_SENSITIVE = 1 static final int DRAG_FLAG_ACCESSIBILITY_ACTION = 1024 static final int DRAG_FLAG_GLOBAL = 256 static final int DRAG_FLAG_GLOBAL_PERSISTABLE_URI_PERMISSION = 64 static final int DRAG_FLAG_GLOBAL_PREFIX_URI_PERMISSION = 128 static final int DRAG_FLAG_GLOBAL_SAME_APPLICATION = 4096 static final int DRAG_FLAG_GLOBAL_URI_READ = 1 static final int DRAG_FLAG_GLOBAL_URI_WRITE = 2 static final int DRAG_FLAG_HIDE_CALLING_TASK_ON_DRAG_START = 16384 static final int DRAG_FLAG_OPAQUE = 512 static final int DRAG_FLAG_START_INTENT_SENDER_ON_UNHANDLED_DRAG = 8192 static final int DRAWING_CACHE_QUALITY_AUTO = 0 This field is deprecated. static final int DRAWING_CACHE_QUALITY_HIGH = 1048576 This field is deprecated. static final int DRAWING_CACHE_QUALITY_LOW = 524288 This field is deprecated. static final int[] EMPTY_STATE_SET static final int[] ENABLED_FOCUSED_SELECTED_STATE_SET static final int[] ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET static final int[] ENABLED_FOCUSED_STATE_SET static final int[] ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET static final int[] ENABLED_SELECTED_STATE_SET static final int[] ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET static final int[] ENABLED_STATE_SET static final int[] ENABLED_WINDOW_FOCUSED_STATE_SET static final int FIND_VIEWS_WITH_CONTENT_DESCRIPTION = 2 static final int FIND_VIEWS_WITH_TEXT = 1 static final int FOCUSABLE = 1 static final int FOCUSABLES_ALL = 0 static final int FOCUSABLES_TOUCH_MODE = 1 static final int FOCUSABLE_AUTO = 16 static final int[] FOCUSED_SELECTED_STATE_SET static final int[] FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET static final int[] FOCUSED_STATE_SET static final int[] FOCUSED_WINDOW_FOCUSED_STATE_SET static final int FOCUS_BACKWARD = 1 static final int FOCUS_DOWN = 130 static final int FOCUS_FORWARD = 2 static final int FOCUS_LEFT = 17 static final int FOCUS_RIGHT = 66 static final int FOCUS_UP = 33 static final int GONE = 8 static final int HAPTIC_FEEDBACK_ENABLED = 268435456 static final int IMPORTANT_FOR_ACCESSIBILITY_AUTO = 0 static final int IMPORTANT_FOR_ACCESSIBILITY_NO = 2 static final int IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS = 4 static final int IMPORTANT_FOR_ACCESSIBILITY_YES = 1 static final int IMPORTANT_FOR_AUTOFILL_AUTO = 0 static final int IMPORTANT_FOR_AUTOFILL_NO = 2 static final int IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS = 8 static final int IMPORTANT_FOR_AUTOFILL_YES = 1 static final int IMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTS = 4 static final int IMPORTANT_FOR_CONTENT_CAPTURE_AUTO = 0 static final int IMPORTANT_FOR_CONTENT_CAPTURE_NO = 2 static final int IMPORTANT_FOR_CONTENT_CAPTURE_NO_EXCLUDE_DESCENDANTS = 8 static final int IMPORTANT_FOR_CONTENT_CAPTURE_YES = 1 static final int IMPORTANT_FOR_CONTENT_CAPTURE_YES_EXCLUDE_DESCENDANTS = 4 static final int INVISIBLE = 4 static final int KEEP_SCREEN_ON = 67108864 static final int LAYER_TYPE_HARDWARE = 2 static final int LAYER_TYPE_NONE = 0 static final int LAYER_TYPE_SOFTWARE = 1 static final int LAYOUT_DIRECTION_INHERIT = 2 static final int LAYOUT_DIRECTION_LOCALE = 3 static final int LAYOUT_DIRECTION_LTR = 0 static final int LAYOUT_DIRECTION_RTL = 1 static final int MEASURED_HEIGHT_STATE_SHIFT = 16 static final int MEASURED_SIZE_MASK = 16777215 static final int MEASURED_STATE_MASK = -16777216 static final int MEASURED_STATE_TOO_SMALL = 16777216 static final int NOT_FOCUSABLE = 0 static final int NO_ID = -1 static final int OVER_SCROLL_ALWAYS = 0 static final int OVER_SCROLL_IF_CONTENT_SCROLLS = 1 static final int OVER_SCROLL_NEVER = 2 static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET static final int[] PRESSED_ENABLED_FOCUSED_STATE_SET static final int[] PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET static final int[] PRESSED_ENABLED_SELECTED_STATE_SET static final int[] PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET static final int[] PRESSED_ENABLED_STATE_SET static final int[] PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET static final int[] PRESSED_FOCUSED_SELECTED_STATE_SET static final int[] PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET static final int[] PRESSED_FOCUSED_STATE_SET static final int[] PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET static final int[] PRESSED_SELECTED_STATE_SET static final int[] PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET static final int[] PRESSED_STATE_SET static final int[] PRESSED_WINDOW_FOCUSED_STATE_SET static final float REQUESTED_FRAME_RATE_CATEGORY_DEFAULT static final float REQUESTED_FRAME_RATE_CATEGORY_HIGH = -4.0f static final float REQUESTED_FRAME_RATE_CATEGORY_LOW = -2.0f static final float REQUESTED_FRAME_RATE_CATEGORY_NORMAL = -3.0f static final float REQUESTED_FRAME_RATE_CATEGORY_NO_PREFERENCE = -1.0f static final Property<View, Float> ROTATION static final Property<View, Float> ROTATION_X static final Property<View, Float> ROTATION_Y static final Property<View, Float> SCALE_X static final Property<View, Float> SCALE_Y static final int SCREEN_STATE_OFF = 0 static final int SCREEN_STATE_ON = 1 static final int SCROLLBARS_INSIDE_INSET = 16777216 static final int SCROLLBARS_INSIDE_OVERLAY = 0 static final int SCROLLBARS_OUTSIDE_INSET = 50331648 static final int SCROLLBARS_OUTSIDE_OVERLAY = 33554432 static final int SCROLLBAR_POSITION_DEFAULT = 0 static final int SCROLLBAR_POSITION_LEFT = 1 static final int SCROLLBAR_POSITION_RIGHT = 2 static final int SCROLL_AXIS_HORIZONTAL = 1 static final int SCROLL_AXIS_NONE = 0 static final int SCROLL_AXIS_VERTICAL = 2 static final int SCROLL_CAPTURE_HINT_AUTO = 0 static final int SCROLL_CAPTURE_HINT_EXCLUDE = 1 static final int SCROLL_CAPTURE_HINT_EXCLUDE_DESCENDANTS = 4 static final int SCROLL_CAPTURE_HINT_INCLUDE = 2 static final int SCROLL_INDICATOR_BOTTOM = 2 static final int SCROLL_INDICATOR_END = 32 static final int SCROLL_INDICATOR_LEFT = 4 static final int SCROLL_INDICATOR_RIGHT = 8 static final int SCROLL_INDICATOR_START = 16 static final int SCROLL_INDICATOR_TOP = 1 static final int[] SELECTED_STATE_SET static final int[] SELECTED_WINDOW_FOCUSED_STATE_SET static final int SOUND_EFFECTS_ENABLED = 134217728 static final int STATUS_BAR_HIDDEN = 1 This field is deprecated. static final int STATUS_BAR_VISIBLE = 0 This field is deprecated. static final int SYSTEM_UI_FLAG_FULLSCREEN = 4 This field is deprecated. static final int SYSTEM_UI_FLAG_HIDE_NAVIGATION = 2 This field is deprecated. static final int SYSTEM_UI_FLAG_IMMERSIVE = 2048 This field is deprecated. static final int SYSTEM_UI_FLAG_IMMERSIVE_STICKY = 4096 This field is deprecated. static final int SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN = 1024 This field is deprecated. static final int SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION = 512 This field is deprecated. static final int SYSTEM_UI_FLAG_LAYOUT_STABLE = 256 This field is deprecated. static final int SYSTEM_UI_FLAG_LIGHT_NAVIGATION_BAR = 16 This field is deprecated. static final int SYSTEM_UI_FLAG_LIGHT_STATUS_BAR = 8192 This field is deprecated. static final int SYSTEM_UI_FLAG_LOW_PROFILE = 1 This field is deprecated. static final int SYSTEM_UI_FLAG_VISIBLE = 0 This field is deprecated. static final int SYSTEM_UI_LAYOUT_FLAGS = 1536 This field is deprecated. static final int TEXT_ALIGNMENT_CENTER = 4 static final int TEXT_ALIGNMENT_GRAVITY = 1 static final int TEXT_ALIGNMENT_INHERIT = 0 static final int TEXT_ALIGNMENT_TEXT_END = 3 static final int TEXT_ALIGNMENT_TEXT_START = 2 static final int TEXT_ALIGNMENT_VIEW_END = 6 static final int TEXT_ALIGNMENT_VIEW_START = 5 static final int TEXT_DIRECTION_ANY_RTL = 2 static final int TEXT_DIRECTION_FIRST_STRONG = 1 static final int TEXT_DIRECTION_FIRST_STRONG_LTR = 6 static final int TEXT_DIRECTION_FIRST_STRONG_RTL = 7 static final int TEXT_DIRECTION_INHERIT = 0 static final int TEXT_DIRECTION_LOCALE = 5 static final int TEXT_DIRECTION_LTR = 3 static final int TEXT_DIRECTION_RTL = 4 static final Property<View, Float> TRANSLATION_X static final Property<View, Float> TRANSLATION_Y static final Property<View, Float> TRANSLATION_Z static final String VIEW_LOG_TAG = "View" static final int VISIBLE = 0 static final int[] WINDOW_FOCUSED_STATE_SET static final Property<View, Float> X static final Property<View, Float> Y static final Property<View, Float> Z
From android.view.ViewGroup static final int CLIP_TO_PADDING_MASK = 34 static final int FOCUS_AFTER_DESCENDANTS = 262144 static final int FOCUS_BEFORE_DESCENDANTS = 131072 static final int FOCUS_BLOCK_DESCENDANTS = 393216 static final int LAYOUT_MODE_CLIP_BOUNDS = 0 static final int LAYOUT_MODE_OPTICAL_BOUNDS = 1 static final int PERSISTENT_ALL_CACHES = 3 This field is deprecated. static final int PERSISTENT_ANIMATION_CACHE = 1 This field is deprecated. static final int PERSISTENT_NO_CACHE = 0 This field is deprecated. static final int PERSISTENT_SCROLLING_CACHE = 2 This field is deprecated.

Inherited methods
From androidx.wear.widget.DismissibleFrameLayout boolean canScrollHorizontally(int direction) boolean isDismissableByBackButton() Returns true if the frame layout would be dismissed with back button click boolean isDismissableBySwipe() Returns true if the frame layout can be dismissed by swipe gestures. boolean onInterceptTouchEvent(@NonNull MotionEvent ev) boolean onTouchEvent(@NonNull MotionEvent ev) final void @UiThread registerCallback(@NonNull DismissibleFrameLayout.Callback callback) Registers a callback for dismissal. void requestDisallowInterceptTouchEvent(boolean disallowIntercept) Following methods overriding are only required with swipe-to-dismiss to handle touch event for detect swipe gesture. final void setBackButtonDismissible(boolean backButtonDismissible) Sets the frame layout to be back button dismissible or not. final void setSwipeDismissible(boolean swipeDismissible) Sets the frame layout to be swipe dismissible or not. final void @UiThread unregisterCallback(@NonNull DismissibleFrameLayout.Callback callback) Removes a callback that was added with registerCallback.
From android.widget.FrameLayout boolean checkLayoutParams(ViewGroup.LayoutParams p) FrameLayout.LayoutParams generateDefaultLayoutParams() FrameLayout.LayoutParams generateLayoutParams(AttributeSet attrs) CharSequence getAccessibilityClassName() boolean getConsiderGoneChildrenWhenMeasuring() This method is deprecated. boolean getMeasureAllChildren() void onLayout(boolean changed, int left, int top, int right, int bottom) void onMeasure(int widthMeasureSpec, int heightMeasureSpec) void setForegroundGravity(int foregroundGravity) void setMeasureAllChildren(boolean measureAll) boolean shouldDelayChildPressedState()
From android.view.View void addOnAttachStateChangeListener(     View.OnAttachStateChangeListener listener ) void addOnLayoutChangeListener(View.OnLayoutChangeListener listener) void addOnUnhandledKeyEventListener(     View.OnUnhandledKeyEventListener listener ) ViewPropertyAnimator animate() void announceForAccessibility(CharSequence text) This method is deprecated. void autofill(SparseArray<AutofillValue> values) boolean awakenScrollBars() void bringToFront() void buildDrawingCache() This method is deprecated. void buildLayer() boolean callOnClick() boolean canResolveLayoutDirection() boolean canResolveTextAlignment() boolean canResolveTextDirection() boolean canScrollHorizontally(int direction) boolean canScrollVertically(int direction) final void cancelDragAndDrop() void cancelLongPress() final void cancelPendingInputEvents() boolean checkInputConnectionProxy(View view) void clearAnimation() void clearPendingCredentialRequest() void clearViewTranslationCallback() static int combineMeasuredStates(int curState, int newState) int computeHorizontalScrollExtent() int computeHorizontalScrollOffset() int computeHorizontalScrollRange() void computeScroll() WindowInsets computeSystemWindowInsets(WindowInsets in, Rect outLocalInsets) int computeVerticalScrollExtent() int computeVerticalScrollOffset() int computeVerticalScrollRange() AccessibilityNodeInfo createAccessibilityNodeInfo() void createContextMenu(ContextMenu menu) void destroyDrawingCache() This method is deprecated. boolean dispatchGenericMotionEvent(MotionEvent event) boolean dispatchNestedFling(float velocityX, float velocityY, boolean consumed) boolean dispatchNestedPreFling(float velocityX, float velocityY) boolean dispatchNestedPrePerformAccessibilityAction(     int action,     Bundle arguments ) boolean dispatchNestedPreScroll(     int dx,     int dy,     int[] consumed,     int[] offsetInWindow ) boolean dispatchNestedScroll(     int dxConsumed,     int dyConsumed,     int dxUnconsumed,     int dyUnconsumed,     int[] offsetInWindow ) boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event) void draw(Canvas canvas) void drawableHotspotChanged(float x, float y) final OnBackInvokedDispatcher findOnBackInvokedDispatcher() final T <T extends View> findViewById(int id) final T <T extends View> findViewWithTag(Object tag) boolean fitSystemWindows(Rect insets) This method is deprecated. void forceHasOverlappingRendering(boolean hasOverlappingRendering) void forceLayout() void generateDisplayHash(     String hashAlgorithm,     Rect bounds,     Executor executor,     DisplayHashResultCallback callback ) static int generateViewId() View.AccessibilityDelegate getAccessibilityDelegate() int getAccessibilityLiveRegion() AccessibilityNodeProvider getAccessibilityNodeProvider() CharSequence getAccessibilityPaneTitle() int getAccessibilityTraversalAfter() int getAccessibilityTraversalBefore() String getAllowedHandwritingDelegatePackageName() String getAllowedHandwritingDelegatorPackageName() float getAlpha() Animation getAnimation() Matrix getAnimationMatrix() IBinder getApplicationWindowToken() int[] getAttributeResolutionStack(int attribute) Map<Integer, Integer> getAttributeSourceResourceMap() String[] getAutofillHints() final AutofillId getAutofillId() int getAutofillType() AutofillValue getAutofillValue() Drawable getBackground() BlendMode getBackgroundTintBlendMode() ColorStateList getBackgroundTintList() PorterDuff.Mode getBackgroundTintMode() int getBaseline() final int getBottom() float getBottomFadingEdgeStrength() int getBottomPaddingOffset() float getCameraDistance() Rect getClipBounds() boolean getClipBounds(Rect outRect) final boolean getClipToOutline() final ContentCaptureSession getContentCaptureSession() CharSequence getContentDescription() final int getContentSensitivity() final Context getContext() ContextMenu.ContextMenuInfo getContextMenuInfo() final boolean getDefaultFocusHighlightEnabled() static int getDefaultSize(int size, int measureSpec) Display getDisplay() final int[] getDrawableState() Bitmap getDrawingCache() This method is deprecated. int getDrawingCacheBackgroundColor() This method is deprecated. int getDrawingCacheQuality() This method is deprecated. void getDrawingRect(Rect outRect) long getDrawingTime() float getElevation() int getExplicitStyle() boolean getFilterTouchesWhenObscured() boolean getFitsSystemWindows() int getFocusable() ArrayList<View> getFocusables(int direction) void getFocusedRect(Rect r) Drawable getForeground() int getForegroundGravity() BlendMode getForegroundTintBlendMode() ColorStateList getForegroundTintList() PorterDuff.Mode getForegroundTintMode() float getFrameContentVelocity() final boolean getGlobalVisibleRect(Rect r) Handler getHandler() float getHandwritingBoundsOffsetBottom() float getHandwritingBoundsOffsetLeft() float getHandwritingBoundsOffsetRight() float getHandwritingBoundsOffsetTop() int getHandwritingDelegateFlags() Runnable getHandwritingDelegatorCallback() final boolean getHasOverlappingRendering() final int getHeight() void getHitRect(Rect outRect) int getHorizontalFadingEdgeLength() int getHorizontalScrollbarHeight() Drawable getHorizontalScrollbarThumbDrawable() Drawable getHorizontalScrollbarTrackDrawable() int getId() int getImportantForAccessibility() int getImportantForAutofill() int getImportantForContentCapture() boolean getKeepScreenOn() KeyEvent.DispatcherState getKeyDispatcherState() int getLabelFor() int getLayerType() int getLayoutDirection() ViewGroup.LayoutParams getLayoutParams() final int getLeft() float getLeftFadingEdgeStrength() int getLeftPaddingOffset() final boolean getLocalVisibleRect(Rect r) void getLocationInSurface(int[] location) void getLocationInWindow(int[] outLocation) void getLocationOnScreen(int[] outLocation)