org.controlsfx.glyphfont

Class GlyphFont

java.lang.Object

org.controlsfx.glyphfont.GlyphFont

Direct Known Subclasses:

FontAwesome

public abstract class GlyphFont
extends Object

Represents a glyph font, which can be loaded locally or from a specified URL. Glyphs can be created easily using specified character defined in the font. For example, \uf013 in FontAwesome is used to represent a gear icon.

To simplify glyph customization, methods can be chained, for example:

  Glyph glyph = fontAwesome.fontSize(28).fontColor(Color.RED).create('\uf013'); //GEAR
  

Here's a screenshot of two font packs being used to render images into JavaFX Button controls:

Constructor Summary

Constructors

Constructor and Description
GlyphFont(String fontName, int defaultSize, InputStream in) Loads glyph font from specified InputStream
GlyphFont(String fontName, int defaultSize, String urlStr) Load glyph font from specified URL

Method Summary

Modifier and Type	Method and Description
Glyph	create(char character) Creates an instance of Glyph using specified font character
Glyph	create(String glyphName) Creates and instance of Glyph using glyph name
GlyphFont	fontColor(Color color) Sets font color
GlyphFont	fontSize(double size) Sets font size
double	getDefaultSize() Returns the default font size
abstract Map<String,Character>	getGlyphs() Returns glyph dictionary
String	getName() Returns font name

Methods inherited from class java.lang.Object

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

Constructor Detail

GlyphFont

public GlyphFont(String fontName,
                 int defaultSize,
                 InputStream in)

Loads glyph font from specified InputStream

Parameters:

fontName - glyph font name

defaultSize - default font size

in - input stream to load the font from

GlyphFont

public GlyphFont(String fontName,
                 int defaultSize,
                 String urlStr)

Load glyph font from specified URL

Parameters:

fontName - glyph font name

defaultSize - default font size

urlStr - URL to load the font from

Method Detail

getName

public String getName()

Returns font name

Returns:

font name

getDefaultSize

public double getDefaultSize()

Returns the default font size

Returns:

default font size

fontSize

public GlyphFont fontSize(double size)

Sets font size

Parameters:

size -

Returns:

font instance so the calls can be chained

fontColor

public GlyphFont fontColor(Color color)

Sets font color

Parameters:

color -

Returns:

font instance so the calls can be chained

create

public Glyph create(char character)

Creates an instance of Glyph using specified font character

Parameters:

character - font character

Returns:

instance of Glyph

create

public Glyph create(String glyphName)

Creates and instance of Glyph using glyph name

Parameters:

glyphName - glyph name

Returns:

glyph by its name or null if name is not found

getGlyphs

public abstract Map<String,Character> getGlyphs()

Returns glyph dictionary

Returns:

Map of glyph name to character