Adds support for separate images for light and dark color schemes.

Author: simonbrowndotje

changelog.md

@@ -3,7 +3,8 @@
 ## v5.0.0 (unreleased)
 
 - structurizr-core: Removes support for deprecated enterprise and location concepts.
-- structurizr-core: Adds support for filtered deployment views (https://github.com/structurizr/java/issues/409). 
+- structurizr-core: Adds support for filtered deployment views (https://github.com/structurizr/java/issues/409).
+- structurizr-core: Adds support for separate images for light and dark color schemes.
 - structurizr-component: Fixes https://github.com/structurizr/java/issues/437 (Make ComponentFinder.run() not fail on empty Set<DiscoveredComponent>).
 - structurizr-dsl: Adds support for `iconPosition` on element styles (options are `Top`, `Bottom`, `Left`).
 - structurizr-dsl: Adds support for defining element and relationship styles for light and dark mode.

structurizr-core/src/main/java/com/structurizr/view/ImageView.java

@@ -13,6 +13,8 @@ public final class ImageView extends View {
     private Element element;
     private String elementId;
     private String content;
+    private String contentLight;
+    private String contentDark;
     private String contentType;
 
     ImageView() {
@@ -62,17 +64,58 @@ public String getContent() {
         return content;
     }
 
+    /**
+     * Gets the content of this view (a URL or a data URI), for the light color scheme.
+     *
+     * @return  the content, as a String
+     */
+    public String getContentLight() {
+        return contentLight;
+    }
+
+    /**
+     * Gets the content of this view (a URL or a data URI), for the dark color scheme.
+     *
+     * @return  the content, as a String
+     */
+    public String getContentDark() {
+        return contentDark;
+    }
+
     /**
      * Sets the content of this image view, which needs to be a URL or a data URI.
      *
      * @param content   the content of this view
      */
     public void setContent(String content) {
+        setContent(content, null);
+    }
+
+    /**
+     * Sets the content of this image view, which needs to be a URL or a data URI.
+     *
+     * @param content   the content of this view
+     */
+    public void setContent(String content, ColorScheme colorScheme) {
         if (StringUtils.isNullOrEmpty(content)) {
-            this.content = null;
+            if (colorScheme == ColorScheme.Dark) {
+                this.contentDark = null;
+            } else if (colorScheme == ColorScheme.Light) {
+                this.contentLight = null;
+            } else {
+                this.content = null;
+            }
         } else {
             ImageUtils.validateImage(content);
-            this.content = content.trim();
+            content = content.trim();
+
+            if (colorScheme == ColorScheme.Dark) {
+                this.contentDark = content;
+            } else if (colorScheme == ColorScheme.Light) {
+                this.contentLight = content;
+            } else {
+                this.content = content;
+            }
         }
     }
 
@@ -99,4 +142,11 @@ public String getName() {
         return getTitle();
     }
 
+    public boolean hasContent() {
+        return
+                !StringUtils.isNullOrEmpty(content) ||
+                !StringUtils.isNullOrEmpty(contentLight) ||
+                !StringUtils.isNullOrEmpty(contentDark);
+    }
+
 }

structurizr-core/src/test/java/com/structurizr/view/ImageViewTests.java

@@ -27,4 +27,31 @@ void construction_WhenAnElementIsSpecified() {
         assertEquals(softwareSystem.getId(), view.getElementId());
     }
 
+    @Test
+    void hasContent_WhenNoContent() {
+        ImageView view = views.createImageView("key");
+        assertFalse(view.hasContent());
+    }
+
+    @Test
+    void hasContent_WhenContent() {
+        ImageView view = views.createImageView("key");
+        view.setContent("https://example.com/image.png");
+        assertTrue(view.hasContent());
+    }
+
+    @Test
+    void hasContent_WhenContentLight() {
+        ImageView view = views.createImageView("key");
+        view.setContent("https://example.com/image.png", ColorScheme.Light);
+        assertTrue(view.hasContent());
+    }
+
+    @Test
+    void hasContent_WhenContentDark() {
+        ImageView view = views.createImageView("key");
+        view.setContent("https://example.com/image.png", ColorScheme.Dark);
+        assertTrue(view.hasContent());
+    }
+
 }