de.mrapp.android.preference

Class AbstractListPreference

java.lang.Object

android.preference.Preference

de.mrapp.android.preference.AbstractDialogPreference

de.mrapp.android.preference.AbstractListPreference

All Implemented Interfaces:

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

Direct Known Subclasses:

ListPreference, MultiChoiceListPreference

public abstract class AbstractListPreference
extends AbstractDialogPreference

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

AbstractDialogPreference.SavedState

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
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
int	getDialogItemColor() Returns the color 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 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.
void	setDialogItemColor(int color) Sets the color 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.AbstractDialogPreference

getDialog, getDialogBackground, getDialogButtonBarDividerColor, getDialogButtonTextColor, getDialogContentDividerColor, getDialogHeaderBackground, getDialogHeaderIcon, getDialogIcon, getDialogMessage, getDialogMessageColor, getDialogTitle, getDialogTitleColor, getNegativeButtonText, getPositiveButtonText, isDialogButtonBarDividerShown, isDialogContentDividerShown, isDialogHeaderShown, isDialogShown, isValueShownAsSummary, onClick, onClick, onDialogClosed, onDismiss, onPrepareDialog, onRestoreInstanceState, onSaveInstanceState, setDialogBackground, setDialogBackground, setDialogBackgroundColor, setDialogButtonBarDividerColor, setDialogButtonTextColor, setDialogContentDividerColor, setDialogHeaderBackground, setDialogHeaderBackground, setDialogHeaderBackgroundColor, setDialogHeaderIcon, setDialogHeaderIcon, setDialogIcon, setDialogIcon, setDialogMessage, setDialogMessage, setDialogMessageColor, setDialogTitle, setDialogTitle, setDialogTitleColor, setNegativeButtonText, setNegativeButtonText, setPositiveButtonText, setPositiveButtonText, showDialogButtonBarDivider, showDialogContentDivider, showDialogHeader, showValueAsSummary

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

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

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

Returns:

The color of the items as an Integer value or -1, 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

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

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

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

needInputMethod

protected final boolean needInputMethod()

Description copied from class: AbstractDialogPreference

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.

Specified by:

needInputMethod in class AbstractDialogPreference

Returns:

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