Android中Fragmen首选项使用自定义的ListPreference的方法

首选项这个名词对于熟悉Android的朋友们一定不会感到陌生，它经常用来设置软件的运行参数。
Android提供了一种健壮并且灵活的框架来处理首选项。它提供了简单的API来隐藏首选项的读取和持久化，并且提供了一个优雅的首选项界面。
几种常见的首选项：
（1）CheckBoxPreference：用来打开或关闭某个功能
（2）ListPreference：用来从多个选项中选择一个值；
（3）EditTextPreference：用来配置一段文字信息；
（4）Preference：用来执行相关的自定义操作(上图中的清除缓存、历史记录、表单、cookie都属于此项)；
（5）RingtonePreference：专门用来为用户设置铃声。
当我们使用首选项框架时，用户每更改一项的值后，系统就会立即在/data/data/[PACKAGE_NAME]/shared_prefs下生成一个[PACKAGE_NAME]_preferences.xml的文件，文件会记录最新的配置信息。
那么本文要讲的就是其中的ListPreference，以及通过PreferenceFragment来使用自定义的ListPreference。

1. 自定义属性
添加文件res/values/attrs.xml，内容如下：

<?xml version="1.0" encoding="utf-8"?>
<resources>
 <declare-styleable name="IconListPreference">
  <attr name="entryIcons" format="reference" />
 </declare-styleable>
</resources>

说明：
(01) name="IconListPreference"，与自定义的ListPreference类的名称相对应。后面会实现一个继承于ListPreference的IconListPreference.java。
(02) name="entryIcons"，这是属性的名称。
(03) format="reference"，这描述属性的值是引用类型。因为，后面会根据资源id设置该属性，所以将属性格式设为reference。如果是颜色，设为format="color"；如果是布尔类型，format="boolean"；如果是字符串，设为format="string"。
2. 自定义ListPreference
2.1 构造函数

public IconListPreference(Context context, AttributeSet attrs) {
 super(context, attrs);
 mContext = context;

 // 获取自定义的属性(attrs.xml中)对应行的TypedArray
 TypedArray a = context.obtainStyledAttributes(attrs, R.styleable.IconListPreference);
 // 获取entryIcons属性对应的值
 int iconResId = a.getResourceId(R.styleable.IconListPreference_entryIcons, -1);
 if (iconResId != -1) {
  setEntryIcons(iconResId);
 } 

 // 获取Preferece对应的key
 mKey = getKey();
 // 获取SharedPreferences
 mPref = PreferenceManager.getDefaultSharedPreferences(context);
 // 获取SharedPreferences.Editor
 mEditor = mPref.edit();
 // 获取Entry
 // 注意：如果配置文件中没有android:entries属性，则getEntries()为空；
 mEntries = getEntries();
 // 获取Entry对应的值
 // 注意：如果配置文件中没有android:entryValues属性，则getEntries()为空
 mEntryValues = getEntryValues();

 // 获取该ListPreference保存的值
 String value = mPref.getString(mKey, "");
 mPosition = findIndexOfValue(value);
 // 设置Summary
 if (mPosition!=-1) {
  setSummary(mEntries[mPosition]);
  setIcon(mEntryIcons[mPosition]);
 } 

 a.recycle();
}

说明：
(01) 首先，根据obtainStyledAttributes()能获取自定义属性对应的TypedArray对象。
(02) 在自定义属性中，entryIcons对应的类名是IconListPreference。因为需要通过"类名"_"属性名"，即IconListPreference_entryIcons的方式来获取资源信息。
(03) getKey()是获取Preferece对应的Key。该Key是Preference对象的唯一标识。
(04) getEntries()是获取Preferece的Entry数组。
(05) getEntryValues()是获取Preferece的Entry对应的值的数组。
(06) setSummary()是设置Preferece的summary标题内容。
(07) setIcon()是设置Preferece的图标。
2.2 自定义ListPreference中图片相关代码

/**
 * 设置图标：icons数组
 */
private void setEntryIcons(int[] entryIcons) {
 mEntryIcons = entryIcons;
}

/**
 * 设置图标：根据icon的id数组
 */
public void setEntryIcons(int entryIconsResId) {
 TypedArray icons = getContext().getResources().obtainTypedArray(entryIconsResId);
 int[] ids = new int[icons.length()];
 for (int i = 0; i < icons.length(); i++)
  ids[i] = icons.getResourceId(i, -1);
 setEntryIcons(ids);
 icons.recycle();
}

说明：这两个函数是读取图片信息的。
2.3 自定义ListPreference弹出的列表选项

@Override
protected void onPrepareDialogBuilder(Builder builder) {
 super.onPrepareDialogBuilder(builder);

 IconAdapter adapter = new IconAdapter(mContext);
 builder.setAdapter(adapter, null);
}

说明：点击ListPreference，会弹出一个列表对话框。通过重写onPrepareDialogBuilder()，我们可以自定义弹出的列表对话框。这里是通过IconAdapter来显示的。

public class IconAdapter extends BaseAdapter{

 private LayoutInflater mInflater;

 public IconAdapter(Context context){
  this.mInflater = LayoutInflater.from(context);
 }
 @Override
 public int getCount() {
  return mEntryIcons.length;
 }

 @Override
 public Object getItem(int arg0) {
  return null;
 }

 @Override
 public long getItemId(int arg0) {
  return 0;
 }

 @Override
 public View getView(int position, View convertView, ViewGroup parent) {

  ViewHolder holder = null;
  if (convertView == null) {

   holder = new ViewHolder();

   convertView = mInflater.inflate(R.layout.icon_adapter, parent, false);
   holder.layout = (LinearLayout)convertView.findViewById(R.id.icon_layout);
   holder.img = (ImageView)convertView.findViewById(R.id.icon_img);
   holder.info = (TextView)convertView.findViewById(R.id.icon_info);
   holder.check = (RadioButton)convertView.findViewById(R.id.icon_check);
   convertView.setTag(holder);

  }else {
   holder = (ViewHolder)convertView.getTag();
  }

  holder.img.setBackgroundResource(mEntryIcons[position]);
  holder.info.setText(mEntries[position]);
  holder.check.setChecked(mPosition == position);

  final ViewHolder fholder = holder;
  final int fpos = position;
  convertView.setOnClickListener(new View.OnClickListener() {

   @Override
   public void onClick(View v) {
    v.requestFocus();
    // 选中效果
    fholder.layout.setBackgroundColor(Color.CYAN);

    // 更新mPosition
    mPosition = fpos;
    // 更新Summary
    IconListPreference.this.setSummary(mEntries[fpos]);
    IconListPreference.this.setIcon(mEntryIcons[fpos]);
    // 更新该ListPreference保存的值
    mEditor.putString(mKey, mEntryValues[fpos].toString());
    mEditor.commit();

    // 取消ListPreference设置对话框
    getDialog().dismiss();
   }
  });

  return convertView;
 }

 // ListPreference每一项对应的Layout文件的结构体
 private final class ViewHolder {
  ImageView img;
  TextView info;
  RadioButton check;
  LinearLayout layout;
 }
}

说明：弹出的列表对话框中的每一项的内容是通过布局icon_adapter.xml来显示的。下面看看icon_adapter.xml的源码。

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
 android:id="@+id/icon_layout"
 android:orientation="horizontal"
 android:paddingLeft="6dp"
 android:layout_width="fill_parent"
 android:layout_height="fill_parent">

 <ImageView
  android:id="@+id/icon_img"
  android:layout_width="wrap_content"
  android:layout_height="wrap_content"
  android:gravity="center_vertical"
  android:layout_margin="4dp"/>

 <TextView
  android:id="@+id/icon_info"
  android:layout_width="0dp"
  android:layout_height="wrap_content"
  android:layout_weight="1"
  android:paddingLeft="6dp"
  android:layout_gravity="left|center_vertical"
  android:textAppearance="?android:attr/textAppearanceLarge" />

 <RadioButton
  android:id="@+id/icon_check"
  android:layout_width="wrap_content"
  android:layout_height="wrap_content"
  android:checked="false"
  android:layout_gravity="right|center_vertical"
  android:layout_marginRight="6dp"/>

</LinearLayout>

至此，自定义的ListPreference就算完成了。下面就是如何使用它了。
3. 使用该自定义ListPreference
我们是通过PreferenceFragment使用该自定义的ListPreference。
3.1 PreferenceFragment的配置文件
res/xml/preferences.xml的内容如下：

<PreferenceScreen xmlns:android="http://schemas.android.com/apk/res/android"
 xmlns:iconlistpreference="http://schemas.android.com/apk/res/com.skw.fragmenttest">

 <!-- 系统默认的ListPreference -->
 <PreferenceCategory
  android:title="PreferenceCategory A">

  <!--
   (01) android:key是Preferece的id
   (02) android:title是Preferece的大标题
   (03) android:summary是Preferece的小标题
   (04) android:dialogTitle是对话框的标题
   (05) android:defaultValue是默认值
   (06) android:entries是列表中各项的说明
   (07) android:entryValues是列表中各项的值
   -->
  <ListPreference
   android:key="list_preference"
   android:dialogTitle="Choose font"
   android:entries="@array/pref_font_types"
   android:entryValues="@array/pref_font_types_values"
   android:summary="sans"
   android:title="Font"
   android:defaultValue="sans"/>
 </PreferenceCategory>

 <!-- 自定义的ListPreference -->

 <PreferenceCategory
  android:title="PreferenceCategory B">

  <!--
   iconlistpreference:entryIcons是自定义的属性
   -->
  <com.skw.fragmenttest.IconListPreference
   android:key="icon_list_preference"
   android:dialogTitle="ChooseIcon"
   android:entries="@array/android_versions"
   android:entryValues="@array/android_version_values"
   iconlistpreference:entryIcons="@array/android_version_icons"
   android:icon="@drawable/cupcake"
   android:summary="summary_icon_list_preference"
   android:title="title_icon_list_preference" /> 

 </PreferenceCategory>

</PreferenceScreen>

说明：该配置文件中使用了"系统默认的ListPreference"和"自定义的ListPreference(即IconListPreference)"。
注意，IconListPreference中的"iconlistpreference:entryIcons"属性。前面的"iconlistpreference"与该文件的命名空间表示"xmlns:iconlistpreference="http://schemas.android.com/apk/res/com.skw.fragmenttest"中的iconlistpreference一样! 而entryIcons则是我们自定义的属性名称。
3.2 自定义PreferenceFragment的代码

public class PrefsFragment extends PreferenceFragment {

 @Override
 public void onCreate(Bundle savedInstanceState) {
  super.onCreate(savedInstanceState);

  addPreferencesFromResource(R.xml.preferences);
 }

 ...
}

4. 使用PrefsFragment
下面，就可以在Activity中使用该PrefsFragment了。
4.1 使用PrefsFragment的Activity的代码

public class FragmentTest extends Activity {

 @Override
 public void onCreate(Bundle savedInstanceState) {
  super.onCreate(savedInstanceState);
  setContentView(R.layout.main);

  // 获取FragmentManager
  FragmentManager fragmentManager = getFragmentManager();
  // 获取FragmentTransaction
  FragmentTransaction fragmentTransaction = fragmentManager.beginTransaction();

  PrefsFragment fragment = new PrefsFragment();
  // 将fragment添加到容器frag_example中
  fragmentTransaction.add(R.id.prefs, fragment);
  fragmentTransaction.commit();
 }
}

4.2 使用PrefsFragment的Activity的配置文件
res/layout/main.xml的内容如下：

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
 android:orientation="vertical"
 android:layout_width="fill_parent"
 android:layout_height="fill_parent"
 >

 <FrameLayout
  android:id="@+id/prefs"
  android:layout_width="match_parent"
  android:layout_height="match_parent"/>

</LinearLayout>