Summary: Inherited Constants | Ctors | Methods | Protected Methods | Inherited Methods

SideSheetDialog

public class SideSheetDialog
extends AppCompatDialog

java.lang.Object
↳	android.app.Dialog
	↳	androidx.activity.ComponentDialog
		↳	androidx.appcompat.app.AppCompatDialog
			↳	com.google.android.material.sidesheet.SideSheetDialog

Base class for Dialogs styled as a side sheet.

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

Summary

Inherited constants

From interface android.content.DialogInterface

`int`	`BUTTON1`
`int`	`BUTTON2`
`int`	`BUTTON3`
`int`	`BUTTON_NEGATIVE`
`int`	`BUTTON_NEUTRAL`
`int`	`BUTTON_POSITIVE`

Public constructors
`SideSheetDialog(Context context)`
`SideSheetDialog(Context context, int theme)`

Public methods
`void`	`cancel()` This function can be called from a few different use cases, including swiping the dialog away or calling `dismiss()` from a `SideSheetDialogFragment`, tapping outside a dialog, etc...
`SideSheetBehavior<? extends View>`	`getBehavior()` Returns the behavior associated with this `SideSheetDialog`.
`boolean`	`isDismissWithSheetAnimationEnabled()` Returns whether dismissing will perform the swipe away animation on the sheet, rather than the window animation for the dialog.
`void`	`onAttachedToWindow()`
`void`	`onDetachedFromWindow()`
`void`	`setCancelable(boolean cancelable)`
`void`	`setCanceledOnTouchOutside(boolean cancel)`
`void`	`setContentView(View view)`
`void`	`setContentView(int layoutResId)`
`void`	`setContentView(View view, ViewGroup.LayoutParams params)`
`void`	`setDismissWithSheetAnimationEnabled(boolean dismissWithAnimation)` Set whether to perform the swipe away animation on the sheet when dismissing, rather than the window animation for the dialog.
`void`	`setSheetEdge(int gravity)` Set the edge which the sheet should originate from.

Protected methods
`void`	`onCreate(Bundle savedInstanceState)`
`void`	`onStart()`

Inherited methods

From class


        
          androidx.appcompat.app.AppCompatDialog

`void`	`addContentView(View arg0, ViewGroup.LayoutParams arg1)`
`void`	`dismiss()`
`boolean`	`dispatchKeyEvent(KeyEvent arg0)`
`<T extends View> T`	`findViewById(int arg0)`
`AppCompatDelegate`	`getDelegate()`
`ActionBar`	`getSupportActionBar()`
`void`	`invalidateOptionsMenu()`
`void`	`onCreate(Bundle arg0)`
`void`	`onStop()`
`void`	`onSupportActionModeFinished(ActionMode arg0)`
`void`	`onSupportActionModeStarted(ActionMode arg0)`
`ActionMode`	`onWindowStartingSupportActionMode(ActionMode.Callback arg0)`
`void`	`setContentView(View arg0)`
`void`	`setContentView(int arg0)`
`void`	`setContentView(View arg0, ViewGroup.LayoutParams arg1)`
`void`	`setTitle(CharSequence arg0)`
`void`	`setTitle(int arg0)`
`boolean`	`supportRequestWindowFeature(int arg0)`

From class


        
          androidx.activity.ComponentDialog

`void`	`addContentView(View arg0, ViewGroup.LayoutParams arg1)`
`Lifecycle`	`getLifecycle()`
`final OnBackPressedDispatcher`	`getOnBackPressedDispatcher()`
`SavedStateRegistry`	`getSavedStateRegistry()`
`void`	`initializeViewTreeOwners()`
`void`	`onBackPressed()`
`void`	`onCreate(Bundle arg0)`
`Bundle`	`onSaveInstanceState()`
`void`	`onStart()`
`void`	`onStop()`
`void`	`setContentView(View arg0)`
`void`	`setContentView(int arg0)`
`void`	`setContentView(View arg0, ViewGroup.LayoutParams arg1)`

From class


        
          android.app.Dialog

`void`	`addContentView(View arg0, ViewGroup.LayoutParams arg1)`
`void`	`cancel()`
`void`	`closeOptionsMenu()`
`void`	`create()`
`void`	`dismiss()`
`boolean`	`dispatchGenericMotionEvent(MotionEvent arg0)`
`boolean`	`dispatchKeyEvent(KeyEvent arg0)`
`boolean`	`dispatchKeyShortcutEvent(KeyEvent arg0)`
`boolean`	`dispatchPopulateAccessibilityEvent(AccessibilityEvent arg0)`
`boolean`	`dispatchTouchEvent(MotionEvent arg0)`
`boolean`	`dispatchTrackballEvent(MotionEvent arg0)`
`<T extends View> T`	`findViewById(int arg0)`
`ActionBar`	`getActionBar()`
`final Context`	`getContext()`
`View`	`getCurrentFocus()`
`LayoutInflater`	`getLayoutInflater()`
`OnBackInvokedDispatcher`	`getOnBackInvokedDispatcher()`
`final Activity`	`getOwnerActivity()`
`final SearchEvent`	`getSearchEvent()`
`final int`	`getVolumeControlStream()`
`Window`	`getWindow()`
`void`	`hide()`
`void`	`invalidateOptionsMenu()`
`boolean`	`isShowing()`
`void`	`onActionModeFinished(ActionMode arg0)`
`void`	`onActionModeStarted(ActionMode arg0)`
`void`	`onAttachedToWindow()`
`void`	`onBackPressed()`
`void`	`onContentChanged()`
`boolean`	`onContextItemSelected(MenuItem arg0)`
`void`	`onContextMenuClosed(Menu arg0)`
`void`	`onCreate(Bundle arg0)`
`void`	`onCreateContextMenu(ContextMenu arg0, View arg1, ContextMenu.ContextMenuInfo arg2)`
`boolean`	`onCreateOptionsMenu(Menu arg0)`
`boolean`	`onCreatePanelMenu(int arg0, Menu arg1)`
`View`	`onCreatePanelView(int arg0)`
`void`	`onDetachedFromWindow()`
`boolean`	`onGenericMotionEvent(MotionEvent arg0)`
`boolean`	`onKeyDown(int arg0, KeyEvent arg1)`
`boolean`	`onKeyLongPress(int arg0, KeyEvent arg1)`
`boolean`	`onKeyMultiple(int arg0, int arg1, KeyEvent arg2)`
`boolean`	`onKeyShortcut(int arg0, KeyEvent arg1)`
`boolean`	`onKeyUp(int arg0, KeyEvent arg1)`
`boolean`	`onMenuItemSelected(int arg0, MenuItem arg1)`
`boolean`	`onMenuOpened(int arg0, Menu arg1)`
`boolean`	`onOptionsItemSelected(MenuItem arg0)`
`void`	`onOptionsMenuClosed(Menu arg0)`
`void`	`onPanelClosed(int arg0, Menu arg1)`
`boolean`	`onPrepareOptionsMenu(Menu arg0)`
`boolean`	`onPreparePanel(int arg0, View arg1, Menu arg2)`
`void`	`onRestoreInstanceState(Bundle arg0)`
`Bundle`	`onSaveInstanceState()`
`boolean`	`onSearchRequested(SearchEvent arg0)`
`boolean`	`onSearchRequested()`
`void`	`onStart()`
`void`	`onStop()`
`boolean`	`onTouchEvent(MotionEvent arg0)`
`boolean`	`onTrackballEvent(MotionEvent arg0)`
`void`	`onWindowAttributesChanged(WindowManager.LayoutParams arg0)`
`void`	`onWindowFocusChanged(boolean arg0)`
`ActionMode`	`onWindowStartingActionMode(ActionMode.Callback arg0)`
`ActionMode`	`onWindowStartingActionMode(ActionMode.Callback arg0, int arg1)`
`void`	`openContextMenu(View arg0)`
`void`	`openOptionsMenu()`
`void`	`registerForContextMenu(View arg0)`
`final boolean`	`requestWindowFeature(int arg0)`
`final <T extends View> T`	`requireViewById(int arg0)`
`void`	`setCancelMessage(Message arg0)`
`void`	`setCancelable(boolean arg0)`
`void`	`setCanceledOnTouchOutside(boolean arg0)`
`void`	`setContentView(int arg0)`
`void`	`setContentView(View arg0, ViewGroup.LayoutParams arg1)`
`void`	`setContentView(View arg0)`
`void`	`setDismissMessage(Message arg0)`
`final void`	`setFeatureDrawable(int arg0, Drawable arg1)`
`final void`	`setFeatureDrawableAlpha(int arg0, int arg1)`
`final void`	`setFeatureDrawableResource(int arg0, int arg1)`
`final void`	`setFeatureDrawableUri(int arg0, Uri arg1)`
`void`	`setOnCancelListener(DialogInterface.OnCancelListener arg0)`
`void`	`setOnDismissListener(DialogInterface.OnDismissListener arg0)`
`void`	`setOnKeyListener(DialogInterface.OnKeyListener arg0)`
`void`	`setOnShowListener(DialogInterface.OnShowListener arg0)`
`final void`	`setOwnerActivity(Activity arg0)`
`void`	`setTitle(CharSequence arg0)`
`void`	`setTitle(int arg0)`
`final void`	`setVolumeControlStream(int arg0)`
`void`	`show()`
`void`	`takeKeyEvents(boolean arg0)`
`void`	`unregisterForContextMenu(View arg0)`

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()`

From interface


        
          androidx.appcompat.app.AppCompatCallback

`abstract void`	`onSupportActionModeFinished(ActionMode arg0)`
`abstract void`	`onSupportActionModeStarted(ActionMode arg0)`
`abstract ActionMode`	`onWindowStartingSupportActionMode(ActionMode.Callback arg0)`

From interface


        
          androidx.lifecycle.LifecycleOwner

abstract Lifecycle getLifecycle()

From interface


        
          androidx.activity.OnBackPressedDispatcherOwner

abstract OnBackPressedDispatcher getOnBackPressedDispatcher()

From interface


        
          androidx.savedstate.SavedStateRegistryOwner

abstract SavedStateRegistry getSavedStateRegistry()

From interface


        
          android.content.DialogInterface

`abstract void`	`cancel()`
`abstract void`	`dismiss()`

From interface


        
          android.view.Window.Callback

`abstract boolean`	`dispatchGenericMotionEvent(MotionEvent arg0)`
`abstract boolean`	`dispatchKeyEvent(KeyEvent arg0)`
`abstract boolean`	`dispatchKeyShortcutEvent(KeyEvent arg0)`
`abstract boolean`	`dispatchPopulateAccessibilityEvent(AccessibilityEvent arg0)`
`abstract boolean`	`dispatchTouchEvent(MotionEvent arg0)`
`abstract boolean`	`dispatchTrackballEvent(MotionEvent arg0)`
`abstract void`	`onActionModeFinished(ActionMode arg0)`
`abstract void`	`onActionModeStarted(ActionMode arg0)`
`abstract void`	`onAttachedToWindow()`
`abstract void`	`onContentChanged()`
`abstract boolean`	`onCreatePanelMenu(int arg0, Menu arg1)`
`abstract View`	`onCreatePanelView(int arg0)`
`abstract void`	`onDetachedFromWindow()`
`abstract boolean`	`onMenuItemSelected(int arg0, MenuItem arg1)`
`abstract boolean`	`onMenuOpened(int arg0, Menu arg1)`
`abstract void`	`onPanelClosed(int arg0, Menu arg1)`
`default void`	`onPointerCaptureChanged(boolean arg0)`
`abstract boolean`	`onPreparePanel(int arg0, View arg1, Menu arg2)`
`default void`	`onProvideKeyboardShortcuts(List<KeyboardShortcutGroup> arg0, Menu arg1, int arg2)`
`abstract boolean`	`onSearchRequested()`
`abstract boolean`	`onSearchRequested(SearchEvent arg0)`
`abstract void`	`onWindowAttributesChanged(WindowManager.LayoutParams arg0)`
`abstract void`	`onWindowFocusChanged(boolean arg0)`
`abstract ActionMode`	`onWindowStartingActionMode(ActionMode.Callback arg0)`
`abstract ActionMode`	`onWindowStartingActionMode(ActionMode.Callback arg0, int arg1)`

From interface


        
          android.view.KeyEvent.Callback

`abstract boolean`	`onKeyDown(int arg0, KeyEvent arg1)`
`abstract boolean`	`onKeyLongPress(int arg0, KeyEvent arg1)`
`abstract boolean`	`onKeyMultiple(int arg0, int arg1, KeyEvent arg2)`
`abstract boolean`	`onKeyUp(int arg0, KeyEvent arg1)`

From interface


        
          android.view.View.OnCreateContextMenuListener

abstract void onCreateContextMenu(ContextMenu arg0, View arg1, ContextMenu.ContextMenuInfo arg2)

Public constructors

SideSheetDialog

public SideSheetDialog (Context context)

Parameters
`context`	`Context`

SideSheetDialog

public SideSheetDialog (Context context, 
                int theme)

Parameters
`context`	`Context`
`theme`	`int`

Public methods

cancel

public void cancel ()

This function can be called from a few different use cases, including swiping the dialog away or calling `dismiss()` from a `SideSheetDialogFragment`, tapping outside a dialog, etc...

The default animation to dismiss this dialog is a fade-out transition through a windowAnimation. Set setDismissWithSheetAnimationEnabled(boolean) to true if you want to utilize the sheet animation instead.

If this function is called from a swipe interaction, or dismissWithAnimation is false, then keep the default behavior.

getBehavior

public SideSheetBehavior<? extends View> getBehavior ()

Returns the behavior associated with this SideSheetDialog. The behavior must always be a SideSheetBehavior; otherwise, this method will throw an IllegalStateException.

Returns
`SideSheetBehavior<? extends View>`

isDismissWithSheetAnimationEnabled

public boolean isDismissWithSheetAnimationEnabled ()

Returns whether dismissing will perform the swipe away animation on the sheet, rather than the window animation for the dialog.

Returns
`boolean`

onAttachedToWindow

public void onAttachedToWindow ()

onDetachedFromWindow

public void onDetachedFromWindow ()

setCancelable

public void setCancelable (boolean cancelable)

Parameters
`cancelable`	`boolean`

setCanceledOnTouchOutside

public void setCanceledOnTouchOutside (boolean cancel)

Parameters
`cancel`	`boolean`

setContentView

public void setContentView (View view)

Parameters
`view`	`View`

setContentView

public void setContentView (int layoutResId)

Parameters
`layoutResId`	`int`

setContentView

public void setContentView (View view, 
                ViewGroup.LayoutParams params)

Parameters
`view`	`View`
`params`	`ViewGroup.LayoutParams`

setDismissWithSheetAnimationEnabled

public void setDismissWithSheetAnimationEnabled (boolean dismissWithAnimation)

Set whether to perform the swipe away animation on the sheet when dismissing, rather than the window animation for the dialog.

Parameters
`dismissWithAnimation`	`boolean`: True if swipe away animation should be used when dismissing.

setSheetEdge

public void setSheetEdge (int gravity)

Set the edge which the sheet should originate from.

Note: This method should be called when the sheet is initialized, before it is shown. Runtime sheet edge changes are not supported.

Parameters
`gravity`	`int`: the edge from which the sheet and its animations should originate.

Throws
`IllegalStateException`	if the sheet is null or has already been laid out

Protected methods

onCreate

protected void onCreate (Bundle savedInstanceState)

Parameters
`savedInstanceState`	`Bundle`

onStart

protected void onStart ()