Package org.apache.fop.pdf
Class PDFDocument
- java.lang.Object
-
- org.apache.fop.pdf.PDFDocument
-
public class PDFDocument extends java.lang.Object
Class representing a PDF document. The document is built up by calling various methods and then finally output to given filehandle using output method. A PDF document consists of a series of numbered objects preceded by a header and followed by an xref table and trailer. The xref table allows for quick access to objects by listing their character positions within the document. For this reason the PDF document must keep track of the character position of each object. The document also keeps direct track of the /Root, /Info and /Resources objects. Modified by Mark Lillywhite, mark-fop@inomial.com. The changes involve: ability to output pages one-at-a-time in a streaming fashion (rather than storing them all for output at the end); ability to write the /Pages object after writing the rest of the document; ability to write to a stream and flush the object list; enhanced trailer output; cleanups.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ENCODING
the encoding to use when converting strings to PDF commandsprotected int
gStateObjectCount
protected java.util.List<java.lang.Long>
indirectObjectOffsets
the character position of each objectprotected int
objectcount
the counter for object numberingprotected java.util.List<PDFObject>
objects
the objects themselvesprotected boolean
outputStarted
protected java.util.List<PDFPage>
pageObjs
protected long
position
the current character positionprotected java.util.List<PDFStructElem>
structureTreeElements
protected java.util.List<PDFObject>
trailerObjects
List of objects to write in the trailer
-
Constructor Summary
Constructors Constructor Description PDFDocument(java.lang.String prod)
Creates an empty PDF document.PDFDocument(java.lang.String prod, VersionController versionController)
Creates an empty PDF document.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addDestination(PDFDestination destination)
Adds a destination to the document.PDFFormXObject
addFormXObject(PDFResourceContext res, PDFStream cont, PDFReference formres, java.lang.String key)
Add a form XObject to the PDF document.PDFImageXObject
addImage(PDFResourceContext res, PDFImage img)
Add an image to the PDF document.void
addObject(PDFObject obj)
Adds aPDFObject
to this document.void
addTrailerObject(PDFObject obj)
Add trailer object.void
applyEncryption(AbstractPDFStream stream)
Apply the encryption filter to a PDFStream if encryption is enabled.void
assignObjectNumber(PDFObject obj)
void
enableAccessibility(boolean enableAccessibility)
static byte[]
encode(java.lang.String text)
Converts text to a byte array for writing to a PDF file.protected PDFDestination
findDestination(PDFDestination compare)
Finds a named destination.protected PDFFileSpec
findFileSpec(PDFFileSpec compare)
Finds a file spec.protected PDFFont
findFont(java.lang.String fontname)
Finds a font.protected PDFFunction
findFunction(PDFFunction compare)
Looks through the registered functions to see if one that is equal to a reference object existsprotected PDFGoTo
findGoTo(PDFGoTo compare)
Finds a goto.protected PDFGoToRemote
findGoToRemote(PDFGoToRemote compare)
Finds a goto remote.protected PDFGState
findGState(PDFGState wanted, PDFGState current)
Looks for an existing GState to useprotected PDFLaunch
findLaunch(PDFLaunch compare)
Finds a launch.protected PDFLink
findLink(PDFLink compare)
Finds a link.protected PDFPattern
findPattern(PDFPattern compare)
Find a previous pattern.protected PDFShading
findShading(PDFShading compare)
Looks through the registered shadings to see if one that is equal to a reference object existsstatic void
flushTextBuffer(java.lang.StringBuilder textBuffer, java.io.OutputStream out)
Flushes the given text buffer to an output stream with the right encoding and resets the text buffer.int
getColorSpace()
Returns the color space.java.util.List<PDFDestination>
getDestinationList()
Gets the list of named destinations.PDFEncryption
getEncryption()
Returns the active Encryption object.PDFFactory
getFactory()
Returns the factory for PDF objects.java.util.Map<java.lang.String,java.util.List<java.lang.String>>
getFilterMap()
Returns thePDFFilter
s map used for filters in this document.java.util.Map<java.lang.String,PDFFont>
getFontMap()
Returns the font map for this document.PDFImageXObject
getImage(java.lang.String key)
Deprecated.Use getXObject instead (so forms are treated in the same way)PDFInfo
getInfo()
Get thePDFInfo
object for this document.PDFOutline
getOutlineRoot()
Get the root Outlines object.PDFPages
getPages()
Returns thePDFPages
object associated with the root object.PDFDeviceColorSpace
getPDFColorSpace()
Returns the PDF color space object.Version
getPDFVersion()
Returns the current PDF version.java.lang.String
getPDFVersionString()
PDFProfile
getProfile()
PDFResources
getResources()
Get the /Resources object for the documentPDFRoot
getRoot()
Get thePDFRoot
object for this document.java.util.List<PDFStructElem>
getStructureTreeElements()
Get the Structural Tree Collection for this documentPDFXObject
getXObject(java.lang.String key)
Get an XObject from the image map.boolean
hasDestinations()
Gets whether the document has named destinations.boolean
isEncryptionActive()
Indicates whether encryption is active for this PDF or not.boolean
isFormXObjectEnabled()
boolean
isLinearizationEnabled()
boolean
isMergeFontsEnabled()
PDFStructTreeRoot
makeStructTreeRoot(PDFParentTree parentTree)
Creates and returns a StructTreeRoot object.void
output(java.io.OutputStream stream)
Writes out the entire documentvoid
outputHeader(java.io.OutputStream stream)
Write the PDF header.static int
outputIndirectObject(PDFObject object, java.io.OutputStream stream)
Outputs the given object, wrapped by obj/endobj, to the given stream.void
outputTrailer(java.io.OutputStream stream)
Write the trailerPDFObject
registerObject(PDFObject obj)
Registers aPDFObject
in this PDF document.void
registerStructureElement(PDFStructElem structElem)
Adds the given element to the structure tree.void
registerStructureElement(PDFStructElem structElem, StandardStructureAttributes.Table.Scope scope)
Assigns the given scope to the given element and adds it to the structure tree.PDFReference
resolveExtensionReference(java.lang.String id)
void
setColorSpace(int theColorspace)
Set the color space.void
setCreationDate(java.util.Date date)
Sets the creation date of the document.void
setCreator(java.lang.String creator)
Sets the creator of the document.void
setEncryption(PDFEncryptionParams params)
Enables PDF encryption.void
setFilterMap(java.util.Map<java.lang.String,java.util.List<java.lang.String>> map)
Sets the filter map to use for filters in this document.void
setFormXObjectEnabled(boolean b)
void
setLinearizationEnabled(boolean b)
void
setMergeFontsEnabled(boolean mergeFontsEnabled)
void
setPDFVersion(Version version)
Sets the PDF version of this document.void
setProducer(java.lang.String producer)
Sets the producer of the document.protected int
streamIndirectObject(PDFObject o, java.io.OutputStream stream)
protected void
writeTrailer(java.io.OutputStream stream, int first, int last, int size, long mainOffset, long startxref)
-
-
-
Field Detail
-
ENCODING
public static final java.lang.String ENCODING
the encoding to use when converting strings to PDF commands- See Also:
- Constant Field Values
-
objectcount
protected int objectcount
the counter for object numbering
-
position
protected long position
the current character position
-
indirectObjectOffsets
protected java.util.List<java.lang.Long> indirectObjectOffsets
the character position of each object
-
structureTreeElements
protected java.util.List<PDFStructElem> structureTreeElements
-
trailerObjects
protected java.util.List<PDFObject> trailerObjects
List of objects to write in the trailer
-
objects
protected java.util.List<PDFObject> objects
the objects themselves
-
gStateObjectCount
protected int gStateObjectCount
-
pageObjs
protected java.util.List<PDFPage> pageObjs
-
outputStarted
protected boolean outputStarted
-
-
Constructor Detail
-
PDFDocument
public PDFDocument(java.lang.String prod)
Creates an empty PDF document. The constructor creates a /Root and /Pages object to track the document but does not write these objects until the trailer is written. Note that the object ID of the pages object is determined now, and the xref table is updated later. This allows Pages to refer to their Parent before we write it out.- Parameters:
prod
- the name of the producer of this pdf document
-
PDFDocument
public PDFDocument(java.lang.String prod, VersionController versionController)
Creates an empty PDF document. The constructor creates a /Root and /Pages object to track the document but does not write these objects until the trailer is written. Note that the object ID of the pages object is determined now, and the xref table is updated later. This allows Pages to refer to their Parent before we write it out.- Parameters:
prod
- the name of the producer of this pdf documentversionController
- the version controller of this PDF document
-
-
Method Detail
-
getPDFVersion
public Version getPDFVersion()
Returns the current PDF version.- Returns:
- returns the PDF version
-
setPDFVersion
public void setPDFVersion(Version version)
Sets the PDF version of this document.- Parameters:
version
- the PDF version- Throws:
java.lang.IllegalStateException
- if the version of this PDF is not allowed to change.
-
getPDFVersionString
public java.lang.String getPDFVersionString()
- Returns:
- the String representing the current PDF version
-
getProfile
public PDFProfile getProfile()
- Returns:
- the PDF profile currently active.
-
getFactory
public PDFFactory getFactory()
Returns the factory for PDF objects.- Returns:
- the
PDFFactory
object
-
encode
public static byte[] encode(java.lang.String text)
Converts text to a byte array for writing to a PDF file.- Parameters:
text
- text to convert/encode- Returns:
- the resulting
byte
array
-
flushTextBuffer
public static void flushTextBuffer(java.lang.StringBuilder textBuffer, java.io.OutputStream out) throws java.io.IOException
Flushes the given text buffer to an output stream with the right encoding and resets the text buffer. This is used to efficiently switch between outputting text and binary content.- Parameters:
textBuffer
- the text bufferout
- the output stream to flush the text content to- Throws:
java.io.IOException
- if an I/O error occurs while writing to the output stream
-
setProducer
public void setProducer(java.lang.String producer)
Sets the producer of the document.- Parameters:
producer
- string indicating application producing the PDF
-
setCreationDate
public void setCreationDate(java.util.Date date)
Sets the creation date of the document.- Parameters:
date
- Date to be stored as creation date in the PDF.
-
setCreator
public void setCreator(java.lang.String creator)
Sets the creator of the document.- Parameters:
creator
- string indicating application creating the document
-
setFilterMap
public void setFilterMap(java.util.Map<java.lang.String,java.util.List<java.lang.String>> map)
Sets the filter map to use for filters in this document.- Parameters:
map
- the map of filter lists for each stream type
-
getFilterMap
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getFilterMap()
Returns thePDFFilter
s map used for filters in this document.- Returns:
- the map of filters being used
-
getPages
public PDFPages getPages()
Returns thePDFPages
object associated with the root object.- Returns:
- the
PDFPages
object
-
getRoot
public PDFRoot getRoot()
Get thePDFRoot
object for this document.- Returns:
- the
PDFRoot
object
-
getStructureTreeElements
public java.util.List<PDFStructElem> getStructureTreeElements()
Get the Structural Tree Collection for this document- Returns:
-
makeStructTreeRoot
public PDFStructTreeRoot makeStructTreeRoot(PDFParentTree parentTree)
Creates and returns a StructTreeRoot object.- Parameters:
parentTree
- the value of the ParenTree entry- Returns:
- the structure tree root
-
registerStructureElement
public void registerStructureElement(PDFStructElem structElem)
Adds the given element to the structure tree.
-
registerStructureElement
public void registerStructureElement(PDFStructElem structElem, StandardStructureAttributes.Table.Scope scope)
Assigns the given scope to the given element and adds it to the structure tree. The scope may not be added if it's not compatible with this document's PDF version.
-
getInfo
public PDFInfo getInfo()
Get thePDFInfo
object for this document.- Returns:
- the
PDFInfo
object
-
registerObject
public PDFObject registerObject(PDFObject obj)
Registers aPDFObject
in this PDF document. The object is assigned a new object number.
-
assignObjectNumber
public void assignObjectNumber(PDFObject obj)
- Parameters:
obj
-PDFObject
to assign a number to
-
addObject
public void addObject(PDFObject obj)
Adds aPDFObject
to this document. The object MUST have an object number assigned.- Parameters:
obj
-PDFObject
to add
-
addTrailerObject
public void addTrailerObject(PDFObject obj)
Add trailer object. Adds an object to the list of trailer objects.- Parameters:
obj
- the PDF object to add
-
applyEncryption
public void applyEncryption(AbstractPDFStream stream)
Apply the encryption filter to a PDFStream if encryption is enabled.- Parameters:
stream
- PDFStream to encrypt
-
setEncryption
public void setEncryption(PDFEncryptionParams params)
Enables PDF encryption.- Parameters:
params
- The encryption parameters for the pdf file
-
isEncryptionActive
public boolean isEncryptionActive()
Indicates whether encryption is active for this PDF or not.- Returns:
- boolean True if encryption is active
-
getEncryption
public PDFEncryption getEncryption()
Returns the active Encryption object.- Returns:
- the Encryption object
-
findFunction
protected PDFFunction findFunction(PDFFunction compare)
Looks through the registered functions to see if one that is equal to a reference object exists- Parameters:
compare
- reference object- Returns:
- the function if it was found, null otherwise
-
findShading
protected PDFShading findShading(PDFShading compare)
Looks through the registered shadings to see if one that is equal to a reference object exists- Parameters:
compare
- reference object- Returns:
- the shading if it was found, null otherwise
-
findPattern
protected PDFPattern findPattern(PDFPattern compare)
Find a previous pattern. The problem with this is for tiling patterns the pattern data stream is stored and may use up memory, usually this would only be a small amount of data.- Parameters:
compare
- reference object- Returns:
- the shading if it was found, null otherwise
-
findFont
protected PDFFont findFont(java.lang.String fontname)
Finds a font.- Parameters:
fontname
- name of the font- Returns:
- PDFFont the requested font, null if it wasn't found
-
findDestination
protected PDFDestination findDestination(PDFDestination compare)
Finds a named destination.- Parameters:
compare
- reference object to use as search template- Returns:
- the link if found, null otherwise
-
findLink
protected PDFLink findLink(PDFLink compare)
Finds a link.- Parameters:
compare
- reference object to use as search template- Returns:
- the link if found, null otherwise
-
findFileSpec
protected PDFFileSpec findFileSpec(PDFFileSpec compare)
Finds a file spec.- Parameters:
compare
- reference object to use as search template- Returns:
- the file spec if found, null otherwise
-
findGoToRemote
protected PDFGoToRemote findGoToRemote(PDFGoToRemote compare)
Finds a goto remote.- Parameters:
compare
- reference object to use as search template- Returns:
- the goto remote if found, null otherwise
-
findGoTo
protected PDFGoTo findGoTo(PDFGoTo compare)
Finds a goto.- Parameters:
compare
- reference object to use as search template- Returns:
- the goto if found, null otherwise
-
findLaunch
protected PDFLaunch findLaunch(PDFLaunch compare)
Finds a launch.- Parameters:
compare
- reference object to use as search template- Returns:
- the launch if found, null otherwise
-
findGState
protected PDFGState findGState(PDFGState wanted, PDFGState current)
Looks for an existing GState to use- Parameters:
wanted
- requested featurescurrent
- currently active features- Returns:
- the GState if found, null otherwise
-
getPDFColorSpace
public PDFDeviceColorSpace getPDFColorSpace()
Returns the PDF color space object.- Returns:
- the color space
-
getColorSpace
public int getColorSpace()
Returns the color space.- Returns:
- the color space
-
setColorSpace
public void setColorSpace(int theColorspace)
Set the color space. This is used when creating gradients.- Parameters:
theColorspace
- the new color space
-
getFontMap
public java.util.Map<java.lang.String,PDFFont> getFontMap()
Returns the font map for this document.- Returns:
- the map of fonts used in this document
-
getImage
@Deprecated public PDFImageXObject getImage(java.lang.String key)
Deprecated.Use getXObject instead (so forms are treated in the same way)Get an image from the image map.- Parameters:
key
- the image key to look for- Returns:
- the image or PDFXObject for the key if found
-
getXObject
public PDFXObject getXObject(java.lang.String key)
Get an XObject from the image map.- Parameters:
key
- the XObject key to look for- Returns:
- the PDFXObject for the key if found
-
addDestination
public void addDestination(PDFDestination destination)
Adds a destination to the document.- Parameters:
destination
- the destination object
-
getDestinationList
public java.util.List<PDFDestination> getDestinationList()
Gets the list of named destinations.- Returns:
- the list of named destinations.
-
hasDestinations
public boolean hasDestinations()
Gets whether the document has named destinations.- Returns:
- whether the document has named destinations.
-
addImage
public PDFImageXObject addImage(PDFResourceContext res, PDFImage img)
Add an image to the PDF document. This adds an image to the PDF objects. If an image with the same key already exists it will return the oldPDFXObject
.- Parameters:
res
- the PDF resource context to add to, may be nullimg
- the PDF image to add- Returns:
- the PDF XObject that references the PDF image data
-
addFormXObject
public PDFFormXObject addFormXObject(PDFResourceContext res, PDFStream cont, PDFReference formres, java.lang.String key)
Add a form XObject to the PDF document. This adds a Form XObject to the PDF objects. If a Form XObject with the same key already exists it will return the oldPDFFormXObject
.- Parameters:
res
- the PDF resource context to add to, may be nullcont
- the PDF Stream contents of the Form XObjectformres
- a reference to the PDF Resources for the Form XObject datakey
- the key for the object- Returns:
- the PDF Form XObject that references the PDF data
-
getOutlineRoot
public PDFOutline getOutlineRoot()
Get the root Outlines object. This method does not write the outline to the PDF document, it simply creates a reference for later.- Returns:
- the PDF Outline root object
-
getResources
public PDFResources getResources()
Get the /Resources object for the document- Returns:
- the /Resources object
-
enableAccessibility
public void enableAccessibility(boolean enableAccessibility)
-
resolveExtensionReference
public PDFReference resolveExtensionReference(java.lang.String id)
-
output
public void output(java.io.OutputStream stream) throws java.io.IOException
Writes out the entire document- Parameters:
stream
- the OutputStream to output the document to- Throws:
java.io.IOException
- if there is an exception writing to the output stream
-
writeTrailer
protected void writeTrailer(java.io.OutputStream stream, int first, int last, int size, long mainOffset, long startxref) throws java.io.IOException
- Throws:
java.io.IOException
-
streamIndirectObject
protected int streamIndirectObject(PDFObject o, java.io.OutputStream stream) throws java.io.IOException
- Throws:
java.io.IOException
-
outputIndirectObject
public static int outputIndirectObject(PDFObject object, java.io.OutputStream stream) throws java.io.IOException
Outputs the given object, wrapped by obj/endobj, to the given stream.- Parameters:
object
- an indirect object, as described in Section 3.2.9 of the PDF 1.5 Reference.stream
- the stream to which the object must be output- Throws:
java.lang.IllegalArgumentException
- if the object is not an indirect objectjava.io.IOException
-
outputHeader
public void outputHeader(java.io.OutputStream stream) throws java.io.IOException
Write the PDF header. This method must be called prior to formatting and outputting AreaTrees.- Parameters:
stream
- the OutputStream to write the header to- Throws:
java.io.IOException
- if there is an exception writing to the output stream
-
outputTrailer
public void outputTrailer(java.io.OutputStream stream) throws java.io.IOException
Write the trailer- Parameters:
stream
- the OutputStream to write the trailer to- Throws:
java.io.IOException
- if there is an exception writing to the output stream
-
isMergeFontsEnabled
public boolean isMergeFontsEnabled()
-
setMergeFontsEnabled
public void setMergeFontsEnabled(boolean mergeFontsEnabled)
-
isLinearizationEnabled
public boolean isLinearizationEnabled()
-
setLinearizationEnabled
public void setLinearizationEnabled(boolean b)
-
isFormXObjectEnabled
public boolean isFormXObjectEnabled()
-
setFormXObjectEnabled
public void setFormXObjectEnabled(boolean b)
-
-