Android APIs
java.lang.Object
   ↳ android.preference.Preference
     ↳ android.preference.DialogPreference
Known Direct Subclasses

Class Overview

A base class for Preference objects that are dialog-based. These preferences will, when clicked, open a dialog showing the actual preference controls.

Summary

XML Attributes
Attribute Name Related Method Description
android:dialogIcon The icon for the dialog. 
android:dialogLayout A layout to be used as the content View for the dialog. 
android:dialogMessage The message in the dialog. 
android:dialogTitle The title in the dialog. 
android:negativeButtonText The negative button text for the dialog. 
android:positiveButtonText The positive button text for the dialog. 
[Expand]
Inherited XML Attributes
From class android.preference.Preference
[Expand]
Inherited Constants
From class android.preference.Preference
Public Constructors
DialogPreference(Context context, AttributeSet attrs, int defStyle)
DialogPreference(Context context, AttributeSet attrs)
Public Methods
Dialog getDialog()
Gets the dialog that is shown by this preference.
Drawable getDialogIcon()
Returns the icon to be shown on subsequent dialogs.
int getDialogLayoutResource()
Returns the layout resource that is used as the content View for subsequent dialogs.
CharSequence getDialogMessage()
Returns the message to be shown on subsequent dialogs.
CharSequence getDialogTitle()
Returns the title to be shown on subsequent dialogs.
CharSequence getNegativeButtonText()
Returns the text of the negative button to be shown on subsequent dialogs.
CharSequence getPositiveButtonText()
Returns the text of the positive button to be shown on subsequent dialogs.
void onActivityDestroy()
See Activity's onDestroy.
void onClick(DialogInterface dialog, int which)
This method will be invoked when a button in the dialog is clicked.
void onDismiss(DialogInterface dialog)
This method will be invoked when the dialog is dismissed.
void setDialogIcon(int dialogIconRes)
Sets the icon (resource ID) of the dialog.
void setDialogIcon(Drawable dialogIcon)
Sets the icon of the dialog.
void setDialogLayoutResource(int dialogLayoutResId)
Sets the layout resource that is inflated as the View to be shown as the content View of subsequent dialogs.
void setDialogMessage(CharSequence dialogMessage)
Sets the message of the dialog.
void setDialogMessage(int dialogMessageResId)
void setDialogTitle(int dialogTitleResId)
void setDialogTitle(CharSequence dialogTitle)
Sets the title of the dialog.
void setNegativeButtonText(int negativeButtonTextResId)
void setNegativeButtonText(CharSequence negativeButtonText)
Sets the text of the negative button of the dialog.
void setPositiveButtonText(int positiveButtonTextResId)
void setPositiveButtonText(CharSequence positiveButtonText)
Sets the text of the positive button of the dialog.
Protected Methods
void onBindDialogView(View view)
Binds views in the content View of the dialog to data.
void onClick()
Processes a click on the preference.
View onCreateDialogView()
Creates the content view for the dialog (if a custom content view is required).
void onDialogClosed(boolean positiveResult)
Called when the dialog is dismissed and should be used to save data to the SharedPreferences.
void onPrepareDialogBuilder(AlertDialog.Builder builder)
Prepares the dialog builder to be shown when the preference is clicked.
void onRestoreInstanceState(Parcelable state)
Hook allowing a Preference to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState().
Parcelable onSaveInstanceState()
Hook allowing a Preference to generate a representation of its internal state that can later be used to create a new instance with that same state.
void showDialog(Bundle state)
Shows the dialog associated with this Preference.
[Expand]
Inherited Methods
From class android.preference.Preference
From class java.lang.Object
From interface android.content.DialogInterface.OnClickListener
From interface android.content.DialogInterface.OnDismissListener
From interface android.preference.PreferenceManager.OnActivityDestroyListener
From interface java.lang.Comparable

XML Attributes

android:dialogIcon

The icon for the dialog.

Must be a reference to another resource, in the form "@[+][package:]type:name" or to a theme attribute in the form "?[package:][type:]name".

This corresponds to the global attribute resource symbol dialogIcon.

Related Methods

android:dialogLayout

A layout to be used as the content View for the dialog. By default, this shouldn't be needed. If a custom DialogPreference is required, this should be set. For example, the EditTextPreference uses a layout with an EditText as this attribute.

Must be a reference to another resource, in the form "@[+][package:]type:name" or to a theme attribute in the form "?[package:][type:]name".

This corresponds to the global attribute resource symbol dialogLayout.

Related Methods

android:dialogMessage

The message in the dialog. If a dialogLayout is provided and contains a TextView with ID android:id/message, this message will be placed in there.

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol dialogMessage.

Related Methods

android:dialogTitle

The title in the dialog.

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol dialogTitle.

Related Methods

android:negativeButtonText

The negative button text for the dialog. Set to @null to hide the negative button.

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol negativeButtonText.

Related Methods

android:positiveButtonText

The positive button text for the dialog. Set to @null to hide the positive button.

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol positiveButtonText.

Related Methods

Public Constructors

public DialogPreference (Context context, AttributeSet attrs, int defStyle)

Added in API level 1

public DialogPreference (Context context, AttributeSet attrs)

Added in API level 1

Public Methods

public Dialog getDialog ()

Added in API level 3

Gets the dialog that is shown by this preference.

Returns
  • The dialog, or null if a dialog is not being shown.

public Drawable getDialogIcon ()

Added in API level 1

Returns the icon to be shown on subsequent dialogs.

Returns

public int getDialogLayoutResource ()

Added in API level 1

Returns the layout resource that is used as the content View for subsequent dialogs.

Returns
  • The layout resource.

public CharSequence getDialogMessage ()

Added in API level 1

Returns the message to be shown on subsequent dialogs.

Returns
  • The message.

public CharSequence getDialogTitle ()

Added in API level 1

Returns the title to be shown on subsequent dialogs.

Returns
  • The title.

public CharSequence getNegativeButtonText ()

Added in API level 1

Returns the text of the negative button to be shown on subsequent dialogs.

Returns
  • The text of the negative button.

public CharSequence getPositiveButtonText ()

Added in API level 1

Returns the text of the positive button to be shown on subsequent dialogs.

Returns
  • The text of the positive button.

public void onActivityDestroy ()

Added in API level 1

See Activity's onDestroy.

public void onClick (DialogInterface dialog, int which)

Added in API level 1

This method will be invoked when a button in the dialog is clicked.

Parameters
dialog The dialog that received the click.
which The button that was clicked (e.g. BUTTON1) or the position of the item clicked.

public void onDismiss (DialogInterface dialog)

Added in API level 1

This method will be invoked when the dialog is dismissed.

Parameters
dialog The dialog that was dismissed will be passed into the method.

public void setDialogIcon (int dialogIconRes)

Added in API level 1

Sets the icon (resource ID) of the dialog. This will be shown on subsequent dialogs.

Parameters
dialogIconRes The icon, as a resource ID.

public void setDialogIcon (Drawable dialogIcon)

Added in API level 1

Sets the icon of the dialog. This will be shown on subsequent dialogs.

Parameters
dialogIcon The icon, as a Drawable.

public void setDialogLayoutResource (int dialogLayoutResId)

Added in API level 1

Sets the layout resource that is inflated as the View to be shown as the content View of subsequent dialogs.

Parameters
dialogLayoutResId The layout resource ID to be inflated.

public void setDialogMessage (CharSequence dialogMessage)

Added in API level 1

Sets the message of the dialog. This will be shown on subsequent dialogs.

This message forms the content View of the dialog and conflicts with list-based dialogs, for example. If setting a custom View on a dialog via setDialogLayoutResource(int), include a text View with ID message and it will be populated with this message.

Parameters
dialogMessage The message.

public void setDialogMessage (int dialogMessageResId)

Added in API level 1

Parameters
dialogMessageResId The dialog message as a resource.

public void setDialogTitle (int dialogTitleResId)

Added in API level 1

Parameters
dialogTitleResId The dialog title as a resource.

public void setDialogTitle (CharSequence dialogTitle)

Added in API level 1

Sets the title of the dialog. This will be shown on subsequent dialogs.

Parameters
dialogTitle The title.

public void setNegativeButtonText (int negativeButtonTextResId)

Added in API level 1

Parameters
negativeButtonTextResId The negative button text as a resource.

public void setNegativeButtonText (CharSequence negativeButtonText)

Added in API level 1

Sets the text of the negative button of the dialog. This will be shown on subsequent dialogs.

Parameters
negativeButtonText The text of the negative button.

public void setPositiveButtonText (int positiveButtonTextResId)

Added in API level 1

Parameters
positiveButtonTextResId The positive button text as a resource.

public void setPositiveButtonText (CharSequence positiveButtonText)

Added in API level 1

Sets the text of the positive button of the dialog. This will be shown on subsequent dialogs.

Parameters
positiveButtonText The text of the positive button.

Protected Methods

protected void onBindDialogView (View view)

Added in API level 1

Binds views in the content View of the dialog to data.

Make sure to call through to the superclass implementation.

Parameters
view The content View of the dialog, if it is custom.

protected void onClick ()

Added in API level 1

Processes a click on the preference. This includes saving the value to the SharedPreferences. However, the overridden method should call callChangeListener(Object) to make sure the client wants to update the preference's state with the new value.

protected View onCreateDialogView ()

Added in API level 1

Creates the content view for the dialog (if a custom content view is required). By default, it inflates the dialog layout resource if it is set.

Returns
  • The content View for the dialog.

protected void onDialogClosed (boolean positiveResult)

Added in API level 1

Called when the dialog is dismissed and should be used to save data to the SharedPreferences.

Parameters
positiveResult Whether the positive button was clicked (true), or the negative button was clicked or the dialog was canceled (false).

protected void onPrepareDialogBuilder (AlertDialog.Builder builder)

Added in API level 1

Prepares the dialog builder to be shown when the preference is clicked. Use this to set custom properties on the dialog.

Do not create() or show().

protected void onRestoreInstanceState (Parcelable state)

Added in API level 1

Hook allowing a Preference to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState(). This function will never be called with a null state.

Parameters
state The saved state that had previously been returned by onSaveInstanceState().

protected Parcelable onSaveInstanceState ()

Added in API level 1

Hook allowing a Preference to generate a representation of its internal state that can later be used to create a new instance with that same state. This state should only contain information that is not persistent or can be reconstructed later.

Returns
  • A Parcelable object containing the current dynamic state of this Preference, or null if there is nothing interesting to save. The default implementation returns null.

protected void showDialog (Bundle state)

Added in API level 1

Shows the dialog associated with this Preference. This is normally initiated automatically on clicking on the preference. Call this method if you need to show the dialog on some other event.

Parameters
state Optional instance state to restore on the dialog