Handle font resource loading. Fixes #122

kordamp · Nov 9, 2020 · 6187014 · 6187014
1 parent 64fc42e
commit 6187014
Show file tree

Hide file tree

Showing 144 changed files with 1,088 additions and 657 deletions.
diff --git a/core/ikonli-core/src/main/java/org/kordamp/ikonli/IkonHandler.java b/core/ikonli-core/src/main/java/org/kordamp/ikonli/IkonHandler.java
@@ -17,6 +17,9 @@
  */
 package org.kordamp.ikonli;
 
+import java.io.InputStream;
+import java.net.URL;
+
 /**
  * @author Andres Almiray
  */
@@ -25,7 +28,9 @@ public interface IkonHandler {
 
     Ikon resolve(String description);
 
-    String getFontResourcePath();
+    URL getFontResource();
+
+    InputStream getFontResourceAsStream();
 
     String getFontFamily();
 

diff --git a/core/ikonli-core/src/main/java/org/kordamp/ikonli/IkonliIkonResolver.java b/core/ikonli-core/src/main/java/org/kordamp/ikonli/IkonliIkonResolver.java
@@ -19,11 +19,16 @@
 
 import org.kordamp.jipsy.ServiceProviderFor;
 
+import java.io.InputStream;
+import java.net.URL;
+
 /**
  * @author Andres Almiray
  */
 @ServiceProviderFor(IkonHandler.class)
 public class IkonliIkonResolver extends AbstractIkonHandler {
+    private static final String FONT_RESOURCE = "/META-INF/resources/ikonli/0.0.0/fonts/ikonli.ttf";
+
     @Override
     public boolean supports(String description) {
         return description != null && description.startsWith("ikn-");
@@ -35,8 +40,13 @@ public Ikon resolve(String description) {
     }
 
     @Override
-    public String getFontResourcePath() {
-        return "META-INF/resources/ikonli/0.0.0/fonts/ikonli.ttf";
+    public URL getFontResource() {
+        return getClass().getResource(FONT_RESOURCE);
+    }
+
+    @Override
+    public InputStream getFontResourceAsStream() {
+        return getClass().getResourceAsStream(FONT_RESOURCE);
     }
 
     @Override

diff --git a/core/ikonli-javafx/src/main/java/org/kordamp/ikonli/javafx/FontIcon.java b/core/ikonli-javafx/src/main/java/org/kordamp/ikonli/javafx/FontIcon.java
@@ -95,6 +95,7 @@ public FontIcon(Ikon iconCode) {
         setIconCode(iconCode);
     }
 
+    @Override
     public String toString() {
         Ikon iconCode = getIconCode();
         return (iconCode != null ? iconCode.getDescription() : "<undef>") + ":" + getIconSize() + ":" + getIconColor();
@@ -233,6 +234,7 @@ public void setIconLiteral(String iconCode) {
         resolvePaint(iconCode, parts);
     }
 
+    @Override
     public List<CssMetaData<? extends Styleable, ?>> getCssMetaData() {
         return FontIcon.getClassCssMetaData();
     }

diff --git a/core/ikonli-javafx/src/main/java/org/kordamp/ikonli/javafx/IkonResolver.java b/core/ikonli-javafx/src/main/java/org/kordamp/ikonli/javafx/IkonResolver.java
@@ -35,7 +35,7 @@ public class IkonResolver extends AbstractIkonResolver {
         ServiceLoader<IkonHandler> loader = ServiceLoader.load(IkonHandler.class.getModule().getLayer(), IkonHandler.class);
         for (IkonHandler handler : loader) {
             HANDLERS.add(handler);
-            handler.setFont(Font.loadFont(handler.getFontResourcePath(), 16));
+            handler.setFont(Font.loadFont(handler.getFontResource().toExternalForm(), 16));
         }
     }
 

diff --git a/core/ikonli-swing/src/main/java/org/kordamp/ikonli/swing/IkonResolver.java b/core/ikonli-swing/src/main/java/org/kordamp/ikonli/swing/IkonResolver.java
@@ -20,9 +20,7 @@
 import org.kordamp.ikonli.AbstractIkonResolver;
 import org.kordamp.ikonli.IkonHandler;
 
-import java.awt.Font;
-import java.awt.FontFormatException;
-import java.awt.GraphicsEnvironment;
+import java.awt.*;
 import java.io.IOException;
 import java.io.InputStream;
 import java.util.ServiceLoader;
@@ -36,13 +34,12 @@ public class IkonResolver extends AbstractIkonResolver {
     static {
         INSTANCE = new IkonResolver();
 
-        ClassLoader classLoader = IkonResolver.class.getClassLoader();
-        ServiceLoader<IkonHandler> loader = ServiceLoader.load(IkonHandler.class, classLoader);
+        ServiceLoader<IkonHandler> loader = ServiceLoader.load(IkonHandler.class.getModule().getLayer(), IkonHandler.class);
         for (IkonHandler handler : loader) {
             HANDLERS.add(handler);
 
             try {
-                InputStream stream = classLoader.getResourceAsStream(handler.getFontResourcePath());
+                InputStream stream = handler.getFontResourceAsStream();
                 Font font = Font.createFont(Font.TRUETYPE_FONT, stream);
                 GraphicsEnvironment.getLocalGraphicsEnvironment().registerFont(font);
                 stream.close();

diff --git a/docs/guide/src/docs/asciidoc/authoring.adoc b/docs/guide/src/docs/asciidoc/authoring.adoc
@@ -61,9 +61,13 @@ import org.kordamp.ikonli.AbstractIkonHandler;
 import org.kordamp.ikonli.Ikon;
 import org.kordamp.ikonli.IkonHandler;
 import org.kordamp.jipsy.ServiceProviderFor;
+import java.io.InputStream;
+import java.net.URL;
 
 @ServiceProviderFor(IkonHandler.class)                                 // <1>
 public class MyIconIkonHandler extends AbstractIkonHandler {
+    private static final String FONT_RESOURCE = "/META-INF/resources/myicon/1.2.3/fonts/myicon.ttf";
+
     @Override
     public boolean supports(String description) {
         return description != null && description.startsWith("my-");   // <2>
@@ -75,9 +79,13 @@ public class MyIconIkonHandler extends AbstractIkonHandler {
     }
 
     @Override
-    public String getFontResourcePath() {
-        return getClass().getResource("/META-INF/resources/myicon/1.2.3/fonts/myicon.ttf")
-                   .toExternalFrom();                                  // <3>
+    public URL getFontResource() {
+        return getClass().getResource(FONT_RESOURCE);                  // <3>
+    }
+
+    @Override
+    public InputStream getFontResourceAsStream() {
+        return getClass().getResourceAsStream(FONT_RESOURCE);          // <3>
     }
 
     @Override
@@ -88,7 +96,7 @@ public class MyIconIkonHandler extends AbstractIkonHandler {
 ----
 <1> Generates an entry at `META-INF/services/org.kordamp.ikonli.IkonHandler`.
 <2> Note the use of the icon prefix.
-<3> Location of the font resource.
+<3> Locate the font resource.
 <4> Name of the font family.
 
 The use of the `@ServiceProviderFor` annotation requires having link:https://github.com/kordamp/jipsy/[jipsy] configured

diff --git a/docs/guide/src/docs/asciidoc/introduction.adoc b/docs/guide/src/docs/asciidoc/introduction.adoc
@@ -29,3 +29,5 @@ If you are upgrading to `12.0.0` or later be aware of the following changes:
 * The `icon-hawkconsfilled-pack` and `icon-hawkconsstroke-pack` icon packs were merged into a single `icon-hawkcons-pack` icon pack.
 * The method `getCode()` of `org.kordamp.ikonli.Ikon` now returns `int` instead of `char`. This change is needed to accomodate
 icon packs whose icon codes are larger than a single char, such as MaterialDesign.
+* The interface `org.kordamp.ikonli.IkonHandler` no longer has a method `String getFontResourcePath()`; it has two new
+methods instead: `URL getFontResource()` and `InputStream getFontResourceAsStream()`.
diff --git a/...pack/src/main/java/org/kordamp/ikonli/antdesignicons/AntDesignIconsFilledIkonHandler.java b/...pack/src/main/java/org/kordamp/ikonli/antdesignicons/AntDesignIconsFilledIkonHandler.java
@@ -22,11 +22,16 @@
 import org.kordamp.ikonli.IkonHandler;
 import org.kordamp.jipsy.ServiceProviderFor;
 
+import java.io.InputStream;
+import java.net.URL;
+
 /**
  * @author Andres Almiray
  */
 @ServiceProviderFor(IkonHandler.class)
 public class AntDesignIconsFilledIkonHandler extends AbstractIkonHandler {
+    private static final String FONT_RESOURCE = "/META-INF/resources/antdesignicons/4.0.0/fonts/AntDesign-Icons-Filled.ttf";
+
     @Override
     public boolean supports(String description) {
         return description != null && description.startsWith("antf-");
@@ -38,9 +43,13 @@ public Ikon resolve(String description) {
     }
 
     @Override
-    public String getFontResourcePath() {
-        return getClass().getResource("/META-INF/resources/antdesignicons/4.0.0/fonts/AntDesign-Icons-Filled.ttf")
-            .toExternalForm();
+    public URL getFontResource() {
+        return getClass().getResource(FONT_RESOURCE);
+    }
+
+    @Override
+    public InputStream getFontResourceAsStream() {
+        return getClass().getResourceAsStream(FONT_RESOURCE);
     }
 
     @Override

diff --git a/...ck/src/main/java/org/kordamp/ikonli/antdesignicons/AntDesignIconsOutlinedIkonHandler.java b/...ck/src/main/java/org/kordamp/ikonli/antdesignicons/AntDesignIconsOutlinedIkonHandler.java
@@ -22,11 +22,16 @@
 import org.kordamp.ikonli.IkonHandler;
 import org.kordamp.jipsy.ServiceProviderFor;
 
+import java.io.InputStream;
+import java.net.URL;
+
 /**
  * @author Andres Almiray
  */
 @ServiceProviderFor(IkonHandler.class)
 public class AntDesignIconsOutlinedIkonHandler extends AbstractIkonHandler {
+    private static final String FONT_RESOURCE = "/META-INF/resources/antdesignicons/4.0.0/fonts/AntDesign-Icons-Outlined.ttf";
+
     @Override
     public boolean supports(String description) {
         return description != null && description.startsWith("anto-");
@@ -38,9 +43,13 @@ public Ikon resolve(String description) {
     }
 
     @Override
-    public String getFontResourcePath() {
-        return getClass().getResource("/META-INF/resources/antdesignicons/4.0.0/fonts/AntDesign-Icons-Outlined.ttf")
-            .toExternalForm();
+    public URL getFontResource() {
+        return getClass().getResource(FONT_RESOURCE);
+    }
+
+    @Override
+    public InputStream getFontResourceAsStream() {
+        return getClass().getResourceAsStream(FONT_RESOURCE);
     }
 
     @Override

diff --git a/...nli-boxicons-pack/src/main/java/org/kordamp/ikonli/boxicons/BoxiconsLogosIkonHandler.java b/...nli-boxicons-pack/src/main/java/org/kordamp/ikonli/boxicons/BoxiconsLogosIkonHandler.java
@@ -22,11 +22,16 @@
 import org.kordamp.ikonli.IkonHandler;
 import org.kordamp.jipsy.ServiceProviderFor;
 
+import java.io.InputStream;
+import java.net.URL;
+
 /**
  * @author Andres Almiray
  */
 @ServiceProviderFor(IkonHandler.class)
 public class BoxiconsLogosIkonHandler extends AbstractIkonHandler {
+    private static final String FONT_RESOURCE = "/META-INF/resources/boxicons/2.0.7/fonts/boxicons.ttf";
+
     @Override
     public boolean supports(String description) {
         return description != null && description.startsWith("bxl-");
@@ -38,9 +43,13 @@ public Ikon resolve(String description) {
     }
 
     @Override
-    public String getFontResourcePath() {
-        return getClass().getResource("/META-INF/resources/boxicons/2.0.7/fonts/boxicons.ttf")
-            .toExternalForm();
+    public URL getFontResource() {
+        return getClass().getResource(FONT_RESOURCE);
+    }
+
+    @Override
+    public InputStream getFontResourceAsStream() {
+        return getClass().getResourceAsStream(FONT_RESOURCE);
     }
 
     @Override

diff --git a/...i-boxicons-pack/src/main/java/org/kordamp/ikonli/boxicons/BoxiconsRegularIkonHandler.java b/...i-boxicons-pack/src/main/java/org/kordamp/ikonli/boxicons/BoxiconsRegularIkonHandler.java
@@ -17,25 +17,39 @@
  */
 package org.kordamp.ikonli.boxicons;
 
+import org.kordamp.ikonli.AbstractIkonHandler;
+import org.kordamp.ikonli.Ikon;
+import org.kordamp.ikonli.IkonHandler;
+import org.kordamp.jipsy.ServiceProviderFor;
+
+import java.io.InputStream;
+import java.net.URL;
+
 /**
  * @author Andres Almiray
  */
-@org.kordamp.jipsy.ServiceProviderFor(org.kordamp.ikonli.IkonHandler.class)
-public class BoxiconsRegularIkonHandler extends org.kordamp.ikonli.AbstractIkonHandler {
+@ServiceProviderFor(IkonHandler.class)
+public class BoxiconsRegularIkonHandler extends AbstractIkonHandler {
+    private static final String FONT_RESOURCE = "/META-INF/resources/boxicons/2.0.7/fonts/boxicons.ttf";
+
     @Override
     public boolean supports(String description) {
         return description != null && description.startsWith("bx-");
     }
 
     @Override
-    public org.kordamp.ikonli.Ikon resolve(String description) {
+    public Ikon resolve(String description) {
         return BoxiconsRegular.findByDescription(description);
     }
 
     @Override
-    public String getFontResourcePath() {
-        return getClass().getResource("/META-INF/resources/boxicons/2.0.7/fonts/boxicons.ttf")
-            .toExternalForm();
+    public URL getFontResource() {
+        return getClass().getResource(FONT_RESOURCE);
+    }
+
+    @Override
+    public InputStream getFontResourceAsStream() {
+        return getClass().getResourceAsStream(FONT_RESOURCE);
     }
 
     @Override

diff --git a/...nli-boxicons-pack/src/main/java/org/kordamp/ikonli/boxicons/BoxiconsSolidIkonHandler.java b/...nli-boxicons-pack/src/main/java/org/kordamp/ikonli/boxicons/BoxiconsSolidIkonHandler.java
@@ -17,25 +17,39 @@
  */
 package org.kordamp.ikonli.boxicons;
 
+import org.kordamp.ikonli.AbstractIkonHandler;
+import org.kordamp.ikonli.Ikon;
+import org.kordamp.ikonli.IkonHandler;
+import org.kordamp.jipsy.ServiceProviderFor;
+
+import java.io.InputStream;
+import java.net.URL;
+
 /**
  * @author Andres Almiray
  */
-@org.kordamp.jipsy.ServiceProviderFor(org.kordamp.ikonli.IkonHandler.class)
-public class BoxiconsSolidIkonHandler extends org.kordamp.ikonli.AbstractIkonHandler {
+@ServiceProviderFor(IkonHandler.class)
+public class BoxiconsSolidIkonHandler extends AbstractIkonHandler {
+    private static final String FONT_RESOURCE = "/META-INF/resources/boxicons/2.0.7/fonts/boxicons.ttf";
+
     @Override
     public boolean supports(String description) {
         return description != null && description.startsWith("bxs-");
     }
 
     @Override
-    public org.kordamp.ikonli.Ikon resolve(String description) {
+    public Ikon resolve(String description) {
         return BoxiconsSolid.findByDescription(description);
     }
 
     @Override
-    public String getFontResourcePath() {
-        return getClass().getResource("/META-INF/resources/boxicons/2.0.7/fonts/boxicons.ttf")
-            .toExternalForm();
+    public URL getFontResource() {
+        return getClass().getResource(FONT_RESOURCE);
+    }
+
+    @Override
+    public InputStream getFontResourceAsStream() {
+        return getClass().getResourceAsStream(FONT_RESOURCE);
     }
 
     @Override

diff --git a/icon-packs/ikonli-bpmn-pack/src/main/java/org/kordamp/ikonli/bpmn/BpmnIkonHandler.java b/icon-packs/ikonli-bpmn-pack/src/main/java/org/kordamp/ikonli/bpmn/BpmnIkonHandler.java
@@ -22,11 +22,16 @@
 import org.kordamp.ikonli.IkonHandler;
 import org.kordamp.jipsy.ServiceProviderFor;
 
+import java.io.InputStream;
+import java.net.URL;
+
 /**
  * @author Andres Almiray
  */
 @ServiceProviderFor(IkonHandler.class)
 public class BpmnIkonHandler extends AbstractIkonHandler {
+    private static final String FONT_RESOURCE = "/META-INF/resources/bpmn/0.10.0/fonts/bpmn.ttf";
+
     @Override
     public boolean supports(String description) {
         return description != null && description.startsWith("bpmn-");
@@ -38,9 +43,13 @@ public Ikon resolve(String description) {
     }
 
     @Override
-    public String getFontResourcePath() {
-        return getClass().getResource("/META-INF/resources/bpmn/0.10.0/fonts/bpmn.ttf")
-            .toExternalForm();
+    public URL getFontResource() {
+        return getClass().getResource(FONT_RESOURCE);
+    }
+
+    @Override
+    public InputStream getFontResourceAsStream() {
+        return getClass().getResourceAsStream(FONT_RESOURCE);
     }
 
     @Override