de.mrapp.android.preference

Class ListPreference

java.lang.Object

androidx.preference.Preference

de.mrapp.android.preference.Preference

de.mrapp.android.preference.DialogPreference

de.mrapp.android.preference.AbstractListPreference

de.mrapp.android.preference.ListPreference

All Implemented Interfaces:

android.content.DialogInterface.OnCancelListener, android.content.DialogInterface.OnClickListener, android.content.DialogInterface.OnDismissListener, android.content.DialogInterface.OnKeyListener, android.content.DialogInterface.OnShowListener

public class ListPreference
extends AbstractListPreference

A preference, which allows to select a value from a list. The selected value will immediately persisted and the preference's dialog will become closed.

Since:

1.0.0

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ListPreference(android.content.Context context) Creates a new preference, which allows to select a value from a list.
ListPreference(android.content.Context context, android.util.AttributeSet attributeSet) Creates a new preference, which allows to select a value from a list.
ListPreference(android.content.Context context, android.util.AttributeSet attributeSet, int defaultStyle) Creates a new preference, which allows to select a value from a list.
ListPreference(android.content.Context context, android.util.AttributeSet attributeSet, int defaultStyle, int defaultStyleResource) Creates a new preference, which allows to select a value from a list.

Method Summary

Modifier and Type	Method and Description
java.lang.CharSequence	getEntry() Returns the entry, the currently persisted value of the preference belongs to.
java.lang.CharSequence	getSummary()
java.lang.String	getValue() Returns the currently persisted value of the preference.
protected void	onDialogClosed(AbstractButtonBarDialog dialog, boolean positiveResult) The method, which is invoked on subclasses when the preference's dialog has been closed.
protected java.lang.Object	onGetDefaultValue(android.content.res.TypedArray typedArray, int index)
protected void	onPrepareDialog(<any> 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()
protected void	onSetInitialValue(java.lang.Object defaultValue)
void	setValue(java.lang.String value) Sets the current value of the preference.
void	setValueIndex(int index) Sets the current value of the preference.

Methods inherited from class de.mrapp.android.preference.AbstractListPreference

getDialogItemColor, getDialogItemTypeface, getEntries, getEntryValues, indexOf, setDialogItemColor, setDialogItemColor, setDialogItemTypeface, setEntries, setEntries, setEntryValues, setEntryValues

Methods inherited from class de.mrapp.android.preference.DialogPreference

areDialogDividersShownOnScroll, createDialog, createDialogBuilder, getDialog, getDialogBackground, getDialogBottomMargin, getDialogButtonTextColor, getDialogButtonTypeface, getDialogCancelAnimation, getDialogDismissAnimation, getDialogDividerColor, getDialogDividerMargin, getDialogGravity, getDialogHeaderBackground, getDialogHeaderIcon, getDialogHeaderIconTintList, getDialogHeaderIconTintMode, getDialogHeight, getDialogIcon, getDialogIconTintList, getDialogIconTintMode, getDialogLeftMargin, getDialogMaxHeight, getDialogMaxWidth, getDialogMessage, getDialogMessageColor, getDialogMessageTypeface, getDialogPaddingBottom, getDialogPaddingLeft, getDialogPaddingRight, getDialogPaddingTop, getDialogRightMargin, getDialogScrollableArea, getDialogShowAnimation, getDialogTitle, getDialogTitleColor, getDialogTitleTypeface, getDialogTopMargin, getDialogWidth, getDialogWindowBackground, getNegativeButtonText, getPositiveButtonText, isDialogButtonBarDividerShown, isDialogFitsSystemWindowsBottom, isDialogFitsSystemWindowsLeft, isDialogFitsSystemWindowsRight, isDialogFitsSystemWindowsTop, isDialogFullscreen, isDialogHeaderShown, isDialogShown, isValueShownAsSummary, needInputMethod, onCancel, onClick, onClick, onDismiss, onKey, onShow, performClick, setCustomDialogButtonBar, setCustomDialogButtonBar, setCustomDialogHeader, setCustomDialogHeader, setCustomDialogMessage, setCustomDialogMessage, setCustomDialogTitle, setCustomDialogTitle, setDialogBackground, setDialogBackground, setDialogBackgroundColor, setDialogButtonTextColor, setDialogButtonTextColor, setDialogButtonTypeface, setDialogCancelAnimation, setDialogDismissAnimation, setDialogDividerColor, setDialogDividerMargin, setDialogFitsSystemWindows, setDialogFitsSystemWindows, setDialogFullscreen, setDialogGravity, setDialogHeaderBackground, setDialogHeaderBackground, setDialogHeaderBackgroundColor, setDialogHeaderIcon, setDialogHeaderIcon, setDialogHeaderIconTint, setDialogHeaderIconTintList, setDialogHeaderIconTintMode, setDialogHeight, setDialogIcon, setDialogIcon, setDialogIconTint, setDialogIconTintList, setDialogIconTintMode, setDialogMargin, setDialogMaxHeight, setDialogMaxWidth, setDialogMessage, setDialogMessage, setDialogMessageColor, setDialogMessageTypeface, setDialogPadding, setDialogScrollableArea, setDialogScrollableArea, setDialogShowAnimation, setDialogTitle, setDialogTitle, setDialogTitleColor, setDialogTitleTypeface, setDialogWidth, setDialogWindowBackground, setDialogWindowBackground, setNegativeButtonText, setNegativeButtonText, setOnCancelListener, setOnClickListener, setOnDismissListener, setOnKeyListener, setOnShowListener, setPositiveButtonText, setPositiveButtonText, showDialogButtonBarDivider, showDialogDividersOnScroll, showDialogHeader, showValueAsSummary

Methods inherited from class de.mrapp.android.preference.Preference

getIconTintList, getIconTintMode, setIcon, setIconTint, setIconTintList, setIconTintMode

Methods inherited from class java.lang.Object

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

Constructor Detail

ListPreference

public ListPreference(android.content.Context context)

Creates a new preference, which allows to select a value from a list.

Parameters:

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

ListPreference

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

Creates a new preference, which allows to select a value from a list.

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

ListPreference

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

Creates a new preference, which allows to select a value from a list.

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

ListPreference

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

Creates a new preference, which allows to select a value from a list.

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

getValue

public final java.lang.String getValue()

Returns the currently persisted value of the preference.

Returns:

The currently persisted value of the preference as a String

setValue

public final void setValue(java.lang.String value)

Sets the current value of the preference. By setting a value, it will be persisted.

Parameters:

value - The value, which should be set, as a String

setValueIndex

public final void setValueIndex(int index)

Sets the current value of the preference. By setting a value, it will be persisted.

Parameters:

index - The index of the value, which should be set, as an Integer value

getEntry

public final java.lang.CharSequence getEntry()

Returns the entry, the currently persisted value of the preference belongs to.

Returns:

The entry, the currently persisted value of the preference belongs to, as an instance of the type CharSequence

getSummary

public final java.lang.CharSequence getSummary()

onGetDefaultValue

protected final java.lang.Object onGetDefaultValue(android.content.res.TypedArray typedArray,
                                                   int index)

onSetInitialValue

protected final void onSetInitialValue(java.lang.Object defaultValue)

onPrepareDialog

protected void onPrepareDialog(<any> dialogBuilder)

Description copied from class: DialogPreference

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.

Overrides:

onPrepareDialog in class AbstractListPreference

Parameters:

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

onDialogClosed

protected void onDialogClosed(AbstractButtonBarDialog dialog,
                              boolean positiveResult)

Description copied from class: DialogPreference

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.

Overrides:

onDialogClosed in class DialogPreference

Parameters:

dialog - The dialog, which has been closed, as an instance of the class AbstractButtonBarDialog. The dialog may not be null

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

onSaveInstanceState

protected android.os.Parcelable onSaveInstanceState()

Overrides:

onSaveInstanceState in class DialogPreference

onRestoreInstanceState

protected void onRestoreInstanceState(android.os.Parcelable state)

Overrides:

onRestoreInstanceState in class DialogPreference