Android
android.preference
public abstract class

android.preference.DialogPreference

java.lang.Object
android.preference.Preference Comparable<T>
android.preference.DialogPreference DialogInterface.OnClickListener DialogInterface.OnDismissListener

The DialogPreference class is a base class for preferences that are dialog-based. These preferences will, when clicked, open a dialog showing the actual preference controls.

Known Direct Subclasses

Summary

XML Attributes

Attribute name Related methods  
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. 
XML Attributes inherited from class android.preference.Preference
Constants inherited from class android.preference.Preference

Public Constructors

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

Public Methods

          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  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(Drawable dialogIcon)
Sets the icon of the dialog.
          void  setDialogIcon(int dialogIconRes)
Sets the icon (resource ID) 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(int dialogMessageResId)
          void  setDialogMessage(CharSequence dialogMessage)
Sets the message of the dialog.
          void  setDialogTitle(CharSequence dialogTitle)
Sets the title of the dialog.
          void  setDialogTitle(int dialogTitleResId)
          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 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.
Methods inherited from class android.preference.Preference
Methods inherited from class java.lang.Object
Methods inherited from interface android.content.DialogInterface.OnClickListener
Methods inherited from interface android.content.DialogInterface.OnDismissListener
Methods inherited from interface java.lang.Comparable

Details

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)

public DialogPreference(Context context, AttributeSet attrs)

Public Methods

public Drawable getDialogIcon()

Returns the icon to be shown on subsequent dialogs.

Returns

public int getDialogLayoutResource()

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

Returns

  • The layout resource.

public CharSequence getDialogMessage()

Returns the message to be shown on subsequent dialogs.

Returns

  • The message.

public CharSequence getDialogTitle()

Returns the title to be shown on subsequent dialogs.

Returns

  • The title.

public CharSequence getNegativeButtonText()

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

Returns

  • The text of the negative button.

public CharSequence getPositiveButtonText()

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

Returns

  • The text of the positive button.

public void onClick(DialogInterface dialog, int which)

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

public void onDismiss(DialogInterface dialog)

This method will be invoked when the dialog is dismissed.

public void setDialogIcon(Drawable dialogIcon)

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

Parameters

dialogIcon The icon, as a Drawable.

public void setDialogIcon(int dialogIconRes)

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 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 The layout resource ID to be inflated.

public void setDialogMessage(int dialogMessageResId)

Parameters

dialogMessageResId The dialog message as a resource.

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 message and it will be populated with this message.

Parameters

dialogMessage The message.

public void setDialogTitle(CharSequence dialogTitle)

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

Parameters

dialogTitle The title.

public void setDialogTitle(int dialogTitleResId)

Parameters

dialogTitleResId The dialog title as a resource.

public void setNegativeButtonText(CharSequence negativeButtonText)

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 setNegativeButtonText(int negativeButtonTextResId)

Parameters

negativeButtonTextResId The negative button text as a resource.

public void setPositiveButtonText(int positiveButtonTextResId)

Parameters

positiveButtonTextResId The positive button text as a resource.

public void setPositiveButtonText(CharSequence positiveButtonText)

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)

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

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

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)

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)

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)

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 icicle.

Parameters

state The frozen state that had previously been returned by 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

  • Returns a Parcelable object containing the preference's current dynamic state, or null if there is nothing interesting to save. The default implementation returns null.

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 Optional instance state to restore on the dialog
Copyright 2007 Google Inc. Build 0.9_r1-98467 - 14 Aug 2008 18:56