added in version 23.4.0
belongs to Maven artifact com.android.support:design:27.1.0

Summary: Inherited Constants | Ctors | Methods | Inherited Methods | [Expand All]

BottomSheetDialogFragment

This package is part of the Android support library which is no longer maintained. The support library has been superseded by AndroidX which is part of Jetpack. We recommend using the AndroidX libraries in all new projects. You should also consider migrating existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library class mappings.

public class BottomSheetDialogFragment
extends AppCompatDialogFragment

java.lang.Object
↳	android.support.v4.app.Fragment
	↳	android.support.v4.app.DialogFragment
		↳	android.support.v7.app.AppCompatDialogFragment
			↳	android.support.design.widget.BottomSheetDialogFragment

---

Modal bottom sheet. This is a version of DialogFragment that shows a bottom sheet using BottomSheetDialog instead of a floating dialog.

Summary

Inherited constants

From class android.support.v4.app.DialogFragment int STYLE_NORMAL Style for setStyle(int, int): a basic, normal dialog. int STYLE_NO_FRAME Style for setStyle(int, int): don't draw any frame at all; the view hierarchy returned by onCreateView(LayoutInflater, ViewGroup, Bundle) is entirely responsible for drawing the dialog. int STYLE_NO_INPUT Style for setStyle(int, int): like STYLE_NO_FRAME, but also disables all input to the dialog. int STYLE_NO_TITLE Style for setStyle(int, int): don't include a title area.

Public constructors
BottomSheetDialogFragment()

Public methods
Dialog	onCreateDialog(Bundle savedInstanceState) Override to build your own custom Dialog container.

Inherited methods
From class android.support.v7.app.AppCompatDialogFragment Dialog onCreateDialog(Bundle savedInstanceState) Override to build your own custom Dialog container.
From class android.support.v4.app.DialogFragment void dismiss() Dismiss the fragment and its dialog. void dismissAllowingStateLoss() Version of dismiss() that uses FragmentTransaction.commitAllowingStateLoss(). Dialog getDialog() boolean getShowsDialog() Return the current value of setShowsDialog(boolean). int getTheme() boolean isCancelable() Return the current value of setCancelable(boolean). void onActivityCreated(Bundle savedInstanceState) Called when the fragment's activity has been created and this fragment's view hierarchy instantiated. void onAttach(Context context) Called when a fragment is first attached to its context. void onCancel(DialogInterface dialog) void onCreate(Bundle savedInstanceState) Called to do initial creation of a fragment. Dialog onCreateDialog(Bundle savedInstanceState) Override to build your own custom Dialog container. void onDestroyView() Remove dialog. void onDetach() Called when the fragment is no longer attached to its activity. void onDismiss(DialogInterface dialog) LayoutInflater onGetLayoutInflater(Bundle savedInstanceState) Returns the LayoutInflater used to inflate Views of this Fragment. void onSaveInstanceState(Bundle outState) Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance of its process is restarted. void onStart() Called when the Fragment is visible to the user. void onStop() Called when the Fragment is no longer started. void setCancelable(boolean cancelable) Control whether the shown Dialog is cancelable. void setShowsDialog(boolean showsDialog) Controls whether this fragment should be shown in a dialog. void setStyle(int style, int theme) Call to customize the basic appearance and behavior of the fragment's dialog. int show(FragmentTransaction transaction, String tag) Display the dialog, adding the fragment using an existing transaction and then committing the transaction. void show(FragmentManager manager, String tag) Display the dialog, adding the fragment to the given FragmentManager. void showNow(FragmentManager manager, String tag) Display the dialog, immediately adding the fragment to the given FragmentManager.
From class android.support.v4.app.Fragment void dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args) Print the Fragments's state into the given stream. final boolean equals(Object o) Subclasses can not override equals(). final FragmentActivity getActivity() Return the FragmentActivity this fragment is currently associated with. boolean getAllowEnterTransitionOverlap() Returns whether the the exit transition and enter transition overlap or not. boolean getAllowReturnTransitionOverlap() Returns whether the the return transition and reenter transition overlap or not. final Bundle getArguments() Return the arguments supplied when the fragment was instantiated, if any. final FragmentManager getChildFragmentManager() Return a private FragmentManager for placing and managing Fragments inside of this Fragment. Context getContext() Return the Context this fragment is currently associated with. Object getEnterTransition() Returns the Transition that will be used to move Views into the initial scene. Object getExitTransition() Returns the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack. final FragmentManager getFragmentManager() Return the FragmentManager for interacting with fragments associated with this fragment's activity. final Object getHost() Return the host object of this fragment. final int getId() Return the identifier this fragment is known by. final LayoutInflater getLayoutInflater() Returns the cached LayoutInflater used to inflate Views of this Fragment. Lifecycle getLifecycle() LoaderManager getLoaderManager() Return the LoaderManager for this fragment, creating it if needed. final Fragment getParentFragment() Returns the parent Fragment containing this Fragment. Object getReenterTransition() Returns the Transition that will be used to move Views in to the scene when returning due to popping a back stack. final Resources getResources() Return requireActivity().getResources(). final boolean getRetainInstance() Object getReturnTransition() Returns the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack. Object getSharedElementEnterTransition() Returns the Transition that will be used for shared elements transferred into the content Scene. Object getSharedElementReturnTransition() Return the Transition that will be used for shared elements transferred back during a pop of the back stack. final String getString(int resId, Object... formatArgs) Return a localized formatted string from the application's package's default string table, substituting the format arguments as defined in Formatter and format(String, Object...). final String getString(int resId) Return a localized string from the application's package's default string table. final String getTag() Get the tag name of the fragment, if specified. final Fragment getTargetFragment() Return the target fragment set by setTargetFragment(Fragment, int). final int getTargetRequestCode() Return the target request code set by setTargetFragment(Fragment, int). final CharSequence getText(int resId) Return a localized, styled CharSequence from the application's package's default string table. boolean getUserVisibleHint() View getView() Get the root view for the fragment's layout (the one returned by onCreateView(LayoutInflater, ViewGroup, Bundle)), if provided. ViewModelStore getViewModelStore() final int hashCode() Subclasses can not override hashCode(). static Fragment instantiate(Context context, String fname) Like instantiate(Context, String, Bundle) but with a null argument Bundle. static Fragment instantiate(Context context, String fname, Bundle args) Create a new instance of a Fragment with the given class name. final boolean isAdded() Return true if the fragment is currently added to its activity. final boolean isDetached() Return true if the fragment has been explicitly detached from the UI. final boolean isHidden() Return true if the fragment has been hidden. final boolean isInLayout() Return true if the layout is included as part of an activity view hierarchy via the <fragment> tag. final boolean isRemoving() Return true if this fragment is currently being removed from its activity. final boolean isResumed() Return true if the fragment is in the resumed state. final boolean isStateSaved() Returns true if this fragment is added and its state has already been saved by its host. final boolean isVisible() Return true if the fragment is currently visible to the user. void onActivityCreated(Bundle savedInstanceState) Called when the fragment's activity has been created and this fragment's view hierarchy instantiated. void onActivityResult(int requestCode, int resultCode, Intent data) Receive the result from a previous call to startActivityForResult(Intent, int). void onAttach(Activity activity) This method was deprecated in API level 23.4.0. See onAttach(Context). void onAttach(Context context) Called when a fragment is first attached to its context. void onAttachFragment(Fragment childFragment) Called when a fragment is attached as a child of this fragment. void onConfigurationChanged(Configuration newConfig) boolean onContextItemSelected(MenuItem item) This hook is called whenever an item in a context menu is selected. void onCreate(Bundle savedInstanceState) Called to do initial creation of a fragment. Animation onCreateAnimation(int transit, boolean enter, int nextAnim) Called when a fragment loads an animation. Animator onCreateAnimator(int transit, boolean enter, int nextAnim) Called when a fragment loads an animator. void onCreateContextMenu(ContextMenu menu, View v, ContextMenu.ContextMenuInfo menuInfo) Called when a context menu for the view is about to be shown. void onCreateOptionsMenu(Menu menu, MenuInflater inflater) Initialize the contents of the Fragment host's standard options menu. View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) Called to have the fragment instantiate its user interface view. void onDestroy() Called when the fragment is no longer in use. void onDestroyOptionsMenu() Called when this fragment's option menu items are no longer being included in the overall options menu. void onDestroyView() Called when the view previously created by onCreateView(LayoutInflater, ViewGroup, Bundle) has been detached from the fragment. void onDetach() Called when the fragment is no longer attached to its activity. LayoutInflater onGetLayoutInflater(Bundle savedInstanceState) Returns the LayoutInflater used to inflate Views of this Fragment. void onHiddenChanged(boolean hidden) Called when the hidden state (as returned by isHidden() of the fragment has changed. void onInflate(Activity activity, AttributeSet attrs, Bundle savedInstanceState) This method was deprecated in API level 23.4.0. See onInflate(Context, AttributeSet, Bundle). void onInflate(Context context, AttributeSet attrs, Bundle savedInstanceState) Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity. void onLowMemory() void onMultiWindowModeChanged(boolean isInMultiWindowMode) Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa. boolean onOptionsItemSelected(MenuItem item) This hook is called whenever an item in your options menu is selected. void onOptionsMenuClosed(Menu menu) This hook is called whenever the options menu is being closed (either by the user canceling the menu with the back/menu button, or when an item is selected). void onPause() Called when the Fragment is no longer resumed. void onPictureInPictureModeChanged(boolean isInPictureInPictureMode) Called by the system when the activity changes to and from picture-in-picture mode. void onPrepareOptionsMenu(Menu menu) Prepare the Fragment host's standard options menu to be displayed. void onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults) Callback for the result from requesting permissions. void onResume() Called when the fragment is visible to the user and actively running. void onSaveInstanceState(Bundle outState) Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance of its process is restarted. void onStart() Called when the Fragment is visible to the user. void onStop() Called when the Fragment is no longer started. void onViewCreated(View view, Bundle savedInstanceState) Called immediately after onCreateView(LayoutInflater, ViewGroup, Bundle) has returned, but before any saved state has been restored in to the view. void onViewStateRestored(Bundle savedInstanceState) Called when all saved state has been restored into the view hierarchy of the fragment. void postponeEnterTransition() Postpone the entering Fragment transition until startPostponedEnterTransition() or executePendingTransactions() has been called. void registerForContextMenu(View view) Registers a context menu to be shown for the given view (multiple views can show the context menu). final void requestPermissions(String[] permissions, int requestCode) Requests permissions to be granted to this application. final FragmentActivity requireActivity() Return the FragmentActivity this fragment is currently associated with. final Context requireContext() Return the Context this fragment is currently associated with. final FragmentManager requireFragmentManager() Return the FragmentManager for interacting with fragments associated with this fragment's activity. final Object requireHost() Return the host object of this fragment. void setAllowEnterTransitionOverlap(boolean allow) Sets whether the the exit transition and enter transition overlap or not. void setAllowReturnTransitionOverlap(boolean allow) Sets whether the the return transition and reenter transition overlap or not. void setArguments(Bundle args) Supply the construction arguments for this fragment. void setEnterSharedElementCallback(SharedElementCallback callback) When custom transitions are used with Fragments, the enter transition callback is called when this Fragment is attached or detached when not popping the back stack. void setEnterTransition(Object transition) Sets the Transition that will be used to move Views into the initial scene. void setExitSharedElementCallback(SharedElementCallback callback) When custom transitions are used with Fragments, the exit transition callback is called when this Fragment is attached or detached when popping the back stack. void setExitTransition(Object transition) Sets the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack. void setHasOptionsMenu(boolean hasMenu) Report that this fragment would like to participate in populating the options menu by receiving a call to onCreateOptionsMenu(Menu, MenuInflater) and related methods. void setInitialSavedState(Fragment.SavedState state) Set the initial saved state that this Fragment should restore itself from when first being constructed, as returned by FragmentManager.saveFragmentInstanceState. void setMenuVisibility(boolean menuVisible) Set a hint for whether this fragment's menu should be visible. void setReenterTransition(Object transition) Sets the Transition that will be used to move Views in to the scene when returning due to popping a back stack. void setRetainInstance(boolean retain) Control whether a fragment instance is retained across Activity re-creation (such as from a configuration change). void setReturnTransition(Object transition) Sets the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack. void setSharedElementEnterTransition(Object transition) Sets the Transition that will be used for shared elements transferred into the content Scene. void setSharedElementReturnTransition(Object transition) Sets the Transition that will be used for shared elements transferred back during a pop of the back stack. void setTargetFragment(Fragment fragment, int requestCode) Optional target for this fragment. void setUserVisibleHint(boolean isVisibleToUser) Set a hint to the system about whether this fragment's UI is currently visible to the user. boolean shouldShowRequestPermissionRationale(String permission) Gets whether you should show UI with rationale for requesting a permission. void startActivity(Intent intent) Call startActivity(Intent) from the fragment's containing Activity. void startActivity(Intent intent, Bundle options) Call startActivity(Intent, Bundle) from the fragment's containing Activity. void startActivityForResult(Intent intent, int requestCode) Call startActivityForResult(Intent, int) from the fragment's containing Activity. void startActivityForResult(Intent intent, int requestCode, Bundle options) Call startActivityForResult(Intent, int, Bundle) from the fragment's containing Activity. void startIntentSenderForResult(IntentSender intent, int requestCode, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options) Call startIntentSenderForResult(IntentSender, int, Intent, int, int, int, Bundle) from the fragment's containing Activity. void startPostponedEnterTransition() Begin postponed transitions after postponeEnterTransition() was called. String toString() void unregisterForContextMenu(View view) Prevents a context menu to be shown for the given view.
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 android.content.DialogInterface.OnCancelListener abstract void onCancel(DialogInterface arg0)
From interface android.content.DialogInterface.OnDismissListener abstract void onDismiss(DialogInterface arg0)
From interface android.content.ComponentCallbacks abstract void onConfigurationChanged(Configuration arg0) abstract void onLowMemory()
From interface android.view.View.OnCreateContextMenuListener abstract void onCreateContextMenu(ContextMenu arg0, View arg1, ContextMenu.ContextMenuInfo arg2)
From interface android.arch.lifecycle.LifecycleOwner abstract Lifecycle getLifecycle()
From interface android.arch.lifecycle.ViewModelStoreOwner abstract ViewModelStore getViewModelStore()

Public constructors

BottomSheetDialogFragment

added in version 23.4.0

BottomSheetDialogFragment ()

Public methods

onCreateDialog

added in version 23.4.0

Dialog onCreateDialog (Bundle savedInstanceState)

Override to build your own custom Dialog container. This is typically used to show an AlertDialog instead of a generic Dialog; when doing so, onCreateView(LayoutInflater, ViewGroup, Bundle) does not need to be implemented since the AlertDialog takes care of its own content.

This method will be called after onCreate(Bundle) and before onCreateView(LayoutInflater, ViewGroup, Bundle). The default implementation simply instantiates and returns a Dialog class.

Note: DialogFragment own the Dialog.setOnCancelListener and Dialog.setOnDismissListener callbacks. You must not set them yourself. To find out about these events, override onCancel(DialogInterface) and onDismiss(DialogInterface).

Parameters
savedInstanceState	Bundle: The last saved instance state of the Fragment, or null if this is a freshly created Fragment.

Returns
Dialog	Return a new Dialog instance to be displayed by the Fragment.

• Annotations

  • CoordinatorLayout.DefaultBehavior

• Interfaces

  • AppBarLayout.OnOffsetChangedListener
  • BaseTransientBottomBar.ContentViewCallback
  • BottomNavigationView.OnNavigationItemReselectedListener
  • BottomNavigationView.OnNavigationItemSelectedListener
  • CoordinatorLayout.AttachedBehavior
  • NavigationView.OnNavigationItemSelectedListener
  • SwipeDismissBehavior.OnDismissListener
  • TabLayout.OnTabSelectedListener

• Classes

  • AppBarLayout
  • AppBarLayout.Behavior
  • AppBarLayout.Behavior.DragCallback
  • AppBarLayout.Behavior.SavedState
  • AppBarLayout.LayoutParams
  • AppBarLayout.ScrollingViewBehavior
  • BaseTransientBottomBar
  • BaseTransientBottomBar.BaseCallback
  • BottomNavigationView
  • BottomSheetBehavior
  • BottomSheetBehavior.BottomSheetCallback
  • BottomSheetBehavior.SavedState
  • BottomSheetDialog
  • BottomSheetDialogFragment
  • CollapsingToolbarLayout
  • CollapsingToolbarLayout.LayoutParams
  • CoordinatorLayout
  • CoordinatorLayout.Behavior
  • CoordinatorLayout.LayoutParams
  • CoordinatorLayout.SavedState
  • FloatingActionButton
  • FloatingActionButton.Behavior
  • FloatingActionButton.OnVisibilityChangedListener
  • NavigationView
  • NavigationView.SavedState
  • Snackbar
  • Snackbar.Callback
  • SwipeDismissBehavior
  • TabItem
  • TabLayout
  • TabLayout.Tab
  • TabLayout.TabLayoutOnPageChangeListener
  • TabLayout.ViewPagerOnTabSelectedListener
  • TextInputEditText
  • TextInputLayout