Merge pull request #97 from AY2324S2-CS2103T-W08-3/light-theme

Added Light theme

docs/UserGuide.md

@@ -75,6 +75,18 @@ Shows a message explaining how to access the help page. The help page is located
 
 Format: `help`
 
+### Changing the theme : `theme`
+
+Changes the theme of the application. Useful if you wish to change the appearance of the application. Currently supports `light` and `dark` themes.
+
+![light theme](images/lightTheme.png)
+
+Format: `theme THEME_NAME`
+
+Examples:
+* `theme light`
+* `theme dark`
+
 
 ### Adding a person: `add`
 
@@ -164,6 +176,10 @@ Format: `find_and_export TAG [n/NAME] [a/ADDRESS] [f/FILENAME]`
 Examples:
 * `find_and_export cs2103t`
 * `find_and_export cs2103t n/john a/olive street 42 f/output1.json`
+* `find_and_export cs2103t n/john a/olive street 42 f/output1.csv`
+
+Tip: `FILENAME` is optional. If not provided, has to be a valid filename with a `.json` or `.csv` extension.
+
 
 ### Importing a datafile: `import`
 
@@ -175,8 +191,9 @@ Format: `import f/FILENAME_1 [f/FILENAME_2] [f/FILENAME_3] ...`
 
 Examples:
 * `import f/export.json`
-* `import f/contacts_export.json`
-* `import f/contacts_export1.json f/contacts_export2.json`
+* `import f/contactsExport.csv`
+* `import f/contactsExport1.json f/contacts_export2.csv`
+
 
 ### Deleting a person : `delete`
 

src/main/java/scm/address/commons/core/GuiSettings.java

@@ -5,6 +5,7 @@
 import java.util.Objects;
 
 import scm.address.commons.util.ToStringBuilder;
+import scm.address.model.theme.ThemeCollection;
 
 /**
  * A Serializable class that contains the GUI settings.
@@ -15,9 +16,7 @@ public class GuiSettings implements Serializable {
     private static final double DEFAULT_HEIGHT = 600;
     private static final double DEFAULT_WIDTH = 740;
 
-    private static final String THEME_LIGHT = "light";
-    private static final String THEME_DARK = "dark";
-
+    private static final String DEFAULT_THEME_NAME = ThemeCollection.getDarkTheme().getThemeName();
     private final double windowWidth;
     private final double windowHeight;
     private final Point windowCoordinates;
@@ -30,7 +29,7 @@ public GuiSettings() {
         windowWidth = DEFAULT_WIDTH;
         windowHeight = DEFAULT_HEIGHT;
         windowCoordinates = null; // null represent no coordinates
-        theme = THEME_LIGHT;
+        theme = DEFAULT_THEME_NAME;
     }
 
     /**
@@ -39,7 +38,7 @@ public GuiSettings() {
     public GuiSettings(double windowWidth, double windowHeight, int xPosition, int yPosition, String theme) {
         this.windowWidth = windowWidth;
         this.windowHeight = windowHeight;
-        windowCoordinates = new Point(xPosition, yPosition);
+        this.windowCoordinates = new Point(xPosition, yPosition);
         this.theme = theme;
     }
 

src/main/java/scm/address/logic/commands/ThemeCommand.java

@@ -5,6 +5,7 @@
 import scm.address.commons.core.GuiSettings;
 import scm.address.logic.commands.exceptions.CommandException;
 import scm.address.model.Model;
+import scm.address.model.theme.Theme;
 
 
 /**
@@ -20,24 +21,29 @@ public class ThemeCommand extends Command {
             + "Example: " + COMMAND_WORD + " light\n"
             + "Supported themes: light, dark";
     public static final String MESSAGE_INVALID_THEME = "Invalid theme value";
-    private final String themeName;
+    private final Theme theme;
 
     /**
      * Creates a ThemeCommand to change the theme of the application.
      *
-     * @param themeName The name of the theme to change to.
+     * @param theme The theme to change to.
      */
-    public ThemeCommand(String themeName) {
-        assert themeName != null;
-        this.themeName = themeName;
+    public ThemeCommand(Theme theme) {
+        assert theme != null;
+        this.theme = theme;
+    }
+
+    public Theme getTheme() {
+        return theme;
     }
 
     @Override
     public CommandResult execute(Model model) throws CommandException {
         requireNonNull(model);
         GuiSettings guiSettings = model.getGuiSettings();
+
         model.setGuiSettings(new GuiSettings(guiSettings.getWindowWidth(), guiSettings.getWindowHeight(),
-                guiSettings.getWindowCoordinates().x, guiSettings.getWindowCoordinates().y, themeName));
+                guiSettings.getWindowCoordinates().x, guiSettings.getWindowCoordinates().y, theme.getThemeName()));
 
         return new CommandResult(String.format(MESSAGE_SUCCESS), false, false, true);
     }

src/main/java/scm/address/logic/parser/ThemeCommandParser.java

@@ -4,6 +4,8 @@
 
 import scm.address.logic.commands.ThemeCommand;
 import scm.address.logic.parser.exceptions.ParseException;
+import scm.address.model.theme.Theme;
+import scm.address.model.theme.ThemeCollection;
 
 
 /**
@@ -19,7 +21,7 @@ public ThemeCommand parse(String args) throws ParseException {
 
         String themeValue = argMultimap.getPreamble().trim();
 
-        String theme = "";
+        Theme theme;
         try {
             theme = parseTheme(themeValue);
         } catch (ParseException e) {
@@ -35,11 +37,17 @@ public ThemeCommand parse(String args) throws ParseException {
      * @return The theme.
      * @throws ParseException If the theme value is invalid.
      */
-    private String parseTheme(String theme) throws ParseException {
-        if (theme.equals("light") || theme.equals("dark")) {
-            return theme;
-        } else {
-            throw new ParseException("Invalid theme value");
+    private Theme parseTheme(String theme) throws ParseException {
+        String temp = theme.trim().toLowerCase();
+
+        switch (temp) {
+        case "light":
+            return ThemeCollection.getLightTheme();
+        case "dark":
+            return ThemeCollection.getDarkTheme();
+        default:
+            //Message does not matter as exception is caught and rethrown
+            throw new ParseException(ThemeCommand.MESSAGE_INVALID_THEME);
         }
     }
 }

src/main/java/scm/address/model/theme/DarkTheme.java

@@ -0,0 +1,36 @@
+package scm.address.model.theme;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+
+/**
+ * Represents the Dark Theme of the application.
+ */
+class DarkTheme implements Theme {
+    private static final String DARK_THEME_NAME = "dark";
+    private static final String DARK_THEME_CSS_PATH = "/view/DarkTheme.css";
+    private static final String DARK_THEME_EXTENSIONS_CSS_PATH = "/view/Extensions.css";
+    @JsonProperty
+    private String theme = "dark";
+
+    @Override
+    public String getThemeName() {
+        return DARK_THEME_NAME;
+    }
+
+    @Override
+    public String getThemeCssPath() {
+        return DARK_THEME_CSS_PATH;
+    }
+
+    @Override
+    public String getThemeExtensionsCssPath() {
+        return DARK_THEME_EXTENSIONS_CSS_PATH;
+    }
+
+    @Override
+    public boolean equals(Object obj) {
+        return obj instanceof DarkTheme;
+    }
+
+}

src/main/java/scm/address/model/theme/LightTheme.java

@@ -0,0 +1,31 @@
+package scm.address.model.theme;
+
+/**
+ * Represents the Light Theme of the application.
+ */
+class LightTheme implements Theme {
+    private static final String LIGHT_THEME_NAME = "light";
+    private static final String LIGHT_THEME_CSS_PATH = "/view/LightTheme.css";
+    private static final String LIGHT_THEME_EXTENSIONS_CSS_PATH = "/view/Extensions.css";
+
+
+    @Override
+    public String getThemeName() {
+        return LIGHT_THEME_NAME;
+    }
+
+    @Override
+    public String getThemeCssPath() {
+        return LIGHT_THEME_CSS_PATH;
+    }
+
+    @Override
+    public String getThemeExtensionsCssPath() {
+        return LIGHT_THEME_EXTENSIONS_CSS_PATH;
+    }
+
+    @Override
+    public boolean equals(Object obj) {
+        return obj instanceof LightTheme;
+    }
+}

src/main/java/scm/address/model/theme/Theme.java

@@ -0,0 +1,10 @@
+package scm.address.model.theme;
+
+/**
+ * Represents a Theme in the application.
+ */
+public interface Theme {
+    String getThemeName();
+    String getThemeCssPath();
+    String getThemeExtensionsCssPath();
+}

src/main/java/scm/address/model/theme/ThemeCollection.java

@@ -0,0 +1,30 @@
+package scm.address.model.theme;
+
+/**
+ * Contains the collection of themes available in the application.
+ */
+public class ThemeCollection {
+    public static final String MESSAGE_INVALID_THEME_NAME = "Invalid theme name provided.";
+    private static final Theme darkTheme = new DarkTheme();
+    private static final Theme lightTheme = new LightTheme();
+
+    public static Theme getDarkTheme() {
+        return darkTheme;
+    }
+
+    public static Theme getLightTheme() {
+        return lightTheme;
+    }
+
+    public static Theme getTheme(String themeName) throws IllegalArgumentException {
+        String temp = themeName.toLowerCase();
+
+        if (temp.equals(darkTheme.getThemeName())) {
+            return darkTheme;
+        } else if (temp.equals(lightTheme.getThemeName())) {
+            return lightTheme;
+        } else {
+            throw new IllegalArgumentException(MESSAGE_INVALID_THEME_NAME);
+        }
+    }
+}

src/main/java/scm/address/ui/MainWindow.java

@@ -1,5 +1,7 @@
 package scm.address.ui;
 
+import static java.util.Objects.requireNonNull;
+
 import java.util.logging.Logger;
 
 import javafx.event.ActionEvent;
@@ -17,6 +19,8 @@
 import scm.address.logic.commands.CommandResult;
 import scm.address.logic.commands.exceptions.CommandException;
 import scm.address.logic.parser.exceptions.ParseException;
+import scm.address.model.theme.Theme;
+import scm.address.model.theme.ThemeCollection;
 
 /**
  * The Main Window. Provides the basic application layout containing
@@ -206,27 +210,42 @@ private CommandResult executeCommand(String commandText) throws CommandException
         }
     }
 
+    /**
+     * Changes the theme of the application.
+     */
+    // GCOVR_EXCL_START
+    // This method cannot be tested as it works on the UI. It is excluded from testing.
     private void handleChangeTheme() {
 
-        String theme = logic.getGuiSettings().getTheme();
+        String themeName = logic.getGuiSettings().getTheme();
 
-        if (theme.equals("light")) {
-            setCss("view/LightTheme.css");
-        } else if (theme.equals("dark")) {
-            setCss("view/DarkTheme.css");
+        try {
+            Theme theme = ThemeCollection.getTheme(themeName);
+            setTheme(theme);
+        } catch (Exception e) {
+            logger.warning("Error changing theme: " + e.getMessage());
+            resultDisplay.setFeedbackToUser("Error changing theme: " + e.getMessage());
         }
     }
+    // GCOVR_EXCL_STOP
 
     /**
-     * Changes the CSS of the application.
+     * Changes the CSS of the application
      *
-     * @param cssFilePath The file path of the CSS file.
+     * @param theme The theme to be set
      */
-    public void setCss(String cssFilePath) {
-        System.out.println(cssFilePath);
+    // GCOVR_EXCL_START
+    // This method cannot be tested as it works on the UI. It is excluded from testing.
+    private void setTheme(Theme theme) {
+        requireNonNull(theme);
+
+        String cssFilePath = theme.getThemeCssPath();
+        String extensionsCssPath = theme.getThemeExtensionsCssPath();
+
         Scene scene = primaryStage.getScene();
         scene.getStylesheets().clear();
         scene.getStylesheets().add(cssFilePath);
-        scene.getStylesheets().add(EXTENSIONS_CSS_FILE_PATH);
+        scene.getStylesheets().add(extensionsCssPath);
     }
+    // GCOVR_EXCL_STOP
 }

src/main/resources/view/LightTheme.css

@@ -294,11 +294,11 @@
 }
 
 .scroll-bar {
-    -fx-background-color: derive(#99A98F, 20%);
+    -fx-background-color: derive(#e4e5f1, 20%);
 }
 
 .scroll-bar .thumb {
-    -fx-background-color: derive(#D6E8DB, 50%);
+    -fx-background-color: derive(#484b6a, 50%);
     -fx-background-insets: 3;
 }