Restructured ui

.gitignore

@@ -14,3 +14,5 @@ config.json
 src/main/resources/updater/updater*.jar
 src/test/data/sandbox/
 preferences.json
+data/addressbook.xml
+.$TEMP_ADDRESS_BOOK

src/main/java/address/controller/BaseUiPart.java

@@ -0,0 +1,105 @@
+package address.controller;
+
+import address.events.BaseEvent;
+import address.events.EventManager;
+import address.util.AppUtil;
+import javafx.scene.Node;
+import javafx.scene.Scene;
+import javafx.scene.layout.AnchorPane;
+import javafx.stage.Modality;
+import javafx.stage.Stage;
+
+/**
+ * Base class for UI parts.
+ * A 'UI part' represents a distinct par of the UI. e.g. Windows, dialogs, panels, status bars, etc.
+ */
+public abstract class BaseUiPart {
+
+    /**
+     * The primary stage for the UI Part.
+     */
+    Stage primaryStage;
+
+    public BaseUiPart(){
+        EventManager.getInstance().registerHandler(this);
+    }
+
+    /**
+     * Raises the even via {@link EventManager#post(BaseEvent)}
+     * @param event
+     */
+    protected void raise(BaseEvent event){
+        EventManager.getInstance().post(event);
+    }
+
+    /**
+     * Raises an event via {@link EventManager#postPotentialEvent(BaseEvent)}
+     * @param event
+     */
+    protected void raisePotentialEvent(BaseEvent event) {
+        EventManager.getInstance().postPotentialEvent(event);
+    }
+
+    /**
+     * Override this method to receive the main Node generated while loading the view from the .fxml file.
+     * @param node
+     */
+    public abstract void setNode(Node node);
+
+    /**
+     * Override this method to return the name of the fxml file. e.g. {@code "MainWindow.fxml"}
+     * @return
+     */
+    public abstract String getFxmlPath();
+
+    public void setStage(Stage primaryStage) {
+        this.primaryStage = primaryStage;
+    }
+
+
+    /**
+     * Creates a modal dialog.
+     * @param title Title of the dialog.
+     * @param parentStage The owner stage of the dialog.
+     * @param scene The scene that will contain the dialog.
+     * @return the created dialog, not yet made visible.
+     */
+    protected Stage createDialogStage(String title, Stage parentStage, Scene scene) {
+        Stage dialogStage = new Stage();
+        dialogStage.setTitle(title);
+        dialogStage.initModality(Modality.WINDOW_MODAL);
+        dialogStage.initOwner(parentStage);
+        dialogStage.setScene(scene);
+        return dialogStage;
+    }
+
+    /**
+     * Sets the given image as the icon for the primary stage of this UI Part.
+     * @param iconSource e.g. {@code "/images/help_icon.png"}
+     */
+    protected void setIcon(String iconSource) {
+        primaryStage.getIcons().add(AppUtil.getImage(iconSource));
+    }
+
+    /**
+     * Sets the given image as the icon for the given stage.
+     * @param stage
+     * @param iconSource e.g. {@code "/images/help_icon.png"}
+     */
+    protected void setIcon(Stage stage, String iconSource) {
+        stage.getIcons().add(AppUtil.getImage(iconSource));
+    }
+
+    /**
+     * Sets the placeholder for UI parts that reside inside another UI part.
+     * This method will be called by the {@link UiPartLoader} during the loading process.
+     * @param placeholder
+     */
+    public void setPlaceholder(AnchorPane placeholder) {
+        //Do nothing by default.
+    }
+
+    public Stage getPrimaryStage() {
+        return primaryStage;
+    }
+}

src/main/java/address/controller/HelpWindow.java

@@ -0,0 +1,71 @@
+package address.controller;
+
+import address.util.AppLogger;
+import address.util.AppUtil;
+import address.util.LoggerManager;
+import commons.FxViewUtil;
+import hubturbo.EmbeddedBrowser;
+import hubturbo.embeddedbrowser.fxbrowser.FxBrowserAdapter;
+import javafx.fxml.FXML;
+import javafx.scene.Node;
+import javafx.scene.Scene;
+import javafx.scene.layout.AnchorPane;
+import javafx.scene.web.WebView;
+import javafx.stage.Stage;
+
+/**
+ * The Help Window UI Part.
+ */
+public class HelpWindow extends BaseUiPart {
+    private static final AppLogger logger = LoggerManager.getLogger(HelpWindow.class);
+    private static final String ICON = "/images/help_icon.png";
+    public static final String FXML = "HelpWindow.fxml";
+    public static final String TITLE = "Help";
+
+    private AnchorPane pane;
+    private Stage dialogStage;
+
+    @FXML
+    private AnchorPane mainPane;
+
+    public HelpWindow() {
+    }
+
+    public static HelpWindow load(Stage primaryStage) {
+        logger.debug("Showing help page about the application.");
+        HelpWindow helpWindow = UiPartLoader.loadUiPart(primaryStage, new HelpWindow());
+        helpWindow.configure();
+        return helpWindow;
+    }
+
+    @FXML
+    public void initialize() {
+        EmbeddedBrowser browser = new FxBrowserAdapter(new WebView());
+        browser.loadUrl(AppUtil.getResourceUrl("/help_html/index.html").toExternalForm());
+        FxViewUtil.applyAnchorBoundaryParameters(browser.getBrowserView(), 0.0, 0.0, 0.0, 0.0);
+        mainPane.getChildren().add(browser.getBrowserView());
+    }
+
+    private void configure(){
+        Scene scene = new Scene(pane);
+        //Null passed as the parent stage to make it non-modal.
+        dialogStage = createDialogStage(TITLE, null, scene);
+        dialogStage.setMaximized(true); //TODO: set a more appropriate initial size
+        setIcon(dialogStage, ICON);
+    }
+
+    @Override
+    public void setNode(Node node) {
+        pane = (AnchorPane)node;
+    }
+
+    @Override
+    public String getFxmlPath() {
+        return FXML;
+    }
+
+    public void show() {
+        dialogStage.showAndWait();
+    }
+
+}