Apache PDFBox 3.0.4 · org.apache.pdfbox.pdmodel.font.PDFontDescriptor

Modifier and Type	Field and Description
private float	capHeight
private final COSDictionary	dic
private static final int	FLAG_ALL_CAP
private static final int	FLAG_FIXED_PITCH
private static final int	FLAG_FORCE_BOLD
private static final int	FLAG_ITALIC
private static final int	FLAG_NON_SYMBOLIC
private static final int	FLAG_SCRIPT
private static final int	FLAG_SERIF
private static final int	FLAG_SMALL_CAP
private static final int	FLAG_SYMBOLIC
private int	flags
private float	xHeight

Access	Constructor and Description
pack-priv	PDFontDescriptor() Package-private constructor, for embedding.
public	PDFontDescriptor(COSDictionary The wrapped COS Dictionary. desc) Creates a PDFontDescriptor from a COS dictionary.

Method Summary

Modifier and Type	Method and Description
public float	Returns: The ascent. getAscent() This will get the ascent for the font.
public float	Returns: The average width value. getAverageWidth() This will get the average width for the font.
public float	Returns: The cap height. getCapHeight() This will get the CapHeight for the font.
public String	Returns: The character set value. getCharSet() This will get the character set for the font.
public PDStream	Returns: A stream containing a CIDSet. getCIDSet() Get the CIDSet stream.
public COSDictionary	Returns: The cos object that matches this Java object. getCOSObject() Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject. Convert this standard java object to a COS object.
public float	Returns: The descent. getDescent() This will get the descent for the font.
public int	Returns: The font flags. getFlags() This will get the font flags.
public PDRectangle	Returns: The fonts bounding box. getFontBoundingBox() This will get the fonts bounding box.
public String	Returns: The font family. getFontFamily() A string representing the preferred font family.
public PDStream	Returns: A stream containing a Type 1 font program. getFontFile() A stream containing a Type 1 font program.
public PDStream	Returns: A stream containing a true type font program. getFontFile2() A stream containing a true type font program.
public PDStream	Returns: A stream containing a font program. getFontFile3() A stream containing a font program that is not true type or type 1.
public String	Returns: The name of the font. getFontName() Get the font name.
public String	Returns: The stretch of the font. getFontStretch() A string representing the preferred font stretch.
public float	Returns: The font weight. getFontWeight() The weight of the font.
public float	Returns: The italic angle. getItalicAngle() This will get the italic angle for the font.
public float	Returns: The leading. getLeading() This will get the leading for the font.
public float	Returns: The max width value. getMaxWidth() This will get the max width for the font.
public float	Returns: The missing width value, or 0 if there is no such dictionary entry. getMissingWidth() This will get the missing width for the font from the /MissingWidth dictionary entry.
public PDPanose	Returns: A Panose wrapper object. getPanose() Returns the Panose entry of the Style dictionary, if any.
public float	Returns: The stem h value. getStemH() This will get the stemH for the font.
public float	Returns: The stem v value. getStemV() This will get the stemV for the font.
public float	Returns: The x height. getXHeight() This will get the x height for the font.
public boolean	Returns: true if the missing widths entry is present in the font descriptor hasMissingWidth() Returns true if the missing widths entry is present in the font descriptor.
public boolean	Returns: true if widths are present in the font descriptor hasWidths() Returns true if widths are present in the font descriptor.
public boolean	Returns: The flag value. isAllCap() A convenience method that checks the flag bit.
public boolean	Returns: The flag value. isFixedPitch() A convenience method that checks the flag bit.
private boolean	isFlagBitOn(int bit)
public boolean	Returns: The flag value. isForceBold() A convenience method that checks the flag bit.
public boolean	Returns: The flag value. isItalic() A convenience method that checks the flag bit.
public boolean	Returns: The flag value. isNonSymbolic() A convenience method that checks the flag bit.
public boolean	Returns: The flag value. isScript() A convenience method that checks the flag bit.
public boolean	Returns: The flag value. isSerif() A convenience method that checks the flag bit.
public boolean	Returns: The flag value. isSmallCap() A convenience method that checks the flag bit.
public boolean	Returns: The flag value. isSymbolic() A convenience method that checks the flag bit.
public void	setAllCap(boolean The flag value. flag) A convenience method that sets the flag bit.
public void	setAscent(float The new ascent for the font. ascent) This will set the ascent for the font.
public void	setAverageWidth(float The new average width for the font. averageWidth) This will set the average width for the font.
public void	setCapHeight(float The new cap height for the font. capHeight) This will set the cap height for the font.
public void	setCharacterSet(String The new character set for the font. charSet) This will set the character set for the font.
public void	setCIDSet(PDStream The font program stream. stream) Set a stream containing a CIDSet.
public void	setDescent(float The new descent for the font. descent) This will set the descent for the font.
public void	setFixedPitch(boolean The flag value. flag) A convenience method that sets the flag bit.
private void	setFlagBit(int bit, boolean value)
public void	setFlags(int The new font flags. flags) This will set the font flags.
public void	setFontBoundingBox(PDRectangle The new bounding box. rect) Set the fonts bounding box.
public void	setFontFamily(String The font family. fontFamily) This will set the font family.
public void	setFontFile(PDStream The type 1 stream. type1Stream) Set the type 1 font program.
public void	setFontFile2(PDStream The true type stream. ttfStream) Set the true type font program.
public void	setFontFile3(PDStream The font program stream. stream) Set a stream containing a font program that is not true type or type 1.
public void	setFontName(String The new name for the font. fontName) This will set the font name.
public void	setFontStretch(String The new stretch for the font. fontStretch) This will set the font stretch.
public void	setFontWeight(float The new weight of the font. fontWeight) Set the weight of the font.
public void	setForceBold(boolean The flag value. flag) A convenience method that sets the flag bit.
public void	setItalic(boolean The flag value. flag) A convenience method that sets the flag bit.
public void	setItalicAngle(float The new italic angle for the font. angle) This will set the italic angle for the font.
public void	setLeading(float The new leading for the font. leading) This will set the leading for the font.
public void	setMaxWidth(float The new max width for the font. maxWidth) This will set the max width for the font.
public void	setMissingWidth(float The new missing width for the font. missingWidth) This will set the missing width for the font.
public void	setNonSymbolic(boolean The flag value. flag) A convenience method that sets the flag bit.
public void	setScript(boolean The flag value. flag) A convenience method that sets the flag bit.
public void	setSerif(boolean The flag value. flag) A convenience method that sets the flag bit.
public void	setSmallCap(boolean The flag value. flag) A convenience method that sets the flag bit.
public void	setStemH(float The new stem h for the font. stemH) This will set the stem H for the font.
public void	setStemV(float The new stem v for the font. stemV) This will set the stem V for the font.
public void	setSymbolic(boolean The flag value. flag) A convenience method that sets the flag bit.
public void	setXHeight(float The new x height for the font. xHeight) This will set the x height for the font.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

capHeight	back to summary
private float capHeight

dic	back to summary
private final COSDictionary dic

FLAG_ALL_CAP	back to summary
private static final int FLAG_ALL_CAP

FLAG_FIXED_PITCH	back to summary
private static final int FLAG_FIXED_PITCH

FLAG_FORCE_BOLD	back to summary
private static final int FLAG_FORCE_BOLD

FLAG_ITALIC	back to summary
private static final int FLAG_ITALIC

FLAG_NON_SYMBOLIC	back to summary
private static final int FLAG_NON_SYMBOLIC

FLAG_SCRIPT	back to summary
private static final int FLAG_SCRIPT

FLAG_SERIF	back to summary
private static final int FLAG_SERIF

FLAG_SMALL_CAP	back to summary
private static final int FLAG_SMALL_CAP

FLAG_SYMBOLIC	back to summary
private static final int FLAG_SYMBOLIC

flags	back to summary
private int flags

xHeight	back to summary
private float xHeight

PDFontDescriptor	back to summary
pack-priv PDFontDescriptor() Package-private constructor, for embedding.

PDFontDescriptor	back to summary
public PDFontDescriptor(COSDictionary desc) Creates a PDFontDescriptor from a COS dictionary. Parameters desc:COSDictionary The wrapped COS Dictionary.

Method Detail

getAscent	back to summary
public float getAscent() This will get the ascent for the font. Returns:float The ascent.

getAscent

back to summary

public float getAscent()

This will get the ascent for the font.

Returns:float: The ascent.

getAverageWidth	back to summary
public float getAverageWidth() This will get the average width for the font. Returns:float The average width value.

getAverageWidth

back to summary

public float getAverageWidth()

This will get the average width for the font.

Returns:float: The average width value.

getCapHeight	back to summary
public float getCapHeight() This will get the CapHeight for the font. Returns:float The cap height.

getCapHeight

back to summary

public float getCapHeight()

This will get the CapHeight for the font.

Returns:float: The cap height.

getCharSet	back to summary
public String getCharSet() This will get the character set for the font. Returns:String The character set value.

getCharSet

back to summary

public String getCharSet()

This will get the character set for the font.

Returns:String: The character set value.

getCIDSet	back to summary
public PDStream getCIDSet() Get the CIDSet stream. Returns:PDStream A stream containing a CIDSet.

getCIDSet

back to summary

public PDStream getCIDSet()

Get the CIDSet stream.

Returns:PDStream: A stream containing a CIDSet.

getCOSObject	back to summary
public COSDictionary getCOSObject() Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject. Convert this standard java object to a COS object. Returns:COSDictionary The cos object that matches this Java object. Annotations @Override

getCOSObject

back to summary

public COSDictionary getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

Returns:COSDictionary

The cos object that matches this Java object.

Annotations

@Override

getDescent	back to summary
public float getDescent() This will get the descent for the font. Returns:float The descent.

getDescent

back to summary

public float getDescent()

This will get the descent for the font.

Returns:float: The descent.

getFlags	back to summary
public int getFlags() This will get the font flags. Returns:int The font flags.

getFlags

back to summary

public int getFlags()

This will get the font flags.

Returns:int: The font flags.

getFontBoundingBox	back to summary
public PDRectangle getFontBoundingBox() This will get the fonts bounding box. Returns:PDRectangle The fonts bounding box.

getFontBoundingBox

back to summary

public PDRectangle getFontBoundingBox()

This will get the fonts bounding box.

Returns:PDRectangle: The fonts bounding box.

getFontFamily	back to summary
public String getFontFamily() A string representing the preferred font family. Returns:String The font family.

getFontFamily

back to summary

public String getFontFamily()

A string representing the preferred font family.

Returns:String: The font family.

getFontFile	back to summary
public PDStream getFontFile() A stream containing a Type 1 font program. Returns:PDStream A stream containing a Type 1 font program.

getFontFile

back to summary

public PDStream getFontFile()

A stream containing a Type 1 font program.

Returns:PDStream: A stream containing a Type 1 font program.

getFontFile2	back to summary
public PDStream getFontFile2() A stream containing a true type font program. Returns:PDStream A stream containing a true type font program.

getFontFile2

back to summary

public PDStream getFontFile2()

A stream containing a true type font program.

Returns:PDStream: A stream containing a true type font program.

getFontFile3	back to summary
public PDStream getFontFile3() A stream containing a font program that is not true type or type 1. Returns:PDStream A stream containing a font program.

getFontFile3

back to summary

public PDStream getFontFile3()

A stream containing a font program that is not true type or type 1.

Returns:PDStream: A stream containing a font program.

getFontName	back to summary
public String getFontName() Get the font name. Returns:String The name of the font.

getFontName

back to summary

public String getFontName()

Get the font name.

Returns:String: The name of the font.

getFontStretch	back to summary
public String getFontStretch() A string representing the preferred font stretch. According to the PDF Spec: The font stretch value; it must be one of the following (ordered from narrowest to widest): UltraCondensed, ExtraCondensed, Condensed, SemiCondensed, Normal, SemiExpanded, Expanded, ExtraExpanded or UltraExpanded. Returns:String The stretch of the font.

getFontStretch

back to summary

public String getFontStretch()

A string representing the preferred font stretch. According to the PDF Spec: The font stretch value; it must be one of the following (ordered from narrowest to widest): UltraCondensed, ExtraCondensed, Condensed, SemiCondensed, Normal, SemiExpanded, Expanded, ExtraExpanded or UltraExpanded.

Returns:String: The stretch of the font.

getFontWeight	back to summary
public float getFontWeight() The weight of the font. According to the PDF spec "possible values are 100, 200, 300, 400, 500, 600, 700, 800 or 900" Where a higher number is more weight and appears to be more bold. Returns:float The font weight.

getFontWeight

back to summary

public float getFontWeight()

The weight of the font. According to the PDF spec "possible values are 100, 200, 300, 400, 500, 600, 700, 800 or 900" Where a higher number is more weight and appears to be more bold.

Returns:float: The font weight.

getItalicAngle	back to summary
public float getItalicAngle() This will get the italic angle for the font. Returns:float The italic angle.

getItalicAngle

back to summary

public float getItalicAngle()

This will get the italic angle for the font.

Returns:float: The italic angle.

getLeading	back to summary
public float getLeading() This will get the leading for the font. Returns:float The leading.

getLeading

back to summary

public float getLeading()

This will get the leading for the font.

Returns:float: The leading.

getMaxWidth	back to summary
public float getMaxWidth() This will get the max width for the font. Returns:float The max width value.

getMaxWidth

back to summary

public float getMaxWidth()

This will get the max width for the font.

Returns:float: The max width value.

getMissingWidth	back to summary
public float getMissingWidth() This will get the missing width for the font from the /MissingWidth dictionary entry. Returns:float The missing width value, or 0 if there is no such dictionary entry.

getMissingWidth

back to summary

public float getMissingWidth()

This will get the missing width for the font from the /MissingWidth dictionary entry.

Returns:float: The missing width value, or 0 if there is no such dictionary entry.

getPanose	back to summary
public PDPanose getPanose() Returns the Panose entry of the Style dictionary, if any. Returns:PDPanose A Panose wrapper object.

getPanose

back to summary

public PDPanose getPanose()

Returns the Panose entry of the Style dictionary, if any.

Returns:PDPanose: A Panose wrapper object.

getStemH	back to summary
public float getStemH() This will get the stemH for the font. Returns:float The stem h value.

getStemH

back to summary

public float getStemH()

This will get the stemH for the font.

Returns:float: The stem h value.

getStemV	back to summary
public float getStemV() This will get the stemV for the font. Returns:float The stem v value.

getStemV

back to summary

public float getStemV()

This will get the stemV for the font.

Returns:float: The stem v value.

getXHeight	back to summary
public float getXHeight() This will get the x height for the font. Returns:float The x height.

getXHeight

back to summary

public float getXHeight()

This will get the x height for the font.

Returns:float: The x height.

hasMissingWidth	back to summary
public boolean hasMissingWidth() Returns true if the missing widths entry is present in the font descriptor. Returns:boolean true if the missing widths entry is present in the font descriptor

hasMissingWidth

back to summary

public boolean hasMissingWidth()

Returns true if the missing widths entry is present in the font descriptor.

Returns:boolean: true if the missing widths entry is present in the font descriptor

hasWidths	back to summary
public boolean hasWidths() Returns true if widths are present in the font descriptor. Returns:boolean true if widths are present in the font descriptor

hasWidths

back to summary

public boolean hasWidths()

Returns true if widths are present in the font descriptor.

Returns:boolean: true if widths are present in the font descriptor

isAllCap	back to summary
public boolean isAllCap() A convenience method that checks the flag bit. Returns:boolean The flag value.

isAllCap

back to summary

public boolean isAllCap()

A convenience method that checks the flag bit.

Returns:boolean: The flag value.

isFixedPitch	back to summary
public boolean isFixedPitch() A convenience method that checks the flag bit. Returns:boolean The flag value.

isFixedPitch

back to summary

public boolean isFixedPitch()

A convenience method that checks the flag bit.

Returns:boolean: The flag value.

isFlagBitOn	back to summary
private boolean isFlagBitOn(int bit)

isForceBold	back to summary
public boolean isForceBold() A convenience method that checks the flag bit. Returns:boolean The flag value.

isForceBold

back to summary

public boolean isForceBold()

A convenience method that checks the flag bit.

Returns:boolean: The flag value.

isItalic	back to summary
public boolean isItalic() A convenience method that checks the flag bit. Returns:boolean The flag value.

isItalic

back to summary

public boolean isItalic()

A convenience method that checks the flag bit.

Returns:boolean: The flag value.

isNonSymbolic	back to summary
public boolean isNonSymbolic() A convenience method that checks the flag bit. Returns:boolean The flag value.

isNonSymbolic

back to summary

public boolean isNonSymbolic()

A convenience method that checks the flag bit.

Returns:boolean: The flag value.

isScript

back to summary

public boolean isScript()

A convenience method that checks the flag bit.

Returns:boolean: The flag value.

isSerif

back to summary

public boolean isSerif()

A convenience method that checks the flag bit.

Returns:boolean: The flag value.

isSmallCap

back to summary

public boolean isSmallCap()

A convenience method that checks the flag bit.

Returns:boolean: The flag value.

isSymbolic

back to summary

public boolean isSymbolic()

A convenience method that checks the flag bit.

Returns:boolean: The flag value.

setAllCap

back to summary

public void setAllCap(boolean flag)

A convenience method that sets the flag bit.

Parameters

flag:boolean: The flag value.

setAscent

back to summary

public void setAscent(float ascent)

This will set the ascent for the font.

Parameters

ascent:float: The new ascent for the font.

setAverageWidth

back to summary

public void setAverageWidth(float averageWidth)

This will set the average width for the font.

Parameters

averageWidth:float: The new average width for the font.

setCapHeight

back to summary

public void setCapHeight(float capHeight)

This will set the cap height for the font.

Parameters

capHeight:float: The new cap height for the font.

setCharacterSet

back to summary

public void setCharacterSet(String charSet)

This will set the character set for the font.

Parameters

charSet:String: The new character set for the font.

setCIDSet

back to summary

public void setCIDSet(PDStream stream)

Set a stream containing a CIDSet.

Parameters

stream:PDStream: The font program stream.

setDescent

back to summary

public void setDescent(float descent)

This will set the descent for the font.

Parameters

descent:float: The new descent for the font.

setFixedPitch

back to summary

public void setFixedPitch(boolean flag)

A convenience method that sets the flag bit.

Parameters

flag:boolean: The flag value.

setFlagBit	back to summary
private void setFlagBit(int bit, boolean value)

setFlags

back to summary

public void setFlags(int flags)

This will set the font flags.

Parameters

flags:int: The new font flags.

setFontBoundingBox

back to summary

public void setFontBoundingBox(PDRectangle rect)

Set the fonts bounding box.

Parameters

rect:PDRectangle: The new bounding box.

setFontFamily

back to summary

public void setFontFamily(String fontFamily)

This will set the font family.

Parameters

fontFamily:String: The font family.

setFontFile

back to summary

public void setFontFile(PDStream type1Stream)

Set the type 1 font program.

Parameters

type1Stream:PDStream: The type 1 stream.

setFontFile2

back to summary

public void setFontFile2(PDStream ttfStream)

Set the true type font program.

Parameters

ttfStream:PDStream: The true type stream.

setFontFile3

back to summary

public void setFontFile3(PDStream stream)

Set a stream containing a font program that is not true type or type 1.

Parameters

stream:PDStream: The font program stream.

setFontName

back to summary

public void setFontName(String fontName)

This will set the font name.

Parameters

fontName:String: The new name for the font.

setFontStretch

back to summary

public void setFontStretch(String fontStretch)

This will set the font stretch.

Parameters

fontStretch:String: The new stretch for the font.

setFontWeight

back to summary

public void setFontWeight(float fontWeight)

Set the weight of the font.

Parameters

fontWeight:float: The new weight of the font.

setForceBold

back to summary

public void setForceBold(boolean flag)

A convenience method that sets the flag bit.

Parameters

flag:boolean: The flag value.

setItalic

back to summary

public void setItalic(boolean flag)

A convenience method that sets the flag bit.

Parameters

flag:boolean: The flag value.

setItalicAngle

back to summary

public void setItalicAngle(float angle)

This will set the italic angle for the font.

Parameters

angle:float: The new italic angle for the font.

setLeading

back to summary

public void setLeading(float leading)

This will set the leading for the font.

Parameters

leading:float: The new leading for the font.

setMaxWidth

back to summary

public void setMaxWidth(float maxWidth)

This will set the max width for the font.

Parameters

maxWidth:float: The new max width for the font.

setMissingWidth

back to summary

public void setMissingWidth(float missingWidth)

This will set the missing width for the font.

Parameters

missingWidth:float: The new missing width for the font.

setNonSymbolic

back to summary

public void setNonSymbolic(boolean flag)

A convenience method that sets the flag bit.

Parameters

flag:boolean: The flag value.

setScript

back to summary

public void setScript(boolean flag)

A convenience method that sets the flag bit.

Parameters

flag:boolean: The flag value.

setSerif

back to summary

public void setSerif(boolean flag)

A convenience method that sets the flag bit.

Parameters

flag:boolean: The flag value.

setSmallCap

back to summary

public void setSmallCap(boolean flag)

A convenience method that sets the flag bit.

Parameters

flag:boolean: The flag value.

setStemH

back to summary

public void setStemH(float stemH)

This will set the stem H for the font.

Parameters

stemH:float: The new stem h for the font.

setStemV

back to summary

public void setStemV(float stemV)

This will set the stem V for the font.

Parameters

stemV:float: The new stem v for the font.

setSymbolic

back to summary

public void setSymbolic(boolean flag)

A convenience method that sets the flag bit.

Parameters

flag:boolean: The flag value.

setXHeight

back to summary

public void setXHeight(float xHeight)

This will set the x height for the font.

Parameters

xHeight:float: The new x height for the font.

public final Class PDFontDescriptor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail