de.mrapp.android.preference

Class MultiChoiceListPreference

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

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 MultiChoiceListPreference
extends AbstractListPreference

A preference, which allows to select multiple values from a list. The selected values are persisted as a Set in the shared preferences. They will only be persisted, if confirmed by the user.

Since:

1.7.0

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addAllValues(java.util.Collection<java.lang.String> values) Adds all values, which are contained by a specific collection, to the preference.
void	addValue(java.lang.String value) Adds a new value to the preference.
java.lang.CharSequence[]	getSelectedEntries() Returns the entries, the currently persisted values of the preference belong to.
java.lang.CharSequence	getSummary()
java.util.Set<java.lang.String>	getValues() Returns the currently persisted values 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	removeAllValues(java.util.Collection<java.lang.String> values) Removes all values, which are contained by a specific collection, from the preference.
void	removeValue(java.lang.String value) Removes a specific value from the preference.
void	setValues(java.util.Set<java.lang.String> values) Sets the current values 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

MultiChoiceListPreference

public MultiChoiceListPreference(android.content.Context context)

Creates a new preference, which allows to select multiple values 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

MultiChoiceListPreference

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

Creates a new preference, which allows to select multiple values 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

MultiChoiceListPreference

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

Creates a new preference, which allows to select multiple values 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

MultiChoiceListPreference

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

Creates a new preference, which allows to select multiple values 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

getValues

public final java.util.Set<java.lang.String> getValues()

Returns the currently persisted values of the preference.

Returns:

A set, which contains the currently persisted values of the preference, as an instance of the type Set

setValues

public final void setValues(java.util.Set<java.lang.String> values)

Sets the current values of the preference. By setting values, they will be persisted.

Parameters:

values - A set, which contains the values, which should be set, as an instance of the type Set

addValue

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

Adds a new value to the preference. By adding a value, the changes will be persisted.

Parameters:

value - The value, which should be added, as a String. The value may not be null

removeValue

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

Removes a specific value from the preference. By removing a value, the changes will be persisted.

Parameters:

value - The value, which should be removed, as a String. The value may not be null

addAllValues

public final void addAllValues(java.util.Collection<java.lang.String> values)

Adds all values, which are contained by a specific collection, to the preference. By adding values, the changes will be persisted.

Parameters:

values - A collection, which contains the values, which should be added, as an instance of the type Collection or an empty collection, if no values should be added

removeAllValues

public final void removeAllValues(java.util.Collection<java.lang.String> values)

Removes all values, which are contained by a specific collection, from the preference. By removing values, the changes will be persisted.

Parameters:

values - A collection, which contains the values, which should be removed, as an instance of the type Collection or an empty collection, if no values should be removed

getSelectedEntries

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

Returns the entries, the currently persisted values of the preference belong to.

Returns:

An array, which contains the entries, the currently persisted values of the preference belong to, as an array 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 final 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