Gérer les pages de préférences avec Eclipse 4

Les pages de préférences dans Eclipse 4

Si vous avez fait des pages de préférence avec Eclipse 3, vous avez du utiliser le point d’extension org.eclipse.ui.preferencePages qui permet de déclarer hiérarchiquement les pages et de les voir s’afficher dans le dialogue de préférence.

En Eclipse 4 pur, ce point d’extension n’est plus disponible car il fait partie de org.eclipse.ui. et l’implémentation de IPreferenceStore que l’on utilise est également indisponible (la classe ScopedPreferenceStore est dans le package org.eclipse.ui.preferences qui dépend de org.eclipse.ui).

Il faut aussi savoir que le dialogue de préférences est fourni par JFace (PreferenceDialog) et qu’il a besoin d’une instance de PreferenceManager pour s’initialiser.

J’ai donc  développé un plugin pour résoudre tout ça, puisqu’il n’y a pas d’implémentation dans la plate forme.

Le plugin est disponible sur github à cet endroit et sur repository P2 d’OPCoach

Il vous fournit les fonctionnalités suivantes :

• un point d’extension com.opcoach.e4.preferences.e4PreferencePages qui ressemble au point d’extension d’Eclipse 3 mais qui attend une classe qui étend FieldEditorPreferencePage
• un handler qui relit toutes ces extensions et qui affiche le dialogue de preferences. Cet handler est utilisé par un plugin (com.opcoach.e4.preferences.mainmenu) qui   ajoute la commande automatiquement dans une application E4 pure.
• la compatibilité avec les pages Eclipse 3 qui pourraient exister dans l’application (mode compatibilité)
• une mise en relation automatique sur le PreferenceStore du plugin auquel appartient la page
• la recopie de la classe ScopedPreferenceStore venant du package E3 org.eclipse.ui.preferences
• un point d’extension com.opcoach.e4.preferences.e4PreferenceStoreProvider, pour gérer le preference store si la solution proposée par défaut ne vous convient pas

Cette solution vous permet d’écrire vos pages de préférences simplement sans faire dépendre votre plugin de org.eclipse.ui.  L’injection dans les champs de vos pages est également appliquée (si vous en avez besoin).

Pour récupérer vos valeurs de préférence, vous pouvez toujours les injecter avec l’annotation @Preference.

Pour intégrer ce plugin dans votre développement, il faut :

• ajouter la feature e4 preferences dans votre Target Platform (voir le lien sur GitHub) ou le fichier de Target Platform (en fin de ce fichier)
• ajouter une dépendance de votre plugin sur com.opcoach.e4.preferences
• étendre le point d’extension com.opcoach.e4.preferences.e4PreferencePages pour ajouter vos pages
• Si vous êtes en mode Eclipse 4 pur, ajouter, dans le plugin contenant votre modele d’application, la dépendance sur le plugin com.opcoach.e4.preferences.mainmenu qui se chargera d’ajouter la commande pour ouvrir le dialogue de préférences.
• Si vous êtes en mode mixte (couche de compatibilité) il n’y a rien à faire, vos pages E4 et E3 seront affichées ensemble
• éventuellement écrire une extension de com.opcoach.e4.preferences.e4PreferenceStoreProvider extension pour surcharger la gestion par défaut du PreferenceStore

Le projet d’example sur github montre comment l’utiliser. 

N’hésitez pas à commenter ce post si vous avez des remarques.