fop 0.94

org.apache.fop.fonts
Class LazyFont

java.lang.Object
  extended by org.apache.fop.fonts.Typeface
      extended by org.apache.fop.fonts.LazyFont
All Implemented Interfaces:
FontDescriptor, FontMetrics

public class LazyFont
extends Typeface
implements FontDescriptor

This class is used to defer the loading of a font until it is really used.


Constructor Summary
LazyFont(EmbedFontInfo fontInfo, FontResolver resolver)
          Main constructor
 
Method Summary
 int getAscender()
          Returns the ascender value of the font.
 int getAscender(int size)
          Returns the ascent of the font described by this FontMetrics object.
 int getCapHeight()
          Returns the capital height of the font.
 int getCapHeight(int size)
          Returns the size of a capital letter measured from the font's baseline.
 int getDescender()
          Returns the descender value of the font.
 int getDescender(int size)
          Returns the descent of the font described by this FontMetrics object.
 java.lang.String getEncoding()
          Get the encoding of the font.
 int getFlags()
          Returns the flags for the font.
 int[] getFontBBox()
          Returns the font's bounding box.
 java.lang.String getFontName()
          Returns the font name.
 FontType getFontType()
          Returns the type of the font.
 int getItalicAngle()
          Returns the italic angle for the font.
 java.util.Map getKerningInfo()
          Returns the kerning map for the font.
 int getMaxAscent(int size)
          Returns the maximum ascent of the font described by this FontMetrics object.
 Typeface getRealFont()
          Gets the real font.
 int getStemV()
          Returns the vertical stem width for the font.
 int getWidth(int i, int size)
          Return the width (in 1/1000ths of point size) of the character at code point i.
 int[] getWidths()
          Return the array of widths.
 int getXHeight(int size)
          Determines the typical font height of this FontMetrics object
 boolean hasChar(char c)
          Determines whether this font contains a particular character/glyph.
 boolean hasKerningInfo()
          Indicates if the font has kering information.
 boolean isEmbeddable()
          Indicates if this font may be embedded.
 boolean isMultiByte()
          Determines whether the font is a multibyte font.
 char mapChar(char c)
          Map a Unicode character to a code point in the font.
 java.lang.String toString()
          String representation of LazyFont
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LazyFont

public LazyFont(EmbedFontInfo fontInfo,
                FontResolver resolver)
Main constructor

Parameters:
fontEmbedPath - path to embeddable file (may be null)
metricsFileName - path to the metrics XML file
useKerning - True, if kerning should be enabled
resolver - the font resolver to handle font URIs
Method Detail

toString

public java.lang.String toString()
String representation of LazyFont

Overrides:
toString in class java.lang.Object

getRealFont

public Typeface getRealFont()
Gets the real font.

Returns:
the real font

getEncoding

public java.lang.String getEncoding()
Description copied from class: Typeface
Get the encoding of the font.

Specified by:
getEncoding in class Typeface
Returns:
the encoding
See Also:
Typeface.getEncoding()

mapChar

public char mapChar(char c)
Description copied from class: Typeface
Map a Unicode character to a code point in the font.

Specified by:
mapChar in class Typeface
Parameters:
c - character to map
Returns:
the mapped character
See Also:
Typeface.mapChar(char)

hasChar

public boolean hasChar(char c)
Description copied from class: Typeface
Determines whether this font contains a particular character/glyph.

Specified by:
hasChar in class Typeface
Parameters:
c - character to check
Returns:
True if the character is supported, Falso otherwise
See Also:
Typeface.hasChar(char)

isMultiByte

public boolean isMultiByte()
Description copied from class: Typeface
Determines whether the font is a multibyte font.

Overrides:
isMultiByte in class Typeface
Returns:
True if it is multibyte
See Also:
Typeface.isMultiByte()

getFontName

public java.lang.String getFontName()
Description copied from interface: FontMetrics
Returns the font name.

Specified by:
getFontName in interface FontMetrics
Returns:
the font name
See Also:
FontMetrics.getFontName()

getMaxAscent

public int getMaxAscent(int size)
Description copied from interface: FontMetrics
Returns the maximum ascent of the font described by this FontMetrics object. Note: This is not the same as getAscender().

Specified by:
getMaxAscent in interface FontMetrics
Overrides:
getMaxAscent in class Typeface
Parameters:
size - font size
Returns:
ascent in milliponts
See Also:
FontMetrics.getMaxAscent(int)

getAscender

public int getAscender(int size)
Description copied from interface: FontMetrics
Returns the ascent of the font described by this FontMetrics object. It returns the nominal ascent within the em box.

Specified by:
getAscender in interface FontMetrics
Parameters:
size - font size
Returns:
ascent in milliponts
See Also:
FontMetrics.getAscender(int)

getCapHeight

public int getCapHeight(int size)
Description copied from interface: FontMetrics
Returns the size of a capital letter measured from the font's baseline.

Specified by:
getCapHeight in interface FontMetrics
Parameters:
size - font size
Returns:
height of capital characters
See Also:
FontMetrics.getCapHeight(int)

getDescender

public int getDescender(int size)
Description copied from interface: FontMetrics
Returns the descent of the font described by this FontMetrics object.

Specified by:
getDescender in interface FontMetrics
Parameters:
size - font size
Returns:
descent in milliponts
See Also:
FontMetrics.getDescender(int)

getXHeight

public int getXHeight(int size)
Description copied from interface: FontMetrics
Determines the typical font height of this FontMetrics object

Specified by:
getXHeight in interface FontMetrics
Parameters:
size - font size
Returns:
font height in millipoints
See Also:
FontMetrics.getXHeight(int)

getWidth

public int getWidth(int i,
                    int size)
Description copied from interface: FontMetrics
Return the width (in 1/1000ths of point size) of the character at code point i.

Specified by:
getWidth in interface FontMetrics
Parameters:
i - code point index
size - font size
Returns:
the width of the character
See Also:
FontMetrics.getWidth(int, int)

getWidths

public int[] getWidths()
Description copied from interface: FontMetrics
Return the array of widths.

This is used to get an array for inserting in an output format. It should not be used for lookup.

Specified by:
getWidths in interface FontMetrics
Returns:
an array of widths
See Also:
FontMetrics.getWidths()

hasKerningInfo

public boolean hasKerningInfo()
Description copied from interface: FontMetrics
Indicates if the font has kering information.

Specified by:
hasKerningInfo in interface FontMetrics
Returns:
True, if kerning is available.
See Also:
FontMetrics.hasKerningInfo()

getKerningInfo

public java.util.Map getKerningInfo()
Description copied from interface: FontMetrics
Returns the kerning map for the font.

Specified by:
getKerningInfo in interface FontMetrics
Returns:
the kerning map
See Also:
FontMetrics.getKerningInfo()

getCapHeight

public int getCapHeight()
Description copied from interface: FontDescriptor
Returns the capital height of the font.

Specified by:
getCapHeight in interface FontDescriptor
Returns:
the capiptal height
See Also:
FontDescriptor.getCapHeight()

getDescender

public int getDescender()
Description copied from interface: FontDescriptor
Returns the descender value of the font. (Descent in pdf spec)

Specified by:
getDescender in interface FontDescriptor
Returns:
the descender value
See Also:
FontDescriptor.getDescender()

getAscender

public int getAscender()
Description copied from interface: FontDescriptor
Returns the ascender value of the font. (Ascent in pdf spec)

Specified by:
getAscender in interface FontDescriptor
Returns:
the ascender
See Also:
FontDescriptor.getAscender()

getFlags

public int getFlags()
Description copied from interface: FontDescriptor
Returns the flags for the font. (See pdf spec)

Specified by:
getFlags in interface FontDescriptor
Returns:
the flags
See Also:
FontDescriptor.getFlags()

getFontBBox

public int[] getFontBBox()
Description copied from interface: FontDescriptor
Returns the font's bounding box.

Specified by:
getFontBBox in interface FontDescriptor
Returns:
the bounding box
See Also:
FontDescriptor.getFontBBox()

getItalicAngle

public int getItalicAngle()
Description copied from interface: FontDescriptor
Returns the italic angle for the font.

Specified by:
getItalicAngle in interface FontDescriptor
Returns:
the italic angle
See Also:
FontDescriptor.getItalicAngle()

getStemV

public int getStemV()
Description copied from interface: FontDescriptor
Returns the vertical stem width for the font.

Specified by:
getStemV in interface FontDescriptor
Returns:
the vertical stem width
See Also:
FontDescriptor.getStemV()

getFontType

public FontType getFontType()
Description copied from interface: FontMetrics
Returns the type of the font.

Specified by:
getFontType in interface FontMetrics
Returns:
the font type
See Also:
FontMetrics.getFontType()

isEmbeddable

public boolean isEmbeddable()
Description copied from interface: FontDescriptor
Indicates if this font may be embedded.

Specified by:
isEmbeddable in interface FontDescriptor
Returns:
True, if embedding is possible/permitted
See Also:
FontDescriptor.isEmbeddable()

fop 0.94

Copyright 1999-2007 The Apache Software Foundation. All Rights Reserved.