- Le fonctionnement théorique
- Le fonctionnement du code
- Le fonctionnement des menus déroulants (MenuItems)
- Le rechargement d'un état sauvegardé
- Les problèmes connus
- Les méthodes
Un point de sauvegarde se crée et vous pouvez ainsi annuler ou récupérer les événements passés lorsque vous effectuez une action:
- Modifier le nom de l'évaluation.
- Ajouter/supprimer/modifier un indicateur.
- Ajouter/supprimer/modifier un processus.
- Modifier le paramètrage d'une agrégation.
Bouton annuler (Undo):
- Annule l'état actuel et recharge l'état précédent (CTRL + Z ou en cliquant sur la flèche retour).
- Annule l'état sélectionné dans le menu déroulant et recharge l'état précédent. Tous les éléments situés entre l'état actuel et l'état sélectionné dans le menu déroulant seront récupérable par ordre d’exécution dans la liste Récupérer.
Bouton récupérer (Redo):
- Récupère l'état qui vient d'être annulé et le recharge (CTRL + Y ou en cliquant sur la flèche avant).
- Récupère l'état sélectionné dans le menu déroulant et le recharge. Tous les éléments situés entre l'état actuel et l'état sélectionné dans le menu déroulant seront de nouveau annulable par ordre d'exécution dans la liste Annuler.
Ces fonctionnalités sont applicables sur les évaluations ouvertes. Retour
La sauvegarde de l'état actuel se fait grâce à la classe Memento. On crée un objet Memento qui prend l'évaluation actuelle en paramètre, ainsi que son état et un ID.
final Evaluation e = GetariApp.get().getCurrentEval().clone();
int newID = history.getMemento().getId() + 1;
Memento m = new Memento(e, Messages.getString("msg", indicator.getName()), newID);
history.addMemento(m);
Chaque action crée un objet Memento et le stock en première position dans une liste observable de la classe History: la liste undo. Chaque ajout vide la deuxième liste (redo) . Cette classe History possède deux liste observable qui géreront les éléments à annuler, et ceux à récupérer.
Lors du clique sur le bouton Annuler, la méthode undo() de la classe History est appelée. Cette méthode transfert le premier élément de la liste undo vers la liste redo et recharge le nouveau premier élément de la liste undo (qui est en fait l'état précédent).
Lors du clique sur le bouton Récupérer, la méthode redo() de la classe History est appelée. Cette méthode transfert le premier élément de la liste redo vers la liste undo en première position et recharge le premier élément de la liste undo.
Lors du clique sur un des éléments du menu déroulant du bouton Annuler, la méthode undoByID(int id) de la classe History est appelée. Cette méthode prend un argument un Integer et cherche dans la liste undo le mémento qui possède cet ID grâce à la méthode findByID(int id). Puis, à partir du premier élément jusqu’à celui possédant l'ID, transfert tous les éléments de la liste undo vers la liste redo par ordre d'exécution. Enfin, recharge le premier élément de la liste undo.
Lors du clique sur un des éléments du menu déroulant du bouton Récupérer, la méthode redoByID(int id) de la classe History est appelée. Cette méthode prend un argument un Integer et cherche dans la liste redo le mémento qui possède cet ID grâce à la méthode findByID(int id). Puis, à partir du premier élément jusqu’à celui possédant l'ID, transfert tous les éléments de la liste redo vers la liste undo par ordre d'exécution. Enfin, recharge le premier élément de la liste undo.
Les listes observables de la classe History ont chacune un EventListener qui se déclenche quand la taille de la liste change. Plusieurs événements se déclenchent.
Quand la taille de la liste undo history augmente mais que la redo history est toujours vide:
- Un MenuItem 'item' se crée en prenant le nom du mémento (son "état").
- Un listener est ajouté sur cet item qui déclenchera la méthode undoByID(int id) si il est cliqué.
- Cet item est ajouté dans une ArrayList nommée 'undoList'.
- Cette liste est ajoutée au bouton undoBtn pour l'affichage du menu déroulant.
Quand la taille de la liste undo history diminue:
- Un MenuItem 'item' se crée en prenant le nom du mémento (son "état").
- Un listener est ajouté sur cet item qui déclenchera la méthode redoByID(int id) si il est cliqué.
- Cet item est ajouté dans une ArrayList nommée 'redoList'.
- Cette liste est ajoutée au bouton redoBtn pour l'affichage du menu déroulant.
- Le premier item de la undoList est supprimé.
Quand la taille de la liste redo history diminue:
- Un MenuItem 'item' se crée en prenant le nom du mémento (son "état").
- Un listener est ajouté sur cet item qui déclenchera la méthode undoByID(int id) si il est cliqué.
- Cet item est ajouté dans la undoList en première position.
- Cette liste est ajoutée au bouton redoBtn pour l'affichage du menu déroulant.
- Le premier item de la redoList est supprimé.
- Si la liste redo history est vide, clear() également la redoList.
Lors de l'utilisation des boutons annuler/récupérer, la méthode reloadGraph() de la classe GraphView est appelée. Cette méthode vide les panneaux, récupère le dernier mémento de la liste undo history. L’évaluation associée à ce mémento est extraite, clonée, puis rechargée.
Lors d'un trop grand nombre d'annulations, récupérations, ajouts/suppressions d'indicateurs, Getari crash.
#1 Exception in thread "JavaFX Application Thread" java.lang.OutOfMemoryError: Required array length too large
#2 Exception in thread "JavaFX Application Thread" java.lang.OutOfMemoryError: Java heap space
Ce problème est certainement dû au clonage de l'évaluation.
L'ajout d'une fonction d'agrégation déclenche bien le point de sauvegarde, mais le rechargement n'annule pas cet ajout.
Incapacité à localiser l'endroit où placer certains points de sauvegarde pour la modification de certains indicateurs (Normalisation, Seuil, Linéaires).
Incapacité à sauvegarder après avoir cliquer sur le bouton "Tout effacer" car ce bouton appelle la méthode clearGraph() de GraphView qui est elle même appelée à chaque rechargement d'un événement passé.
Problème lors de la sauvegarde d'une évaluation. Déroulé du problème:
- Lancement de Getari.
- Lancement d'une évaluation.
- Modification du nom de l'évaluation.
- Enregistrement de l'évaluation.
- Crash.
Exception in thread "JavaFX Application Thread" java.lang.RuntimeException: java.lang.reflect.InvocationTargetExceptionCaused by: java.lang.OutOfMemoryError: Java heap spaceat [email protected]/fr.inrae.agroclim.indicators.model.data.climate.ClimaticResource.clone(ClimaticResource.java:59)
Classe ToolbarController
| Nom | Fonctionnement |
|---|---|
| setHistory(history) | Ajoute un listener sur les listes undo et redo |
| onUndoAction(event) | Déclenche les méthode undo() et reloadCmd.run() |
| onRedoAction(event) | Déclenche les méthode redo() et reloadCmd.run() |
| initialize() | Ajoute le tooltip et le hover sur les boutons |
Classe History
| Nom | Fonctionnement |
|---|---|
| addMemento(memento) | Ajoute un memento dans la liste undoHistory |
| undo() | Transfert le premier élément de la liste undo vers la liste redo |
| redo() | Transfert le premier élément de la liste redo vers la liste undo |
| undoById(int) | Transfert tous les éléments depuis le premier jusqu'au mémento voulu de la liste undo vers la liste redo |
| redoById(int) | Transfert tous les éléments depuis le premier jusqu'au mémento voulu de la liste redo vers la liste undo |
| findById(int) | Retourne le mémento correspondant à l'ID dans la liste undo |
| findRedoById(int) | Retourne le mémento correspondant à l'ID dans la liste redo |
| getUndoMemento() | Retourne le mémento en première position de la liste undo |
| getRedoMemento() | Retourne le mémento en première position de la liste redo |
Classe GraphView
| Nom | Fonctionnement |
|---|---|
| reloadGraph() | Nettoie les panneaux et les rechargent avec l'évaluation voulue. |
| configureUndoRedoButtons(stage) | Ajoute un listener sur le stage pour écouter la combinaison de touche CTRL+Z et CTRL+Y pour undo() et redo(). |