Die Preferences Page - eigene Benutzereinstellungen

/**
 * The activator class controls the plug-in life cycle
 */
public class Activator extends AbstractUIPlugin {

   private IWorkbenchAction preferencesAction;

   protected void makeActions(final IWorkbenchWindow window) {
      preferencesAction = ActionFactory.PREFERENCES.create(window);
      register(preferencesAction);
   }

Anschliessend kann sie zu einem Menü hinzugefügt werden:

   protected void fillMenuBar(IMenuManager menuBar) {
      MenuManager aMenu = new MenuManager("&Window",
       IWorkbenchActionConstants.M_WINDOW);
      menuBar.add(aMenu);
      aMenu.add(preferencesAction);

Das Ergebnis, für den Fall dass in der Anwendung durch kein anderes Plugin eine Preferences Page konfiguriert wurde, sieht nun so aus:

   <extension
         point="org.eclipse.ui.preferencePages">
      <page
            class="de.sinoz.rcp.preferences.preferences.PluginPreferencesPage"
            id="de.sinoz.rcp.preferences.preferencespage"
            name="Plugin Preferences">
      </page>
   </extension>

Es empfielt sich die FieldEditorPreferencePage mit einem GridLayout als Basis für die eigene PreferencesPage zunehmen.

public class PluginPreferencesPage extends FieldEditorPreferencePage
   implements IWorkbenchPreferencePage {

   public PreferencesPage() {
      super(GRID);
   }

Nun werden die Eingabeelemente in der createFieldEditors()-Methode erzeugt. Es gibt eine ganze Reihe bereits bestehender FieldEditor, die über die addField-Methode hinzugefügt werden. Über eine eindeutige ID wird der Eintrag im Preferences Store referenziert.

   /* (non-Javadoc)
    * @see org.eclipse.jface.preference.FieldEditorPreferencePage
    			#createFieldEditors()
    */
   @Override
   protected void createFieldEditors() {
      addField(new BooleanFieldEditor(FIELD_BOOLEAN_ID, "Boolean",
            getFieldEditorParent()));
      addField(new ColorFieldEditor(FIELD_COLOR_ID, "Color:",
            getFieldEditorParent()));
      addField(new StringFieldEditor(FIELD_STRING_ID, "String:",
            getFieldEditorParent()));
      addField(new IntegerFieldEditor(FIELD_INTEGER_ID, "Integer:",
            getFieldEditorParent()));
      addField(new DirectoryFieldEditor(FIELD_DIRECTORY_ID, "Directory:",
            getFieldEditorParent()));
      addField(new RadioGroupFieldEditor(FIELD_RADIO_GROUP_ID, "RadioGroup:", 1,
            new String[][] { { "Wahl 1", OPTION_RADIO_GROUP_1},
                  { "Wahl 2", OPTION_RADIO_GROUP_2} }, getFieldEditorParent()));
      addField(new FontFieldEditor(FIELD_FONT_ID, "Font:",
            getFieldEditorParent()));
      addField(new ScaleFieldEditor(FIELD_SCALE_ID, "Scale:",
            getFieldEditorParent(),0,100,1,1));
   }

Zum Schluss müssen wir noch dafür sorgen, dass der Preferences Store der PreferencesPage gesetzt wird. Dies geschieht in der init()-Methode. Unterbleibt dies, wird zwar die Seite mit Inhalt angezeigt, aber der "Apply"-Button bleibt deaktiviert.

   /* (non-Javadoc)
    * @see org.eclipse.ui.IWorkbenchPreferencePage#init(org.eclipse.ui.IWorkbench)
    */
   @Override
   public void init(IWorkbench workbench) {
      setPreferenceStore(Activator.getDefault().getPreferenceStore());
   }

Damit ist die Preferences Page unseres Plugins fertig implementiert und im Preferences Dialog ist der Eintrag "Plugin Preferences" sichtbar:

   <extension
         point="org.eclipse.core.runtime.preferences">
      <initializer
            class="de.sinoz.rcp.preferences.preferences.PluginPreferenceInitializer">
      </initializer>
   </extension>

Die implementierte Klasse benötigt nur eine Methode, in welcher die Defaultwerte gesetzt werden:

public class PluginPreferenceInitializer extends AbstractPreferenceInitializer {

   /* (non-Javadoc)
    * @see org.eclipse.core.runtime.preferences.AbstractPreferenceInitializer
    					#initializeDefaultPreferences()
    */
   @Override
   public void initializeDefaultPreferences() {
      IEclipsePreferences node = new DefaultScope().getNode(Activator.PLUGIN_ID);
      node.putBoolean(PluginPreferencesPage.FIELD_BOOLEAN_ID, true);
      node.put(PluginPreferencesPage.FIELD_COLOR_ID, "190,190,190");
      node.put(PluginPreferencesPage.FIELD_STRING_ID, "A Text");
      node.putInt(PluginPreferencesPage.FIELD_INTEGER_ID, 3);
      node.put(PluginPreferencesPage.FIELD_DIRECTORY_ID, "C:\\");
      node.put(PluginPreferencesPage.FIELD_RADIO_GROUP_ID,
               PluginPreferencesPage.OPTION_RADIO_GROUP_2);
      node.putInt(PluginPreferencesPage.FIELD_SCALE_ID, 25);
   }
}

Wird nun der Preference Dialog das erste Mal gestartet sind die Defaultwerte gesetzt:

      IPreferenceStore preferenceStore = Activator.getDefault().getPreferenceStore();
      preferenceStore.getString(PluginPreferencesPage.FIELD_STRING_ID);

Die Suche nach den verwendeten IDs lässt sich abkürzen, indem sie ausgegeben werden. Im auskommentierten Teil wird zum Beispiel die Wurzeleinträge interiert:

   /* (non-Javadoc)
    * @see org.eclipse.ui.application.WorkbenchAdvisor#postStartup()
    */
   @Override
   public void postStartup() {
      PreferenceManager pm = PlatformUI.getWorkbench().getPreferenceManager();
//       See what we have
//      for (IPreferenceNode node : pm.getRootSubNodes()) {
//         System.out.println(node.getId());
//      }
      pm.remove("de.sinoz.rcp.preferences.preferencespage");
   }