SESL Material/com.google.android.material.sidesheet/SideSheetBehavior

SideSheetBehavior

open class SideSheetBehavior<V : View?> : CoordinatorLayout.Behavior<V> , Sheet<C>

An interaction behavior plugin for a child view of CoordinatorLayout to make it work as a side sheet.

For more information, see the component developer guidance and design guidelines.

Constructors

Link copied to clipboard
constructor()
constructor(@NonNull context: Context, @Nullable attrs: AttributeSet)

Properties

Link copied to clipboard
open var hideFriction: Float
Link copied to clipboard
@get:RestrictTo(value = LIBRARY_GROUP)
open val lastStableState: Int
Link copied to clipboard
open var state: Int

Functions

Link copied to clipboard
open fun addCallback(@NonNull callback: SideSheetCallback)
Adds a callback to be notified of side sheet events.
Link copied to clipboard
open fun cancelBackProgress()
Call this method from onBackCancelled or handleOnBackCancelled so that the back handler can cancel the back animation.
Link copied to clipboard
open fun expand()
Expand the sheet by setting the side sheet state to STATE_EXPANDED.
Link copied to clipboard
@NonNull
open fun <V : View?> from(@NonNull view: V): SideSheetBehavior<V>
A utility function to get the SideSheetBehavior associated with the view.
Link copied to clipboard
@Nullable
open fun getCoplanarSiblingView(): View
Returns the sibling view that is used for coplanar sheet expansion.
Link copied to clipboard
open fun getExpandedOffset(): Int
Returns the sheet's offset from the inner edge when expanded.
Link copied to clipboard
open fun handleBackInvoked()
Call this method from onBackInvoked or handleOnBackPressed so that the back handler can complete the back animation, or handle back without progress in certain cases.
Link copied to clipboard
open fun hide()
Hide the sheet by setting the sheet state to STATE_HIDDEN.
Link copied to clipboard
open fun isDraggable(): Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun onLayoutChild(@NonNull parent: CoordinatorLayout, @NonNull child: V, layoutDirection: Int): Boolean
Link copied to clipboard
open fun onMeasureChild(@NonNull parent: CoordinatorLayout, @NonNull child: V, parentWidthMeasureSpec: Int, widthUsed: Int, parentHeightMeasureSpec: Int, heightUsed: Int): Boolean
Link copied to clipboard
open fun onRestoreInstanceState(@NonNull parent: CoordinatorLayout, @NonNull child: V, @NonNull state: Parcelable)
Link copied to clipboard
Link copied to clipboard
open fun onTouchEvent(@NonNull parent: CoordinatorLayout, @NonNull child: V, @NonNull event: MotionEvent): Boolean
Link copied to clipboard
open fun removeCallback(@NonNull callback: SideSheetCallback)
Removes a previously added callback.
Link copied to clipboard
open fun setCoplanarSiblingView(@Nullable coplanarSiblingView: View)
Set the sibling view to use for coplanar sheet expansion.
Link copied to clipboard
open fun setCoplanarSiblingViewId(@IdRes coplanarSiblingViewId: Int)
Set the sibling id to use for coplanar sheet expansion.
Link copied to clipboard
open fun setDraggable(draggable: Boolean)
Sets whether this sheet is can be hidden/expanded by dragging.
Link copied to clipboard
@RestrictTo(value = LIBRARY_GROUP)
open fun shouldSkipSmoothAnimation(): Boolean
Checks whether an animation should be smooth after the side sheet is released after dragging.
Link copied to clipboard
open fun startBackProgress(@NonNull backEvent: BackEventCompat)
Call this method from onBackStarted or handleOnBackStarted so that the back handler can initialize and start animating.
Link copied to clipboard
open fun updateBackProgress(@NonNull backEvent: BackEventCompat)
Call this method from onBackProgressed or handleOnBackProgressed so that the back handler can continue animating with a new progress value.