JavaFX Output Implementation - V2

gradle.properties

@@ -16,18 +16,20 @@ me.champeau.jmh.version                                   = 0.6.6
 org.sonarqube.version                                     = 5.1.0.4882
 jacoco.version                                            = 0.8.12
 biz.aQute.bnd.lib.version                                 = 7.1.0
+org.openjfx.javafxplugin.version                          = 0.1.0
 
 #Dependencies
 # Libraries
 nullabilityAnnotations.version                            = 23.0.0
 javaxAnnotations.version                                  = 1.3.2
 osgiAnnotations.version                                   = 2.0.0
 slf4jApi.version                                          = 2.0.17
+javafx.version                                            = 17.0.15
 
 # Test libraries
 junit.version                                             = 5.6.2
 imageCompare.version                                      = 1.0.0
-batik.version                                             = 1.17
+batik.version                                             = 1.19
 svgSalamander.version                                     = 1.1.3
 darklaf.version                                           = 3.1.0
 swingExtensions.version                                   = 0.1.4-SNAPSHOT

jsvg-javafx/build.gradle.kts

@@ -0,0 +1,78 @@
+import org.gradle.api.tasks.testing.logging.TestExceptionFormat
+
+plugins {
+    `java-library`
+    jacoco
+    id("biz.aQute.bnd.builder")
+    id("org.openjfx.javafxplugin")
+}
+
+javafx {
+    version = rootProject.extra["javafx.version"].toString()
+    modules("javafx.controls", "javafx.fxml", "javafx.swing")
+}
+
+dependencies {
+    compileOnly(projects.jsvg)
+    compileOnly(libs.nullabilityAnnotations)
+    compileOnly(toolLibs.errorprone.annotations)
+    compileOnly(libs.osgiAnnotations)
+
+    testImplementation(projects.jsvg)
+    testImplementation(testLibs.junit.api)
+    testImplementation(testLibs.imageCompare)
+    testImplementation(gradleApi())
+
+    testRuntimeOnly(testLibs.junit.engine)
+
+    testCompileOnly(libs.nullabilityAnnotations)
+    testCompileOnly(toolLibs.errorprone.annotations)
+}
+tasks {
+
+    compileTestJava {
+        options.release.set(21)
+    }
+
+    jar {
+        bundle {
+            bnd(
+                bndFile(
+                    moduleName = "com.github.weisj.jsvg.javafx",
+                    requiredModules =
+                        listOf(
+                            Requires("com.github.weisj.jsvg"),
+                            Requires("org.jetbrains.annotations", static = true),
+                            Requires("com.google.errorprone.annotations", static = true),
+                            Requires("org.osgi.annotation.bundle", static = true),
+                        ),
+                ),
+            )
+        }
+    }
+
+    withType<JavaExec> {
+        environment("JAVAFX_TEST_SVG_PATH" to File(project.rootDir, "jsvg/src/test/resources").absolutePath)
+    }
+
+    test {
+        dependsOn(jar)
+        doFirst {
+            workingDir = File(project.rootDir, "build/ref_test").also { it.mkdirs() }
+        }
+        useJUnitPlatform()
+        testLogging {
+            showStandardStreams = true
+            showExceptions = true
+            showStackTraces = true
+            exceptionFormat = TestExceptionFormat.FULL
+        }
+    }
+
+    register<JavaExec>("SVGViewerFX") {
+        group = "application"
+        description = "Runs the JavaFX SVG Viewer application."
+        classpath = sourceSets.test.get().runtimeClasspath
+        mainClass.set("com.github.weisj.jsvg.renderer.jfx.viewer.FXViewerMain")
+    }
+}

jsvg-javafx/src/main/java/com/github/weisj/jsvg/renderer/jfx/FXOutput.java

@@ -0,0 +1,52 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2026 Jannis Weis
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+ * associated documentation files (the "Software"), to deal in the Software without restriction,
+ * including without limitation the rights to use, copy, modify, merge, publish, distribute,
+ * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+ * NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ */
+package com.github.weisj.jsvg.renderer.jfx;
+
+import javafx.scene.canvas.GraphicsContext;
+
+import org.jetbrains.annotations.NotNull;
+
+import com.github.weisj.jsvg.renderer.jfx.impl.FXOutputImpl;
+import com.github.weisj.jsvg.renderer.jfx.impl.bridge.FXRenderingHintsUtil;
+import com.github.weisj.jsvg.renderer.output.Output;
+
+/**
+ * A utility class for retrieving an {@link Output} implementation that uses a {@link GraphicsContext} to draw to.
+ */
+public final class FXOutput {
+
+    private FXOutput() {}
+
+    /**
+     * Example usage:
+     * <pre><code>
+     *     Output output = FXOutput.createForGraphicsContext(graphics);
+     *     svgDocument.renderWithPlatform(NullPlatformSupport.INSTANCE, output, null, null);
+     *     output.dispose();
+     * </code></pre>
+     */
+    public static @NotNull Output createForGraphicsContext(@NotNull GraphicsContext context) {
+        FXOutputImpl output = new FXOutputImpl(context);
+        FXRenderingHintsUtil.setupDefaultJFXRenderingHints(output);
+        return output;
+    }
+}