com.lowagie.text

Class FontFactory

public final class FontFactory extends Object

If you are using True Type fonts, you can declare the paths of the different ttf- and ttc-files to this static class first and then create fonts in your code using one of the static getFont-method without having to enter a path as parameter.

Author: Bruno Lowagie

Field Summary
static StringCOURIER
This is a possible value of a base 14 type 1 font
static StringCOURIER_BOLD
This is a possible value of a base 14 type 1 font
static StringCOURIER_BOLDOBLIQUE
This is a possible value of a base 14 type 1 font
static StringCOURIER_OBLIQUE
This is a possible value of a base 14 type 1 font
static booleandefaultEmbedding
This is the default value of the embedded variable.
static StringdefaultEncoding
This is the default encoding to use.
static FontFactoryImpfontImp
static StringHELVETICA
This is a possible value of a base 14 type 1 font
static StringHELVETICA_BOLD
This is a possible value of a base 14 type 1 font
static StringHELVETICA_BOLDOBLIQUE
This is a possible value of a base 14 type 1 font
static StringHELVETICA_OBLIQUE
This is a possible value of a base 14 type 1 font
static StringSYMBOL
This is a possible value of a base 14 type 1 font
static StringTIMES
This is a possible value of a base 14 type 1 font
static StringTIMES_BOLD
This is a possible value of a base 14 type 1 font
static StringTIMES_BOLDITALIC
This is a possible value of a base 14 type 1 font
static StringTIMES_ITALIC
This is a possible value of a base 14 type 1 font
static StringTIMES_ROMAN
This is a possible value of a base 14 type 1 font
static StringZAPFDINGBATS
This is a possible value of a base 14 type 1 font
Constructor Summary
FontFactory()
Creates new FontFactory
Method Summary
static booleancontains(String fontname)
Gets a set of registered fontnames.
static FontgetFont(String fontname, String encoding, boolean embedded, float size, int style, Color color)
Constructs a Font-object.
static FontgetFont(String fontname, String encoding, boolean embedded, float size, int style, Color color, boolean cached)
Constructs a Font-object.
static FontgetFont(Properties attributes)
Constructs a Font-object.
static FontgetFont(String fontname, String encoding, boolean embedded, float size, int style)
Constructs a Font-object.
static FontgetFont(String fontname, String encoding, boolean embedded, float size)
Constructs a Font-object.
static FontgetFont(String fontname, String encoding, boolean embedded)
Constructs a Font-object.
static FontgetFont(String fontname, String encoding, float size, int style, Color color)
Constructs a Font-object.
static FontgetFont(String fontname, String encoding, float size, int style)
Constructs a Font-object.
static FontgetFont(String fontname, String encoding, float size)
Constructs a Font-object.
static FontgetFont(String fontname, String encoding)
Constructs a Font-object.
static FontgetFont(String fontname, float size, int style, Color color)
Constructs a Font-object.
static FontgetFont(String fontname, float size, Color color)
Constructs a Font-object.
static FontgetFont(String fontname, float size, int style)
Constructs a Font-object.
static FontgetFont(String fontname, float size)
Constructs a Font-object.
static FontgetFont(String fontname)
Constructs a Font-object.
static FontFactoryImpgetFontImp()
Gets the font factory implementation.
static SetgetRegisteredFamilies()
Gets a set of registered fontnames.
static SetgetRegisteredFonts()
Gets a set of registered fontnames.
static booleanisRegistered(String fontname)
Checks if a certain font is registered.
static voidregister(String path)
Register a ttf- or a ttc-file.
static voidregister(String path, String alias)
Register a font file and use an alias for the font contained in it.
static intregisterDirectories()
Register fonts in some probable directories.
static intregisterDirectory(String dir)
Register all the fonts in a directory.
static intregisterDirectory(String dir, boolean scanSubdirectories)
Register all the fonts in a directory and possibly its subdirectories.
voidregisterFamily(String familyName, String fullName, String path)
Register a font by giving explicitly the font family and name.
static voidsetFontImp(FontFactoryImp fontImp)
Sets the font factory implementation.

Field Detail

COURIER

public static final String COURIER
This is a possible value of a base 14 type 1 font

COURIER_BOLD

public static final String COURIER_BOLD
This is a possible value of a base 14 type 1 font

COURIER_BOLDOBLIQUE

public static final String COURIER_BOLDOBLIQUE
This is a possible value of a base 14 type 1 font

COURIER_OBLIQUE

public static final String COURIER_OBLIQUE
This is a possible value of a base 14 type 1 font

defaultEmbedding

public static boolean defaultEmbedding
This is the default value of the embedded variable.

defaultEncoding

public static String defaultEncoding
This is the default encoding to use.

fontImp

private static FontFactoryImp fontImp

HELVETICA

public static final String HELVETICA
This is a possible value of a base 14 type 1 font

HELVETICA_BOLD

public static final String HELVETICA_BOLD
This is a possible value of a base 14 type 1 font

HELVETICA_BOLDOBLIQUE

public static final String HELVETICA_BOLDOBLIQUE
This is a possible value of a base 14 type 1 font

HELVETICA_OBLIQUE

public static final String HELVETICA_OBLIQUE
This is a possible value of a base 14 type 1 font

SYMBOL

public static final String SYMBOL
This is a possible value of a base 14 type 1 font

TIMES

public static final String TIMES
This is a possible value of a base 14 type 1 font

TIMES_BOLD

public static final String TIMES_BOLD
This is a possible value of a base 14 type 1 font

TIMES_BOLDITALIC

public static final String TIMES_BOLDITALIC
This is a possible value of a base 14 type 1 font

TIMES_ITALIC

public static final String TIMES_ITALIC
This is a possible value of a base 14 type 1 font

TIMES_ROMAN

public static final String TIMES_ROMAN
This is a possible value of a base 14 type 1 font

ZAPFDINGBATS

public static final String ZAPFDINGBATS
This is a possible value of a base 14 type 1 font

Constructor Detail

FontFactory

private FontFactory()
Creates new FontFactory

Method Detail

contains

public static boolean contains(String fontname)
Gets a set of registered fontnames.

Parameters: fontname of a font that may or may not be registered

Returns: true if a given font is registered

getFont

public static Font getFont(String fontname, String encoding, boolean embedded, float size, int style, Color color)
Constructs a Font-object.

Parameters: fontname the name of the font encoding the encoding of the font embedded true if the font is to be embedded in the PDF size the size of this font style the style of this font color the Color of this font.

Returns: the Font constructed based on the parameters

getFont

public static Font getFont(String fontname, String encoding, boolean embedded, float size, int style, Color color, boolean cached)
Constructs a Font-object.

Parameters: fontname the name of the font encoding the encoding of the font embedded true if the font is to be embedded in the PDF size the size of this font style the style of this font color the Color of this font. cached true if the font comes from the cache or is added to the cache if new, false if the font is always created new

Returns: the Font constructed based on the parameters

getFont

public static Font getFont(Properties attributes)
Constructs a Font-object.

Parameters: attributes the attributes of a Font object.

Returns: the Font constructed based on the attributes

getFont

public static Font getFont(String fontname, String encoding, boolean embedded, float size, int style)
Constructs a Font-object.

Parameters: fontname the name of the font encoding the encoding of the font embedded true if the font is to be embedded in the PDF size the size of this font style the style of this font

Returns: the Font constructed based on the parameters

getFont

public static Font getFont(String fontname, String encoding, boolean embedded, float size)
Constructs a Font-object.

Parameters: fontname the name of the font encoding the encoding of the font embedded true if the font is to be embedded in the PDF size the size of this font

Returns: the Font constructed based on the parameters

getFont

public static Font getFont(String fontname, String encoding, boolean embedded)
Constructs a Font-object.

Parameters: fontname the name of the font encoding the encoding of the font embedded true if the font is to be embedded in the PDF

Returns: the Font constructed based on the parameters

getFont

public static Font getFont(String fontname, String encoding, float size, int style, Color color)
Constructs a Font-object.

Parameters: fontname the name of the font encoding the encoding of the font size the size of this font style the style of this font color the Color of this font.

Returns: the Font constructed based on the parameters

getFont

public static Font getFont(String fontname, String encoding, float size, int style)
Constructs a Font-object.

Parameters: fontname the name of the font encoding the encoding of the font size the size of this font style the style of this font

Returns: the Font constructed based on the parameters

getFont

public static Font getFont(String fontname, String encoding, float size)
Constructs a Font-object.

Parameters: fontname the name of the font encoding the encoding of the font size the size of this font

Returns: the Font constructed based on the parameters

getFont

public static Font getFont(String fontname, String encoding)
Constructs a Font-object.

Parameters: fontname the name of the font encoding the encoding of the font

Returns: the Font constructed based on the parameters

getFont

public static Font getFont(String fontname, float size, int style, Color color)
Constructs a Font-object.

Parameters: fontname the name of the font size the size of this font style the style of this font color the Color of this font.

Returns: the Font constructed based on the parameters

getFont

public static Font getFont(String fontname, float size, Color color)
Constructs a Font-object.

Parameters: fontname the name of the font size the size of this font color the Color of this font.

Returns: the Font constructed based on the parameters

Since: 2.1.0

getFont

public static Font getFont(String fontname, float size, int style)
Constructs a Font-object.

Parameters: fontname the name of the font size the size of this font style the style of this font

Returns: the Font constructed based on the parameters

getFont

public static Font getFont(String fontname, float size)
Constructs a Font-object.

Parameters: fontname the name of the font size the size of this font

Returns: the Font constructed based on the parameters

getFont

public static Font getFont(String fontname)
Constructs a Font-object.

Parameters: fontname the name of the font

Returns: the Font constructed based on the parameters

getFontImp

public static FontFactoryImp getFontImp()
Gets the font factory implementation.

Returns: the font factory implementation

getRegisteredFamilies

public static Set getRegisteredFamilies()
Gets a set of registered fontnames.

Returns: a set of registered font families

getRegisteredFonts

public static Set getRegisteredFonts()
Gets a set of registered fontnames.

Returns: a set of registered fonts

isRegistered

public static boolean isRegistered(String fontname)
Checks if a certain font is registered.

Parameters: fontname the name of the font that has to be checked.

Returns: true if the font is found

register

public static void register(String path)
Register a ttf- or a ttc-file.

Parameters: path the path to a ttf- or ttc-file

register

public static void register(String path, String alias)
Register a font file and use an alias for the font contained in it.

Parameters: path the path to a font file alias the alias you want to use for the font

registerDirectories

public static int registerDirectories()
Register fonts in some probable directories. It usually works in Windows, Linux and Solaris.

Returns: the number of fonts registered

registerDirectory

public static int registerDirectory(String dir)
Register all the fonts in a directory.

Parameters: dir the directory

Returns: the number of fonts registered

registerDirectory

public static int registerDirectory(String dir, boolean scanSubdirectories)
Register all the fonts in a directory and possibly its subdirectories.

Parameters: dir the directory scanSubdirectories recursively scan subdirectories if true

Returns: the number of fonts registered

Since: 2.1.2

registerFamily

public void registerFamily(String familyName, String fullName, String path)
Register a font by giving explicitly the font family and name.

Parameters: familyName the font family fullName the font name path the font path

setFontImp

public static void setFontImp(FontFactoryImp fontImp)
Sets the font factory implementation.

Parameters: fontImp the font factory implementation