Fonts: support lazy font file loading (extends PRs #545 and #614)

2025-12-09 08:15:09 +03:00 · 2022-11-21 11:51:27 +01:00
parent 6afc747790
commit d491847754
25 changed files with 525 additions and 126 deletions
--- a/flatlaf-fonts/flatlaf-fonts-inter/README.md
+++ b/flatlaf-fonts/flatlaf-fonts-inter/README.md
@@ -18,18 +18,29 @@ License:
 How to install?
 ---------------

-Invoke the `install()` method once (e.g. in your `main()` method; on AWT
-thread):
+Invoke following once (e.g. in your `main()` method; on AWT thread).
+
+For lazy loading use:
+
+~~~java
+FlatInterFont.installLazy();
+~~~
+
+Or load immediately with:

 ~~~java
 FlatInterFont.install();
+// or
+FlatInterFont.installBasic();
+FlatInterFont.installLight();
+FlatInterFont.installSemiBold();
 ~~~


 How to use?
 -----------

-Use as default font:
+Use as application font (invoke before setting up FlatLaf):

 ~~~java
 FlatLaf.setPreferredFontFamily( FlatInterFont.FAMILY );
@@ -37,7 +48,7 @@ FlatLaf.setPreferredLightFontFamily( FlatInterFont.FAMILY_LIGHT );
 FlatLaf.setPreferredSemiboldFontFamily( FlatInterFont.FAMILY_SEMIBOLD );
 ~~~

-Create fonts:
+Create single fonts:

 ~~~java
 // basic styles
@@ -55,6 +66,27 @@ new Font( FlatInterFont.FAMILY_SEMIBOLD, Font.PLAIN, 12 );
 new Font( FlatInterFont.FAMILY_SEMIBOLD, Font.ITALIC, 12 );
 ~~~

+If using lazy loading, invoke one of following before creating the font:
+
+~~~java
+FontUtils.loadFontFamily( FlatInterFont.FAMILY );
+FontUtils.loadFontFamily( FlatInterFont.FAMILY_LIGHT );
+FontUtils.loadFontFamily( FlatInterFont.FAMILY_SEMIBOLD );
+~~~
+
+E.g.:
+
+~~~java
+FontUtils.loadFontFamily( FlatInterFont.FAMILY );
+Font font = new Font( FlatInterFont.FAMILY, Font.PLAIN, 12 );
+~~~
+
+Or use following:
+
+~~~java
+Font font = FontUtils.getCompositeFont( FlatInterFont.FAMILY, Font.PLAIN, 12 );
+~~~
+

 Download
 --------
--- a/flatlaf-fonts/flatlaf-fonts-inter/build.gradle.kts
+++ b/flatlaf-fonts/flatlaf-fonts-inter/build.gradle.kts
@@ -31,6 +31,8 @@ plugins {
 }

 dependencies {
+	implementation( project( ":flatlaf-core" ) )
+
 	testImplementation( "org.junit.jupiter:junit-jupiter-api:5.7.2" )
 	testImplementation( "org.junit.jupiter:junit-jupiter-params" )
 	testRuntimeOnly( "org.junit.jupiter:junit-jupiter-engine" )
--- a/flatlaf-fonts/flatlaf-fonts-inter/src/main/java/com/formdev/flatlaf/fonts/inter/FlatInterFont.java
+++ b/flatlaf-fonts/flatlaf-fonts-inter/src/main/java/com/formdev/flatlaf/fonts/inter/FlatInterFont.java
@@ -16,11 +16,7 @@

 package com.formdev.flatlaf.fonts.inter;

-import java.awt.Font;
-import java.awt.FontFormatException;
-import java.awt.GraphicsEnvironment;
-import java.io.IOException;
-import java.io.InputStream;
+import com.formdev.flatlaf.util.FontUtils;

 /**
 * The Inter font family.
@@ -31,19 +27,30 @@ import java.io.InputStream;
 * Font home page: <a href="https://rsms.me/inter/">https://rsms.me/inter/</a><br>
 * GitHub project: <a href="https://github.com/rsms/inter">https://github.com/rsms/inter</a>
 * <p>
- * To install the font, invoke following once (e.g. in your {@code main()} method; on AWT thread):
+ * To install the font, invoke following once (e.g. in your {@code main()} method; on AWT thread).
+ * <p>
+ * For lazy loading use:
 * <pre>{@code
- * FlatInterFont.install();
+ * FlatInterFont.installLazy();
 * }</pre>
 * <p>
- * Use as default font:
+ * Or load immediately with:
+ * <pre>{@code
+ * FlatInterFont.install();
+ * // or
+ * FlatInterFont.installBasic();
+ * FlatInterFont.installLight();
+ * FlatInterFont.installSemiBold();
+ * }</pre>
+ * <p>
+ * Use as application font (invoke before setting up FlatLaf):
 * <pre>{@code
 * FlatLaf.setPreferredFontFamily( FlatInterFont.FAMILY );
 * FlatLaf.setPreferredLightFontFamily( FlatInterFont.FAMILY_LIGHT );
 * FlatLaf.setPreferredSemiboldFontFamily( FlatInterFont.FAMILY_SEMIBOLD );
 * }</pre>
 * <p>
- * Create fonts:
+ * Create single fonts:
 * <pre>{@code
 * new Font( FlatInterFont.FAMILY, Font.PLAIN, 12 );
 * new Font( FlatInterFont.FAMILY, Font.ITALIC, 12 );
@@ -54,6 +61,24 @@ import java.io.InputStream;
 * new Font( FlatInterFont.FAMILY_SEMIBOLD, Font.PLAIN, 12 );
 * new Font( FlatInterFont.FAMILY_SEMIBOLD, Font.ITALIC, 12 );
 * }</pre>
+ * <p>
+ * If using lazy loading, invoke one of following before creating the font:
+ * <pre>{@code
+ * FontUtils.loadFontFamily( FlatInterFont.FAMILY );
+ * FontUtils.loadFontFamily( FlatInterFont.FAMILY_LIGHT );
+ * FontUtils.loadFontFamily( FlatInterFont.FAMILY_SEMIBOLD );
+ * }</pre>
+ * <p>
+ * E.g.:
+ * <pre>{@code
+ * FontUtils.loadFontFamily( FlatInterFont.FAMILY );
+ * Font font = new Font( FlatInterFont.FAMILY, Font.PLAIN, 12 );
+ * }</pre>
+ * <p>
+ * Or use following:
+ * <pre>{@code
+ * Font font = FontUtils.getCompositeFont( FlatInterFont.FAMILY, Font.PLAIN, 12 );
+ * }</pre>
 *
 * @author Karl Tauber
 */
@@ -115,21 +140,61 @@ public class FlatInterFont

 	private FlatInterFont() {}

+	/**
+	 * Registers the fonts for lazy loading via {@link FontUtils#registerFontFamilyLoader(String, Runnable)}.
+	 * <p>
+	 * This is the preferred method (when using FlatLaf) to avoid unnecessary loading of maybe unused fonts.
+	 * <p>
+	 * <strong>Note</strong>: When using '{@code new Font(...)}', you need to first invoke
+	 * {@link FontUtils#loadFontFamily(family)} to ensure that the font family is loaded.
+	 * When FlatLaf loads a font, or when using {@link FontUtils#getCompositeFont(family, style, size)},
+	 * this is done automatically.
+	 */
+	public static void installLazy() {
+		FontUtils.registerFontFamilyLoader( FAMILY, FlatInterFont::installBasic );
+		FontUtils.registerFontFamilyLoader( FAMILY_LIGHT, FlatInterFont::installLight );
+		FontUtils.registerFontFamilyLoader( FAMILY_SEMIBOLD, FlatInterFont::installSemiBold );
+	}
+
 	/**
 	 * Creates and registers the fonts for all styles.
+	 * <p>
+	 * When using FlatLaf, consider using {@link #installLazy()}.
 	 */
 	public static void install() {
-		// basic styles
+		installBasic();
+		installLight();
+		installSemiBold();
+	}
+
+	/**
+	 * Creates and registers the fonts for basic styles (regular, italic and bold).
+	 * <p>
+	 * When using FlatLaf, consider using {@link #installLazy()}.
+	 */
+	public static void installBasic() {
 		installStyle( STYLE_REGULAR );
 		installStyle( STYLE_ITALIC );
 		installStyle( STYLE_BOLD );
 		installStyle( STYLE_BOLD_ITALIC );
+	}

-		// light
+	/**
+	 * Creates and registers the fonts for light styles.
+	 * <p>
+	 * When using FlatLaf, consider using {@link #installLazy()}.
+	 */
+	public static void installLight() {
 		installStyle( STYLE_LIGHT );
 		installStyle( STYLE_LIGHT_ITALIC );
+	}

-		// semibold
+	/**
+	 * Creates and registers the fonts for semibold styles.
+	 * <p>
+	 * When using FlatLaf, consider using {@link #installLazy()}.
+	 */
+	public static void installSemiBold() {
 		installStyle( STYLE_SEMIBOLD );
 		installStyle( STYLE_SEMIBOLD_ITALIC );
 	}
@@ -139,15 +204,6 @@ public class FlatInterFont
 	 * See {@code STYLE_} constants.
 	 */
 	public static boolean installStyle( String name ) {
-		try( InputStream in = FlatInterFont.class.getResourceAsStream( name ) ) {
-			Font font = Font.createFont( Font.TRUETYPE_FONT, in );
-			return GraphicsEnvironment.getLocalGraphicsEnvironment().registerFont( font );
-		} catch( FontFormatException ex ) {
-			ex.printStackTrace();
-			return false;
-		} catch( IOException ex ) {
-			ex.printStackTrace();
-			return false;
-		}
+		return FontUtils.installFont( FlatInterFont.class.getResource( name ) );
 	}
 }
--- a/flatlaf-fonts/flatlaf-fonts-inter/src/main/module-info/module-info.java
+++ b/flatlaf-fonts/flatlaf-fonts-inter/src/main/module-info/module-info.java
@@ -19,6 +19,7 @@
 */
 module com.formdev.flatlaf.fonts.inter {
 	requires java.desktop;
+	requires com.formdev.flatlaf;

 	exports com.formdev.flatlaf.fonts.inter;