Package org.apache.fop.fonts
Class FontInfo
java.lang.Object
org.apache.fop.fonts.FontInfo
The FontInfo holds font information for the layout and rendering of a fo document.
This stores the list of available fonts that are setup by
the renderer. The font name can be retrieved for the
family style and weight.
Currently font supported font-variant small-caps is not implemented.
Currently font supported font-variant small-caps is not implemented.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final org.apache.commons.logging.Log
logging instance -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addFontProperties
(String name, String[] families, String style, int weight) Adds a series of new font triplets given an array of font family names.void
addFontProperties
(String name, String family, String style, int weight) Adds a new font triplet.void
addFontProperties
(String internalFontKey, FontTriplet triplet) Adds a new font triplet.void
addMetrics
(String internalFontKey, FontMetrics metrics) Adds font metrics for a specific font.static FontTriplet
createFontKey
(String family, String style, int weight) Creates a key from the given strings.void
Diagnostic method for logging all registered fonts to System.out.findAdjustWeight
(String family, String style, int weight) Find a font with a given family and style by trying different font weights according to the spec.fontLookup
(String[] families, String style, int weight) Looks up a set of fonts.fontLookup
(String family, String style, int weight) Lookup a font.getFontInstance
(FontTriplet triplet, int fontSize) Retrieves a (possibly cached) Font instance based on a FontTriplet and a font size.getFontInstanceForAWTFont
(Font awtFont) Returns a suitable internal font given an AWT Font instance.getFonts()
Gets a Map of all registered fonts.getFontStyleFor
(String fontName) Returns the font style for a particular font.Gets a Map of all registered font triplets.int
getFontWeightFor
(String fontName) Returns the font weight for a particular font.getInternalFontKey
(FontTriplet triplet) Returns the internal font key (F1, F2, F3 etc.) for a given triplet.getMetricsFor
(String fontName) Returns the FontMetrics for a particular fontgetTripletFor
(String fontName) Returns the first triplet matching the given font name.getTripletsFor
(String fontName) Returns all font triplet matching the given font name.This is used by the renderers to retrieve all the fonts used in the document.boolean
Determines if a particular font is available.boolean
Checks if the font setup is valid (At least the ultimate fallback font must be registered.)void
notifyStrokingSVGTextAsShapes
(String fontFamily) Notify listeners that the SVG text for the given font will be stroked as shapes.void
setEventListener
(FontEventListener listener) Sets the font event listener that can be used to receive events about particular events in this class.void
Tells this class that the font with the given internal name has been used.
-
Field Details
-
log
protected static final org.apache.commons.logging.Log loglogging instance
-
-
Constructor Details
-
FontInfo
public FontInfo()Main constructor
-
-
Method Details
-
setEventListener
Sets the font event listener that can be used to receive events about particular events in this class.- Parameters:
listener
- the font event listener
-
isSetupValid
public boolean isSetupValid()Checks if the font setup is valid (At least the ultimate fallback font must be registered.)- Returns:
- True if valid
-
addFontProperties
Adds a new font triplet.- Parameters:
name
- internal keyfamily
- font family namestyle
- font style (normal, italic, oblique...)weight
- font weight
-
addFontProperties
Adds a series of new font triplets given an array of font family names.- Parameters:
name
- internal keyfamilies
- an array of font family namesstyle
- font style (normal, italic, oblique...)weight
- font weight
-
addFontProperties
Adds a new font triplet.- Parameters:
internalFontKey
- internal font keytriplet
- the font triplet to associate with the internal key
-
addMetrics
Adds font metrics for a specific font.- Parameters:
internalFontKey
- internal keymetrics
- metrics to register
-
useFont
Tells this class that the font with the given internal name has been used.- Parameters:
internalName
- the internal font name (F1, F2 etc.)
-
getFontInstance
Retrieves a (possibly cached) Font instance based on a FontTriplet and a font size.- Parameters:
triplet
- the font triplet designating the requested fontfontSize
- the font size- Returns:
- the requested Font instance
-
getFontInstanceForAWTFont
Returns a suitable internal font given an AWT Font instance.- Parameters:
awtFont
- the AWT font- Returns:
- a best matching internal Font
-
fontLookup
Lookup a font.
Locate the font name for a given family, style and weight. The font name can then be used as a key as it is unique for the associated document. This also adds the font to the list of used fonts.- Parameters:
family
- font familystyle
- font styleweight
- font weight- Returns:
- the font triplet of the font chosen
-
fontLookup
Looks up a set of fonts.
Locate the font name(s) for the given families, style and weight. The font name(s) can then be used as a key as they are unique for the associated document. This also adds the fonts to the list of used fonts.- Parameters:
families
- font families (priority list)style
- font styleweight
- font weight- Returns:
- the set of font triplets of all supported and chosen font-families in the specified style and weight.
-
notifyStrokingSVGTextAsShapes
Notify listeners that the SVG text for the given font will be stroked as shapes.- Parameters:
fontFamily
- a SVG font family
-
findAdjustWeight
Find a font with a given family and style by trying different font weights according to the spec.- Parameters:
family
- font familystyle
- font styleweight
- font weight- Returns:
- internal key
-
hasFont
Determines if a particular font is available.- Parameters:
family
- font familystyle
- font styleweight
- font weight- Returns:
- True if available
-
getInternalFontKey
Returns the internal font key (F1, F2, F3 etc.) for a given triplet.- Parameters:
triplet
- the font triplet- Returns:
- the associated internal key or null, if not found
-
createFontKey
Creates a key from the given strings.- Parameters:
family
- font familystyle
- font styleweight
- font weight- Returns:
- internal key
-
getFonts
Gets a Map of all registered fonts.- Returns:
- a read-only Map with font key/FontMetrics pairs
-
getFontTriplets
Gets a Map of all registered font triplets.- Returns:
- a Map with FontTriplet/font key pairs
-
getUsedFonts
This is used by the renderers to retrieve all the fonts used in the document. This is for embedded font or creating a list of used fonts.- Returns:
- a read-only Map with font key/FontMetrics pairs
-
getMetricsFor
Returns the FontMetrics for a particular font- Parameters:
fontName
- internal key- Returns:
- font metrics
-
getTripletsFor
Returns all font triplet matching the given font name.- Parameters:
fontName
- The font name we are looking for- Returns:
- A list of matching font triplets
-
getTripletFor
Returns the first triplet matching the given font name. As there may be multiple triplets matching the font name the result set is sorted first to guarantee consistent results.- Parameters:
fontName
- The font name we are looking for- Returns:
- The first triplet for the given font name
-
getFontStyleFor
Returns the font style for a particular font. There may be multiple font styles matching this font. Only the first found is returned. Searching is done on a sorted list to guarantee consistent results.- Parameters:
fontName
- internal key- Returns:
- font style
-
getFontWeightFor
Returns the font weight for a particular font. There may be multiple font weights matching this font. Only the first found is returned. Searching is done on a sorted list to guarantee consistent results.- Parameters:
fontName
- internal key- Returns:
- font weight
-
dumpAllTripletsToSystemOut
public void dumpAllTripletsToSystemOut()Diagnostic method for logging all registered fonts to System.out.
-