Praesentation/praesentation.md

@@ -46,13 +46,15 @@
 * Besondere (für uns) Lösungen
 
 ### Zahlen, Daten, Fakten
-* Zeilen insgesamt: 4120
-  * Code: 1596
+* Zeilen insgesamt: 3056
+  * Code: 1619 (53%)
   * XML: 110
-  * Kommentare:
-  * Leerzeilen:
-  * Commits: 373
-  * Merge Requests: 113
+  * Kommentare: 1076 (35%)
+  * Leerzeilen: 365 (12%)
+  * Commits: 461
+  * Merge Requests: 146
+  * Tickets: 29
+  * Pipelines 471
 
 ## Klassendiagram
 ![Ablaufdiagram Enigma](http://plantuml.gitrepo.de/png/U9oTM4jpspOGlkjNyDPaNFhGeoVJIU97aedbU2GrpiJrU21gHI820HO0uzHfyjkx8CK7G81Yh8D4xRTOBFODlbIQI5tcR3RJL3E8xk_d7yxEBtzJqIaZIaLdbAIIvFVtV_FPB8euoK4L986eaE8BxFGnS9hc9FgEO1_EnGROdXf5IINBNd9SiHoVulUwJBAMrtpYI9CqEeaernRrWR17u8oaK8EtTnOiAK-L1iPAddeP44nsNq6kAT_KF4b6vEtTxLt3qsC_YXhTdZsto5lGIRP29PHACbRY3p27HOkbDjeuv1GqhXiIRzfp3R55xr13T6cVwDdp5kvn_epKSEFO48F2AtGWt6NmwFrZDidd52H8n-Sxu3oLPL4OxzRsit1EaapI9DD-M1KIVTMvP1fNhKj090R7ve58ey_R_QE59qtmdhInuWPGTL37RqbDdaI5lDWIdi9LS_W0pa4kdQFvmdOacYhSSJbm7rFjzZ1ovHwumZw2t9QGhj68husUcgm7Ggfp40q7ZeA1_xuDbY4MifN9bt713FIZ1lKPS3NmIm7A_3fCA0AsK5bgBK7hQo7TdIHWTZGXus0A-2ReJZLoCiGUOJ6iAXMzKyU7rdwv5efgAjppT1oEu-Bw77vTusW3lf3jqJqrC6vT_5uKMmUY7DKZZ2gps6izr8ZmZSZR0FgbkdC16GFPBpeeyEAlgzFLkmzNzzUByujtdto50BdcvylbgpVdOqneo4myd4if97PD9ko38smAn07Yf5EKV2T9cLlLioi41gwBd2_kFEYKFHjdE1MxxiTeZIfwVCssYiZANCqV9xws33SJ4baMpREbTI29_CLo8o43RtKoZRIH7-YYlkHfUxCllxs82c-aHZOQ4VS8OtaRgWU3IZp5pNCXbKbUry-6D2S5EcabmJozgCF_ztqQ_6djtqeP-8nZPz5jxgx40SuMNebXmjUQeOD6eA7yALPe_UTac1jpKsHr3dTCYjgH4hkBxZL3_n0Y94qf9soSxoWAnfO_LweemPvSgp4S1mxX9Qn1rgsmp-MV2yPx_nH3Ll7is92m8aD1WU7DkGsOIT--OfIIg-0bevNfLBM7VLuD5XxLHV1NHhq_WkLhM8R2DI2CZ5yTlBDQRwmV8Ds4r_DSzzrT_ZO4_KiKZD__6gxZCvm6-9hmtV8VHZKuMOUQUkzXfYfn3edsAkFTyLLHz8H_noZKDFbXpfpWK68yRdvdtGvfWiGt9JqLN4l1S7ZeWLNdTiAWbNaKvOJsNO8ECLTjYu97EtDc0kpZN5iNXbPaTOjR2A5zO1mnGJONd-QNUtJ43DQ1UWQ9wvolRhPBtuGSZmyPFzi1pWfWT5H6jzjJAXDcqrS4etD1ogs7MZfcC1LpWzKcsMceE2oCGMbAARU9m_4zZdBWfKK8ZKLxUyoH_xNcA_YcNSX7ypRhsDkguzxW7hXnnRrUFfaSKi1xh-ZcSM_xGDz9i43dieEI7oYM1KF-Y8Fxsd5n_kzAf2d3gg-ruCh2C2nJ7AHKFIsNuDdtHiYT4mRxsM0X8AVetfNuJ3Bcup3qbMZuaEDGNimnOttrmSfbixxgLxM86rWha5zf0lN2y8NzA39A0MKEKWdpQVBYlxWiukWB-Kgstuv9KJ2Q4EDOKyUQv-5QK-JsIprIX_nsDV2lH9d3XSwx714FbZbl-4wyRyw6WeEDOSeMlNRnT9NVTkzzikwzppXhKDYYTyUHJnUpx5-drFhfWkf9wcG_oHmAY36RrrR4qUhfbculinWS-yUGi9OrAAoxlfn4UL2fZii8wXBOcAJz4rIYUeNWKy7aoEmbDXFpDlr_rhUkvW00 "Ablaufdiagram der Enigma")
@@ -85,12 +87,6 @@
 * Dann String (Warum)
 * Vorteile Enum (Warum)
 
-## Die GUI der Enigma (Elemente, etc)
-* Besondere GUI Elemente
-* ControlsFX (ProgressDialog)
-
-## GUI Controller
-
 ## Enigma Demo
 * Kenngruppe Abfrage
   * Testen Kenngruppe Dialog und Fehler
@@ -105,3 +101,7 @@
   * Setzen von Walzen und Ringen
   * Setzen von gleichen Walzen und Fehler
   * Senden & Empfangen
+
+## GUI Controller
+
+![Screenshot](Screenshot.JPG "Screenshot der Enigma")
\ No newline at end of file

README.md

@@ -17,3 +17,5 @@ Ebenfalls wichtig ist eure Kenngruppe. Dies hat früher den Personenkreis bezeic
 Wenn ihr also auf mehreren Clients die selbe Kenngruppe nutzt, dann könnt ihr untereinander eure Nachrichten lesen.\
 \
 Im [Wiki](https://www.gitrepo.de/alfatrainingkurse/java/enigma/wikis/home) findet ihr auch noch einige Informationen zu dem Projekt.
+
+![Screenshot](Praesentation/Screenshot.JPG "Screenshot der Enigma")
\ No newline at end of file

src/main/java/projekt/enigma/App.java

@@ -64,11 +64,10 @@ public class App extends Application {
 
         Label lblEingbae = new Label("Bitte Kenngruppe eingeben!");
         TextField tfEingabe = new TextField();
-        tfEingabe.setText("Enigma");
         Button btnKenngruppe = new Button("Kenngruppe setzen!");
         VBox layout = new VBox();
-        layout.setSpacing(30);
-        layout.setPadding(new Insets(30, 30, 30, 30));
+        layout.setSpacing(10);
+        layout.setPadding(new Insets(20, 30, 10, 30));
         btnKenngruppe.setMaxWidth(Double.MAX_VALUE);
 
         // baut die Scene fuer die Kenngruppenabfrage auf

src/main/java/projekt/enigma/model/Codierer.java

@@ -283,14 +283,13 @@ public class Codierer {
      *
      * @param port       : int : Kabel Nummer, welches am Steckbrett eingesteckt wird.
      * @param verbindung : String : Verbindung, welche die vertauschten Buchstaben angibt.
-     * @return boolean : Wenn true, darf das Kabel gesteckt werden, wenn false, steckt da bereits schon eines.
      */
-    public boolean setzeSteckbrett(int port, String verbindung) {
+    public void setzeSteckbrett(int port, String verbindung) {
         if (verbindung.equals("")) {
             verbindung = "  ";
         }
 
-        return this.hardware.getSteckbrett().setzeVertauschung(port, verbindung.charAt(0), verbindung.charAt(1));
+        this.hardware.getSteckbrett().setzeVertauschung(port, verbindung.charAt(0), verbindung.charAt(1));
     }
     //endregion
 

src/main/java/projekt/enigma/model/Walze.java

@@ -113,7 +113,7 @@ public class Walze {
 	 * @return char : decodierter Buchstabe.
 	 */
 	char codiere2(char buchstabe) {
-		return this.alphabet.charAt((this.fetchWalze().indexOf(buchstabe) - this.turns + 260) % 26);
+		return this.alphabet.charAt((this.fetchWalze().indexOf(buchstabe) - this.turns + 520) % 26);
 	}
 
 	/**
@@ -131,7 +131,6 @@ public class Walze {
 	 *
 	 * @param walzenNr : int : Walzennummer.
 	 */
-	//TODO: Überprüfung notwendig? Wo findet Überprüfung statt?
 	private void setWalzenNr(int walzenNr) {
 		if ((walzenNr > 0) && (walzenNr < 6)) {
 			this.walzenNr = walzenNr - 1;

src/main/java/projekt/enigma/view/ChkBoxGridPane.java

@@ -10,22 +10,40 @@ import projekt.enigma.model.Codierer;
 import java.util.Arrays;
 
 /**
- * TODO: Doku
+ * Die Klasse ChkBoxGripPane erweitert das GridPane Objekt.
+ * Wir erstellen ein GridPane in welches Checkboxen gelegt werden.
+ * Die Anzahl der Checkboxen wird durch die verfuegbarenBuchstaben festgelegt.
+ * Für jeden Buchstaben in diesem char Array, wird eine Checkbox erstellt und auf das Gridpane gelegt.
  */
 public class ChkBoxGridPane extends GridPane {
+
+    // Der globale Checkbox Array
     private CheckBox[] checkbox;
+    // Die Buchstaben die für das jeweilige Pane selectiert werden sollen
     private String checkedBuchstaben;
+    // Die Anzahl der möglichen Checkboxen
     private int charSize;
+    // Das Codierer Objekt. Dieses wird benötigt um auf die Funktionen für das Steckbrett zuzugreifen
     private Codierer codierer;
+    // Der Steckbrett Port für welchen das Pane und die Checkboxen erstellt werden sollen
     private int port;
+    // Die verfügbaren Buchstaben für den jeweiligen Port
     private char[] verfuegbareBuchstaben;
+    // Das Button Objekt des Ports über den dieses Pane gesteuert wird
     private ToggleButton tBtnPort;
 
     /**
-     * TODO: Doku
+     * Hier werfen wir die Checkboxen auf das Gridpane und weißen ihnen die Propertys zu.
+     * Außerdem wird hier auch der Listener generiert womit wir prüfen ob die maximale Auswahlmöglichkeit
+     * erreicht ist.
+     * Es können maximal zwei Checkboxen ausgewählt werden. Wenn zwei erreicht sind, werden die restlichen Checkboxen
+     * deaktiviert. Wenn nur noch eine oder keine Box ausgewählt ist, werden die restlichen wieder aktiviert.
+     * Bei null und zwei Boxen, werden die Buchstaben in das Steckbrett geschrieben.
+     * Andere Auswahlmöglchkeiten stehen nicht zur Verfügung, da ein Kabel nur zwei Enden hat in der Regel.
      *
-     * @param codierer : Codierer
+     * @param codierer : Codierer Objekt
      * @param port     : int
+     * @param tBtnPort : ToogleButton
      */
     public ChkBoxGridPane(Codierer codierer, int port, ToggleButton tBtnPort) {
         this.codierer = codierer;
@@ -48,8 +66,7 @@ public class ChkBoxGridPane extends GridPane {
 
         this.setAlignment(Pos.CENTER);
 
-        System.out.println("----->>>>>" + String.valueOf(this.verfuegbareBuchstaben));
-
+        // Für jeden verfügbaren Buchstaben einen Durchlauf
         for (int i = 0; i < this.verfuegbareBuchstaben.length; i++) {
             if (this.verfuegbareBuchstaben[i] != 20 && this.verfuegbareBuchstaben[i] != ' ') {
                 checkbox[i] = new CheckBox(this.verfuegbareBuchstaben[i] + "");
@@ -66,15 +83,18 @@ public class ChkBoxGridPane extends GridPane {
                     checkbox[i].setDisable(false);
                 }
 
+                // Der Listener für die jeweilige Checkbox
                 checkbox[i].selectedProperty().addListener((observable, oldValue, newValue) -> {
                     String portSelection = "";
                     int zaehler = 0;
 
+                    // Die selektierten Chechkboxen zählen
                     for (CheckBox cb : checkbox) {
                         if (cb != null && cb.isSelected()) {
                             zaehler++;
                         }
                     }
+                    // Wenn nur eine oder keine Checkbox ausgewählt ist
                     if (zaehler == 1 || zaehler == 0) {
                         for (CheckBox cb : checkbox) {
                             if (cb != null && cb.isDisabled()) {
@@ -82,10 +102,14 @@ public class ChkBoxGridPane extends GridPane {
                             }
                         }
                     }
+                    // Es ist keine Checkbox ausgewählt
                     if (zaehler == 0) {
+                        // Daten ins Steckbrett schreiben
                         this.codierer.setzeSteckbrett(this.port, "");
+                        // Und den Button neu beschreiben
                         tBtnPort.setText(portSelection);
                     }
+                    // Das Maximum an selektierten Checkboxen (2) ist erreicht
                     if (zaehler == 2) {
                         for (CheckBox cb : checkbox) {
                             if (cb != null && !cb.isSelected()) {
@@ -96,40 +120,28 @@ public class ChkBoxGridPane extends GridPane {
                                 }
                             }
                         }
+                        // Daten ins Steckbrett schreiben
                         this.codierer.setzeSteckbrett(this.port, "");
                         this.codierer.setzeSteckbrett(this.port, portSelection);
+                        // Und den Button neu beschreiben
                         tBtnPort.setText(portSelection);
                     }
                 });
 
+                // Eine neue Row im Gridpane anlegen für den nächsten Button
                 this.addRow(i + 1);
                 this.add(checkbox[i], 2, i + 1, 1, 1);
             }
         }
+        // Das Pane anzeigen
         this.setVisible(true);
     }
 
     /**
-     * Prüft welche CheckBox aus gewählt und gibt deren
-     * Index zurück
-     *
-     * @return Integer
-     */
-    private Integer isCheckedChkBoxIndex() {
-        for (int i = 0; i < charSize; i++) {
-            if (checkbox[i].isSelected()) {
-                return i;
-            } else {
-                return null;
-            }
-        }
-        return null;
-    }
-
-    /**
-     * TODO: Doku
+     * Gibt den Anzahl der zur Verfügung stehenden Buchstaben zurück.
+     * Anhang dieses Wertes, wird die Anzahl der Checkboxen festgelegt.
      *
-     * @return
+     * @return int : Anzahl der möglcihen chars
      */
     public int getCharSize() {
         return charSize;

src/main/resources/projekt/enigma/gui.fxml

 <?xml version="1.0" encoding="UTF-8"?>
 
-<?import javafx.geometry.*?>
-<?import javafx.scene.control.*?>
-<?import javafx.scene.layout.*?>
-<?import javafx.scene.shape.*?>
-<?import javafx.scene.text.*?>
+<?import javafx.geometry.Insets?>
+<?import javafx.scene.control.Button?>
+<?import javafx.scene.control.Label?>
+<?import javafx.scene.control.MenuButton?>
+<?import javafx.scene.control.ProgressIndicator?>
+<?import javafx.scene.control.TextArea?>
+<?import javafx.scene.layout.AnchorPane?>
+<?import javafx.scene.layout.ColumnConstraints?>
+<?import javafx.scene.layout.GridPane?>
+<?import javafx.scene.layout.Pane?>
+<?import javafx.scene.layout.RowConstraints?>
+<?import javafx.scene.shape.Circle?>
+<?import javafx.scene.text.Font?>
 
-<AnchorPane fx:id="anchorPane" maxHeight="-Infinity" maxWidth="-Infinity" minHeight="-Infinity" minWidth="-Infinity" prefHeight="677.0" prefWidth="962.0" xmlns="http://javafx.com/javafx/10.0.2-internal" xmlns:fx="http://javafx.com/fxml/1" fx:controller="projekt.enigma.GuiController">
+<AnchorPane fx:id="anchorPane" maxHeight="-Infinity" maxWidth="-Infinity" minHeight="-Infinity" minWidth="-Infinity" prefHeight="677.0" prefWidth="962.0" xmlns="http://javafx.com/javafx/8.0.171" xmlns:fx="http://javafx.com/fxml/1" fx:controller="projekt.enigma.GuiController">
     <GridPane layoutX="23.0" layoutY="60.0" prefHeight="158.0" prefWidth="237.0" AnchorPane.leftAnchor="23.0" AnchorPane.topAnchor="60.0">
         <columnConstraints>
             <ColumnConstraints hgrow="SOMETIMES" minWidth="10.0" prefWidth="100.0" />
@@ -585,12 +593,6 @@
             <RowConstraints minHeight="10.0" prefHeight="30.0" vgrow="SOMETIMES" />
             <RowConstraints minHeight="10.0" prefHeight="30.0" vgrow="SOMETIMES" />
         </rowConstraints>
-        <TextField fx:id="tfKlartext" editable="false" prefHeight="70.0" prefWidth="293.0">
-            <GridPane.margin>
-                <Insets />
-            </GridPane.margin>
-        </TextField>
-        <TextField fx:id="tfCodiert" editable="false" prefHeight="70.0" prefWidth="293.0" GridPane.rowIndex="1" />
         <Button fx:id="btnSenden" alignment="CENTER" contentDisplay="RIGHT" mnemonicParsing="false" onAction="#gedrueckteTaste" prefHeight="70.0" prefWidth="195.0" text="An Funker senden" textAlignment="CENTER" GridPane.columnIndex="1">
             <GridPane.margin>
                 <Insets left="80.0" />
@@ -601,6 +603,16 @@
                 <Insets left="80.0" />
             </GridPane.margin>
         </Button>
+      <TextArea fx:id="tfKlartext" prefHeight="66.0" prefWidth="293.0" wrapText="true">
+         <GridPane.margin>
+            <Insets bottom="5.0" top="5.0" />
+         </GridPane.margin>
+      </TextArea>
+      <TextArea fx:id="tfCodiert" prefHeight="200.0" prefWidth="200.0" wrapText="true" GridPane.rowIndex="1">
+         <GridPane.margin>
+            <Insets bottom="5.0" top="5.0" />
+         </GridPane.margin>
+      </TextArea>
     </GridPane>
     <Label fx:id="lblKenngruppe" layoutX="682.0" layoutY="34.0" prefHeight="17.0" prefWidth="177.0" />
     <Pane layoutX="266.0" layoutY="194.0" prefHeight="200.0" prefWidth="354.0" style="-fx-background-color: white; -fx-border-color: black;" visible="false">