DialogPreference
public
abstract
class
DialogPreference
extends Preference
implements
DialogInterface.OnClickListener,
DialogInterface.OnDismissListener,
PreferenceManager.OnActivityDestroyListener
java.lang.Object | ||
↳ | android.preference.Preference | |
↳ | android.preference.DialogPreference |
This class was deprecated
in API level 29.
Use the AndroidX
Preference Library for consistent behavior across all devices. For more information on
using the AndroidX Preference Library see
Settings.
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 | |
---|---|
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. |
Inherited XML attributes | |
---|---|
Inherited constants |
---|
Public constructors | |
---|---|
DialogPreference(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
|
|
DialogPreference(Context context, AttributeSet attrs, int defStyleAttr)
|
|
DialogPreference(Context context, AttributeSet attrs)
|
|
DialogPreference(Context context)
|
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 |
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(CharSequence negativeButtonText)
Sets the text of the negative button of the dialog. |
void
|
setNegativeButtonText(int negativeButtonTextResId)
|
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 |
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 |
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. |
Inherited methods | |
---|---|
XML attributes
android:dialogIcon
The icon for the dialog.
May be a reference to another resource, in the form
"@[+][package:]type/name
" or a theme
attribute in the form
"?[package:]type/name
".
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.
May be a reference to another resource, in the form
"@[+][package:]type/name
" or a theme
attribute in the form
"?[package:]type/name
".
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.
May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;
android:dialogTitle
The title in the dialog.
May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;
android:negativeButtonText
The negative button text for the dialog. Set to @null to hide the negative button.
May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;
android:positiveButtonText
The positive button text for the dialog. Set to @null to hide the positive button.
May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;
Public constructors
DialogPreference
public DialogPreference (Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
Parameters | |
---|---|
context |
Context |
attrs |
AttributeSet |
defStyleAttr |
int |
defStyleRes |
int |
DialogPreference
public DialogPreference (Context context, AttributeSet attrs, int defStyleAttr)
Parameters | |
---|---|
context |
Context |
attrs |
AttributeSet |
defStyleAttr |
int |
DialogPreference
public DialogPreference (Context context, AttributeSet attrs)
Parameters | |
---|---|
context |
Context |
attrs |
AttributeSet |
DialogPreference
public DialogPreference (Context context)
Parameters | |
---|---|
context |
Context |
Public methods
getDialog
public Dialog getDialog ()
Gets the dialog that is shown by this preference.
Returns | |
---|---|
Dialog |
The dialog, or null if a dialog is not being shown. |
getDialogIcon
public Drawable getDialogIcon ()
Returns the icon to be shown on subsequent dialogs.
Returns | |
---|---|
Drawable |
The icon, as a Drawable . |
getDialogLayoutResource
public int getDialogLayoutResource ()
Returns the layout resource that is used as the content View for subsequent dialogs.
Returns | |
---|---|
int |
The layout resource. |
getDialogMessage
public CharSequence getDialogMessage ()
Returns the message to be shown on subsequent dialogs.
Returns | |
---|---|
CharSequence |
The message. |
getDialogTitle
public CharSequence getDialogTitle ()
Returns the title to be shown on subsequent dialogs.
Returns | |
---|---|
CharSequence |
The title. |
getNegativeButtonText
public CharSequence getNegativeButtonText ()
Returns the text of the negative button to be shown on subsequent dialogs.
Returns | |
---|---|
CharSequence |
The text of the negative button. |
getPositiveButtonText
public CharSequence getPositiveButtonText ()
Returns the text of the positive button to be shown on subsequent dialogs.
Returns | |
---|---|
CharSequence |
The text of the positive button. |
onClick
public void onClick (DialogInterface dialog, int which)
This method will be invoked when a button in the dialog is clicked.
Parameters | |
---|---|
dialog |
DialogInterface : the dialog that received the click |
which |
int : the button that was clicked (ex.
DialogInterface#BUTTON_POSITIVE ) or the position
of the item clicked |
onDismiss
public void onDismiss (DialogInterface dialog)
This method will be invoked when the dialog is dismissed.
Parameters | |
---|---|
dialog |
DialogInterface : the dialog that was dismissed will be passed into the
method |
setDialogIcon
public void setDialogIcon (int dialogIconRes)
Sets the icon (resource ID) of the dialog. This will be shown on subsequent dialogs.
Parameters | |
---|---|
dialogIconRes |
int : The icon, as a resource ID. |
setDialogIcon
public void setDialogIcon (Drawable dialogIcon)
Sets the icon of the dialog. This will be shown on subsequent dialogs.
Parameters | |
---|---|
dialogIcon |
Drawable : The icon, as a Drawable . |
setDialogLayoutResource
public void setDialogLayoutResource (int dialogLayoutResId)
Sets the layout resource that is inflated as the View
to be shown
as the content View of subsequent dialogs.
Parameters | |
---|---|
dialogLayoutResId |
int : The layout resource ID to be inflated. |
See also:
setDialogMessage
public void setDialogMessage (CharSequence dialogMessage)
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
R.id.message
and it will be populated with this message.
Parameters | |
---|---|
dialogMessage |
CharSequence : The message. |
setDialogMessage
public void setDialogMessage (int dialogMessageResId)
Parameters | |
---|---|
dialogMessageResId |
int : The dialog message as a resource. |
See also:
setDialogTitle
public void setDialogTitle (int dialogTitleResId)
Parameters | |
---|---|
dialogTitleResId |
int : The dialog title as a resource. |
See also:
setDialogTitle
public void setDialogTitle (CharSequence dialogTitle)
Sets the title of the dialog. This will be shown on subsequent dialogs.
Parameters | |
---|---|
dialogTitle |
CharSequence : The title. |
setNegativeButtonText
public void setNegativeButtonText (CharSequence negativeButtonText)
Sets the text of the negative button of the dialog. This will be shown on subsequent dialogs.
Parameters | |
---|---|
negativeButtonText |
CharSequence : The text of the negative button. |
setNegativeButtonText
public void setNegativeButtonText (int negativeButtonTextResId)
Parameters | |
---|---|
negativeButtonTextResId |
int : The negative button text as a resource. |
See also:
setPositiveButtonText
public void setPositiveButtonText (int positiveButtonTextResId)
Parameters | |
---|---|
positiveButtonTextResId |
int : The positive button text as a resource. |
See also:
setPositiveButtonText
public void setPositiveButtonText (CharSequence positiveButtonText)
Sets the text of the positive button of the dialog. This will be shown on subsequent dialogs.
Parameters | |
---|---|
positiveButtonText |
CharSequence : The text of the positive button. |
Protected methods
onBindDialogView
protected void onBindDialogView (View view)
Binds views in the content View of the dialog to data.
Make sure to call through to the superclass implementation.
If you override this method you must call through to the
superclass implementation.
Parameters | |
---|---|
view |
View : The content View of the dialog, if it is custom. |
onClick
protected void onClick ()
Processes a click on the preference. This includes saving the value to
the SharedPreferences
. However, the overridden method should
call callChangeListener(java.lang.Object)
to make sure the client wants to
update the preference's state with the new value.
onCreateDialogView
protected View onCreateDialogView ()
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 | |
---|---|
View |
The content View for the dialog. |
See also:
onDialogClosed
protected void onDialogClosed (boolean positiveResult)
Called when the dialog is dismissed and should be used to save data to
the SharedPreferences
.
Parameters | |
---|---|
positiveResult |
boolean : Whether the positive button was clicked (true), or
the negative button was clicked or the dialog was canceled (false). |
onPrepareDialogBuilder
protected void onPrepareDialogBuilder (AlertDialog.Builder builder)
Prepares the dialog builder to be shown when the preference is clicked. Use this to set custom properties on the dialog.
Do not AlertDialog.Builder#create()
or
AlertDialog.Builder#show()
.
Parameters | |
---|---|
builder |
AlertDialog.Builder |
onRestoreInstanceState
protected void onRestoreInstanceState (Parcelable state)
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 |
Parcelable : The saved state that had previously been returned by
onSaveInstanceState() . |
onSaveInstanceState
protected 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. This state should only contain information that is not persistent or can be reconstructed later.
Returns | |
---|---|
Parcelable |
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 . |
showDialog
protected void showDialog (Bundle state)
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 |
Bundle : Optional instance state to restore on the dialog |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-04-11 UTC.