Merge pull request nus-cs2103-AY2021S1#94 from Licheng-Wu/branch-timetable-view

Update GUI for Timetable view

Author: iqbxl

src/main/java/seedu/address/logic/Logic.java

@@ -49,6 +49,9 @@ public interface Logic {
     /** Returns an unmodifiable view of the filtered list of slots */
     ObservableList<Slot> getFilteredSlotList();
 
+    /** Returns an unmodifiable view of the filtered list of slots, filtered by chosen day */
+    ObservableList<Slot> getFilteredSlotList(String day);
+
     /**
      * Returns the user prefs' address book file path.
      */

src/main/java/seedu/address/logic/LogicManager.java

@@ -88,6 +88,11 @@ public ObservableList<Slot> getFilteredSlotList() {
         return model.getFilteredSlotList();
     }
 
+    @Override
+    public ObservableList<Slot> getFilteredSlotList(String day) {
+        return model.getFilteredSlotList(day);
+    }
+
     @Override
     public Path getAddressBookFilePath() {
         return model.getAddressBookFilePath();

src/main/java/seedu/address/model/Model.java

@@ -126,6 +126,11 @@ public interface Model {
      */
     ObservableList<Slot> getFilteredSlotList();
 
+    /**
+     * Returns an unmodifiable view of the filtered slot list, filtered by the chosen day
+     */
+    ObservableList<Slot> getFilteredSlotList(String day);
+
     /**
      * Updates the filter of the filtered person list to filter by the given {@code predicate}.
      *

src/main/java/seedu/address/model/ModelManager.java

@@ -18,6 +18,7 @@
 import seedu.address.model.person.Routine;
 import seedu.address.model.person.RoutineNameContainsKeywordsPredicate;
 import seedu.address.model.person.Slot;
+import seedu.address.model.person.SlotDayPredicate;
 
 /**
  * Represents the in-memory model of the address book data.
@@ -312,6 +313,18 @@ public ObservableList<Slot> getFilteredSlotList() {
         return filteredSlots;
     }
 
+    @Override
+    public ObservableList<Slot> getFilteredSlotList(String day) {
+        SlotDayPredicate predicate = new SlotDayPredicate(Arrays.asList(day));
+
+        ObservableList<Slot> slotObservableList = this.addressBook.getSlotList();
+        FilteredList<Slot> filteredSlotsByDay = new FilteredList<>(slotObservableList);
+
+        requireNonNull(predicate);
+        filteredSlotsByDay.setPredicate(predicate);
+        return filteredSlotsByDay;
+    }
+
     @Override
     public void updateFilteredRoutineList(Predicate<Routine> predicate) {
         requireNonNull(predicate);

src/main/java/seedu/address/model/person/Slot.java

@@ -4,7 +4,7 @@
 
 import java.util.Objects;
 
-public class Slot {
+public class Slot implements Comparable<Slot> {
 
     private final Activity activity;
 
@@ -102,4 +102,9 @@ public int hashCode() {
     public String toString() {
         return activity.getName() + " on " + day.toString() + " " + duration.toString();
     }
+
+    @Override
+    public int compareTo(Slot o) {
+        return this.getDuration().getStartTime().compareTo(o.getDuration().getStartTime());
+    }
 }

src/main/java/seedu/address/model/person/SlotDayPredicate.java

@@ -0,0 +1,31 @@
+package seedu.address.model.person;
+
+import java.util.List;
+import java.util.function.Predicate;
+
+import seedu.address.commons.util.StringUtil;
+
+/**
+ * Tests that a {@code Slot}'s {@code Day} matches the day given.
+ */
+public class SlotDayPredicate implements Predicate<Slot> {
+    private final List<String> keywords;
+
+    public SlotDayPredicate(List<String> keywords) {
+        this.keywords = keywords;
+    }
+
+    @Override
+    public boolean test(Slot slot) {
+        return keywords.stream()
+                .anyMatch(keyword -> StringUtil.containsWordIgnoreCase(slot.getDay().getDay(), keyword));
+    }
+
+    @Override
+    public boolean equals(Object other) {
+        return other == this // short circuit if same object
+                || (other instanceof SlotDayPredicate // instanceof handles nulls
+                && keywords.equals(((SlotDayPredicate) other).keywords)); // state check
+    }
+
+}

src/main/java/seedu/address/model/person/UniqueSlotList.java

@@ -60,6 +60,7 @@ public void add(Slot toAdd) {
             throw new SlotOverlapDurationException();
         }
         internalList.add(toAdd);
+        FXCollections.sort(internalList);
     }
 
     /**

src/main/java/seedu/address/ui/SlotCard.java

@@ -0,0 +1,67 @@
+package seedu.address.ui;
+
+import javafx.fxml.FXML;
+import javafx.scene.control.Label;
+import javafx.scene.layout.FlowPane;
+import javafx.scene.layout.HBox;
+import javafx.scene.layout.Region;
+import seedu.address.model.person.Slot;
+
+/**
+ * An UI component that displays information of a {@code Slot}.
+ */
+public class SlotCard extends UiPart<Region> {
+
+    private static final String FXML = "SlotListCard.fxml";
+
+    /**
+     * Note: Certain keywords such as "location" and "resources" are reserved keywords in JavaFX.
+     * As a consequence, UI elements' variable names cannot be set to such keywords
+     * or an exception will be thrown by JavaFX during runtime.
+     *
+     * @see <a href="https://github.com/se-edu/addressbook-level4/issues/336">The issue on AddressBook level 4</a>
+     */
+
+    public final Slot slot;
+
+    @FXML
+    private HBox cardPane;
+    @FXML
+    private Label name;
+    @FXML
+    private Label id;
+    @FXML
+    private Label time;
+    @FXML
+    private FlowPane tags;
+
+    /**
+     * Creates a {@code SlotCode} with the given {@code Slot} and index to display.
+     */
+    public SlotCard(Slot slot, int displayedIndex) {
+        super(FXML);
+        this.slot = slot;
+        id.setText(displayedIndex + ". ");
+        name.setText(slot.getActivity().getName().toString());
+        time.setText(slot.getDuration().getStartTime().toString() + " - "
+                + slot.getDuration().getEndTime().toString());
+    }
+
+    @Override
+    public boolean equals(Object other) {
+        // short circuit if same object
+        if (other == this) {
+            return true;
+        }
+
+        // instanceof handles nulls
+        if (!(other instanceof SlotCard)) {
+            return false;
+        }
+
+        // state check
+        SlotCard card = (SlotCard) other;
+        return id.getText().equals(card.id.getText())
+                && slot.equals(card.slot);
+    }
+}

src/main/java/seedu/address/ui/SlotListPanel.java

@@ -0,0 +1,51 @@
+package seedu.address.ui;
+
+import java.util.logging.Logger;
+
+import javafx.collections.ObservableList;
+import javafx.fxml.FXML;
+import javafx.geometry.Orientation;
+import javafx.scene.control.ListCell;
+import javafx.scene.control.ListView;
+import javafx.scene.layout.Region;
+import seedu.address.commons.core.LogsCenter;
+import seedu.address.model.person.Slot;
+
+/**
+ * Panel containing the list of slots.
+ */
+public class SlotListPanel extends UiPart<Region> {
+    private static final String FXML = "SlotListPanel.fxml";
+    private final Logger logger = LogsCenter.getLogger(SlotListPanel.class);
+
+    @FXML
+    private ListView<Slot> slotListView;
+
+    /**
+     * Creates a {@code SlotListPanel} with the given {@code ObservableList}.
+     */
+    public SlotListPanel(ObservableList<Slot> slotList) {
+        super(FXML);
+        slotListView.setItems(slotList);
+        slotListView.setOrientation(Orientation.HORIZONTAL);
+        slotListView.setCellFactory(listView -> new SlotListViewCell());
+    }
+
+    /**
+     * Custom {@code ListCell} that displays the graphics of a {@code Slot} using a {@code SlotCard}.
+     */
+    class SlotListViewCell extends ListCell<Slot> {
+        @Override
+        protected void updateItem(Slot slot, boolean empty) {
+            super.updateItem(slot, empty);
+
+            if (empty || slot == null) {
+                setGraphic(null);
+                setText(null);
+            } else {
+                setGraphic(new SlotCard(slot, getIndex() + 1).getRoot());
+            }
+        }
+    }
+
+}

src/main/java/seedu/address/ui/TimetablePanel.java

@@ -2,7 +2,9 @@
 
 import java.util.logging.Logger;
 
+import javafx.fxml.FXML;
 import javafx.scene.layout.Region;
+import javafx.scene.layout.StackPane;
 import seedu.address.commons.core.LogsCenter;
 import seedu.address.logic.Logic;
 
@@ -13,6 +15,29 @@ public class TimetablePanel extends UiPart<Region> {
 
     private Logic logic;
 
+    // Independent Ui parts residing in this Ui container
+    private SlotListPanel mondayListPanel;
+    private SlotListPanel tuesdayListPanel;
+    private SlotListPanel wednesdayListPanel;
+    private SlotListPanel thursdayListPanel;
+    private SlotListPanel fridayListPanel;
+
+    @FXML
+    private StackPane mondayListPanelPlaceholder;
+
+    @FXML
+    private StackPane tuesdayListPanelPlaceholder;
+
+    @FXML
+    private StackPane wednesdayListPanelPlaceholder;
+
+    @FXML
+    private StackPane thursdayListPanelPlaceholder;
+
+    @FXML
+    private StackPane fridayListPanelPlaceholder;
+
+
     /** Constructs TimetablePanel
      *
      * @param logic
@@ -21,5 +46,20 @@ public TimetablePanel(Logic logic) {
         super(FXML);
 
         this.logic = logic;
+
+        mondayListPanel = new SlotListPanel(logic.getFilteredSlotList("Monday"));
+        mondayListPanelPlaceholder.getChildren().add(mondayListPanel.getRoot());
+
+        tuesdayListPanel = new SlotListPanel(logic.getFilteredSlotList("Tuesday"));
+        tuesdayListPanelPlaceholder.getChildren().add(tuesdayListPanel.getRoot());
+
+        wednesdayListPanel = new SlotListPanel(logic.getFilteredSlotList("Wednesday"));
+        wednesdayListPanelPlaceholder.getChildren().add(wednesdayListPanel.getRoot());
+
+        thursdayListPanel = new SlotListPanel(logic.getFilteredSlotList("Thursday"));
+        thursdayListPanelPlaceholder.getChildren().add(thursdayListPanel.getRoot());
+
+        fridayListPanel = new SlotListPanel(logic.getFilteredSlotList("Friday"));
+        fridayListPanelPlaceholder.getChildren().add(fridayListPanel.getRoot());
     }
 }