From 8767b8b498fda20efc7807d4373d8656563c30fb Mon Sep 17 00:00:00 2001 From: Joshua Perry <45966243+jpez-development@users.noreply.github.com> Date: Sun, 5 Feb 2023 21:19:57 +0000 Subject: [PATCH] javadoc created --- .../controllers/ReportController.java | 29 ++++++++++++++----- 1 file changed, 22 insertions(+), 7 deletions(-) diff --git a/src/main/java/com/r0r5chach/controllers/ReportController.java b/src/main/java/com/r0r5chach/controllers/ReportController.java index 029a025..4a713df 100644 --- a/src/main/java/com/r0r5chach/controllers/ReportController.java +++ b/src/main/java/com/r0r5chach/controllers/ReportController.java @@ -11,14 +11,25 @@ import javafx.scene.control.TextArea; /** * Class that defines the controller for the report View of the GUI * Inherits from com.r0r5chach.controllers.Controller + * @author r0r5chach */ public class ReportController extends Controller { + /** + * Attribute that stores the competitor list for the report View + */ @FXML private ListView competitorList; - + /** + * Attribute that stores the output area for the report View + */ @FXML private TextArea outputArea; - + /** + * Method that runs when the program initializes the edit View + * (param details copied from super implementation) + * @param url The location used to resolve relative paths for the root object + * @param rb The resources used to localize the root object + */ @Override public void initialize(URL url, ResourceBundle rb) { Platform.runLater(() -> { @@ -26,8 +37,10 @@ public class ReportController extends Controller { competitorList.setItems(FXCollections.observableList(competitorIds)); }); } - - @FXML + /** + * Outputs the short details of the selected player to the output area + */ + @FXML //Triggers when the short details button is pressed private void shortDetailsPress() { Integer item = competitorList.getSelectionModel().getSelectedItem(); outputArea.clear(); @@ -38,8 +51,10 @@ public class ReportController extends Controller { outputArea.setText("Select A Competitor"); } } - - @FXML + /** + * Outputs the full details of the selected player to the output area + */ + @FXML //Triggers when the full details button is pressed private void fullDetailsPress() { Integer item = competitorList.getSelectionModel().getSelectedItem(); if (item != null) { @@ -50,4 +65,4 @@ public class ReportController extends Controller { outputArea.setText("Select A Competitor"); } } -} +} \ No newline at end of file