Un article de azerr    Pas de commentaires

A l’étape du billet précédant [step17] nous avons réglé le problème de la selection d’un EditPart GEF. Si vous mettez un point d’arrêt dans la méthode GraphicalEditor#selectionChanged(IWorkbenchPart part, ISelection selection), puis si vous sélectionnez un state, action de la page GEF Graphics vous pourrez constater que cette méthode est appelée :

Mais la méthode updateActions n’est jamais appelé. Nous expliquerons dans ce billet comment régler ce problème pour pouvoir ensuite implémenter les fonctionnalités de suppression :

• suppression des states/actions sélectionnés.
• suppression des connections sélectionnées.

La supppression pourra s’effectuer via :

• l’entrée de menu « Delete » accessible par le menu contextuel de la page GEF Graphics.
• la touche « Suppr ».
• l’entrée de menu « Delete » accessible par le menu global « Edit ».

Voici une copie d’écran qui affiche le menu contextuel qui permettra de supprimer un state sélectionné :

Vous pouvez télécharger le projet org.example.workflow_step18.zip présenté dans ce billet.

GEF Actions

Dans la page GEF, nous avons vu que notre modèle EMF est modifié via des Command GEF générée par nos EditPolicy installées qui réagissent à l’outil sélectionné dans la palette GEF. Une autre manière est de générer des Command GEF via des actions GEF. Ces actions GEF étendent toutes la classe org.eclipse.jface.action.Action qui sont beaucoup utilisés dans l’IDE Eclipse dans les menu (lorsque l’on clique sur un item d’un menu (ex : Copy), l’item du menu est associé à une Action JFace. La classe de base d’un editor GEF org.eclipse.gef.ui.parts.GraphicalEditor installe dans la méthode GraphicalEditor#createActions() par défaut 3 grands types d’actions GEF:

• les action de selection qui étendent org.eclipse.gef.ui.actions.SelectAction. Ce type d’action génère des Command GEF lorsque le Viewer de GraphicalEditor (GraphicalViewer) est sélectionné, comme l’action de delete.
• les action de stack qui éténdent org.eclipse.gef.ui.actions.StackAction. qui permmettent de gérer le undo, redo…
• les action de properties comme le save (je n’ai pas encore bien compris a quoi sert cette action).

DeleteAction

L’action qui nous intéresse dans notre cas est l’action de selection delete org.eclipse.gef.ui.actions.DeleteAction. Cette action réagit à la selection d’un EditPart et génère une Commande GEF de delete dans le cas ou l’EditPart sélectionné à un EditPolicy qui rèagit à sa suppression (ex : dans notre cas nous installerons un EditPolicy sur les EditPart StateTypePart, ActionTypePart et ConnectionPart pour pouvoir les supprimer.

Lorsqu’un EditPart GEF est sélectionné, une commande GEF DeleteCommand doit être instancié. Ceci est du à la méthode DeleteAction#calculateEnabled() :

Cette méthode est appelée pour vérifier si l’action « Delete » doit être activée ou non. Lorsqu’un EditPart GEF action/state est sélectionné, une commande GEF DeleteCommand devra être instanciée et l’action « Delete » sera activée. L’exéction de la commande GEF DeleteCommand s’effectuera lorsque l’action DeleteAction sera lancée via sa méthode DeleteAction#run() :

GraphicalWorkflowEditor#selectionChanged

Lorsqu’un EditPart GEF est sélectionné, la méthode DeleteAction#calculateEnabled() doit être appelé pour activer/désactiver l’action de delete en fonction de l’EditPart GEF selectionné. Cette méthode est appelé lorsqu’il y a une selection dans le viewer GEF par la méthode GraphicalEditor#updateActions(List actionIds). Le code qui permet de rafraîchir les actions de selection lors d’une selection dans le viewer de l’editor GEF se trouve dans la classe GEF GraphicalEditor :

Cette méthode implémente l’interface org.eclipse.ui.ISelectionListener qui est appelé (théoriquement) lorsque il y a une selection effectuée sur n’importe quel éditeur du workbench Eclipse. GraphicalEditor joue le rôle d’un listener de selection en s’enregistrant dans le service de selection dans sa méthode init :

Le test dans la méthode GraphicalEditor#selectionChanged :

if (this.equals(getSite().getPage().getActiveEditor()))

permet de tester si la sélection effectuée dans l’IDE Eclipse, concerne bien l’editor GEF en question. Dans un contexte ou l’editor GEF n’est pas inclus dans un multi page editor, ce code fonctionne très bien, mais qu’il l’est ce code ne sera jamais éxécuté car :

getSite().getPage().getActiveEditor()

retourne le multi page editor (dans notre cas WorkflowEditor) et pas l’editor GEF qui est inclu dans une page du multi page editor (dans notre cas GraphicalWorkflowEditor). Pour régler ce problème il faut tester si la page courante sélectionnée est bien notre editor GEF. Pour connaître la page active d’un editor, la classe de base org.eclipse.ui.part.MultiPageEditorPart (dont hérite notre multi page editor) fournit la méthode MultiPageEditorPart#getActiveEditor() mais qui est (pour je ne sais quelle raison) en protected. Pour pouvoir y accéder dans notre classe GraphicalWorkflowEditor, nous définissons une nouvelle méthode public WorkflowEditor#getActivePageEditor() comme suit :

Ici nous avons défini une nouvelle méthode (au lieu de surcharger la méthode MultiPageEditorPart#getActiveEditor() protected pour la rendre public) car dans la javdoc il y a :

Subclasses should not override this method.

Nous pouvons ensuite surcharger la méthode GraphicalEditor#selectionChanged(IWorkbenchPart part, ISelection selection) dans la classe GraphicalWorkflowEditor comme suit :

Mettez un point d’arrêt au debut de notre nouvelle méthode GraphicalWorkflowEditor#selectionChanged(IWorkbenchPart part, ISelection selection) et relancez le plugin. Si vous sélectionnez un state dans la page GEF, le point d’arrêt s’arrête.

Delete ActionType-StateType

Pour supprimer un state ou une action du workflow, nous allons créer une Commande GEF org.example.workflow.presentation.graphical.commands.DeleteCommand comme suit :

Cette commande GEF de delete doit être ensuite appelé via un EditPolicy qui doit étendre org.eclipse.gef.editpolicies.ComponentEditPolicy. En effet d’après la javadoc :

By default, ComponentEditPolicy understands being DELETEd from its container….

Notre command GEF DeleteCommand doit être initialisée dans la méthode ComponentEditPolicy#createDeleteCommand(GroupRequest deleteRequest) que nous allons implémenter. Créez la classe org.example.workflow.presentation.graphical.policies.WorkflowComponentEditPolicy comme suit :

Installez l’EditiPolicy WorkflowComponentEditPolicy dans l’EditPart Installez org.example.workflow.presentation.graphical.parts.ConnectableNodePart dans la méthode ConnectableNodePart#createEditPolicies() comme suit :

Executer Commande delete

L’exéction de la commande GEF DeleteCommand s’effectuera lorsque l’action DeleteAction sera lancée via sa méthode DeleteAction#run() :

Il nous reste donc à lancer DeleteAction#run() qui peut s’effectuer de plusieurs manières, autrement dit pouvoir supprimer un state, une action sélectionné :

• par le menu contextuel accéssible dans l’editor GEF Graphics qui propose une entrée de menu « Delete ».
• par la touche « Suppr ».
• par le menu globale accéssible dans la barre de menu standard « Edit » l’entrée de menu « Delete ».

Delete – Menu contextuel

Dans cette section nous allons associer un menu contextuel à la page GEF Graphics et nous y ajouterons une entrée « Delete ». Nous avons vu que l’action de delete GEF DeleteAction est ajouté par défaut au registry d’actions de l’editor GraphicalEditor. Pour ajouter un menu contextuel à une editor GEF, il est conseillé d’implémenter la classe abstraite GEF org.eclipse.gef.ContextMenuProvider.

Créez la classe org.example.workflow.presentation.graphical.actions.WorkflowContextMenuProvider comme suit :

Cette classe éténd org.eclipse.gef.ContextMenuProvider et attend dans son constructeur un registry d’actions (qui sera celui de l’editor GraphicalEditor). La méthode WorkflowContextMenuProvider#buildContextMenu(IMenuManager menu) :

1. appelle GEFActionConstants.addStandardActionGroups(menu); qui ajoute les groupes de menu standards (EDIT, UNDO, COPY…).
2. ajoute l’entrée de menu « Delete » dans le groupe EDIT si l’action « Delete » peut être opérationnel (si une action/state est sélectionné).

Dans les examples GEF, ils utilisent IWorkbenchActionConstants.DELETE pour rechercher l’action de delete, mais cette constante est deprecated, il faut utiliser ActionFactory.DELETE.getId() à la place.

Pour indiquer à notre editor GEF que nous souhaitons utiliser notre menu contextuel WorkflowContextMenuProvider, modifiez la méthode GraphicalWorkflowEditor#configureGraphicalViewer() comme suit :

Relancez le plugin, sélectionnez une action/state et ouvrez le menu contextuel (clic droit de le souris), le menu contextuel doit s’afficher avec une entré de menu « Delete » :

Si vous sélectionnez cette action « Delete », l’action/state selectionné sera ensuite supprimé.

Delete – Touche Suppr

Nous souhaitons executer l’action DeleteAction via la touche « Suppr ». Pour effectuer ceci, il suffit de mapper l’action DeleteAction (identifié par ActionFactory.DELETE.getId()) avec la touche « Suppr » (identifié par SWT.DEL). Définissez la variable de type org.eclipse.gef.KeyHandler dans GraphicalWorkflowEditor qui contiendra notre mapping :

private KeyHandler sharedKeyHandler;

Initialisez le mapping en ajoutant la méthode GraphicalWorkflowEditor#getCommonKeyHandler() :

Pour utilisez notre mapping, ajoutez a la fin de la méthode GraphicalWorkflowEditor#configureGraphicalViewer() le code suivant :

Relancez le plugin, sélectionnez une action/state puis appuyez sur la touche « Suppr » pour le supprimer.

Delete – Menu globale

Nous souhaitons maintenant mapper l’action GEF DeleteActionAction via l’entrée de menu « Delete » du menu globale standard « Edit ». Un EditorPart influe sur les actions disponibles dans la barre de menu en étendant généralement la classe org.eclipse.ui.part.EditorActionBarContributor. Cette barre de menu personnalisée pour l’editor est souvent associée « déclarativement » dans le fichier plugin.xml à l’aide de l’attribut contributorClass. Par exemple dans notre editor de workflow nous avons une entré de menu « Workflow Editor » dans la barre de menu globale qui est disponible lorsque l’editor de workflow est activé. Ce menu est gérée par la classe org.example.workflow.presentation.WorkflowActionBarContributor et est déclaré comme ceci dans le fichier plugin.xml :

GEF fournit la classe abstraite org.eclipse.gef.ui.actions.ActionBarContributor qui éténd org.eclipse.ui.part.EditorActionBarContributor et qui est conseillé d’utiliser pour des actions GEF associées à un editor GEF. Créez la classe org.example.workflow.presentation.graphical.actions.GraphicalWorkkflowActionBarContributor comme suit :

Le code addRetargetAction(new DeleteRetargetAction()); dans la méthode buildActions, mappe l’action de « Delete » du workbench avec l’action DeleteAction GEF.

Maintenant nous devons associer cette barre personnalisée d’actions lorsque la page GEF Graphics est activée. Les exemples GEF renseigne cette barre d’actions déclarativement via l’attribut contributorClass de l’élement XML editor du fichier plugin.xml. Dans notre cas nous ne pouvons pas faire comme ceci car nous sommes dans un contexte de multi page, ce qui signifie que les barre d’actions doivent se rafrîchir aussi en fonction de la page sélectionnée (et pas seulement au niveau de l’editor).

Pour gérer ceci nous allons suivre les explication de la section Completing Menus and Toolbars de l’article GMF ou l’idée générale est de modifier le code EMF pour pouvoir utiliser un org.eclipse.ui.part.MultiPageEditorActionBarContributor qui permet de gérer des barres d’actions selon la page activée dans un editor multi page. Actuellement, l’editor est associé à la barre d’actions org.example.workflow.presentation.WorkflowActionBarContributor qui éténd org.eclipse.emf.edit.ui.action.EditingDomainActionBarContributor

Nous allons créer la classe WorkflowMultipageActionBarContributor (comme TopicmapMultipageActionBarContributor) qui va éténdre org.eclipse.emf.edit.ui.action.EditingDomainActionBarContributor et gérer les barres d’actions de EMF et celle de GEF en fonction de la page activée.

Copiez collez la classe de l’article SubActionBarsExt dans le package org.example.workflow.presentation.

Créez la classe org.example.workflow.presentation.WorkflowMultipageActionBarContributor comme suit :

Modifiez le fichier plugin.xml pour utiliser dans notre editor WorkflowEditor, le contribution de barres d’actions WorkflowMultipageActionBarContributor au lieu de WorkflowActionBarContributor :

Si vous relancez le plugin vous aurrez une erreur de ClassCastException sur WorkflowMultipageActionBarContributor :

Pour eviter cette erreur, modifiez la méthode WorkflowEditor#getActionBarContributor() pour récupérer de notre MultipageActionBarContributor la contribution de barres d’action concernant l’editor SelectionEditPart :

Relancez le plugin (vous n’aurrez plus d’erreur de ClassCastException), selectionnez une action/state et accéder au menu global Edit/Delete :

Cette entrée de menu est active lorsque un state/action est sélectionné. Si vous cliquez sur cette entrée de menu, le state/action sélectionné se supprime du workflow.

Si vous accédez à la page Selection et que vous tentez d’ouvrir le menu contextuel, celui-ci ne s’ouvre pas, pour remédier à ce problème, modifiez la méthode AbstractWorkflowEditorPart#menuAboutToShow(IMenuManager manager) de la classe org.example.workflow.presentation.parts.AbstractWorkflowEditorPart comme ceci :

Relancez le plugin, le menu contentuel dans la page Selection doit être à nouveau opérationnel :

Delete ConnectionType

Pour supprimer une connection nous allons créer une Commande GEF org.example.workflow.presentation.graphical.commands.DeleteConnectionCommand comme suit :

Cette commande GEF de delete de connections doit être ensuite appelé via un EditPolicy qui doit étendre org.eclipse.gef.editpolicies.ConnectionEditPolicy. En effet d’après la javadoc :

A model-based EditPolicy for connections… By default, ConnectionEditPolicy understands only DELETE.

Notre command GEF DeleteConnectionCommand doit être initialisée dans la méthode ConnectionEditPolicy#getDeleteCommand(GroupRequest deleteRequest) que nous allons implémenter. Créez la classe org.example.workflow.presentation.graphical.policies.WorkflowConnectionEditPolicy comme suit :

Installez l’EditiPolicy WorkflowConnectionEditPolicy dans l’EditPart org.example.workflow.presentation.graphical.parts.ConnectionPart dans la méthode ConnectionPart#createEditPolicies() comme suit :

Relancez le plugin, sélectionnez une connection de la page GEF et supprimez la à l’aide du menu contextuel « Delete », à l’aide de la touche « Suppr » ou via le menu global « Edit/Delete ».