From aec25eb862c7f2446798d10fa44b979167c58a04 Mon Sep 17 00:00:00 2001 From: Matisse DEKEISER <matisse.dekeiser.etu@univ-lille.fr> Date: Fri, 29 Nov 2024 12:56:18 +0100 Subject: [PATCH] Javadoc controllers V1 (pas encore fini) --- .../controller/AddDataController.java | 22 ++++++++--- .../controller/AxesSettingsController.java | 39 ++++++++++++++++--- .../controller/DataStageController.java | 34 ++++++++-------- 3 files changed, 66 insertions(+), 29 deletions(-) diff --git a/src/main/java/fr/univlille/sae/classification/controller/AddDataController.java b/src/main/java/fr/univlille/sae/classification/controller/AddDataController.java index 4d38f1f..014d6d9 100644 --- a/src/main/java/fr/univlille/sae/classification/controller/AddDataController.java +++ b/src/main/java/fr/univlille/sae/classification/controller/AddDataController.java @@ -19,25 +19,36 @@ import java.util.List; import java.util.Map; /** - * Controlleur pour le FXML add-data-stage, pour ajouter une nouvelle donnée + * Contrôleur pour le fichier FXML "add-data-stage", permettant à l'utilisateur + * d'ajouter une nouvelle donnée dans le modèle de classification. */ public class AddDataController { + /** + * Fenêtre associée à cette vue. + */ @FXML private Stage stage; + /** + * Conteneur contenant les champs d'entrée de données. + */ @FXML private VBox entries; /** - * MainStageView associé au controlleur + * MainStageView associée au contrôleur. */ MainStageView mainStageView; + /** + * Liste des composants d'entrée gérés dynamiquement (Spinner, TextField, + * ChoiceBox) selon le type des données. + */ private List<Object> components; /** - * Méthode d'intitialisation du controlleur + * Méthode d'initialisation du contrôleur. */ @FXML public void initialize() { @@ -105,14 +116,14 @@ public class AddDataController { } /** - * Méthode permettante d'attribuer la mainStageView associer à la classe + * Méthode permettant d'attribuer la mainStageView associée à la classe. * @param mainStageView mainStageView à attribuer */ public void setMainStageView(MainStageView mainStageView) { this.mainStageView = mainStageView; } /** - * Validation des données à ajouter + * Validation des données à ajouter. */ public void validate() { System.out.println("validé"); @@ -141,5 +152,4 @@ public class AddDataController { } stage.close(); } - } diff --git a/src/main/java/fr/univlille/sae/classification/controller/AxesSettingsController.java b/src/main/java/fr/univlille/sae/classification/controller/AxesSettingsController.java index b355ba3..508057c 100644 --- a/src/main/java/fr/univlille/sae/classification/controller/AxesSettingsController.java +++ b/src/main/java/fr/univlille/sae/classification/controller/AxesSettingsController.java @@ -10,18 +10,27 @@ import javafx.scene.control.SpinnerValueFactory; import javafx.stage.Stage; /** - * Controlleur pour le FXML axes-settings-stage, pour gérer les axes de la vue + * Contrôleur pour le fichier FXML "axes-settings-stage", pour gérer les axes de la vue. */ public class AxesSettingsController{ + /** + * Fenêtre associée à cette vue. + */ @FXML Stage stage; + /** + * Choix des données en axes (abscisse et ordonnée). + */ @FXML ChoiceBox selectOrd; @FXML ChoiceBox selectAbs; + /** + * Choix des limites inférieures et supérieures des axes. + */ @FXML Spinner OrdSizeLower; @@ -36,12 +45,12 @@ public class AxesSettingsController{ /** - * DataVisualizationView associé au controlleur + * DataVisualizationView associé au contrôleur. */ DataVisualizationView dataVisualizationView; /** - * Ajout des éléments à sélectionner pour les ordonnées de la grille + * Ajout des éléments à sélectionner pour les ordonnées de la grille. * @param fields Éléments à ajouter */ public void setSelectOrd(String[] fields){ @@ -51,7 +60,7 @@ public class AxesSettingsController{ } /** - * Ajout des éléments à sélectionner pout les abscisses de la grille + * Ajout des éléments à sélectionner pour les abscisses de la grille. * @param fields Éléments à ajouter */ public void setSelectAbs(String[] fields){ @@ -60,18 +69,34 @@ public class AxesSettingsController{ selectAbs.setValue(dataVisualizationView.getActualX()); } + /** + * Configure la limite supérieure de l'axe des ordonnées. + * @param value Valeur initiale à définir pour la limite supérieure. + */ public void setOrdSizeUpper(double value){ OrdSizeUpper.setValueFactory(new SpinnerValueFactory.DoubleSpinnerValueFactory(0.0, 9999, value,1)); } + /** + * Configure la limite inférieure de l'axe des ordonnées. + * @param value Valeur initiale à définir pour la limite inférieure. + */ public void setOrdSizeLower(double value){ OrdSizeLower.setValueFactory(new SpinnerValueFactory.DoubleSpinnerValueFactory(0.0, 9999, value,1)); } + /** + * Configure la limite supérieure de l'axe des abscisses. + * @param value Valeur initiale à définir pour la limite supérieure. + */ public void setAbsSizeUpper(double value){ AbsSizeUpper.setValueFactory(new SpinnerValueFactory.DoubleSpinnerValueFactory(0.0, 9999, value,1)); } + /** + * Configure la limite inférieure de l'axe des abscisses. + * @param value Valeur initiale à définir pour la limite inférieure. + */ public void setAbsSizeLower(double value){ AbsSizeLower.setValueFactory(new SpinnerValueFactory.DoubleSpinnerValueFactory(0.0, 9999, value,1)); } @@ -85,7 +110,7 @@ public class AxesSettingsController{ } /** - * Validation des paramètres des axes + * Validation des paramètres des axes. */ public void validate(){ if(dataVisualizationView.getActualX() != null || dataVisualizationView.getActualY() != null){ @@ -128,6 +153,10 @@ public class AxesSettingsController{ stage.close(); } + /** + * Réinitialise les paramètres des axes en activant l'ajustement + * automatique et recharge la visualisation des données. + */ public void reset(){ ((NumberAxis) dataVisualizationView.getScatterChart().getXAxis()).setAutoRanging(true); ((NumberAxis) dataVisualizationView.getScatterChart().getYAxis()).setAutoRanging(true); diff --git a/src/main/java/fr/univlille/sae/classification/controller/DataStageController.java b/src/main/java/fr/univlille/sae/classification/controller/DataStageController.java index edc1926..49f0c70 100644 --- a/src/main/java/fr/univlille/sae/classification/controller/DataStageController.java +++ b/src/main/java/fr/univlille/sae/classification/controller/DataStageController.java @@ -13,45 +13,43 @@ import javafx.stage.Stage; import java.io.IOException; /** - * Controlleur pour le FXML data-view-stage, pour gérer la vue supplémentaire + * Contrôleur pour le fichier FXML "data-view-stage", pour gérer la vue supplémentaire. */ public class DataStageController extends DataVisualizationController{ + /** + * Fenêtre associée à cette vue. + */ @FXML Stage stage; - - - + /** + * Composant ListView pour l'affichage des informations des données d'un point. + */ @FXML ListView PointInfo; - - - + /** + * Initialise le contrôleur en configurant le zoom et le déplacement de la vue. + */ public void initialize() { setupZoom(); setupDrag(); } - - /** - * Associe la dataStageView associer à la classe - * @param dataStageView + * Associe la dataStageView associée à la classe. + * @param dataStageView Instance de dataStageView à associer. */ public void setDataStageView (DataStageView dataStageView) { this.view = dataStageView; } - - - - - + /** + * Retourne l'instance de PointInfo. + * @return Instance de PointInfo. + */ public ListView getPointInfo(){ return this.PointInfo; }; - - } -- GitLab