org.controlsfx.glyphfont

Class GlyphFontRegistry

java.lang.Object

org.controlsfx.glyphfont.GlyphFontRegistry

public final class GlyphFontRegistry
extends Object

The glyph font registry automatically registers available fonts using a ServiceLoader facility, however it is also possible to register glyph fonts manually using the provided register(GlyphFont) method.

Once registered, fonts and their glyphs can be requested by name using the glyph(String) and glyph(String, String) methods. For example:

 import static org.controlsfx.glyphfont.GlyphFontRegistry.glyph; 
 new Button("", glyph("FontAwesome|TRASH")) 
 

An ability to retrieve glyph node by combination of font name and glyph name extends to the ActionProxy graphic attribute, where the "font>" prefix should be used. For more information see ActionProxy.

Method Summary

Modifier and Type	Method and Description
static GlyphFont	font(String fontName) Retrieve font by font
static Node	glyph(String fontAndGlyph) Retrieve glyph by font name and glyph name using one string where font name an glyph name are separated by pipe
static Node	glyph(String fontName, String glyphName) Retrieve one glyph by font name and glyph name
static void	register(GlyphFont font) Registers specified font

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

register

public static void register(GlyphFont font)

Registers specified font

Parameters:

font -

font

public static GlyphFont font(String fontName)

Retrieve font by font

Parameters:

fontName - font name

Returns:

font or null if not found

glyph

public static Node glyph(String fontName,
                         String glyphName)

Retrieve one glyph by font name and glyph name

Parameters:

fontName - font name

glyphName - glyph name

Returns:

glyph as a Node

glyph

public static Node glyph(String fontAndGlyph)

Retrieve glyph by font name and glyph name using one string where font name an glyph name are separated by pipe

Parameters:

fontAndGlyph - font and glyph

Returns:

glyph as Node