File	Doc	Category	Size	Date	Package
ListPreference.java	API Doc	Android 5.1 API	11640	Thu Mar 12 22:22:10 GMT 2015	android.preference

ListPreference

• java.lang.Object
  • DialogPreference

Fields Summary
private CharSequence[]	mEntries
private CharSequence[]	mEntryValues
private String	mValue
private String	mSummary
private int	mClickedDialogEntryIndex
private boolean	mValueSet

Constructors Summary
public ListPreference(android.content.Context context, android.util.AttributeSet attrs, int defStyleAttr, int defStyleRes) super(context, attrs, defStyleAttr, defStyleRes); TypedArray a = context.obtainStyledAttributes( attrs, com.android.internal.R.styleable.ListPreference, defStyleAttr, defStyleRes); mEntries = a.getTextArray(com.android.internal.R.styleable.ListPreference_entries); mEntryValues = a.getTextArray(com.android.internal.R.styleable.ListPreference_entryValues); a.recycle(); /* Retrieve the Preference summary attribute since it's private * in the Preference class. */ a = context.obtainStyledAttributes(attrs, com.android.internal.R.styleable.Preference, defStyleAttr, defStyleRes); mSummary = a.getString(com.android.internal.R.styleable.Preference_summary); a.recycle();
public ListPreference(android.content.Context context, android.util.AttributeSet attrs, int defStyleAttr) this(context, attrs, defStyleAttr, 0);
public ListPreference(android.content.Context context, android.util.AttributeSet attrs) this(context, attrs, com.android.internal.R.attr.dialogPreferenceStyle);
public ListPreference(android.content.Context context) this(context, null);

Methods Summary
public int	findIndexOfValue(java.lang.String value) Returns the index of the given value (in the entry values array). param value The value whose index should be returned. return The index of the value, or -1 if not found. if (value != null && mEntryValues != null) { for (int i = mEntryValues.length - 1; i >= 0; i--) { if (mEntryValues[i].equals(value)) { return i; } } } return -1;
public java.lang.CharSequence[]	getEntries() The list of entries to be shown in the list in subsequent dialogs. return The list as an array. return mEntries;
public java.lang.CharSequence	getEntry() Returns the entry corresponding to the current value. return The entry corresponding to the current value, or null. int index = getValueIndex(); return index >= 0 && mEntries != null ? mEntries[index] : null;
public java.lang.CharSequence[]	getEntryValues() Returns the array of values to be saved for the preference. return The array of values. return mEntryValues;
public java.lang.CharSequence	getSummary() Returns the summary of this ListPreference. If the summary has a {@linkplain java.lang.String#format String formatting} marker in it (i.e. "%s" or "%1$s"), then the current entry value will be substituted in its place. return the summary with appropriate string substitution final CharSequence entry = getEntry(); if (mSummary == null) { return super.getSummary(); } else { return String.format(mSummary, entry == null ? "" : entry); }
public java.lang.String	getValue() Returns the value of the key. This should be one of the entries in {@link #getEntryValues()}. return The value of the key. return mValue;
private int	getValueIndex() return findIndexOfValue(mValue);
protected void	onDialogClosed(boolean positiveResult) super.onDialogClosed(positiveResult); if (positiveResult && mClickedDialogEntryIndex >= 0 && mEntryValues != null) { String value = mEntryValues[mClickedDialogEntryIndex].toString(); if (callChangeListener(value)) { setValue(value); } }
protected java.lang.Object	onGetDefaultValue(android.content.res.TypedArray a, int index) return a.getString(index);
protected void	onPrepareDialogBuilder(android.app.AlertDialog.Builder builder) super.onPrepareDialogBuilder(builder); if (mEntries == null || mEntryValues == null) { throw new IllegalStateException( "ListPreference requires an entries array and an entryValues array."); } mClickedDialogEntryIndex = getValueIndex(); builder.setSingleChoiceItems(mEntries, mClickedDialogEntryIndex, new DialogInterface.OnClickListener() { public void onClick(DialogInterface dialog, int which) { mClickedDialogEntryIndex = which; /* * Clicking on an item simulates the positive button * click, and dismisses the dialog. */ ListPreference.this.onClick(dialog, DialogInterface.BUTTON_POSITIVE); dialog.dismiss(); } }); /* * The typical interaction for list-based dialogs is to have * click-on-an-item dismiss the dialog instead of the user having to * press 'Ok'. */ builder.setPositiveButton(null, null);
protected void	onRestoreInstanceState(android.os.Parcelable state) if (state == null || !state.getClass().equals(SavedState.class)) { // Didn't save state for us in onSaveInstanceState super.onRestoreInstanceState(state); return; } SavedState myState = (SavedState) state; super.onRestoreInstanceState(myState.getSuperState()); setValue(myState.value);
protected android.os.Parcelable	onSaveInstanceState() final Parcelable superState = super.onSaveInstanceState(); if (isPersistent()) { // No need to save instance state since it's persistent return superState; } final SavedState myState = new SavedState(superState); myState.value = getValue(); return myState;
protected void	onSetInitialValue(boolean restoreValue, java.lang.Object defaultValue) setValue(restoreValue ? getPersistedString(mValue) : (String) defaultValue);
public void	setEntries(java.lang.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 {@link #setEntryValues(CharSequence[])}. param entries The entries. see #setEntryValues(CharSequence[]) mEntries = entries;
public void	setEntries(int entriesResId) see #setEntries(CharSequence[]) param entriesResId The entries array as a resource. setEntries(getContext().getResources().getTextArray(entriesResId));
public void	setEntryValues(java.lang.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. param entryValues The array to be used as values to save for the preference. mEntryValues = entryValues;
public void	setEntryValues(int entryValuesResId) see #setEntryValues(CharSequence[]) param entryValuesResId The entry values array as a resource. setEntryValues(getContext().getResources().getTextArray(entryValuesResId));
public void	setSummary(java.lang.CharSequence summary) Sets the summary for this Preference with a CharSequence. If the summary has a {@linkplain java.lang.String#format String formatting} marker in it (i.e. "%s" or "%1$s"), then the current entry value will be substituted in its place when it's retrieved. param summary The summary for the preference. super.setSummary(summary); if (summary == null && mSummary != null) { mSummary = null; } else if (summary != null && !summary.equals(mSummary)) { mSummary = summary.toString(); }
public void	setValue(java.lang.String value) Sets the value of the key. This should be one of the entries in {@link #getEntryValues()}. param value The value to set for the key. // Always persist/notify the first time. final boolean changed = !TextUtils.equals(mValue, value); if (changed || !mValueSet) { mValue = value; mValueSet = true; persistString(value); if (changed) { notifyChanged(); } }
public void	setValueIndex(int index) Sets the value to the given index from the entry values. param index The index of the value to set. if (mEntryValues != null) { setValue(mEntryValues[index].toString()); }