From 7746f910656ce6e811853f4062108e9798063337 Mon Sep 17 00:00:00 2001 From: Dianne Hackborn Date: Thu, 26 Apr 2012 15:34:57 -0700 Subject: New preference for multi-selection check boxes. This will be used for a new settings preference. Change-Id: Ia748cd3e0e8b80ff40942fe2978bd27ce929499a --- .../android/preference/MultiCheckPreference.java | 313 +++++++++++++++++++++ 1 file changed, 313 insertions(+) create mode 100644 core/java/android/preference/MultiCheckPreference.java diff --git a/core/java/android/preference/MultiCheckPreference.java b/core/java/android/preference/MultiCheckPreference.java new file mode 100644 index 000000000000..735f66ae67cd --- /dev/null +++ b/core/java/android/preference/MultiCheckPreference.java @@ -0,0 +1,313 @@ +/* + * Copyright (C) 2012 The Android Open Source Project + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package android.preference; + +import java.util.Arrays; + +import android.app.AlertDialog.Builder; +import android.content.Context; +import android.content.DialogInterface; +import android.content.res.TypedArray; +import android.os.Parcel; +import android.os.Parcelable; +import android.util.AttributeSet; + +/** + * @hide + * A {@link Preference} that displays a list of entries as + * a dialog which allow the user to toggle each individually on and off. + * + * @attr ref android.R.styleable#ListPreference_entries + * @attr ref android.R.styleable#ListPreference_entryValues + */ +public class MultiCheckPreference extends DialogPreference { + private CharSequence[] mEntries; + private String[] mEntryValues; + private boolean[] mSetValues; + private boolean[] mOrigValues; + private String mSummary; + + public MultiCheckPreference(Context context, AttributeSet attrs) { + super(context, attrs); + + TypedArray a = context.obtainStyledAttributes(attrs, + com.android.internal.R.styleable.ListPreference, 0, 0); + mEntries = a.getTextArray(com.android.internal.R.styleable.ListPreference_entries); + if (mEntries != null) { + setEntries(mEntries); + } + setEntryValuesCS(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, 0, 0); + mSummary = a.getString(com.android.internal.R.styleable.Preference_summary); + a.recycle(); + } + + public MultiCheckPreference(Context context) { + this(context, null); + } + + /** + * 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[]) + */ + public void setEntries(CharSequence[] entries) { + mEntries = entries; + mSetValues = new boolean[entries.length]; + mOrigValues = new boolean[entries.length]; + } + + /** + * @see #setEntries(CharSequence[]) + * @param entriesResId The entries array as a resource. + */ + public void setEntries(int entriesResId) { + setEntries(getContext().getResources().getTextArray(entriesResId)); + } + + /** + * The list of entries to be shown in the list in subsequent dialogs. + * + * @return The list as an array. + */ + public CharSequence[] getEntries() { + return mEntries; + } + + /** + * 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. + */ + public void setEntryValues(String[] entryValues) { + mEntryValues = entryValues; + Arrays.fill(mSetValues, false); + Arrays.fill(mOrigValues, false); + } + + /** + * @see #setEntryValues(CharSequence[]) + * @param entryValuesResId The entry values array as a resource. + */ + public void setEntryValues(int entryValuesResId) { + setEntryValuesCS(getContext().getResources().getTextArray(entryValuesResId)); + } + + private void setEntryValuesCS(CharSequence[] values) { + setValues(null); + if (values != null) { + mEntryValues = new String[values.length]; + for (int i=0; i= 0; i--) { + if (mEntryValues[i].equals(value)) { + return i; + } + } + } + return -1; + } + + @Override + protected void onPrepareDialogBuilder(Builder builder) { + super.onPrepareDialogBuilder(builder); + + if (mEntries == null || mEntryValues == null) { + throw new IllegalStateException( + "ListPreference requires an entries array and an entryValues array."); + } + + mOrigValues = Arrays.copyOf(mSetValues, mSetValues.length); + builder.setMultiChoiceItems(mEntries, mSetValues, + new DialogInterface.OnMultiChoiceClickListener() { + @Override + public void onClick(DialogInterface dialog, int which, boolean isChecked) { + mSetValues[which] = isChecked; + } + }); + } + + @Override + protected void onDialogClosed(boolean positiveResult) { + super.onDialogClosed(positiveResult); + + if (positiveResult) { + if (callChangeListener(getValues())) { + return; + } + } + System.arraycopy(mOrigValues, 0, mSetValues, 0, mSetValues.length); + } + + @Override + protected Object onGetDefaultValue(TypedArray a, int index) { + return a.getString(index); + } + + @Override + protected void onSetInitialValue(boolean restoreValue, Object defaultValue) { + } + + @Override + protected 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.values = getValues(); + return myState; + } + + @Override + protected void onRestoreInstanceState(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()); + setValues(myState.values); + } + + private static class SavedState extends BaseSavedState { + boolean[] values; + + public SavedState(Parcel source) { + super(source); + values = source.createBooleanArray(); + } + + @Override + public void writeToParcel(Parcel dest, int flags) { + super.writeToParcel(dest, flags); + dest.writeBooleanArray(values); + } + + public SavedState(Parcelable superState) { + super(superState); + } + + public static final Parcelable.Creator CREATOR = + new Parcelable.Creator() { + public SavedState createFromParcel(Parcel in) { + return new SavedState(in); + } + + public SavedState[] newArray(int size) { + return new SavedState[size]; + } + }; + } + +} -- cgit v1.2.3-59-g8ed1b