fix: fixed fxml version warning

Feature gui overhaul m3

src/main/java/ch/zhaw/gartenverwaltung/MainFXMLController.java

@@ -11,6 +11,9 @@ import javafx.scene.image.Image;
 import javafx.scene.image.ImageView;
 import javafx.scene.layout.AnchorPane;
 import javafx.scene.layout.Pane;
+import javafx.stage.Modality;
+import javafx.stage.Stage;
+import javafx.stage.WindowEvent;
 
 import java.io.IOException;
 import java.util.logging.Level;
@@ -40,6 +43,9 @@ public class MainFXMLController {
     @FXML
     private Button tutorial_button;
 
+    private final Stage tutorialModal = new Stage();
+
+
     /**
      * go to home pane
      */
@@ -95,11 +101,23 @@ public class MainFXMLController {
     }
 
     /**
-     * go to Tutorial pane
+     * Show the tutorial window
      */
-    public void goToTutorial() {
-        showPaneAsMainView("Tutorial.fxml");
-        styleChangeButton(tutorial_button);
+    public void showTutorial() {
+        if (!tutorialModal.isShowing()) {
+            if (tutorialModal.getScene() == null) {
+                try {
+                    appLoader.loadSceneToStage("Tutorial.fxml", tutorialModal);
+                    tutorialModal.initModality(Modality.NONE);
+                    tutorialModal.setResizable(false);
+                    tutorialModal.sizeToScene();
+                } catch (IOException e) {
+                    LOG.log(Level.SEVERE, "Could not load Tutorial");
+                }
+            }
+            tutorialModal.show();
+        }
+        tutorialModal.requestFocus();
     }
 
     /**
@@ -132,7 +150,6 @@ public class MainFXMLController {
         appLoader.loadAndCacheFxml("MyGarden.fxml");
         appLoader.loadAndCacheFxml("MySchedule.fxml");
         appLoader.loadAndCacheFxml("Plants.fxml");
-        appLoader.loadAndCacheFxml("Tutorial.fxml");
     }
 
     private void styleChangeButton(Button button) {
@@ -153,12 +170,14 @@ public class MainFXMLController {
         } catch (IOException e) {
             LOG.log(Level.SEVERE, "Failed to load FXML-Pane!", e);
         }
+        mainPane.getScene().getWindow().setOnCloseRequest(this::closeWindowHandler);
         setIconToButton(home_button, "homeIcon.png");
         setIconToButton(settings_button, "settingsIcon.png");
-        Settings.getInstance().getShowTutorialProperty().addListener((observable, oldValue, newValue) -> {
-            tutorial_button.setVisible(newValue);
-        });
-        tutorial_button.setVisible(Settings.getInstance().getShowTutorial());
+        tutorial_button.visibleProperty().bind(Settings.getInstance().getShowTutorialProperty());
+    }
+
+    private void closeWindowHandler(WindowEvent windowEvent) {
+        tutorialModal.close();
     }
 
     /**
@@ -173,7 +192,4 @@ public class MainFXMLController {
         imageView.setPreserveRatio(true);
         button.setGraphic(imageView);
     }
-
-
 }
-

src/main/java/ch/zhaw/gartenverwaltung/TaskFormularController.java

@@ -1,7 +1,6 @@
 package ch.zhaw.gartenverwaltung;
 
 import ch.zhaw.gartenverwaltung.types.Crop;
-import ch.zhaw.gartenverwaltung.types.GrowthPhaseType;
 import ch.zhaw.gartenverwaltung.types.Task;
 import javafx.fxml.FXML;
 import javafx.fxml.Initializable;
@@ -49,8 +48,12 @@ public class TaskFormularController implements Initializable {
         taskName_field.setText(task.getName());
         description_area.setText(task.getDescription());
         start_datePicker.setValue(task.getStartDate());
-        end_datePicker.setValue(task.getEndDate().get());
+        end_datePicker.setValue(task.getEndDate().orElse(null));
+        if(task.getInterval().orElse(null)!=null) {
             interval_field.setText(task.getInterval().get().toString());
+        } else {
+            interval_field.setText(null);
+        }
     }
 
     private Callback<DatePicker, DateCell> getDayCellFactory() {

src/main/java/ch/zhaw/gartenverwaltung/TutorialController.java

@@ -1,6 +1,61 @@
 package ch.zhaw.gartenverwaltung;
 
 
+import javafx.fxml.FXML;
+import javafx.scene.control.Button;
+import javafx.scene.image.Image;
+import javafx.scene.image.ImageView;
+import javafx.scene.layout.StackPane;
+import javafx.stage.Stage;
+
 public class TutorialController {
 
+    @FXML
+    public Button previousPageButton;
+    @FXML
+    public Button nextPageButton;
+    @FXML
+    public StackPane tourPages;
+    public ImageView imgAddNewPlant;
+    public ImageView imgTaskList;
+    public ImageView imgSelectDate;
+
+    private int page = 0;
+
+    @FXML
+    public void initialize() {
+        switchViews();
+        setButtonAbilities();
+
+        Image placeholder = new Image(String.valueOf(PlantsController.class.getResource("placeholder.png")));
+        imgAddNewPlant.setImage(placeholder);
+        imgSelectDate.setImage(placeholder);
+        imgTaskList.setImage(placeholder);
+    }
+
+    public void viewNextPage() {
+        page++;
+        switchViews();
+        setButtonAbilities();
+    }
+    public void viewPreviousPage() {
+        page--;
+        switchViews();
+        setButtonAbilities();
+    }
+
+    private void setButtonAbilities() {
+        previousPageButton.setDisable(page <= 0);
+        nextPageButton.setDisable(page >= tourPages.getChildren().size() - 1);
+    }
+
+    private void switchViews() {
+        tourPages.getChildren().forEach(node -> node.setOpacity(0));
+        tourPages.getChildren().get(page).setOpacity(1);
+    }
+
+    public void closeTutorial() {
+        Stage root = (Stage) tourPages.getScene().getWindow();
+        root.close();
+    }
 }

src/main/java/ch/zhaw/gartenverwaltung/io/JsonTaskList.java

@@ -103,10 +103,9 @@ public class JsonTaskList implements TaskList {
         if(taskMap.isEmpty()) {
             loadTaskListFromFile();
         }
-        if(task.getId() == 0) {
-            task.withId(idProvider.incrementAndGet());
-        }
-        taskMap.put(task.getId(), task);
+        long id = task.getId().orElse(idProvider.incrementAndGet());
+
+        taskMap.put(id, task.withId(id));
         writeTaskListToFile();
     }
 
@@ -122,8 +121,9 @@ public class JsonTaskList implements TaskList {
         if(taskMap.isEmpty()) {
             loadTaskListFromFile();
         }
-        if(taskMap.containsKey(task.getId())){
-            taskMap.remove(task.getId());
+        Long taskId = task.getId().orElseThrow(IOException::new);
+        if(taskMap.containsKey(taskId)){
+            taskMap.remove(taskId);
             writeTaskListToFile();
         }
     }
@@ -163,7 +163,7 @@ public class JsonTaskList implements TaskList {
 
             taskMap = result.stream()
                     .collect(HashMap::new,
-                        (res, task) -> res.put(task.getId(), task),
+                        (res, task) -> res.put(task.getId().orElse(0L), task),
                         (existing, replacement) -> {});
         }
 

src/main/java/ch/zhaw/gartenverwaltung/types/Task.java

@@ -9,7 +9,7 @@ import java.util.Optional;
  * May be created using the builder pattern.
  */
 public class Task {
-    private long id;
+    private Long id;
     private final String name;
     private final String description;
     private final LocalDate startDate;
@@ -62,7 +62,7 @@ public class Task {
     }
 
     // Getters
-    public long getId() { return id; }
+    public Optional<Long> getId() { return Optional.ofNullable(id); }
     public String getName() { return name; }
     public String getDescription() { return description; }
     public LocalDate getStartDate() { return startDate; }

src/main/java/ch/zhaw/gartenverwaltung/types/TaskTemplate.java

@@ -34,6 +34,7 @@ public class TaskTemplate {
     public void setRelativeEndDate(Integer relativeEndDate) {
         this.relativeEndDate = relativeEndDate;
     }
+
     public void setInterval(Integer interval) {
         this.interval = interval;
     }
@@ -45,13 +46,10 @@ public class TaskTemplate {
     }
 
     public Task generateTask(LocalDate realStartDate, long cropId) {
-        Task task = new Task(name, description, realStartDate.plusDays(relativeStartDate), cropId);
-        if (relativeEndDate != null) {
-            task.withEndDate(realStartDate.plusDays(relativeEndDate));
-        }
-        if (interval != null) {
-            task.withInterval(interval);
-        }
-        return task;
+        LocalDate endDate = relativeEndDate != null ? realStartDate.plusDays(relativeEndDate) : null;
+
+        return new Task(name, description, realStartDate.plusDays(relativeStartDate), cropId)
+                .withInterval(interval)
+                .withEndDate(endDate);
     }
 }

src/main/resources/ch/zhaw/gartenverwaltung/MainFXML.fxml

@@ -12,7 +12,7 @@
             <Button fx:id="home_button" mnemonicParsing="false" onAction="#goToHome" prefHeight="38.0" prefWidth="40.0" HBox.hgrow="NEVER" />
             <Button fx:id="myGarden_button" layoutX="10.0" layoutY="10.0" mnemonicParsing="false" onAction="#goToMyPlants" prefHeight="38.0" prefWidth="121.0" text="My Garden" />
             <Button fx:id="mySchedule_button" layoutX="10.0" layoutY="10.0" mnemonicParsing="false" onAction="#goToMySchedule" prefHeight="38.0" prefWidth="121.0" text="My Schedule" />
-            <Button fx:id="tutorial_button" layoutX="10.0" layoutY="10.0" mnemonicParsing="false" onAction="#goToTutorial" prefHeight="38.0" prefWidth="121.0" text="Tutorial" />
+            <Button fx:id="tutorial_button" layoutX="10.0" layoutY="10.0" mnemonicParsing="false" onAction="#showTutorial" prefHeight="38.0" prefWidth="121.0" text="Tutorial" />
             <Pane maxWidth="1.7976931348623157E308" prefHeight="200.0" prefWidth="200.0" HBox.hgrow="ALWAYS" />
             <Button fx:id="settings_button" maxHeight="1.7976931348623157E308" mnemonicParsing="false" onAction="#openSettings" prefHeight="38.0" prefWidth="40.0" HBox.hgrow="NEVER" />
          </children>

src/main/resources/ch/zhaw/gartenverwaltung/Tutorial.fxml

@@ -1,27 +1,141 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
 <?import javafx.geometry.Insets?>
-<?import javafx.scene.control.Label?>
-<?import javafx.scene.layout.AnchorPane?>
+<?import javafx.scene.control.Button?>
+<?import javafx.scene.control.ButtonBar?>
+<?import javafx.scene.control.CheckBox?>
+<?import javafx.scene.control.Separator?>
+<?import javafx.scene.image.ImageView?>
+<?import javafx.scene.layout.BorderPane?>
+<?import javafx.scene.layout.HBox?>
+<?import javafx.scene.layout.StackPane?>
 <?import javafx.scene.layout.VBox?>
 <?import javafx.scene.text.Font?>
+<?import javafx.scene.text.Text?>
+<?import javafx.scene.text.TextFlow?>
 
-
-<AnchorPane maxHeight="-Infinity" maxWidth="-Infinity" minHeight="-Infinity" minWidth="-Infinity" prefHeight="400.0" prefWidth="600.0" xmlns="http://javafx.com/javafx/17"
-            xmlns:fx="http://javafx.com/fxml/1" fx:controller="ch.zhaw.gartenverwaltung.TutorialController">
+<BorderPane maxHeight="470.0" maxWidth="724.0" minHeight="470.0" minWidth="724.0" prefHeight="470.0" prefWidth="724.0" xmlns="http://javafx.com/javafx/17" xmlns:fx="http://javafx.com/fxml/1" fx:controller="ch.zhaw.gartenverwaltung.TutorialController">
+   <bottom>
+      <HBox alignment="CENTER" prefHeight="0.0" prefWidth="724.0" BorderPane.alignment="CENTER">
          <children>
-      <VBox layoutX="7.0" layoutY="8.0" prefHeight="200.0" prefWidth="100.0" AnchorPane.bottomAnchor="0.0" AnchorPane.leftAnchor="0.0" AnchorPane.rightAnchor="0.0" AnchorPane.topAnchor="0.0">
-         <children>
-            <Label text="Tutorial">
-               <font>
-                  <Font size="18.0" />
-               </font>
-            </Label>
-            <Label text="To be added" />
+            <CheckBox mnemonicParsing="false" text="Don't show again" />
+            <Separator prefWidth="50.0" visible="false" HBox.hgrow="ALWAYS" />
+            <ButtonBar prefHeight="40.0" prefWidth="200.0">
+              <buttons>
+                  <Button cancelButton="true" contentDisplay="CENTER" graphicTextGap="5.0" mnemonicParsing="false" text="Close" onAction="#closeTutorial"/>
+                <Button fx:id="previousPageButton" mnemonicParsing="false" text="Previous" onAction="#viewPreviousPage"/>
+                  <Button fx:id="nextPageButton" defaultButton="true" mnemonicParsing="false" text="Next" onAction="#viewNextPage" />
+              </buttons>
+            </ButtonBar>
          </children>
          <padding>
-            <Insets bottom="10.0" left="10.0" right="10.0" top="10.0" />
+            <Insets bottom="15.0" left="15.0" right="15.0" top="15.0" />
          </padding>
+      </HBox>
+   </bottom>
+   <center>
+      <StackPane fx:id="tourPages" prefHeight="150.0" prefWidth="200.0" BorderPane.alignment="CENTER">
+         <children>
+            <VBox layoutX="30.0" layoutY="26.0" opacity="0.0" prefHeight="200.0" prefWidth="100.0">
+               <children>
+                  <Text strokeType="OUTSIDE" strokeWidth="0.0" text="Managing Your Crops">
+                     <font>
+                        <Font size="24.0" />
+                     </font>
+                  </Text>
+                  <Separator prefWidth="200.0">
+                     <VBox.margin>
+                        <Insets bottom="15.0" top="10.0" />
+                     </VBox.margin>
+                  </Separator>
+                  <Text strokeType="OUTSIDE" strokeWidth="0.0" text="In the &quot;My Garden&quot; tab, you can see all of the plants you're planning on growing.">
+                     <VBox.margin>
+                        <Insets bottom="20.0" />
+                     </VBox.margin>
+                  </Text>
+                  <HBox prefHeight="100.0" prefWidth="200.0">
+                     <children>
+                        <TextFlow lineSpacing="4.0" prefHeight="90.0" prefWidth="500.0">
+                           <children>
+                              <Text strokeType="OUTSIDE" strokeWidth="0.0" text="To get started, click on the &quot;Add new Plant&quot; button in the bottom left. This will open a list of all the plants you can grow.&#10;Use the search bar at the top, the filters on the left, or simply browse the list until you've found a plant you want to grow in your garden." wrappingWidth="345.80316162109375" />
+                           </children>
+                           <HBox.margin>
+                              <Insets bottom="20.0" />
+                           </HBox.margin>
+                        </TextFlow>
+                        <Separator prefWidth="200.0" visible="false" HBox.hgrow="ALWAYS" />
+                        <ImageView fx:id="imgAddNewPlant" fitHeight="98.0" fitWidth="200.0" pickOnBounds="true" preserveRatio="true" />
+                     </children>
+                  </HBox>
+                  <HBox prefHeight="100.0" prefWidth="200.0">
+                     <children>
+                        <TextFlow lineSpacing="4.0" prefHeight="200.0" prefWidth="500.0">
+                           <children>
+                              <Text strokeType="OUTSIDE" strokeWidth="0.0" text="Once you've found what you're looking for, click the &quot;Select Sow/Harvest Date&quot; button at the bottom of the window.&#10;In the subsequently shown dialog, you can select the date you'd like to sow or harvest the crop. The date selector shows possible dates in green. Confirm your selection with the &quot;Save&quot; button." />
+                           </children>
+                        </TextFlow>
+                        <Separator prefWidth="200.0" visible="false" HBox.hgrow="ALWAYS" />
+                        <ImageView fx:id="imgSelectDate" fitHeight="150.0" fitWidth="200.0" pickOnBounds="true" preserveRatio="true" />
+                     </children>
+                  </HBox>
+               </children>
+               <opaqueInsets>
+                  <Insets />
+               </opaqueInsets>
+            </VBox>
+            <VBox prefHeight="200.0" prefWidth="100.0">
+               <children>
+                  <Text strokeType="OUTSIDE" strokeWidth="0.0" text="Managing Your Tasks">
+                     <font>
+                        <Font size="24.0" />
+                     </font>
+                  </Text>
+                  <Separator prefWidth="200.0">
+                     <VBox.margin>
+                        <Insets bottom="15.0" top="10.0" />
+                     </VBox.margin>
+                  </Separator>
+                  <Text strokeType="OUTSIDE" strokeWidth="0.0" text="In the &quot;My Schedule&quot; tab, you can see all of the tasks you need to complete for a successful harvest.">
+                     <VBox.margin>
+                        <Insets bottom="20.0" />
+                     </VBox.margin>
+                  </Text>
+                  <HBox prefHeight="100.0" prefWidth="200.0">
+                     <children>
+                        <TextFlow lineSpacing="4.0" prefHeight="90.0" prefWidth="500.0">
+                           <children>
+                              <Text strokeType="OUTSIDE" strokeWidth="0.0" text="You can view the tasks for a specific crop by selecting it from the left sidebar.&#10;To see all tasks again, click the &quot;Clear Filter&quot; button at the bottom." wrappingWidth="345.80316162109375" />
+                           </children>
+                           <HBox.margin>
+                              <Insets bottom="20.0" />
+                           </HBox.margin>
+                        </TextFlow>
+                        <Separator prefWidth="200.0" visible="false" HBox.hgrow="ALWAYS" />
+                        <ImageView fx:id="imgTaskList" fitHeight="98.0" fitWidth="200.0" pickOnBounds="true" preserveRatio="true" />
+                     </children>
+                  </HBox>
+                  <HBox prefHeight="100.0" prefWidth="200.0">
+                     <children>
+                        <TextFlow lineSpacing="4.0" prefHeight="200.0" prefWidth="500.0">
+                           <children>
+                              <Text strokeType="OUTSIDE" strokeWidth="0.0" text="You can also add your own custom tasks, by clicking the &quot;Add Task&quot; button.&#10;In the subsequently shown dialog, you can enter the corresponding details.&#10;&#10;Note: If you want to make a task recurring, you need to set both an interval (in days) AND an end date, so the task won't repeat for all eternity." />
+                           </children>
+                        </TextFlow>
+                        <Separator prefWidth="200.0" visible="false" HBox.hgrow="ALWAYS" />
+                        <ImageView fitHeight="150.0" fitWidth="200.0" pickOnBounds="true" preserveRatio="true" />
+                     </children></HBox>
+               </children>
+               <opaqueInsets>
+                  <Insets />
+               </opaqueInsets>
             </VBox>
          </children>
-</AnchorPane>
+         <BorderPane.margin>
+            <Insets />
+         </BorderPane.margin>
+         <padding>
+            <Insets bottom="20.0" left="20.0" right="20.0" top="20.0" />
+         </padding>
+      </StackPane>
+   </center>
+</BorderPane>

src/test/java/ch/zhaw/gartenverwaltung/io/JsonTaskListTest.java

@@ -72,7 +72,8 @@ public class JsonTaskListTest {
     @Test
     @DisplayName("Remove task.")
     void removeTask() {
-        Task task = new Task("Dummy", "Dummy", LocalDate.parse("2022-05-31", formatter), 1).withId(2);
+        Task task = new Task("Dummy", "Dummy", LocalDate.parse("2022-05-31", formatter), 1)
+                .withId(2);
         try {
             testDatabase.removeTask(task);
             List<Task> taskList;

src/test/java/ch/zhaw/gartenverwaltung/models/GardenPlanModelTest.java

@@ -55,8 +55,8 @@ public class GardenPlanModelTest {
                         new GrowthPhase(MonthDay.of(2, 8), MonthDay.of(12, 4), 0, new WateringCycle(0, 0, null), GrowthPhaseType.PLANT, HardinessZone.ZONE_8A, new ArrayList<>()),
                         new GrowthPhase(MonthDay.of(10, 2), MonthDay.of(12, 4), 0, new WateringCycle(0, 0, null), GrowthPhaseType.PLANT, HardinessZone.ZONE_8A, new ArrayList<>())));
 
-        exampleCropOnion = new Crop(examplePlantOnion.id(),  LocalDate.of(2023,3,1));
-        exampleCropOnion.withId(3);
+        exampleCropOnion = new Crop(examplePlantOnion.id(), LocalDate.of(2023, 3, 1))
+                .withId(3);
         examplePlantCarrot = new Plant(
                 1,
                 "Early Carrot",
@@ -67,18 +67,18 @@ public class GardenPlanModelTest {
                 "sandy to loamy, loose soil, free of stones",
                 new ArrayList<>(),
                 List.of(new GrowthPhase(MonthDay.of(4, 4), MonthDay.of(12, 4), 0, new WateringCycle(0, 0, null), GrowthPhaseType.PLANT, HardinessZone.ZONE_8A, new ArrayList<>())));
-        exampleCropCarrot = new Crop(examplePlantCarrot.id(), LocalDate.now());
-        exampleCropCarrot.withId(5);
+        exampleCropCarrot = new Crop(examplePlantCarrot.id(), LocalDate.now())
+                .withId(5);
 
-        exampleCrop1 = new Crop(1, LocalDate.of(2023,2,25));
-        exampleCrop1.withId(0);
-        exampleCrop1.withArea(0.5);
-        exampleCrop2 = new Crop(1,LocalDate.of(2023,3,1));
-        exampleCrop2.withId(1);
-        exampleCrop2.withArea(0.5);
-        exampleCrop3 = new Crop(0,LocalDate.of(2023,3,1));
-        exampleCrop3.withId(2);
-        exampleCrop3.withArea(1.0);
+        exampleCrop1 = new Crop(1, LocalDate.of(2023, 2, 25))
+                .withId(0)
+                .withArea(0.5);
+        exampleCrop2 = new Crop(1, LocalDate.of(2023, 3, 1))
+                .withId(1)
+                .withArea(0.5);
+        exampleCrop3 = new Crop(0, LocalDate.of(2023, 3, 1))
+                .withId(2)
+                .withArea(1.0);
 
         exampleCrops = new ArrayList<>();
         exampleCrops.add(exampleCrop1);
@@ -107,7 +107,7 @@ public class GardenPlanModelTest {
     @Test
     void plantAsCrop() throws HardinessZoneNotSetException, IOException, PlantNotFoundException {
 
-        model.plantAsCrop(examplePlantOnion, LocalDate.of(2023,3,1));
+        model.plantAsCrop(examplePlantOnion, LocalDate.of(2023, 3, 1));
         Optional<Crop> exampleCrop = model.getCrop(2L);
         assertTrue(exampleCrop.isPresent());
         assertEquals(model.getCrops().get(2), exampleCrop.get());
@@ -119,6 +119,6 @@ public class GardenPlanModelTest {
         exampleCrop1.withId(2);
         exampleCrop1.withArea(1.5);
         model.removeCrop(exampleCrop1);
-        assertEquals(2,model.getCrops().size());
+        assertEquals(2, model.getCrops().size());
     }
 }