java.lang.Object | ||
↳ | android.app.Dialog | |
↳ | android.app.AlertDialog |
Known Direct Subclasses |
A subclass of Dialog that can display one, two or three buttons. If you only want to display a String in this dialog box, use the setMessage() method. If you want to display a more complex view, look up the FrameLayout called "custom" and add your view to it:
FrameLayout fl = (FrameLayout) findViewById(android.R.id.custom); fl.addView(myView, new LayoutParams(MATCH_PARENT, WRAP_CONTENT));
The AlertDialog class takes care of automatically setting
WindowManager.LayoutParams.FLAG_ALT_FOCUSABLE_IM
for you based on whether
any views in the dialog return true from View.onCheckIsTextEditor()
. Generally you want this set for a Dialog
without text editors, so that it will be placed on top of the current
input method UI. You can modify this behavior by forcing the flag to your
desired mode after calling onCreate(Bundle)
.
For more information about creating dialogs, read the Dialogs developer guide.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
AlertDialog.Builder |
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
int | THEME_DEVICE_DEFAULT_DARK |
This constant was deprecated
in API level 23.
Use Theme_DeviceDefault_Dialog_Alert .
|
|||||||||
int | THEME_DEVICE_DEFAULT_LIGHT |
This constant was deprecated
in API level 23.
Use Theme_DeviceDefault_Light_Dialog_Alert .
|
|||||||||
int | THEME_HOLO_DARK |
This constant was deprecated
in API level 23.
Use Theme_Material_Dialog_Alert .
|
|||||||||
int | THEME_HOLO_LIGHT |
This constant was deprecated
in API level 23.
Use Theme_Material_Light_Dialog_Alert .
|
|||||||||
int | THEME_TRADITIONAL |
This constant was deprecated
in API level 23.
Use Theme_Material_Dialog_Alert .
|
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From interface
android.content.DialogInterface
|
Protected Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates an alert dialog that uses the default alert dialog theme.
| |||||||||||
Creates an alert dialog that uses the default alert dialog theme and a
custom cancel listener.
| |||||||||||
Creates an alert dialog that uses an explicit theme resource.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Gets one of the buttons used in the dialog.
| |||||||||||
Gets the list view used in the dialog.
| |||||||||||
A key was pressed down.
| |||||||||||
A key was released.
| |||||||||||
This method was deprecated
in API level 3.
Use
setButton(int, CharSequence, Message) with
BUTTON_POSITIVE .
| |||||||||||
Set a listener to be invoked when the positive button of the dialog is pressed.
| |||||||||||
This method was deprecated
in API level 3.
Use
setButton(int, CharSequence, android.content.DialogInterface.OnClickListener)
with BUTTON_POSITIVE
| |||||||||||
Set a message to be sent when a button is pressed.
| |||||||||||
This method was deprecated
in API level 3.
Use
setButton(int, CharSequence, android.content.DialogInterface.OnClickListener)
with BUTTON_NEGATIVE
| |||||||||||
This method was deprecated
in API level 3.
Use
setButton(int, CharSequence, Message) with
BUTTON_NEGATIVE .
| |||||||||||
This method was deprecated
in API level 3.
Use
setButton(int, CharSequence, android.content.DialogInterface.OnClickListener)
with BUTTON_POSITIVE
| |||||||||||
This method was deprecated
in API level 3.
Use
setButton(int, CharSequence, Message) with
BUTTON_NEUTRAL .
| |||||||||||
Set resId to 0 if you don't want an icon.
| |||||||||||
Set an icon as supplied by a theme attribute.
| |||||||||||
Set the title text for this dialog's window.
| |||||||||||
Set the view to display in that dialog, specifying the spacing to appear around that
view.
| |||||||||||
Set the view to display in that dialog.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Similar to
onCreate(Bundle) , you should initialize your dialog
in this method, including calling setContentView(View) .
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
android.app.Dialog
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
android.content.DialogInterface
| |||||||||||
From interface
android.view.Window.Callback
| |||||||||||
From interface
android.view.KeyEvent.Callback
| |||||||||||
From interface
android.view.View.OnCreateContextMenuListener
|
This constant was deprecated
in API level 23.
Use Theme_DeviceDefault_Dialog_Alert
.
Special theme constant for AlertDialog(Context, int)
: use
the device's default alert theme with a dark background.
This constant was deprecated
in API level 23.
Use Theme_DeviceDefault_Light_Dialog_Alert
.
Special theme constant for AlertDialog(Context, int)
: use
the device's default alert theme with a light background.
This constant was deprecated
in API level 23.
Use Theme_Material_Dialog_Alert
.
Special theme constant for AlertDialog(Context, int)
: use
the holographic alert theme with a dark background.
This constant was deprecated
in API level 23.
Use Theme_Material_Light_Dialog_Alert
.
Special theme constant for AlertDialog(Context, int)
: use
the holographic alert theme with a light background.
This constant was deprecated
in API level 23.
Use Theme_Material_Dialog_Alert
.
Special theme constant for AlertDialog(Context, int)
: use
the traditional (pre-Holo) alert dialog theme.
Creates an alert dialog that uses the default alert dialog theme.
The default alert dialog theme is defined by
alertDialogTheme
within the parent
context
's theme.
context | the parent context |
---|
Creates an alert dialog that uses the default alert dialog theme and a custom cancel listener.
This is functionally identical to:
AlertDialog dialog = new AlertDialog(context); alertDialog.setCancelable(cancelable); alertDialog.setOnCancelListener(cancelListener);
The default alert dialog theme is defined by
alertDialogTheme
within the parent
context
's theme.
context | the parent context |
---|
Creates an alert dialog that uses an explicit theme resource.
The specified theme resource (themeResId
) is applied on top of
the parent context
's theme. It may be specified as a style
resource containing a fully-populated theme, such as
Theme_Material_Dialog
, to replace all attributes
in the parent context
's theme including primary and accent
colors.
To preserve attributes such as primary and accent colors, the
themeResId
may instead be specified as an overlay theme such as
ThemeOverlay_Material_Dialog
. This will override
only the window attributes necessary to style the alert window as a
dialog.
Alternatively, the themeResId
may be specified as 0
to
use the parent context
's resolved value for
alertDialogTheme
.
context | the parent context |
---|---|
themeResId | the resource ID of the theme against which to inflate
this dialog, or 0 to use the parent
context 's default alert dialog theme |
Gets one of the buttons used in the dialog. Returns null if the specified
button does not exist or the dialog has not yet been fully created (for
example, via show()
or create()
).
whichButton | The identifier of the button that should be returned.
For example, this can be
BUTTON_POSITIVE . |
---|
Gets the list view used in the dialog.
ListView
from the dialog.
A key was pressed down.
If the focused view didn't want this event, this method is called.
The default implementation consumed the KEYCODE_BACK to later
handle it in onKeyUp(int, KeyEvent)
.
keyCode | The value in event.getKeyCode(). |
---|---|
event | Description of the key event. |
A key was released.
The default implementation handles KEYCODE_BACK to close the dialog.
keyCode | The value in event.getKeyCode(). |
---|---|
event | Description of the key event. |
This method was deprecated
in API level 3.
Use setButton(int, CharSequence, Message)
with
BUTTON_POSITIVE
.
Set a listener to be invoked when the positive button of the dialog is pressed.
whichButton | Which button to set the listener on, can be one of
BUTTON_POSITIVE ,
BUTTON_NEGATIVE , or
BUTTON_NEUTRAL |
---|---|
text | The text to display in positive button. |
listener | The DialogInterface.OnClickListener to use.
|
This method was deprecated
in API level 3.
Use
setButton(int, CharSequence, android.content.DialogInterface.OnClickListener)
with BUTTON_POSITIVE
Set a listener to be invoked when button 1 of the dialog is pressed.
text | The text to display in button 1. |
---|---|
listener | The DialogInterface.OnClickListener to use. |
Set a message to be sent when a button is pressed.
whichButton | Which button to set the message for, can be one of
BUTTON_POSITIVE ,
BUTTON_NEGATIVE , or
BUTTON_NEUTRAL |
---|---|
text | The text to display in positive button. |
msg | The Message to be sent when clicked.
|
This method was deprecated
in API level 3.
Use
setButton(int, CharSequence, android.content.DialogInterface.OnClickListener)
with BUTTON_NEGATIVE
Set a listener to be invoked when button 2 of the dialog is pressed.
text | The text to display in button 2. |
---|---|
listener | The DialogInterface.OnClickListener to use. |
This method was deprecated
in API level 3.
Use setButton(int, CharSequence, Message)
with
BUTTON_NEGATIVE
.
This method was deprecated
in API level 3.
Use
setButton(int, CharSequence, android.content.DialogInterface.OnClickListener)
with BUTTON_POSITIVE
Set a listener to be invoked when button 3 of the dialog is pressed.
text | The text to display in button 3. |
---|---|
listener | The DialogInterface.OnClickListener to use. |
This method was deprecated
in API level 3.
Use setButton(int, CharSequence, Message)
with
BUTTON_NEUTRAL
.
Set resId to 0 if you don't want an icon.
resId | the resourceId of the drawable to use as the icon or 0 if you don't want an icon. |
---|
Set an icon as supplied by a theme attribute. e.g. android.R.attr.alertDialogIcon
attrId | ID of a theme attribute that points to a drawable resource. |
---|
Set the title text for this dialog's window.
title | The new text to display in the title. |
---|
Set the view to display in that dialog, specifying the spacing to appear around that view.
view | The view to show in the content area of the dialog |
---|---|
viewSpacingLeft | Extra space to appear to the left of view |
viewSpacingTop | Extra space to appear above view |
viewSpacingRight | Extra space to appear to the right of view |
viewSpacingBottom | Extra space to appear below view
|
Similar to onCreate(Bundle)
, you should initialize your dialog
in this method, including calling setContentView(View)
.
savedInstanceState | If this dialog is being reinitalized after a
the hosting activity was previously shut down, holds the result from
the most recent call to onSaveInstanceState() , or null if this
is the first time.
|
---|