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

This commit is contained in:
Karl Tauber
2022-11-21 11:51:27 +01:00
parent 6afc747790
commit d491847754
25 changed files with 525 additions and 126 deletions

View File

@@ -15,8 +15,15 @@ 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
FlatJetBrainsMonoFont.installLazy();
~~~
Or load immediately with:
~~~java
FlatJetBrainsMonoFont.install();
@@ -26,13 +33,13 @@ FlatJetBrainsMonoFont.install();
How to use?
-----------
Use as default monospaced font:
Use as application monospaced font (invoke before setting up FlatLaf):
~~~java
FlatLaf.setPreferredMonospacedFontFamily( FlatJetBrainsMonoFont.FAMILY );
~~~
Create fonts:
Create single fonts:
~~~java
// basic styles
@@ -42,6 +49,25 @@ new Font( FlatJetBrainsMonoFont.FAMILY, Font.BOLD, 12 );
new Font( FlatJetBrainsMonoFont.FAMILY, Font.BOLD | Font.ITALIC, 12 );
~~~
If using lazy loading, invoke one of following before creating the font:
~~~java
FontUtils.loadFontFamily( FlatJetBrainsMonoFont.FAMILY );
~~~
E.g.:
~~~java
FontUtils.loadFontFamily( FlatJetBrainsMonoFont.FAMILY );
Font font = new Font( FlatJetBrainsMonoFont.FAMILY, Font.PLAIN, 12 );
~~~
Or use following:
~~~java
Font font = FontUtils.getCompositeFont( FlatJetBrainsMonoFont.FAMILY, Font.PLAIN, 12 );
~~~
Download
--------

View File

@@ -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" )

View File

@@ -16,11 +16,7 @@
package com.formdev.flatlaf.fonts.jetbrains_mono;
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 JetBrains Mono font family.
@@ -28,23 +24,46 @@ import java.io.InputStream;
* Font home page: <a href="https://www.jetbrains.com/mono">https://www.jetbrains.com/mono</a><br>
* GitHub project: <a href="https://github.com/JetBrains/JetBrainsMono">https://github.com/JetBrains/JetBrainsMono</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
* FlatJetBrainsMonoFont.installLazy();
* }</pre>
* <p>
* Or load immediately with:
* <pre>{@code
* FlatJetBrainsMonoFont.install();
* }</pre>
* <p>
* Use as default monospaced font:
* Use as application monospaced font (invoke before setting up FlatLaf):
* <pre>{@code
* FlatLaf.setPreferredMonospacedFontFamily( FlatJetBrainsMonoFont.FAMILY );
* }</pre>
* <p>
* Create fonts:
* Create single fonts:
* <pre>{@code
* new Font( FlatJetBrainsMonoFont.FAMILY, Font.PLAIN, 12 );
* new Font( FlatJetBrainsMonoFont.FAMILY, Font.ITALIC, 12 );
* new Font( FlatJetBrainsMonoFont.FAMILY, Font.BOLD, 12 );
* new Font( FlatJetBrainsMonoFont.FAMILY, Font.BOLD | Font.ITALIC, 12 );
* }</pre>
* <p>
* If using lazy loading, invoke following before creating the font:
* <pre>{@code
* FontUtils.loadFontFamily( FlatJetBrainsMonoFont.FAMILY );
* }</pre>
* <p>
* E.g.:
* <pre>{@code
* FontUtils.loadFontFamily( FlatJetBrainsMonoFont.FAMILY );
* Font font = new Font( FlatJetBrainsMonoFont.FAMILY, Font.PLAIN, 12 );
* }</pre>
* <p>
* Or use following:
* <pre>{@code
* Font font = FontUtils.getCompositeFont( FlatJetBrainsMonoFont.FAMILY, Font.PLAIN, 12 );
* }</pre>
*
* @author Karl Tauber
*/
@@ -76,8 +95,24 @@ public class FlatJetBrainsMonoFont
private FlatJetBrainsMonoFont() {}
/**
* 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, FlatJetBrainsMonoFont::install );
}
/**
* Creates and registers the fonts for all styles.
* <p>
* When using FlatLaf, consider using {@link #installLazy()}.
*/
public static void install() {
installStyle( STYLE_REGULAR );
@@ -91,15 +126,6 @@ public class FlatJetBrainsMonoFont
* See {@code STYLE_} constants.
*/
public static boolean installStyle( String name ) {
try( InputStream in = FlatJetBrainsMonoFont.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( FlatJetBrainsMonoFont.class.getResource( name ) );
}
}

View File

@@ -19,6 +19,7 @@
*/
module com.formdev.flatlaf.fonts.jetbrains_mono {
requires java.desktop;
requires com.formdev.flatlaf;
exports com.formdev.flatlaf.fonts.jetbrains_mono;