Most visited

Recently visited

Results for

Added in API level 11

MultiSelectListPreference

public class MultiSelectListPreference
extends DialogPreference

java.lang.Object
↳	android.preference.Preference
	↳	android.preference.DialogPreference
		↳	android.preference.MultiSelectListPreference

A Preference that displays a list of entries as a dialog.

This preference will store a set of strings into the SharedPreferences. This set will contain one or more values from the setEntryValues(CharSequence[]) array.

Summary

XML attributes
`android:entries`	The human-readable array to present as a list.
`android:entryValues`	The array to find the value to save for a preference when an entry from entries is selected.

Inherited XML attributes

From class


  android.preference.DialogPreference

From class


  android.preference.Preference

`android:defaultValue`	The default value for the preference, which will be set either if persistence is off or persistence is on and the preference is not found in the persistent storage.
`android:dependency`	The key of another Preference that this Preference will depend on.
`android:enabled`	Whether the Preference is enabled.
`android:fragment`	When used inside of a modern PreferenceActivity, this declares a new PreferenceFragment to be shown when the user selects this item.
`android:icon`	The optional icon for the preference Must be a reference to another resource, in the form "`@[+][package:]type:name`" or to a theme attribute in the form "`?[package:][type:]name`".
`android:key`	The key to store the Preference value.
`android:layout`	The layout for the Preference in a PreferenceActivity screen.
`android:order`	The order for the Preference (lower values are to be ordered first).
`android:persistent`	Whether the Preference stores its value to the shared preferences.
`android:selectable`	Whether the Preference is selectable.
`android:shouldDisableView`	Whether the view of this Preference should be disabled when this Preference is disabled.
`android:summary`	The summary for the Preference in a PreferenceActivity screen.
`android:title`	The title for the Preference in a PreferenceActivity screen.
`android:widgetLayout`	The layout for the controllable widget portion of a Preference.

Inherited constants

From class


    android.preference.Preference

Public constructors
`MultiSelectListPreference(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)`
`MultiSelectListPreference(Context context, AttributeSet attrs, int defStyleAttr)`
`MultiSelectListPreference(Context context, AttributeSet attrs)`
`MultiSelectListPreference(Context context)`

Public methods
`int`	`findIndexOfValue(String value)` Returns the index of the given value (in the entry values array).
`CharSequence[]`	`getEntries()` The list of entries to be shown in the list in subsequent dialogs.
`CharSequence[]`	`getEntryValues()` Returns the array of values to be saved for the preference.
`Set<String>`	`getValues()` Retrieves the current value of the key.
`void`	`setEntries(CharSequence[] entries)` Sets the human-readable entries to be shown in the list.
`void`	`setEntries(int entriesResId)`
`void`	`setEntryValues(int entryValuesResId)`
`void`	`setEntryValues(CharSequence[] entryValues)` The array to find the value to save for a preference when an entry from entries is selected.
`void`	`setValues(Set<String> values)` Sets the value of the key.

Protected methods
`void`	`onDialogClosed(boolean positiveResult)` Called when the dialog is dismissed and should be used to save data to the `SharedPreferences`.
`Object`	`onGetDefaultValue(TypedArray a, int index)` Called when a Preference is being inflated and the default value attribute needs to be read.
`void`	`onPrepareDialogBuilder(AlertDialog.Builder builder)` Prepares the dialog builder to be shown when the preference is clicked.
`Parcelable`	`onSaveInstanceState()` Hook allowing a Preference to generate a representation of its internal state that can later be used to create a new instance with that same state.
`void`	`onSetInitialValue(boolean restoreValue, Object defaultValue)` Implement this to set the initial value of the Preference.

Inherited methods

From class


  
    android.preference.DialogPreference

From class


  
    android.preference.Preference

`boolean`	`callChangeListener(Object newValue)` Call this method after the user changes the preference, but before the internal state is set.
`int`	`compareTo(Preference another)` Compares Preference objects based on order (if set), otherwise alphabetically on the titles.
`Preference`	`findPreferenceInHierarchy(String key)` Finds a Preference in this hierarchy (the whole thing, even above/below your `PreferenceScreen` screen break) with the given key.
`Context`	`getContext()` Returns the `Context` of this Preference.
`String`	`getDependency()` Returns the key of the dependency on this Preference.
`SharedPreferences.Editor`	`getEditor()` Returns an `SharedPreferences.Editor` where this Preference can save its value(s).
`Bundle`	`getExtras()` Return the extras Bundle object associated with this preference, creating a new Bundle if there currently isn't one.
`String`	`getFragment()` Return the fragment class name associated with this Preference.
`Drawable`	`getIcon()` Returns the icon of this Preference.
`Intent`	`getIntent()` Return the `Intent` associated with this Preference.
`String`	`getKey()` Gets the key for this Preference, which is also the key used for storing values into SharedPreferences.
`int`	`getLayoutResource()` Gets the layout resource that will be shown as the `View` for this Preference.
`Preference.OnPreferenceChangeListener`	`getOnPreferenceChangeListener()` Returns the callback to be invoked when this Preference is changed by the user (but before the internal state has been updated).
`Preference.OnPreferenceClickListener`	`getOnPreferenceClickListener()` Returns the callback to be invoked when this Preference is clicked.
`int`	`getOrder()` Gets the order of this Preference with respect to other Preference objects on the same level.
`boolean`	`getPersistedBoolean(boolean defaultReturnValue)` Attempts to get a persisted boolean from the `SharedPreferences`.
`float`	`getPersistedFloat(float defaultReturnValue)` Attempts to get a persisted float from the `SharedPreferences`.
`int`	`getPersistedInt(int defaultReturnValue)` Attempts to get a persisted int from the `SharedPreferences`.
`long`	`getPersistedLong(long defaultReturnValue)` Attempts to get a persisted long from the `SharedPreferences`.
`String`	`getPersistedString(String defaultReturnValue)` Attempts to get a persisted String from the `SharedPreferences`.
`Set<String>`	`getPersistedStringSet(Set<String> defaultReturnValue)` Attempts to get a persisted set of Strings from the `SharedPreferences`.
`PreferenceManager`	`getPreferenceManager()` Gets the `PreferenceManager` that manages this Preference object's tree.
`SharedPreferences`	`getSharedPreferences()` Returns the `SharedPreferences` where this Preference can read its value(s).
`boolean`	`getShouldDisableView()` Checks whether this Preference should disable its view when it's action is disabled.
`CharSequence`	`getSummary()` Returns the summary of this Preference.
`CharSequence`	`getTitle()` Returns the title of this Preference.
`int`	`getTitleRes()` Returns the title resource ID of this Preference.
`View`	`getView(View convertView, ViewGroup parent)` Gets the View that will be shown in the `PreferenceActivity`.
`int`	`getWidgetLayoutResource()` Gets the layout resource for the controllable widget portion of this Preference.
`boolean`	`hasKey()` Checks whether this Preference has a valid key.
`boolean`	`isEnabled()` Checks whether this Preference should be enabled in the list.
`boolean`	`isPersistent()` Checks whether this Preference is persistent.
`boolean`	`isSelectable()` Checks whether this Preference should be selectable in the list.
`void`	`notifyChanged()` Should be called when the data of this `Preference` has changed.
`void`	`notifyDependencyChange(boolean disableDependents)` Notifies any listening dependents of a change that affects the dependency.
`void`	`notifyHierarchyChanged()` Should be called when a Preference has been added/removed from this group, or the ordering should be re-evaluated.
`void`	`onAttachedToActivity()` Called when the Preference hierarchy has been attached to the `PreferenceActivity`.
`void`	`onAttachedToHierarchy(PreferenceManager preferenceManager)` Called when this Preference has been attached to a Preference hierarchy.
`void`	`onBindView(View view)` Binds the created View to the data for this Preference.
`void`	`onClick()` Processes a click on the preference.
`View`	`onCreateView(ViewGroup parent)` Creates the View to be shown for this Preference in the `PreferenceActivity`.
`void`	`onDependencyChanged(Preference dependency, boolean disableDependent)` Called when the dependency changes.
`Object`	`onGetDefaultValue(TypedArray a, int index)` Called when a Preference is being inflated and the default value attribute needs to be read.
`void`	`onParentChanged(Preference parent, boolean disableChild)` Called when the implicit parent dependency changes.
`void`	`onPrepareForRemoval()` Called when this Preference is being removed from the hierarchy.
`void`	`onRestoreInstanceState(Parcelable state)` Hook allowing a Preference to re-apply a representation of its internal state that had previously been generated by `onSaveInstanceState()`.
`Parcelable`	`onSaveInstanceState()` Hook allowing a Preference to generate a representation of its internal state that can later be used to create a new instance with that same state.
`void`	`onSetInitialValue(boolean restorePersistedValue, Object defaultValue)` Implement this to set the initial value of the Preference.
`Bundle`	`peekExtras()` Return the extras Bundle object associated with this preference, returning null if there is not currently one.
`boolean`	`persistBoolean(boolean value)` Attempts to persist a boolean to the `SharedPreferences`.
`boolean`	`persistFloat(float value)` Attempts to persist a float to the `SharedPreferences`.
`boolean`	`persistInt(int value)` Attempts to persist an int to the `SharedPreferences`.
`boolean`	`persistLong(long value)` Attempts to persist a long to the `SharedPreferences`.
`boolean`	`persistString(String value)` Attempts to persist a String to the `SharedPreferences`.
`boolean`	`persistStringSet(Set<String> values)` Attempts to persist a set of Strings to the `SharedPreferences`.
`void`	`restoreHierarchyState(Bundle container)` Restore this Preference hierarchy's previously saved state from the given container.
`void`	`saveHierarchyState(Bundle container)` Store this Preference hierarchy's frozen state into the given container.
`void`	`setDefaultValue(Object defaultValue)` Sets the default value for this Preference, which will be set either if persistence is off or persistence is on and the preference is not found in the persistent storage.
`void`	`setDependency(String dependencyKey)` Sets the key of a Preference that this Preference will depend on.
`void`	`setEnabled(boolean enabled)` Sets whether this Preference is enabled.
`void`	`setFragment(String fragment)` Sets the class name of a fragment to be shown when this Preference is clicked.
`void`	`setIcon(Drawable icon)` Sets the icon for this Preference with a Drawable.
`void`	`setIcon(int iconResId)` Sets the icon for this Preference with a resource ID.
`void`	`setIntent(Intent intent)` Sets an `Intent` to be used for `startActivity(Intent)` when this Preference is clicked.
`void`	`setKey(String key)` Sets the key for this Preference, which is used as a key to the `SharedPreferences`.
`void`	`setLayoutResource(int layoutResId)` Sets the layout resource that is inflated as the `View` to be shown for this Preference.
`void`	`setOnPreferenceChangeListener(Preference.OnPreferenceChangeListener onPreferenceChangeListener)` Sets the callback to be invoked when this Preference is changed by the user (but before the internal state has been updated).
`void`	`setOnPreferenceClickListener(Preference.OnPreferenceClickListener onPreferenceClickListener)` Sets the callback to be invoked when this Preference is clicked.
`void`	`setOrder(int order)` Sets the order of this Preference with respect to other Preference objects on the same level.
`void`	`setPersistent(boolean persistent)` Sets whether this Preference is persistent.
`void`	`setSelectable(boolean selectable)` Sets whether this Preference is selectable.
`void`	`setShouldDisableView(boolean shouldDisableView)` Sets whether this Preference should disable its view when it gets disabled.
`void`	`setSummary(CharSequence summary)` Sets the summary for this Preference with a CharSequence.
`void`	`setSummary(int summaryResId)` Sets the summary for this Preference with a resource ID.
`void`	`setTitle(CharSequence title)` Sets the title for this Preference with a CharSequence.
`void`	`setTitle(int titleResId)` Sets the title for this Preference with a resource ID.
`void`	`setWidgetLayoutResource(int widgetLayoutResId)` Sets the layout for the controllable widget portion of this Preference.
`boolean`	`shouldCommit()` Returns whether the `Preference` should commit its saved value(s) in `getEditor()`.
`boolean`	`shouldDisableDependents()` Checks whether this preference's dependents should currently be disabled.
`boolean`	`shouldPersist()` Checks whether, at the given time this method is called, this Preference should store/restore its value(s) into the `SharedPreferences`.
`String`	`toString()` Returns a string representation of the object.

From class


  
    java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

From interface


  
    android.content.DialogInterface.OnClickListener

From interface


  
    android.content.DialogInterface.OnDismissListener

From interface


  
    android.preference.PreferenceManager.OnActivityDestroyListener

From interface


  
    java.lang.Comparable

XML attributes

android:entries

The human-readable array to present as a list. Each entry must have a corresponding index in entryValues.

Must be a reference to another resource, in the form "@[+][package:]type:name" or to a theme attribute in the form "?[package:][type:]name".

This corresponds to the global attribute resource symbol entries.

android:entryValues

The array to find the value to save for a preference when an entry from entries is selected. If a user clicks the second item in entries, the second item in this array will be saved to the preference.

Must be a reference to another resource, in the form "@[+][package:]type:name" or to a theme attribute in the form "?[package:][type:]name".

This corresponds to the global attribute resource symbol entryValues.

Public constructors