added in version 24.1.0
belongs to Maven artifact com.android.support:appcompat-v7:28.0.0-alpha1

Summary: Nested Classes | Inherited Constants | Protected Ctors | Methods | Protected Methods | Inherited Methods | [Expand All]

AlertDialog

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 AlertDialog
extends AppCompatDialog implements DialogInterface

java.lang.Object
↳	android.app.Dialog
	↳	android.support.v7.app.AppCompatDialog
		↳	android.support.v7.app.AlertDialog

Known Direct Subclasses MediaRouteControllerDialog MediaRouteControllerDialog This class implements the route controller dialog for MediaRouter.

---

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 = findViewById(android.R.id.custom);
 fl.addView(myView, new LayoutParams(MATCH_PARENT, WRAP_CONTENT));
 

The AlertDialog class takes care of automatically setting android.view.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).

Developer Guides

For more information about creating dialogs, read the Dialogs developer guide.

Summary

Nested classes
class	AlertDialog.Builder

Inherited constants
From interface android.content.DialogInterface int BUTTON1 int BUTTON2 int BUTTON3 int BUTTON_NEGATIVE int BUTTON_NEUTRAL int BUTTON_POSITIVE

Protected constructors
AlertDialog(Context context)
AlertDialog(Context context, int themeResId) Construct an AlertDialog that uses an explicit theme.
AlertDialog(Context context, boolean cancelable, DialogInterface.OnCancelListener cancelListener)

Public methods
Button	getButton(int whichButton) Gets one of the buttons used in the dialog.
ListView	getListView() Gets the list view used in the dialog.
boolean	onKeyDown(int keyCode, KeyEvent event)
boolean	onKeyUp(int keyCode, KeyEvent event)
void	setButton(int whichButton, CharSequence text, Drawable icon, DialogInterface.OnClickListener listener) Sets an icon to be displayed along with the button text and a listener to be invoked when the positive button of the dialog is pressed.
void	setButton(int whichButton, CharSequence text, DialogInterface.OnClickListener listener) Sets a listener to be invoked when the positive button of the dialog is pressed.
void	setButton(int whichButton, CharSequence text, Message msg) Sets a message to be sent when a button is pressed.
void	setCustomTitle(View customTitleView) This method has no effect if called after show().
void	setIcon(Drawable icon) Set the Drawable to be used in the title.
void	setIcon(int resId) Set resId to 0 if you don't want an icon.
void	setIconAttribute(int attrId) Sets an icon as supplied by a theme attribute.
void	setMessage(CharSequence message) Sets the message to display.
void	setTitle(CharSequence title)
void	setView(View view, int viewSpacingLeft, int viewSpacingTop, int viewSpacingRight, int viewSpacingBottom) Set the view to display in the dialog, specifying the spacing to appear around that view.
void	setView(View view) Set the view to display in the dialog.

Protected methods
void	onCreate(Bundle savedInstanceState)

Inherited methods
From class android.support.v7.app.AppCompatDialog void addContentView(View view, ViewGroup.LayoutParams params) <T extends View> T findViewById(int id) AppCompatDelegate getDelegate() ActionBar getSupportActionBar() Support library version of getActionBar(). void onCreate(Bundle savedInstanceState) void onStop() void onSupportActionModeFinished(ActionMode mode) Called when a support action mode has finished. void onSupportActionModeStarted(ActionMode mode) Called when a support action mode has been started. ActionMode onWindowStartingSupportActionMode(ActionMode.Callback callback) Called when a support action mode is being started for this window. void setContentView(View view) void setContentView(int layoutResID) void setContentView(View view, ViewGroup.LayoutParams params) void setTitle(CharSequence title) void setTitle(int titleId) boolean supportRequestWindowFeature(int featureId) Enable extended support library window features.
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() 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 android.support.v7.app.AppCompatCallback abstract void onSupportActionModeFinished(ActionMode mode) Called when a support action mode has finished. abstract void onSupportActionModeStarted(ActionMode mode) Called when a support action mode has been started. abstract ActionMode onWindowStartingSupportActionMode(ActionMode.Callback callback) Called when a support action mode is being started for this window.
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)

Protected constructors

AlertDialog

added in version 24.1.0

AlertDialog (Context context)

Parameters
context	Context

AlertDialog

added in version 24.1.0

AlertDialog (Context context, 
                int themeResId)

Construct an AlertDialog that uses an explicit theme. The actual style that an AlertDialog uses is a private implementation, however you can here supply either the name of an attribute in the theme from which to get the dialog's style (such as alertDialogTheme.

Parameters
context	Context
themeResId	int

AlertDialog

added in version 24.1.0

AlertDialog (Context context, 
                boolean cancelable, 
                DialogInterface.OnCancelListener cancelListener)

Parameters
context	Context
cancelable	boolean
cancelListener	DialogInterface.OnCancelListener

Public methods

getButton

added in version 24.1.0

Button getButton (int whichButton)

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

Parameters
whichButton	int: The identifier of the button that should be returned. For example, this can be BUTTON_POSITIVE.

Returns
Button	The button from the dialog, or null if a button does not exist.

getListView

added in version 24.1.0

ListView getListView ()

Gets the list view used in the dialog.

Returns
ListView	The ListView from the dialog.

onKeyDown

boolean onKeyDown (int keyCode, 
                KeyEvent event)

Parameters
keyCode	int
event	KeyEvent

Returns
boolean

onKeyUp

boolean onKeyUp (int keyCode, 
                KeyEvent event)

Parameters
keyCode	int
event	KeyEvent

Returns
boolean

setButton

added in version 27.1.0

void setButton (int whichButton, 
                CharSequence text, 
                Drawable icon, 
                DialogInterface.OnClickListener listener)

Sets an icon to be displayed along with the button text and a listener to be invoked when the positive button of the dialog is pressed. This method has no effect if called after show().

Parameters
whichButton	int: Which button to set the listener on, can be one of BUTTON_POSITIVE, BUTTON_NEGATIVE, or BUTTON_NEUTRAL
text	CharSequence: The text to display in positive button.
icon	Drawable: The Drawable to be set as an icon for the button.
listener	DialogInterface.OnClickListener: The DialogInterface.OnClickListener to use.

setButton

added in version 24.1.0

void setButton (int whichButton, 
                CharSequence text, 
                DialogInterface.OnClickListener listener)

Sets a listener to be invoked when the positive button of the dialog is pressed. This method has no effect if called after show().

Parameters
whichButton	int: Which button to set the listener on, can be one of BUTTON_POSITIVE, BUTTON_NEGATIVE, or BUTTON_NEUTRAL
text	CharSequence: The text to display in positive button.
listener	DialogInterface.OnClickListener: The DialogInterface.OnClickListener to use.

setButton

added in version 24.1.0

void setButton (int whichButton, 
                CharSequence text, 
                Message msg)

Sets a message to be sent when a button is pressed. This method has no effect if called after show().

Parameters
whichButton	int: Which button to set the message for, can be one of BUTTON_POSITIVE, BUTTON_NEGATIVE, or BUTTON_NEUTRAL
text	CharSequence: The text to display in positive button.
msg	Message: The Message to be sent when clicked.

setCustomTitle

added in version 24.1.0

void setCustomTitle (View customTitleView)

This method has no effect if called after show().

Parameters
customTitleView	View

See also:

• setCustomTitle(View)

setIcon

added in version 24.1.0

void setIcon (Drawable icon)

Set the Drawable to be used in the title.

Parameters
icon	Drawable: Drawable to use as the icon or null if you don't want an icon.

setIcon

added in version 24.1.0

void setIcon (int resId)

Set resId to 0 if you don't want an icon.

Parameters
resId	int: the resourceId of the drawable to use as the icon or 0 if you don't want an icon.

setIconAttribute

added in version 24.1.0

void setIconAttribute (int attrId)

Sets an icon as supplied by a theme attribute. e.g. android.R.attr.alertDialogIcon

Parameters
attrId	int: ID of a theme attribute that points to a drawable resource.

setMessage

added in version 24.1.0

void setMessage (CharSequence message)

Sets the message to display.

Parameters
message	CharSequence: The message to display in the dialog.

setTitle

void setTitle (CharSequence title)

Parameters
title	CharSequence

setView

added in version 24.1.0

void setView (View view, 
                int viewSpacingLeft, 
                int viewSpacingTop, 
                int viewSpacingRight, 
                int viewSpacingBottom)

Set the view to display in the dialog, specifying the spacing to appear around that view. This method has no effect if called after show().

Parameters
view	View: The view to show in the content area of the dialog
viewSpacingLeft	int: Extra space to appear to the left of view
viewSpacingTop	int: Extra space to appear above view
viewSpacingRight	int: Extra space to appear to the right of view
viewSpacingBottom	int: Extra space to appear below view

setView

added in version 24.1.0

void setView (View view)

Set the view to display in the dialog. This method has no effect if called after show().

Parameters
view	View

Protected methods

onCreate

void onCreate (Bundle savedInstanceState)

Parameters
savedInstanceState	Bundle

• Interfaces

  • ActionBar.OnMenuVisibilityListener
  • ActionBar.OnNavigationListener
  • ActionBar.TabListener
  • ActionBarDrawerToggle.Delegate
  • ActionBarDrawerToggle.DelegateProvider
  • AppCompatCallback

• Classes

  • ActionBar
  • ActionBar.LayoutParams
  • ActionBar.Tab
  • ActionBarDrawerToggle
  • AlertDialog
  • AlertDialog.Builder
  • AppCompatActivity
  • AppCompatDelegate
  • AppCompatDialog
  • AppCompatDialogFragment
  • AppCompatViewInflater
  • MediaRouteActionProvider
  • MediaRouteButton
  • MediaRouteChooserDialog
  • MediaRouteChooserDialogFragment
  • MediaRouteControllerDialog
  • MediaRouteControllerDialogFragment
  • MediaRouteDialogFactory
  • MediaRouteDiscoveryFragment