java.lang.Object | ||
↳ | android.support.v4.app.Fragment | |
↳ | android.support.v4.app.DialogFragment |
Known Direct Subclasses |
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.
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 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 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Dismiss the fragment and its dialog.
| |||||||||||
Version of
dismiss() that uses
FragmentTransaction.commitAllowingStateLoss() . | |||||||||||
Return the current value of
setShowsDialog(boolean) . | |||||||||||
Return the current value of
setCancelable(boolean) . | |||||||||||
Called when the fragment's activity has been created and this
fragment's view hierarchy instantiated.
| |||||||||||
Called when a fragment is first attached to its activity.
| |||||||||||
This method will be invoked when the dialog is canceled.
| |||||||||||
Called to do initial creation of a fragment.
| |||||||||||
Override to build your own custom Dialog container.
| |||||||||||
Remove dialog.
| |||||||||||
Called when the fragment is no longer attached to its activity.
| |||||||||||
This method will be invoked when the dialog is dismissed.
| |||||||||||
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.
| |||||||||||
Called when the Fragment is visible to the user.
| |||||||||||
Called when the Fragment is no longer started.
| |||||||||||
Control whether the shown Dialog is cancelable.
| |||||||||||
Controls whether this fragment should be shown in a dialog.
| |||||||||||
Call to customize the basic appearance and behavior of the
fragment's dialog.
| |||||||||||
Display the dialog, adding the fragment to the given FragmentManager.
| |||||||||||
Display the dialog, adding the fragment using an existing transaction
and then committing the transaction.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
android.support.v4.app.Fragment
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
android.content.ComponentCallbacks
| |||||||||||
From interface
android.content.DialogInterface.OnCancelListener
| |||||||||||
From interface
android.content.DialogInterface.OnDismissListener
| |||||||||||
From interface
android.view.View.OnCreateContextMenuListener
|
Style for setStyle(int, int)
: a basic,
normal dialog.
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.
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.
Style for setStyle(int, int)
: don't include
a title area.
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.
Version of dismiss()
that uses
FragmentTransaction.commitAllowingStateLoss()
. See linked
documentation for further details.
Called when the fragment's activity has been created and this
fragment's view hierarchy instantiated. It can be used to do final
initialization once these pieces are in place, such as retrieving
views or restoring state. It is also useful for fragments that use
setRetainInstance(boolean)
to retain their instance,
as this callback tells the fragment when it is fully associated with
the new activity instance. This is called after onCreateView(LayoutInflater, ViewGroup, Bundle)
and before onViewStateRestored(Bundle)
.
savedInstanceState | If the fragment is being re-created from a previous saved state, this is the state. |
---|
Called when a fragment is first attached to its activity.
onCreate(Bundle)
will be called after this.
This method will be invoked when the dialog is canceled.
dialog | The dialog that was canceled will be passed into the method. |
---|
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, see onActivityCreated(Bundle)
.
savedInstanceState | If the fragment is being re-created from a previous saved state, this is the state. |
---|
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)
.
savedInstanceState | The last saved instance state of the Fragment, or null if this is a freshly created Fragment. |
---|
Remove dialog.
Called when the fragment is no longer attached to its activity. This
is called after onDestroy()
.
This method will be invoked when the dialog is dismissed.
dialog | The dialog that was dismissed will be passed into the method. |
---|
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. 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
onActivityCreated(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.
outState | Bundle in which to place your saved state. |
---|
Called when the Fragment is visible to the user. This is generally
tied to Activity.onStart
of the containing
Activity's lifecycle.
Called when the Fragment is no longer started. This is generally
tied to Activity.onStop
of the containing
Activity's lifecycle.
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.
cancelable | If true, the dialog is cancelable. The default is true. |
---|
Controls whether this fragment should be shown in a dialog. If not
set, no Dialog will be created in onActivityCreated(Bundle)
,
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.
showsDialog | If true, the fragment will be displayed in a Dialog. If false, no Dialog will be created and the fragment's view hierarchly left undisturbed. |
---|
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.
style | Selects a standard style: may be STYLE_NORMAL ,
STYLE_NO_TITLE , STYLE_NO_FRAME , or
STYLE_NO_INPUT . |
---|---|
theme | Optional custom theme. If 0, an appropriate theme (based on the style) will be selected for you. |
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 back stack. When the fragment is dismissed, a new transaction will be executed to remove it from the activity.
manager | The FragmentManager this fragment will be added to. |
---|---|
tag | The tag for this fragment, as per
FragmentTransaction.add .
|
Display the dialog, adding the fragment using an existing transaction and then committing the transaction.
transaction | An existing transaction in which to add the fragment. |
---|---|
tag | The tag for this fragment, as per
FragmentTransaction.add . |
FragmentTransaction.commit()
.