Merge pull request #59 from mfl28/feature/add-help-and-program-version-info

Add help menu and program version info

Author: mfl28

src/main/java/com/github/mfl28/boundingboxeditor/BoundingBoxEditorApp.java

@@ -49,7 +49,7 @@ public static void main(String[] args) {
 
     @Override
     public void start(Stage primaryStage) {
-        final Controller controller = new Controller(primaryStage);
+        final Controller controller = new Controller(primaryStage, getHostServices());
         final Scene scene = createSceneFromParent(controller.getView());
 
         scene.getStylesheets().add(getClass().getResource(STYLESHEET_PATH).toExternalForm());

src/main/java/com/github/mfl28/boundingboxeditor/controller/Controller.java

@@ -43,6 +43,7 @@
 import com.github.mfl28.boundingboxeditor.utils.ImageUtils;
 import jakarta.ws.rs.client.Client;
 import jakarta.ws.rs.client.ClientBuilder;
+import javafx.application.HostServices;
 import javafx.application.Platform;
 import javafx.beans.property.BooleanProperty;
 import javafx.beans.property.SimpleBooleanProperty;
@@ -84,6 +85,10 @@
 public class Controller {
     private static final String PROGRAM_NAME = "Bounding Box Editor";
     private static final String PROGRAM_NAME_EXTENSION_SEPARATOR = " - ";
+    private static final String GITHUB_WIKI_URL = "https://github.com/mfl28/BoundingBoxEditor/wiki";
+    private static final String PROGRAM_VERSION = "2.5.0";
+    private static final String PROGRAM_LICENSE = "GPL-3.0";
+    private static final String PROGRAM_IDENTIFIER = PROGRAM_NAME + " " + PROGRAM_VERSION;
     private static final String OPEN_FOLDER_ERROR_DIALOG_TITLE = "Image Folder Loading Error";
     private static final String OPEN_FOLDER_ERROR_DIALOG_HEADER = "The selected folder is not a valid image folder.";
     private static final String SAVE_IMAGE_ANNOTATIONS_DIRECTORY_CHOOSER_TITLE = "Save Image Annotations to Folder";
@@ -172,6 +177,7 @@ public class Controller {
     private final BoundingBoxPredictorService boundingBoxPredictorService = new BoundingBoxPredictorService();
     private final ModelNameFetchService modelNameFetchService = new ModelNameFetchService();
     private final Stage stage;
+    private final HostServices hostServices;
     private final MainView view = new MainView();
     private final Model model = new Model();
     private final ListChangeListener<BoundingShapeViewable> boundingShapeCountPerCategoryListener =
@@ -193,9 +199,11 @@ public class Controller {
      *
      * @param mainStage the stage that represents the top level container of all used ui-elements
      */
-    public Controller(final Stage mainStage) {
+    public Controller(final Stage mainStage, final HostServices hostServices) {
         stage = mainStage;
-        stage.setTitle(PROGRAM_NAME);
+        this.hostServices = hostServices;
+
+        stage.setTitle(PROGRAM_IDENTIFIER);
         stage.getIcons().add(MainView.APPLICATION_ICON);
         stage.setOnCloseRequest(event -> {
             onRegisterExitAction();
@@ -650,6 +658,19 @@ public void onRegisterSettingsCancelCloseAction() {
         view.getInferenceSettingsView().setAllFieldsValid();
     }
 
+    public void onRegisterDocumentationAction() {
+        hostServices.showDocument(GITHUB_WIKI_URL);
+    }
+
+    public void onRegisterAboutAction() {
+        MainView.displayTextInfoDialog(
+                "About " + PROGRAM_NAME,
+                PROGRAM_NAME,
+                "Version: " + PROGRAM_VERSION +
+                "\nLicense: " + PROGRAM_LICENSE,
+                stage);
+    }
+
     void makeClientAvailable() {
         if(client == null) {
             client = ClientBuilder.newBuilder()
@@ -1304,7 +1325,7 @@ private void updateViewImageFiles() {
 
     private void updateStageTitle() {
         ImageMetaData currentImageMetaData = model.getCurrentImageMetaData();
-        stage.setTitle(PROGRAM_NAME + PROGRAM_NAME_EXTENSION_SEPARATOR
+    stage.setTitle(PROGRAM_IDENTIFIER + PROGRAM_NAME_EXTENSION_SEPARATOR
                 + model.getCurrentImageFilePath() + " " + currentImageMetaData.getDimensionsString());
     }
 
@@ -1526,7 +1547,7 @@ private void clearViewAndModel() {
         imagePane.removeAllCurrentBoundingShapes();
         view.getCurrentBoundingShapes().removeListener(boundingShapeCountPerCategoryListener);
 
-        stage.setTitle(PROGRAM_NAME);
+        stage.setTitle(PROGRAM_IDENTIFIER);
 
         ObjectCategoryTableView objectCategoryTableView = view.getObjectCategoryTable();
         objectCategoryTableView.getItems().clear();

src/main/java/com/github/mfl28/boundingboxeditor/ui/MainView.java

@@ -550,6 +550,11 @@ public void displaySettingsDialog(Controller controller, Window owner) {
         settingsDialog.showAndWait();
     }
 
+
+    public static void displayTextInfoDialog(String title, String header, String content, Window owner) {
+        displayInfoAlert(title, header, content, null, owner);
+    }
+
     public Optional<Window> getSettingsWindow() {
         return Window.getWindows()
                 .stream()
@@ -646,14 +651,16 @@ private static void displayInfoAlert(String title, String header, String content
         ((Stage) alert.getDialogPane().getScene().getWindow()).getIcons().add(APPLICATION_ICON);
         alert.initOwner(owner);
 
-        GridPane.setVgrow(additionalInfoNode, Priority.ALWAYS);
-        GridPane.setHgrow(additionalInfoNode, Priority.ALWAYS);
+        if(additionalInfoNode != null) {
+            GridPane.setVgrow(additionalInfoNode, Priority.ALWAYS);
+            GridPane.setHgrow(additionalInfoNode, Priority.ALWAYS);
 
-        GridPane expandableContent = new GridPane();
-        expandableContent.setMaxWidth(Double.MAX_VALUE);
-        expandableContent.add(additionalInfoNode, 0, 0);
+            GridPane expandableContent = new GridPane();
+            expandableContent.setMaxWidth(Double.MAX_VALUE);
+            expandableContent.add(additionalInfoNode, 0, 0);
 
-        alert.getDialogPane().setExpandableContent(expandableContent);
+            alert.getDialogPane().setExpandableContent(expandableContent);
+        }
         alert.showAndWait();
     }
 

src/main/java/com/github/mfl28/boundingboxeditor/ui/MenuBarView.java

@@ -67,6 +67,12 @@ class MenuBarView extends MenuBar implements View {
     private static final String SETTINGS_TEXT = "Se_ttings";
     private static final String SETTINGS_ICON_ID = "settings-icon";
     private static final String FILE_SETTINGS_MENU_ITEM_ID = "file-settings-menu-item";
+    private static final String HELP_MENU_TEXT = "_Help";
+    private static final String HELP_MENU_ID = "help-menu";
+    private static final String DOCUMENTATION_TEXT = "_Documentation";
+    private static final String ABOUT_TEXT = "_About";
+    private static final String DOCUMENTATION_MENU_ITEM_ID = "documentation-menu-item";
+    private static final String ABOUT_MENU_ITEM_ID = "about-menu-item";
 
     private final MenuItem fileOpenFolderItem = new MenuItem(OPEN_FOLDER_TEXT, createIconRegion(OPEN_FOLDER_ICON_ID));
     private final Menu fileExportAnnotationsMenu = new Menu(SAVE_TEXT, createIconRegion(SAVE_ICON_ID));
@@ -83,12 +89,14 @@ class MenuBarView extends MenuBar implements View {
     private final MenuItem fileExitItem = new MenuItem(EXIT_TEXT, createIconRegion(EXIT_ICON_ID));
     private final CheckMenuItem viewMaximizeImagesItem = new CheckMenuItem(MAXIMIZE_IMAGES_TEXT);
     private final CheckMenuItem viewShowImagesPanelItem = new CheckMenuItem(SHOW_IMAGE_FILE_EXPLORER_TEXT);
+    private final MenuItem documentationMenuItem = new MenuItem(DOCUMENTATION_TEXT);
+    private final MenuItem aboutMenuItem = new MenuItem(ABOUT_TEXT);
 
     /**
      * Creates a new menu-bar UI-element.
      */
     MenuBarView() {
-        getMenus().addAll(createFileMenu(), createViewMenu());
+        getMenus().addAll(createFileMenu(), createViewMenu(), createHelpMenu());
         setId(MAIN_MENU_BAR_ID);
         viewShowImagesPanelItem.setSelected(true);
         viewMaximizeImagesItem.setSelected(true);
@@ -132,6 +140,8 @@ public void connectToController(final Controller controller) {
                                                        ImageAnnotationLoadStrategy.Type.JSON));
         fileExitItem.setOnAction(action -> controller.onRegisterExitAction());
         settingsMenuItem.setOnAction(action -> controller.onRegisterSettingsAction());
+        documentationMenuItem.setOnAction(action -> controller.onRegisterDocumentationAction());
+        aboutMenuItem.setOnAction(action -> controller.onRegisterAboutAction());
     }
 
     /**
@@ -199,6 +209,21 @@ private Menu createViewMenu() {
         return viewMenu;
     }
 
+    private Menu createHelpMenu() {
+        Menu helpMenu = new Menu(HELP_MENU_TEXT);
+        helpMenu.setId(HELP_MENU_ID);
+
+        helpMenu.getItems().addAll(
+                documentationMenuItem,
+                aboutMenuItem
+        );
+
+        documentationMenuItem.setId(DOCUMENTATION_MENU_ITEM_ID);
+        aboutMenuItem.setId(ABOUT_MENU_ITEM_ID);
+
+        return helpMenu;
+    }
+
     private Region createIconRegion(String cssId) {
         Region region = new Region();
         region.setId(cssId);

src/test/java/com/github/mfl28/boundingboxeditor/BoundingBoxEditorTestBase.java

@@ -205,7 +205,7 @@ protected void waitUntilCurrentImageIsLoaded(TestInfo testinfo) {
     @Start
     protected void onStart(Stage stage) {
         Platform.setImplicitExit(false);
-        controller = new Controller(stage);
+        controller = new Controller(stage, null);
         mainView = controller.getView();
         model = controller.getModel();
         // To make sure that the window is on top of all other windows at the start.

src/test/java/com/github/mfl28/boundingboxeditor/controller/ControllerTests.java

@@ -1048,7 +1048,7 @@ void onReloadAnnotations_afterImageFilesReopened_shouldCorrectlyDisplayBoundingS
         WaitForAsyncUtils.waitForFxEvents();
         timeOutAssertServiceSucceeded(controller.getImageMetaDataLoadingService(), testinfo);
 
-        verifyThat(controller.getStage().getTitle(), Matchers.startsWith("Bounding Box Editor - "),
+        verifyThat(controller.getStage().getTitle(), Matchers.matchesRegex("^Bounding Box Editor \\d\\.\\d\\.\\d - .*$"),
                    saveScreenshot(testinfo));
 
         verifyThat(mainView.getStatusBar().getCurrentEventMessage(),

src/test/java/com/github/mfl28/boundingboxeditor/ui/NoImageFolderOpenedBasicTests.java

@@ -218,6 +218,39 @@ private void verifyMenuBarFunctionality(FxRobot robot, TestInfo testinfo) {
         assertTrue(imageExplorerItem.isDisable(),
                 () -> saveScreenshotAndReturnMessage(testinfo, "Image explorer item not " +
                         "disabled"));
+
+
+        timeOutClickOn(robot, "#help-menu", testinfo);
+
+        WaitForAsyncUtils.waitForFxEvents();
+
+        MenuItem documentationItem = getSubMenuItem(robot, "Help", "Documentation");
+        assertTrue(documentationItem.isVisible(),
+                () -> saveScreenshotAndReturnMessage(testinfo, "Documentation item not " +
+                        "visible"));
+        assertFalse(documentationItem.isDisable(),
+                () -> saveScreenshotAndReturnMessage(testinfo, "Documentation item not " +
+                        "enabled"));
+
+        MenuItem aboutItem = getSubMenuItem(robot, "Help", "About");
+        assertTrue(aboutItem.isVisible(),
+                () -> saveScreenshotAndReturnMessage(testinfo, "About item not " +
+                        "visible"));
+        assertFalse(aboutItem.isDisable(),
+                () -> saveScreenshotAndReturnMessage(testinfo, "About item not " +
+                        "enabled"));
+
+        timeOutClickOn(robot, "#help-menu", testinfo);
+        WaitForAsyncUtils.waitForFxEvents();
+        timeOutClickOn(robot, "#about-menu-item", testinfo);
+        WaitForAsyncUtils.waitForFxEvents();
+
+        Stage aboutStage = timeOutGetTopModalStage(robot, "About Bounding Box Editor", testinfo);
+        verifyThat(aboutStage, Matchers.notNullValue(), saveScreenshot(testinfo));
+
+        timeOutLookUpInStageAndClickOn(robot, aboutStage, "OK", testinfo);
+        WaitForAsyncUtils.waitForFxEvents();
+        timeOutAssertTopModalStageClosed(robot, "About Bounding Box Editor", testinfo);
     }
 
     private void verifyNodeVisibilities(TestInfo testinfo) {