Package org.apache.fop.fonts
Class FontLoader
- java.lang.Object
-
- org.apache.fop.fonts.FontLoader
-
- Direct Known Subclasses:
OFFontLoader
,Type1FontLoader
public abstract class FontLoader extends java.lang.Object
Base class for font loaders.
-
-
Field Summary
Fields Modifier and Type Field Description protected boolean
embedded
true if the font will be embedded, false if it will be referenced only.protected java.net.URI
fontFileURI
URI representing the font fileprotected boolean
loaded
true if the font has been loadedprotected static org.apache.commons.logging.Log
log
logging instanceprotected InternalResourceResolver
resourceResolver
the resource resolver to use for font URI resolutionprotected CustomFont
returnFont
the loaded fontprotected boolean
useAdvanced
true if advanced typographic information shall be loaded if available.protected boolean
useKerning
true if kerning information false be loaded if available.
-
Constructor Summary
Constructors Constructor Description FontLoader(java.net.URI fontFileURI, boolean embedded, boolean useKerning, boolean useAdvanced, InternalResourceResolver resourceResolver)
Default constructor.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description CustomFont
getFont()
Returns the custom font that was read using this instance of FontLoader.static CustomFont
loadFont(FontUris fontUris, java.lang.String subFontName, boolean embedded, EmbeddingMode embeddingMode, EncodingMode encodingMode, boolean useKerning, boolean useAdvanced, InternalResourceResolver resourceResolver, boolean simulateStyle, boolean embedAsType1, boolean useSVG)
Loads a custom font from a URI.protected abstract void
read()
Reads/parses the font data.
-
-
-
Field Detail
-
log
protected static final org.apache.commons.logging.Log log
logging instance
-
fontFileURI
protected final java.net.URI fontFileURI
URI representing the font file
-
resourceResolver
protected final InternalResourceResolver resourceResolver
the resource resolver to use for font URI resolution
-
returnFont
protected CustomFont returnFont
the loaded font
-
loaded
protected boolean loaded
true if the font has been loaded
-
embedded
protected boolean embedded
true if the font will be embedded, false if it will be referenced only.
-
useKerning
protected boolean useKerning
true if kerning information false be loaded if available.
-
useAdvanced
protected boolean useAdvanced
true if advanced typographic information shall be loaded if available.
-
-
Constructor Detail
-
FontLoader
public FontLoader(java.net.URI fontFileURI, boolean embedded, boolean useKerning, boolean useAdvanced, InternalResourceResolver resourceResolver)
Default constructor.- Parameters:
fontFileURI
- the URI to the PFB file of a Type 1 fontembedded
- indicates whether the font is embedded or referenceduseKerning
- indicates whether kerning information shall be loaded if availableuseAdvanced
- indicates whether advanced typographic information shall be loaded if availableresourceResolver
- the font resolver used to resolve URIs
-
-
Method Detail
-
loadFont
public static CustomFont loadFont(FontUris fontUris, java.lang.String subFontName, boolean embedded, EmbeddingMode embeddingMode, EncodingMode encodingMode, boolean useKerning, boolean useAdvanced, InternalResourceResolver resourceResolver, boolean simulateStyle, boolean embedAsType1, boolean useSVG) throws java.io.IOException
Loads a custom font from a URI. In the case of Type 1 fonts, the PFB file must be specified.- Parameters:
fontUris
- the URI to the fontsubFontName
- the sub-fontname of a font (for TrueType Collections, null otherwise)embedded
- indicates whether the font is embedded or referencedembeddingMode
- the embedding mode of the fontencodingMode
- the requested encoding modeuseKerning
- indicates whether kerning information should be loaded if availableuseAdvanced
- indicates whether advanced typographic information shall be loaded if availableresourceResolver
- the font resolver to use when resolving URIs- Returns:
- the newly loaded font
- Throws:
java.io.IOException
- In case of an I/O error
-
read
protected abstract void read() throws java.io.IOException
Reads/parses the font data.- Throws:
java.io.IOException
- In case of an I/O error
-
getFont
public CustomFont getFont() throws java.io.IOException
Returns the custom font that was read using this instance of FontLoader.- Returns:
- the newly loaded font
- Throws:
java.io.IOException
- if an I/O error occurs
-
-