AlertDialog

Added in 1.1.0

Kotlin |Java

class AlertDialog : AppCompatDialog, DialogInterface

kotlin.Any
↳	android.app.Dialog
	↳	androidx.activity.ComponentDialog
		↳	androidx.appcompat.app.AppCompatDialog
			↳	androidx.appcompat.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.

Summary

Nested types
`class AlertDialog.Builder`

Protected constructors
`AlertDialog(context: Context)`
`AlertDialog(context: Context, themeResId: @StyleRes Int)` Construct an AlertDialog that uses an explicit theme.
`AlertDialog( context: Context, cancelable: Boolean, cancelListener: DialogInterface.OnCancelListener? )`

Public functions
`Button!`	`getButton(whichButton: Int)` Gets one of the buttons used in the dialog.
`ListView!`	`getListView()` Gets the list view used in the dialog.
`Boolean`	`onKeyDown(keyCode: Int, event: KeyEvent!)`
`Boolean`	`onKeyUp(keyCode: Int, event: KeyEvent!)`
`Unit`	`setButton( whichButton: Int, text: CharSequence!, listener: DialogInterface.OnClickListener! )` Sets a listener to be invoked when the positive button of the dialog is pressed.
`Unit`	`setButton(whichButton: Int, text: CharSequence!, msg: Message!)` Sets a message to be sent when a button is pressed.
`Unit`	`setButton( whichButton: Int, text: CharSequence!, icon: Drawable!, listener: DialogInterface.OnClickListener! )` 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.
`Unit`	`setCustomTitle(customTitleView: View!)` This method has no effect if called after `show`.
`Unit`	`setIcon(icon: Drawable!)` Set the `Drawable` to be used in the title.
`Unit`	`setIcon(resId: Int)` Set resId to 0 if you don't want an icon.
`Unit`	`setIconAttribute(attrId: Int)` Sets an icon as supplied by a theme attribute. e.g. android.R.attr.alertDialogIcon
`Unit`	`setMessage(message: CharSequence!)` Sets the message to display.
`Unit`	`setTitle(title: CharSequence!)`
`Unit`	`setView(view: View!)` Set the view to display in the dialog.
`Unit`	`setView( view: View!, viewSpacingLeft: Int, viewSpacingTop: Int, viewSpacingRight: Int, viewSpacingBottom: Int )` Set the view to display in the dialog, specifying the spacing to appear around that view.

Protected functions
`Unit`	`onCreate(savedInstanceState: Bundle!)`

Inherited Constants

From android.content.DialogInterface

`const Int`	`BUTTON1 = -1` This property is deprecated.
`const Int`	`BUTTON2 = -2` This property is deprecated.
`const Int`	`BUTTON3 = -3` This property is deprecated.
`const Int`	`BUTTON_NEGATIVE = -2`
`const Int`	`BUTTON_NEUTRAL = -3`
`const Int`	`BUTTON_POSITIVE = -1`

Inherited functions

From androidx.appcompat.app.AppCompatDialog

`Unit`	`addContentView(view: View, params: ViewGroup.LayoutParams!)`
`Unit`	`dismiss()`
`Boolean`	`dispatchKeyEvent(event: KeyEvent!)`
`T?`	`<T : View?> findViewById(id: @IdRes Int)`
`AppCompatDelegate`	`getDelegate()`
`ActionBar!`	`getSupportActionBar()` Support library version of `getActionBar`.
`Unit`	`onStop()`
`Unit`	`onSupportActionModeFinished(mode: ActionMode!)` Called when a support action mode has finished.
`Unit`	`onSupportActionModeStarted(mode: ActionMode!)` Called when a support action mode has been started.
`ActionMode?`	`onWindowStartingSupportActionMode(callback: ActionMode.Callback!)` Called when a support action mode is being started for this window.
`Unit`	`setContentView(layoutResID: @LayoutRes Int)`
`Unit`	`setContentView(view: View)`
`Unit`	`setContentView(view: View, params: ViewGroup.LayoutParams!)`
`Unit`	`setTitle(titleId: Int)`
`Boolean`	`supportRequestWindowFeature(featureId: Int)` Enable extended support library window features.

From androidx.activity.ComponentDialog

`Unit`	`addContentView(view: View!, params: ViewGroup.LayoutParams!)`
`Lifecycle!`	`getLifecycle()`
`SavedStateRegistry!`	`getSavedStateRegistry()`
`Unit`	`initializeViewTreeOwners()` Sets the view tree owners before setting the content view so that the inflation process and attach listeners will see them already present.
`Unit`	`onBackPressed()` This function is deprecated.
`Unit`	`onCreate(savedInstanceState: Bundle!)`
`Bundle!`	`onSaveInstanceState()`
`Unit`	`onStart()`
`Unit`	`onStop()`
`Unit`	`setContentView(layoutResID: Int)`

From android.app.Dialog

`Unit`	`addContentView(view: View!, params: ViewGroup.LayoutParams!)`
`Unit`	`closeOptionsMenu()`
`Unit`	`create()`
`Boolean`	`dispatchGenericMotionEvent(ev: MotionEvent!)`
`Boolean`	`dispatchKeyEvent(event: KeyEvent!)`
`Boolean`	`dispatchKeyShortcutEvent(event: KeyEvent!)`
`Boolean`	`dispatchPopulateAccessibilityEvent(event: AccessibilityEvent!)`
`Boolean`	`dispatchTouchEvent(ev: MotionEvent!)`
`Boolean`	`dispatchTrackballEvent(ev: MotionEvent!)`
`T!`	`<T : View?> findViewById(id: Int)`
`ActionBar!`	`getActionBar()`
`Context!`	`getContext()`
`View!`	`getCurrentFocus()`
`LayoutInflater!`	`getLayoutInflater()`
`OnBackInvokedDispatcher!`	`getOnBackInvokedDispatcher()`
`Activity!`	`getOwnerActivity()`
`SearchEvent!`	`getSearchEvent()`
`Int`	`getVolumeControlStream()`
`Window!`	`getWindow()`
`Unit`	`hide()`
`Unit`	`invalidateOptionsMenu()`
`Boolean`	`isShowing()`
`Unit`	`onActionModeFinished(mode: ActionMode!)`
`Unit`	`onActionModeStarted(mode: ActionMode!)`
`Unit`	`onAttachedToWindow()`
`Unit`	`onBackPressed()` This function is deprecated.
`Unit`	`onContentChanged()`
`Boolean`	`onContextItemSelected(item: MenuItem!)`
`Unit`	`onContextMenuClosed(menu: Menu!)`
`Unit`	`onCreate(savedInstanceState: Bundle!)`
`Unit`	`onCreateContextMenu( menu: ContextMenu!, v: View!, menuInfo: ContextMenu.ContextMenuInfo! )`
`Boolean`	`onCreateOptionsMenu(menu: Menu!)`
`Boolean`	`onCreatePanelMenu(featureId: Int, menu: Menu!)`
`View!`	`onCreatePanelView(featureId: Int)`
`Unit`	`onDetachedFromWindow()`
`Boolean`	`onGenericMotionEvent(event: MotionEvent!)`
`Boolean`	`onKeyLongPress(keyCode: Int, event: KeyEvent!)`
`Boolean`	`onKeyMultiple(keyCode: Int, repeatCount: Int, event: KeyEvent!)`
`Boolean`	`onKeyShortcut(keyCode: Int, event: KeyEvent!)`
`Boolean`	`onMenuItemSelected(featureId: Int, item: MenuItem!)`
`Boolean`	`onMenuOpened(featureId: Int, menu: Menu!)`
`Boolean`	`onOptionsItemSelected(item: MenuItem!)`
`Unit`	`onOptionsMenuClosed(menu: Menu!)`
`Unit`	`onPanelClosed(featureId: Int, menu: Menu!)`
`Boolean`	`onPrepareOptionsMenu(menu: Menu!)`
`Boolean`	`onPreparePanel(featureId: Int, view: View!, menu: Menu!)`
`Unit`	`onRestoreInstanceState(savedInstanceState: Bundle!)`
`Bundle!`	`onSaveInstanceState()`
`Boolean`	`onSearchRequested(searchEvent: SearchEvent!)`
`Unit`	`onStart()`
`Unit`	`onStop()`
`Boolean`	`onTouchEvent(event: MotionEvent!)`
`Boolean`	`onTrackballEvent(event: MotionEvent!)`
`Unit`	`onWindowAttributesChanged(params: WindowManager.LayoutParams!)`
`Unit`	`onWindowFocusChanged(hasFocus: Boolean)`
`ActionMode!`	`onWindowStartingActionMode(callback: ActionMode.Callback!)`
`Unit`	`openContextMenu(view: View!)`
`Unit`	`openOptionsMenu()`
`Unit`	`registerForContextMenu(view: View!)`
`Boolean`	`requestWindowFeature(featureId: Int)`
`T!`	`<T : View?> requireViewById(id: Int)`
`Unit`	`setCancelMessage(msg: Message!)`
`Unit`	`setCancelable(flag: Boolean)`
`Unit`	`setCanceledOnTouchOutside(cancel: Boolean)`
`Unit`	`setContentView(layoutResID: Int)`
`Unit`	`setDismissMessage(msg: Message!)`
`Unit`	`setFeatureDrawable(featureId: Int, drawable: Drawable!)`
`Unit`	`setFeatureDrawableAlpha(featureId: Int, alpha: Int)`
`Unit`	`setFeatureDrawableResource(featureId: Int, resId: Int)`
`Unit`	`setFeatureDrawableUri(featureId: Int, uri: Uri!)`
`Unit`	`setOnCancelListener(listener: DialogInterface.OnCancelListener!)`
`Unit`	`setOnDismissListener(listener: DialogInterface.OnDismissListener!)`
`Unit`	`setOnKeyListener(onKeyListener: DialogInterface.OnKeyListener!)`
`Unit`	`setOnShowListener(listener: DialogInterface.OnShowListener!)`
`Unit`	`setOwnerActivity(activity: Activity!)`
`Unit`	`setTitle(title: CharSequence!)`
`Unit`	`setVolumeControlStream(streamType: Int)`
`Unit`	`show()`
`Unit`	`takeKeyEvents(get: Boolean)`
`Unit`	`unregisterForContextMenu(view: View!)`

From android.content.DialogInterface

`abstract Unit`	`cancel()`
`abstract Unit`	`dismiss()`

From androidx.lifecycle.LifecycleOwner

abstract Lifecycle!

getLifecycle()

From androidx.savedstate.SavedStateRegistryOwner

abstract SavedStateRegistry!

getSavedStateRegistry()

From android.view.Window.Callback

`Unit`	`onPointerCaptureChanged(hasCapture: Boolean)`
`Unit`	`onProvideKeyboardShortcuts( data: (Mutable)List<KeyboardShortcutGroup!>!, menu: Menu!, deviceId: Int )`

Inherited properties

From androidx.activity.ComponentDialog

OnBackPressedDispatcher!

onBackPressedDispatcher

The OnBackPressedDispatcher that should handle the system back button.

Protected constructors

AlertDialog

Added in 1.1.0

protected AlertDialog(context: Context)

AlertDialog

Added in 1.1.0

protected AlertDialog(context: Context, themeResId: @StyleRes Int)

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.

AlertDialog

Added in 1.1.0

protected AlertDialog(
    context: Context,
    cancelable: Boolean,
    cancelListener: DialogInterface.OnCancelListener?
)

Public functions

getButton

Added in 1.1.0

fun getButton(whichButton: Int): Button!

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 1.1.0

fun getListView(): ListView!

Gets the list view used in the dialog.

Returns
`ListView!`	The `ListView` from the dialog.

onKeyDown

fun onKeyDown(keyCode: Int, event: KeyEvent!): Boolean

onKeyUp

fun onKeyUp(keyCode: Int, event: KeyEvent!): Boolean

setButton

Added in 1.1.0

fun setButton(
    whichButton: Int,
    text: CharSequence!,
    listener: DialogInterface.OnClickListener!
): Unit

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 1.1.0

fun setButton(whichButton: Int, text: CharSequence!, msg: Message!): Unit

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.

setButton

Added in 1.1.0

fun setButton(
    whichButton: Int,
    text: CharSequence!,
    icon: Drawable!,
    listener: DialogInterface.OnClickListener!
): Unit

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.

setCustomTitle

Added in 1.1.0

fun setCustomTitle(customTitleView: View!): Unit

This method has no effect if called after show.

See also
`setCustomTitle`

setIcon

Added in 1.1.0

fun setIcon(icon: Drawable!): Unit

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 1.1.0

fun setIcon(resId: Int): Unit

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 1.1.0

fun setIconAttribute(attrId: Int): Unit

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 1.1.0

fun setMessage(message: CharSequence!): Unit

Sets the message to display.

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

setTitle

fun setTitle(title: CharSequence!): Unit

setView

Added in 1.1.0

fun setView(view: View!): Unit

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

setView

Added in 1.1.0

fun setView(
    view: View!,
    viewSpacingLeft: Int,
    viewSpacingTop: Int,
    viewSpacingRight: Int,
    viewSpacingBottom: Int
): Unit

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`

Protected functions

onCreate

protected fun onCreate(savedInstanceState: Bundle!): Unit

AlertDialog

Summary

Nested types

Protected constructors

Public functions

Protected functions

Inherited Constants

Inherited functions

Inherited properties

Protected constructors

AlertDialog

AlertDialog

AlertDialog

Public functions

getButton

getListView

onKeyDown

onKeyUp

setButton

setButton

setButton

setCustomTitle

setIcon

setIcon

setIconAttribute

setMessage

setTitle

setView

setView

Protected functions

onCreate