Participe do evento ⁠#Android11: apresentação de lançamento da versão Beta no dia 3 de junho.

DialogFragment

public class DialogFragment
extends Fragment implements DialogInterface.OnCancelListener, DialogInterface.OnDismissListener

java.lang.Object
   ↳ androidx.fragment.app.Fragment
     ↳ androidx.fragment.app.DialogFragment


Static library support version of the framework's DialogFragment. Used to write apps that run on platforms prior to Android 3.0. When running on Android 3.0 or above, this implementation is still used; it does not try to switch to the framework's implementation. See the framework SDK documentation for a class overview.

Summary

Constants

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 Fragment.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

DialogFragment()

Constructor used by the default FragmentFactory.

DialogFragment(int contentLayoutId)

Alternate constructor that can be called from your default, no argument constructor to provide a default layout that will be inflated by Fragment.onCreateView(LayoutInflater, ViewGroup, Bundle).

Public methods

void dismiss()

Dismiss the fragment and its dialog.

void dismissAllowingStateLoss()

Version of dismiss() that uses FragmentTransaction.commitAllowingStateLoss().

Dialog getDialog()

Return the Dialog this fragment is currently controlling.

boolean getShowsDialog()

Return the current value of setShowsDialog(boolean).

int getTheme()
boolean isCancelable()

Return the current value of setCancelable(boolean).

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.

If this is called from within onCreateDialog(Bundle), the layout inflater from Fragment.onGetLayoutInflater(Bundle), without the dialog theme, will be returned.

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 if 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 onViewStateRestored(Bundle savedInstanceState)

Called when all saved state has been restored into the view hierarchy of the fragment.

final Dialog requireDialog()

Return the Dialog this fragment is currently controlling.

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.

void show(FragmentManager manager, String tag)

Display the dialog, adding the fragment to the given FragmentManager.

int show(FragmentTransaction transaction, String tag)

Display the dialog, adding the fragment using an existing transaction and then committing the transaction.

void showNow(FragmentManager manager, String tag)

Display the dialog, immediately adding the fragment to the given FragmentManager.

Inherited methods

Constants

STYLE_NORMAL

public static final int STYLE_NORMAL

Style for setStyle(int, int): a basic, normal dialog.

Constant Value: 0 (0x00000000)

STYLE_NO_FRAME

public static final int STYLE_NO_FRAME

Style for setStyle(int, int): don't draw any frame at all; the view hierarchy returned by Fragment.onCreateView(LayoutInflater, ViewGroup, Bundle) is entirely responsible for drawing the dialog.

Constant Value: 2 (0x00000002)

STYLE_NO_INPUT

public static final int STYLE_NO_INPUT

Style for setStyle(int, int): like STYLE_NO_FRAME, but also disables all input to the dialog. The user can not touch it, and its window will not receive input focus.

Constant Value: 3 (0x00000003)

STYLE_NO_TITLE

public static final int STYLE_NO_TITLE

Style for setStyle(int, int): don't include a title area.

Constant Value: 1 (0x00000001)

Public constructors

DialogFragment

public DialogFragment ()

Constructor used by the default FragmentFactory. You must set a custom FragmentFactory if you want to use a non-default constructor to ensure that your constructor is called when the fragment is re-instantiated.

It is strongly recommended to supply arguments with Fragment.setArguments(Bundle) and later retrieved by the Fragment with Fragment.getArguments(). These arguments are automatically saved and restored alongside the Fragment.

Applications should generally not implement a constructor. Prefer onAttach(Context) instead. It is the first place application code can run where the fragment is ready to be used - the point where the fragment is actually associated with its context.

DialogFragment

public DialogFragment (int contentLayoutId)

Alternate constructor that can be called from your default, no argument constructor to provide a default layout that will be inflated by Fragment.onCreateView(LayoutInflater, ViewGroup, Bundle).

 class MyDialogFragment extends DialogFragment {
   public MyDialogFragment() {
     super(R.layout.dialog_fragment_main);
   }
 }
 
You must set a custom FragmentFactory if you want to use a non-default constructor to ensure that your constructor is called when the fragment is re-instantiated.

Parameters
contentLayoutId int

Public methods

dismiss

public void dismiss ()

Dismiss the fragment and its dialog. If the fragment was added to the back stack, all back stack state up to and including this entry will be popped. Otherwise, a new transaction will be committed to remove the fragment.

dismissAllowingStateLoss

public void dismissAllowingStateLoss ()

Version of dismiss() that uses FragmentTransaction.commitAllowingStateLoss(). See linked documentation for further details.

getDialog

public Dialog getDialog ()

Return the Dialog this fragment is currently controlling.

Returns
Dialog

See also:

getShowsDialog

public boolean getShowsDialog ()

Return the current value of setShowsDialog(boolean).

Returns
boolean

getTheme

public int getTheme ()

Returns
int

isCancelable

public boolean isCancelable ()

Return the current value of setCancelable(boolean).

Returns
boolean

onAttach

public void onAttach (Context context)

Called when a fragment is first attached to its context. onCreate(Bundle) will be called after this.

Parameters
context Context

onCancel

public void onCancel (DialogInterface dialog)

Parameters
dialog DialogInterface

onCreate

public void onCreate (Bundle savedInstanceState)

Called to do initial creation of a fragment. This is called after onAttach(Activity) and before onCreateView(LayoutInflater, ViewGroup, Bundle).

Note that this can be called while the fragment's activity is still in the process of being created. As such, you can not rely on things like the activity's content view hierarchy being initialized at this point. If you want to do work once the activity itself is created, add a LifecycleObserver on the activity's Lifecycle, removing it when it receives the Lifecycle.State.CREATED callback.

Any restored child fragments will be created before the base Fragment.onCreate method returns.

Parameters
savedInstanceState Bundle: If the fragment is being re-created from a previous saved state, this is the state.

onCreateDialog

public 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, Fragment.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 immediately before Fragment.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.

onDestroyView

public void onDestroyView ()

Remove dialog.

onDetach

public void onDetach ()

Called when the fragment is no longer attached to its activity. This is called after onDestroy().

onDismiss

public void onDismiss (DialogInterface dialog)

Parameters
dialog DialogInterface

onGetLayoutInflater

public LayoutInflater onGetLayoutInflater (Bundle savedInstanceState)

Returns the LayoutInflater used to inflate Views of this Fragment. The default implementation will throw an exception if the Fragment is not attached.

If this is called from within onCreateDialog(Bundle), the layout inflater from Fragment.onGetLayoutInflater(Bundle), without the dialog theme, will be returned.

Parameters
savedInstanceState Bundle: If the fragment is being re-created from a previous saved state, this is the state.

Returns
LayoutInflater The LayoutInflater used to inflate Views of this Fragment.

onSaveInstanceState

public 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 if its process is restarted. If a new instance of the fragment later needs to be created, the data you place in the Bundle here will be available in the Bundle given to onCreate(Bundle), onCreateView(LayoutInflater, ViewGroup, Bundle), and onViewCreated(View, Bundle).

This corresponds to Activity.onSaveInstanceState(Bundle) and most of the discussion there applies here as well. Note however: this method may be called at any time before onDestroy(). There are many situations where a fragment may be mostly torn down (such as when placed on the back stack with no UI showing), but its state will not be saved until its owning activity actually needs to save its state.

Parameters
outState Bundle: Bundle in which to place your saved state.

onStart

public void onStart ()

Called when the Fragment is visible to the user. This is generally tied to Activity.onStart of the containing Activity's lifecycle.

onStop

public void onStop ()

Called when the Fragment is no longer started. This is generally tied to Activity.onStop of the containing Activity's lifecycle.

onViewStateRestored

public void onViewStateRestored (Bundle savedInstanceState)

Called when all saved state has been restored into the view hierarchy of the fragment. This can be used to do initialization based on saved state that you are letting the view hierarchy track itself, such as whether check box widgets are currently checked. This is called after onViewCreated(View, Bundle) and before onStart().

Parameters
savedInstanceState Bundle: If the fragment is being re-created from a previous saved state, this is the state.

requireDialog

public final Dialog requireDialog ()

Return the Dialog this fragment is currently controlling.

Returns
Dialog

Throws
IllegalStateException if the Dialog has not yet been created (before onCreateDialog(Bundle)) or has been destroyed (after onDestroyView().

See also:

setCancelable

public void setCancelable (boolean cancelable)

Control whether the shown Dialog is cancelable. Use this instead of directly calling Dialog.setCancelable(boolean), because DialogFragment needs to change its behavior based on this.

Parameters
cancelable boolean: If true, the dialog is cancelable. The default is true.

setShowsDialog

public void setShowsDialog (boolean showsDialog)

Controls whether this fragment should be shown in a dialog. If not set, no Dialog will be created and the fragment's view hierarchy will thus not be added to it. This allows you to instead use it as a normal fragment (embedded inside of its activity).

This is normally set for you based on whether the fragment is associated with a container view ID passed to FragmentTransaction.add(int, Fragment). If the fragment was added with a container, setShowsDialog will be initialized to false; otherwise, it will be true.

If calling this manually, it should be called in onCreate(Bundle) as calling it any later will have no effect.

Parameters
showsDialog boolean: If true, the fragment will be displayed in a Dialog. If false, no Dialog will be created and the fragment's view hierarchy left undisturbed.

setStyle

public void setStyle (int style, 
                int theme)

Call to customize the basic appearance and behavior of the fragment's dialog. This can be used for some common dialog behaviors, taking care of selecting flags, theme, and other options for you. The same effect can be achieve by manually setting Dialog and Window attributes yourself. Calling this after the fragment's Dialog is created will have no effect.

Parameters
style int: Selects a standard style: may be STYLE_NORMAL, STYLE_NO_TITLE, STYLE_NO_FRAME, or STYLE_NO_INPUT.

theme int: Optional custom theme. If 0, an appropriate theme (based on the style) will be selected for you.

show

public void show (FragmentManager manager, 
                String tag)

Display the dialog, adding the fragment to the given FragmentManager. This is a convenience for explicitly creating a transaction, adding the fragment to it with the given tag, and committing it. This does not add the transaction to the fragment back stack. When the fragment is dismissed, a new transaction will be executed to remove it from the activity.

Parameters
manager FragmentManager: The FragmentManager this fragment will be added to.

tag String: The tag for this fragment, as per FragmentTransaction.add.

show

public int show (FragmentTransaction transaction, 
                String tag)

Display the dialog, adding the fragment using an existing transaction and then committing the transaction.

Parameters
transaction FragmentTransaction: An existing transaction in which to add the fragment.

tag String: The tag for this fragment, as per FragmentTransaction.add.

Returns
int Returns the identifier of the committed transaction, as per FragmentTransaction.commit().

showNow

public void showNow (FragmentManager manager, 
                String tag)

Display the dialog, immediately adding the fragment to the given FragmentManager. This is a convenience for explicitly creating a transaction, adding the fragment to it with the given tag, and calling FragmentTransaction.commitNow(). This does not add the transaction to the fragment back stack. When the fragment is dismissed, a new transaction will be executed to remove it from the activity.

Parameters
manager FragmentManager: The FragmentManager this fragment will be added to.

tag String: The tag for this fragment, as per FragmentTransaction.add.