From ad0e26e88238ddc9cc2b677f676e0c4a9051aa64 Mon Sep 17 00:00:00 2001
From: Jessica Syder <jam339@uclive.ac.nz>
Date: Wed, 30 Aug 2017 17:16:15 +1200
Subject: [PATCH 01/11] Created scene to view/update current key bindings.

- Current key bindings are shown on buttons
- Added button action events to store the clicked button
- Added key press event to entire pane
- Button text is updated to display its key
- Added functionality to keyFactory to update key bindings
- CSS styling for some components

#story[1197]
---
 .../Controllers/KeyBindingsController.java    | 116 ++++++++++++++++++
 .../src/main/java/visualiser/app/App.java     |  12 +-
 .../gameController/Keys/KeyFactory.java       |   8 ++
 .../src/main/resources/css/keyBindings.css    |  35 ++++++
 .../visualiser/scenes/keyBindings.fxml        |  25 ++++
 5 files changed, 192 insertions(+), 4 deletions(-)
 create mode 100644 racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java
 create mode 100644 racevisionGame/src/main/resources/css/keyBindings.css
 create mode 100644 racevisionGame/src/main/resources/visualiser/scenes/keyBindings.fxml

diff --git a/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java b/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java
new file mode 100644
index 00000000..77b6687f
--- /dev/null
+++ b/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java
@@ -0,0 +1,116 @@
+package visualiser.Controllers;
+
+import javafx.application.Platform;
+import javafx.collections.ObservableList;
+import javafx.event.ActionEvent;
+import javafx.event.EventHandler;
+import javafx.fxml.FXML;
+import javafx.scene.control.Button;
+import javafx.scene.control.Label;
+import javafx.scene.control.ListView;
+import javafx.scene.input.KeyEvent;
+import visualiser.gameController.Keys.ControlKey;
+import visualiser.gameController.Keys.KeyFactory;
+import java.util.Map;
+
+public class KeyBindingsController {
+    @FXML Button btnSave;
+    @FXML Button btnCancel;
+    @FXML Button btnReset;
+    @FXML ListView lstControl;
+    @FXML ListView lstKey;
+    @FXML ListView lstDescription;
+    @FXML Label lblTitle;
+    String currentButton = null;
+    KeyFactory keyFactory = KeyFactory.getFactory();
+
+    public void initialize(){
+
+        lstKey.getItems().add("Key");
+        lstControl.getItems().add("Command");
+        lstDescription.getItems().add("Description");
+
+
+
+        for (Map.Entry<String, ControlKey> entry : keyFactory.getKeyState().entrySet()) {
+            Button button = new Button(entry.getKey());
+            button.setMinWidth(120);
+            button.setOnAction(new EventHandler<ActionEvent>() {
+                @Override public void handle(ActionEvent e) {
+                    currentButton = button.getText();
+                    System.out.println("Button clicked");
+                }
+            });
+            lstKey.getItems().add(button);
+            lstControl.getItems().add(entry.getValue());
+            lstDescription.getItems().add(entry.getValue().getProtocolCode());
+        }
+
+        lstKey.getSelectionModel().select(0);
+        lstControl.getSelectionModel().select(0);
+        lstDescription.getSelectionModel().select(0);
+
+        lstKey.getSelectionModel().selectedItemProperty()
+                .addListener((observable, oldvalue, newValue) -> {
+                    Platform.runLater(new Runnable() {
+                        public void run() {
+                            lstKey.getSelectionModel().select(0);
+                        }
+                    });
+                });
+        lstDescription.getSelectionModel().selectedItemProperty()
+                .addListener((observable, oldvalue, newValue) -> {
+                    Platform.runLater(new Runnable() {
+                        public void run() {
+                            lstDescription.getSelectionModel().select(0);
+                        }
+                    });
+                });
+        lstControl.getSelectionModel().selectedItemProperty()
+                .addListener((observable, oldvalue, newValue) -> {
+                    Platform.runLater(new Runnable() {
+                        public void run() {
+                            lstControl.getSelectionModel().select(0);
+                        }
+                    });
+                });
+
+        lstKey.sceneProperty().addListener((obs, oldScene, newScene) -> {
+            if (newScene != null) {
+                newScene.getStylesheets().add("/css/keyBindings.css");
+            }
+
+        });
+    }
+
+    public void cancel(){
+        System.out.println("cancel clicked");
+    }
+
+    public void reset(){
+        System.out.println("reset clicked");
+    }
+
+    public void save(){
+        System.out.println("save clicked");
+    }
+
+    public void onKey(KeyEvent e){
+        System.out.println("key pressed");
+        // if a button was clicked
+        if (currentButton!=null){
+            // update text on the button
+            ObservableList buttons = lstKey.getItems();
+            for (int i = 1; i < buttons.size(); i++) {
+                if (currentButton == ((Button)buttons.get(i)).getText()) {
+                    ((Button)buttons.get(i)).setText(e.getCode().toString());
+                    break;
+                }
+            }
+            // update the control key
+            keyFactory.updateKey(currentButton, e.getCode().toString());
+            // remove current button selection
+            currentButton = null;
+        }
+    }
+}
diff --git a/racevisionGame/src/main/java/visualiser/app/App.java b/racevisionGame/src/main/java/visualiser/app/App.java
index eeae5a5d..92cb3096 100644
--- a/racevisionGame/src/main/java/visualiser/app/App.java
+++ b/racevisionGame/src/main/java/visualiser/app/App.java
@@ -3,7 +3,6 @@ package visualiser.app;
 import javafx.animation.FadeTransition;
 import javafx.application.Application;
 import javafx.application.Platform;
-import javafx.beans.property.ReadOnlyObjectProperty;
 import javafx.collections.FXCollections;
 import javafx.collections.ObservableList;
 import javafx.concurrent.Task;
@@ -15,7 +14,6 @@ import javafx.geometry.Rectangle2D;
 import javafx.scene.Parent;
 import javafx.scene.Scene;
 import javafx.scene.control.Label;
-import javafx.scene.control.ListView;
 import javafx.scene.control.ProgressBar;
 import javafx.scene.effect.DropShadow;
 import javafx.scene.image.Image;
@@ -30,8 +28,6 @@ import javafx.stage.WindowEvent;
 import javafx.util.Duration;
 import visualiser.Controllers.MainController;
 
-import java.io.IOException;
-
 public class App extends Application {
 
 
@@ -170,6 +166,14 @@ public class App extends Application {
                 System.exit(0);
             }
         });
+
+        // TODO: remove later, just for testing
+        Parent root2 = FXMLLoader.load(getClass().getResource
+                ("/visualiser/scenes/keyBindings.fxml"));
+        Stage stage2 = new Stage();
+        stage2.setScene(new Scene(root2));
+        stage2.centerOnScreen();
+        stage2.show();
     }
 
     /**
diff --git a/racevisionGame/src/main/java/visualiser/gameController/Keys/KeyFactory.java b/racevisionGame/src/main/java/visualiser/gameController/Keys/KeyFactory.java
index be95abd3..26267d84 100644
--- a/racevisionGame/src/main/java/visualiser/gameController/Keys/KeyFactory.java
+++ b/racevisionGame/src/main/java/visualiser/gameController/Keys/KeyFactory.java
@@ -48,4 +48,12 @@ public class KeyFactory {
         return keyState.get(key);
     }
 
+    public Map<String, ControlKey> getKeyState() {
+        return keyState;
+    }
+
+    public void updateKey(String oldKey, String newKey){
+        ControlKey controlKey = keyState.get(oldKey);
+        keyState.put(newKey, controlKey);
+    }
 }
diff --git a/racevisionGame/src/main/resources/css/keyBindings.css b/racevisionGame/src/main/resources/css/keyBindings.css
new file mode 100644
index 00000000..a1dc8242
--- /dev/null
+++ b/racevisionGame/src/main/resources/css/keyBindings.css
@@ -0,0 +1,35 @@
+.list-view .list-cell {
+    -fx-cell-size: 40;
+    -fx-font-family: "Tahoma";
+    -fx-background-color: #fffff0;
+    -fx-alignment: center;
+}
+
+.list-view .list-cell:even {
+    -fx-background-color: #ffffdc;
+}
+
+.list-view .list-cell:selected {
+    -fx-background-color: #f9e5c3;
+    -fx-font-family: "Comic Sans MS";
+    -fx-font-weight: bold;
+    -fx-font-size: 18;
+}
+
+.button {
+    -fx-background-color: linear-gradient(#acdeff 50%, #a9c8ff 100%);
+    -fx-background-radius: 4px;
+    -fx-border-radius: 4px;
+    -fx-text-fill: #242d35;
+    -fx-font-size: 12px;
+    -fx-font-family: "Courier New";
+}
+
+.button:focused {
+    -fx-background-color: white;
+    -fx-border-color: #0056bd;
+}
+
+#anchor {
+    -fx-background-color: #fdfac3;
+}
\ No newline at end of file
diff --git a/racevisionGame/src/main/resources/visualiser/scenes/keyBindings.fxml b/racevisionGame/src/main/resources/visualiser/scenes/keyBindings.fxml
new file mode 100644
index 00000000..9f881b21
--- /dev/null
+++ b/racevisionGame/src/main/resources/visualiser/scenes/keyBindings.fxml
@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<?import javafx.scene.control.Button?>
+<?import javafx.scene.control.Label?>
+<?import javafx.scene.control.ListView?>
+<?import javafx.scene.layout.AnchorPane?>
+<?import javafx.scene.text.Font?>
+
+<AnchorPane id="anchor" maxHeight="-Infinity" maxWidth="-Infinity"
+        minHeight="-Infinity"
+            minWidth="-Infinity" onKeyPressed="#onKey" prefHeight="471.0" prefWidth="600.0" xmlns="http://javafx.com/javafx/8.0.111" xmlns:fx="http://javafx.com/fxml/1" fx:controller="visualiser.Controllers.KeyBindingsController">
+   <children>
+      <Label fx:id="lblTitle" layoutX="172.0" layoutY="14.0" text="Key Bindings">
+         <font>
+            <Font name="Comic Sans MS" size="44.0" />
+         </font>
+      </Label>
+      <Button fx:id="btnCancel" layoutX="430.0" layoutY="428.0" mnemonicParsing="false" onAction="#cancel" prefWidth="160.0" text="Cancel" AnchorPane.bottomAnchor="18.0" AnchorPane.rightAnchor="20.0" />
+      <ListView fx:id="lstControl" focusTraversable="false" layoutX="27.0" layoutY="88.0" maxHeight="-Infinity" maxWidth="-Infinity" minHeight="-Infinity" minWidth="-Infinity" prefHeight="322.0" prefWidth="150.0" />
+      <ListView fx:id="lstKey" focusTraversable="false" layoutX="176.0" layoutY="88.0" maxHeight="-Infinity" maxWidth="-Infinity" minHeight="-Infinity" minWidth="-Infinity" prefHeight="322.0" prefWidth="150.0" />
+      <ListView fx:id="lstDescription" focusTraversable="false" layoutX="325.0" layoutY="88.0" prefHeight="322.0" prefWidth="250.0" />
+      <Button fx:id="btnSave" layoutX="220.0" layoutY="428.0" mnemonicParsing="false" onAction="#save" prefWidth="160.0" text="Save" AnchorPane.bottomAnchor="18.0" />
+      <Button fx:id="btnReset" layoutX="20.0" layoutY="428.0" mnemonicParsing="false" onAction="#reset" prefWidth="160.0" text="Reset to Default" AnchorPane.bottomAnchor="18.0" AnchorPane.leftAnchor="20.0" />
+   </children>
+</AnchorPane>

From 8250226bdec95461c6b5f6b480d3973edab4a22b Mon Sep 17 00:00:00 2001
From: Jessica Syder <jam339@uclive.ac.nz>
Date: Thu, 31 Aug 2017 15:00:37 +1200
Subject: [PATCH 02/11] Key bindings can be updated with any key.

- Changed key press from FXML key event to a listener
- UP, DOWN, ENTER keys now work
- Keys no longer change cells or press buttons
- Added placeholder buttons Cancel, Reset and Save
- Added some JavaDoc

#story[1197]
---
 .../Controllers/KeyBindingsController.java    | 65 +++++++++++--------
 .../gameController/Keys/KeyFactory.java       |  6 ++
 .../visualiser/scenes/keyBindings.fxml        |  4 +-
 3 files changed, 46 insertions(+), 29 deletions(-)

diff --git a/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java b/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java
index 77b6687f..356430a0 100644
--- a/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java
+++ b/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java
@@ -6,13 +6,16 @@ import javafx.event.ActionEvent;
 import javafx.event.EventHandler;
 import javafx.fxml.FXML;
 import javafx.scene.control.Button;
-import javafx.scene.control.Label;
 import javafx.scene.control.ListView;
 import javafx.scene.input.KeyEvent;
+import javafx.scene.layout.AnchorPane;
 import visualiser.gameController.Keys.ControlKey;
 import visualiser.gameController.Keys.KeyFactory;
 import java.util.Map;
 
+/**
+ * Controller for the scene used to display and update current key bindings.
+ */
 public class KeyBindingsController {
     @FXML Button btnSave;
     @FXML Button btnCancel;
@@ -20,18 +23,21 @@ public class KeyBindingsController {
     @FXML ListView lstControl;
     @FXML ListView lstKey;
     @FXML ListView lstDescription;
-    @FXML Label lblTitle;
+    @FXML AnchorPane anchor;
     String currentButton = null;
     KeyFactory keyFactory = KeyFactory.getFactory();
 
     public void initialize(){
 
+        // headings for each column
         lstKey.getItems().add("Key");
         lstControl.getItems().add("Command");
         lstDescription.getItems().add("Description");
+        lstKey.getSelectionModel().select(0);
+        lstControl.getSelectionModel().select(0);
+        lstDescription.getSelectionModel().select(0);
 
-
-
+        // populate columns with current key bindings and buttons to update
         for (Map.Entry<String, ControlKey> entry : keyFactory.getKeyState().entrySet()) {
             Button button = new Button(entry.getKey());
             button.setMinWidth(120);
@@ -46,10 +52,7 @@ public class KeyBindingsController {
             lstDescription.getItems().add(entry.getValue().getProtocolCode());
         }
 
-        lstKey.getSelectionModel().select(0);
-        lstControl.getSelectionModel().select(0);
-        lstDescription.getSelectionModel().select(0);
-
+        // stop the columns from being selectable, so only the buttons are
         lstKey.getSelectionModel().selectedItemProperty()
                 .addListener((observable, oldvalue, newValue) -> {
                     Platform.runLater(new Runnable() {
@@ -75,11 +78,39 @@ public class KeyBindingsController {
                     });
                 });
 
+        // add CSS stylesheet once the scene has been created
         lstKey.sceneProperty().addListener((obs, oldScene, newScene) -> {
             if (newScene != null) {
                 newScene.getStylesheets().add("/css/keyBindings.css");
             }
+        });
+
+        setKeyListener();
+    }
 
+    /**
+     * Creates a listener for the base anchorpane for key presses.
+     * It updates the current key bindings if required.
+     */
+    public void setKeyListener(){
+        anchor.addEventFilter(KeyEvent.KEY_PRESSED, event -> {
+            // if a button was clicked
+            if (currentButton != null) {
+                // update text on the button
+                ObservableList buttons = lstKey.getItems();
+                for (int i = 1; i < buttons.size(); i++) {
+                    if (currentButton == ((Button)buttons.get(i)).getText()) {
+                        ((Button)buttons.get(i)).setText(event.getCode().toString
+                                ());
+                        break;
+                    }
+                }
+                // update the control key
+                keyFactory.updateKey(currentButton, event.getCode().toString());
+                // remove current button selection
+                currentButton = null;
+            }
+            event.consume();
         });
     }
 
@@ -95,22 +126,4 @@ public class KeyBindingsController {
         System.out.println("save clicked");
     }
 
-    public void onKey(KeyEvent e){
-        System.out.println("key pressed");
-        // if a button was clicked
-        if (currentButton!=null){
-            // update text on the button
-            ObservableList buttons = lstKey.getItems();
-            for (int i = 1; i < buttons.size(); i++) {
-                if (currentButton == ((Button)buttons.get(i)).getText()) {
-                    ((Button)buttons.get(i)).setText(e.getCode().toString());
-                    break;
-                }
-            }
-            // update the control key
-            keyFactory.updateKey(currentButton, e.getCode().toString());
-            // remove current button selection
-            currentButton = null;
-        }
-    }
 }
diff --git a/racevisionGame/src/main/java/visualiser/gameController/Keys/KeyFactory.java b/racevisionGame/src/main/java/visualiser/gameController/Keys/KeyFactory.java
index 26267d84..555cafff 100644
--- a/racevisionGame/src/main/java/visualiser/gameController/Keys/KeyFactory.java
+++ b/racevisionGame/src/main/java/visualiser/gameController/Keys/KeyFactory.java
@@ -52,8 +52,14 @@ public class KeyFactory {
         return keyState;
     }
 
+    /**
+     * Update the key bound to a particular command in the keystate.
+     * @param oldKey the existing key to updated
+     * @param newKey the new key value to replace the old
+     */
     public void updateKey(String oldKey, String newKey){
         ControlKey controlKey = keyState.get(oldKey);
+        keyState.remove(oldKey, controlKey);
         keyState.put(newKey, controlKey);
     }
 }
diff --git a/racevisionGame/src/main/resources/visualiser/scenes/keyBindings.fxml b/racevisionGame/src/main/resources/visualiser/scenes/keyBindings.fxml
index 9f881b21..6ce15890 100644
--- a/racevisionGame/src/main/resources/visualiser/scenes/keyBindings.fxml
+++ b/racevisionGame/src/main/resources/visualiser/scenes/keyBindings.fxml
@@ -6,9 +6,7 @@
 <?import javafx.scene.layout.AnchorPane?>
 <?import javafx.scene.text.Font?>
 
-<AnchorPane id="anchor" maxHeight="-Infinity" maxWidth="-Infinity"
-        minHeight="-Infinity"
-            minWidth="-Infinity" onKeyPressed="#onKey" prefHeight="471.0" prefWidth="600.0" xmlns="http://javafx.com/javafx/8.0.111" xmlns:fx="http://javafx.com/fxml/1" fx:controller="visualiser.Controllers.KeyBindingsController">
+<AnchorPane id="anchor" fx:id="anchor" maxHeight="-Infinity" maxWidth="-Infinity" minHeight="-Infinity" minWidth="-Infinity" prefHeight="471.0" prefWidth="600.0" xmlns="http://javafx.com/javafx/8.0.111" xmlns:fx="http://javafx.com/fxml/1" fx:controller="visualiser.Controllers.KeyBindingsController">
    <children>
       <Label fx:id="lblTitle" layoutX="172.0" layoutY="14.0" text="Key Bindings">
          <font>

From 2188ddc3a328403c5764cd63c488b14d586d10b9 Mon Sep 17 00:00:00 2001
From: Jessica Syder <jam339@uclive.ac.nz>
Date: Thu, 31 Aug 2017 21:59:28 +1200
Subject: [PATCH 03/11] Fixed errors in making the keybinding replaceable.

- Changed KeyFactory to not be a singleton
- Simplified keyBindings initializer
- Modified and simplified keyListener
- Added method to copy existing keyState
- Changed button events
- Changed to newer lambda functions
- Modified updateKey method
- Left option for multiple keys bound to one command
- Updated and wrote new JavaDoc

#story[1197]
---
 .../Controllers/KeyBindingsController.java    | 141 ++++++++++--------
 .../Controllers/RaceController.java           |   5 +-
 .../src/main/java/visualiser/app/App.java     |   2 +
 .../gameController/InputChecker.java          |   5 +-
 .../gameController/Keys/DownWindKey.java      |   6 +-
 .../gameController/Keys/KeyFactory.java       |  48 +++---
 .../gameController/Keys/SailsToggleKey.java   |   6 +-
 .../gameController/Keys/TackGybeKey.java      |   6 +-
 .../gameController/Keys/UpWindKey.java        |   6 +-
 .../gameController/Keys/VMGKey.java           |   7 +-
 .../gameController/Keys/ZoomInKey.java        |   4 +-
 .../gameController/Keys/ZoomOutKey.java       |   6 +-
 12 files changed, 120 insertions(+), 122 deletions(-)

diff --git a/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java b/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java
index 356430a0..528f3869 100644
--- a/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java
+++ b/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java
@@ -1,9 +1,6 @@
 package visualiser.Controllers;
 
 import javafx.application.Platform;
-import javafx.collections.ObservableList;
-import javafx.event.ActionEvent;
-import javafx.event.EventHandler;
 import javafx.fxml.FXML;
 import javafx.scene.control.Button;
 import javafx.scene.control.ListView;
@@ -11,25 +8,40 @@ import javafx.scene.input.KeyEvent;
 import javafx.scene.layout.AnchorPane;
 import visualiser.gameController.Keys.ControlKey;
 import visualiser.gameController.Keys.KeyFactory;
+
+import java.util.HashMap;
 import java.util.Map;
 
+import static visualiser.app.App.keyFactory;
+
 /**
  * Controller for the scene used to display and update current key bindings.
  */
 public class KeyBindingsController {
-    @FXML Button btnSave;
-    @FXML Button btnCancel;
-    @FXML Button btnReset;
-    @FXML ListView lstControl;
-    @FXML ListView lstKey;
-    @FXML ListView lstDescription;
-    @FXML AnchorPane anchor;
-    String currentButton = null;
-    KeyFactory keyFactory = KeyFactory.getFactory();
+    private @FXML Button btnSave;
+    private @FXML Button btnCancel;
+    private @FXML Button btnReset;
+    private @FXML ListView lstControl;
+    private @FXML ListView lstKey;
+    private @FXML ListView lstDescription;
+    private @FXML AnchorPane anchor;
+    private Button currentButton = null;
+    private KeyFactory newKeyFactory;
 
     public void initialize(){
+        // create new key factory to modify, keeping the existing one safe
+        newKeyFactory = copyExistingFactory();
+        initializeTable();
+        populateTable();
+        setKeyListener();
+    }
 
-        // headings for each column
+    /**
+     * Sets up table before populating it.
+     * Set up includes headings, CSS styling and modifying default properties.
+     */
+    public void initializeTable(){
+        // set the headings for each column
         lstKey.getItems().add("Key");
         lstControl.getItems().add("Command");
         lstDescription.getItems().add("Description");
@@ -37,47 +49,6 @@ public class KeyBindingsController {
         lstControl.getSelectionModel().select(0);
         lstDescription.getSelectionModel().select(0);
 
-        // populate columns with current key bindings and buttons to update
-        for (Map.Entry<String, ControlKey> entry : keyFactory.getKeyState().entrySet()) {
-            Button button = new Button(entry.getKey());
-            button.setMinWidth(120);
-            button.setOnAction(new EventHandler<ActionEvent>() {
-                @Override public void handle(ActionEvent e) {
-                    currentButton = button.getText();
-                    System.out.println("Button clicked");
-                }
-            });
-            lstKey.getItems().add(button);
-            lstControl.getItems().add(entry.getValue());
-            lstDescription.getItems().add(entry.getValue().getProtocolCode());
-        }
-
-        // stop the columns from being selectable, so only the buttons are
-        lstKey.getSelectionModel().selectedItemProperty()
-                .addListener((observable, oldvalue, newValue) -> {
-                    Platform.runLater(new Runnable() {
-                        public void run() {
-                            lstKey.getSelectionModel().select(0);
-                        }
-                    });
-                });
-        lstDescription.getSelectionModel().selectedItemProperty()
-                .addListener((observable, oldvalue, newValue) -> {
-                    Platform.runLater(new Runnable() {
-                        public void run() {
-                            lstDescription.getSelectionModel().select(0);
-                        }
-                    });
-                });
-        lstControl.getSelectionModel().selectedItemProperty()
-                .addListener((observable, oldvalue, newValue) -> {
-                    Platform.runLater(new Runnable() {
-                        public void run() {
-                            lstControl.getSelectionModel().select(0);
-                        }
-                    });
-                });
-
         // add CSS stylesheet once the scene has been created
         lstKey.sceneProperty().addListener((obs, oldScene, newScene) -> {
             if (newScene != null) {
@@ -85,7 +56,54 @@ public class KeyBindingsController {
             }
         });
 
-        setKeyListener();
+        // stop the columns from being selectable, so only the buttons are
+        lstKey.getSelectionModel().selectedItemProperty()
+                .addListener((observable, oldvalue, newValue) ->
+                        Platform.runLater(() ->
+                        lstKey.getSelectionModel().select(0)));
+        lstDescription.getSelectionModel().selectedItemProperty()
+                .addListener((observable, oldvalue, newValue) ->
+                        Platform.runLater(() ->
+                        lstDescription.getSelectionModel().select(0)));
+        lstControl.getSelectionModel().selectedItemProperty()
+                .addListener((observable, oldvalue, newValue) ->
+                        Platform.runLater(() ->
+                        lstControl.getSelectionModel().select(0)));
+    }
+
+    /**
+     * Populates the table with commands and their key binding details.
+     */
+    public void populateTable(){
+        // add each command to the table
+        for (Map.Entry<String, ControlKey> entry : newKeyFactory.getKeyState().entrySet()) {
+            // create button for command
+            Button button = new Button(entry.getKey());
+            button.setMinWidth(120);
+            button.setId(entry.getValue().toString());
+            button.setOnAction(e -> currentButton = button);
+            // display details for command in table
+            lstControl.getItems().add(entry.getValue());
+            lstKey.getItems().add(button);
+            lstDescription.getItems().add(entry.getValue().getProtocolCode());
+        }
+    }
+
+    /**
+     * Makes a copy of the keyfactory that does not modify the original.
+     * @return new keyfactory to be modified
+     */
+    public KeyFactory copyExistingFactory(){
+        newKeyFactory = new KeyFactory();
+        Map<String, ControlKey> newKeyState = newKeyFactory.getKeyState();
+        Map<String, ControlKey> oldKeyState = keyFactory.getKeyState();
+        newKeyState = new HashMap<>();  // clear default keys
+
+        // copy over commands and their keys
+        for (Map.Entry<String, ControlKey> entry : oldKeyState.entrySet()){
+            newKeyState.put(entry.getKey(), entry.getValue());
+        }
+        return newKeyFactory;
     }
 
     /**
@@ -96,17 +114,12 @@ public class KeyBindingsController {
         anchor.addEventFilter(KeyEvent.KEY_PRESSED, event -> {
             // if a button was clicked
             if (currentButton != null) {
+                System.out.println("button is clicked");
                 // update text on the button
-                ObservableList buttons = lstKey.getItems();
-                for (int i = 1; i < buttons.size(); i++) {
-                    if (currentButton == ((Button)buttons.get(i)).getText()) {
-                        ((Button)buttons.get(i)).setText(event.getCode().toString
-                                ());
-                        break;
-                    }
-                }
+                currentButton.setText(event.getCode().toString());
                 // update the control key
-                keyFactory.updateKey(currentButton, event.getCode().toString());
+                newKeyFactory.updateKey(event.getCode().toString(),
+                        currentButton.getId());
                 // remove current button selection
                 currentButton = null;
             }
diff --git a/racevisionGame/src/main/java/visualiser/Controllers/RaceController.java b/racevisionGame/src/main/java/visualiser/Controllers/RaceController.java
index 4fcda581..395b4a6b 100644
--- a/racevisionGame/src/main/java/visualiser/Controllers/RaceController.java
+++ b/racevisionGame/src/main/java/visualiser/Controllers/RaceController.java
@@ -10,7 +10,6 @@ import javafx.collections.transformation.SortedList;
 import javafx.fxml.FXML;
 import javafx.scene.chart.LineChart;
 import javafx.scene.control.*;
-import javafx.scene.control.Label;
 import javafx.scene.input.KeyCode;
 import javafx.scene.input.KeyEvent;
 import javafx.scene.layout.AnchorPane;
@@ -23,7 +22,6 @@ import shared.model.Leg;
 import visualiser.app.App;
 import visualiser.gameController.ControllerClient;
 import visualiser.gameController.Keys.ControlKey;
-import visualiser.gameController.Keys.KeyFactory;
 import visualiser.model.*;
 
 import java.io.IOException;
@@ -33,6 +31,7 @@ import java.util.ResourceBundle;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
+import static visualiser.app.App.keyFactory;
 
 
 /**
@@ -113,7 +112,7 @@ public class RaceController extends Controller {
 
     @Override
     public void initialize(URL location, ResourceBundle resources) {
-        KeyFactory keyFactory = KeyFactory.getFactory();
+//        KeyFactory keyFactory = KeyFactory.getFactory();
         infoTableShow = true;
 
         // Initialise keyboard handler
diff --git a/racevisionGame/src/main/java/visualiser/app/App.java b/racevisionGame/src/main/java/visualiser/app/App.java
index 92cb3096..9a1a7132 100644
--- a/racevisionGame/src/main/java/visualiser/app/App.java
+++ b/racevisionGame/src/main/java/visualiser/app/App.java
@@ -27,6 +27,7 @@ import javafx.stage.StageStyle;
 import javafx.stage.WindowEvent;
 import javafx.util.Duration;
 import visualiser.Controllers.MainController;
+import visualiser.gameController.Keys.KeyFactory;
 
 public class App extends Application {
 
@@ -37,6 +38,7 @@ public class App extends Application {
     private Label progressText;
     private static final int SPLASH_WIDTH = 676;
     private static final int SPLASH_HEIGHT = 227;
+    public static KeyFactory keyFactory = new KeyFactory();
 
     public static App app;
 
diff --git a/racevisionGame/src/main/java/visualiser/gameController/InputChecker.java b/racevisionGame/src/main/java/visualiser/gameController/InputChecker.java
index 057b5721..b4b3de9b 100644
--- a/racevisionGame/src/main/java/visualiser/gameController/InputChecker.java
+++ b/racevisionGame/src/main/java/visualiser/gameController/InputChecker.java
@@ -3,10 +3,11 @@ package visualiser.gameController;
 import javafx.animation.AnimationTimer;
 import javafx.scene.Scene;
 import visualiser.gameController.Keys.ControlKey;
-import visualiser.gameController.Keys.KeyFactory;
 
 import java.util.HashMap;
 
+import static visualiser.app.App.keyFactory;
+
 /**
  * Class for checking what keys are currently being used
  */
@@ -18,7 +19,7 @@ public class InputChecker {
      * @param scene Scene the controller is to run in parallel with.
      */
     public void runWithScene(Scene scene){
-        KeyFactory keyFactory = KeyFactory.getFactory();
+//        KeyFactory keyFactory = KeyFactory.getFactory();
 
         scene.setOnKeyPressed(event -> {
             String codeString = event.getCode().toString();
diff --git a/racevisionGame/src/main/java/visualiser/gameController/Keys/DownWindKey.java b/racevisionGame/src/main/java/visualiser/gameController/Keys/DownWindKey.java
index e4b5455a..6c974972 100644
--- a/racevisionGame/src/main/java/visualiser/gameController/Keys/DownWindKey.java
+++ b/racevisionGame/src/main/java/visualiser/gameController/Keys/DownWindKey.java
@@ -9,11 +9,9 @@ public class DownWindKey extends ControlKey {
 
     /**
      * Constructor for Control
-     *  @param name    name of the key
-     *
      */
-    public DownWindKey(String name) {
-        super(name, BoatActionEnum.DOWNWIND);
+    public DownWindKey() {
+        super("Downwind", BoatActionEnum.DOWNWIND);
     }
 
     @Override
diff --git a/racevisionGame/src/main/java/visualiser/gameController/Keys/KeyFactory.java b/racevisionGame/src/main/java/visualiser/gameController/Keys/KeyFactory.java
index 555cafff..d896f6c6 100644
--- a/racevisionGame/src/main/java/visualiser/gameController/Keys/KeyFactory.java
+++ b/racevisionGame/src/main/java/visualiser/gameController/Keys/KeyFactory.java
@@ -13,30 +13,17 @@ public class KeyFactory {
     private Map<String, ControlKey> keyState;
 
     /**
-     * Singleton instance to enforce consistent key state
+     * Constructor for key state, set up initial state of each action.
      */
-    private static KeyFactory theFactory = new KeyFactory();
-
-    /**
-     * Singleton constructor for key state, set up initial state of each action.
-     */
-    private KeyFactory() {
+    public KeyFactory() {
         this.keyState = new HashMap<>();
-        keyState.put("Z", new ZoomInKey("Zoom In"));
-        keyState.put("X", new ZoomOutKey("Zoom Out"));
-        keyState.put("SPACE", new VMGKey("VMG"));
-        keyState.put("SHIFT", new SailsToggleKey("Toggle Sails"));
-        keyState.put("ENTER", new TackGybeKey("Tack/Gybe"));
-        keyState.put("UP", new UpWindKey("Upwind"));
-        keyState.put("DOWN", new DownWindKey("Downwind"));
-    }
-
-    /**
-     * Get singleton instance of KeyFactory to interact with key state
-     * @return automatically constructed KeyFactory
-     */
-    public static KeyFactory getFactory() {
-        return theFactory;
+        keyState.put("Z", new ZoomInKey());
+        keyState.put("X", new ZoomOutKey());
+        keyState.put("SPACE", new VMGKey());
+        keyState.put("SHIFT", new SailsToggleKey());
+        keyState.put("ENTER", new TackGybeKey());
+        keyState.put("UP", new UpWindKey());
+        keyState.put("DOWN", new DownWindKey());
     }
 
     /**
@@ -54,12 +41,21 @@ public class KeyFactory {
 
     /**
      * Update the key bound to a particular command in the keystate.
-     * @param oldKey the existing key to updated
-     * @param newKey the new key value to replace the old
+     * @param newKey the new key value for the command
+     * @param command the command to be updated
      */
-    public void updateKey(String oldKey, String newKey){
-        ControlKey controlKey = keyState.get(oldKey);
+    public void updateKey(String newKey, String command){
+        ControlKey controlKey = null;
+        String oldKey = null;
+        for (Map.Entry<String, ControlKey> entry : keyState.entrySet()) {
+            // if this is the correct command
+            if (entry.getValue().toString()==command){
+                controlKey = entry.getValue();
+                oldKey = entry.getKey();
+            }
+        }
         keyState.remove(oldKey, controlKey);
         keyState.put(newKey, controlKey);
     }
+
 }
diff --git a/racevisionGame/src/main/java/visualiser/gameController/Keys/SailsToggleKey.java b/racevisionGame/src/main/java/visualiser/gameController/Keys/SailsToggleKey.java
index f1e4d65b..a04b7d77 100644
--- a/racevisionGame/src/main/java/visualiser/gameController/Keys/SailsToggleKey.java
+++ b/racevisionGame/src/main/java/visualiser/gameController/Keys/SailsToggleKey.java
@@ -10,11 +10,9 @@ public class SailsToggleKey extends ControlKey {
 
     /**
      * Constructor for Control
-     *  @param name    name of the key
-     *
      */
-    public SailsToggleKey(String name) {
-        super(name, BoatActionEnum.NOT_A_STATUS);
+    public SailsToggleKey() {
+        super("Toggle Sails", BoatActionEnum.NOT_A_STATUS);
     }
 
     /**
diff --git a/racevisionGame/src/main/java/visualiser/gameController/Keys/TackGybeKey.java b/racevisionGame/src/main/java/visualiser/gameController/Keys/TackGybeKey.java
index 80252e73..5c164443 100644
--- a/racevisionGame/src/main/java/visualiser/gameController/Keys/TackGybeKey.java
+++ b/racevisionGame/src/main/java/visualiser/gameController/Keys/TackGybeKey.java
@@ -9,11 +9,9 @@ public class TackGybeKey extends ControlKey {
 
     /**
      * Constructor for Control
-     *  @param name    name of the key
-     *
      */
-    public TackGybeKey(String name) {
-        super(name, BoatActionEnum.TACK_GYBE);
+    public TackGybeKey() {
+        super("Tack/Gybe", BoatActionEnum.TACK_GYBE);
     }
 
     @Override
diff --git a/racevisionGame/src/main/java/visualiser/gameController/Keys/UpWindKey.java b/racevisionGame/src/main/java/visualiser/gameController/Keys/UpWindKey.java
index 333e5f1f..b4bbf489 100644
--- a/racevisionGame/src/main/java/visualiser/gameController/Keys/UpWindKey.java
+++ b/racevisionGame/src/main/java/visualiser/gameController/Keys/UpWindKey.java
@@ -9,11 +9,9 @@ public class UpWindKey extends ControlKey {
 
     /**
      * Constructor for Control
-     *  @param name    name of the key
-     *
      */
-    public UpWindKey(String name) {
-        super(name, BoatActionEnum.UPWIND);
+    public UpWindKey() {
+        super("Upwind", BoatActionEnum.UPWIND);
     }
 
     @Override
diff --git a/racevisionGame/src/main/java/visualiser/gameController/Keys/VMGKey.java b/racevisionGame/src/main/java/visualiser/gameController/Keys/VMGKey.java
index c01658bb..2c7237f0 100644
--- a/racevisionGame/src/main/java/visualiser/gameController/Keys/VMGKey.java
+++ b/racevisionGame/src/main/java/visualiser/gameController/Keys/VMGKey.java
@@ -1,6 +1,5 @@
 package visualiser.gameController.Keys;
 
-import javafx.scene.input.KeyCode;
 import network.Messages.Enums.BoatActionEnum;
 
 /**
@@ -10,11 +9,9 @@ public class VMGKey extends ControlKey{
 
     /**
      * Constructor for Control
-     *
-     * @param name    name of the key
      */
-    public VMGKey(String name) {
-        super(name, BoatActionEnum.AUTO_PILOT);
+    public VMGKey() {
+        super("VMG", BoatActionEnum.AUTO_PILOT);
     }
 
     @Override
diff --git a/racevisionGame/src/main/java/visualiser/gameController/Keys/ZoomInKey.java b/racevisionGame/src/main/java/visualiser/gameController/Keys/ZoomInKey.java
index 51f98a58..e9a8ad7b 100644
--- a/racevisionGame/src/main/java/visualiser/gameController/Keys/ZoomInKey.java
+++ b/racevisionGame/src/main/java/visualiser/gameController/Keys/ZoomInKey.java
@@ -5,8 +5,8 @@ package visualiser.gameController.Keys;
  */
 public class ZoomInKey extends ControlKey {
 
-    public ZoomInKey(String name) {
-        super(name);
+    public ZoomInKey() {
+        super("Zoom In");
     }
 
     @Override
diff --git a/racevisionGame/src/main/java/visualiser/gameController/Keys/ZoomOutKey.java b/racevisionGame/src/main/java/visualiser/gameController/Keys/ZoomOutKey.java
index 6da2210c..cbba97fc 100644
--- a/racevisionGame/src/main/java/visualiser/gameController/Keys/ZoomOutKey.java
+++ b/racevisionGame/src/main/java/visualiser/gameController/Keys/ZoomOutKey.java
@@ -7,11 +7,9 @@ public class ZoomOutKey extends ControlKey{
 
     /**
      * Constructor for Control
-     *  @param name    name of the key
-     *
      */
-    public ZoomOutKey(String name) {
-        super(name);
+    public ZoomOutKey() {
+        super("Zoom Out");
     }
 
     @Override

From ce47b0d81369645e58233339c657e436fe526493 Mon Sep 17 00:00:00 2001
From: Jessica Syder <jam339@uclive.ac.nz>
Date: Thu, 31 Aug 2017 22:28:55 +1200
Subject: [PATCH 04/11] When a new key is bound other commands bound to this
 key are removed

- On binding new key existing keys are searched
- If key is in use the old one is removed
- ControlKey is updated with a placeholder key value

#story[1197]
---
 .../visualiser/Controllers/KeyBindingsController.java  | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java b/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java
index 528f3869..621e91ef 100644
--- a/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java
+++ b/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java
@@ -114,7 +114,15 @@ public class KeyBindingsController {
         anchor.addEventFilter(KeyEvent.KEY_PRESSED, event -> {
             // if a button was clicked
             if (currentButton != null) {
-                System.out.println("button is clicked");
+                // check if a button is already mapped to this key
+                for (int i = 1; i < lstKey.getItems().size(); i++) {
+                    Button button = (Button)lstKey.getItems().get(i);
+                    // update buttons text and remove key binding from command
+                    if (button.getText() == event.getCode().toString()) {
+                        button.setText("");
+                        newKeyFactory.updateKey(button.getId(), button.getId());
+                    }
+                }
                 // update text on the button
                 currentButton.setText(event.getCode().toString());
                 // update the control key

From 278fb65852ccc0fa900e860221fbd74e87e4f6c7 Mon Sep 17 00:00:00 2001
From: Jessica Syder <jam339@uclive.ac.nz>
Date: Thu, 31 Aug 2017 22:39:19 +1200
Subject: [PATCH 05/11] Pressing ESC cancels the selected command's key from
 being replaced

- focus is shifted away on esc
- focus is shifted away after successful change

#story[1197]
---
 .../visualiser/Controllers/KeyBindingsController.java    | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java b/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java
index 621e91ef..aa8cf66f 100644
--- a/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java
+++ b/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java
@@ -4,6 +4,7 @@ import javafx.application.Platform;
 import javafx.fxml.FXML;
 import javafx.scene.control.Button;
 import javafx.scene.control.ListView;
+import javafx.scene.input.KeyCode;
 import javafx.scene.input.KeyEvent;
 import javafx.scene.layout.AnchorPane;
 import visualiser.gameController.Keys.ControlKey;
@@ -112,8 +113,13 @@ public class KeyBindingsController {
      */
     public void setKeyListener(){
         anchor.addEventFilter(KeyEvent.KEY_PRESSED, event -> {
+            // if esc, cancel current button click
+            if (event.getCode() == KeyCode.ESCAPE){
+                btnCancel.requestFocus();
+                currentButton = null;
+            }
             // if a button was clicked
-            if (currentButton != null) {
+            else if (currentButton != null) {
                 // check if a button is already mapped to this key
                 for (int i = 1; i < lstKey.getItems().size(); i++) {
                     Button button = (Button)lstKey.getItems().get(i);
@@ -130,6 +136,7 @@ public class KeyBindingsController {
                         currentButton.getId());
                 // remove current button selection
                 currentButton = null;
+                btnCancel.requestFocus();
             }
             event.consume();
         });

From 3e720a9e16d69b310dfbe7574235dc0eace6ccec Mon Sep 17 00:00:00 2001
From: Jessica Syder <jam339@uclive.ac.nz>
Date: Thu, 31 Aug 2017 22:47:57 +1200
Subject: [PATCH 06/11] Modified key bindings can be saved to use in a race.

- new key bindings replace old new bindings on save
- javadoc save method and small updates

#story[1197]
---
 .../visualiser/Controllers/KeyBindingsController.java  | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java b/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java
index aa8cf66f..5822179c 100644
--- a/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java
+++ b/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java
@@ -91,7 +91,7 @@ public class KeyBindingsController {
     }
 
     /**
-     * Makes a copy of the keyfactory that does not modify the original.
+     * Makes a copy of the {@link KeyFactory} that does not modify the original.
      * @return new keyfactory to be modified
      */
     public KeyFactory copyExistingFactory(){
@@ -109,7 +109,8 @@ public class KeyBindingsController {
 
     /**
      * Creates a listener for the base anchorpane for key presses.
-     * It updates the current key bindings if required.
+     * It updates the current key bindings of the {@link KeyFactory} if
+     * required.
      */
     public void setKeyListener(){
         anchor.addEventFilter(KeyEvent.KEY_PRESSED, event -> {
@@ -150,8 +151,11 @@ public class KeyBindingsController {
         System.out.println("reset clicked");
     }
 
+    /**
+     * Replace existing {@link KeyFactory} with the modified key bindings.
+     */
     public void save(){
-        System.out.println("save clicked");
+        keyFactory = newKeyFactory;
     }
 
 }

From 716a99aac77c2f17d7441903a78c2f26ccbaafb7 Mon Sep 17 00:00:00 2001
From: Jessica Syder <jam339@uclive.ac.nz>
Date: Thu, 31 Aug 2017 22:58:35 +1200
Subject: [PATCH 07/11] Reset to default button is now functional.

- keybindings are reset to built in default
- the table is cleared and reloaded

#story[1197]
---
 .../visualiser/Controllers/KeyBindingsController.java  | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java b/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java
index 5822179c..d43f22eb 100644
--- a/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java
+++ b/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java
@@ -147,8 +147,16 @@ public class KeyBindingsController {
         System.out.println("cancel clicked");
     }
 
+    /**
+     * Resets all key bindings to the built-in defaults.
+     */
     public void reset(){
-        System.out.println("reset clicked");
+        lstKey.getItems().clear();
+        lstControl.getItems().clear();
+        lstDescription.getItems().clear();
+        newKeyFactory = new KeyFactory();
+        initializeTable();
+        populateTable();
     }
 
     /**

From 086206a6237052e325182479d596745873be6388 Mon Sep 17 00:00:00 2001
From: David Wu <zwu18@uclive.ac.nz>
Date: Fri, 1 Sep 2017 13:44:09 +1200
Subject: [PATCH 08/11] Controls button in title screen now opens the key
 mapping menu. #story[1197]

---
 .../main/java/visualiser/Controllers/TitleController.java | 2 +-
 racevisionGame/src/main/java/visualiser/app/App.java      | 8 --------
 2 files changed, 1 insertion(+), 9 deletions(-)

diff --git a/racevisionGame/src/main/java/visualiser/Controllers/TitleController.java b/racevisionGame/src/main/java/visualiser/Controllers/TitleController.java
index 32e033c8..94fff748 100644
--- a/racevisionGame/src/main/java/visualiser/Controllers/TitleController.java
+++ b/racevisionGame/src/main/java/visualiser/Controllers/TitleController.java
@@ -89,7 +89,7 @@ public class TitleController extends Controller {
      */
     public void controlBtnPressed(){
         FXMLLoader loader = new FXMLLoader();
-        loader.setLocation(getClass().getResource("/visualiser/scenes/controls.fxml"));
+        loader.setLocation(getClass().getResource("/visualiser/scenes/keyBindings.fxml"));
         Parent layout;
         try {
             layout = loader.load();
diff --git a/racevisionGame/src/main/java/visualiser/app/App.java b/racevisionGame/src/main/java/visualiser/app/App.java
index 9a1a7132..ac063b94 100644
--- a/racevisionGame/src/main/java/visualiser/app/App.java
+++ b/racevisionGame/src/main/java/visualiser/app/App.java
@@ -168,14 +168,6 @@ public class App extends Application {
                 System.exit(0);
             }
         });
-
-        // TODO: remove later, just for testing
-        Parent root2 = FXMLLoader.load(getClass().getResource
-                ("/visualiser/scenes/keyBindings.fxml"));
-        Stage stage2 = new Stage();
-        stage2.setScene(new Scene(root2));
-        stage2.centerOnScreen();
-        stage2.show();
     }
 
     /**

From 3fdfbd83e0c28755d5ac6f5b18798462cf004672 Mon Sep 17 00:00:00 2001
From: Jessica Syder <jam339@uclive.ac.nz>
Date: Fri, 1 Sep 2017 14:29:18 +1200
Subject: [PATCH 09/11] User can save, reset or cancel.

- Created a notification popups for errors
- Added functionality to save, cancel and reset buttons
- Key bindings are only saved if they're valid
- Added window close event
- Can not exit without saving correctly
- CSS to cancel, save and reset buttons to differentiate between key buttons
- Javadocd

#story[1197]
---
 .../Controllers/KeyBindingsController.java    | 88 +++++++++++++++++--
 .../Controllers/NotificationController.java   | 35 ++++++++
 .../Controllers/TitleController.java          | 26 ++++++
 .../gameController/Keys/KeyFactory.java       |  4 +
 .../src/main/resources/css/keyBindings.css    | 10 +++
 .../visualiser/scenes/keyBindings.fxml        |  7 +-
 .../visualiser/scenes/notification.fxml       | 19 ++++
 7 files changed, 180 insertions(+), 9 deletions(-)
 create mode 100644 racevisionGame/src/main/java/visualiser/Controllers/NotificationController.java
 create mode 100644 racevisionGame/src/main/resources/visualiser/scenes/notification.fxml

diff --git a/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java b/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java
index d43f22eb..d19a4f5d 100644
--- a/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java
+++ b/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java
@@ -2,14 +2,20 @@ package visualiser.Controllers;
 
 import javafx.application.Platform;
 import javafx.fxml.FXML;
+import javafx.fxml.FXMLLoader;
+import javafx.scene.Parent;
+import javafx.scene.Scene;
 import javafx.scene.control.Button;
 import javafx.scene.control.ListView;
 import javafx.scene.input.KeyCode;
 import javafx.scene.input.KeyEvent;
 import javafx.scene.layout.AnchorPane;
+import javafx.stage.Modality;
+import javafx.stage.Stage;
+import javafx.stage.WindowEvent;
 import visualiser.gameController.Keys.ControlKey;
 import visualiser.gameController.Keys.KeyFactory;
-
+import java.io.IOException;
 import java.util.HashMap;
 import java.util.Map;
 
@@ -26,8 +32,9 @@ public class KeyBindingsController {
     private @FXML ListView lstKey;
     private @FXML ListView lstDescription;
     private @FXML AnchorPane anchor;
-    private Button currentButton = null;
+    private Button currentButton = null;    // last button clicked
     private KeyFactory newKeyFactory;
+    private Boolean changed = false;    // keybindings have been modified
 
     public void initialize(){
         // create new key factory to modify, keeping the existing one safe
@@ -96,14 +103,14 @@ public class KeyBindingsController {
      */
     public KeyFactory copyExistingFactory(){
         newKeyFactory = new KeyFactory();
-        Map<String, ControlKey> newKeyState = newKeyFactory.getKeyState();
         Map<String, ControlKey> oldKeyState = keyFactory.getKeyState();
-        newKeyState = new HashMap<>();  // clear default keys
+        Map<String, ControlKey> newKeyState = new HashMap<>();
 
         // copy over commands and their keys
         for (Map.Entry<String, ControlKey> entry : oldKeyState.entrySet()){
             newKeyState.put(entry.getKey(), entry.getValue());
         }
+        newKeyFactory.setKeyState(newKeyState);
         return newKeyFactory;
     }
 
@@ -137,14 +144,20 @@ public class KeyBindingsController {
                         currentButton.getId());
                 // remove current button selection
                 currentButton = null;
+                changed = true;
                 btnCancel.requestFocus();
             }
             event.consume();
         });
     }
 
+    /**
+     * Cancel and exits the key bindings menu. Changes are not forced to be
+     * saved or fixed if invalid, and instead are defaulted back to the last
+     * successful saved state.
+     */
     public void cancel(){
-        System.out.println("cancel clicked");
+        ((Stage)btnCancel.getScene().getWindow()).close();
     }
 
     /**
@@ -157,13 +170,76 @@ public class KeyBindingsController {
         newKeyFactory = new KeyFactory();
         initializeTable();
         populateTable();
+        changed = true;
     }
 
     /**
      * Replace existing {@link KeyFactory} with the modified key bindings.
      */
     public void save(){
-        keyFactory = newKeyFactory;
+        if (isFactoryValid()) {
+            keyFactory = newKeyFactory;
+            newKeyFactory = new KeyFactory();
+            changed = false;
+            loadNotification("Key bindings were successfully saved.", false);
+        } else {
+            loadNotification("One or more key bindings are missing. " +
+                    "Failed to save.", true);
+        }
+    }
+
+    /**
+     * Checks the {@link KeyFactory} being modified is valid and that no
+     * commands are missing a key binding.
+     * @return True if valid, false if invalid
+     */
+    public Boolean isFactoryValid(){
+        for (Map.Entry<String, ControlKey> entry : newKeyFactory.getKeyState().entrySet
+                ()) {
+            if (entry.getKey().toString()==entry.getValue().toString()){
+                return false;
+            }
+        }
+        return true;
+    }
+
+    /**
+     * Method used to stop a user from exiting key bindings without saving
+     * their changes to the {@link KeyFactory}.
+     * @param we {@link WindowEvent} close request to be consumed if settings
+     *                             have not been successfully saved.
+     */
+    public void onExit(WindowEvent we){
+        // if modified KeyFactory hasn't been saved
+        if (keyFactory!=newKeyFactory && changed==true){
+            loadNotification("Please cancel or save your changes before exiting" +
+                    ".", true);
+            we.consume();
+        }
+    }
+
+    /**
+     * Loads a popup window giving confirmation/warning of user activity.
+     * @param message the message to be displayed to the user
+     * @param warning true if the message to be displayed is due to user error
+     */
+    public void loadNotification(String message, Boolean warning){
+        Parent root = null;
+        FXMLLoader loader = new FXMLLoader(getClass().getResource
+                ("/visualiser/scenes/notification.fxml"));
+        try {
+            root = loader.load();
+        } catch (IOException e) {
+            e.printStackTrace();
+        }
+        NotificationController controller = loader.getController();
+        Stage stage = new Stage();
+        stage.setScene(new Scene(root));
+        stage.centerOnScreen();
+        stage.initModality(Modality.APPLICATION_MODAL);
+        stage.show();
+        // displays given message in the window
+        controller.setMessage(message, warning);
     }
 
 }
diff --git a/racevisionGame/src/main/java/visualiser/Controllers/NotificationController.java b/racevisionGame/src/main/java/visualiser/Controllers/NotificationController.java
new file mode 100644
index 00000000..d122ec80
--- /dev/null
+++ b/racevisionGame/src/main/java/visualiser/Controllers/NotificationController.java
@@ -0,0 +1,35 @@
+package visualiser.Controllers;
+
+import javafx.fxml.FXML;
+import javafx.scene.control.Label;
+import javafx.scene.paint.Color;
+import javafx.scene.text.Text;
+import javafx.stage.Stage;
+
+/**
+ * Controller for a popup notification regarding user activity.
+ */
+public class NotificationController {
+    private @FXML Label lblDescription;
+    private @FXML Text txtMessage;
+
+    /**
+     * Closes the popup window once clicked.
+     */
+    public void ok(){
+        ((Stage)lblDescription.getScene().getWindow()).close();
+    }
+
+    /**
+     * Displays the appropriate popup notification.
+     * @param message message for the user
+     * @param warning if true warning text shown, if false success text shown
+     */
+    public void setMessage(String message, Boolean warning){
+        lblDescription.setText(message);
+        if (!warning){
+            txtMessage.setText("Success!");
+            txtMessage.setFill(Color.GREEN);
+        }
+    }
+}
diff --git a/racevisionGame/src/main/java/visualiser/Controllers/TitleController.java b/racevisionGame/src/main/java/visualiser/Controllers/TitleController.java
index 94fff748..21e3dcc7 100644
--- a/racevisionGame/src/main/java/visualiser/Controllers/TitleController.java
+++ b/racevisionGame/src/main/java/visualiser/Controllers/TitleController.java
@@ -1,5 +1,6 @@
 package visualiser.Controllers;
 
+import javafx.event.EventHandler;
 import javafx.fxml.FXML;
 import javafx.fxml.FXMLLoader;
 import javafx.scene.Parent;
@@ -9,6 +10,7 @@ import javafx.scene.control.RadioButton;
 import javafx.scene.layout.AnchorPane;
 import javafx.stage.Modality;
 import javafx.stage.Stage;
+import javafx.stage.WindowEvent;
 import visualiser.app.App;
 
 import java.io.IOException;
@@ -88,6 +90,22 @@ public class TitleController extends Controller {
      * Called when control button is pressed. New pop up window displaying controls
      */
     public void controlBtnPressed(){
+
+//        Parent root2 = loader2.load();
+//        KeyBindingsController controller = loader2.getController();
+//        Stage stage2 = new Stage();
+//        stage2.setScene(new Scene(root2));
+//        stage2.centerOnScreen();
+//        stage2.initModality(Modality.APPLICATION_MODAL);
+//        stage2.show();
+//        stage2.setOnCloseRequest(new EventHandler<WindowEvent>() {
+//            public void handle(WindowEvent we) {
+//                if (we.getEventType() == WindowEvent.WINDOW_CLOSE_REQUEST) {
+//                    controller.onExit(we);
+//                }
+//            }
+//        });
+
         FXMLLoader loader = new FXMLLoader();
         loader.setLocation(getClass().getResource("/visualiser/scenes/keyBindings.fxml"));
         Parent layout;
@@ -100,6 +118,14 @@ public class TitleController extends Controller {
             popupStage.initModality(Modality.WINDOW_MODAL);
             popupStage.setScene(scene);
             popupStage.showAndWait();
+            KeyBindingsController controller = loader.getController();
+            popupStage.setOnCloseRequest(new EventHandler<WindowEvent>() {
+                public void handle(WindowEvent we) {
+                    if (we.getEventType() == WindowEvent.WINDOW_CLOSE_REQUEST) {
+                        controller.onExit(we);
+                    }
+                }
+            });
         } catch (Exception  e){
             e.printStackTrace();
         }
diff --git a/racevisionGame/src/main/java/visualiser/gameController/Keys/KeyFactory.java b/racevisionGame/src/main/java/visualiser/gameController/Keys/KeyFactory.java
index d896f6c6..ecf0b1af 100644
--- a/racevisionGame/src/main/java/visualiser/gameController/Keys/KeyFactory.java
+++ b/racevisionGame/src/main/java/visualiser/gameController/Keys/KeyFactory.java
@@ -39,6 +39,10 @@ public class KeyFactory {
         return keyState;
     }
 
+    public void setKeyState(Map<String, ControlKey> keyState) {
+        this.keyState = keyState;
+    }
+
     /**
      * Update the key bound to a particular command in the keystate.
      * @param newKey the new key value for the command
diff --git a/racevisionGame/src/main/resources/css/keyBindings.css b/racevisionGame/src/main/resources/css/keyBindings.css
index a1dc8242..a572116e 100644
--- a/racevisionGame/src/main/resources/css/keyBindings.css
+++ b/racevisionGame/src/main/resources/css/keyBindings.css
@@ -23,6 +23,7 @@
     -fx-text-fill: #242d35;
     -fx-font-size: 12px;
     -fx-font-family: "Courier New";
+    -fx-border-color: #a9c8ff;
 }
 
 .button:focused {
@@ -32,4 +33,13 @@
 
 #anchor {
     -fx-background-color: #fdfac3;
+}
+#menu{
+    -fx-background-color: linear-gradient(#acdeff 50%, #a9c8ff 100%);
+    -fx-background-radius: 4px;
+    -fx-border-radius: 4px;
+    -fx-text-fill: #242d35;
+    -fx-font-size: 12px;
+    -fx-font-family: "Verdana";
+    -fx-border-color: #a9c8ff;
 }
\ No newline at end of file
diff --git a/racevisionGame/src/main/resources/visualiser/scenes/keyBindings.fxml b/racevisionGame/src/main/resources/visualiser/scenes/keyBindings.fxml
index 6ce15890..40217567 100644
--- a/racevisionGame/src/main/resources/visualiser/scenes/keyBindings.fxml
+++ b/racevisionGame/src/main/resources/visualiser/scenes/keyBindings.fxml
@@ -13,11 +13,12 @@
             <Font name="Comic Sans MS" size="44.0" />
          </font>
       </Label>
-      <Button fx:id="btnCancel" layoutX="430.0" layoutY="428.0" mnemonicParsing="false" onAction="#cancel" prefWidth="160.0" text="Cancel" AnchorPane.bottomAnchor="18.0" AnchorPane.rightAnchor="20.0" />
+      <Button id="menu" fx:id="btnCancel" layoutX="430.0" layoutY="428.0"
+              mnemonicParsing="false" onAction="#cancel" prefWidth="160.0" text="Cancel" AnchorPane.bottomAnchor="18.0" AnchorPane.rightAnchor="20.0" />
       <ListView fx:id="lstControl" focusTraversable="false" layoutX="27.0" layoutY="88.0" maxHeight="-Infinity" maxWidth="-Infinity" minHeight="-Infinity" minWidth="-Infinity" prefHeight="322.0" prefWidth="150.0" />
       <ListView fx:id="lstKey" focusTraversable="false" layoutX="176.0" layoutY="88.0" maxHeight="-Infinity" maxWidth="-Infinity" minHeight="-Infinity" minWidth="-Infinity" prefHeight="322.0" prefWidth="150.0" />
       <ListView fx:id="lstDescription" focusTraversable="false" layoutX="325.0" layoutY="88.0" prefHeight="322.0" prefWidth="250.0" />
-      <Button fx:id="btnSave" layoutX="220.0" layoutY="428.0" mnemonicParsing="false" onAction="#save" prefWidth="160.0" text="Save" AnchorPane.bottomAnchor="18.0" />
-      <Button fx:id="btnReset" layoutX="20.0" layoutY="428.0" mnemonicParsing="false" onAction="#reset" prefWidth="160.0" text="Reset to Default" AnchorPane.bottomAnchor="18.0" AnchorPane.leftAnchor="20.0" />
+      <Button id="menu" fx:id="btnSave" layoutX="220.0" layoutY="428.0" mnemonicParsing="false" onAction="#save" prefWidth="160.0" text="Save" AnchorPane.bottomAnchor="18.0" />
+      <Button id="menu" fx:id="btnReset" layoutX="20.0" layoutY="428.0" mnemonicParsing="false" onAction="#reset" prefWidth="160.0" text="Reset to Default" AnchorPane.bottomAnchor="18.0" AnchorPane.leftAnchor="20.0" />
    </children>
 </AnchorPane>
diff --git a/racevisionGame/src/main/resources/visualiser/scenes/notification.fxml b/racevisionGame/src/main/resources/visualiser/scenes/notification.fxml
new file mode 100644
index 00000000..0e4a7c5b
--- /dev/null
+++ b/racevisionGame/src/main/resources/visualiser/scenes/notification.fxml
@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<?import javafx.scene.control.Button?>
+<?import javafx.scene.control.Label?>
+<?import javafx.scene.layout.Pane?>
+<?import javafx.scene.text.Font?>
+<?import javafx.scene.text.Text?>
+
+<Pane maxHeight="-Infinity" maxWidth="-Infinity" minHeight="-Infinity" minWidth="-Infinity" prefHeight="100.0" prefWidth="300.0" xmlns="http://javafx.com/javafx/8.0.111" xmlns:fx="http://javafx.com/fxml/1" fx:controller="visualiser.Controllers.NotificationController">
+   <children>
+      <Button fx:id="btnOk" layoutX="110.0" layoutY="65.0" mnemonicParsing="false" onAction="#ok" prefWidth="80.0" text="Ok" />
+      <Text fx:id="txtMessage" fill="RED" layoutY="23.0" strokeType="OUTSIDE" strokeWidth="0.0" text="Warning!" textAlignment="CENTER" wrappingWidth="300.0">
+         <font>
+            <Font name="System Bold" size="14.0" />
+         </font>
+      </Text>
+      <Label fx:id="lblDescription" alignment="CENTER" layoutY="36.0" prefHeight="17.0" prefWidth="300.0" textAlignment="CENTER" />
+   </children>
+</Pane>

From cfa6fc37e0a0cf04a7ed4998d4482dcc94d1ef4a Mon Sep 17 00:00:00 2001
From: Jessica Syder <jam339@uclive.ac.nz>
Date: Sun, 3 Sep 2017 20:44:27 +1200
Subject: [PATCH 10/11] User modified keybindings are persistently saved

- Works on windows computers
- KeyFactory processes its own XML saving/loading
- Does not work with Jar yet
- Changed keyFactory to static temporarily to work with existing FXML loading architecture

#story[1197]
---
 .../Controllers/KeyBindingsController.java    | 10 +++--
 .../Controllers/TitleController.java          | 26 +++--------
 .../src/main/java/visualiser/app/App.java     |  4 +-
 .../gameController/Keys/KeyFactory.java       | 43 +++++++++++++++++++
 .../visualiser/userSettings/keyFactory.xml    | 33 ++++++++++++++
 5 files changed, 89 insertions(+), 27 deletions(-)
 create mode 100644 racevisionGame/src/main/resources/visualiser/userSettings/keyFactory.xml

diff --git a/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java b/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java
index d19a4f5d..84d82e91 100644
--- a/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java
+++ b/racevisionGame/src/main/java/visualiser/Controllers/KeyBindingsController.java
@@ -15,6 +15,7 @@ import javafx.stage.Stage;
 import javafx.stage.WindowEvent;
 import visualiser.gameController.Keys.ControlKey;
 import visualiser.gameController.Keys.KeyFactory;
+
 import java.io.IOException;
 import java.util.HashMap;
 import java.util.Map;
@@ -32,9 +33,9 @@ public class KeyBindingsController {
     private @FXML ListView lstKey;
     private @FXML ListView lstDescription;
     private @FXML AnchorPane anchor;
-    private Button currentButton = null;    // last button clicked
     private KeyFactory newKeyFactory;
-    private Boolean changed = false;    // keybindings have been modified
+    private Boolean changed = false;    // keyBindings have been modified
+    private Button currentButton = null;    // last button clicked
 
     public void initialize(){
         // create new key factory to modify, keeping the existing one safe
@@ -132,7 +133,7 @@ public class KeyBindingsController {
                 for (int i = 1; i < lstKey.getItems().size(); i++) {
                     Button button = (Button)lstKey.getItems().get(i);
                     // update buttons text and remove key binding from command
-                    if (button.getText() == event.getCode().toString()) {
+                    if (button.getText().equals(event.getCode().toString())) {
                         button.setText("");
                         newKeyFactory.updateKey(button.getId(), button.getId());
                     }
@@ -181,6 +182,7 @@ public class KeyBindingsController {
             keyFactory = newKeyFactory;
             newKeyFactory = new KeyFactory();
             changed = false;
+            keyFactory.save();  // save persistently
             loadNotification("Key bindings were successfully saved.", false);
         } else {
             loadNotification("One or more key bindings are missing. " +
@@ -211,7 +213,7 @@ public class KeyBindingsController {
      */
     public void onExit(WindowEvent we){
         // if modified KeyFactory hasn't been saved
-        if (keyFactory!=newKeyFactory && changed==true){
+        if (changed){
             loadNotification("Please cancel or save your changes before exiting" +
                     ".", true);
             we.consume();
diff --git a/racevisionGame/src/main/java/visualiser/Controllers/TitleController.java b/racevisionGame/src/main/java/visualiser/Controllers/TitleController.java
index 21e3dcc7..57b4c44d 100644
--- a/racevisionGame/src/main/java/visualiser/Controllers/TitleController.java
+++ b/racevisionGame/src/main/java/visualiser/Controllers/TitleController.java
@@ -90,34 +90,18 @@ public class TitleController extends Controller {
      * Called when control button is pressed. New pop up window displaying controls
      */
     public void controlBtnPressed(){
-
-//        Parent root2 = loader2.load();
-//        KeyBindingsController controller = loader2.getController();
-//        Stage stage2 = new Stage();
-//        stage2.setScene(new Scene(root2));
-//        stage2.centerOnScreen();
-//        stage2.initModality(Modality.APPLICATION_MODAL);
-//        stage2.show();
-//        stage2.setOnCloseRequest(new EventHandler<WindowEvent>() {
-//            public void handle(WindowEvent we) {
-//                if (we.getEventType() == WindowEvent.WINDOW_CLOSE_REQUEST) {
-//                    controller.onExit(we);
-//                }
-//            }
-//        });
-
-        FXMLLoader loader = new FXMLLoader();
-        loader.setLocation(getClass().getResource("/visualiser/scenes/keyBindings.fxml"));
-        Parent layout;
         try {
-            layout = loader.load();
+            FXMLLoader loader = new FXMLLoader();
+            loader.setLocation(getClass().getResource("/visualiser/scenes/keyBindings.fxml"));
+            Parent layout = loader.load();
             Scene scene = new Scene(layout);
             Stage popupStage = new Stage();
             popupStage.setResizable(false);
             popupStage.setTitle("Game Controls");
             popupStage.initModality(Modality.WINDOW_MODAL);
+            popupStage.centerOnScreen();
             popupStage.setScene(scene);
-            popupStage.showAndWait();
+            popupStage.show();
             KeyBindingsController controller = loader.getController();
             popupStage.setOnCloseRequest(new EventHandler<WindowEvent>() {
                 public void handle(WindowEvent we) {
diff --git a/racevisionGame/src/main/java/visualiser/app/App.java b/racevisionGame/src/main/java/visualiser/app/App.java
index ac063b94..cc3b0e1e 100644
--- a/racevisionGame/src/main/java/visualiser/app/App.java
+++ b/racevisionGame/src/main/java/visualiser/app/App.java
@@ -31,7 +31,6 @@ import visualiser.gameController.Keys.KeyFactory;
 
 public class App extends Application {
 
-
     private static Stage stage;
     private Pane splashLayout;
     private ProgressBar loadProgress;
@@ -39,7 +38,6 @@ public class App extends Application {
     private static final int SPLASH_WIDTH = 676;
     private static final int SPLASH_HEIGHT = 227;
     public static KeyFactory keyFactory = new KeyFactory();
-
     public static App app;
 
     /**
@@ -53,6 +51,8 @@ public class App extends Application {
 
     @Override
     public void init() {
+        keyFactory.load();
+
         ImageView splash = new ImageView(new Image(
                 getClass().getClassLoader().getResourceAsStream("images/splashScreen.png")
         ));
diff --git a/racevisionGame/src/main/java/visualiser/gameController/Keys/KeyFactory.java b/racevisionGame/src/main/java/visualiser/gameController/Keys/KeyFactory.java
index ecf0b1af..b4d55201 100644
--- a/racevisionGame/src/main/java/visualiser/gameController/Keys/KeyFactory.java
+++ b/racevisionGame/src/main/java/visualiser/gameController/Keys/KeyFactory.java
@@ -1,5 +1,9 @@
 package visualiser.gameController.Keys;
 
+import java.beans.XMLDecoder;
+import java.beans.XMLEncoder;
+import java.io.*;
+import java.net.URISyntaxException;
 import java.util.HashMap;
 import java.util.Map;
 
@@ -62,4 +66,43 @@ public class KeyFactory {
         keyState.put(newKey, controlKey);
     }
 
+    /**
+     * Persistently saves the keybindings the user has set.
+     */
+    public void save(){
+        try {
+            XMLEncoder encoder = new XMLEncoder(new BufferedOutputStream(
+                    new FileOutputStream(getClass().getResource(
+                            "/visualiser/userSettings/keyFactory.xml")
+                            .toURI().getPath())));
+            encoder.writeObject(this.keyState);
+            encoder.close();
+        } catch (FileNotFoundException e) {
+            e.printStackTrace();
+        } catch (URISyntaxException e) {
+            e.printStackTrace();
+        }
+    }
+
+    /**
+     * Loads the persistently saved keybindings the user has set.
+     */
+    public void load(){
+        try {
+            XMLDecoder decoder = new XMLDecoder(new BufferedInputStream(
+                    new FileInputStream(getClass().getResource(
+                            "/visualiser/userSettings/keyFactory.xml")
+                            .toURI().getPath())));
+
+            Map<String, ControlKey> savedKeyState
+                    = (Map<String, ControlKey>)decoder.readObject();
+            decoder.close();
+            this.keyState = savedKeyState;
+        } catch (FileNotFoundException e) {
+            e.printStackTrace();
+        } catch (URISyntaxException e) {
+            e.printStackTrace();
+        }
+    }
+
 }
diff --git a/racevisionGame/src/main/resources/visualiser/userSettings/keyFactory.xml b/racevisionGame/src/main/resources/visualiser/userSettings/keyFactory.xml
new file mode 100644
index 00000000..ae05a188
--- /dev/null
+++ b/racevisionGame/src/main/resources/visualiser/userSettings/keyFactory.xml
@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<java version="1.8.0_121" class="java.beans.XMLDecoder">
+    <object class="java.util.HashMap">
+        <void method="put">
+            <string>SPACE</string>
+            <object class="visualiser.gameController.Keys.VMGKey"/>
+        </void>
+        <void method="put">
+            <string>SHIFT</string>
+            <object class="visualiser.gameController.Keys.SailsToggleKey"/>
+        </void>
+        <void method="put">
+            <string>DOWN</string>
+            <object class="visualiser.gameController.Keys.DownWindKey"/>
+        </void>
+        <void method="put">
+            <string>X</string>
+            <object class="visualiser.gameController.Keys.ZoomOutKey"/>
+        </void>
+        <void method="put">
+            <string>ENTER</string>
+            <object class="visualiser.gameController.Keys.TackGybeKey"/>
+        </void>
+        <void method="put">
+            <string>Z</string>
+            <object class="visualiser.gameController.Keys.ZoomInKey"/>
+        </void>
+        <void method="put">
+            <string>UP</string>
+            <object class="visualiser.gameController.Keys.UpWindKey"/>
+        </void>
+    </object>
+</java>
\ No newline at end of file

From 85eb66d508fca2a93ce9f2b11735e809d4ea8ecd Mon Sep 17 00:00:00 2001
From: Jessica Syder <jam339@uclive.ac.nz>
Date: Mon, 4 Sep 2017 12:30:01 +1200
Subject: [PATCH 11/11] Keybindings can be saved and loaded, and work when
 Jar'd!

- trying to solve jar file reading issue
- learnt a lot about jars including their lack of file structure
- changed location of keybindings settings to outside of jar
- added new folder/file that is generated on first run

#story[1197]
---
 .../src/main/java/visualiser/app/App.java     |  1 +
 .../gameController/Keys/KeyFactory.java       | 47 ++++++++++++-------
 .../visualiser/userSettings/keyFactory.xml    | 33 -------------
 3 files changed, 32 insertions(+), 49 deletions(-)
 delete mode 100644 racevisionGame/src/main/resources/visualiser/userSettings/keyFactory.xml

diff --git a/racevisionGame/src/main/java/visualiser/app/App.java b/racevisionGame/src/main/java/visualiser/app/App.java
index cc3b0e1e..186bc094 100644
--- a/racevisionGame/src/main/java/visualiser/app/App.java
+++ b/racevisionGame/src/main/java/visualiser/app/App.java
@@ -51,6 +51,7 @@ public class App extends Application {
 
     @Override
     public void init() {
+        // load the user's personalised key bindings
         keyFactory.load();
 
         ImageView splash = new ImageView(new Image(
diff --git a/racevisionGame/src/main/java/visualiser/gameController/Keys/KeyFactory.java b/racevisionGame/src/main/java/visualiser/gameController/Keys/KeyFactory.java
index b4d55201..a783f268 100644
--- a/racevisionGame/src/main/java/visualiser/gameController/Keys/KeyFactory.java
+++ b/racevisionGame/src/main/java/visualiser/gameController/Keys/KeyFactory.java
@@ -3,7 +3,6 @@ package visualiser.gameController.Keys;
 import java.beans.XMLDecoder;
 import java.beans.XMLEncoder;
 import java.io.*;
-import java.net.URISyntaxException;
 import java.util.HashMap;
 import java.util.Map;
 
@@ -71,16 +70,15 @@ public class KeyFactory {
      */
     public void save(){
         try {
-            XMLEncoder encoder = new XMLEncoder(new BufferedOutputStream(
-                    new FileOutputStream(getClass().getResource(
-                            "/visualiser/userSettings/keyFactory.xml")
-                            .toURI().getPath())));
-            encoder.writeObject(this.keyState);
-            encoder.close();
+            // open the filestream and write to it
+            FileOutputStream fos = new FileOutputStream(
+                    System.getProperty("user.dir")+
+                            "/settings/keyBindings.xml");
+            XMLEncoder xmlEncoder = new XMLEncoder(fos);
+            xmlEncoder.writeObject(this.keyState);
+            xmlEncoder.close();
         } catch (FileNotFoundException e) {
             e.printStackTrace();
-        } catch (URISyntaxException e) {
-            e.printStackTrace();
         }
     }
 
@@ -89,18 +87,35 @@ public class KeyFactory {
      */
     public void load(){
         try {
-            XMLDecoder decoder = new XMLDecoder(new BufferedInputStream(
-                    new FileInputStream(getClass().getResource(
-                            "/visualiser/userSettings/keyFactory.xml")
-                            .toURI().getPath())));
+            // access settings folder, create if it doesn't exist
+            File settingsFolder = new File(
+                    System.getProperty("user.dir")+"/settings");
+            if (!settingsFolder.exists()){
+                settingsFolder.mkdir();
+            }
 
+            // access keybindings xml file, create if it doesn't exist
+            File savedFile = new File(
+                    settingsFolder+"/keyBindings.xml");
+            if (!savedFile.exists()){
+                savedFile.createNewFile();
+                FileOutputStream fos = new FileOutputStream(savedFile);
+                XMLEncoder xmlEncoder = new XMLEncoder(fos);
+                xmlEncoder.writeObject(this.keyState);
+                xmlEncoder.close();
+            }
+
+            // load the saved settings into the game
+            InputStream is = new FileInputStream(savedFile);
+            XMLDecoder xmlDecoder = new XMLDecoder(is);
             Map<String, ControlKey> savedKeyState
-                    = (Map<String, ControlKey>)decoder.readObject();
-            decoder.close();
+                    = (Map<String, ControlKey>)xmlDecoder.readObject();
+            xmlDecoder.close();
             this.keyState = savedKeyState;
+
         } catch (FileNotFoundException e) {
             e.printStackTrace();
-        } catch (URISyntaxException e) {
+        } catch (IOException e) {
             e.printStackTrace();
         }
     }
diff --git a/racevisionGame/src/main/resources/visualiser/userSettings/keyFactory.xml b/racevisionGame/src/main/resources/visualiser/userSettings/keyFactory.xml
deleted file mode 100644
index ae05a188..00000000
--- a/racevisionGame/src/main/resources/visualiser/userSettings/keyFactory.xml
+++ /dev/null
@@ -1,33 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<java version="1.8.0_121" class="java.beans.XMLDecoder">
-    <object class="java.util.HashMap">
-        <void method="put">
-            <string>SPACE</string>
-            <object class="visualiser.gameController.Keys.VMGKey"/>
-        </void>
-        <void method="put">
-            <string>SHIFT</string>
-            <object class="visualiser.gameController.Keys.SailsToggleKey"/>
-        </void>
-        <void method="put">
-            <string>DOWN</string>
-            <object class="visualiser.gameController.Keys.DownWindKey"/>
-        </void>
-        <void method="put">
-            <string>X</string>
-            <object class="visualiser.gameController.Keys.ZoomOutKey"/>
-        </void>
-        <void method="put">
-            <string>ENTER</string>
-            <object class="visualiser.gameController.Keys.TackGybeKey"/>
-        </void>
-        <void method="put">
-            <string>Z</string>
-            <object class="visualiser.gameController.Keys.ZoomInKey"/>
-        </void>
-        <void method="put">
-            <string>UP</string>
-            <object class="visualiser.gameController.Keys.UpWindKey"/>
-        </void>
-    </object>
-</java>
\ No newline at end of file