Package com.itextpdf.kernel.pdf
Class PdfWriter
java.lang.Object
java.io.OutputStream
com.itextpdf.io.source.OutputStream<PdfOutputStream>
com.itextpdf.kernel.pdf.PdfOutputStream
com.itextpdf.kernel.pdf.PdfWriter
- All Implemented Interfaces:
Closeable
,Flushable
,AutoCloseable
- Direct Known Subclasses:
MemoryFirstPdfWriter
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Map
<PdfIndirectReference, PdfIndirectReference> Is used to avoid duplications on object copying.private static final byte[]
protected boolean
private static final byte[]
(package private) PdfObjectStream
Currently active object stream.protected WriterProperties
private SmartModePdfObjectsSerializer
Is used in smart mode to serialize and store serialized objects content.Fields inherited from class com.itextpdf.kernel.pdf.PdfOutputStream
crypto, document
Fields inherited from class com.itextpdf.io.source.OutputStream
closeStream, currentPos, outputStream
-
Constructor Summary
ConstructorsConstructorDescriptionCreate a PdfWriter writing to the passed File and with default writer properties.Create a PdfWriter writing to the passed outputstream and with default writer properties.PdfWriter
(OutputStream os, WriterProperties properties) Create a PdfWriter writing to the passed filename and with default writer properties.PdfWriter
(String filename, WriterProperties properties) Create a PdfWriter writing to the passed filename and using the passed writer properties. -
Method Summary
Modifier and TypeMethodDescriptionprivate static boolean
checkTypeOfPdfDictionary
(PdfObject dictionary, PdfName expectedType) protected PdfObject
copyObject
(PdfObject obj, PdfDocument documentTo, boolean allowDuplicating) Copies a PdfObject either stand alone or as part of the PdfDocument passed as documentTo.protected PdfObject
copyObject
(PdfObject obj, PdfDocument documentTo, boolean allowDuplicating, ICopyFilter copyFilter) Copies a PdfObject either stand alone or as part of the PdfDocument passed as documentTo.(package private) void
flushCopiedObjects
(long docId) Flush all copied objects.protected void
flushModifiedWaitingObjects
(Set<PdfIndirectReference> forbiddenToFlush) Flushes all modified objects which have not been flushed yet.protected void
flushObject
(PdfObject pdfObject, boolean canBeInObjStm) Flushes the object.protected void
flushWaitingObjects
(Set<PdfIndirectReference> forbiddenToFlush) Flushes all objects which have not been flushed yet.int
Gets default compression level for @see PdfStream.(package private) PdfObjectStream
Gets the current object stream.Gets the writer properties.protected void
initCryptoIfSpecified
(PdfVersion version) boolean
Indicates if to use full compression mode.private void
markArrayContentToFlush
(PdfArray array) private void
markDictionaryContentToFlush
(PdfDictionary dictionary) private void
markObjectToFlush
(PdfObject pdfObject) setCompressionLevel
(int compressionLevel) Sets default compression level for @see PdfStream.setSmartMode
(boolean smartMode) Sets the smart mode.protected void
Writes PDF header.protected void
writeToBody
(PdfObject pdfObj) Writes object to body of PDF document.Methods inherited from class com.itextpdf.kernel.pdf.PdfOutputStream
checkEncryption, containsFlateFilter, decodeFlateBytes, updateCompressionFilter, write, write, write
Methods inherited from class com.itextpdf.io.source.OutputStream
assignBytes, close, flush, getCurrentPos, getHighPrecision, getLocalHighPrecision, getOutputStream, isCloseStream, reset, setCloseStream, setHighPrecision, setLocalHighPrecision, write, write, write, writeByte, writeByte, writeBytes, writeBytes, writeDouble, writeDouble, writeFloat, writeFloat, writeFloats, writeInteger, writeLong, writeNewLine, writeSpace, writeString
Methods inherited from class java.io.OutputStream
nullOutputStream
-
Field Details
-
obj
private static final byte[] obj -
endobj
private static final byte[] endobj -
properties
-
isUserWarnedAboutAcroFormCopying
protected boolean isUserWarnedAboutAcroFormCopying -
objectStream
PdfObjectStream objectStreamCurrently active object stream. Objects are written to the object stream if fullCompression set to true. -
copiedObjects
Is used to avoid duplications on object copying. It stores hashes of the indirect reference from the source document and the corresponding indirect references of the copied objects from the new document. -
smartModeSerializer
Is used in smart mode to serialize and store serialized objects content.
-
-
Constructor Details
-
PdfWriter
Create a PdfWriter writing to the passed File and with default writer properties.- Parameters:
file
- File to write to.- Throws:
FileNotFoundException
- if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason
-
PdfWriter
Create a PdfWriter writing to the passed outputstream and with default writer properties.- Parameters:
os
- Outputstream to write to.
-
PdfWriter
-
PdfWriter
Create a PdfWriter writing to the passed filename and with default writer properties.- Parameters:
filename
- filename of the resulting pdf.- Throws:
FileNotFoundException
- if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason
-
PdfWriter
Create a PdfWriter writing to the passed filename and using the passed writer properties.- Parameters:
filename
- filename of the resulting pdf.properties
- writerproperties to use.- Throws:
FileNotFoundException
- if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason
-
-
Method Details
-
isFullCompression
public boolean isFullCompression()Indicates if to use full compression mode.- Returns:
- true if to use full compression, false otherwise.
-
getCompressionLevel
public int getCompressionLevel()Gets default compression level for @see PdfStream. For more details @seeDeflaterOutputStream
.- Returns:
- compression level.
-
setCompressionLevel
Sets default compression level for @see PdfStream. For more details @seeDeflaterOutputStream
.- Parameters:
compressionLevel
- compression level.- Returns:
- this
PdfWriter
instance
-
getProperties
Gets the writer properties.- Returns:
- The
WriterProperties
of the current PdfWriter.
-
setSmartMode
Sets the smart mode.
In smart mode when resources (such as fonts, images,...) are encountered, a reference to these resources is saved in a cache, so that they can be reused. This requires more memory, but reduces the file size of the resulting PDF document.- Parameters:
smartMode
- True for enabling smart mode.- Returns:
- this
PdfWriter
instance
-
initCryptoIfSpecified
-
flushObject
Flushes the object. Override this method if you want to define custom behaviour for object flushing.- Parameters:
pdfObject
- object to flush.canBeInObjStm
- indicates whether object can be placed into object stream.
-
copyObject
Copies a PdfObject either stand alone or as part of the PdfDocument passed as documentTo.- Parameters:
obj
- object to copydocumentTo
- optional target documentallowDuplicating
- allow that some objects will become duplicated by this action- Returns:
- the copies object
-
copyObject
protected PdfObject copyObject(PdfObject obj, PdfDocument documentTo, boolean allowDuplicating, ICopyFilter copyFilter) Copies a PdfObject either stand alone or as part of the PdfDocument passed as documentTo.- Parameters:
obj
- object to copydocumentTo
- optional target documentallowDuplicating
- allow that some objects will become duplicated by this actioncopyFilter
-ICopyFilter
a filter to apply while copying arrays and dictionaries * UseNullCopyFilter
for no filtering- Returns:
- the copies object
-
writeToBody
Writes object to body of PDF document.- Parameters:
pdfObj
- object to write.
-
writeHeader
protected void writeHeader()Writes PDF header. -
flushWaitingObjects
Flushes all objects which have not been flushed yet.- Parameters:
forbiddenToFlush
- aSet
ofreferences
that are forbidden to be flushed automatically.
-
flushModifiedWaitingObjects
Flushes all modified objects which have not been flushed yet. Used in case incremental updates.- Parameters:
forbiddenToFlush
- aSet
ofreferences
that are forbidden to be flushed automatically.
-
getObjectStream
PdfObjectStream getObjectStream()Gets the current object stream.- Returns:
- object stream.
-
flushCopiedObjects
void flushCopiedObjects(long docId) Flush all copied objects.- Parameters:
docId
- id of the source document
-
markArrayContentToFlush
-
markDictionaryContentToFlush
-
markObjectToFlush
-
checkTypeOfPdfDictionary
-