From 53a966fb67bf71d603c770f615cf6ad97c7cf209 Mon Sep 17 00:00:00 2001 From: Stefan Suhren Date: Thu, 7 Jan 2016 00:16:30 +0100 Subject: Update documentation --- .../view/AnsprechpartnerHinzufuegenController.java | 6 ++ .../view/AnsprechpartnerListeController.java | 14 ++-- .../view/KommentarHinzufuegenController.java | 6 ++ .../view/ProjektHinzufuegenController.java | 30 +++++++++ .../view/ProjektthemenverwaltungsController.java | 76 ++++++++++++++++++++++ .../view/StudentenverwaltungsController.java | 26 ++++++++ 6 files changed, 151 insertions(+), 7 deletions(-) (limited to 'src/de/fhswf/in/inf/se/projektthemenvergabe/view') diff --git a/src/de/fhswf/in/inf/se/projektthemenvergabe/view/AnsprechpartnerHinzufuegenController.java b/src/de/fhswf/in/inf/se/projektthemenvergabe/view/AnsprechpartnerHinzufuegenController.java index fa2afd8..6730468 100644 --- a/src/de/fhswf/in/inf/se/projektthemenvergabe/view/AnsprechpartnerHinzufuegenController.java +++ b/src/de/fhswf/in/inf/se/projektthemenvergabe/view/AnsprechpartnerHinzufuegenController.java @@ -12,6 +12,12 @@ import javafx.scene.control.TextField; import javafx.scene.layout.AnchorPane; import javafx.util.Pair; +/** + * The controller for the FXML-View AnsprechpartnerHinzufuegen. + * + * @author Dina-Marie Hanxleden & Stefan Suhren + * @version 1.0 + */ public class AnsprechpartnerHinzufuegenController extends Dialog> { diff --git a/src/de/fhswf/in/inf/se/projektthemenvergabe/view/AnsprechpartnerListeController.java b/src/de/fhswf/in/inf/se/projektthemenvergabe/view/AnsprechpartnerListeController.java index 1c9c8d5..4aee813 100644 --- a/src/de/fhswf/in/inf/se/projektthemenvergabe/view/AnsprechpartnerListeController.java +++ b/src/de/fhswf/in/inf/se/projektthemenvergabe/view/AnsprechpartnerListeController.java @@ -60,7 +60,7 @@ public class AnsprechpartnerListeController private Main main; /** - * TODO Add method comment here + * After the FXML was loaded the controller call the initialize function. * */ @FXML @@ -151,7 +151,7 @@ public class AnsprechpartnerListeController } /** - * TODO Add method comment here + * Set a back reference to the Main. * * @param main */ @@ -167,7 +167,7 @@ public class AnsprechpartnerListeController } /** - * TODO Add method comment here + * Open a TextInputStage to add an new Organization. * */ @FXML @@ -193,7 +193,7 @@ public class AnsprechpartnerListeController } /** - * TODO Add method comment here + * Open a TextInputDialog to edit the Organization. * */ @FXML @@ -221,7 +221,7 @@ public class AnsprechpartnerListeController } /** - * TODO Add method comment here + * Delete the selected Organization. * */ @FXML @@ -262,7 +262,7 @@ public class AnsprechpartnerListeController } /** - * TODO Add method comment here + * Deletes the selected Ansprechpartner. * */ @FXML @@ -279,7 +279,7 @@ public class AnsprechpartnerListeController } /** - * TODO Add method comment here + * Open a Stage to add a new Ansprechpartner. * */ @FXML diff --git a/src/de/fhswf/in/inf/se/projektthemenvergabe/view/KommentarHinzufuegenController.java b/src/de/fhswf/in/inf/se/projektthemenvergabe/view/KommentarHinzufuegenController.java index a88a6af..806fd8b 100644 --- a/src/de/fhswf/in/inf/se/projektthemenvergabe/view/KommentarHinzufuegenController.java +++ b/src/de/fhswf/in/inf/se/projektthemenvergabe/view/KommentarHinzufuegenController.java @@ -10,6 +10,12 @@ import javafx.scene.control.Dialog; import javafx.scene.control.TextArea; import javafx.scene.layout.AnchorPane; +/** + * The controller for the FXML-View Kommentarhinzufuegen. + * + * @author Dina-Marie Hanxleden & Stefan Suhren + * @version 1.0 + */ public class KommentarHinzufuegenController extends Dialog { @FXML diff --git a/src/de/fhswf/in/inf/se/projektthemenvergabe/view/ProjektHinzufuegenController.java b/src/de/fhswf/in/inf/se/projektthemenvergabe/view/ProjektHinzufuegenController.java index 0e21ecd..cd0c673 100644 --- a/src/de/fhswf/in/inf/se/projektthemenvergabe/view/ProjektHinzufuegenController.java +++ b/src/de/fhswf/in/inf/se/projektthemenvergabe/view/ProjektHinzufuegenController.java @@ -11,6 +11,12 @@ import javafx.scene.control.TextArea; import javafx.scene.control.TextField; import javafx.stage.Stage; +/** + * The controller for the FXML-View ProjektHinzufuegen. + * + * @author Dina-Marie Hanxleden & Stefan Suhren + * @version 1.0 + */ public class ProjektHinzufuegenController { @FXML @@ -49,6 +55,13 @@ public class ProjektHinzufuegenController private boolean wasAborted = true; + /** + * + * Set back reference of the Main. + * + * @param main + * @param projekt + */ public void setMain(Main main, Projekt projekt) { this.projekt = projekt; @@ -134,6 +147,12 @@ public class ProjektHinzufuegenController } } + /** + * + * Getter for the projekt. + * + * @return Returns the projekt + */ public Projekt getProjekt() { if (wasAborted) @@ -143,6 +162,12 @@ public class ProjektHinzufuegenController return projekt; } + /** + * + * Set the Text of the Fields from the stage into the TableView and close + * the projekthinzufuegen stage. + * + */ @FXML private void handleSave() { @@ -163,6 +188,11 @@ public class ProjektHinzufuegenController projekthinzufuegenStage.close(); } + /** + * + * Cancel the projekthinzufuegen stage. + * + */ @FXML private void handleCancel() { diff --git a/src/de/fhswf/in/inf/se/projektthemenvergabe/view/ProjektthemenverwaltungsController.java b/src/de/fhswf/in/inf/se/projektthemenvergabe/view/ProjektthemenverwaltungsController.java index 764563b..e3b0b17 100644 --- a/src/de/fhswf/in/inf/se/projektthemenvergabe/view/ProjektthemenverwaltungsController.java +++ b/src/de/fhswf/in/inf/se/projektthemenvergabe/view/ProjektthemenverwaltungsController.java @@ -16,6 +16,12 @@ import javafx.scene.control.TableColumn; import javafx.scene.control.TableView; import javafx.scene.control.cell.ComboBoxTableCell; +/** + * The controller for the FXML-View Projektthemenverwaltung. + * + * @author Dina-Marie Hanxleden & Stefan Suhren + * @version 1.0 + */ public class ProjektthemenverwaltungsController { @FXML @@ -55,6 +61,10 @@ public class ProjektthemenverwaltungsController private FilteredList filterList; + /** + * After the FXML was loaded the controller call the initialize function. + * + */ @FXML private void initialize() { @@ -161,6 +171,12 @@ public class ProjektthemenverwaltungsController .bind(deleteProjektButton.disabledProperty()); } + /** + * + * Set back reference of the Main. + * + * @param main + */ public void setMain(Main main) { this.main = main; @@ -174,12 +190,22 @@ public class ProjektthemenverwaltungsController projektTableView.setItems(sortedList); } + /** + * + * The filter is off. Show all projects. + * + */ @FXML private void handleShowAll() { filterList.setPredicate(null); } + /** + * + * Filter projects according to status "IN_BEARBEITUNG". + * + */ @FXML private void handleShowInBearbeitung() { @@ -187,6 +213,11 @@ public class ProjektthemenverwaltungsController .equals(Projekt.StatusTypes.IN_BEARBEITUNG)); } + /** + * + * Filter projects according to status "EINGEREICHT". + * + */ @FXML private void handleShowEingereicht() { @@ -194,6 +225,11 @@ public class ProjektthemenverwaltungsController .equals(Projekt.StatusTypes.EINGEREICHT)); } + /** + * + * Filter projects according to status "IN_UEBERARBEITUNG". + * + */ @FXML private void handleShowInUeberabeitung() { @@ -201,6 +237,11 @@ public class ProjektthemenverwaltungsController .equals(Projekt.StatusTypes.IN_UEBERARBEITUNG)); } + /** + * + * Filter projects according to status "ANGENOMMEN". + * + */ @FXML private void handleShowAngenommen() { @@ -208,6 +249,11 @@ public class ProjektthemenverwaltungsController .equals(Projekt.StatusTypes.ANGENOMMEN)); } + /** + * + * Filter projects according to status "ABGELEHNT". + * + */ @FXML private void handleShowAbgelehnt() { @@ -215,6 +261,11 @@ public class ProjektthemenverwaltungsController .equals(Projekt.StatusTypes.ABGELEHNT)); } + /** + * + * Open the ProjekthinzufuegenStage to add a new Projekt. + * + */ @FXML private void handleAddProjekt() { @@ -226,6 +277,11 @@ public class ProjektthemenverwaltungsController } } + /** + * + * Open the ProjekthinzufuegenStage to edit a Projekt. + * + */ @FXML private void handleEditProjekt() { @@ -239,6 +295,11 @@ public class ProjektthemenverwaltungsController } } + /** + * + * Delete the selected Projekt. + * + */ @FXML private void handleDeleteProjekt() { @@ -251,18 +312,33 @@ public class ProjektthemenverwaltungsController } } + /** + * + * Open Stage of Studentenverwaltung. + * + */ @FXML private void handleStudentenverwaltung() { main.showStudentenverwaltung(); } + /** + * + * Open Stage of Ansprechpartnerverwaltung. + * + */ @FXML private void handleAnsprechpartnerverwaltungs() { main.showAnsprechpartnerverwaltungsStage(); } + /** + * + * Cancel the Projekttehmenverwaltung stage. + * + */ @FXML private void handleClose() { diff --git a/src/de/fhswf/in/inf/se/projektthemenvergabe/view/StudentenverwaltungsController.java b/src/de/fhswf/in/inf/se/projektthemenvergabe/view/StudentenverwaltungsController.java index b1d5dbf..5950b0a 100644 --- a/src/de/fhswf/in/inf/se/projektthemenvergabe/view/StudentenverwaltungsController.java +++ b/src/de/fhswf/in/inf/se/projektthemenvergabe/view/StudentenverwaltungsController.java @@ -14,6 +14,12 @@ import javafx.scene.control.TextInputDialog; import javafx.scene.control.cell.TextFieldTableCell; import javafx.util.converter.IntegerStringConverter; +/** + * The controller for the FXML-View Studentenverwaltung. + * + * @author Dina-Marie Hanxleden & Stefan Suhren + * @version 1.0 + */ public class StudentenverwaltungsController { @FXML @@ -33,6 +39,10 @@ public class StudentenverwaltungsController private Main main; + /** + * After the FXML was loaded the controller call the initialize function. + * + */ @FXML private void initialize() { @@ -69,12 +79,23 @@ public class StudentenverwaltungsController .getSelectionModel().selectedItemProperty().isNull()); } + /** + * + * Set back reference of the Main. + * + * @param main + */ public void setMain(Main main) { this.main = main; studentTableView.setItems(main.getStudenten()); } + /** + * + * Open the StudenthinzufuegenStage to add a new Student. + * + */ @FXML private void handleAddStudent() { @@ -111,6 +132,11 @@ public class StudentenverwaltungsController } } + /** + * + * Delete the selected Student. + * + */ @FXML private void handleDeleteStudent() { -- cgit v1.2.3-70-g09d2