org.fontbox.afm

Class FontMetric


public class FontMetric
extends java.lang.Object

This is the outermost AFM type. This can be created by the afmparser with a valid AFM document.
Version:
$Revision: 1.2 $
Author:
Ben Litchfield (ben@benlitchfield.com)

Constructor Summary

FontMetric()
Constructor.

Method Summary

void
addCharMetric(CharMetric metric)
This will add another character metric.
void
addComment(String comment)
This will add a new comment.
void
addComposite(Composite composite)
This will add a single composite part to the picture.
void
addKernPair(KernPair kernPair)
This will add a kern pair.
void
addKernPair0(KernPair kernPair)
This will add a kern pair.
void
addKernPair1(KernPair kernPair)
This will add a kern pair.
void
addTrackKern(TrackKern kern)
This will add another track kern.
float
getAFMVersion()
This will get the version of the AFM document.
float
getAscender()
Getter for property ascender.
float
getAverageCharacterWidth()
This will get the average width of a character.
float
getCapHeight()
Getter for property capHeight.
List
getCharMetrics()
Getter for property charMetrics.
float[]
getCharWidth()
Getter for property charWidth.
float
getCharacterHeight(String name)
This will get the width of a character.
String
getCharacterSet()
Getter for property characterSet.
float
getCharacterWidth(String name)
This will get the width of a character.
int
getCharacters()
Getter for property characters.
List
getComments()
This will get all comments.
List
getComposites()
Getter for property composites.
float
getDescender()
Getter for property descender.
String
getEncodingScheme()
Getter for property encodingScheme.
int
getEscChar()
Getter for property escChar.
String
getFamilyName()
Getter for property familyName.
BoundingBox
getFontBBox()
Getter for property fontBBox.
String
getFontName()
Getter for property fontName.
String
getFontVersion()
Getter for property fontVersion.
String
getFullName()
Getter for property fullName.
float
getItalicAngle()
Getter for property italicAngle.
List
getKernPairs()
Getter for property kernPairs.
List
getKernPairs0()
Getter for property kernPairs0.
List
getKernPairs1()
Getter for property kernPairs1.
int
getMappingScheme()
Getter for property mappingScheme.
int
getMetricSets()
This will get the metricSets attribute.
String
getNotice()
Getter for property notice.
float
getStandardHorizontalWidth()
Getter for property standardHorizontalWidth.
float
getStandardVerticalWidth()
Getter for property standardVerticalWidth.
List
getTrackKern()
Getter for property trackKern.
float
getUnderlinePosition()
Getter for property underlinePosition.
float
getUnderlineThickness()
Getter for property underlineThickness.
float[]
getVVector()
Getter for property vVector.
String
getWeight()
Getter for property weight.
float
getXHeight()
Getter for property xHeight.
boolean
isBaseFont()
Getter for property isBaseFont.
boolean
isFixedPitch()
Getter for property isFixedPitch.
boolean
isFixedV()
Getter for property isFixedV.
void
setAFMVersion(float afmVersionValue)
This will set the version of the AFM document.
void
setAscender(float ascenderValue)
Setter for property ascender.
void
setCapHeight(float capHeightValue)
Setter for property capHeight.
void
setCharMetrics(List charMetricsValue)
Setter for property charMetrics.
void
setCharWidth(float[] charWidthValue)
Setter for property charWidth.
void
setCharacterSet(String characterSetValue)
Setter for property characterSet.
void
setCharacters(int charactersValue)
Setter for property characters.
void
setComposites(List compositesList)
Setter for property composites.
void
setDescender(float descenderValue)
Setter for property descender.
void
setEncodingScheme(String encodingSchemeValue)
Setter for property encodingScheme.
void
setEscChar(int escCharValue)
Setter for property escChar.
void
setFamilyName(String familyNameValue)
Setter for property familyName.
void
setFixedPitch(boolean isFixedPitchValue)
Setter for property isFixedPitch.
void
setFontBBox(BoundingBox bBox)
Setter for property fontBBox.
void
setFontName(String name)
Setter for property fontName.
void
setFontVersion(String fontVersionValue)
Setter for property fontVersion.
void
setFullName(String fullNameValue)
Setter for property fullName.
void
setIsBaseFont(boolean isBaseFontValue)
Setter for property isBaseFont.
void
setIsFixedV(boolean isFixedVValue)
Setter for property isFixedV.
void
setItalicAngle(float italicAngleValue)
Setter for property italicAngle.
void
setKernPairs(List kernPairsList)
Setter for property kernPairs.
void
setKernPairs0(List kernPairs0List)
Setter for property kernPairs0.
void
setKernPairs1(List kernPairs1List)
Setter for property kernPairs1.
void
setMappingScheme(int mappingSchemeValue)
Setter for property mappingScheme.
void
setMetricSets(int metricSetsValue)
This will set the metricSets attribute.
void
setNotice(String noticeValue)
Setter for property notice.
void
setStandardHorizontalWidth(float standardHorizontalWidthValue)
Setter for property standardHorizontalWidth.
void
setStandardVerticalWidth(float standardVerticalWidthValue)
Setter for property standardVerticalWidth.
void
setTrackKern(List trackKernValue)
Setter for property trackKern.
void
setUnderlinePosition(float underlinePositionValue)
Setter for property underlinePosition.
void
setUnderlineThickness(float underlineThicknessValue)
Setter for property underlineThickness.
void
setVVector(float[] vVectorValue)
Setter for property vVector.
void
setWeight(String weightValue)
Setter for property weight.
void
setXHeight(float xHeightValue)
Setter for property xHeight.

Constructor Details

FontMetric

public FontMetric()
Constructor.

Method Details

addCharMetric

public void addCharMetric(CharMetric metric)
This will add another character metric.
Parameters:
metric - The character metric to add.

addComment

public void addComment(String comment)
This will add a new comment.
Parameters:
comment - The comment to add to this metric.

addComposite

public void addComposite(Composite composite)
This will add a single composite part to the picture.
Parameters:
composite - The composite info to add.

addKernPair

public void addKernPair(KernPair kernPair)
This will add a kern pair.
Parameters:
kernPair - The kern pair to add.

addKernPair0

public void addKernPair0(KernPair kernPair)
This will add a kern pair.
Parameters:
kernPair - The kern pair to add.

addKernPair1

public void addKernPair1(KernPair kernPair)
This will add a kern pair.
Parameters:
kernPair - The kern pair to add.

addTrackKern

public void addTrackKern(TrackKern kern)
This will add another track kern.
Parameters:
kern - The track kerning data.

getAFMVersion

public float getAFMVersion()
This will get the version of the AFM document.
Returns:
The version of the document.

getAscender

public float getAscender()
Getter for property ascender.
Returns:
Value of property ascender.

getAverageCharacterWidth

public float getAverageCharacterWidth()
            throws IOException
This will get the average width of a character.
Returns:
The width of the character.

getCapHeight

public float getCapHeight()
Getter for property capHeight.
Returns:
Value of property capHeight.

getCharMetrics

public List getCharMetrics()
Getter for property charMetrics.
Returns:
Value of property charMetrics.

getCharWidth

public float[] getCharWidth()
Getter for property charWidth.
Returns:
Value of property charWidth.

getCharacterHeight

public float getCharacterHeight(String name)
            throws IOException
This will get the width of a character.
Parameters:
name - The character to get the width for.
Returns:
The width of the character.

getCharacterSet

public String getCharacterSet()
Getter for property characterSet.
Returns:
Value of property characterSet.

getCharacterWidth

public float getCharacterWidth(String name)
            throws IOException
This will get the width of a character.
Parameters:
name - The character to get the width for.
Returns:
The width of the character.

getCharacters

public int getCharacters()
Getter for property characters.
Returns:
Value of property characters.

getComments

public List getComments()
This will get all comments.
Returns:
The list of all comments.

getComposites

public List getComposites()
Getter for property composites.
Returns:
Value of property composites.

getDescender

public float getDescender()
Getter for property descender.
Returns:
Value of property descender.

getEncodingScheme

public String getEncodingScheme()
Getter for property encodingScheme.
Returns:
Value of property encodingScheme.

getEscChar

public int getEscChar()
Getter for property escChar.
Returns:
Value of property escChar.

getFamilyName

public String getFamilyName()
Getter for property familyName.
Returns:
Value of property familyName.

getFontBBox

public BoundingBox getFontBBox()
Getter for property fontBBox.
Returns:
Value of property fontBBox.

getFontName

public String getFontName()
Getter for property fontName.
Returns:
Value of property fontName.

getFontVersion

public String getFontVersion()
Getter for property fontVersion.
Returns:
Value of property fontVersion.

getFullName

public String getFullName()
Getter for property fullName.
Returns:
Value of property fullName.

getItalicAngle

public float getItalicAngle()
Getter for property italicAngle.
Returns:
Value of property italicAngle.

getKernPairs

public List getKernPairs()
Getter for property kernPairs.
Returns:
Value of property kernPairs.

getKernPairs0

public List getKernPairs0()
Getter for property kernPairs0.
Returns:
Value of property kernPairs0.

getKernPairs1

public List getKernPairs1()
Getter for property kernPairs1.
Returns:
Value of property kernPairs1.

getMappingScheme

public int getMappingScheme()
Getter for property mappingScheme.
Returns:
Value of property mappingScheme.

getMetricSets

public int getMetricSets()
This will get the metricSets attribute.
Returns:
The value of the metric sets.

getNotice

public String getNotice()
Getter for property notice.
Returns:
Value of property notice.

getStandardHorizontalWidth

public float getStandardHorizontalWidth()
Getter for property standardHorizontalWidth.
Returns:
Value of property standardHorizontalWidth.

getStandardVerticalWidth

public float getStandardVerticalWidth()
Getter for property standardVerticalWidth.
Returns:
Value of property standardVerticalWidth.

getTrackKern

public List getTrackKern()
Getter for property trackKern.
Returns:
Value of property trackKern.

getUnderlinePosition

public float getUnderlinePosition()
Getter for property underlinePosition.
Returns:
Value of property underlinePosition.

getUnderlineThickness

public float getUnderlineThickness()
Getter for property underlineThickness.
Returns:
Value of property underlineThickness.

getVVector

public float[] getVVector()
Getter for property vVector.
Returns:
Value of property vVector.

getWeight

public String getWeight()
Getter for property weight.
Returns:
Value of property weight.

getXHeight

public float getXHeight()
Getter for property xHeight.
Returns:
Value of property xHeight.

isBaseFont

public boolean isBaseFont()
Getter for property isBaseFont.
Returns:
Value of property isBaseFont.

isFixedPitch

public boolean isFixedPitch()
Getter for property isFixedPitch.
Returns:
Value of property isFixedPitch.

isFixedV

public boolean isFixedV()
Getter for property isFixedV.
Returns:
Value of property isFixedV.

setAFMVersion

public void setAFMVersion(float afmVersionValue)
This will set the version of the AFM document.
Parameters:
afmVersionValue - The version of the document.

setAscender

public void setAscender(float ascenderValue)
Setter for property ascender.
Parameters:
ascenderValue - New value of property ascender.

setCapHeight

public void setCapHeight(float capHeightValue)
Setter for property capHeight.
Parameters:
capHeightValue - New value of property capHeight.

setCharMetrics

public void setCharMetrics(List charMetricsValue)
Setter for property charMetrics.
Parameters:
charMetricsValue - New value of property charMetrics.

setCharWidth

public void setCharWidth(float[] charWidthValue)
Setter for property charWidth.
Parameters:
charWidthValue - New value of property charWidth.

setCharacterSet

public void setCharacterSet(String characterSetValue)
Setter for property characterSet.
Parameters:
characterSetValue - New value of property characterSet.

setCharacters

public void setCharacters(int charactersValue)
Setter for property characters.
Parameters:
charactersValue - New value of property characters.

setComposites

public void setComposites(List compositesList)
Setter for property composites.
Parameters:
compositesList - New value of property composites.

setDescender

public void setDescender(float descenderValue)
Setter for property descender.
Parameters:
descenderValue - New value of property descender.

setEncodingScheme

public void setEncodingScheme(String encodingSchemeValue)
Setter for property encodingScheme.
Parameters:
encodingSchemeValue - New value of property encodingScheme.

setEscChar

public void setEscChar(int escCharValue)
Setter for property escChar.
Parameters:
escCharValue - New value of property escChar.

setFamilyName

public void setFamilyName(String familyNameValue)
Setter for property familyName.
Parameters:
familyNameValue - New value of property familyName.

setFixedPitch

public void setFixedPitch(boolean isFixedPitchValue)
Setter for property isFixedPitch.
Parameters:
isFixedPitchValue - New value of property isFixedPitch.

setFontBBox

public void setFontBBox(BoundingBox bBox)
Setter for property fontBBox.
Parameters:
bBox - New value of property fontBBox.

setFontName

public void setFontName(String name)
Setter for property fontName.
Parameters:
name - New value of property fontName.

setFontVersion

public void setFontVersion(String fontVersionValue)
Setter for property fontVersion.
Parameters:
fontVersionValue - New value of property fontVersion.

setFullName

public void setFullName(String fullNameValue)
Setter for property fullName.
Parameters:
fullNameValue - New value of property fullName.

setIsBaseFont

public void setIsBaseFont(boolean isBaseFontValue)
Setter for property isBaseFont.
Parameters:
isBaseFontValue - New value of property isBaseFont.

setIsFixedV

public void setIsFixedV(boolean isFixedVValue)
Setter for property isFixedV.
Parameters:
isFixedVValue - New value of property isFixedV.

setItalicAngle

public void setItalicAngle(float italicAngleValue)
Setter for property italicAngle.
Parameters:
italicAngleValue - New value of property italicAngle.

setKernPairs

public void setKernPairs(List kernPairsList)
Setter for property kernPairs.
Parameters:
kernPairsList - New value of property kernPairs.

setKernPairs0

public void setKernPairs0(List kernPairs0List)
Setter for property kernPairs0.
Parameters:
kernPairs0List - New value of property kernPairs0.

setKernPairs1

public void setKernPairs1(List kernPairs1List)
Setter for property kernPairs1.
Parameters:
kernPairs1List - New value of property kernPairs1.

setMappingScheme

public void setMappingScheme(int mappingSchemeValue)
Setter for property mappingScheme.
Parameters:
mappingSchemeValue - New value of property mappingScheme.

setMetricSets

public void setMetricSets(int metricSetsValue)
This will set the metricSets attribute. This value must be 0,1, or 2.
Parameters:
metricSetsValue - The new metric sets attribute.

setNotice

public void setNotice(String noticeValue)
Setter for property notice.
Parameters:
noticeValue - New value of property notice.

setStandardHorizontalWidth

public void setStandardHorizontalWidth(float standardHorizontalWidthValue)
Setter for property standardHorizontalWidth.
Parameters:
standardHorizontalWidthValue - New value of property standardHorizontalWidth.

setStandardVerticalWidth

public void setStandardVerticalWidth(float standardVerticalWidthValue)
Setter for property standardVerticalWidth.
Parameters:
standardVerticalWidthValue - New value of property standardVerticalWidth.

setTrackKern

public void setTrackKern(List trackKernValue)
Setter for property trackKern.
Parameters:
trackKernValue - New value of property trackKern.

setUnderlinePosition

public void setUnderlinePosition(float underlinePositionValue)
Setter for property underlinePosition.
Parameters:
underlinePositionValue - New value of property underlinePosition.

setUnderlineThickness

public void setUnderlineThickness(float underlineThicknessValue)
Setter for property underlineThickness.
Parameters:
underlineThicknessValue - New value of property underlineThickness.

setVVector

public void setVVector(float[] vVectorValue)
Setter for property vVector.
Parameters:
vVectorValue - New value of property vVector.

setWeight

public void setWeight(String weightValue)
Setter for property weight.
Parameters:
weightValue - New value of property weight.

setXHeight

public void setXHeight(float xHeightValue)
Setter for property xHeight.
Parameters:
xHeightValue - New value of property xHeight.