Most visited

Recently visited

Results for

MultiSelectListPreference

public class MultiSelectListPreference
extends DialogPreference

java.lang.Object
↳	android.support.v7.preference.Preference
	↳	android.support.v7.preference.DialogPreference
		↳	android.support.v14.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

Inherited constants

From class


    android.support.v7.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
`boolean[]`	`getSelectedItems()`
`Object`	`onGetDefaultValue(TypedArray a, int index)` Called when a Preference is being inflated and the default value attribute needs to be read.
`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 restoreValue, Object defaultValue)` Implement this to set the initial value of the Preference.

Inherited methods

From class


  
    android.support.v7.preference.DialogPreference

From class


  
    android.support.v7.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.
`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.
`final 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`.
`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.
`final 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.
`final boolean`	`isVisible()` Checks whether this preference should be visible to the user 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`	`onAttached()` Called when the Preference hierarchy has been attached to the list of preferences.
`void`	`onAttachedToHierarchy(PreferenceManager preferenceManager)` Called when this Preference has been attached to a Preference hierarchy.
`void`	`onBindViewHolder(PreferenceViewHolder holder)` Binds the created View to the data for this Preference.
`void`	`onClick()` Processes a click on the preference.
`void`	`onDependencyChanged(Preference dependency, boolean disableDependent)` Called when the dependency changes.
`void`	`onDetached()` Called when the Preference hierarchy has been detached from the list of preferences.
`Object`	`onGetDefaultValue(TypedArray a, int index)` Called when a Preference is being inflated and the default value attribute needs to be read.
`void`	`onInitializeAccessibilityNodeInfo(AccessibilityNodeInfoCompat info)` Initializes an `AccessibilityNodeInfo` with information about the View for this Preference.
`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`.
`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`	`setViewId(int viewId)` Set the ID that will be assigned to the overall View representing this preference, once bound.
`final void`	`setVisible(boolean visible)` Sets whether this preference should be visible in the list.
`void`	`setWidgetLayoutResource(int widgetLayoutResId)` Sets the layout for the controllable widget portion of this Preference.
`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


  
    java.lang.Comparable

Public constructors

MultiSelectListPreference

MultiSelectListPreference (Context context, 
                AttributeSet attrs, 
                int defStyleAttr, 
                int defStyleRes)

Parameters
`context`	`Context`
`attrs`	`AttributeSet`
`defStyleAttr`	`int`
`defStyleRes`	`int`

MultiSelectListPreference

MultiSelectListPreference (Context context, 
                AttributeSet attrs, 
                int defStyleAttr)

Parameters
`context`	`Context`
`attrs`	`AttributeSet`
`defStyleAttr`	`int`

MultiSelectListPreference

MultiSelectListPreference (Context context, 
                AttributeSet attrs)

Parameters
`context`	`Context`
`attrs`	`AttributeSet`

MultiSelectListPreference

MultiSelectListPreference (Context context)

Parameters
`context`	`Context`

Public methods

findIndexOfValue

int findIndexOfValue (String value)

Returns the index of the given value (in the entry values array).

Parameters
`value`	`String`: The value whose index should be returned.

Returns
`int`	The index of the value, or -1 if not found.

getEntries

CharSequence[] getEntries ()

The list of entries to be shown in the list in subsequent dialogs.

Returns
`CharSequence[]`	The list as an array.

getEntryValues

CharSequence[] getEntryValues ()

Returns the array of values to be saved for the preference.

Returns
`CharSequence[]`	The array of values.

getValues

Set<String> getValues ()

Retrieves the current value of the key.

Returns
`Set<String>`

setEntries

void setEntries (CharSequence[] entries)

Sets the human-readable entries to be shown in the list. This will be shown in subsequent dialogs.

Each entry must have a corresponding index in setEntryValues(CharSequence[]).

Parameters
`entries`	`CharSequence`: The entries.

See also:

setEntryValues(CharSequence[])

setEntries

void setEntries (int entriesResId)

Parameters
`entriesResId`	`int`: The entries array as a resource.

See also:

setEntries(CharSequence[])

setEntryValues

void setEntryValues (int entryValuesResId)

Parameters
`entryValuesResId`	`int`: The entry values array as a resource.

See also:

setEntryValues(CharSequence[])

setEntryValues

void setEntryValues (CharSequence[] entryValues)

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

Parameters
`entryValues`	`CharSequence`: The array to be used as values to save for the preference.

setValues

void setValues (Set<String> values)

Sets the value of the key. This should contain entries in getEntryValues().

Parameters
`values`	`Set`: The values to set for the key.

Protected methods

getSelectedItems

boolean[] getSelectedItems ()

Returns
`boolean[]`

onGetDefaultValue

Object onGetDefaultValue (TypedArray a, 
                int index)

Called when a Preference is being inflated and the default value attribute needs to be read. Since different Preference types have different value types, the subclass should get and return the default value which will be its value type.

For example, if the value type is String, the body of the method would proxy to getString(int).

Parameters
`a`	`TypedArray`: The set of attributes.
`index`	`int`: The index of the default value attribute.

Returns
`Object`	The default value of this preference type.

onRestoreInstanceState

void onRestoreInstanceState (Parcelable state)

Hook allowing a Preference to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState(). This function will never be called with a null state.

Parameters
`state`	`Parcelable`: The saved state that had previously been returned by `onSaveInstanceState()`.

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. This state should only contain information that is not persistent or can be reconstructed later.

Returns
`Parcelable`	A Parcelable object containing the current dynamic state of this Preference, or null if there is nothing interesting to save. The default implementation returns null.

onSetInitialValue

void onSetInitialValue (boolean restoreValue, 
                Object defaultValue)

Implement this to set the initial value of the Preference.

If restorePersistedValue is true, you should restore the Preference value from the SharedPreferences. If restorePersistedValue is false, you should set the Preference value to defaultValue that is given (and possibly store to SharedPreferences if shouldPersist() is true).

This may not always be called. One example is if it should not persist but there is no default value given.

Parameters
`restoreValue`	`boolean`: True to restore the persisted value; false to use the given `defaultValue`.
`defaultValue`	`Object`: The default value for this Preference. Only use this if `restorePersistedValue` is false.

Interfaces

Classes

Most visited

Recently visited

Results for

MultiSelectListPreference

Summary

Inherited constants

Public constructors

Public methods

Protected methods

Inherited methods

Public constructors

MultiSelectListPreference

MultiSelectListPreference

MultiSelectListPreference

MultiSelectListPreference

Public methods

findIndexOfValue

getEntries

getEntryValues

getValues

setEntries

setEntries

setEntryValues

setEntryValues

setValues

Protected methods

getSelectedItems

onGetDefaultValue

onRestoreInstanceState

onSaveInstanceState

onSetInitialValue