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

Modifier and Type	Field and Description
private float	averageWidth
private float	defaultWidth
protected final COSDictionary	dict
private final float[]	dw2
private PDFontDescriptor	fontDescriptor
private static final Log	LOG
protected final PDType0Font	parent
private final Map<Integer, Vector>	positionVectors
private final Map<Integer, Float>	verticalDisplacementY
private Map<Integer, Float>	widths

Access	Constructor and Description
pack-priv	PDCIDFont(COSDictionary The font dictionary according to the PDF specification. fontDictionary, PDType0Font parent) Constructor.

Method Summary

Modifier and Type	Method and Description
public abstract int	Returns: CID codeToCID(int character code code) Returns the CID for the given character code.
public abstract int	Returns: GID codeToGID(int character code code) Returns the GID for the given character code.
protected abstract byte[]	Returns: Array of 1 to 4 PDF content stream bytes. encode(int Unicode code point. unicode) Encodes the given Unicode code point for use in a PDF content stream.
public abstract byte[]	encodeGlyphId(int glyphId)
public float	getAverageFontWidth() Implements org.apache.pdfbox.pdmodel.font.PDFontLike.getAverageFontWidth. This will get the average font width for all characters.
public String	Returns: The postscript name of the font. getBaseFont() The PostScript name of the font.
public PDCIDSystemInfo	Returns: the CIDSystemInfo, or null getCIDSystemInfo() Returns the CIDSystemInfo, or null if it is missing (which isn't allowed but could happen).
public COSDictionary	getCOSObject() Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject. Convert this standard java object to a COS object.
private Vector	getDefaultPositionVector(int CID cid) Returns the default position vector (v).
private float	Returns: The default width for the glyphs in this font. getDefaultWidth() This will get the default width.
public PDFontDescriptor	getFontDescriptor() Implements org.apache.pdfbox.pdmodel.font.PDFontLike.getFontDescriptor. Returns the font descriptor, may be null.
public String	getName() Implements org.apache.pdfbox.pdmodel.font.PDFontLike.getName. Returns the name of this font, either the PostScript "BaseName" or the Type 3 "Name".
public final PDType0Font	Returns: parent Type 0 font getParent() Returns the Type 0 font which is the parent of this font.
public Vector	getPositionVector(int character code code) Implements org.apache.pdfbox.pdmodel.font.PDFontLike.getPositionVector. Returns the position vector (v), in text space, for the given character.
public float	Returns: w1y getVerticalDisplacementVectorY(int character code code) Returns the y-component of the vertical displacement vector (w1).
public float	getWidth(int character code code) Implements org.apache.pdfbox.pdmodel.font.PDFontLike.getWidth. Returns the advance width of the given character, in glyph space.
private float	getWidthForCID(int cid)
public boolean	hasExplicitWidth(int character code code) Implements org.apache.pdfbox.pdmodel.font.PDFontLike.hasExplicitWidth. Returns true if the Font dictionary specifies an explicit width for the given glyph.
pack-priv final int[]	readCIDToGIDMap()
private void	readVerticalDisplacements()
private void	readWidths()

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

averageWidth	back to summary
private float averageWidth

defaultWidth	back to summary
private float defaultWidth

dict	back to summary
protected final COSDictionary dict

dw2	back to summary
private final float[] dw2

fontDescriptor	back to summary
private PDFontDescriptor fontDescriptor

LOG	back to summary
private static final Log LOG

parent	back to summary
protected final PDType0Font parent

positionVectors	back to summary
private final Map<Integer, Vector> positionVectors

verticalDisplacementY	back to summary
private final Map<Integer, Float> verticalDisplacementY

widths	back to summary
private Map<Integer, Float> widths

PDCIDFont	back to summary
pack-priv PDCIDFont(COSDictionary fontDictionary, PDType0Font parent) Constructor. Parameters fontDictionary:COSDictionary The font dictionary according to the PDF specification.

Method Detail

codeToCID	back to summary
public abstract int codeToCID(int code) Returns the CID for the given character code. If not found then CID 0 is returned. Parameters code:int character code Returns:int CID

codeToCID

back to summary

public abstract int codeToCID(int code)

Returns the CID for the given character code. If not found then CID 0 is returned.

Parameters

code:int: character code

Returns:int

CID

codeToGID	back to summary
public abstract int codeToGID(int code) throws IOException Returns the GID for the given character code. Parameters code:int character code Returns:int GID Exceptions IOException: if the mapping could not be read

codeToGID

back to summary

public abstract int codeToGID(int code) throws IOException

Returns the GID for the given character code.

Parameters

code:int: character code

Returns:int

GID

Exceptions

IOException:: if the mapping could not be read

encode	back to summary
protected abstract byte[] encode(int unicode) throws IOException Encodes the given Unicode code point for use in a PDF content stream. Content streams use a multi-byte encoding with 1 to 4 bytes. This method is called when embedding text in PDFs and when filling in fields. Parameters unicode:int Unicode code point. Returns:byte[] Array of 1 to 4 PDF content stream bytes. Exceptions IOException: If the text could not be encoded.

encode

back to summary

protected abstract byte[] encode(int unicode) throws IOException

Encodes the given Unicode code point for use in a PDF content stream. Content streams use a multi-byte encoding with 1 to 4 bytes.

This method is called when embedding text in PDFs and when filling in fields.

Parameters

unicode:int: Unicode code point.

Returns:byte[]

Array of 1 to 4 PDF content stream bytes.

Exceptions

IOException:: If the text could not be encoded.

encodeGlyphId	back to summary
public abstract byte[] encodeGlyphId(int glyphId)

getAverageFontWidth	back to summary
public float getAverageFontWidth() Implements org.apache.pdfbox.pdmodel.font.PDFontLike.getAverageFontWidth. Doc from org.apache.pdfbox.pdmodel.font.PDFontLike.getAverageFontWidth. This will get the average font width for all characters. Returns:float The width is in 1000 unit of text space, ie 333 or 777 Annotations @Override

getAverageFontWidth

back to summary

public float getAverageFontWidth()

Implements org.apache.pdfbox.pdmodel.font.PDFontLike.getAverageFontWidth.

Doc from org.apache.pdfbox.pdmodel.font.PDFontLike.getAverageFontWidth.

This will get the average font width for all characters.

Returns:float

The width is in 1000 unit of text space, ie 333 or 777

Annotations

@Override

getBaseFont	back to summary
public String getBaseFont() The PostScript name of the font. Returns:String The postscript name of the font.

getBaseFont

back to summary

public String getBaseFont()

The PostScript name of the font.

Returns:String: The postscript name of the font.

getCIDSystemInfo	back to summary
public PDCIDSystemInfo getCIDSystemInfo() Returns the CIDSystemInfo, or null if it is missing (which isn't allowed but could happen). Returns:PDCIDSystemInfo the CIDSystemInfo, or null

getCIDSystemInfo

back to summary

public PDCIDSystemInfo getCIDSystemInfo()

Returns the CIDSystemInfo, or null if it is missing (which isn't allowed but could happen).

Returns:PDCIDSystemInfo: the CIDSystemInfo, or null

getCOSObject	back to summary
public COSDictionary getCOSObject() Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject. Doc from 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.

Doc from 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

getDefaultPositionVector	back to summary
private Vector getDefaultPositionVector(int cid) Returns the default position vector (v). Parameters cid:int CID

getDefaultPositionVector

back to summary

private Vector getDefaultPositionVector(int cid)

Returns the default position vector (v).

Parameters

cid:int: CID

getDefaultWidth	back to summary
private float getDefaultWidth() This will get the default width. The default value for the default width is 1000. Returns:float The default width for the glyphs in this font.

getDefaultWidth

back to summary

private float getDefaultWidth()

This will get the default width. The default value for the default width is 1000.

Returns:float: The default width for the glyphs in this font.

getFontDescriptor	back to summary
public PDFontDescriptor getFontDescriptor() Implements org.apache.pdfbox.pdmodel.font.PDFontLike.getFontDescriptor. Doc from org.apache.pdfbox.pdmodel.font.PDFontLike.getFontDescriptor. Returns the font descriptor, may be null. Returns:PDFontDescriptor the font descriptor or null Annotations @Override

getFontDescriptor

back to summary

public PDFontDescriptor getFontDescriptor()

Implements org.apache.pdfbox.pdmodel.font.PDFontLike.getFontDescriptor.

Doc from org.apache.pdfbox.pdmodel.font.PDFontLike.getFontDescriptor.

Returns the font descriptor, may be null.

Returns:PDFontDescriptor

the font descriptor or null

Annotations

@Override

getName	back to summary
public String getName() Implements org.apache.pdfbox.pdmodel.font.PDFontLike.getName. Doc from org.apache.pdfbox.pdmodel.font.PDFontLike.getName. Returns the name of this font, either the PostScript "BaseName" or the Type 3 "Name". Returns:String the name of the font Annotations @Override

getName

back to summary

public String getName()

Implements org.apache.pdfbox.pdmodel.font.PDFontLike.getName.

Doc from org.apache.pdfbox.pdmodel.font.PDFontLike.getName.

Returns the name of this font, either the PostScript "BaseName" or the Type 3 "Name".

Returns:String

the name of the font

Annotations

@Override

getParent	back to summary
public final PDType0Font getParent() Returns the Type 0 font which is the parent of this font. Returns:PDType0Font parent Type 0 font

getParent

back to summary

public final PDType0Font getParent()

Returns the Type 0 font which is the parent of this font.

Returns:PDType0Font: parent Type 0 font

getPositionVector	back to summary
public Vector getPositionVector(int code) Implements org.apache.pdfbox.pdmodel.font.PDFontLike.getPositionVector. Doc from org.apache.pdfbox.pdmodel.font.PDFontLike.getPositionVector. Returns the position vector (v), in text space, for the given character. This represents the position of vertical origin relative to horizontal origin, for horizontal writing it will always be (0, 0). For vertical writing both x and y are set. Parameters code:int character code Returns:Vector position vector Annotations @Override

getPositionVector

back to summary

public Vector getPositionVector(int code)

Implements org.apache.pdfbox.pdmodel.font.PDFontLike.getPositionVector.

Doc from org.apache.pdfbox.pdmodel.font.PDFontLike.getPositionVector.

Returns the position vector (v), in text space, for the given character. This represents the position of vertical origin relative to horizontal origin, for horizontal writing it will always be (0, 0). For vertical writing both x and y are set.

Parameters

code:int: character code

Returns:Vector

position vector

Annotations

@Override

getVerticalDisplacementVectorY	back to summary
public float getVerticalDisplacementVectorY(int code) Returns the y-component of the vertical displacement vector (w1). Parameters code:int character code Returns:float w1y

getVerticalDisplacementVectorY

back to summary

public float getVerticalDisplacementVectorY(int code)

Returns the y-component of the vertical displacement vector (w1).

Parameters

code:int: character code

Returns:float

w1y

getWidth	back to summary
public float getWidth(int code) throws IOException Implements org.apache.pdfbox.pdmodel.font.PDFontLike.getWidth. Doc from org.apache.pdfbox.pdmodel.font.PDFontLike.getWidth. Returns the advance width of the given character, in glyph space. If you want the visual bounds of the glyph then call getPath(..) on the appropriate PDFont subclass to retrieve the glyph outline as a GeneralPath instead. See the cyan rectangles in the DrawPrintTextLocations.java example to see this in action. Parameters code:int character code Returns:float the width of the given character Annotations @Override Exceptions IOException: if the width could not be read

getWidth

back to summary

public float getWidth(int code) throws IOException

Implements org.apache.pdfbox.pdmodel.font.PDFontLike.getWidth.

Doc from org.apache.pdfbox.pdmodel.font.PDFontLike.getWidth.

Returns the advance width of the given character, in glyph space.

If you want the visual bounds of the glyph then call getPath(..) on the appropriate PDFont subclass to retrieve the glyph outline as a GeneralPath instead. See the cyan rectangles in the DrawPrintTextLocations.java example to see this in action.

Parameters

code:int: character code

Returns:float

the width of the given character

Annotations

@Override

Exceptions

IOException:: if the width could not be read

getWidthForCID	back to summary
private float getWidthForCID(int cid)

hasExplicitWidth	back to summary
public boolean hasExplicitWidth(int code) throws IOException Implements org.apache.pdfbox.pdmodel.font.PDFontLike.hasExplicitWidth. Doc from org.apache.pdfbox.pdmodel.font.PDFontLike.hasExplicitWidth. Returns true if the Font dictionary specifies an explicit width for the given glyph. This includes Width, W but not default widths entries. Parameters code:int character code Returns:boolean true if the Font dictionary specifies an explicit width for the given glyph Annotations @Override Exceptions IOException: if the font could not be read

hasExplicitWidth

back to summary

public boolean hasExplicitWidth(int code) throws IOException

Implements org.apache.pdfbox.pdmodel.font.PDFontLike.hasExplicitWidth.

Doc from org.apache.pdfbox.pdmodel.font.PDFontLike.hasExplicitWidth.

Returns true if the Font dictionary specifies an explicit width for the given glyph. This includes Width, W but not default widths entries.

Parameters

code:int: character code

Returns:boolean

true if the Font dictionary specifies an explicit width for the given glyph

Annotations

@Override

Exceptions

IOException:: if the font could not be read

readCIDToGIDMap	back to summary
pack-priv final int[] readCIDToGIDMap() throws IOException

readVerticalDisplacements	back to summary
private void readVerticalDisplacements()

readWidths	back to summary
private void readWidths()

public abstract Class PDCIDFont

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail