DocWriter class for PDF.
- *
- * When this PdfWriter is added
- * to a certain PdfDocument, the PDF representation of every Element
- * added to this Document will be written to the outputstream.
+ * When this PdfWriter is added to a certain PdfDocument, the PDF representation of every
+ * Element added to this Document will be written to the outputstream.
- * This class covers the third section of Chapter 5 in the 'Portable Document Format - * Reference Manual version 1.3' (page 55-60). It contains the body of a PDF document - * (section 5.14) and it can also generate a Cross-reference Table (section 5.15). + *
+ * This class covers the third section of Chapter 5 in the 'Portable Document Format Reference Manual version 1.3'
+ * (page 55-60). It contains the body of a PDF document (section 5.14) and it can also generate a Cross-reference
+ * Table (section 5.15).
*
- * @see PdfWriter
- * @see PdfObject
- * @see PdfIndirectObject
+ * @see PdfWriter
+ * @see PdfObject
+ * @see PdfIndirectObject
*/
-
public static class PdfBody {
- // inner classes
-
- /**
- *
- * This methods creates a
+ * This methods creates a
+ * Adds a
* This methods creates a
- * This object is described in the 'Portable Document Format Reference Manual version 1.3'
- * section 5.16 (page 59-60).
+ *
+ * This object is described in the 'Portable Document Format Reference Manual version 1.3' section 5.16 (page
+ * 59-60).
*/
static class PdfTrailer extends PdfDictionary {
@@ -529,34 +534,40 @@ static class PdfTrailer extends PdfDictionary {
/**
* Constructs a PDF-Trailer.
*
- * @param size the number of entries in the
+ *
* Remark: a PdfWriter can only be constructed by calling the method
*
- * The document has to be open before you can begin to add content
- * to the body of the document.
+ *
+ * The document has to be open before you can begin to add content to the body of the document.
*
- * @return a
- * When this method is called, the PDF-document header is
- * written to the outputstream.
+ *
+ * When this method is called, the PDF-document header is written to the outputstream.
+ *
* @see com.lowagie.text.DocWriter#open()
*/
+ @Override
public void open() {
super.open();
try {
@@ -1131,15 +1167,15 @@ public void open() {
body = new PdfBody(this);
if (pdfxConformance.isPdfX32002()) {
PdfDictionary sec = new PdfDictionary();
- sec.put(PdfName.GAMMA, new PdfArray(new float[]{2.2f,2.2f,2.2f}));
- sec.put(PdfName.MATRIX, new PdfArray(new float[]{0.4124f,0.2126f,0.0193f,0.3576f,0.7152f,0.1192f,0.1805f,0.0722f,0.9505f}));
- sec.put(PdfName.WHITEPOINT, new PdfArray(new float[]{0.9505f,1f,1.089f}));
+ sec.put(PdfName.GAMMA, new PdfArray(new float[]{2.2f, 2.2f, 2.2f}));
+ sec.put(PdfName.MATRIX, new PdfArray(
+ new float[]{0.4124f, 0.2126f, 0.0193f, 0.3576f, 0.7152f, 0.1192f, 0.1805f, 0.0722f, 0.9505f}));
+ sec.put(PdfName.WHITEPOINT, new PdfArray(new float[]{0.9505f, 1f, 1.089f}));
PdfArray arr = new PdfArray(PdfName.CALRGB);
arr.add(sec);
setDefaultColorspace(PdfName.DEFAULTRGB, addToBody(arr).getIndirectReference());
}
- }
- catch(IOException ioe) {
+ } catch (IOException ioe) {
throw new ExceptionConverter(ioe);
}
}
@@ -1147,25 +1183,29 @@ public void open() {
/**
* Signals that the
- * The pages-tree is built and written to the outputstream.
- * A Catalog is constructed, as well as an Info-object,
- * the reference table is composed and everything is written
- * to the outputstream embedded in a Trailer.
+ *
+ * The pages-tree is built and written to the outputstream. A Catalog is constructed, as well as an Info-object, the
+ * reference table is composed and everything is written to the outputstream embedded in a Trailer.
+ *
* @see com.lowagie.text.DocWriter#close()
*/
@Override
public void close() {
if (open) {
-
+ if (pdf != null && pdf.isOpen()) {
+ throw new IllegalStateException(MessageLocalization
+ .getComposedMessage("you.should.call.document.close.instead"));
+ }
if ((currentPageNumber - 1) != pageReferences.size())
- // 2019-04-26: If you get this error, it could be that you are using OpenPDF or
- // another library such as flying-saucer's ITextRenderer in a non-threadsafe way.
- // ITextRenderer is not thread safe. So if you get this problem here, create a new
- // instance, rather than re-using it.
- // See: https://github.com/LibrePDF/OpenPDF/issues/164
+ // 2019-04-26: If you get this error, it could be that you are using OpenPDF or
+ // another library such as flying-saucer's ITextRenderer in a non-threadsafe way.
+ // ITextRenderer is not thread safe. So if you get this problem here, create a new
+ // instance, rather than re-using it.
+ // See: https://github.com/LibrePDF/OpenPDF/issues/164
+ {
throw new RuntimeException("The page " + pageReferences.size() +
- " was requested but the document has only " + (currentPageNumber - 1) + " pages.");
+ " was requested but the document has only " + (currentPageNumber - 1) + " pages.");
+ }
try {
addSharedObjectsToBody();
@@ -1204,7 +1244,7 @@ public void close() {
// [F1] encryption
PdfIndirectReference encryption = null;
- PdfObject fileID = null;
+ PdfObject fileID;
body.flushObjStm();
if (crypto != null) {
PdfIndirectObject encryptionObject = addToBody(crypto.getEncryptionDictionary(), false);
@@ -1220,14 +1260,13 @@ public void close() {
// write the cross-reference table of the body
body.writeCrossReferenceTable(os, indirectCatalog.getIndirectReference(),
- infoObj.getIndirectReference(), encryption, fileID, prevxref);
+ infoObj.getIndirectReference(), encryption, fileID, prevxref);
os.write(getISOBytes("startxref\n"));
os.write(getISOBytes(String.valueOf(body.offset())));
os.write(getISOBytes("\n%%EOF\n"));
super.close();
- }
- catch(IOException ioe) {
+ } catch (IOException ioe) {
throw new ExceptionConverter(ioe);
}
}
@@ -1241,8 +1280,9 @@ protected void addSharedObjectsToBody() throws IOException {
// [F4] add the form XObjects
for (Object[] objs : formXObjects.values()) {
PdfTemplate template = (PdfTemplate) objs[1];
- if (template != null && template.getIndirectReference() instanceof PRIndirectReference)
+ if (template != null && template.getIndirectReference() instanceof PRIndirectReference) {
continue;
+ }
if (template != null && template.getType() == PdfTemplate.TYPE_TEMPLATE) {
addToBody(template.getFormXObject(compressionLevel), template.getIndirectReference());
}
@@ -1279,8 +1319,7 @@ protected void addSharedObjectsToBody() throws IOException {
for (Map.Entry
* Prefer the
* If set before opening the document it will also set the pdf version to 1.5.
*/
@@ -2007,12 +2249,14 @@ public void setFullCompression() {
/**
* The compression level of the content streams.
+ *
* @since 2.1.3
*/
protected int compressionLevel = PdfStream.DEFAULT_COMPRESSION;
/**
* Returns the compression level used for streams written by this writer.
+ *
* @return the compression level (0 = best speed, 9 = best compression, -1 is default)
* @since 2.1.3
*/
@@ -2022,35 +2266,41 @@ public int getCompressionLevel() {
/**
* Sets the compression level to be used for streams written by this writer.
+ *
* @param compressionLevel a value between 0 (best speed) and 9 (best compression)
* @since 2.1.3
*/
public void setCompressionLevel(int compressionLevel) {
- if (compressionLevel < PdfStream.NO_COMPRESSION || compressionLevel > PdfStream.BEST_COMPRESSION)
+ if (compressionLevel < PdfStream.NO_COMPRESSION || compressionLevel > PdfStream.BEST_COMPRESSION) {
this.compressionLevel = PdfStream.DEFAULT_COMPRESSION;
- else
+ } else {
this.compressionLevel = compressionLevel;
+ }
}
// [F3] adding fonts
- /** The fonts of this document */
+ /**
+ * The fonts of this document
+ */
protected LinkedHashMap
- * The colorspace is applied immediately when creating templates and
- * at the page end for the main document content.
- * @param key the name of the colorspace. It can be PdfCrossReference is an entry in the PDF Cross-Reference table.
- */
-
- public static class PdfCrossReference implements ComparablePdfBody.
+ *
* @param writer
*/
PdfBody(PdfWriter writer) {
@@ -290,8 +173,9 @@ void setRefnum(int refnum) {
}
private PdfWriter.PdfBody.PdfCrossReference addToObjStm(PdfObject obj, int nObj) throws IOException {
- if (numObj >= OBJSINSTREAM)
+ if (numObj >= OBJSINSTREAM) {
flushObjStm();
+ }
if (index == null) {
index = new ByteBuffer();
streamObjects = new ByteBuffer();
@@ -310,8 +194,9 @@ private PdfWriter.PdfBody.PdfCrossReference addToObjStm(PdfObject obj, int nObj)
}
private void flushObjStm() throws IOException {
- if (numObj == 0)
+ if (numObj == 0) {
return;
+ }
int first = index.size();
index.append(streamObjects);
PdfStream stream = new PdfStream(index.toByteArray());
@@ -327,18 +212,15 @@ private void flushObjStm() throws IOException {
/**
* Adds a PdfObject to the body.
- * PdfIndirectObject with a
- * certain number, containing the given PdfObject.
- * It also adds a PdfCrossReference for this object
- * to an ArrayList that will be used to build the
- * Cross-reference Table.
+ * PdfIndirectObject with a certain number, containing the given
+ * PdfObject. It also adds a PdfCrossReference for this object to an
+ * ArrayList that will be used to build the Cross-reference Table.
*
- * @param object a PdfObject
- * @return a PdfIndirectObject
+ * @param object a PdfObject
+ * @return a PdfIndirectObject
* @throws IOException
*/
-
PdfIndirectObject add(PdfObject object) throws IOException {
return add(object, getIndirectReferenceNumber());
}
@@ -349,9 +231,9 @@ PdfIndirectObject add(PdfObject object, boolean inObjStm) throws IOException {
/**
* Gets a PdfIndirectReference for an object that will be created in the future.
+ *
* @return a PdfIndirectReference
*/
-
PdfIndirectReference getPdfIndirectReference() {
return new PdfIndirectReference(0, getIndirectReferenceNumber());
}
@@ -363,21 +245,18 @@ int getIndirectReferenceNumber() {
}
/**
- * Adds a PdfObject to the body given an already existing
- * PdfIndirectReference.
- * PdfObject to the body given an already existing PdfIndirectReference.
+ * PdfIndirectObject with the number given by
* ref, containing the given PdfObject.
- * It also adds a PdfCrossReference for this object
- * to an ArrayList that will be used to build the
- * Cross-reference Table.
+ * It also adds a PdfCrossReference for this object to an ArrayList that will be used
+ * to build the Cross-reference Table.
*
- * @param object a PdfObject
- * @param ref a PdfIndirectReference
- * @return a PdfIndirectObject
+ * @param object a PdfObject
+ * @param ref a PdfIndirectReference
+ * @return a PdfIndirectObject
* @throws IOException
*/
-
PdfIndirectObject add(PdfObject object, PdfIndirectReference ref) throws IOException {
return add(object, ref.getNumber());
}
@@ -399,8 +278,7 @@ PdfIndirectObject add(PdfObject object, int refNumber, boolean inObjStm) throws
xrefs.add(pxref);
}
return indirect;
- }
- else {
+ } else {
PdfIndirectObject indirect = new PdfIndirectObject(refNumber, object, writer);
PdfCrossReference pxref = new PdfCrossReference(refNumber, position);
if (!xrefs.add(pxref)) {
@@ -416,9 +294,8 @@ PdfIndirectObject add(PdfObject object, int refNumber, boolean inObjStm) throws
/**
* Returns the offset of the Cross-Reference table.
*
- * @return an offset
+ * @return an offset
*/
-
long offset() {
return position;
}
@@ -426,15 +303,15 @@ long offset() {
/**
* Returns the total number of objects contained in the CrossReferenceTable of this Body.
*
- * @return a number of objects
+ * @return a number of objects
*/
-
int size() {
return Math.max((xrefs.last()).getRefnum() + 1, refnum);
}
/**
* Returns the CrossReferenceTable of the Body.
+ *
* @param os
* @param root
* @param info
@@ -444,7 +321,8 @@ int size() {
* @throws IOException
*/
- void writeCrossReferenceTable(OutputStream os, PdfIndirectReference root, PdfIndirectReference info, PdfIndirectReference encryption, PdfObject fileID, int prevxref) throws IOException {
+ void writeCrossReferenceTable(OutputStream os, PdfIndirectReference root, PdfIndirectReference info,
+ PdfIndirectReference encryption, PdfObject fileID, int prevxref) throws IOException {
int refNumber = 0;
// Old-style xref tables limit object offsets to 10 digits
boolean useNewXrefFormat = writer.isFullCompression() || position > 9_999_999_999L;
@@ -459,9 +337,9 @@ void writeCrossReferenceTable(OutputStream os, PdfIndirectReference root, PdfInd
ArrayListPdfCrossReference is an entry in the PDF Cross-Reference table.
+ */
+ public static class PdfCrossReference implements ComparablePdfTrailer is the PDF Trailer object.
- * PdfCrossReferenceTable
- * @param root an indirect reference to the root of the PDF document
- * @param info an indirect reference to the info object of the PDF document
+ * @param size the number of entries in the PdfCrossReferenceTable
+ * @param root an indirect reference to the root of the PDF document
+ * @param info an indirect reference to the info object of the PDF document
* @param encryption
* @param fileID
* @param prevxref
*/
- PdfTrailer(int size, PdfIndirectReference root, PdfIndirectReference info, PdfIndirectReference encryption, PdfObject fileID, int prevxref) {
+ PdfTrailer(int size, PdfIndirectReference root, PdfIndirectReference info, PdfIndirectReference encryption,
+ PdfObject fileID, int prevxref) {
put(PdfName.SIZE, new PdfNumber(size));
put(PdfName.ROOT, root);
if (info != null) {
put(PdfName.INFO, info);
}
- if (encryption != null)
+ if (encryption != null) {
put(PdfName.ENCRYPT, encryption);
- if (fileID != null)
+ }
+ if (fileID != null) {
put(PdfName.ID, fileID);
- if (prevxref > 0)
+ }
+ if (prevxref > 0) {
put(PdfName.PREV, new PdfNumber(prevxref));
+ }
}
/**
* Returns the PDF representation of this PdfObject.
+ *
* @param writer
* @param os
* @throws IOException
*/
+ @Override
public void toPdf(PdfWriter writer, OutputStream os) throws IOException {
os.write(getISOBytes("trailer\n"));
super.toPdf(null, os);
@@ -576,12 +587,12 @@ protected PdfWriter() {
/**
* Constructs a PdfWriter.
- * getInstance(Document document, OutputStream os).
*
- * @param document The PdfDocument that has to be written
- * @param os The OutputStream the writer has to write to.
+ * @param document The PdfDocument that has to be written
+ * @param os The OutputStream the writer has to write to.
*/
protected PdfWriter(PdfDocument document, OutputStream os) {
@@ -594,15 +605,14 @@ protected PdfWriter(PdfDocument document, OutputStream os) {
/**
* Use this method to get an instance of the PdfWriter.
*
- * @param document The Document that has to be written
- * @param os The OutputStream the writer has to write to.
- * @return a new PdfWriter
- *
- * @throws DocumentException on error
+ * @param document The Document that has to be written
+ * @param os The OutputStream the writer has to write to.
+ * @return a new PdfWriter
+ * @throws DocumentException on error
*/
public static PdfWriter getInstance(Document document, OutputStream os)
- throws DocumentException {
+ throws DocumentException {
PdfDocument pdf = new PdfDocument();
pdf.setTextRenderingOptions(document.getTextRenderingOptions());
document.addDocListener(pdf);
@@ -614,15 +624,15 @@ public static PdfWriter getInstance(Document document, OutputStream os)
/**
* Use this method to get an instance of the PdfWriter.
*
- * @return a new PdfWriter
* @param document The Document that has to be written
- * @param os The OutputStream the writer has to write to.
+ * @param os The OutputStream the writer has to write to.
* @param listener A DocListener to pass to the PdfDocument.
+ * @return a new PdfWriter
* @throws DocumentException on error
*/
public static PdfWriter getInstance(Document document, OutputStream os, DocListener listener)
- throws DocumentException {
+ throws DocumentException {
PdfDocument pdf = new PdfDocument();
pdf.setTextRenderingOptions(document.getTextRenderingOptions());
pdf.addDocListener(listener);
@@ -634,11 +644,14 @@ public static PdfWriter getInstance(Document document, OutputStream os, DocListe
// the PdfDocument instance
- /** the pdfdocument object. */
+ /**
+ * the pdfdocument object.
+ */
protected PdfDocument pdf;
/**
* Gets the PdfDocument associated with this writer.
+ *
* @return the PdfDocument
*/
@@ -647,8 +660,9 @@ PdfDocument getPdfDocument() {
}
/**
- * Use this method to get the info dictionary if you want to
- * change it directly (add keys and values to the info dictionary).
+ * Use this method to get the info dictionary if you want to change it directly (add keys and values to the info
+ * dictionary).
+ *
* @return the info dictionary
*/
public PdfDictionary getInfo() {
@@ -657,9 +671,9 @@ public PdfDictionary getInfo() {
/**
* Use this method to get the current vertical page position.
- * @param ensureNewLine Tells whether a new line shall be enforced. This may cause side effects
- * for elements that do not terminate the lines they've started because those lines will get
- * terminated.
+ *
+ * @param ensureNewLine Tells whether a new line shall be enforced. This may cause side effects for elements that do
+ * not terminate the lines they've started because those lines will get terminated.
* @return The current vertical page position.
*/
public float getVerticalPosition(boolean ensureNewLine) {
@@ -667,64 +681,71 @@ public float getVerticalPosition(boolean ensureNewLine) {
}
/**
- * Sets the initial leading for the PDF document.
- * This has to be done before the document is opened.
- * @param leading the initial leading
- * @since 2.1.6
- * @throws DocumentException if you try setting the leading after the document was opened.
+ * Sets the initial leading for the PDF document. This has to be done before the document is opened.
+ *
+ * @param leading the initial leading
+ * @throws DocumentException if you try setting the leading after the document was opened.
+ * @since 2.1.6
*/
public void setInitialLeading(float leading) throws DocumentException {
- if (open)
- throw new DocumentException(MessageLocalization.getComposedMessage("you.can.t.set.the.initial.leading.if.the.document.is.already.open"));
+ if (open) {
+ throw new DocumentException(MessageLocalization.getComposedMessage(
+ "you.can.t.set.the.initial.leading.if.the.document.is.already.open"));
+ }
pdf.setLeading(leading);
}
-
+
// the PdfDirectContentByte instances
-/*
- * You should see Direct Content as a canvas on which you can draw
- * graphics and text. One canvas goes on top of the page (getDirectContent),
- * the other goes underneath (getDirectContentUnder).
- * You can always the same object throughout your document,
- * even if you have moved to a new page. Whatever you add on
- * the canvas will be displayed on top or under the current page.
- */
+ /*
+ * You should see Direct Content as a canvas on which you can draw
+ * graphics and text. One canvas goes on top of the page (getDirectContent),
+ * the other goes underneath (getDirectContentUnder).
+ * You can always the same object throughout your document,
+ * even if you have moved to a new page. Whatever you add on
+ * the canvas will be displayed on top or under the current page.
+ */
- /** The direct content in this document. */
+ /**
+ * The direct content in this document.
+ */
protected PdfContentByte directContent;
- /** The direct content under in this document. */
+ /**
+ * The direct content under in this document.
+ */
protected PdfContentByte directContentUnder;
/**
- * Use this method to get the direct content for this document.
- * There is only one direct content, multiple calls to this method
- * will allways retrieve the same object.
+ * Use this method to get the direct content for this document. There is only one direct content, multiple calls to
+ * this method will allways retrieve the same object.
+ *
* @return the direct content
*/
public PdfContentByte getDirectContent() {
- if (!open)
+ if (!open) {
throw new RuntimeException(MessageLocalization.getComposedMessage("the.document.is.not.open"));
+ }
return directContent;
}
/**
- * Use this method to get the direct content under for this document.
- * There is only one direct content, multiple calls to this method
- * will always retrieve the same object.
+ * Use this method to get the direct content under for this document. There is only one direct content, multiple
+ * calls to this method will always retrieve the same object.
+ *
* @return the direct content
*/
public PdfContentByte getDirectContentUnder() {
- if (!open)
+ if (!open) {
throw new RuntimeException(MessageLocalization.getComposedMessage("the.document.is.not.open"));
+ }
return directContentUnder;
}
/**
- * Resets all the direct contents to empty.
- * This happens when a new page is started.
+ * Resets all the direct contents to empty. This happens when a new page is started.
*/
void resetContent() {
directContent.reset();
@@ -733,19 +754,22 @@ void resetContent() {
// PDF body
-/*
- * A PDF file has 4 parts: a header, a body, a cross-reference table, and a trailer.
- * The body contains all the PDF objects that make up the PDF document.
- * Each element gets a reference (a set of numbers) and the byte position of
- * every object is stored in the cross-reference table.
- * Use these methods only if you know what you're doing.
- */
+ /*
+ * A PDF file has 4 parts: a header, a body, a cross-reference table, and a trailer.
+ * The body contains all the PDF objects that make up the PDF document.
+ * Each element gets a reference (a set of numbers) and the byte position of
+ * every object is stored in the cross-reference table.
+ * Use these methods only if you know what you're doing.
+ */
- /** body of the PDF document */
+ /**
+ * body of the PDF document
+ */
protected PdfBody body;
/**
* Adds the local destinations to the body of the document.
+ *
* @param dest the HashMap containing the destinations
* @throws IOException on error
*/
@@ -756,98 +780,95 @@ void addLocalDestinations(TreeMap dest) throws IOException {
String name = (String) entry.getKey();
Object[] obj = (Object[]) entry.getValue();
PdfDestination destination = (PdfDestination) obj[2];
- if (obj[1] == null)
+ if (obj[1] == null) {
obj[1] = getPdfIndirectReference();
- if (destination == null)
+ }
+ if (destination == null) {
addToBody(new PdfString("invalid_" + name), (PdfIndirectReference) obj[1]);
- else
+ } else {
addToBody(destination, (PdfIndirectReference) obj[1]);
+ }
}
}
/**
- * Use this method to add a PDF object to the PDF body.
- * Use this method only if you know what you're doing!
+ * Use this method to add a PDF object to the PDF body. Use this method only if you know what you're doing!
+ *
* @param object the PDF object to add
* @return a PdfIndirectObject
* @throws IOException thrown when an I/O operation fails
*/
public PdfIndirectObject addToBody(PdfObject object) throws IOException {
- PdfIndirectObject iobj = body.add(object);
- return iobj;
+ return body.add(object);
}
/**
- * Use this method to add a PDF object to the PDF body.
- * Use this method only if you know what you're doing!
- * @param object the PDF object to add
+ * Use this method to add a PDF object to the PDF body. Use this method only if you know what you're doing!
+ *
+ * @param object the PDF object to add
* @param inObjStm a boolean
* @return a PdfIndirectObject
* @throws IOException thrown when an I/O operation fails
*/
public PdfIndirectObject addToBody(PdfObject object, boolean inObjStm) throws IOException {
- PdfIndirectObject iobj = body.add(object, inObjStm);
- return iobj;
+ return body.add(object, inObjStm);
}
/**
- * Use this method to add a PDF object to the PDF body.
- * Use this method only if you know what you're doing!
+ * Use this method to add a PDF object to the PDF body. Use this method only if you know what you're doing!
+ *
* @param object the object to add
- * @param ref the IndirectReference of that object
+ * @param ref the IndirectReference of that object
* @return a PdfIndirectObject
* @throws IOException thrown when an I/O operation fails
*/
public PdfIndirectObject addToBody(PdfObject object, PdfIndirectReference ref) throws IOException {
- PdfIndirectObject iobj = body.add(object, ref);
- return iobj;
+ return body.add(object, ref);
}
/**
- * Use this method to add a PDF object to the PDF body.
- * Use this method only if you know what you're doing!
- * @param object the object to add
- * @param ref the indirect reference
+ * Use this method to add a PDF object to the PDF body. Use this method only if you know what you're doing!
+ *
+ * @param object the object to add
+ * @param ref the indirect reference
* @param inObjStm a boolean
* @return a PdfIndirectObject
* @throws IOException thrown when an I/O operation fails
*/
- public PdfIndirectObject addToBody(PdfObject object, PdfIndirectReference ref, boolean inObjStm) throws IOException {
- PdfIndirectObject iobj = body.add(object, ref, inObjStm);
- return iobj;
+ public PdfIndirectObject addToBody(PdfObject object, PdfIndirectReference ref, boolean inObjStm)
+ throws IOException {
+ return body.add(object, ref, inObjStm);
}
/**
- * Use this method to add a PDF object to the PDF body.
- * Use this method only if you know what you're doing!
- * @param object the object to add
+ * Use this method to add a PDF object to the PDF body. Use this method only if you know what you're doing!
+ *
+ * @param object the object to add
* @param refNumber the reference number
* @return a PdfIndirectObject
* @throws IOException thrown when an I/O operation fails
*/
public PdfIndirectObject addToBody(PdfObject object, int refNumber) throws IOException {
- PdfIndirectObject iobj = body.add(object, refNumber);
- return iobj;
+ return body.add(object, refNumber);
}
/**
- * Use this method to add a PDF object to the PDF body.
- * Use this method only if you know what you're doing!
- * @param object the object to add
+ * Use this method to add a PDF object to the PDF body. Use this method only if you know what you're doing!
+ *
+ * @param object the object to add
* @param refNumber the reference number
- * @param inObjStm a boolean
+ * @param inObjStm a boolean
* @return a PdfIndirectObject
* @throws IOException thrown when an I/O operation fails
*/
public PdfIndirectObject addToBody(PdfObject object, int refNumber, boolean inObjStm) throws IOException {
- PdfIndirectObject iobj = body.add(object, refNumber, inObjStm);
- return iobj;
+ return body.add(object, refNumber, inObjStm);
}
/**
- * Use this to get an PdfIndirectReference for an object that
- * will be created in the future.
- * Use this method only if you know what you're doing!
+ * Use this to get an PdfIndirectReference for an object that will be created in the future. Use this
+ * method only if you know what you're doing!
+ *
* @return the PdfIndirectReference
*/
@@ -861,39 +882,38 @@ int getIndirectReferenceNumber() {
/**
* Returns the outputStreamCounter.
+ *
* @return the outputStreamCounter
*/
OutputStreamCounter getOs() {
return os;
}
-
// PDF Catalog
-/*
- * The Catalog is also called the root object of the document.
- * Whereas the Cross-Reference maps the objects number with the
- * byte offset so that the viewer can find the objects, the
- * Catalog tells the viewer the numbers of the objects needed
- * to render the document.
- */
+ /*
+ * The Catalog is also called the root object of the document.
+ * Whereas the Cross-Reference maps the objects number with the
+ * byte offset so that the viewer can find the objects, the
+ * Catalog tells the viewer the numbers of the objects needed
+ * to render the document.
+ */
- protected PdfDictionary getCatalog(PdfIndirectReference rootObj)
- {
+ protected PdfDictionary getCatalog(PdfIndirectReference rootObj) {
PdfDictionary catalog = pdf.getCatalog(rootObj);
// [F12] tagged PDF
if (tagged) {
try {
getStructureTreeRoot().buildTree();
- }
- catch (Exception e) {
+ } catch (Exception e) {
throw new ExceptionConverter(e);
}
catalog.put(PdfName.STRUCTTREEROOT, structureTreeRoot.getReference());
PdfDictionary mi = new PdfDictionary();
mi.put(PdfName.MARKED, PdfBoolean.PDFTRUE);
- if (userProperties)
+ if (userProperties) {
mi.put(PdfName.USERPROPERTIES, PdfBoolean.PDFTRUE);
+ }
catalog.put(PdfName.MARKINFO, mi);
}
// [F13] OCG
@@ -904,56 +924,65 @@ protected PdfDictionary getCatalog(PdfIndirectReference rootObj)
return catalog;
}
- /** Holds value of property extraCatalog this is used for Output Intents. */
+ /**
+ * Holds value of property extraCatalog this is used for Output Intents.
+ */
protected PdfDictionary extraCatalog;
/**
* Sets extra keys to the catalog.
+ *
* @return the catalog to change
*/
public PdfDictionary getExtraCatalog() {
- if (extraCatalog == null)
+ if (extraCatalog == null) {
extraCatalog = new PdfDictionary();
+ }
return this.extraCatalog;
}
// PdfPages
-/*
- * The page root keeps the complete page tree of the document.
- * There's an entry in the Catalog that refers to the root
- * of the page tree, the page tree contains the references
- * to pages and other page trees.
- */
+ /*
+ * The page root keeps the complete page tree of the document.
+ * There's an entry in the Catalog that refers to the root
+ * of the page tree, the page tree contains the references
+ * to pages and other page trees.
+ */
- /** The root of the page tree. */
+ /**
+ * The root of the page tree.
+ */
protected PdfPages root = new PdfPages(this);
- /** The PdfIndirectReference to the pages. */
+ /**
+ * The PdfIndirectReference to the pages.
+ */
protected ArrayListnull argument value only returns the number of pages to process.
- * It is advisable to issue a Document.newPage() before using this method.
+ * Use this method to reorder the pages in the document. A null argument value only returns the number
+ * of pages to process. It is advisable to issue a Document.newPage() before using this method.
+ *
+ * @param order an array with the new page sequence. It must have the same size as the number of pages.
* @return the total number of pages
- * @param order an array with the new page sequence. It must have the
- * same size as the number of pages.
* @throws DocumentException if all the pages are not present in the array
*/
public int reorderPages(int[] order) throws DocumentException {
@@ -961,18 +990,19 @@ public int reorderPages(int[] order) throws DocumentException {
}
/**
- * Use this method to get a reference to a page existing or not.
- * If the page does not exist yet the reference will be created
- * in advance. If on closing the document, a page number greater
- * than the total number of pages was requested, an exception
- * is thrown.
+ * Use this method to get a reference to a page existing or not. If the page does not exist yet the reference will
+ * be created in advance. If on closing the document, a page number greater than the total number of pages was
+ * requested, an exception is thrown.
+ *
* @param page the page number. The first page is 1
* @return the reference to the page
*/
public PdfIndirectReference getPageReference(int page) {
--page;
- if (page < 0)
- throw new IndexOutOfBoundsException(MessageLocalization.getComposedMessage("the.page.number.must.be.gt.eq.1"));
+ if (page < 0) {
+ throw new IndexOutOfBoundsException(
+ MessageLocalization.getComposedMessage("the.page.number.must.be.gt.eq.1"));
+ }
PdfIndirectReference ref;
if (page < pageReferences.size()) {
ref = pageReferences.get(page);
@@ -980,11 +1010,11 @@ public PdfIndirectReference getPageReference(int page) {
ref = body.getPdfIndirectReference();
pageReferences.set(page, ref);
}
- }
- else {
+ } else {
int empty = page - pageReferences.size();
- for (int k = 0; k < empty; ++k)
+ for (int k = 0; k < empty; ++k) {
pageReferences.add(null);
+ }
ref = body.getPdfIndirectReference();
pageReferences.add(ref);
}
@@ -992,9 +1022,9 @@ public PdfIndirectReference getPageReference(int page) {
}
/**
- * Gets the pagenumber of this document.
- * This number can be different from the real pagenumber,
- * if you have (re)set the page number previously.
+ * Gets the pagenumber of this document. This number can be different from the real pagenumber, if you have (re)set
+ * the page number previously.
+ *
* @return a page number
*/
@@ -1012,10 +1042,10 @@ public int getCurrentPageNumber() {
/**
* Sets the value for the Tabs entry in the page tree.
- * @param tabs Can be PdfName.R, PdfName.C or PdfName.S.
- * Since the Adobe Extensions Level 3, it can also be PdfName.A
- * or PdfName.W
- * @since 2.1.5
+ *
+ * @param tabs Can be PdfName.R, PdfName.C or PdfName.S. Since the Adobe Extensions Level 3, it can also be
+ * PdfName.A or PdfName.W
+ * @since 2.1.5
*/
public void setTabs(PdfName tabs) {
this.tabs = tabs;
@@ -1023,8 +1053,9 @@ public void setTabs(PdfName tabs) {
/**
* Returns the value to be used for the Tabs entry in the page tree.
- * @since 2.1.5
+ *
* @return a PdfName of the value of the Tabs entry in the page dictionnary
+ * @since 2.1.5
*/
public PdfName getTabs() {
return tabs;
@@ -1032,13 +1063,12 @@ public PdfName getTabs() {
/**
* Adds some PdfContents to this Writer.
- * PdfIndirectReference
- * @param page the PdfPage to add
+ * @param page the PdfPage to add
* @param contents the PdfContents of the page
+ * @return a PdfIndirectReference
* @throws PdfException on error
*/
@@ -1049,8 +1079,7 @@ PdfIndirectReference add(PdfPage page, PdfContents contents) throws PdfException
PdfIndirectObject object;
try {
object = addToBody(contents);
- }
- catch(IOException ioe) {
+ } catch (IOException ioe) {
throw new ExceptionConverter(ioe);
}
page.add(object.getIndirectReference());
@@ -1058,8 +1087,7 @@ PdfIndirectReference add(PdfPage page, PdfContents contents) throws PdfException
if (group != null) {
page.put(PdfName.GROUP, group);
group = null;
- }
- else if (rgbTransparencyBlending) {
+ } else if (rgbTransparencyBlending) {
PdfDictionary pp = new PdfDictionary();
pp.put(PdfName.TYPE, PdfName.GROUP);
pp.put(PdfName.S, PdfName.TRANSPARENCY);
@@ -1073,26 +1101,32 @@ else if (rgbTransparencyBlending) {
// page events
-/*
- * Page events are specific for iText, not for PDF.
- * Upon specific events (for instance when a page starts
- * or ends), the corresponding method in the page event
- * implementation that is added to the writer is invoked.
- */
+ /*
+ * Page events are specific for iText, not for PDF.
+ * Upon specific events (for instance when a page starts
+ * or ends), the corresponding method in the page event
+ * implementation that is added to the writer is invoked.
+ */
- /** The PdfPageEvent for this document. */
+ /**
+ * The PdfPageEvent for this document.
+ */
private PdfPageEvent pageEvent;
/**
* Sets the PdfPageEvent for this document.
+ *
* @param event the PdfPageEvent for this document
*/
public void setPageEvent(PdfPageEvent event) {
- if (event == null) this.pageEvent = null;
- else if (this.pageEvent == null) this.pageEvent = event;
- else if (this.pageEvent instanceof PdfPageEventForwarder) ((PdfPageEventForwarder)this.pageEvent).addPageEvent(event);
- else {
+ if (event == null) {
+ this.pageEvent = null;
+ } else if (this.pageEvent == null) {
+ this.pageEvent = event;
+ } else if (this.pageEvent instanceof PdfPageEventForwarder) {
+ ((PdfPageEventForwarder) this.pageEvent).addPageEvent(event);
+ } else {
PdfPageEventForwarder forward = new PdfPageEventForwarder();
forward.addPageEvent(this.pageEvent);
forward.addPageEvent(event);
@@ -1101,10 +1135,9 @@ public void setPageEvent(PdfPageEvent event) {
}
/**
- * Gets the PdfPageEvent for this document or null
- * if none is set.
- * @return the PdfPageEvent for this document or null
- * if none is set
+ * Gets the PdfPageEvent for this document or null if none is set.
+ *
+ * @return the PdfPageEvent for this document or null if none is set
*/
public PdfPageEvent getPageEvent() {
@@ -1113,17 +1146,20 @@ public PdfPageEvent getPageEvent() {
// Open and Close methods + method that create the PDF
- /** A number referring to the previous Cross-Reference Table. */
+ /**
+ * A number referring to the previous Cross-Reference Table.
+ */
protected int prevxref = 0;
/**
* Signals that the Document has been opened and that
* Elements can be added.
- * Document was closed and that no other
* Elements will be added.
- * null to remove any
*/
public void setOutlines(List outlines) {
@@ -1318,71 +1357,104 @@ public void setOutlines(List outlines) {
}
protected void writeOutlines(PdfDictionary catalog, boolean namedAsNames) throws IOException {
- if (newBookmarks == null || newBookmarks.isEmpty())
+ if (newBookmarks == null || newBookmarks.isEmpty()) {
return;
+ }
PdfDictionary top = new PdfDictionary();
PdfIndirectReference topRef = getPdfIndirectReference();
Object[] kids = SimpleBookmark.iterateOutlines(this, topRef, newBookmarks, namedAsNames);
- top.put(PdfName.FIRST, (PdfIndirectReference)kids[0]);
- top.put(PdfName.LAST, (PdfIndirectReference)kids[1]);
+ top.put(PdfName.FIRST, (PdfIndirectReference) kids[0]);
+ top.put(PdfName.LAST, (PdfIndirectReference) kids[1]);
top.put(PdfName.COUNT, new PdfNumber((Integer) kids[2]));
addToBody(top, topRef);
catalog.put(PdfName.OUTLINES, topRef);
}
// [C2] PdfVersion interface
- /** possible PDF version (header) */
- public static final char VERSION_1_2 = '2';
- /** possible PDF version (header) */
- public static final char VERSION_1_3 = '3';
- /** possible PDF version (header) */
- public static final char VERSION_1_4 = '4';
- /** possible PDF version (header) */
- public static final char VERSION_1_5 = '5';
- /** possible PDF version (header) */
- public static final char VERSION_1_6 = '6';
- /** possible PDF version (header) */
- public static final char VERSION_1_7 = '7';
-
- /** possible PDF version (catalog) */
- public static final PdfName PDF_VERSION_1_2 = new PdfName("1.2");
- /** possible PDF version (catalog) */
- public static final PdfName PDF_VERSION_1_3 = new PdfName("1.3");
- /** possible PDF version (catalog) */
- public static final PdfName PDF_VERSION_1_4 = new PdfName("1.4");
- /** possible PDF version (catalog) */
- public static final PdfName PDF_VERSION_1_5 = new PdfName("1.5");
- /** possible PDF version (catalog) */
- public static final PdfName PDF_VERSION_1_6 = new PdfName("1.6");
- /** possible PDF version (catalog) */
- public static final PdfName PDF_VERSION_1_7 = new PdfName("1.7");
-
- /** Stores the version information for the header and the catalog. */
+ /**
+ * possible PDF version (header)
+ */
+ public static final char VERSION_1_2 = '2';
+ /**
+ * possible PDF version (header)
+ */
+ public static final char VERSION_1_3 = '3';
+ /**
+ * possible PDF version (header)
+ */
+ public static final char VERSION_1_4 = '4';
+ /**
+ * possible PDF version (header)
+ */
+ public static final char VERSION_1_5 = '5';
+ /**
+ * possible PDF version (header)
+ */
+ public static final char VERSION_1_6 = '6';
+ /**
+ * possible PDF version (header)
+ */
+ public static final char VERSION_1_7 = '7';
+
+ /**
+ * possible PDF version (catalog)
+ */
+ public static final PdfName PDF_VERSION_1_2 = new PdfName("1.2");
+ /**
+ * possible PDF version (catalog)
+ */
+ public static final PdfName PDF_VERSION_1_3 = new PdfName("1.3");
+ /**
+ * possible PDF version (catalog)
+ */
+ public static final PdfName PDF_VERSION_1_4 = new PdfName("1.4");
+ /**
+ * possible PDF version (catalog)
+ */
+ public static final PdfName PDF_VERSION_1_5 = new PdfName("1.5");
+ /**
+ * possible PDF version (catalog)
+ */
+ public static final PdfName PDF_VERSION_1_6 = new PdfName("1.6");
+ /**
+ * possible PDF version (catalog)
+ */
+ public static final PdfName PDF_VERSION_1_7 = new PdfName("1.7");
+
+ /**
+ * Stores the version information for the header and the catalog.
+ */
protected PdfVersionImp pdf_version = new PdfVersionImp();
- /** @see com.lowagie.text.pdf.interfaces.PdfVersion#setPdfVersion(char) */
+ /**
+ * @see com.lowagie.text.pdf.interfaces.PdfVersion#setPdfVersion(char)
+ */
public void setPdfVersion(char version) {
pdf_version.setPdfVersion(version);
}
- /** @see com.lowagie.text.pdf.interfaces.PdfVersion#setAtLeastPdfVersion(char) */
+ /**
+ * @see com.lowagie.text.pdf.interfaces.PdfVersion#setAtLeastPdfVersion(char)
+ */
public void setAtLeastPdfVersion(char version) {
pdf_version.setAtLeastPdfVersion(version);
}
- /** @see com.lowagie.text.pdf.interfaces.PdfVersion#setPdfVersion(com.lowagie.text.pdf.PdfName) */
+ /**
+ * @see com.lowagie.text.pdf.interfaces.PdfVersion#setPdfVersion(com.lowagie.text.pdf.PdfName)
+ */
public void setPdfVersion(PdfName version) {
pdf_version.setPdfVersion(version);
}
/**
* @see com.lowagie.text.pdf.interfaces.PdfVersion#addDeveloperExtension(com.lowagie.text.pdf.PdfDeveloperExtension)
- * @since 2.1.6
+ * @since 2.1.6
*/
public void addDeveloperExtension(PdfDeveloperExtension de) {
pdf_version.addDeveloperExtension(de);
}
-
+
/**
* Returns the version information.
*/
@@ -1394,72 +1466,127 @@ PdfVersionImp getPdfVersion() {
// page layout (section 13.1.1 of "iText in Action")
- /** A viewer preference */
+ /**
+ * A viewer preference
+ */
public static final int PageLayoutSinglePage = 1;
- /** A viewer preference */
+ /**
+ * A viewer preference
+ */
public static final int PageLayoutOneColumn = 2;
- /** A viewer preference */
+ /**
+ * A viewer preference
+ */
public static final int PageLayoutTwoColumnLeft = 4;
- /** A viewer preference */
+ /**
+ * A viewer preference
+ */
public static final int PageLayoutTwoColumnRight = 8;
- /** A viewer preference */
+ /**
+ * A viewer preference
+ */
public static final int PageLayoutTwoPageLeft = 16;
- /** A viewer preference */
+ /**
+ * A viewer preference
+ */
public static final int PageLayoutTwoPageRight = 32;
// page mode (section 13.1.2 of "iText in Action")
- /** A viewer preference */
+ /**
+ * A viewer preference
+ */
public static final int PageModeUseNone = 64;
- /** A viewer preference */
+ /**
+ * A viewer preference
+ */
public static final int PageModeUseOutlines = 128;
- /** A viewer preference */
+ /**
+ * A viewer preference
+ */
public static final int PageModeUseThumbs = 256;
- /** A viewer preference */
+ /**
+ * A viewer preference
+ */
public static final int PageModeFullScreen = 512;
- /** A viewer preference */
+ /**
+ * A viewer preference
+ */
public static final int PageModeUseOC = 1024;
- /** A viewer preference */
+ /**
+ * A viewer preference
+ */
public static final int PageModeUseAttachments = 2048;
// values for setting viewer preferences in iText versions older than 2.x
- /** A viewer preference */
+ /**
+ * A viewer preference
+ */
public static final int HideToolbar = 1 << 12;
- /** A viewer preference */
+ /**
+ * A viewer preference
+ */
public static final int HideMenubar = 1 << 13;
- /** A viewer preference */
+ /**
+ * A viewer preference
+ */
public static final int HideWindowUI = 1 << 14;
- /** A viewer preference */
+ /**
+ * A viewer preference
+ */
public static final int FitWindow = 1 << 15;
- /** A viewer preference */
+ /**
+ * A viewer preference
+ */
public static final int CenterWindow = 1 << 16;
- /** A viewer preference */
+ /**
+ * A viewer preference
+ */
public static final int DisplayDocTitle = 1 << 17;
- /** A viewer preference */
+ /**
+ * A viewer preference
+ */
public static final int NonFullScreenPageModeUseNone = 1 << 18;
- /** A viewer preference */
+ /**
+ * A viewer preference
+ */
public static final int NonFullScreenPageModeUseOutlines = 1 << 19;
- /** A viewer preference */
+ /**
+ * A viewer preference
+ */
public static final int NonFullScreenPageModeUseThumbs = 1 << 20;
- /** A viewer preference */
+ /**
+ * A viewer preference
+ */
public static final int NonFullScreenPageModeUseOC = 1 << 21;
- /** A viewer preference */
+ /**
+ * A viewer preference
+ */
public static final int DirectionL2R = 1 << 22;
- /** A viewer preference */
+ /**
+ * A viewer preference
+ */
public static final int DirectionR2L = 1 << 23;
- /** A viewer preference */
+ /**
+ * A viewer preference
+ */
public static final int PrintScalingNone = 1 << 24;
- /** @see com.lowagie.text.pdf.interfaces.PdfViewerPreferences#setViewerPreferences(int) */
+ /**
+ * @see com.lowagie.text.pdf.interfaces.PdfViewerPreferences#setViewerPreferences(int)
+ */
public void setViewerPreferences(int preferences) {
pdf.setViewerPreferences(preferences);
}
- /** @see com.lowagie.text.pdf.interfaces.PdfViewerPreferences#addViewerPreference(com.lowagie.text.pdf.PdfName, com.lowagie.text.pdf.PdfObject) */
+ /**
+ * @see com.lowagie.text.pdf.interfaces.PdfViewerPreferences#addViewerPreference(com.lowagie.text.pdf.PdfName,
+ * com.lowagie.text.pdf.PdfObject)
+ */
public void addViewerPreference(PdfName key, PdfObject value) {
pdf.addViewerPreference(key, value);
}
@@ -1468,6 +1595,7 @@ public void addViewerPreference(PdfName key, PdfObject value) {
/**
* Use this method to add page labels
+ *
* @param pageLabels the page labels
*/
public void setPageLabels(PdfPageLabels pageLabels) {
@@ -1477,15 +1605,14 @@ public void setPageLabels(PdfPageLabels pageLabels) {
// [C5] named objects: named destinations, javascript, embedded files
/**
- * Adds named destinations in bulk.
- * Valid keys and values of the map can be found in the map
- * that is created by SimpleNamedDestination.
- * @param map a map with strings as keys for the names,
- * and structured strings as values for the destinations
- * @param page_offset number of pages that has to be added to
- * the page numbers in the destinations (useful if you
- * use this method in combination with PdfCopy).
- * @since iText 5.0
+ * Adds named destinations in bulk. Valid keys and values of the map can be found in the map that is created by
+ * SimpleNamedDestination.
+ *
+ * @param map a map with strings as keys for the names, and structured strings as values for the
+ * destinations
+ * @param page_offset number of pages that has to be added to the page numbers in the destinations (useful if you
+ * use this method in combination with PdfCopy).
+ * @since iText 5.0
*/
public void addNamedDestinations(Mapnull
- * the file will be read from the disk
- * @param file the path to the file. It will only be used if
- * fileStore is not null
- * @param fileDisplay the actual file name stored in the pdf
- * @throws IOException on error
- */
- public void addFileAttachment(String description, byte[] fileStore, String file, String fileDisplay) throws IOException {
- addFileAttachment(description, PdfFileSpecification.fileEmbedded(this, file, fileDisplay, fileStore));
- }
-
- /**
- * Use this method to add a file attachment at the document level.
- * @param description the file description
- * @param fs the file specification
- * @throws IOException thrown when an I/O operation fails
- */
- public void addFileAttachment(String description, PdfFileSpecification fs) throws IOException {
- pdf.addFileAttachment(description, fs);
- }
-
- /**
- * Use this method to add a file attachment at the document level.
- * @param fs the file specification
- * @throws IOException thrown when an I/O operation fails
- */
- public void addFileAttachment(PdfFileSpecification fs) throws IOException {
- addFileAttachment(null, fs);
- }
+
+ /**
+ * Use this method to add a JavaScript action at the document level. When the document opens, all this JavaScript
+ * runs.
+ *
+ * @param js The JavaScript action
+ */
+ public void addJavaScript(PdfAction js) {
+ pdf.addJavaScript(js);
+ }
+
+ /**
+ * Use this method to add a JavaScript action at the document level. When the document opens, all this JavaScript
+ * runs.
+ *
+ * @param code the JavaScript code
+ * @param unicode select JavaScript unicode. Note that the internal Acrobat JavaScript engine does not support
+ * unicode, so this may or may not work for you
+ */
+ public void addJavaScript(String code, boolean unicode) {
+ addJavaScript(PdfAction.javaScript(code, this, unicode));
+ }
+
+ /**
+ * Use this method to adds a JavaScript action at the document level. When the document opens, all this JavaScript
+ * runs.
+ *
+ * @param code the JavaScript code
+ */
+ public void addJavaScript(String code) {
+ addJavaScript(code, false);
+ }
+
+ /**
+ * Use this method to add a JavaScript action at the document level. When the document opens, all this JavaScript
+ * runs.
+ *
+ * @param name The name of the JS Action in the name tree
+ * @param js The JavaScript action
+ */
+ public void addJavaScript(String name, PdfAction js) {
+ pdf.addJavaScript(name, js);
+ }
+
+ /**
+ * Use this method to add a JavaScript action at the document level. When the document opens, all this JavaScript
+ * runs.
+ *
+ * @param name The name of the JS Action in the name tree
+ * @param code the JavaScript code
+ * @param unicode select JavaScript unicode. Note that the internal Acrobat JavaScript engine does not support
+ * unicode, so this may or may not work for you
+ */
+ public void addJavaScript(String name, String code, boolean unicode) {
+ addJavaScript(name, PdfAction.javaScript(code, this, unicode));
+ }
+
+ /**
+ * Use this method to adds a JavaScript action at the document level. When the document opens, all this JavaScript
+ * runs.
+ *
+ * @param name The name of the JS Action in the name tree
+ * @param code the JavaScript code
+ */
+ public void addJavaScript(String name, String code) {
+ addJavaScript(name, code, false);
+ }
+
+ /**
+ * Use this method to add a file attachment at the document level.
+ *
+ * @param description the file description
+ * @param fileStore an array with the file. If it's null the file will be read from the disk
+ * @param file the path to the file. It will only be used if
+ * fileStore is not null
+ * @param fileDisplay the actual file name stored in the pdf
+ * @throws IOException on error
+ */
+ public void addFileAttachment(String description, byte[] fileStore, String file, String fileDisplay)
+ throws IOException {
+ addFileAttachment(description, PdfFileSpecification.fileEmbedded(this, file, fileDisplay, fileStore));
+ }
+
+ /**
+ * Use this method to add a file attachment at the document level.
+ *
+ * @param description the file description
+ * @param fs the file specification
+ * @throws IOException thrown when an I/O operation fails
+ */
+ public void addFileAttachment(String description, PdfFileSpecification fs) throws IOException {
+ pdf.addFileAttachment(description, fs);
+ }
+
+ /**
+ * Use this method to add a file attachment at the document level.
+ *
+ * @param fs the file specification
+ * @throws IOException thrown when an I/O operation fails
+ */
+ public void addFileAttachment(PdfFileSpecification fs) throws IOException {
+ addFileAttachment(null, fs);
+ }
// [C6] Actions (open and additional)
- /** action value */
- public static final PdfName DOCUMENT_CLOSE = PdfName.WC;
- /** action value */
- public static final PdfName WILL_SAVE = PdfName.WS;
- /** action value */
- public static final PdfName DID_SAVE = PdfName.DS;
- /** action value */
- public static final PdfName WILL_PRINT = PdfName.WP;
- /** action value */
- public static final PdfName DID_PRINT = PdfName.DP;
-
- /** @see com.lowagie.text.pdf.interfaces.PdfDocumentActions#setOpenAction(java.lang.String) */
+ /**
+ * action value
+ */
+ public static final PdfName DOCUMENT_CLOSE = PdfName.WC;
+ /**
+ * action value
+ */
+ public static final PdfName WILL_SAVE = PdfName.WS;
+ /**
+ * action value
+ */
+ public static final PdfName DID_SAVE = PdfName.DS;
+ /**
+ * action value
+ */
+ public static final PdfName WILL_PRINT = PdfName.WP;
+ /**
+ * action value
+ */
+ public static final PdfName DID_PRINT = PdfName.DP;
+
+ /**
+ * @see com.lowagie.text.pdf.interfaces.PdfDocumentActions#setOpenAction(java.lang.String)
+ */
public void setOpenAction(String name) {
- pdf.setOpenAction(name);
- }
+ pdf.setOpenAction(name);
+ }
- /** @see com.lowagie.text.pdf.interfaces.PdfDocumentActions#setOpenAction(com.lowagie.text.pdf.PdfAction) */
+ /**
+ * @see com.lowagie.text.pdf.interfaces.PdfDocumentActions#setOpenAction(com.lowagie.text.pdf.PdfAction)
+ */
public void setOpenAction(PdfAction action) {
- pdf.setOpenAction(action);
- }
+ pdf.setOpenAction(action);
+ }
- /** @see com.lowagie.text.pdf.interfaces.PdfDocumentActions#setAdditionalAction(com.lowagie.text.pdf.PdfName, com.lowagie.text.pdf.PdfAction) */
+ /**
+ * @see com.lowagie.text.pdf.interfaces.PdfDocumentActions#setAdditionalAction(com.lowagie.text.pdf.PdfName,
+ * com.lowagie.text.pdf.PdfAction)
+ */
public void setAdditionalAction(PdfName actionType, PdfAction action) throws DocumentException {
- if (!(actionType.equals(DOCUMENT_CLOSE) ||
- actionType.equals(WILL_SAVE) ||
- actionType.equals(DID_SAVE) ||
- actionType.equals(WILL_PRINT) ||
- actionType.equals(DID_PRINT))) {
- throw new DocumentException(MessageLocalization.getComposedMessage("invalid.additional.action.type.1", actionType.toString()));
- }
- pdf.addAdditionalAction(actionType, action);
- }
+ if (!(actionType.equals(DOCUMENT_CLOSE) ||
+ actionType.equals(WILL_SAVE) ||
+ actionType.equals(DID_SAVE) ||
+ actionType.equals(WILL_PRINT) ||
+ actionType.equals(DID_PRINT))) {
+ throw new DocumentException(
+ MessageLocalization.getComposedMessage("invalid.additional.action.type.1", actionType.toString()));
+ }
+ pdf.addAdditionalAction(actionType, action);
+ }
// [C7] portable collections
/**
* Use this method to add the Collection dictionary.
+ *
* @param collection a dictionary of type PdfCollection
*/
public void setCollection(PdfCollection collection) {
@@ -1656,17 +1811,25 @@ public void setCollection(PdfCollection collection) {
// [C8] AcroForm
- /** signature value */
+ /**
+ * signature value
+ */
public static final int SIGNATURE_EXISTS = 1;
- /** signature value */
+ /**
+ * signature value
+ */
public static final int SIGNATURE_APPEND_ONLY = 2;
- /** @see com.lowagie.text.pdf.interfaces.PdfAnnotations#getAcroForm() */
+ /**
+ * @see com.lowagie.text.pdf.interfaces.PdfAnnotations#getAcroForm()
+ */
public PdfAcroForm getAcroForm() {
return pdf.getAcroForm();
}
- /** @see com.lowagie.text.pdf.interfaces.PdfAnnotations#addAnnotation(com.lowagie.text.pdf.PdfAnnotation) */
+ /**
+ * @see com.lowagie.text.pdf.interfaces.PdfAnnotations#addAnnotation(com.lowagie.text.pdf.PdfAnnotation)
+ */
public void addAnnotation(PdfAnnotation annot) {
pdf.addAnnotation(annot);
}
@@ -1675,23 +1838,30 @@ void addAnnotation(PdfAnnotation annot, int page) {
addAnnotation(annot);
}
- /** @see com.lowagie.text.pdf.interfaces.PdfAnnotations#addCalculationOrder(com.lowagie.text.pdf.PdfFormField) */
+ /**
+ * @see com.lowagie.text.pdf.interfaces.PdfAnnotations#addCalculationOrder(com.lowagie.text.pdf.PdfFormField)
+ */
public void addCalculationOrder(PdfFormField annot) {
pdf.addCalculationOrder(annot);
}
- /** @see com.lowagie.text.pdf.interfaces.PdfAnnotations#setSigFlags(int) */
+ /**
+ * @see com.lowagie.text.pdf.interfaces.PdfAnnotations#setSigFlags(int)
+ */
public void setSigFlags(int f) {
pdf.setSigFlags(f);
}
// [C9] Metadata
- /** XMP Metadata for the document. */
+ /**
+ * XMP Metadata for the document.
+ */
protected byte[] xmpMetadata = null;
/**
* Use this method to set the XMP Metadata.
+ *
* @param xmpMetadata The xmpMetadata to set.
*/
public void setXmpMetadata(byte[] xmpMetadata) {
@@ -1700,6 +1870,7 @@ public void setXmpMetadata(byte[] xmpMetadata) {
/**
* Use this method to set the XMP Metadata for each page.
+ *
* @param xmpMetadata The xmpMetadata to set.
*/
public void setPageXmpMetadata(byte[] xmpMetadata) {
@@ -1707,8 +1878,7 @@ public void setPageXmpMetadata(byte[] xmpMetadata) {
}
/**
- * Use this method to creates XMP Metadata based
- * on the metadata in the PdfDocument.
+ * Use this method to creates XMP Metadata based on the metadata in the PdfDocument.
*/
public void createXmpMetadata() {
setXmpMetadata(createXmpMetadataBytes());
@@ -1722,77 +1892,107 @@ private byte[] createXmpMetadataBytes() {
try {
XmpWriter xmp = new XmpWriter(baos, pdf.getInfo(), pdfxConformance.getPDFXConformance());
xmp.close();
- }
- catch (IOException ioe) {
+ } catch (IOException ioe) {
ioe.printStackTrace();
}
return baos.toByteArray();
}
// [C10] PDFX Conformance
- /** A PDF/X level. */
+ /**
+ * A PDF/X level.
+ */
public static final int PDFXNONE = 0;
- /** A PDF/X level. */
+ /**
+ * A PDF/X level.
+ */
public static final int PDFX1A2001 = 1;
- /** A PDF/X level. */
+ /**
+ * A PDF/X level.
+ */
public static final int PDFX32002 = 2;
- /** PDFA-1A level. */
+ /**
+ * PDFA-1A level.
+ */
public static final int PDFA1A = 3;
- /** PDFA-1B level. */
+ /**
+ * PDFA-1B level.
+ */
public static final int PDFA1B = 4;
- /** Stores the PDF/X level. */
- private PdfXConformanceImp pdfxConformance = new PdfXConformanceImp();
+ /**
+ * Stores the PDF/X level.
+ */
+ private final PdfXConformanceImp pdfxConformance = new PdfXConformanceImp();
- /** @see com.lowagie.text.pdf.interfaces.PdfXConformance#setPDFXConformance(int) */
+ /**
+ * @see com.lowagie.text.pdf.interfaces.PdfXConformance#setPDFXConformance(int)
+ */
public void setPDFXConformance(int pdfx) {
- if (pdfxConformance.getPDFXConformance() == pdfx)
+ if (pdfxConformance.getPDFXConformance() == pdfx) {
return;
- if (pdf.isOpen())
- throw new PdfXConformanceException(MessageLocalization.getComposedMessage("pdfx.conformance.can.only.be.set.before.opening.the.document"));
- if (crypto != null)
- throw new PdfXConformanceException(MessageLocalization.getComposedMessage("a.pdfx.conforming.document.cannot.be.encrypted"));
- if (pdfx == PDFA1A || pdfx == PDFA1B)
+ }
+ if (pdf.isOpen()) {
+ throw new PdfXConformanceException(
+ MessageLocalization.getComposedMessage(
+ "pdfx.conformance.can.only.be.set.before.opening.the.document"));
+ }
+ if (crypto != null) {
+ throw new PdfXConformanceException(
+ MessageLocalization.getComposedMessage("a.pdfx.conforming.document.cannot.be.encrypted"));
+ }
+ if (pdfx == PDFA1A || pdfx == PDFA1B) {
setPdfVersion(VERSION_1_4);
- else if (pdfx != PDFXNONE)
+ } else if (pdfx != PDFXNONE) {
setPdfVersion(VERSION_1_3);
+ }
pdfxConformance.setPDFXConformance(pdfx);
}
- /** @see com.lowagie.text.pdf.interfaces.PdfXConformance#getPDFXConformance() */
+ /**
+ * @see com.lowagie.text.pdf.interfaces.PdfXConformance#getPDFXConformance()
+ */
public int getPDFXConformance() {
return pdfxConformance.getPDFXConformance();
}
- /** @see com.lowagie.text.pdf.interfaces.PdfXConformance#isPdfX() */
+ /**
+ * @see com.lowagie.text.pdf.interfaces.PdfXConformance#isPdfX()
+ */
public boolean isPdfX() {
return pdfxConformance.isPdfX();
}
// [C11] Output intents
+
/**
- * Sets the values of the output intent dictionary. Null values are allowed to
- * suppress any key.
+ * Sets the values of the output intent dictionary. Null values are allowed to suppress any key.
*
* @param outputConditionIdentifier a value
* @param outputCondition a value, "PDFA/A" to force GTS_PDFA1, otherwise cued by pdfxConformance.
* @param registryName a value
* @param info a value
* @param colorProfile a value
- * @since 2.1.5
* @throws IOException on error
+ * @since 2.1.5
*/
- public void setOutputIntents(String outputConditionIdentifier, String outputCondition, String registryName, String info, ICC_Profile colorProfile) throws IOException {
+ public void setOutputIntents(String outputConditionIdentifier, String outputCondition, String registryName,
+ String info, ICC_Profile colorProfile) throws IOException {
getExtraCatalog();
PdfDictionary out = new PdfDictionary(PdfName.OUTPUTINTENT);
- if (outputCondition != null)
+ if (outputCondition != null) {
out.put(PdfName.OUTPUTCONDITION, new PdfString(outputCondition, PdfObject.TEXT_UNICODE));
- if (outputConditionIdentifier != null)
- out.put(PdfName.OUTPUTCONDITIONIDENTIFIER, new PdfString(outputConditionIdentifier, PdfObject.TEXT_UNICODE));
- if (registryName != null)
+ }
+ if (outputConditionIdentifier != null) {
+ out.put(PdfName.OUTPUTCONDITIONIDENTIFIER,
+ new PdfString(outputConditionIdentifier, PdfObject.TEXT_UNICODE));
+ }
+ if (registryName != null) {
out.put(PdfName.REGISTRYNAME, new PdfString(registryName, PdfObject.TEXT_UNICODE));
- if (info != null)
+ }
+ if (info != null) {
out.put(PdfName.INFO, new PdfString(info, PdfObject.TEXT_UNICODE));
+ }
if (colorProfile != null) {
PdfStream stream = new PdfICCBased(colorProfile, compressionLevel);
out.put(PdfName.DESTOUTPUTPROFILE, addToBody(stream).getIndirectReference());
@@ -1801,8 +2001,7 @@ public void setOutputIntents(String outputConditionIdentifier, String outputCond
PdfName intentSubtype;
if (pdfxConformance.isPdfA1() || "PDFA/1".equals(outputCondition)) {
intentSubtype = PdfName.GTS_PDFA1;
- }
- else {
+ } else {
intentSubtype = PdfName.GTS_PDFX;
}
@@ -1811,64 +2010,70 @@ public void setOutputIntents(String outputConditionIdentifier, String outputCond
extraCatalog.put(PdfName.OUTPUTINTENTS, new PdfArray(out));
}
- /**
- * Sets the values of the output intent dictionary. Null values are allowed to
- * suppress any key.
- *
+ /**
+ * Sets the values of the output intent dictionary. Null values are allowed to suppress any key.
+ * ICC_Profile-based version of this method.
+ *
* @param outputConditionIdentifier a value
* @param outputCondition a value, "PDFA/A" to force GTS_PDFA1, otherwise cued by pdfxConformance.
* @param registryName a value
* @param info a value
* @param destOutputProfile a value
- * @since 1.x
- *
* @throws IOException on error
+ * @since 1.x
*/
- public void setOutputIntents(String outputConditionIdentifier, String outputCondition, String registryName, String info, byte[] destOutputProfile) throws IOException {
+ public void setOutputIntents(String outputConditionIdentifier, String outputCondition, String registryName,
+ String info, byte[] destOutputProfile) throws IOException {
ICC_Profile colorProfile = (destOutputProfile == null) ? null : ICC_Profile.getInstance(destOutputProfile);
setOutputIntents(outputConditionIdentifier, outputCondition, registryName, info, colorProfile);
}
/**
- * Use this method to copy the output intent dictionary
- * from another document to this one.
- * @param reader the other document
+ * Use this method to copy the output intent dictionary from another document to this one.
+ *
+ * @param reader the other document
* @param checkExistence true to just check for the existence of a valid output intent
- * dictionary, false to insert the dictionary if it exists
- * @throws IOException on error
+ * dictionary, false to insert the dictionary if it exists
* @return true if the output intent dictionary exists, false
* otherwise
+ * @throws IOException on error
*/
public boolean setOutputIntents(PdfReader reader, boolean checkExistence) throws IOException {
PdfDictionary catalog = reader.getCatalog();
PdfArray outs = catalog.getAsArray(PdfName.OUTPUTINTENTS);
- if (outs == null)
+ if (outs == null) {
return false;
- if (outs.isEmpty())
+ }
+ if (outs.isEmpty()) {
return false;
+ }
PdfDictionary out = outs.getAsDict(0);
PdfObject obj = PdfReader.getPdfObject(out.get(PdfName.S));
- if (!PdfName.GTS_PDFX.equals(obj))
+ if (!PdfName.GTS_PDFX.equals(obj)) {
return false;
- if (checkExistence)
+ }
+ if (checkExistence) {
return true;
- PRStream stream = (PRStream)PdfReader.getPdfObject(out.get(PdfName.DESTOUTPUTPROFILE));
+ }
+ PRStream stream = (PRStream) PdfReader.getPdfObject(out.get(PdfName.DESTOUTPUTPROFILE));
byte[] destProfile = null;
if (stream != null) {
destProfile = PdfReader.getStreamBytes(stream);
}
- setOutputIntents(getNameString(out, PdfName.OUTPUTCONDITIONIDENTIFIER), getNameString(out, PdfName.OUTPUTCONDITION),
+ setOutputIntents(getNameString(out, PdfName.OUTPUTCONDITIONIDENTIFIER),
+ getNameString(out, PdfName.OUTPUTCONDITION),
getNameString(out, PdfName.REGISTRYNAME), getNameString(out, PdfName.INFO), destProfile);
return true;
}
private static String getNameString(PdfDictionary dic, PdfName key) {
PdfObject obj = PdfReader.getPdfObject(dic.get(key));
- if (obj == null || !obj.isString())
+ if (obj == null || !obj.isString()) {
return null;
- return ((PdfString)obj).toUnicodeString();
+ }
+ return ((PdfString) obj).toUnicodeString();
}
// PDF Objects that have an impact on the PDF body
@@ -1877,101 +2082,137 @@ private static String getNameString(PdfDictionary dic, PdfName key) {
// types of encryption
- /** No encryption */
+ /**
+ * No encryption
+ */
public static final int ENCRYPTION_NONE = -1;
- /** Type of encryption */
+ /**
+ * Type of encryption
+ */
public static final int STANDARD_ENCRYPTION_40 = 0;
- /** Type of encryption */
+ /**
+ * Type of encryption
+ */
public static final int STANDARD_ENCRYPTION_128 = 1;
- /** Type of encryption */
+ /**
+ * Type of encryption
+ */
public static final int ENCRYPTION_AES_128 = 2;
// ENCRYPTION_* = 3 reserved for implementation of the
// meanwhile deprecated proprietary AES256 variant by Adobe
- /** Type of encryption */
+ /**
+ * Type of encryption
+ */
public static final int ENCRYPTION_AES_256_V3 = 4;
- /** Mask to separate the encryption type from the encryption mode. */
+ /**
+ * Mask to separate the encryption type from the encryption mode.
+ */
static final int ENCRYPTION_MASK = 7;
- /** Add this to the mode to keep the metadata in clear text */
+ /**
+ * Add this to the mode to keep the metadata in clear text
+ */
public static final int DO_NOT_ENCRYPT_METADATA = 8;
/**
* Add this to the mode to keep encrypt only the embedded files.
+ *
* @since 2.1.3
*/
public static final int EMBEDDED_FILES_ONLY = 24;
// permissions
- /** The operation permitted when the document is opened with the user password
+ /**
+ * The operation permitted when the document is opened with the user password
*
* @since 2.0.7
*/
public static final int ALLOW_PRINTING = 4 + 2048;
- /** The operation permitted when the document is opened with the user password
+ /**
+ * The operation permitted when the document is opened with the user password
*
* @since 2.0.7
*/
public static final int ALLOW_MODIFY_CONTENTS = 8;
- /** The operation permitted when the document is opened with the user password
+ /**
+ * The operation permitted when the document is opened with the user password
*
* @since 2.0.7
*/
public static final int ALLOW_COPY = 16;
- /** The operation permitted when the document is opened with the user password
+ /**
+ * The operation permitted when the document is opened with the user password
*
* @since 2.0.7
*/
public static final int ALLOW_MODIFY_ANNOTATIONS = 32;
- /** The operation permitted when the document is opened with the user password
+ /**
+ * The operation permitted when the document is opened with the user password
*
* @since 2.0.7
*/
public static final int ALLOW_FILL_IN = 256;
- /** The operation permitted when the document is opened with the user password
+ /**
+ * The operation permitted when the document is opened with the user password
*
* @since 2.0.7
*/
public static final int ALLOW_SCREENREADERS = 512;
- /** The operation permitted when the document is opened with the user password
+ /**
+ * The operation permitted when the document is opened with the user password
*
* @since 2.0.7
*/
public static final int ALLOW_ASSEMBLY = 1024;
- /** The operation permitted when the document is opened with the user password
+ /**
+ * The operation permitted when the document is opened with the user password
*
* @since 2.0.7
*/
public static final int ALLOW_DEGRADED_PRINTING = 4;
- /** Contains the business logic for cryptography. */
+ /**
+ * Contains the business logic for cryptography.
+ */
protected PdfEncryption crypto;
+
PdfEncryption getEncryption() {
return crypto;
}
- /** @see com.lowagie.text.pdf.interfaces.PdfEncryptionSettings#setEncryption(byte[], byte[], int, int) */
- public void setEncryption(byte[] userPassword, byte[] ownerPassword, int permissions, int encryptionType) throws DocumentException {
- if (pdf.isOpen())
- throw new DocumentException(MessageLocalization.getComposedMessage("encryption.can.only.be.added.before.opening.the.document"));
+ /**
+ * @see com.lowagie.text.pdf.interfaces.PdfEncryptionSettings#setEncryption(byte[], byte[], int, int)
+ */
+ public void setEncryption(byte[] userPassword, byte[] ownerPassword, int permissions, int encryptionType)
+ throws DocumentException {
+ if (pdf.isOpen()) {
+ throw new DocumentException(
+ MessageLocalization.getComposedMessage("encryption.can.only.be.added.before.opening.the.document"));
+ }
crypto = new PdfEncryption();
crypto.setCryptoMode(encryptionType, 0);
crypto.setupAllKeys(userPassword, ownerPassword, permissions);
}
- /** @see com.lowagie.text.pdf.interfaces.PdfEncryptionSettings#setEncryption(java.security.cert.Certificate[], int[], int) */
+ /**
+ * @see com.lowagie.text.pdf.interfaces.PdfEncryptionSettings#setEncryption(java.security.cert.Certificate[], int[],
+ * int)
+ */
public void setEncryption(Certificate[] certs, int[] permissions, int encryptionType) throws DocumentException {
- if (pdf.isOpen())
- throw new DocumentException(MessageLocalization.getComposedMessage("encryption.can.only.be.added.before.opening.the.document"));
+ if (pdf.isOpen()) {
+ throw new DocumentException(
+ MessageLocalization.getComposedMessage("encryption.can.only.be.added.before.opening.the.document"));
+ }
crypto = new PdfEncryption();
if (certs != null) {
- for (int i=0; i < certs.length; i++) {
+ for (int i = 0; i < certs.length; i++) {
crypto.addRecipient(certs[i], permissions[i]);
}
}
@@ -1979,14 +2220,16 @@ public void setEncryption(Certificate[] certs, int[] permissions, int encryption
crypto.getEncryptionDictionary();
}
-
// [F2] compression
- /** Holds value of property fullCompression. */
+ /**
+ * Holds value of property fullCompression.
+ */
protected boolean fullCompression = false;
/**
* Use this method to find out if 1.5 compression is on.
+ *
* @return the 1.5 compression status
*/
public boolean isFullCompression() {
@@ -1994,9 +2237,8 @@ public boolean isFullCompression() {
}
/**
- * Use this method to set the document's compression to the
- * PDF 1.5 mode with object streams and xref streams.
- * It can be set at any time but once set it can't be unset.
+ * Use this method to set the document's compression to the PDF 1.5 mode with object streams and xref streams. It
+ * can be set at any time but once set it can't be unset.
* BaseFont to the document but not to the page resources.
- * It is used for templates.
+ * Adds a BaseFont to the document but not to the page resources. It is used for templates.
+ *
* @param bf the BaseFont to add
- * @return an Object[] where position 0 is a PdfName
- * and position 1 is an PdfIndirectReference
+ * @return an Object[] where position 0 is a PdfName and position 1 is an
+ * PdfIndirectReference
*/
FontDetails addSimple(BaseFont bf) {
if (bf.getFontType() == BaseFont.FONT_TYPE_DOCUMENT) {
- return new FontDetails(new PdfName("F" + (fontNumber++)), ((DocumentFont)bf).getIndirectReference(), bf);
+ return new FontDetails(new PdfName("F" + (fontNumber++)), ((DocumentFont) bf).getIndirectReference(), bf);
}
FontDetails ret = documentFonts.get(bf);
if (ret == null) {
@@ -2063,23 +2313,28 @@ FontDetails addSimple(BaseFont bf) {
void eliminateFontSubset(PdfDictionary fonts) {
for (FontDetails ft : documentFonts.values()) {
- if (fonts.get(ft.getFontName()) != null)
+ if (fonts.get(ft.getFontName()) != null) {
ft.setSubset(false);
+ }
}
}
// [F4] adding (and releasing) form XObjects
- /** The form XObjects in this document. The key is the xref and the value
- is Object[]{PdfName, template}.*/
+ /**
+ * The form XObjects in this document. The key is the xref and the value is Object[]{PdfName, template}.
+ */
protected LinkedHashMapPdfName for this template
*/
@@ -2087,18 +2342,18 @@ void eliminateFontSubset(PdfDictionary fonts) {
PdfName addDirectTemplateSimple(PdfTemplate template, PdfName forcedName) {
PdfIndirectReference ref = template.getIndirectReference();
Object[] obj = formXObjects.get(ref);
- PdfName name = null;
+ PdfName name;
try {
if (obj == null) {
if (forcedName == null) {
name = new PdfName("Xf" + formXObjectsCounter);
++formXObjectsCounter;
- }
- else
+ } else {
name = forcedName;
+ }
if (template.getType() == PdfTemplate.TYPE_IMPORTED) {
// If we got here from PdfCopy we'll have to fill importedPages
- PdfImportedPage ip = (PdfImportedPage)template;
+ PdfImportedPage ip = (PdfImportedPage) template;
PdfReader r = ip.getPdfReaderInstance().getReader();
if (!importedPages.containsKey(r)) {
importedPages.put(r, ip.getPdfReaderInstance());
@@ -2106,32 +2361,32 @@ PdfName addDirectTemplateSimple(PdfTemplate template, PdfName forcedName) {
template = null;
}
formXObjects.put(ref, new Object[]{name, template});
+ } else {
+ name = (PdfName) obj[0];
}
- else
- name = (PdfName)obj[0];
- }
- catch (Exception e) {
+ } catch (Exception e) {
throw new ExceptionConverter(e);
}
return name;
}
/**
- * Use this method to releases the memory used by a template.
- * This method writes the template to the output.
- * The template can still be added to any content
- * but changes to the template itself won't have any effect.
+ * Use this method to releases the memory used by a template. This method writes the template to the output. The
+ * template can still be added to any content but changes to the template itself won't have any effect.
+ *
* @param tp the template to release
* @throws IOException on error
*/
public void releaseTemplate(PdfTemplate tp) throws IOException {
PdfIndirectReference ref = tp.getIndirectReference();
Object[] objs = formXObjects.get(ref);
- if (objs == null || objs[1] == null)
+ if (objs == null || objs[1] == null) {
return;
- PdfTemplate template = (PdfTemplate)objs[1];
- if (template.getIndirectReference() instanceof PRIndirectReference)
+ }
+ PdfTemplate template = (PdfTemplate) objs[1];
+ if (template.getIndirectReference() instanceof PRIndirectReference) {
return;
+ }
if (template.getType() == PdfTemplate.TYPE_TEMPLATE) {
addToBody(template.getFormXObject(compressionLevel), template.getIndirectReference());
objs[1] = null;
@@ -2143,11 +2398,10 @@ public void releaseTemplate(PdfTemplate tp) throws IOException {
protected HashMapPdfReader to free
* @throws IOException on error
*/
public void freeReader(PdfReader reader) throws IOException {
currentPdfReaderInstance = importedPages.get(reader);
- if (currentPdfReaderInstance == null)
+ if (currentPdfReaderInstance == null) {
return;
+ }
currentPdfReaderInstance.writeAllPages();
currentPdfReaderInstance = null;
importedPages.remove(reader);
}
/**
- * Use this method to gets the current document size.
- * This size only includes the data already written
- * to the output stream, it does not include templates or fonts.
- * It is useful if used with freeReader()
- * when concatenating many documents and an idea of
- * the current size is needed.
+ * Use this method to gets the current document size. This size only includes the data already written to the output
+ * stream, it does not include templates or fonts. It is useful if used with freeReader() when
+ * concatenating many documents and an idea of the current size is needed.
+ *
* @return the approximate size without fonts or templates
*/
public long getCurrentDocumentSize() {
- return body.offset() + (long)body.size() * 20L + 0x48;
+ return body.offset() + (long) body.size() * 20L + 0x48;
}
protected PdfReaderInstance currentPdfReaderInstance;
@@ -2209,10 +2460,14 @@ RandomAccessFileOrArray getReaderFile(PdfReader reader) {
// [F6] spot colors
- /** The colors of this document */
+ /**
+ * The colors of this document
+ */
protected HashMapSpotColor to the document but not to the page resources.
+ *
* @param spc the SpotColor to add
- * @return an Object[] where position 0 is a PdfName
- * and position 1 is an PdfIndirectReference
+ * @return an Object[] where position 0 is a PdfName and position 1 is an
+ * PdfIndirectReference
*/
ColorDetails addSimple(PdfSpotColor spc) {
ColorDetails ret = documentColors.get(spc);
@@ -2236,16 +2492,20 @@ ColorDetails addSimple(PdfSpotColor spc) {
// [F7] document patterns
- /** The patterns of this document */
+ /**
+ * The patterns of this document
+ */
protected HashMaptrue if the document is marked for tagging
*/
public boolean isTagged() {
@@ -2333,34 +2598,45 @@ public boolean isTagged() {
/**
* Gets the structure tree root. If the document is not marked for tagging it will return null.
+ *
* @return the structure tree root
*/
public PdfStructureTreeRoot getStructureTreeRoot() {
- if (tagged && structureTreeRoot == null)
+ if (tagged && structureTreeRoot == null) {
structureTreeRoot = new PdfStructureTreeRoot(this);
+ }
return structureTreeRoot;
}
// [F13] Optional Content Groups
- /** A hashSet containing all the PdfLayer objects. */
+ /**
+ * A hashSet containing all the PdfLayer objects.
+ */
protected Setratio times more than extra character spacing.
+ * The ratio between the extra word spacing and the extra character spacing. Extra word spacing will grow
+ * ratio times more than extra character spacing.
*/
private float spaceCharRatio = SPACE_CHAR_RATIO_DEFAULT;
/**
- * Use this method to gets the space/character extra spacing ratio
- * for fully justified text.
+ * Use this method to gets the space/character extra spacing ratio for fully justified text.
+ *
* @return the space/character extra spacing ratio
*/
public float getSpaceCharRatio() {
@@ -2661,51 +2971,54 @@ public float getSpaceCharRatio() {
}
/**
- * Use this method to set the ratio between the extra word spacing and
- * the extra character spacing when the text is fully justified.
- * Extra word spacing will grow spaceCharRatio times more
- * than extra character spacing. If the ratio is PdfWriter.NO_SPACE_CHAR_RATIO
- * then the extra character spacing will be zero.
+ * Use this method to set the ratio between the extra word spacing and the extra character spacing when the text is
+ * fully justified. Extra word spacing will grow spaceCharRatio times more than extra character
+ * spacing. If the ratio is PdfWriter.NO_SPACE_CHAR_RATIO then the extra character spacing will be
+ * zero.
+ *
* @param spaceCharRatio the ratio between the extra word spacing and the extra character spacing
*/
public void setSpaceCharRatio(float spaceCharRatio) {
- if (spaceCharRatio < 0.001f)
- this.spaceCharRatio = 0.001f;
- else
- this.spaceCharRatio = spaceCharRatio;
+ this.spaceCharRatio = Math.max(spaceCharRatio, 0.001f);
}
// [U7] run direction (doesn't actually do anything)
- /** Use the default run direction. */
+ /**
+ * Use the default run direction.
+ */
public static final int RUN_DIRECTION_DEFAULT = 0;
- /** Do not use bidirectional reordering. */
+ /**
+ * Do not use bidirectional reordering.
+ */
public static final int RUN_DIRECTION_NO_BIDI = 1;
- /** Use bidirectional reordering with left-to-right
- * preferential run direction.
+ /**
+ * Use bidirectional reordering with left-to-right preferential run direction.
*/
public static final int RUN_DIRECTION_LTR = 2;
- /** Use bidirectional reordering with right-to-left
- * preferential run direction.
+ /**
+ * Use bidirectional reordering with right-to-left preferential run direction.
*/
public static final int RUN_DIRECTION_RTL = 3;
protected int runDirection = RUN_DIRECTION_NO_BIDI;
/**
- * Use this method to set the run direction.
- * This is only used as a placeholder as it does not affect anything.
+ * Use this method to set the run direction. This is only used as a placeholder as it does not affect anything.
+ *
* @param runDirection the run direction
*/
public void setRunDirection(int runDirection) {
- if (runDirection < RUN_DIRECTION_NO_BIDI || runDirection > RUN_DIRECTION_RTL)
+ if (runDirection < RUN_DIRECTION_NO_BIDI || runDirection > RUN_DIRECTION_RTL) {
throw new RuntimeException(MessageLocalization.getComposedMessage("invalid.run.direction.1", runDirection));
+ }
this.runDirection = runDirection;
}
/**
* Use this method to set the run direction.
+ *
* @return the run direction
*/
public int getRunDirection() {
@@ -2714,40 +3027,45 @@ public int getRunDirection() {
// [U8] user units
- protected float userunit = 0f;
+ protected float userunit = 0f;
+
/**
- * Use this method to get the user unit.
- * A user unit is a value that defines the default user space unit.
- * The minimum UserUnit is 1 (1 unit = 1/72 inch).
- * The maximum UserUnit is 75,000.
- * Note that this userunit only works starting with PDF1.6!
+ * Use this method to get the user unit. A user unit is a value that defines the default user space unit. The
+ * minimum UserUnit is 1 (1 unit = 1/72 inch). The maximum UserUnit is 75,000. Note that this userunit only works
+ * starting with PDF1.6!
+ *
* @return Returns the userunit.
*/
public float getUserunit() {
return userunit;
}
+
/**
- * Use this method to set the user unit.
- * A UserUnit is a value that defines the default user space unit.
- * The minimum UserUnit is 1 (1 unit = 1/72 inch).
- * The maximum UserUnit is 75,000.
- * Note that this userunit only works starting with PDF1.6!
+ * Use this method to set the user unit. A UserUnit is a value that defines the default user space unit. The minimum
+ * UserUnit is 1 (1 unit = 1/72 inch). The maximum UserUnit is 75,000. Note that this userunit only works starting
+ * with PDF1.6!
+ *
* @param userunit The userunit to set.
* @throws DocumentException on error
*/
- public void setUserunit(float userunit) throws DocumentException {
- if (userunit < 1f || userunit > 75000f) throw new DocumentException(MessageLocalization.getComposedMessage("userunit.should.be.a.value.between.1.and.75000"));
- this.userunit = userunit;
- setAtLeastPdfVersion(VERSION_1_6);
- }
+ public void setUserunit(float userunit) throws DocumentException {
+ if (userunit < 1f || userunit > 75000f) {
+ throw new DocumentException(
+ MessageLocalization.getComposedMessage("userunit.should.be.a.value.between.1.and.75000"));
+ }
+ this.userunit = userunit;
+ setAtLeastPdfVersion(VERSION_1_6);
+ }
// Miscellaneous topics
// [M1] Color settings
protected PdfDictionary defaultColorspace = new PdfDictionary();
+
/**
* Use this method to get the default colorspaces.
+ *
* @return the default colorspaces
*/
public PdfDictionary getDefaultColorspace() {
@@ -2755,19 +3073,19 @@ public PdfDictionary getDefaultColorspace() {
}
/**
- * Use this method to sets the default colorspace that will be applied
- * to all the document. The colorspace is only applied if another colorspace
- * with the same name is not present in the content.
+ * Use this method to sets the default colorspace that will be applied to all the document. The colorspace is only
+ * applied if another colorspace with the same name is not present in the content.
* PdfName.DEFAULTGRAY, PdfName.DEFAULTRGB
- * or PdfName.DEFAULTCMYK
- * @param cs the colorspace. A null or PdfNull removes any colorspace with the same name
+ * The colorspace is applied immediately when creating templates and at the page end for the main document content.
+ *
+ * @param key the name of the colorspace. It can be PdfName.DEFAULTGRAY,
+ * PdfName.DEFAULTRGB or PdfName.DEFAULTCMYK
+ * @param cs the colorspace. A null or PdfNull removes any colorspace with the same name
*/
public void setDefaultColorspace(PdfName key, PdfObject cs) {
- if (cs == null || cs.isNull())
+ if (cs == null || cs.isNull()) {
defaultColorspace.remove(key);
+ }
defaultColorspace.put(key, cs);
}
@@ -2780,13 +3098,16 @@ public void setDefaultColorspace(PdfName key, PdfObject cs) {
ColorDetails addSimplePatternColorspace(Color color) {
int type = ExtendedColor.getType(color);
- if (type == ExtendedColor.TYPE_PATTERN || type == ExtendedColor.TYPE_SHADING)
- throw new RuntimeException(MessageLocalization.getComposedMessage("an.uncolored.tile.pattern.can.not.have.another.pattern.or.shading.as.color"));
+ if (type == ExtendedColor.TYPE_PATTERN || type == ExtendedColor.TYPE_SHADING) {
+ throw new RuntimeException(MessageLocalization.getComposedMessage(
+ "an.uncolored.tile.pattern.can.not.have.another.pattern.or.shading.as.color"));
+ }
try {
switch (type) {
case ExtendedColor.TYPE_RGB:
if (patternColorspaceRGB == null) {
- patternColorspaceRGB = new ColorDetails(getColorspaceName(), body.getPdfIndirectReference(), null);
+ patternColorspaceRGB = new ColorDetails(getColorspaceName(), body.getPdfIndirectReference(),
+ null);
PdfArray array = new PdfArray(PdfName.PATTERN);
array.add(PdfName.DEVICERGB);
addToBody(array, patternColorspaceRGB.getIndirectReference());
@@ -2794,7 +3115,8 @@ ColorDetails addSimplePatternColorspace(Color color) {
return patternColorspaceRGB;
case ExtendedColor.TYPE_CMYK:
if (patternColorspaceCMYK == null) {
- patternColorspaceCMYK = new ColorDetails(getColorspaceName(), body.getPdfIndirectReference(), null);
+ patternColorspaceCMYK = new ColorDetails(getColorspaceName(), body.getPdfIndirectReference(),
+ null);
PdfArray array = new PdfArray(PdfName.PATTERN);
array.add(PdfName.DEVICECMYK);
addToBody(array, patternColorspaceCMYK.getIndirectReference());
@@ -2802,14 +3124,15 @@ ColorDetails addSimplePatternColorspace(Color color) {
return patternColorspaceCMYK;
case ExtendedColor.TYPE_GRAY:
if (patternColorspaceGRAY == null) {
- patternColorspaceGRAY = new ColorDetails(getColorspaceName(), body.getPdfIndirectReference(), null);
+ patternColorspaceGRAY = new ColorDetails(getColorspaceName(), body.getPdfIndirectReference(),
+ null);
PdfArray array = new PdfArray(PdfName.PATTERN);
array.add(PdfName.DEVICEGRAY);
addToBody(array, patternColorspaceGRAY.getIndirectReference());
}
return patternColorspaceGRAY;
case ExtendedColor.TYPE_SEPARATION: {
- ColorDetails details = addSimple(((SpotColor)color).getPdfSpotColor());
+ ColorDetails details = addSimple(((SpotColor) color).getPdfSpotColor());
ColorDetails patternDetails = documentSpotPatterns.get(details);
if (patternDetails == null) {
patternDetails = new ColorDetails(getColorspaceName(), body.getPdfIndirectReference(), null);
@@ -2823,8 +3146,7 @@ ColorDetails addSimplePatternColorspace(Color color) {
default:
throw new RuntimeException(MessageLocalization.getComposedMessage("invalid.color.type"));
}
- }
- catch (Exception e) {
+ } catch (Exception e) {
throw new RuntimeException(e.getMessage());
}
}
@@ -2833,6 +3155,7 @@ ColorDetails addSimplePatternColorspace(Color color) {
/**
* Use this method to get the strictImageSequence status.
+ *
* @return value of property strictImageSequence
*/
public boolean isStrictImageSequence() {
@@ -2840,10 +3163,9 @@ public boolean isStrictImageSequence() {
}
/**
- * Use this method to set the image sequence, so that it follows
- * the text in strict order (or not).
- * @param strictImageSequence new value of property strictImageSequence
+ * Use this method to set the image sequence, so that it follows the text in strict order (or not).
*
+ * @param strictImageSequence new value of property strictImageSequence
*/
public void setStrictImageSequence(boolean strictImageSequence) {
pdf.setStrictImageSequence(strictImageSequence);
@@ -2851,26 +3173,30 @@ public void setStrictImageSequence(boolean strictImageSequence) {
/**
* Use this method to clear text wrapping around images (if applicable).
+ *
* @throws DocumentException on error
*/
public void clearTextWrap() throws DocumentException {
pdf.clearTextWrap();
}
- /** Dictionary, containing all the images of the PDF document */
+ /**
+ * Dictionary, containing all the images of the PDF document
+ */
protected PdfDictionary imageDictionary = new PdfDictionary();
- /** This is the list with all the images in the document. */
- private HashMapDocument.add(Image).
- * Use this method only if you know what you're doing!
+ * Use this method to adds an image to the document but not to the page resources. It is used with templates and
+ * Document.add(Image). Use this method only if you know what you're doing!
+ *
* @param image the Image to add
* @return the name of the image added
- * @throws PdfException on error
+ * @throws PdfException on error
* @throws DocumentException on error
*/
public PdfName addDirectImageSimple(Image image) throws DocumentException {
@@ -2878,14 +3204,14 @@ public PdfName addDirectImageSimple(Image image) throws DocumentException {
}
/**
- * Adds an image to the document but not to the page resources.
- * It is used with templates and Document.add(Image).
- * Use this method only if you know what you're doing!
- * @param image the Image to add
- * @param fixedRef the reference to used. It may be null,
- * a PdfIndirectReference or a PRIndirectReference.
+ * Adds an image to the document but not to the page resources. It is used with templates and
+ * Document.add(Image). Use this method only if you know what you're doing!
+ *
+ * @param image the Image to add
+ * @param fixedRef the reference to used. It may be null, a PdfIndirectReference or a
+ * PRIndirectReference.
* @return the name of the image added
- * @throws PdfException on error
+ * @throws PdfException on error
* @throws DocumentException on error
*/
public PdfName addDirectImageSimple(Image image, PdfIndirectReference fixedRef) throws DocumentException {
@@ -2898,17 +3224,15 @@ public PdfName addDirectImageSimple(Image image, PdfIndirectReference fixedRef)
else {
if (image.isImgTemplate()) {
name = new PdfName("img" + images.size());
- if(image instanceof ImgWMF){
+ if (image instanceof ImgWMF) {
try {
- ImgWMF wmf = (ImgWMF)image;
+ ImgWMF wmf = (ImgWMF) image;
wmf.readWMF(PdfTemplate.createTemplate(this, 0, 0));
- }
- catch (Exception e) {
+ } catch (Exception e) {
throw new DocumentException(e);
}
}
- }
- else {
+ } else {
PdfIndirectReference dref = image.getDirectReference();
if (dref != null) {
PdfName rname = new PdfName("img" + images.size());
@@ -2939,13 +3263,14 @@ public PdfName addDirectImageSimple(Image image, PdfIndirectReference fixedRef)
iccArray.add(iccRef);
PdfArray colorspace = i.getAsArray(PdfName.COLORSPACE);
if (colorspace != null) {
- if (colorspace.size() > 1 && PdfName.INDEXED.equals(colorspace.getPdfObject(0)))
+ if (colorspace.size() > 1 && PdfName.INDEXED.equals(colorspace.getPdfObject(0))) {
colorspace.set(1, iccArray);
- else
+ } else {
i.put(PdfName.COLORSPACE, iccArray);
- }
- else
+ }
+ } else {
i.put(PdfName.COLORSPACE, iccArray);
+ }
}
add(i, fixedRef);
name = i.name();
@@ -2964,19 +3289,19 @@ public PdfName addDirectImageSimple(Image image, PdfIndirectReference fixedRef)
*/
PdfIndirectReference add(PdfImage pdfImage, PdfIndirectReference fixedRef) throws PdfException {
- if (! imageDictionary.contains(pdfImage.name())) {
+ if (!imageDictionary.contains(pdfImage.name())) {
PdfXConformanceImp.checkPDFXConformance(this, PdfXConformanceImp.PDFXKEY_IMAGE, pdfImage);
- if (fixedRef instanceof PRIndirectReference) {
- PRIndirectReference r2 = (PRIndirectReference)fixedRef;
- fixedRef = new PdfIndirectReference(0, getNewObjectNumber(r2.getReader(), r2.getNumber(), r2.getGeneration()));
+ if (fixedRef instanceof PRIndirectReference r2) {
+ fixedRef = new PdfIndirectReference(0,
+ getNewObjectNumber(r2.getReader(), r2.getNumber(), r2.getGeneration()));
}
try {
- if (fixedRef == null)
+ if (fixedRef == null) {
fixedRef = addToBody(pdfImage).getIndirectReference();
- else
+ } else {
addToBody(pdfImage, fixedRef);
- }
- catch(IOException ioe) {
+ }
+ } catch (IOException ioe) {
throw new ExceptionConverter(ioe);
}
imageDictionary.put(pdfImage.name(), fixedRef);
@@ -3000,8 +3325,7 @@ protected PdfIndirectReference add(PdfICCBased icc) {
PdfIndirectObject object;
try {
object = addToBody(icc);
- }
- catch(IOException ioe) {
+ } catch (IOException ioe) {
throw new ExceptionConverter(ioe);
}
return object.getIndirectReference();
@@ -3009,18 +3333,23 @@ protected PdfIndirectReference add(PdfICCBased icc) {
/**
* A HashSet with Stream objects containing JBIG2 Globals
+ *
* @since 2.1.5
*/
protected HashMapTable fits the current page of the PdfDocument.
*
- * @param table the table that has to be checked
- * @param margin a certain margin
- * @return true if the Table fits the page, false otherwise.
+ * @param table the table that has to be checked
+ * @param margin a certain margin
+ * @return true if the Table fits the page, false otherwise.
*/
public boolean fitsPage(Table table, float margin) {
@@ -3056,8 +3385,8 @@ public boolean fitsPage(Table table, float margin) {
/**
* Checks if a Table fits the current page of the PdfDocument.
*
- * @param table the table that has to be checked
- * @return true if the Table fits the page, false otherwise.
+ * @param table the table that has to be checked
+ * @return true if the Table fits the page, false otherwise.
*/
public boolean fitsPage(Table table) {
@@ -3071,6 +3400,7 @@ public boolean fitsPage(Table table) {
/**
* Gets the flag indicating the presence of structure elements that contain user properties attributes.
+ *
* @return the user properties flag
*/
public boolean isUserProperties() {
@@ -3079,6 +3409,7 @@ public boolean isUserProperties() {
/**
* Sets the flag indicating the presence of structure elements that contain user properties attributes.
+ *
* @param userProperties the user properties flag
*/
public void setUserProperties(boolean userProperties) {
@@ -3092,6 +3423,7 @@ public void setUserProperties(boolean userProperties) {
/**
* Gets the transparency blending colorspace.
+ *
* @return true if the transparency blending colorspace is RGB, false
* if it is the default blending colorspace
* @since 2.1.0
@@ -3101,13 +3433,14 @@ public boolean isRgbTransparencyBlending() {
}
/**
- * Sets the transparency blending colorspace to RGB. The default blending colorspace is
- * CMYK and will result in faded colors in the screen and in printing. Calling this method
- * will return the RGB colors to what is expected. The RGB blending will be applied to all subsequent pages
- * until other value is set.
- * Note that this is a generic solution that may not work in all cases.
- * @param rgbTransparencyBlending true to set the transparency blending colorspace to RGB, false
- * to use the default blending colorspace
+ * Sets the transparency blending colorspace to RGB. The default blending colorspace is CMYK and will result in
+ * faded colors in the screen and in printing. Calling this method will return the RGB colors to what is expected.
+ * The RGB blending will be applied to all subsequent pages until other value is set. Note that this is a generic
+ * solution that may not work in all cases.
+ *
+ * @param rgbTransparencyBlending true to set the transparency blending colorspace to RGB,
+ * false
+ * to use the default blending colorspace
* @since 2.1.0
*/
public void setRgbTransparencyBlending(boolean rgbTransparencyBlending) {
diff --git a/openpdf/src/main/resources/com/lowagie/text/error_messages/en.lng b/openpdf/src/main/resources/com/lowagie/text/error_messages/en.lng
index 656740708..1a98455eb 100644
--- a/openpdf/src/main/resources/com/lowagie/text/error_messages/en.lng
+++ b/openpdf/src/main/resources/com/lowagie/text/error_messages/en.lng
@@ -368,7 +368,7 @@ unexpected.end.of.file=Unexpected end of file.
unexpected.eof=Unexpected EOF
unexpected.gt.gt=Unexpected '>>'
unexpected.close.bracket=Unexpected ']'
-unknown.color.format.must.be.rgb.or.rrggbb=Unknown color format. Must be #RGB or #RRGGBB
+unknown.color.format.must.be.rgb.or.rrggbb=Unknown color format. Must be #RGB, #RRGGBB, #RGBA or #RRGGBBAA
unknown.encryption.type.r.eq.1=Unknown encryption type R = {1}
unknown.encryption.type.v.eq.1=Unknown encryption type V = {1}
unknown.filter.1=Unknown filter: {1}
@@ -387,6 +387,7 @@ while.removing.wmf.placeable.header=while removing wmf placeable header
writelength.can.only.be.called.after.output.of.the.stream.body=writeLength() can only be called after output of the stream body.
writelength.can.only.be.called.in.a.contructed.pdfstream.inputstream.pdfwriter=writeLength() can only be called in a contructed PdfStream(InputStream,PdfWriter).
wrong.number.of.columns=Wrong number of columns.
+xref.infinite.loop=An infinite loop was detected in the xref table.
xref.subsection.not.found=xref subsection not found
xstep.or.ystep.can.not.be.zero=XStep or YStep can not be ZERO.
you.can.only.add.a.writer.to.a.pdfdocument.once=You can only add a writer to a PdfDocument once.
@@ -405,4 +406,5 @@ you.have.to.consolidate.the.named.destinations.of.your.reader=You have to consol
you.have.to.define.a.boolean.array.for.this.collection.sort.dictionary=You have to define a boolean array for this collection sort dictionary.
you.have.used.the.wrong.constructor.for.this.fieldpositioningevents.class=You have used the wrong constructor for this FieldPositioningEvents class.
you.must.set.a.value.before.adding.a.prefix=You must set a value before adding a prefix.
-you.need.a.single.boolean.for.this.collection.sort.dictionary=You need a single boolean for this collection sort dictionary.
\ No newline at end of file
+you.need.a.single.boolean.for.this.collection.sort.dictionary=You need a single boolean for this collection sort dictionary.
+you.should.call.document.close.instead=Please call Document.close() instead. The PdfWriter will then be closed automatically.
diff --git a/openpdf/src/main/resources/com/lowagie/text/error_messages/nl.lng b/openpdf/src/main/resources/com/lowagie/text/error_messages/nl.lng
index b4734eb90..fa20942e0 100644
--- a/openpdf/src/main/resources/com/lowagie/text/error_messages/nl.lng
+++ b/openpdf/src/main/resources/com/lowagie/text/error_messages/nl.lng
@@ -66,7 +66,7 @@ blend.mode.1.not.allowed=Blend mode {1} niet toegelaten.
bookmark.end.tag.out.of.place=Bookmark end tag op verkeerde plaats.
both.colors.must.be.of.the.same.type=Beide kleuren moeten van het zelfde type zijn.
buffersize.1=bufferlengte {1}
-can.only.push.back.one.byte=Werkt enkel met één byte ineens.
+can.only.push.back.one.byte=Werkt enkel met ��n byte ineens.
can.t.add.1.to.multicolumntext.with.complex.columns={1} kan niet toegevoegd worden aan een MultiColumnText met complexe kolommen
can.t.decode.pkcs7signeddata.object=Kan het PKCS7SignedData object niet decoderen
can.t.find.page.size.1=Kan de pagina afmetingen niet vinden {1}
@@ -82,7 +82,7 @@ colorspace.rgb.is.not.allowed=Colorspace RGB is niet toegelaten.
column.coordinate.of.location.must.be.gt.eq.0.and.lt.nr.of.columns=Kolom coordinaat moet groter dan of gelijk zijn aan 0 en kleiner dan het aantal kolommen
columntext.go.with.simulate.eq.eq.false.and.text.eq.eq.null=ColumnText.go met simulate==false en text==null.
components.must.be.1.3.or.4=Componenten moeten 1, 3, of 4 zijn.
-compression.jpeg.is.only.supported.with.a.single.strip.this.image.has.1.strips=Compressie JPEG wordt enkel ondersteund voor één enkele strip. Jouw JPEG heeft {1} strips.
+compression.jpeg.is.only.supported.with.a.single.strip.this.image.has.1.strips=Compressie JPEG wordt enkel ondersteund voor ��n enkele strip. Jouw JPEG heeft {1} strips.
content.can.not.be.added.to.a.pdfimportedpage=Er kan geen extra content toegevoegd worden aan een PdfImportedPage.
content.was.already.written.to.the.output=Er werd al inhoud naar de output gestuurd.
corrupted.png.file=Corrupt PNG bestand.
@@ -387,6 +387,7 @@ while.removing.wmf.placeable.header=tijdens het verwijderen van een wmf position
writelength.can.only.be.called.after.output.of.the.stream.body=writeLength() kan alleen opgeroepen worden na output van de stream body.
writelength.can.only.be.called.in.a.contructed.pdfstream.inputstream.pdfwriter=writeLength() kan alleen opgeroepen worden in een aldus aangemaakte stream: PdfStream(InputStream,PdfWriter).
wrong.number.of.columns=Verkeerd aantal kolommen.
+xref.infinite.loop=Er is een eindeloos lus gedetecteerd in de xref-tabel.
xref.subsection.not.found=xref subsectie niet gevonden
xstep.or.ystep.can.not.be.zero=XStep of YStep kan niet nul zijn.
you.can.only.add.a.writer.to.a.pdfdocument.once=Je kan een writer slecht een enkele keer toevoegen aan een PdfDocument.
@@ -397,7 +398,7 @@ you.can.t.add.an.element.of.type.1.to.a.simplecell=Je kan geen element van type
you.can.t.add.cells.to.a.table.directly.add.them.to.a.row.first=Je kan geen cellen toevoegen aan een tabel, zonder ze eerst aan een rij toe te voegen.
you.can.t.add.listitems.rows.or.cells.to.a.cell=Je kan geen lijst items, rijen of cellen toevoegen aan een cell.
you.can.t.add.one.row.to.another.row=Je kan rijen niet aan rijen toevoegen.
-you.can.t.have.1.pages.on.one.page.minimum.2.maximum.8=Je kan geen {1} pagina's op één blad plaatsen (minimum 2; maximum 8).
+you.can.t.have.1.pages.on.one.page.minimum.2.maximum.8=Je kan geen {1} pagina's op ��n blad plaatsen (minimum 2; maximum 8).
you.can.t.set.the.initial.leading.if.the.document.is.already.open=Je kan geen initial leading bepalen als het document al open is.
you.can.t.split.this.document.at.page.1.there.is.no.such.page=Je kan dit document niet splitsen op pagina {1}; Die pagina bestaat niet.
you.can.t.translate.a.negative.number.into.an.alphabetical.value=Je kan een negatieve waarde niet omzetten naar een alfabetische waarde.
diff --git a/openpdf/src/main/resources/com/lowagie/text/error_messages/pt.lng b/openpdf/src/main/resources/com/lowagie/text/error_messages/pt.lng
index 1e6b3cf66..7d6709c4b 100644
--- a/openpdf/src/main/resources/com/lowagie/text/error_messages/pt.lng
+++ b/openpdf/src/main/resources/com/lowagie/text/error_messages/pt.lng
@@ -5,3 +5,4 @@ fdf.header.not.found=InÃcio de FDF não encontrado.
greaterthan.not.expected='>' inesperado
pdf.header.not.found=InÃcio de PDF não encontrado.
pdf.startxref.not.found=startxref de PDF não encontrado.
+xref.infinite.loop=Um loop infinito foi detectado na tabela xref.
diff --git a/openpdf/src/test/java/com/lowagie/text/pdf/PdfWriterTest.java b/openpdf/src/test/java/com/lowagie/text/pdf/PdfWriterTest.java
new file mode 100644
index 000000000..8c4a09b21
--- /dev/null
+++ b/openpdf/src/test/java/com/lowagie/text/pdf/PdfWriterTest.java
@@ -0,0 +1,42 @@
+package com.lowagie.text.pdf;
+
+import static org.assertj.core.api.Assertions.assertThatIllegalStateException;
+import static org.assertj.core.api.Assertions.assertThatNoException;
+
+import com.lowagie.text.Document;
+import com.lowagie.text.PageSize;
+import com.lowagie.text.Phrase;
+import java.io.ByteArrayOutputStream;
+import org.junit.jupiter.api.Test;
+
+class PdfWriterTest {
+
+ // Test case to check that a PdfWriter may not be closed before the including document is closed
+ @Test
+ void testCloseBeforeDocumentClose() {
+ try (Document document = new Document(PageSize.A4)) {
+ // given
+ PdfWriter writer = PdfWriter.getInstance(document, new ByteArrayOutputStream());
+ document.open();
+ document.add(new Phrase("Hello World"));
+ // then
+ assertThatIllegalStateException().isThrownBy(writer::close)
+ .withMessage("Please call Document.close() instead. The PdfWriter will then be closed automatically.");
+ }
+ }
+
+ @Test
+ void testCloseAfterDocumentClose() {
+ try (Document document = new Document(PageSize.A4)) {
+ // given
+ PdfWriter writer = PdfWriter.getInstance(document, new ByteArrayOutputStream());
+ document.open();
+ document.add(new Phrase("Hello World"));
+ document.close();
+ // then
+ assertThatNoException().isThrownBy(writer::close);
+ }
+ }
+
+
+}