de.mrapp.android.preference

Class AbstractDialogPreference

java.lang.Object

android.preference.Preference

de.mrapp.android.preference.AbstractDialogPreference

All Implemented Interfaces:

android.content.DialogInterface.OnClickListener, android.content.DialogInterface.OnDismissListener, java.lang.Comparable<android.preference.Preference>

Direct Known Subclasses:

AbstractColorPickerPreference, AbstractListPreference, AbstractNumberPickerPreference, AbstractValidateableDialogPreference, SeekBarPreference

public abstract class AbstractDialogPreference
extends android.preference.Preference
implements android.content.DialogInterface.OnClickListener, android.content.DialogInterface.OnDismissListener

An abstract base class for all preferences, which will show a dialog when clicked by the user.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractDialogPreference.SavedState A data structure, which allows to save the internal state of an AbstractDialogPreference.

Nested classes/interfaces inherited from class android.preference.Preference

android.preference.Preference.BaseSavedState, android.preference.Preference.OnPreferenceChangeListener, android.preference.Preference.OnPreferenceClickListener

Field Summary

Fields inherited from class android.preference.Preference

DEFAULT_ORDER

Constructor Summary

Constructors

Constructor and Description
AbstractDialogPreference(android.content.Context context) Creates a new preference, which will show a dialog when clicked by the user.
AbstractDialogPreference(android.content.Context context, android.util.AttributeSet attributeSet) Creates a new preference, which will show a dialog when clicked by the user.
AbstractDialogPreference(android.content.Context context, android.util.AttributeSet attributeSet, int defaultStyle) Creates a new preference, which will show a dialog when clicked by the user.
AbstractDialogPreference(android.content.Context context, android.util.AttributeSet attributeSet, int defaultStyle, int defaultStyleResource) Creates a new preference, which will show a dialog when clicked by the user.

Method Summary

Modifier and Type	Method and Description
android.app.Dialog	getDialog() Returns the dialog, which is shown by the preference.
android.graphics.drawable.Drawable	getDialogBackground() Returns the background of the preference's dialog.
int	getDialogButtonBarDividerColor() Returns the color of the divider, which is located above the buttons of the preference's dialog.
int	getDialogButtonTextColor() Returns the color of the button text of the preference's dialog.
int	getDialogContentDividerColor() Returns the color of the divider, which is located above the custom view of the preference's dialog.
android.graphics.drawable.Drawable	getDialogHeaderBackground() Returns the background of the header of the preference's dialog.
android.graphics.drawable.Drawable	getDialogHeaderIcon() Returns the icon of the header of the preference's dialog.
android.graphics.drawable.Drawable	getDialogIcon() Returns the icon of the preference's dialog.
java.lang.CharSequence	getDialogMessage() Returns the message of the preference's dialog.
int	getDialogMessageColor() Returns the color of the message of the preference's dialog.
java.lang.CharSequence	getDialogTitle() Returns the title of the preference's dialog.
int	getDialogTitleColor() Returns the color of the title of the preference's dialog.
java.lang.CharSequence	getNegativeButtonText() Returns the text of the negative button of the preference's dialog.
java.lang.CharSequence	getPositiveButtonText() Returns the text of the positive button of the preference's dialog.
boolean	isDialogButtonBarDividerShown() Returns, whether the divider, which is located above the buttons of the preference's dialog, is shown, or not.
boolean	isDialogContentDividerShown() Returns, whether the divider, which is located above the custom view of the preference's dialog, is shown, or not.
boolean	isDialogHeaderShown() Returns, whether the header of the preference's dialog is shown, or not.
boolean	isDialogShown() Returns, whether the preference's dialog is currently shown, or not.
boolean	isValueShownAsSummary() Returns, whether the currently persisted value is shown instead of the summary, or not.
protected abstract boolean	needInputMethod() The method, which is invoked on subclasses to determine, whether the soft input mode should be requested when the preference's dialog becomes shown, or not.
protected void	onClick()
void	onClick(android.content.DialogInterface dialog, int which)
protected abstract void	onDialogClosed(boolean positiveResult) The method, which is invoked on subclasses when the preference's dialog has been closed.
void	onDismiss(android.content.DialogInterface dialog)
protected abstract void	onPrepareDialog(MaterialDialog.Builder dialogBuilder) The method, which is invoked on subclasses when the preference's dialog is about to be created.
protected void	onRestoreInstanceState(android.os.Parcelable state)
protected android.os.Parcelable	onSaveInstanceState()
void	setDialogBackground(android.graphics.drawable.Drawable background) Sets the background of the preference's dialog.
void	setDialogBackground(int resourceId) Sets the background of the preference's dialog.
void	setDialogBackgroundColor(int color) Sets the background color of the preference's dialog.
void	setDialogButtonBarDividerColor(int color) Sets the color of the divider, which is located above the buttons of the preference's dialog.
void	setDialogButtonTextColor(int color) Sets the color of the button text of the preference's dialog.
void	setDialogContentDividerColor(int color) Sets the color of the divider, which is located above the custom view of the preference's dialog.
void	setDialogHeaderBackground(android.graphics.drawable.Drawable background) Sets the background of the header of the preference's dialog.
void	setDialogHeaderBackground(int resourceId) Sets the background of the header of the preference's dialog.
void	setDialogHeaderBackgroundColor(int color) Sets the background color of the header of the preference's dialog.
void	setDialogHeaderIcon(android.graphics.drawable.Drawable icon) Sets the icon of the header of the preference's dialog.
void	setDialogHeaderIcon(int resourceId) Sets the icon of the header of the preference's dialog.
void	setDialogIcon(android.graphics.drawable.Drawable dialogIcon) Sets the icon of the preference's dialog.
void	setDialogIcon(int resourceId) Sets the icon of the preference's dialog.
void	setDialogMessage(java.lang.CharSequence dialogMessage) Sets the message of the preference's dialog.
void	setDialogMessage(int resourceId) Sets the message of the preference's dialog.
void	setDialogMessageColor(int color) Sets the color of the message of the preference's dialog.
void	setDialogTitle(java.lang.CharSequence dialogTitle) Sets the title of the preference's dialog.
void	setDialogTitle(int resourceId) Sets the title of the preference's dialog.
void	setDialogTitleColor(int color) Sets the color of the title of the preference's dialog.
void	setNegativeButtonText(java.lang.CharSequence negativeButtonText) Sets the text of the negative button of the preference's dialog.
void	setNegativeButtonText(int resourceId) Sets the text of the negative button of the preference's dialog.
void	setPositiveButtonText(java.lang.CharSequence positiveButtonText) Sets the text of the positive button of the preference's dialog.
void	setPositiveButtonText(int resourceId) Sets the text of the positive button of the preference's dialog.
void	showDialogButtonBarDivider(boolean show) Sets, whether the divider, which is located above the buttons of the preference's dialog, should be shown, or not.
void	showDialogContentDivider(boolean show) Sets, whether the divider, which is located above the custom view of the preference's dialog, should be shown, or not.
void	showDialogHeader(boolean show) Sets, whether the header of the preference's dialog should be shown, or not.
void	showValueAsSummary(boolean showValueAsSummary) Sets, whether the currently persisted value should be shown instead of the summary, or not.

Methods inherited from class android.preference.Preference

callChangeListener, compareTo, findPreferenceInHierarchy, getContext, getDependency, getEditor, getExtras, getFragment, getIcon, getIntent, getKey, getLayoutResource, getOnPreferenceChangeListener, getOnPreferenceClickListener, getOrder, getPersistedBoolean, getPersistedFloat, getPersistedInt, getPersistedLong, getPersistedString, getPreferenceManager, getSharedPreferences, getShouldDisableView, getSummary, getTitle, getTitleRes, getView, getWidgetLayoutResource, hasKey, isEnabled, isPersistent, isSelectable, notifyChanged, notifyDependencyChange, notifyHierarchyChanged, onAttachedToActivity, onAttachedToHierarchy, onBindView, onCreateView, onDependencyChanged, onGetDefaultValue, onParentChanged, onPrepareForRemoval, onSetInitialValue, peekExtras, persistBoolean, persistFloat, persistInt, persistLong, persistString, restoreHierarchyState, saveHierarchyState, setDefaultValue, setDependency, setEnabled, setFragment, setIcon, setIcon, setIntent, setKey, setLayoutResource, setOnPreferenceChangeListener, setOnPreferenceClickListener, setOrder, setPersistent, setSelectable, setShouldDisableView, setSummary, setSummary, setTitle, setTitle, setWidgetLayoutResource, shouldCommit, shouldDisableDependents, shouldPersist, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractDialogPreference

public AbstractDialogPreference(android.content.Context context)

Creates a new preference, which will show a dialog when clicked by the user.

Parameters:

context - The context, which should be used by the preference, as an instance of the class Context. The context may not be null

AbstractDialogPreference

public AbstractDialogPreference(android.content.Context context,
                                android.util.AttributeSet attributeSet)

Creates a new preference, which will show a dialog when clicked by the user.

Parameters:

context - The context, which should be used by the preference, as an instance of the class Context. The context may not be null

attributeSet - The attributes of the XML tag that is inflating the preference, as an instance of the type AttributeSet or null, if no attributes are available

AbstractDialogPreference

public AbstractDialogPreference(android.content.Context context,
                                android.util.AttributeSet attributeSet,
                                int defaultStyle)

Creates a new preference, which will show a dialog when clicked by the user.

Parameters:

context - The context, which should be used by the preference, as an instance of the class Context. The context may not be null

attributeSet - The attributes of the XML tag that is inflating the preference, as an instance of the type AttributeSet or null, if no attributes are available

defaultStyle - The default style to apply to this preference. If 0, no style will be applied (beyond what is included in the theme). This may either be an attribute resource, whose value will be retrieved from the current theme, or an explicit style resource

AbstractDialogPreference

public AbstractDialogPreference(android.content.Context context,
                                android.util.AttributeSet attributeSet,
                                int defaultStyle,
                                int defaultStyleResource)

Creates a new preference, which will show a dialog when clicked by the user.

Parameters:

context - The context, which should be used by the preference, as an instance of the class Context. The context may not be null

attributeSet - The attributes of the XML tag that is inflating the preference, as an instance of the type AttributeSet or null, if no attributes are available

defaultStyle - The default style to apply to this preference. If 0, no style will be applied (beyond what is included in the theme). This may either be an attribute resource, whose value will be retrieved from the current theme, or an explicit style resource

defaultStyleResource - A resource identifier of a style resource that supplies default values for the preference, used only if the default style is 0 or can not be found in the theme. Can be 0 to not look for defaults

Method Detail

needInputMethod

protected abstract boolean needInputMethod()

The method, which is invoked on subclasses to determine, whether the soft input mode should be requested when the preference's dialog becomes shown, or not.

Returns:

True, if the soft input mode should be requested when the preference's dialog becomes shown, false otherwise

onPrepareDialog

protected abstract void onPrepareDialog(MaterialDialog.Builder dialogBuilder)

The method, which is invoked on subclasses when the preference's dialog is about to be created. The builder, which is passed as a method parameter may be manipulated by subclasses in order to change the appearance of the dialog. When views are inflated inside this method, the context of the builder should be used in order to ensure that the dialog's theme is used.

Parameters:

dialogBuilder - The builder, which is used to create the preference's dialog, as an instance of the class MaterialDialog.Builder

onDialogClosed

protected abstract void onDialogClosed(boolean positiveResult)

The method, which is invoked on subclasses when the preference's dialog has been closed. This method may be used within subclasses to evaluate the changes, which have been made while the dialog was shown.

Parameters:

positiveResult - True, if the dialog has been close affirmatively, false otherwise

getDialog

public final android.app.Dialog getDialog()

Returns the dialog, which is shown by the preference.

Returns:

The dialog, which is shown by the preference, as an instance of the class Dialog or null, if the dialog is currently not shown

isDialogShown

public final boolean isDialogShown()

Returns, whether the preference's dialog is currently shown, or not.

Returns:

True, if the preference's dialog is currently shown, false otherwise

getDialogTitle

public final java.lang.CharSequence getDialogTitle()

Returns the title of the preference's dialog.

Returns:

The title of the preference's dialog as an instance of the class CharSequence or null, if the preference's title is used instead

setDialogTitle

public final void setDialogTitle(java.lang.CharSequence dialogTitle)

Sets the title of the preference's dialog.

Parameters:

dialogTitle - The title, which should be set, as an instance of the class CharSequence or null, if the preference's title should be used instead

setDialogTitle

public final void setDialogTitle(int resourceId)

Sets the title of the preference's dialog.

Parameters:

resourceId - The resource id of the title, which should be set, as an Integer value. The resource id must correspond to a valid string resource

getDialogMessage

public final java.lang.CharSequence getDialogMessage()

Returns the message of the preference's dialog.

Returns:

The message of the preference's dialog as an instance of the class CharSequence or null, if no message is shown in the dialog

setDialogMessage

public final void setDialogMessage(java.lang.CharSequence dialogMessage)

Sets the message of the preference's dialog.

Parameters:

dialogMessage - The message, which should be set, as an instance of the class CharSequence or null, if no message should be shown in the dialog

setDialogMessage

public final void setDialogMessage(int resourceId)

Sets the message of the preference's dialog.

Parameters:

resourceId - The resource id of the message, which should be set, as an Integer value. The resource id must correspond to a valid string resource

getDialogIcon

public final android.graphics.drawable.Drawable getDialogIcon()

Returns the icon of the preference's dialog.

Returns:

The icon of the preference's dialog as an instance of the class Drawable or null, if no icon is shown in the dialog

setDialogIcon

public final void setDialogIcon(android.graphics.drawable.Drawable dialogIcon)

Sets the icon of the preference's dialog.

Parameters:

dialogIcon - The dialog, which should be set, as an instance of the class Drawable or null, if no icon should be shown in the dialog

setDialogIcon

public final void setDialogIcon(int resourceId)

Sets the icon of the preference's dialog.

Parameters:

resourceId - The resource id of the icon, which should be set, as an Integer value. The resource id must correspond to a valid drawable resource

getPositiveButtonText

public final java.lang.CharSequence getPositiveButtonText()

Returns the text of the positive button of the preference's dialog.

Returns:

The text of the positive button as an instance of the class CharSequence or null, if no positive button is shown in the dialog

setPositiveButtonText

public final void setPositiveButtonText(java.lang.CharSequence positiveButtonText)

Sets the text of the positive button of the preference's dialog.

Parameters:

positiveButtonText - The text, which should be set, as an instance of the class CharSequence or null, if no positive button should be shown in the dialog

setPositiveButtonText

public final void setPositiveButtonText(int resourceId)

Sets the text of the positive button of the preference's dialog.

Parameters:

resourceId - The resource id of the text, which should be set, as an Integer value. The resource id must correspond to a valid string resource

getNegativeButtonText

public final java.lang.CharSequence getNegativeButtonText()

Returns the text of the negative button of the preference's dialog.

Returns:

The text of the negative button as an instance of the class CharSequence or null, if no negative button is shown in the dialog

setNegativeButtonText

public final void setNegativeButtonText(java.lang.CharSequence negativeButtonText)

Sets the text of the negative button of the preference's dialog.

Parameters:

negativeButtonText - The text, which should be set, as an instance of the class CharSequence or null, if no negative button should be shown in the dialog

setNegativeButtonText

public final void setNegativeButtonText(int resourceId)

Sets the text of the negative button of the preference's dialog.

Parameters:

resourceId - The resource id of the text, which should be set, as an Integer value. The resource id must correspond to a valid string resource

getDialogTitleColor

public final int getDialogTitleColor()

Returns the color of the title of the preference's dialog.

Returns:

The color of the title as an Integer value or -1, if no custom title color is set

setDialogTitleColor

public final void setDialogTitleColor(int color)

Sets the color of the title of the preference's dialog.

Parameters:

color - The color, which should be set, as an Integer value or -1, if no custom title should be set

getDialogMessageColor

public final int getDialogMessageColor()

Returns the color of the message of the preference's dialog.

Returns:

The color of the message as an Integer value or -1, if no custom message color is set

setDialogMessageColor

public final void setDialogMessageColor(int color)

Sets the color of the message of the preference's dialog.

Parameters:

color - The color, which should be set, as an Integer value or -1, if no custom message color should be set

getDialogButtonTextColor

public final int getDialogButtonTextColor()

Returns the color of the button text of the preference's dialog.

Returns:

The color of the button text as an Integer value or -1, if no custom text color is set

setDialogButtonTextColor

public final void setDialogButtonTextColor(int color)

Sets the color of the button text of the preference's dialog.

Parameters:

color - The color, which should be set, as an Integer value or -1, if no custom text color should be set

getDialogBackground

public final android.graphics.drawable.Drawable getDialogBackground()

Returns the background of the preference's dialog.

Returns:

The background of the preference's dialog as an instance of the class Drawable or null, if no custom background is set

setDialogBackground

public final void setDialogBackground(android.graphics.drawable.Drawable background)

Sets the background of the preference's dialog.

Parameters:

background - The background, which should be set, as an instance of the class Drawable or null, if no custom background should be set

setDialogBackground

public final void setDialogBackground(int resourceId)

Sets the background of the preference's dialog.

Parameters:

resourceId - The resource id of the background, which should be set, as an Integer value. The resource id must correspond to a valid drawable resource

setDialogBackgroundColor

public final void setDialogBackgroundColor(int color)

Sets the background color of the preference's dialog.

Parameters:

color - The color, which should be set, as an Integer value or -1, if no custom background color should be set

isValueShownAsSummary

public final boolean isValueShownAsSummary()

Returns, whether the currently persisted value is shown instead of the summary, or not.

Returns:

True, if the currently persisted value is shown instead of the summary, false otherwise

showValueAsSummary

public final void showValueAsSummary(boolean showValueAsSummary)

Sets, whether the currently persisted value should be shown instead of the summary, or not.

Parameters:

showValueAsSummary - True, if the currently persisted value should be shown instead of the summary, false otherwise

isDialogHeaderShown

public final boolean isDialogHeaderShown()

Returns, whether the header of the preference's dialog is shown, or not.

Returns:

True, if the header of the preference's dialog is shown, false otherwise

showDialogHeader

public final void showDialogHeader(boolean show)

Sets, whether the header of the preference's dialog should be shown, or not.

Parameters:

show - True, if the header of the preference's dialog should be shown, false otherwise

getDialogHeaderBackground

public final android.graphics.drawable.Drawable getDialogHeaderBackground()

Returns the background of the header of the preference's dialog.

Returns:

The background of the header of the preference's dialog as an instance of the class Drawable

setDialogHeaderBackground

public final void setDialogHeaderBackground(android.graphics.drawable.Drawable background)

Sets the background of the header of the preference's dialog.

Parameters:

background - The background, which should be set, as an instance of the class Drawable or null, if no custom background should be set

setDialogHeaderBackground

public final void setDialogHeaderBackground(int resourceId)

Sets the background of the header of the preference's dialog.

Parameters:

resourceId - The resource id of the background, which should be set, as an Integer value. The resource id must correspond to a valid drawable resource

setDialogHeaderBackgroundColor

public final void setDialogHeaderBackgroundColor(int color)

Sets the background color of the header of the preference's dialog.

Parameters:

color - The color, which should be set, as an Integer value or -1, if no custom color should be set

getDialogHeaderIcon

public final android.graphics.drawable.Drawable getDialogHeaderIcon()

Returns the icon of the header of the preference's dialog.

Returns:

The icon of the header of the preference's dialog as an instance of the class Drawable

setDialogHeaderIcon

public final void setDialogHeaderIcon(android.graphics.drawable.Drawable icon)

Sets the icon of the header of the preference's dialog.

Parameters:

icon - The icon, which should be set, as an instance of the class Drawable or null, if no icon should be set

setDialogHeaderIcon

public final void setDialogHeaderIcon(int resourceId)

Sets the icon of the header of the preference's dialog.

Parameters:

resourceId - The resource id of the icon, which should be set, as an Integer value. The resource id must correspond to a valid drawable resource

isDialogButtonBarDividerShown

public final boolean isDialogButtonBarDividerShown()

Returns, whether the divider, which is located above the buttons of the preference's dialog, is shown, or not.

Returns:

True, if the divider, which is located above the buttons of the preference's dialog, is shown, false otherwise

showDialogButtonBarDivider

public final void showDialogButtonBarDivider(boolean show)

Sets, whether the divider, which is located above the buttons of the preference's dialog, should be shown, or not.

Parameters:

show - True, if the divider, which is located above the buttons of the preference's dialog should be shown, false otherwise

getDialogButtonBarDividerColor

public final int getDialogButtonBarDividerColor()

Returns the color of the divider, which is located above the buttons of the preference's dialog.

Returns:

The color of the divider, which is located above the buttons of the preference's dialog, as an Integer value or -1, if no custom color is set

setDialogButtonBarDividerColor

public final void setDialogButtonBarDividerColor(int color)

Sets the color of the divider, which is located above the buttons of the preference's dialog.

Parameters:

color - The color, which should be set, as an Integer value or -1, if no custom color should be set

isDialogContentDividerShown

public final boolean isDialogContentDividerShown()

Returns, whether the divider, which is located above the custom view of the preference's dialog, is shown, or not.

Returns:

True, if the divider, which is located above the custom view of the preference's dialog, is shown, false otherwise

showDialogContentDivider

public final void showDialogContentDivider(boolean show)

Sets, whether the divider, which is located above the custom view of the preference's dialog, should be shown, or not.

Parameters:

show - True, if the divider, which is located above the custom view of the preference's dialog, should be shown, false otherwise

getDialogContentDividerColor

public final int getDialogContentDividerColor()

Returns the color of the divider, which is located above the custom view of the preference's dialog.

Returns:

The color of the divider, which is located above the custom view of the preferene's dialog, as an Integer value or -1, if no custom color is set

setDialogContentDividerColor

public final void setDialogContentDividerColor(int color)

Sets the color of the divider, which is located above the custom view of the preference's dialog.

Parameters:

color - The color, which should be set, as an Integer value or -1, if no custom color should be set

onClick

public final void onClick(android.content.DialogInterface dialog,
                          int which)

Specified by:

onClick in interface android.content.DialogInterface.OnClickListener

onDismiss

public final void onDismiss(android.content.DialogInterface dialog)

Specified by:

onDismiss in interface android.content.DialogInterface.OnDismissListener

onClick

protected final void onClick()

Overrides:

onClick in class android.preference.Preference

onSaveInstanceState

protected android.os.Parcelable onSaveInstanceState()

Overrides:

onSaveInstanceState in class android.preference.Preference

onRestoreInstanceState

protected void onRestoreInstanceState(android.os.Parcelable state)

Overrides:

onRestoreInstanceState in class android.preference.Preference