org.docx4j.fonts

Class PhysicalFonts

java.lang.Object

org.docx4j.fonts.PhysicalFonts

public class PhysicalFonts
extends Object

The fonts which are physically installed on the system. They can be discovered automatically, or you can just add specific fonts. Do NOT add fonts embedded in a docx to physicalFontMap!

Author:

dev

Field Summary

Fields

Modifier and Type	Field and Description
protected static FontCache	fontCache
protected static org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
PhysicalFonts()

Method Summary

Modifier and Type	Method and Description
static void	addPhysicalFont(URL fontUrl) Add a physical font's EmbedFontInfo object.
static void	addPhysicalFonts(String nameAsInFontTablePart, URL fontUrl) Add a physical font's EmbedFontInfo object.
static void	discoverPhysicalFonts() Autodetect fonts available on the system.
static PhysicalFont	get(String key) Get a PhysicalFont by case-insensitive name.
static PhysicalFont	getBoldForm(PhysicalFont pf)
static PhysicalFont	getBoldItalicForm(PhysicalFont pf)
static PhysicalFont	getItalicForm(PhysicalFont pf)
static String	getPhysicalFont(OpcPackage wmlPackage, String fontName)
static List<PhysicalFont>	getPhysicalFont(String nameAsInFontTablePart, URL fontUrl) Get a physical font's EmbedFontInfo object.
static Map<String,PhysicalFont>	getPhysicalFonts() Deprecated.
static String	getRegex()
static void	main(String[] args)
static void	put(String key, PhysicalFont pf) Put a PhysicalFont by case-insensitive name.
static void	setRegex(String regex) Set a regex to limit to the common fonts in order to lower memory use.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.slf4j.Logger log

fontCache

protected static FontCache fontCache

Constructor Detail

PhysicalFonts

public PhysicalFonts()

Method Detail

getPhysicalFonts

@Deprecated
public static Map<String,PhysicalFont> getPhysicalFonts()

Deprecated.

get

public static PhysicalFont get(String key)

Get a PhysicalFont by case-insensitive name. (Although Word always uses Title Case for font names, it is actually case insensitive; the spec is silent on this.)

Parameters:

key -

Returns:

put

public static void put(String key,
                       PhysicalFont pf)

Put a PhysicalFont by case-insensitive name. (Although Word always uses Title Case for font names, it is actually case insensitive; the spec is silent on this.)

Parameters:

key -

pf -

getRegex

public static String getRegex()

setRegex

public static void setRegex(String regex)

Set a regex to limit to the common fonts in order to lower memory use. eg on Mac regex=".*(Courier New|Arial|Times New Roman|Comic Sans|Georgia|Impact|Lucida Console|Lucida Sans Unicode|Palatino Linotype|Tahoma|Trebuchet|Verdana|Symbol|Webdings|Wingdings|MS Sans Serif|MS Serif).*"; on Windows: regex=".*(calibri|cour|arial|times|comic|georgia|impact|LSANS|pala|tahoma|trebuc|verdana|symbol|webdings|wingding).*"; If you want to use this, set it before instantiating a Mapper.

Since:

2.8.1

discoverPhysicalFonts

public static final void discoverPhysicalFonts()
                                        throws Exception

Autodetect fonts available on the system.

Throws:

Exception

addPhysicalFont

public static void addPhysicalFont(URL fontUrl)

Add a physical font's EmbedFontInfo object. Not to be used for embedded fonts.

Parameters:

fontUrl - eg new java.net.URL("file:" + path)

addPhysicalFonts

public static void addPhysicalFonts(String nameAsInFontTablePart,
                                    URL fontUrl)

Add a physical font's EmbedFontInfo object. Not to be used for embedded fonts.

Parameters:

fontUrl - eg new java.net.URL("file:" + path)

getPhysicalFont

public static List<PhysicalFont> getPhysicalFont(String nameAsInFontTablePart,
                                                 URL fontUrl)

Get a physical font's EmbedFontInfo object.

Parameters:

fontUrl - eg new java.net.URL("file:" + path)

getBoldForm

public static PhysicalFont getBoldForm(PhysicalFont pf)

getBoldItalicForm

public static PhysicalFont getBoldItalicForm(PhysicalFont pf)

getItalicForm

public static PhysicalFont getItalicForm(PhysicalFont pf)

getPhysicalFont

public static String getPhysicalFont(OpcPackage wmlPackage,
                                     String fontName)

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception