Make watermark text customizable

Author: georgweiss

app/imageviewer/doc/images/example.png

@@ -7,23 +7,25 @@ Overview
 As the name suggests, the Image Viewer renders an image file at full resolution
 in a separate tab in the main window. The tab title shows the image file name.
 
-By default a watermark is rendered over the image. The purpose is to avoid confusion in case the image shows a screenshot
-of an OPI screen. User may remove the watermark using the Watermark checkbox.
-
-Using the "Scale to fit" button user may rescale the non-SVG images to fit to the current size of the view. The resizing
+Using the "Scale to fit" button user may rescale the images to fit to the current size of the view. The resizing
 process will honor the aspect ratio of the image, i.e. the resulting view may show empty space
 above/below the image, or to left/right of the image. Pressing the button again will switch back to showing the
 image at full resolution. It should be noted that if the image is smaller than the current size of the view,
 pressing the "Scale to fit" button will zoom in on the image.
 
-.. image:: images/example.png
+In some cases it may be necessary to indicate that the image is static in nature and cannot be interacted with, e.g.
+when showing a screen shot of an OPI. Ticking the Watermark check box will add an overlay showing the text "WATERMARK"
+(may be customized).
+
+.. image:: images/toolbar.png
 
 There is no menu entry for the application. It is launched automatically for instance
 when user double clicks on an image file in the File Browser, or when user clicks on
 an image in the log entry attachment viewer.
 
 Supported file types are png, jpg (jpeg) and gif. The application also supports Scalable Vector Graphics
-files, but user should keep in mind that SVG tools may generate incompatible files.
+files, but user should keep in mind that SVG tools may generate incompatible files. When a SVG file is rendered
+by the application the "Scale to fit" button is disabled.
 
 If user has configured an external application for a particular image file extension, this is
 NOT overridden by the Image Viewer application.

app/imageviewer/doc/images/scale_to_fit.png

@@ -19,11 +19,13 @@
 package org.phoebus.applications.imageviewer;
 
 import javafx.beans.property.SimpleBooleanProperty;
+import javafx.beans.property.SimpleDoubleProperty;
 import javafx.beans.property.SimpleObjectProperty;
 import javafx.embed.swing.SwingFXUtils;
 import javafx.fxml.FXML;
 import javafx.scene.Node;
 import javafx.scene.control.Button;
+import javafx.scene.control.CheckBox;
 import javafx.scene.control.Label;
 import javafx.scene.control.ScrollPane;
 import javafx.scene.image.Image;
@@ -73,14 +75,19 @@ public class ImageViewerController {
     @FXML
     private BorderPane imageParent;
 
+    @FXML
+    private CheckBox showWatermarkCheckBox;
+
     private Image image;
 
-    private SimpleBooleanProperty isSVG = new SimpleBooleanProperty(false);
-    private SimpleBooleanProperty fitToWindow = new SimpleBooleanProperty(false);
+    private final SimpleBooleanProperty isSVG = new SimpleBooleanProperty(false);
+    private final SimpleBooleanProperty fitToWindow = new SimpleBooleanProperty(false);
+
+    private final SimpleBooleanProperty showWatermarkProperty = new SimpleBooleanProperty(true);
 
-    private SimpleBooleanProperty showWatermarkProperty = new SimpleBooleanProperty(true);
+    private final SimpleObjectProperty fontProperty = new SimpleObjectProperty();
 
-    private SimpleObjectProperty fontProperty = new SimpleObjectProperty();
+    private final SimpleDoubleProperty rotationProperty = new SimpleDoubleProperty();
 
     @FXML
     public void initialize() {
@@ -108,10 +115,12 @@ public void initialize() {
         fontProperty.set(new Font(20));
 
         watermarkPane.visibleProperty().bind(showWatermarkProperty);
-        watermarkText.fontProperty().bind(fontProperty);
 
+        watermarkText.textProperty().set(ImageViewerPreferences.watermark_text);
+        watermarkText.fontProperty().bind(fontProperty);
         watermarkText.getStylesheets().addAll(getClass().getResource("/style.css").toExternalForm());
         watermarkText.getStyleClass().add("outline");
+        watermarkText.rotateProperty().bind(rotationProperty);
     }
 
     public Node getRoot() {
@@ -122,9 +131,11 @@ public Node getRoot() {
      * Sets the image in the view. Shows error dialog if the image file
      * cannot be loaded/rendered, e.g. non-image file or incompatible SVG.
      *
-     * @param url
+     * @param url URL to image resource
      */
-    public void setImage(URL url) {
+    public void setImage(URL url, boolean showWatermark) {
+        showWatermarkProperty.set(showWatermark);
+        showWatermarkCheckBox.selectedProperty().set(showWatermark);
         try {
             if (url.toExternalForm().endsWith("svg")) {
                 image = SVGTranscoder.loadSVG(url.openStream(), 0, 0);
@@ -164,15 +175,32 @@ private void scale() {
             imageView.setFitHeight(image.getHeight());
         }
         fontProperty.set(getFont());
+        setRotation();
     }
 
     public void toggleWatermark() {
         showWatermarkProperty.set(!showWatermarkProperty.getValue());
     }
 
+    /**
+     * Computes a font size based on current size of image view and length of the watermark text.
+     * In short: larger image view -> larger font, longer text -> smaller font.
+     *
+     * @return A bold {@link Font} using calculated size.
+     */
     private Font getFont() {
         double height = imageView.getFitHeight();
         double width = imageView.getFitWidth();
-        return Font.font("Liberation Sans", FontWeight.BOLD, FontPosture.REGULAR, Math.min(width, height) / 10);
+        int textLength = ImageViewerPreferences.watermark_text.length();
+        double scalingFactor = textLength / 2.0;
+        return Font.font("Liberation Sans", FontWeight.BOLD, FontPosture.REGULAR, Math.min(width, height) / scalingFactor);
+    }
+
+    /**
+     * Determines rotation of the watermark text depending on portrait or landscape orientation of
+     * the image. If portrait the text is rotated more to better fit it on top ov the image.
+     */
+    private void setRotation() {
+        rotationProperty.set(imageView.getFitHeight() < imageView.getFitWidth() ? 25.0 : 60.0);
     }
 }

app/imageviewer/doc/images/toolbar.png

@@ -18,43 +18,34 @@
 
 package org.phoebus.applications.imageviewer;
 
-import javafx.application.Platform;
 import javafx.fxml.FXMLLoader;
 import org.phoebus.framework.nls.NLS;
 import org.phoebus.framework.spi.AppDescriptor;
 import org.phoebus.framework.spi.AppInstance;
 import org.phoebus.ui.docking.DockItem;
 import org.phoebus.ui.docking.DockItemWithInput;
 import org.phoebus.ui.docking.DockPane;
-import org.phoebus.ui.docking.DockStage;
 
-import java.io.IOException;
-import java.io.InputStream;
-import java.net.MalformedURLException;
 import java.net.URI;
-import java.net.URL;
 import java.util.ResourceBundle;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
 public class ImageViewerInstance implements AppInstance {
 
-    public static final String NAME = "Image Viewer";
-
-    public enum ViewMode{
+    public enum ViewMode {
         TAB,
         DIALOG
-    };
+    }
 
     private DockItem dockItem;
 
-    private AppDescriptor appDescriptor;
+    private final AppDescriptor appDescriptor;
 
-    public ImageViewerInstance(AppDescriptor appDescriptor, URI uri, ViewMode viewMode){
+    public ImageViewerInstance(AppDescriptor appDescriptor, URI uri, ViewMode viewMode) {
         this.appDescriptor = appDescriptor;
 
-        if(viewMode == ViewMode.TAB){
-            final DockItemWithInput existing = DockStage.getDockItemWithInput(NAME, uri);
+        if (viewMode == ViewMode.TAB) {
             FXMLLoader fxmlLoader = new FXMLLoader();
             ResourceBundle resourceBundle = NLS.getMessages(Messages.class);
             fxmlLoader.setResources(resourceBundle);
@@ -64,28 +55,25 @@ public ImageViewerInstance(AppDescriptor appDescriptor, URI uri, ViewMode viewMo
                 ImageViewerController imageViewerController = fxmlLoader.getController();
                 dockItem = new DockItemWithInput(this, imageViewerController.getRoot(), uri, null, null);
                 DockPane.getActiveDockPane().addTab(dockItem);
-                Platform.runLater(() -> {
-                    try {
-                        imageViewerController.setImage(uri.toURL());
-                    } catch (MalformedURLException e) {
-                        Logger.getLogger(ImageViewerInstance.class.getName())
-                                .log(Level.WARNING, "Unable to set image", e);
-                    }
-                });
+                boolean showWatermark = false;
+                String queryParams = uri.getQuery();
+                if (queryParams != null && queryParams.contains("watermark=true")) {
+                    showWatermark = true;
+                }
+                imageViewerController.setImage(uri.toURL(), showWatermark);
             } catch (Exception e) {
                 Logger.getLogger(ImageViewerInstance.class.getName())
-                    .log(Level.WARNING, "Unable to load fxml", e);
+                        .log(Level.WARNING, "Unable to load fxml", e);
             }
         }
     }
 
     @Override
-    public AppDescriptor getAppDescriptor()
-    {
+    public AppDescriptor getAppDescriptor() {
         return appDescriptor;
     }
 
-    public void raise(){
+    public void raise() {
         dockItem.select();
     }
 }

app/imageviewer/doc/index.rst

@@ -0,0 +1,26 @@
+/*******************************************************************************
+ * Copyright (c) 2018 Oak Ridge National Laboratory.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *******************************************************************************/
+package org.phoebus.applications.imageviewer;
+
+import org.phoebus.framework.preferences.AnnotatedPreferences;
+import org.phoebus.framework.preferences.Preference;
+
+/**
+ * Preference settings for Image Viewer app
+ *
+ * @author Georg Weiss
+ */
+@SuppressWarnings("nls")
+public class ImageViewerPreferences {
+    @Preference
+    public static String watermark_text;
+
+    static {
+        AnnotatedPreferences.initialize(ImageViewerPreferences.class, "/image_viewer_preferences.properties");
+    }
+}

app/imageviewer/src/main/java/org/phoebus/applications/imageviewer/ImageViewerController.java

@@ -33,7 +33,7 @@
         <ToolBar>
             <Button fx:id="scaleToFitButton" prefWidth="130.0" text="%ScaleToFit">
             </Button>
-            <CheckBox fx:id="showWatermark" onAction="#toggleWatermark" prefWidth="130.0" selected="true"
+            <CheckBox fx:id="showWatermarkCheckBox" onAction="#toggleWatermark" prefWidth="130.0" selected="true"
                       text="%watermarkButton">
                 <padding>
                     <Insets left="10.0"/>
@@ -43,16 +43,14 @@
 
     </top>
     <center>
-
         <ScrollPane fx:id="scrollPane">
             <BorderPane fx:id="imageParent">
                 <center>
                     <StackPane fx:id="stackPane">
                         <ImageView fx:id="imageView"/>
                         <BorderPane fx:id="watermarkPane">
                             <center>
-                                <Label fx:id="watermarkText" rotate="25.0" style="-fx-text-fill: #AAAAAA90;"
-                                       text="%watermarkText"/>
+                                <Label fx:id="watermarkText" rotate="25.0" style="-fx-text-fill: #AAAAAA90;"/>
                             </center>
                         </BorderPane>
                     </StackPane>

app/imageviewer/src/main/java/org/phoebus/applications/imageviewer/ImageViewerInstance.java

@@ -0,0 +1,6 @@
+# --------------------------------------------
+# Package org.phoebus.applications.imageviewer
+# --------------------------------------------
+
+# Watermark text
+watermark_text=W A T E R M A R K

app/imageviewer/src/main/java/org/phoebus/applications/imageviewer/ImageViewerPreferences.java

@@ -21,4 +21,3 @@ ErrorDialogText=Failed to load image resource {0}
 OneHundredPercent=Show 100%
 ScaleToFit=Scale to fit
 watermarkButton=Watermark
-watermarkText=W A T E R M A R K