android developer API Guider之user interface---Settings（一）

本文翻译之原文地址，可参照阅读：

http://developer.android.com/guide/topics/ui/settings.html#DefiningPrefs

笔者水平有限，翻译之中难免有错误之处，敬请指出，不甚感激！

本文原文较长，所以会分几篇博文发出，敬请谅解！

设置

        应用通常会包含允许用户修改app特性的设置。例如，一些app允许用户修改是否使能notificatons或者修改应用把数据同步到云端的频率。

        假如你想为你的app提供设置的功能，你需要使用Android的Preference API去实现一个接口，它使得用户在使用这个app时和使用别的应用（包括系统的设置）感觉起来比较类似。这篇文档就描述了如何使用Preference API去创建你的app设置。

设置的设计

         关于如何设计你的设置，请参阅《设置设计指导》。

概述

        设置使用一系列在XML文件中定义的preference类的子类来实现用户的接口，而不再使用View objects来实现。

        一个Preference object是一个单设置的组成部件。每一个preference都是作为一个item显示在列表中的并且为用户去改变设置提供了对应的UI。比如，一个CheckBoxPreference创建了一个列表item，显示为一个复选框，而一个ListPreference则创建一个item，他会打开一个列表选择的对话框。

        对你的应用设置而言，每一个你加入的Preference都有一个相对应的键值去匹配系统保存在默认sharedPreference文件中的设置。当用户改变这个设置时，系统会刷新保存在SharedPreference文件中的对应的值。只有你需要根据用户的设置来决定你的app的行为时，你才会读取保存在相应sharedPreferences文件中的值。

        为每一个设置保存在SharedPreference中的值应当是以下类型中的一种：

l  Boolean

l  Float

l  Int

l  Log

l  String

l  String Set

        因为你的app是使用Preference objects而不是view objects，你需要使用一个特殊的activity或者fragment子类来显示列表设置：

        假如你的应用支持Android3.0之前的版本（API level 10及之前），你必须build这个activity为PreferenceActivity类的扩展。

        在Android3.0及之后，你应当使用一个PreferenceFragment来代替传统的Activity来显示你的app设置。当然，你仍然可以使用PreferenceActivity去创建一个two-pane画布，用于多个设置组的大屏应用中。

如何创建你的preferenceactivity和preferencefragment的实例，请参见《创建一个Preference Activity》和《使用Preference Fragments》。

 

图一，Android短信应用中的设置截图，

选择一个由preference定义的item来打开一个改变设置的接口

Preferences

你的app的每一个设置都是由Preference类的一个特殊的子类来描述的。每一个子类都有一些核心的属性允许你去改变诸如设置的标题，默认值之类的东西。每一个子类也提供它自己特殊的属性和用户的接口。例如，图1就显示了一个短信app设置的截图，每一个列表item都由不同的Preference object来回调。

        一些常用的Preference如下：

CheckBoxPreference

        在设置中显示一个复选框，可以被选中或者不选中。保存的值是一个boolean（选中为true）。

ListPreference

        打开一个有一系列单选按钮的对话框，保存的值可以是任何一个支持的类型（见上文）。

EditTextPreference

        打开一个具有输入功能的小窗口，他保存的值是一个string的类型。

        其它的子类和他们相应的属性请参看Preference类。

当然内建的类并不能满足所有你的需求，你有可能需要一些特殊的类。比如，系统当前并不提供一个Preference类来获得一个数据或者数字。因此你有可能需要定义自己的Preference子类。如何自己定义，请参照《创建一个用户Preference》章节。

在XML中定义Preferences

        虽然你可以在运行的时候实例化一个新的Preference objects，但是你仍然应当在一个XML中使用由层次的Preference objects来定义你的设置列表。使用XML文件来定义你的设置结合是一个比较好的方法，因为这个文件看起来比较清晰而且以后升级起来也比较方便。同时，你的应用设置通常是预先决定好了，尽管在运行的时候你仍然可以修改这个集合。

每一个Preference子类都是能够由XML文件中和类名字匹配的元素来声明，比较<CheckBoxPreference>.

你应当把XML文件保存在res/xml目录下面。尽管你可以把这个文件命名为任何一个你想要的名字，它通常会被命名为preferences.xml。你通常只需要一个文件，因为在层次中的分支都似乎有内嵌的preferenceScren的实例来声明的。

注意：假如你想要创建multi-pane layout，你需要为每一个fragment使用单独的XML文件。

XML文件的根节点应当是<PreferenceScreen>元素，这个元素里面就是你自己添加的Preference。其中你添加的每一个元素都会在设置列表中显示为一个单独的item。

例子：

<?xml version="1.0" encoding="utf-8"?>
<PreferenceScreen xmlns:android="http://schemas.android.com/apk/res/android">
    <CheckBoxPreference
        android:key="pref_sync"
        android:title="@string/pref_sync"
        android:summary="@string/pref_sync_summ"
        android:defaultValue="true" />
    <ListPreference
        android:dependency="pref_sync"
        android:key="pref_syncConnectionType"
        android:title="@string/pref_syncConnectionType"
        android:dialogTitle="@string/pref_syncConnectionType"
        android:entries="@array/pref_syncConnectionTypes_entries"
        android:entryValues="@array/pref_syncConnectionTypes_values"
        android:defaultValue="@string/pref_syncConnectionTypes_default" />
</PreferenceScreen>

 

在这个例子中，包含了一个CheckBoxPreference和一个ListPreference。这两个item都包含以下三个属性：

android:key

      这个参数在preference中是用来保存一个数据值的。他指定了系统保存设置值到SharedPreferences中所使用的特定的值。

    只有在PreferenceCategory和PreferenceScreen中，这个值才不是强制要求的。当然若是这个preference指定了一个Intent去回调（就是有<intent>元素）或者一个Fragment去显示（有android:fragment属性），他也是不需要的。

android:title

        这个是用户可见的设置的标题。

android:defaultValue

        这个指定了系统保存到SharedPreferences中的初始值，你应当为所有的设置指定一个初始值。

        关于别的支持的属性，请参照Preference文档。

        当你的设置列表超过了10个items，你也许需要为设置的组加入标题或者在不同的屏幕中显示这些组。这些选项在下面的章节中会被介绍到。

创建设置组

        假如你实现了超过10个的设置，用户也许在使用，理解和处理他们的时候有一些困难。你可以通过分组来解决这个问题。每一个相关设置的分组可以通过以下两种方法：

使用标题

使用子窗口

        你可以使用一个或者两个以上的技术来组织你的app设置。你决定使用之后，你应当遵循Android设计的设置指导。

使用标题

        假如你想像图2那样使用标题来区分不同的设置组，把每一个Preference objects放到一个PreferenceCategory中去。

图2通过标题来为设置分类

1.通过<PreferenceCategory>元素来进行分类

2.这个标题的名字是由android:title属性来指定的

例子：

<PreferenceScreen xmlns:android="http://schemas.android.com/apk/res/android">
    <PreferenceCategory 
        android:title="@string/pref_sms_storage_title"
        android:key="pref_key_storage_settings">
        <CheckBoxPreference
            android:key="pref_key_auto_delete"
            android:summary="@string/pref_summary_auto_delete"
            android:title="@string/pref_title_auto_delete"
            android:defaultValue="false"... />
        <Preference 
            android:key="pref_key_sms_delete_limit"
            android:dependency="pref_key_auto_delete"
            android:summary="@string/pref_summary_delete_limit"
            android:title="@string/pref_title_sms_delete"... />
        <Preference 
            android:key="pref_key_mms_delete_limit"
            android:dependency="pref_key_auto_delete"
            android:summary="@string/pref_summary_delete_limit"
            android:title="@string/pref_title_mms_delete" ... />
    </PreferenceCategory>
    ...
</PreferenceScreen>

使用子窗口

         假如你想使用子窗口来放不同的设置组（如图3），把Preference组放入到PreferenceScreen中。 

图3.设置子窗口。<PreferenceScreen>元素创建一个item，当选择它的时候，就会打开一个内嵌设置的显示列表

例子：

<PreferenceScreen  xmlns:android="http://schemas.android.com/apk/res/android">
    <!-- opens a subscreen of settings -->
    <PreferenceScreen
        android:key="button_voicemail_category_key"
        android:title="@string/voicemail"
        android:persistent="false">
        <ListPreference
            android:key="button_voicemail_provider_key"
            android:title="@string/voicemail_provider" ... />
        <!-- opens another nested subscreen -->
        <PreferenceScreen
            android:key="button_voicemail_setting_key"
            android:title="@string/voicemail_settings"
            android:persistent="false">
            ...
        </PreferenceScreen>
        <RingtonePreference
            android:key="button_voicemail_ringtone_key"
            android:title="@string/voicemail_ringtone_title"
            android:ringtoneType="notification" ... />
        ...
    </PreferenceScreen>
    ...
</PreferenceScreen>