de.mrapp.android.preference

Class AbstractListPreference

java.lang.Object

androidx.preference.Preference

de.mrapp.android.preference.Preference

de.mrapp.android.preference.DialogPreference

de.mrapp.android.preference.AbstractListPreference

All Implemented Interfaces:

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

Direct Known Subclasses:

ListPreference, MultiChoiceListPreference

public abstract class AbstractListPreference
extends DialogPreference

An abstract base class for all preferences, which provide a list of selectable items.

Since:

1.7.0

Nested Class Summary

Nested classes/interfaces inherited from class de.mrapp.android.preference.DialogPreference

DialogPreference.SavedState

Constructor Summary

Constructors

Constructor and Description
AbstractListPreference(android.content.Context context) Creates a new preference, which provides a list of selectable items.
AbstractListPreference(android.content.Context context, android.util.AttributeSet attributeSet) Creates a new preference, which provides a list of selectable items.
AbstractListPreference(android.content.Context context, android.util.AttributeSet attributeSet, int defaultStyle) Creates a new preference, which provides a list of selectable items.
AbstractListPreference(android.content.Context context, android.util.AttributeSet attributeSet, int defaultStyle, int defaultStyleResource) Creates a new preference, which provides a list of selectable items.

Method Summary

Modifier and Type	Method and Description
android.content.res.ColorStateList	getDialogItemColor() Returns the color of the items of the preference's dialog.
android.graphics.Typeface	getDialogItemTypeface() Returns the typeface of the items of the preference's dialog.
java.lang.CharSequence[]	getEntries() Returns the entries of the list, which is shown by the preference.
java.lang.CharSequence[]	getEntryValues() Returns the values, which correspond to the entries of the list, which is shown by the preference.
protected int	indexOf(java.lang.CharSequence value) Return the index of the entry, a specific value corresponds to.
protected void	onPrepareDialog(<any> dialogBuilder) The method, which is invoked on subclasses when the preference's dialog is about to be created.
void	setDialogItemColor(android.content.res.ColorStateList colorStateList) Sets the color of the items of the preference's dialog.
void	setDialogItemColor(int color) Sets the color of the items of the preference's dialog.
void	setDialogItemTypeface(android.graphics.Typeface typeface) Sets the typeface of the items of the preference's dialog.
void	setEntries(java.lang.CharSequence[] entries) Sets the entries of the list, which is shown by the preference.
void	setEntries(int resourceId) Sets the entries of the list, which is shown by the preference.
void	setEntryValues(java.lang.CharSequence[] entryValues) Sets the values, which correspond to the entries of the list, which is shown by the preference.
void	setEntryValues(int resourceId) Sets the values, which correspond to the entries of the list, which is shown by the preference.

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, onDialogClosed, onDismiss, onKey, onRestoreInstanceState, onSaveInstanceState, 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

AbstractListPreference

public AbstractListPreference(android.content.Context context)

Creates a new preference, which provides a list of selectable items.

Parameters:

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

AbstractListPreference

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

Creates a new preference, which provides a list of selectable items.

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

AbstractListPreference

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

Creates a new preference, which provides a list of selectable items.

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

AbstractListPreference

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

Creates a new preference, which provides a list of selectable items.

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

indexOf

protected final int indexOf(java.lang.CharSequence value)

Return the index of the entry, a specific value corresponds to.

Parameters:

value - The value of the entry, whose index should be returned, as an instance of the type CharSequence

Returns:

The index of the entry, the given value corresponds to, as an Integer value or -1 if there is no such entry

getDialogItemColor

public final android.content.res.ColorStateList getDialogItemColor()

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

Returns:

The color of the items as an instance of the class ColorStateList or null, if no custom item color is set

setDialogItemColor

public final void setDialogItemColor(int color)

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

Parameters:

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

setDialogItemColor

public final void setDialogItemColor(android.content.res.ColorStateList colorStateList)

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

Parameters:

colorStateList - The color, which should be set, as an instance of the class ColorStateList. The color state list may not be null

getDialogItemTypeface

public final android.graphics.Typeface getDialogItemTypeface()

Returns the typeface of the items of the preference's dialog.

Returns:

The typeface of the items of the preference's dialog as an instance of the class Typeface or null, if the default typeface is used

setDialogItemTypeface

public final void setDialogItemTypeface(android.graphics.Typeface typeface)

Sets the typeface of the items of the preference's dialog.

Parameters:

typeface - The typeface, which should be set, as an instance of the class Typeface or null, if the default typeface should be used

getEntries

public final java.lang.CharSequence[] getEntries()

Returns the entries of the list, which is shown by the preference.

Returns:

The entries of the list, which is shown by the preference, as a CharSequence array or null, if no entries have been set

setEntries

public final void setEntries(java.lang.CharSequence[] entries)

Sets the entries of the list, which is shown by the preference.

Parameters:

entries - The entries, which should be set, as an CharSequence array. The entries may not be null

setEntries

public final void setEntries(int resourceId)

Sets the entries of the list, which is shown by the preference.

Parameters:

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

setEntryValues

public final void setEntryValues(java.lang.CharSequence[] entryValues)

Sets the values, which correspond to the entries of the list, which is shown by the preference.

Parameters:

entryValues - The values, which should be set, as a CharSequence array. The values may not be null and the array's length must be equal to the number of list items

getEntryValues

public final java.lang.CharSequence[] getEntryValues()

Returns the values, which correspond to the entries of the list, which is shown by the preference.

Returns:

The values, which correspond to the entries of the list, which is shown by the preference, as a CharSequence array

setEntryValues

public final void setEntryValues(int resourceId)

Sets the values, which correspond to the entries of the list, which is shown by the preference.

Parameters:

resourceId - The resource id of the values, which should be set, as an Integer value. The resource id must correspond to a valid array resource. The array's length must be equal to the number of list items

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 DialogPreference

Parameters:

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