关于Preference的一点理解

版权声明：转载时请以超链接形式标明文章原始出处和作者信息及本声明

http://allenyoung.blogbus.com/logs/1694872.html

稍微正规一点儿的plug-in都会有Preference page，在那里我们可以设置一个plug-in的profile，来个性化plug-in的显示及运行效果。Eclipse把Preference作为一个extension，这样就方便了plug-in开发者对Preference的开发，在PrettyPro中，我第一次尝试了Preference的开发，有了点儿理解，写在下面。

Preference的extension是org.eclipse.ui.preferencePages，因此在plugin.xml中，我们可以如下的声明一个Preference：

  <extension point="org.eclipse.ui.preferencePages">
    <page
            id="com.qad.progress.prettypro.ui.preference.GenralPage"
            name="%preference.GeneralPage"
            class="com.qad.progress.prettypro.ui.preference.GeneralPage">
    </page>   
    <page 
            id="com.qad.progress.prettypro.ui.preference.IndentationPage"
            name="%preference.IndentationPage"
            class="com.qad.progress.prettypro.ui.preference.IndentationPage"
            category="com.qad.progress.prettypro.ui.preference.GenralPage">
    </page>
  </extension>

其中的page就是我们想要在Preference中显示个页面，category提供了给page分级的方法。

声明好之后，我们就要去实现具体的page类，每一个page类都要实现org.eclipse.ui.IWorkbenchPreferencePage接口，并继承org.eclipse.jface.preference.PreferencePage类。随着这些实现和继承的声明，page类就要实现两个方法，protected Control createContents(Composite parent)和public void init(IWorkbench workbench)。可以看出，createContents是用来创建page中显示的widget的；init的用处在下面会提到。

下面要着重说一下Preference的结构，对Preference中内容从存储，都是通过org.eclipse.jface.preference.IPreferenceStore这个接口来完成的。每个plug-in都有它自己默认的一个IPreferenceStore，我们可以通过plug-in类来获得，例如：PrettyProPlugin.getDefault().getPreferenceStore()。IPreferenceStore中存储着Preference的default setting value和user defined value这两套value。这是通过一组键值对来实现的。Preference中每个要存储的数据都要对应到一个开发者自己声明的String上，我们可以使用IPreferenceStore的setDefault()来对default value做这一关联。注意IPreferenceStore的存储和读取Preference数据的方法只能操作primitive type。

当我们使用setDefault方法关联了所有的键值对后(这些操作往往写在plug-in类的protected void initializeDefaultPreferences(IPreferenceStore store)方法中)，我们就可以在page类的createContents方法中创建widgets，并用IPreferenceStore的getXXX()方法来获得各个键的值(XXX表示primitive type)，并赋给widgets显示。

下面要为每一个page类实现protected void performDefaults()和public boolean performOk()方法，它们分别相应page中的"Restore default"按钮和"Ok"按钮，"Apply"按钮默认也调用performOk方法。在performDefaults中，使用IPreferenceStore的getDefaultXXX()方法来获得default value并赋给widgets；在performOk中，使用IPreferenceStore的setValue()方法来存储widgets下的数据。

最后来看init这个方法，一般我们会写如如下代码：

setPreferenceStore(PrettyProPlugin.getDefault().getPreferenceStore());

这样做是为了把当前page所使用的Preference Store赋值。

后续的文章中，我会讲到如何动态的相应Preference上的改变，以及Eclipse的Field Editors在Preference Page中的使用。