Add GUI for chatbot

Author: nubnubyas

build.gradle

@@ -14,6 +14,21 @@ repositories {
 }
 
 dependencies {
+    String javaFxVersion = '17.0.7'
+
+    implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-controls', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-controls', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-controls', version: javaFxVersion, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-fxml', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-fxml', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-fxml', version: javaFxVersion, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'linux'
+
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.10.0'
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.10.0'
 }

data/duke.txt

@@ -0,0 +1,62 @@
+package monday;
+
+import java.io.IOException;
+import java.util.Collections;
+
+import javafx.collections.FXCollections;
+import javafx.collections.ObservableList;
+import javafx.fxml.FXML;
+import javafx.fxml.FXMLLoader;
+import javafx.geometry.Pos;
+import javafx.scene.Node;
+import javafx.scene.control.Label;
+import javafx.scene.image.Image;
+import javafx.scene.image.ImageView;
+import javafx.scene.layout.HBox;
+
+
+/**
+ * An example of a custom control using FXML.
+ * This control represents a dialog box consisting of an ImageView to represent the speaker's face and a label
+ * containing text from the speaker.
+ */
+public class DialogBox extends HBox {
+    @FXML
+    private Label dialog;
+    @FXML
+    private ImageView displayPicture;
+
+    private DialogBox(String text, Image img) {
+        try {
+            FXMLLoader fxmlLoader = new FXMLLoader(MainWindow.class.getResource("/view/DialogBox.fxml"));
+            fxmlLoader.setController(this);
+            fxmlLoader.setRoot(this);
+            fxmlLoader.load();
+        } catch (IOException e) {
+            e.printStackTrace();
+        }
+
+        dialog.setText(text);
+        displayPicture.setImage(img);
+    }
+
+    /**
+     * Flips the dialog box such that the ImageView is on the left and text on the right.
+     */
+    private void flip() {
+        ObservableList<Node> tmp = FXCollections.observableArrayList(this.getChildren());
+        Collections.reverse(tmp);
+        getChildren().setAll(tmp);
+        setAlignment(Pos.TOP_LEFT);
+    }
+
+    public static DialogBox getUserDialog(String text, Image img) {
+        return new DialogBox(text, img);
+    }
+
+    public static DialogBox getDukeDialog(String text, Image img) {
+        var db = new DialogBox(text, img);
+        db.flip();
+        return db;
+    }
+}

src/main/java/monday/DialogBox.java

@@ -0,0 +1,12 @@
+package monday;
+
+import javafx.application.Application;
+
+/**
+ * A launcher class to workaround classpath issues.
+ */
+public class Launcher {
+    public static void main(String[] args) {
+        Application.launch(Main.class, args);
+    }
+}

src/main/java/monday/Launcher.java

@@ -0,0 +1,32 @@
+package monday;
+
+import java.io.IOException;
+
+import javafx.application.Application;
+import javafx.fxml.FXMLLoader;
+import javafx.scene.Scene;
+import javafx.scene.layout.AnchorPane;
+import javafx.stage.Stage;
+
+
+/**
+ * A GUI for Duke using FXML.
+ */
+public class Main extends Application {
+
+    private Monday monday = new Monday();
+
+    @Override
+    public void start(Stage stage) {
+        try {
+            FXMLLoader fxmlLoader = new FXMLLoader(Main.class.getResource("/view/MainWindow.fxml"));
+            AnchorPane ap = fxmlLoader.load();
+            Scene scene = new Scene(ap);
+            stage.setScene(scene);
+            fxmlLoader.<MainWindow>getController().setMonday(monday);
+            stage.show();
+        } catch (IOException e) {
+            e.printStackTrace();
+        }
+    }
+}

src/main/java/monday/Main.java

@@ -0,0 +1,51 @@
+package monday;
+
+import javafx.fxml.FXML;
+import javafx.scene.control.Button;
+import javafx.scene.control.ScrollPane;
+import javafx.scene.control.TextField;
+import javafx.scene.image.Image;
+import javafx.scene.layout.AnchorPane;
+import javafx.scene.layout.VBox;
+/**
+ * Controller for MainWindow. Provides the layout for the other controls.
+ */
+public class MainWindow extends AnchorPane {
+    @FXML
+    private ScrollPane scrollPane;
+    @FXML
+    private VBox dialogContainer;
+    @FXML
+    private TextField userInput;
+    @FXML
+    private Button sendButton;
+
+    private Monday monday;
+
+    private Image userImage = new Image(this.getClass().getResourceAsStream("/images/bai.png"));
+    private Image mondayImage = new Image(this.getClass().getResourceAsStream("/images/fa.png"));
+
+    @FXML
+    public void initialize() {
+        scrollPane.vvalueProperty().bind(dialogContainer.heightProperty());
+    }
+
+    public void setMonday(Monday d) {
+        monday = d;
+    }
+
+    /**
+     * Creates two dialog boxes, one echoing user input and the other containing Duke's reply and then appends them to
+     * the dialog container. Clears the user input after processing.
+     */
+    @FXML
+    private void handleUserInput() {
+        String input = userInput.getText();
+        String response = monday.getResponse(input);
+        dialogContainer.getChildren().addAll(
+                DialogBox.getUserDialog(input, userImage),
+                DialogBox.getDukeDialog(response, mondayImage)
+        );
+        userInput.clear();
+    }
+}

src/main/java/monday/MainWindow.java

@@ -12,25 +12,28 @@
  * delete, keep track of the tasks they have.
  */
 public class Monday {
+
+    private final TaskList taskList = new TaskList("./data/duke.txt");
+
     /**
      * Starts the Monday application.
      * Initializes necessary components, greets the user, handles user input, and handles errors.
-     *
-     * @param filepath the filepath to store the tasks
      */
-    private static void startMonday(String filepath) {
+    private void startMonday() {
         Scanner scanner = new Scanner(System.in);
-        TaskList taskList = new TaskList(filepath);
         boolean isRunning = true;
 
         Ui.printSeparator();
-        Ui.greet();
+        System.out.println(Ui.greet());
         Ui.printSeparator();
         while (isRunning) {
             String userInput = scanner.nextLine();
+            if (userInput.equals("bye")) {
+                isRunning = false;
+            }
             Ui.printSeparator();
             try {
-                isRunning = Parser.mondayParser(userInput, taskList);
+                System.out.println(Parser.mondayParser(userInput, taskList));
             } catch (MondayExceptions e) {
                 System.out.println(e);
             } catch (NumberFormatException e) {
@@ -45,12 +48,21 @@ private static void startMonday(String filepath) {
         scanner.close();
     }
 
+    public String getResponse(String input) {
+        try {
+            return Parser.mondayParser(input, taskList);
+        } catch (MondayExceptions e) {
+            return e.toString();
+        }
+    }
+
     /**
      * Entry point to Monday.
      *
      * @param args Command line arguments
      */
     public static void main(String[] args) {
-        startMonday("./data/duke.txt");
+        Monday monday = new Monday();
+        monday.startMonday();
     }
 }

src/main/java/monday/Monday.java

@@ -24,19 +24,20 @@ private enum Command {
         DEADLINE,
         EVENT,
         DELETE,
-        FIND
+        FIND,
+        HI
     }
 
     /**
      * Parses the user input and performs the corresponding action.
      *
      * @param userInput the user input to be parsed
      * @param taskList the TaskList object to perform actions on
-     * @return true if the application should continue running, false otherwise
+     * @return response from chatbot
      * @throws MondayExceptions if there are errors related to the Monday application
      * @throws IllegalArgumentException if the user input is in the wrong format
      */
-    public static boolean mondayParser(String userInput, TaskList taskList) throws MondayExceptions {
+    public static String mondayParser(String userInput, TaskList taskList) throws MondayExceptions {
         String[] input = userInput.split(" ", 2);
         String command = input[0];
         String content = input.length > 1 ? input[1] : null;
@@ -45,20 +46,19 @@ public static boolean mondayParser(String userInput, TaskList taskList) throws M
 
 
         switch (commandEnum) {
+        case HI:
+            return Ui.greet();
         case BYE:
-            Ui.exit();
-            return false;
+            return Ui.exit();
         case LIST:
-            taskList.displayList();
-            break;
+            return taskList.displayList();
         case MARK: {
             if (content == null) {
                 throw new MondayExceptions("Mark requires a index to mark the task as completed.");
             }
             int index = Integer.parseInt(content);
 
-            taskList.mark(index);
-            break;
+            return taskList.mark(index);
         }
         case UNMARK: {
             if (content == null) {
@@ -67,17 +67,15 @@ public static boolean mondayParser(String userInput, TaskList taskList) throws M
 
             int index = Integer.parseInt(content);
 
-            taskList.unMark(index);
-            break;
+            return taskList.unMark(index);
         }
         case TODO:
             if (content == null) {
                 throw new MondayExceptions("The description of a todo cannot be empty.\n"
                         + "Usage: todo (task)");
             }
 
-            taskList.addToTask(new ToDo(content));
-            break;
+            return taskList.addToTask(new ToDo(content));
         case DEADLINE:
             try {
                 if (content == null) {
@@ -89,12 +87,11 @@ public static boolean mondayParser(String userInput, TaskList taskList) throws M
                 String description = taskDetails[0];
                 String date = taskDetails[1];
 
-                taskList.addToTask(new Deadline(description.trim(), date.trim()));
+                return taskList.addToTask(new Deadline(description.trim(), date.trim()));
             } catch (ArrayIndexOutOfBoundsException e) {
                 throw new IllegalArgumentException("Invalid Format. "
                         + "Usage: deadline (task) /by (time)");
             }
-            break;
         case EVENT:
             try {
                 if (content == null) {
@@ -108,22 +105,20 @@ public static boolean mondayParser(String userInput, TaskList taskList) throws M
                 String start = taskTiming[0];
                 String end = taskTiming[1];
 
-                taskList.addToTask(new Event(description.trim(),
+                return taskList.addToTask(new Event(description.trim(),
                         start.trim(),
                         end.trim()));
             } catch (ArrayIndexOutOfBoundsException e) {
                 throw new IllegalArgumentException("Invalid Format. "
                         + "Usage: event (task) /from (start time) /to (end time)");
             }
-            break;
         case DELETE:
             if (content == null) {
                 throw new MondayExceptions("Delete requires a index to delete the task");
             }
             int index = Integer.parseInt(content);
 
-            taskList.delete(index);
-            break;
+            return taskList.delete(index);
         case FIND:
             if (content == null) {
                 throw new MondayExceptions("Find requires a keyword to find the tasks");
@@ -136,12 +131,10 @@ public static boolean mondayParser(String userInput, TaskList taskList) throws M
                         + "Usage: find (keyword), there should only be one keyword.");
             }
 
-            taskList.find(keywordDetails[0]);
-            break;
+            return taskList.find(keywordDetails[0]);
         default:
             throw new MondayExceptions("Sorry, I do not understand what that means.\n"
                     + "Please provide a valid input/command. e.g todo read book");
         }
-        return true;
     }
 }