public static readonly iText.Kernel.Pdf.PdfName WP = CreateDirectName("WP");
+ public static readonly iText.Kernel.Pdf.PdfName WS = CreateDirectName("WS");
+
public static readonly iText.Kernel.Pdf.PdfName WT = CreateDirectName("WT");
public static readonly iText.Kernel.Pdf.PdfName X = CreateDirectName("X");
diff --git a/itext/itext.kernel/itext/kernel/pdf/PdfNull.cs b/itext/itext.kernel/itext/kernel/pdf/PdfNull.cs
index 859fd89f2e..b4a6d3c9ec 100644
--- a/itext/itext.kernel/itext/kernel/pdf/PdfNull.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/PdfNull.cs
@@ -120,5 +120,13 @@ protected internal override PdfObject NewInstance() {
protected internal override void CopyContent(PdfObject from, PdfDocument document) {
}
+
+ public override bool Equals(Object obj) {
+ return this == obj || obj != null && GetType() == obj.GetType();
+ }
+
+ public override int GetHashCode() {
+ return 0;
+ }
}
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/PdfNumber.cs b/itext/itext.kernel/itext/kernel/pdf/PdfNumber.cs
index 9829ad17bc..b04d6b91fc 100644
--- a/itext/itext.kernel/itext/kernel/pdf/PdfNumber.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/PdfNumber.cs
@@ -42,6 +42,8 @@ source product.
address: sales@itextpdf.com
*/
using System;
+using iText.IO;
+using iText.IO.Log;
using iText.IO.Source;
namespace iText.Kernel.Pdf {
@@ -50,6 +52,8 @@ public class PdfNumber : PdfPrimitiveObject {
private bool isDouble;
+ private bool changed = false;
+
public PdfNumber(double value)
: base() {
SetValue(value);
@@ -101,6 +105,7 @@ public virtual void SetValue(int value) {
this.value = value;
this.isDouble = false;
this.content = null;
+ this.changed = true;
}
public virtual void SetValue(double value) {
@@ -172,6 +177,22 @@ public override String ToString() {
}
}
+ public override bool Equals(Object o) {
+ return this == o || o != null && GetType() == o.GetType() && iText.IO.Util.JavaUtil.DoubleCompare(((iText.Kernel.Pdf.PdfNumber
+ )o).value, value) == 0;
+ }
+
+ public override int GetHashCode() {
+ if (changed) {
+ //if the instance was modified, hashCode also will be changed, it may cause inconsistency.
+ ILogger logger = LoggerFactory.GetLogger(typeof(PdfReader));
+ logger.Warn(LogMessageConstant.CALCULATE_HASHCODE_FOR_MODIFIED_PDFNUMBER);
+ changed = false;
+ }
+ long hash = iText.IO.Util.JavaUtil.DoubleToLongBits(value);
+ return (int)(hash ^ ((long)(((ulong)hash) >> 32)));
+ }
+
protected internal override PdfObject NewInstance() {
return new iText.Kernel.Pdf.PdfNumber();
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/PdfObject.cs b/itext/itext.kernel/itext/kernel/pdf/PdfObject.cs
index 011b32f380..235ac28d12 100644
--- a/itext/itext.kernel/itext/kernel/pdf/PdfObject.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/PdfObject.cs
@@ -117,21 +117,24 @@ public abstract class PdfObject {
public abstract byte GetObjectType();
/// Flushes the object to the document.
- ///
public void Flush() {
Flush(true);
}
/// Flushes the object to the document.
/// indicates whether object can be placed into object stream.
- ///
public void Flush(bool canBeInObjStm) {
if (IsFlushed() || GetIndirectReference() == null) {
+ // TODO here we should take into account and log the case when object is MustBeIndirect, but has no indirect reference
+ // TODO DEVSIX-744
// Logger logger = LoggerFactory.getLogger(PdfObject.class);
// if (isFlushed()) {
// logger.warn("Meaningless call, the object has already flushed");
+ // } else if (isIndirect()){
+ // logger.warn("Meaningless call, the object will be transformed into indirect on closing, but at the moment it doesn't have an indirect reference and therefore couldn't be flushed. " +
+ // "To flush it now call makeIndirect(PdfDocument) method before calling flush() method.");
// } else {
- // logger.warn("Meaningless call, the object is direct object.");
+ // logger.warn("Meaningless call, the object is direct object. It will be flushed along with the indirect object that contains it.");
// }
return;
}
@@ -268,9 +271,10 @@ public virtual PdfObject CopyTo(PdfDocument document) {
/// copied object.
public virtual PdfObject CopyTo(PdfDocument document, bool allowDuplicating) {
if (document == null) {
- throw new PdfException(PdfException.DocumentToCopyToCannotBeNull);
+ throw new PdfException(PdfException.DocumentForCopyToCannotBeNull);
}
if (indirectReference != null) {
+ // TODO checkState(MUST_BE_INDIRECT) now is always false, because indirectReference != null. See also DEVSIX-602
if (indirectReference.GetWriter() != null || CheckState(MUST_BE_INDIRECT)) {
throw new PdfException(PdfException.CannotCopyIndirectObjectFromTheDocumentThatIsBeingWritten);
}
@@ -448,6 +452,7 @@ protected internal virtual void CopyContent(PdfObject from, PdfDocument document
/// copying to the other document
/// cloning inside of the current document
///
+ ///
/// This two cases are distinguished by the state of document parameter:
/// the second case is processed if document is null.
///
@@ -481,5 +486,13 @@ internal virtual PdfObject ProcessCopying(PdfDocument documentTo, bool allowDupl
return obj.Clone();
}
}
+
+ internal static bool EqualContent(PdfObject obj1, PdfObject obj2) {
+ PdfObject direct1 = obj1 != null && obj1.IsIndirectReference() ? ((PdfIndirectReference)obj1).GetRefersTo(
+ true) : obj1;
+ PdfObject direct2 = obj2 != null && obj2.IsIndirectReference() ? ((PdfIndirectReference)obj2).GetRefersTo(
+ true) : obj2;
+ return direct1 != null && direct1.Equals(direct2);
+ }
}
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/PdfObjectStream.cs b/itext/itext.kernel/itext/kernel/pdf/PdfObjectStream.cs
index 5512f37cf9..d3610f1444 100644
--- a/itext/itext.kernel/itext/kernel/pdf/PdfObjectStream.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/PdfObjectStream.cs
@@ -57,7 +57,8 @@ internal class PdfObjectStream : PdfStream {
public PdfObjectStream(PdfDocument doc)
: base() {
- MakeIndirect(doc);
+ //avoid reuse existed references
+ MakeIndirect(doc, doc.GetXref().CreateNewIndirectReference(doc));
GetOutputStream().document = doc;
Put(PdfName.Type, PdfName.ObjStm);
Put(PdfName.N, size);
@@ -82,7 +83,6 @@ internal PdfObjectStream(iText.Kernel.Pdf.PdfObjectStream prev)
/// Adds object to the object stream.
/// object to add.
- ///
public virtual void AddObject(PdfObject @object) {
if (size.IntValue() == MAX_OBJ_STREAM_SIZE) {
throw new PdfException(PdfException.PdfObjectStreamReachMaxSize);
diff --git a/itext/itext.kernel/itext/kernel/pdf/PdfOutline.cs b/itext/itext.kernel/itext/kernel/pdf/PdfOutline.cs
index 7f53d13ec3..1b2ed57012 100644
--- a/itext/itext.kernel/itext/kernel/pdf/PdfOutline.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/PdfOutline.cs
@@ -49,9 +49,15 @@ source product.
using iText.Kernel.Pdf.Navigation;
namespace iText.Kernel.Pdf {
+ ///
+ /// Document outline object
+ /// See ISO-320001, 12.3.3 Document Outline.
+ ///
public class PdfOutline {
+ /// A flag for displaying the outline item’s text with italic font.
public static int FLAG_ITALIC = 1;
+ /// A flag for displaying the outline item’s text with bold font.
public static int FLAG_BOLD = 2;
private IList children = new List();
@@ -66,12 +72,27 @@ public class PdfOutline {
private PdfDocument pdfDoc;
+ /// Create instance of document outline.
+ /// the text that shall be displayed on the screen for this item.
+ /// Outline dictionary
+ ///
+ ///
+ ///
+ /// the outline belongs to.
+ ///
+ [System.ObsoleteAttribute(@"Use PdfCatalog.GetOutlines(bool) instead.")]
public PdfOutline(String title, PdfDictionary content, PdfDocument pdfDocument) {
this.title = title;
this.content = content;
this.pdfDoc = pdfDocument;
}
+ /// Create instance of document outline.
+ /// the text that shall be displayed on the screen for this item.
+ /// Outline dictionary
+ /// parent outline.
+ [System.ObsoleteAttribute(@"Use PdfCatalog.GetNextItem(PdfDictionary, PdfOutline, System.Collections.Generic.IDictionary{K, V}) ,AddOutline(System.String, int) and AddOutline(System.String) instead."
+ )]
public PdfOutline(String title, PdfDictionary content, iText.Kernel.Pdf.PdfOutline parent) {
this.title = title;
this.content = content;
@@ -81,8 +102,11 @@ public PdfOutline(String title, PdfDictionary content, iText.Kernel.Pdf.PdfOutli
}
/// This constructor creates root outline in the document.
- ///
- ///
+ ///
+ ///
+ ///
+ ///
+ [System.ObsoleteAttribute(@"Use PdfCatalog.GetOutlines(bool) instead.")]
protected internal PdfOutline(PdfDocument doc) {
content = new PdfDictionary();
content.Put(PdfName.Type, PdfName.Outlines);
@@ -91,74 +115,170 @@ protected internal PdfOutline(PdfDocument doc) {
doc.GetCatalog().AddRootOutline(this);
}
+ /// Gets title of the outline.
+ /// String value.
public virtual String GetTitle() {
return title;
}
+ ///
+ /// Sets title of the outline with
+ ///
+ /// encoding,
+ /// Title
+ /// key.
+ ///
+ /// String value.
public virtual void SetTitle(String title) {
this.title = title;
this.content.Put(PdfName.Title, new PdfString(title, PdfEncodings.UNICODE_BIG));
}
+ ///
+ /// Sets color for the outline entry’s text,
+ /// C
+ /// key.
+ ///
+ ///
+ ///
+ ///
+ ///
public virtual void SetColor(Color color) {
content.Put(PdfName.C, new PdfArray(color.GetColorValue()));
}
+ ///
+ /// Sets text style for the outline entry’s text,
+ /// F
+ /// key.
+ ///
+ ///
+ /// Could be either
+ ///
+ /// or
+ ///
+ /// . Default value is
+ /// 0
+ /// .
+ ///
public virtual void SetStyle(int style) {
if (style == FLAG_BOLD || style == FLAG_ITALIC) {
content.Put(PdfName.F, new PdfNumber(style));
}
}
+ /// Gets content dictionary.
+ ///
+ ///
+ ///
+ /// .
+ ///
public virtual PdfDictionary GetContent() {
return content;
}
+ /// Gets list of children outlines.
+ ///
+ /// List of
+ ///
+ /// .
+ ///
public virtual IList GetAllChildren() {
return children;
}
+ /// Gets parent outline.
+ ///
+ ///
+ ///
+ /// .
+ ///
public virtual iText.Kernel.Pdf.PdfOutline GetParent() {
return parent;
}
+ ///
+ /// Gets
+ ///
+ /// .
+ ///
+ ///
+ ///
+ ///
+ /// .
+ ///
public virtual PdfDestination GetDestination() {
return destination;
}
+ ///
+ /// Adds
+ ///
+ /// for the outline,
+ /// Dest
+ /// key.
+ ///
+ ///
+ /// instance of
+ ///
+ /// .
+ ///
public virtual void AddDestination(PdfDestination destination) {
SetDestination(destination);
content.Put(PdfName.Dest, destination.GetPdfObject());
}
+ ///
+ /// Adds
+ ///
+ /// for the outline,
+ /// A
+ /// key.
+ ///
+ ///
+ /// instance of
+ ///
+ /// .
+ ///
public virtual void AddAction(PdfAction action) {
content.Put(PdfName.A, action.GetPdfObject());
}
- ///
- /// Adds an PdfOutline as a child to existing PdfOutline
- /// and put it in the end of the existing PdfOutline children list
- ///
- /// an outline title
- /// a created outline
- ///
- public virtual iText.Kernel.Pdf.PdfOutline AddOutline(String title) {
- return AddOutline(title, -1);
+ /// Defines if the outline needs to be closed or not.
+ ///
+ /// Defines if the outline needs to be closed or not.
+ /// By default, outlines are open.
+ ///
+ /// if false, the outline will be closed by default
+ public virtual void SetOpen(bool open) {
+ if (!open) {
+ content.Put(PdfName.Count, new PdfNumber(-1));
+ }
+ else {
+ if (children.Count > 0) {
+ content.Put(PdfName.Count, new PdfNumber(children.Count));
+ }
+ else {
+ content.Remove(PdfName.Count);
+ }
+ }
}
///
- /// Adds an
+ /// Adds a new
/// PdfOutline
- /// as a child to existing PdfOutline
- /// and put it to specified position in the existing PdfOutline children list
+ /// with specified parameters as a child to existing
+ /// PdfOutline
+ /// and put it to specified position in the existing
+ /// PdfOutline
+ /// children list.
///
/// an outline title
///
/// a position in the current outline child List where a new outline should be added.
/// If the position equals -1, then the outline will be put in the end of children list.
///
- /// created outline
- ///
+ /// just created outline
public virtual iText.Kernel.Pdf.PdfOutline AddOutline(String title, int position) {
if (position == -1) {
position = children.Count;
@@ -185,32 +305,70 @@ public virtual iText.Kernel.Pdf.PdfOutline AddOutline(String title, int position
if (position == children.Count) {
content.Put(PdfName.Last, dictionary);
}
- if (children.Count > 0) {
- int count = (int)this.content.GetAsInt(PdfName.Count);
- if (count > 0) {
- content.Put(PdfName.Count, new PdfNumber(count++));
- }
- else {
- content.Put(PdfName.Count, new PdfNumber(count--));
- }
- }
- else {
- this.content.Put(PdfName.Count, new PdfNumber(-1));
+ PdfNumber count = this.content.GetAsNumber(PdfName.Count);
+ if (count == null || count.GetValue() != -1) {
+ content.Put(PdfName.Count, new PdfNumber(children.Count + 1));
}
children.Add(position, outline);
return outline;
}
+ ///
+ /// Adds an
+ /// PdfOutline
+ /// as a child to existing
+ /// PdfOutline
+ /// and put it in the end of the existing
+ /// PdfOutline
+ /// children list.
+ ///
+ /// an outline title
+ /// just created outline
+ public virtual iText.Kernel.Pdf.PdfOutline AddOutline(String title) {
+ return AddOutline(title, -1);
+ }
+
+ ///
+ /// Adds an
+ /// PdfOutline
+ /// as a child to existing
+ /// PdfOutline
+ /// and put it to the end of the existing
+ /// PdfOutline
+ /// children list.
+ ///
+ /// an outline to add.
+ /// just created outline
+ public virtual iText.Kernel.Pdf.PdfOutline AddOutline(iText.Kernel.Pdf.PdfOutline outline) {
+ iText.Kernel.Pdf.PdfOutline newOutline = AddOutline(outline.GetTitle());
+ newOutline.AddDestination(outline.GetDestination());
+ IList children = outline.GetAllChildren();
+ foreach (iText.Kernel.Pdf.PdfOutline child in children) {
+ newOutline.AddOutline(child);
+ }
+ return newOutline;
+ }
+
+ /// Clear list of children.
internal virtual void Clear() {
children.Clear();
}
+ ///
+ /// Sets
+ ///
+ /// .
+ ///
+ ///
+ /// instance of
+ ///
+ /// .
+ ///
internal virtual void SetDestination(PdfDestination destination) {
this.destination = destination;
}
- /// remove this outline from the document.
- ///
+ /// Remove this outline from the document.
internal virtual void RemoveOutline() {
PdfName type = content.GetAsName(PdfName.Type);
if (type != null && type.Equals(PdfName.Outlines)) {
@@ -246,15 +404,5 @@ internal virtual void RemoveOutline() {
}
}
}
-
- public virtual iText.Kernel.Pdf.PdfOutline AddOutline(iText.Kernel.Pdf.PdfOutline outline) {
- iText.Kernel.Pdf.PdfOutline newOutline = AddOutline(outline.GetTitle());
- newOutline.AddDestination(outline.GetDestination());
- IList children = outline.GetAllChildren();
- foreach (iText.Kernel.Pdf.PdfOutline child in children) {
- newOutline.AddOutline(child);
- }
- return newOutline;
- }
}
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/PdfOutputIntent.cs b/itext/itext.kernel/itext/kernel/pdf/PdfOutputIntent.cs
index 146ce11e27..77ebb470ae 100644
--- a/itext/itext.kernel/itext/kernel/pdf/PdfOutputIntent.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/PdfOutputIntent.cs
@@ -46,6 +46,10 @@ source product.
using iText.Kernel.Pdf.Colorspace;
namespace iText.Kernel.Pdf {
+ ///
+ /// Specify the colour characteristics of output devices on which the document might be rendered
+ /// See ISO 32000-1 14.11.5: Output Intents.
+ ///
public class PdfOutputIntent : PdfObjectWrapper {
/// Creates output intent dictionary.
///
diff --git a/itext/itext.kernel/itext/kernel/pdf/PdfOutputStream.cs b/itext/itext.kernel/itext/kernel/pdf/PdfOutputStream.cs
index c9dcca9564..1997cbe05f 100644
--- a/itext/itext.kernel/itext/kernel/pdf/PdfOutputStream.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/PdfOutputStream.cs
@@ -42,7 +42,6 @@ source product.
address: sales@itextpdf.com
*/
using System;
-using System.Collections.Generic;
using System.IO;
using iText.IO;
using iText.IO.Log;
@@ -156,13 +155,13 @@ private void Write(PdfArray pdfArray) {
private void Write(PdfDictionary pdfDictionary) {
WriteBytes(openDict);
- foreach (KeyValuePair entry in pdfDictionary.EntrySet()) {
+ foreach (PdfName key in pdfDictionary.KeySet()) {
bool isAlreadyWriteSpace = false;
- Write(entry.Key);
- PdfObject value = entry.Value;
+ Write(key);
+ PdfObject value = pdfDictionary.Get(key, false);
if (value == null) {
ILogger logger = LoggerFactory.GetLogger(typeof(iText.Kernel.Pdf.PdfOutputStream));
- logger.Warn(String.Format(LogMessageConstant.INVALID_KEY_VALUE_KEY_0_HAS_NULL_VALUE, entry.Key));
+ logger.Warn(String.Format(LogMessageConstant.INVALID_KEY_VALUE_KEY_0_HAS_NULL_VALUE, key));
value = PdfNull.PDF_NULL;
}
if ((value.GetObjectType() == PdfObject.NUMBER || value.GetObjectType() == PdfObject.LITERAL || value.GetObjectType
@@ -187,7 +186,7 @@ private void Write(PdfDictionary pdfDictionary) {
private void Write(PdfIndirectReference indirectReference) {
if (document != null && !indirectReference.GetDocument().Equals(document)) {
- throw new PdfException(PdfException.PdfInderectObjectBelongToOtherPdfDocument);
+ throw new PdfException(PdfException.PdfIndirectObjectBelongsToOtherPdfDocument);
}
if (indirectReference.GetRefersTo() == null) {
Write(PdfNull.PDF_NULL);
@@ -358,7 +357,7 @@ private void Write(PdfStream pdfStream) {
}
}
catch (System.IO.IOException e) {
- throw new PdfException(PdfException.CannotWritePdfStream, e, pdfStream);
+ throw new PdfException(PdfException.CannotWriteToPdfStream, e, pdfStream);
}
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/PdfPage.cs b/itext/itext.kernel/itext/kernel/pdf/PdfPage.cs
index 8f48929dd5..c69e93908a 100644
--- a/itext/itext.kernel/itext/kernel/pdf/PdfPage.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/PdfPage.cs
@@ -105,24 +105,24 @@ protected internal PdfPage(PdfDocument pdfDocument)
: this(pdfDocument, pdfDocument.GetDefaultPageSize()) {
}
+ /// Gets page size, defined by media box object.
+ /// Gets page size, defined by media box object. This method doesn't take page rotation into account.
+ ///
+ ///
+ ///
+ ///
+ /// that specify page size.
+ ///
public virtual Rectangle GetPageSize() {
- PdfArray box = GetPdfObject().GetAsArray(PdfName.MediaBox);
- if (box == null || box.Size() != 4) {
- throw new ArgumentException("MediaBox");
- }
- PdfNumber llx = box.GetAsNumber(0);
- PdfNumber lly = box.GetAsNumber(1);
- PdfNumber urx = box.GetAsNumber(2);
- PdfNumber ury = box.GetAsNumber(3);
- if (llx == null || lly == null || urx == null || ury == null) {
- throw new ArgumentException("MediaBox");
- }
- return new Rectangle(Math.Min(llx.FloatValue(), urx.FloatValue()), Math.Min(lly.FloatValue(), ury.FloatValue
- ()), Math.Abs(urx.FloatValue() - llx.FloatValue()), Math.Abs(ury.FloatValue() - lly.FloatValue()));
+ return GetMediaBox();
}
- /// Gets the rotated page.
- /// the rotated rectangle
+ /// Gets page size, considering page rotation.
+ ///
+ ///
+ ///
+ /// that specify size of rotated page.
+ ///
public virtual Rectangle GetPageSizeWithRotation() {
PageSize rect = new PageSize(GetPageSize());
int rotation = GetRotation();
@@ -133,6 +133,17 @@ public virtual Rectangle GetPageSizeWithRotation() {
return rect;
}
+ /// Gets the number of degrees by which the page shall be rotated clockwise when displayed or printed.
+ ///
+ ///
+ /// Gets the number of degrees by which the page shall be rotated clockwise when displayed or printed.
+ /// Shall be a multiple of 90.
+ ///
+ ///
+ ///
+ /// int
+ /// number of degrees. Default value: 0
+ ///
public virtual int GetRotation() {
PdfNumber rotate = GetPdfObject().GetAsNumber(PdfName.Rotate);
if (rotate == null) {
@@ -145,11 +156,44 @@ public virtual int GetRotation() {
}
}
+ /// Sets the page rotation.
+ ///
+ /// the
+ /// int
+ /// number of degrees by which the page shall be rotated clockwise
+ /// when displayed or printed. Shall be a multiple of 90.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.PdfPage SetRotation(int degAngle) {
GetPdfObject().Put(PdfName.Rotate, new PdfNumber(degAngle));
return this;
}
+ ///
+ /// Gets the content stream at specified 0-based index in the Contents object
+ ///
+ /// .
+ /// The situation when Contents object is a
+ ///
+ /// is treated like a one element array.
+ ///
+ ///
+ /// the
+ /// int
+ /// index of returned
+ ///
+ /// .
+ ///
+ ///
+ ///
+ ///
+ /// object at specified index.
+ ///
+ /// if the index is out of range
public virtual PdfStream GetContentStream(int index) {
int count = GetContentStreamCount();
if (index >= count) {
@@ -170,6 +214,21 @@ public virtual PdfStream GetContentStream(int index) {
}
}
+ ///
+ /// Gets the size of Contents object
+ ///
+ /// .
+ /// The situation when Contents object is a
+ ///
+ /// is treated like a one element array.
+ ///
+ ///
+ /// the
+ /// int
+ /// size of Contents object, or 1 if Contents object is a
+ ///
+ /// .
+ ///
public virtual int GetContentStreamCount() {
PdfObject contents = GetPdfObject().Get(PdfName.Contents);
if (contents is PdfStream) {
@@ -185,6 +244,20 @@ public virtual int GetContentStreamCount() {
}
}
+ ///
+ /// Returns the Contents object if it is
+ ///
+ /// , or first stream in the array if it is
+ ///
+ /// .
+ ///
+ ///
+ /// first
+ ///
+ /// in Contents object, or
+ ///
+ /// if Contents is empty.
+ ///
public virtual PdfStream GetFirstContentStream() {
if (GetContentStreamCount() > 0) {
return GetContentStream(0);
@@ -192,6 +265,20 @@ public virtual PdfStream GetFirstContentStream() {
return null;
}
+ ///
+ /// Returns the Contents object if it is
+ ///
+ /// , or last stream in the array if it is
+ ///
+ /// .
+ ///
+ ///
+ /// first
+ ///
+ /// in Contents object, or
+ ///
+ /// if Contents is empty.
+ ///
public virtual PdfStream GetLastContentStream() {
int count = GetContentStreamCount();
if (count > 0) {
@@ -200,14 +287,60 @@ public virtual PdfStream GetLastContentStream() {
return null;
}
+ ///
+ /// Creates new
+ ///
+ /// object and puts it at the beginning of Contents array
+ /// (if Contents object is
+ ///
+ /// it will be replaced with one-element array).
+ ///
+ ///
+ /// Created
+ ///
+ /// object.
+ ///
public virtual PdfStream NewContentStreamBefore() {
return NewContentStream(true);
}
+ ///
+ /// Creates new
+ ///
+ /// object and puts it at the end of Contents array
+ /// (if Contents object is
+ ///
+ /// it will be replaced with one-element array).
+ ///
+ ///
+ /// Created
+ ///
+ /// object.
+ ///
public virtual PdfStream NewContentStreamAfter() {
return NewContentStream(false);
}
+ ///
+ /// Gets the
+ ///
+ /// wrapper object for this page resources.
+ /// If page doesn't have resource object, then it will be inherited from page's parents.
+ /// If neither parents nor page has the resource object, then the new one is created and added to page dictionary.
+ ///
+ /// NOTE: If you'll try to modify the inherited resources, then the new resources object will be created,
+ /// so you won't change the parent's resources.
+ /// This new object under the wrapper will be added to page dictionary on
+ ///
+ /// ,
+ /// or you can add it manually with this line, if needed:
+ /// getPdfObject().put(PdfName.Resources, getResources().getPdfObject());
+ ///
+ ///
+ ///
+ ///
+ /// wrapper of the page.
+ ///
public virtual PdfResources GetResources() {
if (this.resources == null) {
bool readOnly = false;
@@ -229,15 +362,34 @@ public virtual PdfResources GetResources() {
return this.resources;
}
+ ///
+ /// Sets
+ ///
+ /// object.
+ ///
+ ///
+ ///
+ ///
+ /// to set.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.PdfPage SetResources(PdfResources pdfResources) {
GetPdfObject().Put(PdfName.Resources, pdfResources.GetPdfObject());
this.resources = pdfResources;
return this;
}
- /// Use this method to set the XMP Metadata for each page.
- /// The xmpMetadata to set.
- ///
+ /// Sets the XMP Metadata.
+ ///
+ /// the
+ /// byte[]
+ /// of XMP Metadata to set.
+ ///
+ /// in case of writing error.
public virtual void SetXmpMetadata(byte[] xmpMetadata) {
PdfStream xmp = ((PdfStream)new PdfStream().MakeIndirect(GetDocument()));
xmp.GetOutputStream().Write(xmpMetadata);
@@ -246,20 +398,44 @@ public virtual void SetXmpMetadata(byte[] xmpMetadata) {
GetPdfObject().Put(PdfName.Metadata, xmp);
}
- ///
- ///
+ /// Serializes XMP Metadata to byte array and sets it.
+ ///
+ /// the
+ ///
+ /// object to set.
+ ///
+ ///
+ /// the
+ ///
+ /// used while serialization.
+ ///
+ /// in case of XMP Metadata serialization error.
+ /// in case of writing error.
public virtual void SetXmpMetadata(XMPMeta xmpMeta, SerializeOptions serializeOptions) {
SetXmpMetadata(XMPMetaFactory.SerializeToBuffer(xmpMeta, serializeOptions));
}
- ///
- ///
+ /// Serializes XMP Metadata to byte array and sets it.
+ /// Serializes XMP Metadata to byte array and sets it. Uses padding equals to 2000.
+ ///
+ /// the
+ ///
+ /// object to set.
+ ///
+ /// in case of XMP Metadata serialization error.
+ /// in case of writing error.
public virtual void SetXmpMetadata(XMPMeta xmpMeta) {
SerializeOptions serializeOptions = new SerializeOptions();
serializeOptions.SetPadding(2000);
SetXmpMetadata(xmpMeta, serializeOptions);
}
+ /// Gets the XMP Metadata object.
+ ///
+ ///
+ ///
+ /// object, that represent XMP Metadata.
+ ///
///
public virtual PdfStream GetXmpMetadata() {
return GetPdfObject().GetAsStream(PdfName.Metadata);
@@ -272,7 +448,11 @@ public virtual PdfStream GetXmpMetadata() {
/// NOTE: Works only for pages from the document opened in reading mode, otherwise an exception is thrown.
///
/// a document to copy page to.
- /// copied page.
+ ///
+ /// copied
+ ///
+ /// .
+ ///
public virtual iText.Kernel.Pdf.PdfPage CopyTo(PdfDocument toDocument) {
return CopyTo(toDocument, null);
}
@@ -284,19 +464,32 @@ public virtual iText.Kernel.Pdf.PdfPage CopyTo(PdfDocument toDocument) {
/// NOTE: Works only for pages from the document opened in reading mode, otherwise an exception is thrown.
///
/// a document to copy page to.
- /// a copier which bears a specific copy logic. May be NULL
- /// copied page.
+ ///
+ /// a copier which bears a specific copy logic. May be
+ ///
+ ///
+ ///
+ /// copied
+ ///
+ /// .
+ ///
public virtual iText.Kernel.Pdf.PdfPage CopyTo(PdfDocument toDocument, IPdfPageExtraCopier copier) {
PdfDictionary dictionary = GetPdfObject().CopyTo(toDocument, excludedKeys, true);
iText.Kernel.Pdf.PdfPage page = new iText.Kernel.Pdf.PdfPage(dictionary);
CopyInheritedProperties(page, toDocument);
foreach (PdfAnnotation annot in GetAnnotations()) {
if (annot.GetSubtype().Equals(PdfName.Link)) {
- GetDocument().StoreLinkAnnotation(this, (PdfLinkAnnotation)annot);
+ GetDocument().StoreLinkAnnotation(page, (PdfLinkAnnotation)annot);
}
else {
- page.AddAnnotation(-1, PdfAnnotation.MakeAnnotation(((PdfDictionary)annot.GetPdfObject().CopyTo(toDocument
- , false))), false);
+ if (annot.GetSubtype().Equals(PdfName.Widget)) {
+ page.AddAnnotation(-1, PdfAnnotation.MakeAnnotation(((PdfDictionary)annot.GetPdfObject().CopyTo(toDocument
+ , false))), false);
+ }
+ else {
+ page.AddAnnotation(-1, PdfAnnotation.MakeAnnotation(((PdfDictionary)annot.GetPdfObject().CopyTo(toDocument
+ , true))), false);
+ }
}
}
if (toDocument.IsTagged()) {
@@ -319,7 +512,11 @@ public virtual iText.Kernel.Pdf.PdfPage CopyTo(PdfDocument toDocument, IPdfPageE
/// Copies page as FormXObject to the specified document.
/// a document to copy to.
- /// resultant XObject.
+ ///
+ /// copied
+ ///
+ /// object.
+ ///
///
public virtual PdfFormXObject CopyAsFormXObject(PdfDocument toDocument) {
PdfFormXObject xObject = new PdfFormXObject(GetCropBox());
@@ -332,6 +529,20 @@ public virtual PdfFormXObject CopyAsFormXObject(PdfDocument toDocument) {
return xObject;
}
+ ///
+ /// Gets the
+ ///
+ /// that owns that page, or
+ ///
+ /// if such document isn't exist.
+ ///
+ ///
+ ///
+ ///
+ /// that owns that page, or
+ ///
+ /// if such document isn't exist.
+ ///
public virtual PdfDocument GetDocument() {
if (GetPdfObject().GetIndirectReference() != null) {
return GetPdfObject().GetIndirectReference().GetDocument();
@@ -357,86 +568,160 @@ public override void Flush() {
/// Flushes page and its content stream.
///
- /// Flushes page and its content stream. If flushXObjects is true the images and FormXObjects
- /// associated with this page will also be flushed.
+ /// Flushes page and its content stream. If flushContentStreams is true, all content streams that are
+ /// rendered on this page (like FormXObjects, annotation appearance streams, patterns) and also all images associated
+ /// with this page will also be flushed.
///
/// For notes about tag structure flushing see
/// PdfPage#flush() method
/// .
///
///
- /// If PdfADocument is used, flushing will be applied only if flushXObjects is true.
+ /// If PdfADocument is used, flushing will be applied only if flushContentStreams is true.
///
- /// if true the images and FormXObjects associated with this page will also be flushed.
- ///
- public virtual void Flush(bool flushXObjects) {
+ ///
+ /// if true all content streams that are rendered on this page (like form xObjects,
+ /// annotation appearance streams, patterns) and also all images associated with this page
+ /// will be flushed.
+ ///
+ public virtual void Flush(bool flushContentStreams) {
// TODO log warning in case of failed flush in pdfa document case
if (IsFlushed()) {
return;
}
+ GetDocument().DispatchEvent(new PdfDocumentEvent(PdfDocumentEvent.END_PAGE, this));
if (GetDocument().IsTagged() && !GetDocument().GetStructTreeRoot().IsFlushed()) {
- GetDocument().GetTagStructureContext().FlushPageTags(this);
- GetDocument().GetStructTreeRoot().CreateParentTreeEntryForPage(this);
+ TryFlushPageTags();
}
- GetDocument().DispatchEvent(new PdfDocumentEvent(PdfDocumentEvent.END_PAGE, this));
- if (flushXObjects) {
+ if (resources != null && resources.IsModified() && !resources.IsReadOnly()) {
+ GetPdfObject().Put(PdfName.Resources, resources.GetPdfObject());
+ }
+ if (flushContentStreams) {
GetDocument().CheckIsoConformance(this, IsoKey.PAGE);
+ FlushContentStreams();
}
int contentStreamCount = GetContentStreamCount();
for (int i = 0; i < contentStreamCount; i++) {
GetContentStream(i).Flush(false);
}
- ICollection xObjects = null;
- if (resources != null) {
- if (resources.IsReadOnly() && !resources.IsModified()) {
- GetPdfObject().Remove(PdfName.Resources);
- }
- else {
- if (flushXObjects) {
- PdfDictionary xObjectsDict = GetPdfObject().GetAsDictionary(PdfName.Resources).GetAsDictionary(PdfName.XObject
- );
- xObjects = xObjectsDict != null ? xObjectsDict.Values() : null;
- }
- }
- }
resources = null;
base.Flush();
- if (flushXObjects && xObjects != null) {
- FlushXObjects(xObjects);
- }
}
+ ///
+ /// Gets
+ ///
+ /// object specified by page's Media Box, that defines the boundaries of the physical medium
+ /// on which the page shall be displayed or printed
+ ///
+ ///
+ ///
+ ///
+ /// object specified by page Media Box, expressed in default user space units.
+ ///
+ /// in case of any error while reading MediaBox object.
public virtual Rectangle GetMediaBox() {
InitParentPages();
PdfArray mediaBox = GetPdfObject().GetAsArray(PdfName.MediaBox);
if (mediaBox == null) {
mediaBox = (PdfArray)GetParentValue(parentPages, PdfName.MediaBox);
}
- return mediaBox.ToRectangle();
+ if (mediaBox == null) {
+ throw new PdfException(PdfException.CannotRetrieveMediaBoxAttribute);
+ }
+ if (mediaBox.Size() != 4) {
+ throw new PdfException(PdfException.WrongMediaBoxSize1).SetMessageParams(mediaBox.Size());
+ }
+ PdfNumber llx = mediaBox.GetAsNumber(0);
+ PdfNumber lly = mediaBox.GetAsNumber(1);
+ PdfNumber urx = mediaBox.GetAsNumber(2);
+ PdfNumber ury = mediaBox.GetAsNumber(3);
+ if (llx == null || lly == null || urx == null || ury == null) {
+ throw new PdfException(PdfException.InvalidMediaBoxValue);
+ }
+ return new Rectangle(Math.Min(llx.FloatValue(), urx.FloatValue()), Math.Min(lly.FloatValue(), ury.FloatValue
+ ()), Math.Abs(urx.FloatValue() - llx.FloatValue()), Math.Abs(ury.FloatValue() - lly.FloatValue()));
}
+ ///
+ /// Sets the Media Box object, that defines the boundaries of the physical medium
+ /// on which the page shall be displayed or printed.
+ ///
+ ///
+ /// the
+ ///
+ /// object to set, expressed in default user space units.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.PdfPage SetMediaBox(Rectangle rectangle) {
GetPdfObject().Put(PdfName.MediaBox, new PdfArray(rectangle));
return this;
}
+ ///
+ /// Gets the
+ ///
+ /// specified by page's CropBox, that defines the visible region of default user space.
+ /// When the page is displayed or printed, its contents shall be clipped (cropped) to this rectangle
+ /// and then shall be imposed on the output medium in some implementation-defined manner.
+ ///
+ ///
+ /// the
+ ///
+ /// object specified by pages's CropBox, expressed in default user space units.
+ /// MediaBox by default.
+ ///
public virtual Rectangle GetCropBox() {
InitParentPages();
PdfArray cropBox = GetPdfObject().GetAsArray(PdfName.CropBox);
if (cropBox == null) {
cropBox = (PdfArray)GetParentValue(parentPages, PdfName.CropBox);
if (cropBox == null) {
- cropBox = new PdfArray(GetMediaBox());
+ return GetMediaBox();
}
}
return cropBox.ToRectangle();
}
+ /// Sets the CropBox object, that defines the visible region of default user space.
+ ///
+ /// Sets the CropBox object, that defines the visible region of default user space.
+ /// When the page is displayed or printed, its contents shall be clipped (cropped) to this rectangle
+ /// and then shall be imposed on the output medium in some implementation-defined manner.
+ ///
+ ///
+ /// the
+ ///
+ /// object to set, expressed in default user space units.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.PdfPage SetCropBox(Rectangle rectangle) {
GetPdfObject().Put(PdfName.CropBox, new PdfArray(rectangle));
return this;
}
+ ///
+ /// Sets the ArtBox object, that define the extent of the page’s meaningful content
+ /// (including potential white space) as intended by the page’s creator.
+ ///
+ ///
+ /// the
+ ///
+ /// object to set, expressed in default user space units.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.PdfPage SetArtBox(Rectangle rectangle) {
if (GetPdfObject().GetAsRectangle(PdfName.TrimBox) != null) {
GetPdfObject().Remove(PdfName.TrimBox);
@@ -447,10 +732,35 @@ public virtual iText.Kernel.Pdf.PdfPage SetArtBox(Rectangle rectangle) {
return this;
}
+ ///
+ /// Gets the
+ ///
+ /// object specified by page's ArtBox, that define the extent of the page’s
+ /// meaningful content (including potential white space) as intended by the page’s creator.
+ ///
+ ///
+ /// the
+ ///
+ /// object specified by page's ArtBox, expressed in default user space units.
+ /// CropBox by default.
+ ///
public virtual Rectangle GetArtBox() {
- return GetPdfObject().GetAsRectangle(PdfName.ArtBox);
+ Rectangle artBox = GetPdfObject().GetAsRectangle(PdfName.ArtBox);
+ return artBox == null ? GetCropBox() : artBox;
}
+ /// Sets the TrimBox object, that define the intended dimensions of the finished page after trimming.
+ ///
+ ///
+ /// the
+ ///
+ /// object to set, expressed in default user space units.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.PdfPage SetTrimBox(Rectangle rectangle) {
if (GetPdfObject().GetAsRectangle(PdfName.ArtBox) != null) {
GetPdfObject().Remove(PdfName.ArtBox);
@@ -461,19 +771,40 @@ public virtual iText.Kernel.Pdf.PdfPage SetTrimBox(Rectangle rectangle) {
return this;
}
+ ///
+ /// Gets the
+ ///
+ /// object specified by page's TrimBox object,
+ /// that define the intended dimensions of the finished page after trimming.
+ ///
+ ///
+ /// the
+ ///
+ /// object specified by page's TrimBox, expressed in default user space units.
+ /// CropBox by default.
+ ///
public virtual Rectangle GetTrimBox() {
- return GetPdfObject().GetAsRectangle(PdfName.TrimBox);
+ Rectangle trimBox = GetPdfObject().GetAsRectangle(PdfName.TrimBox);
+ return trimBox == null ? GetCropBox() : trimBox;
}
/// Get decoded bytes for the whole page content.
/// byte array.
- /// in case any @see IOException.
+ ///
+ /// in case of any
+ /// IOException).
+ ///
public virtual byte[] GetContentBytes() {
try {
MemoryStream baos = new MemoryStream();
int streamCount = GetContentStreamCount();
+ byte[] streamBytes;
for (int i = 0; i < streamCount; i++) {
- baos.Write(GetStreamBytes(i));
+ streamBytes = GetStreamBytes(i);
+ baos.Write(streamBytes);
+ if (0 != streamBytes.Length && !char.IsWhiteSpace((char)streamBytes[streamBytes.Length - 1])) {
+ baos.Write('\n');
+ }
}
return baos.ToArray();
}
@@ -485,14 +816,17 @@ public virtual byte[] GetContentBytes() {
/// Gets decoded bytes of a certain stream of a page content.
/// index of stream inside Content.
/// byte array.
- /// in case any @see IOException.
+ ///
+ /// in case of any
+ /// IOException).
+ ///
public virtual byte[] GetStreamBytes(int index) {
return GetContentStream(index).GetBytes();
}
/// Calculates and returns next available MCID reference.
/// calculated MCID reference.
- ///
+ /// in case of not tagged document.
public virtual int GetNextMcid() {
if (!GetDocument().IsTagged()) {
throw new PdfException(PdfException.MustBeATaggedDocument);
@@ -504,6 +838,16 @@ public virtual int GetNextMcid() {
return mcid++;
}
+ ///
+ /// Gets
+ ///
+ /// key of the page’s entry in the structural parent tree.
+ ///
+ ///
+ ///
+ ///
+ /// key of the page’s entry in the structural parent tree.
+ ///
public virtual int? GetStructParentIndex() {
if (structParents == -1) {
PdfNumber n = GetPdfObject().GetAsNumber(PdfName.StructParents);
@@ -517,11 +861,40 @@ public virtual int GetNextMcid() {
return structParents;
}
+ /// Helper method to add an additional action to this page.
+ ///
+ /// Helper method to add an additional action to this page.
+ /// May be used in chain.
+ ///
+ ///
+ /// a
+ ///
+ /// specifying the name of an additional action
+ ///
+ ///
+ /// the
+ ///
+ /// to add as an additional action
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.PdfPage SetAdditionalAction(PdfName key, PdfAction action) {
PdfAction.SetAdditionalAction(this, key, action);
return this;
}
+ ///
+ /// Gets array of annotation dictionaries that shall contain indirect references
+ /// to all annotations associated with the page.
+ ///
+ ///
+ /// the
+ /// List
+ /// containing all page's annotations.
+ ///
public virtual IList GetAnnotations() {
IList annotations = new List();
PdfArray annots = GetPdfObject().GetAsArray(PdfName.Annots);
@@ -534,6 +907,19 @@ public virtual IList GetAnnotations() {
return annotations;
}
+ /// Checks if page contains the specified annotation.
+ ///
+ /// the
+ ///
+ /// to check.
+ ///
+ ///
+ ///
+ ///
+ /// if page contains specified annotation and
+ ///
+ /// otherwise.
+ ///
public virtual bool ContainsAnnotation(PdfAnnotation annotation) {
foreach (PdfAnnotation a in GetAnnotations()) {
if (a.GetPdfObject().Equals(annotation.GetPdfObject())) {
@@ -543,10 +929,55 @@ public virtual bool ContainsAnnotation(PdfAnnotation annotation) {
return false;
}
+ /// Adds specified annotation to the end of annotations array and tagged it.
+ ///
+ /// Adds specified annotation to the end of annotations array and tagged it.
+ /// May be used in chain.
+ ///
+ ///
+ /// the
+ ///
+ /// to add.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.PdfPage AddAnnotation(PdfAnnotation annotation) {
return AddAnnotation(-1, annotation, true);
}
+ ///
+ /// Adds specified
+ ///
+ /// to specified index in annotations array with or without autotagging.
+ /// May be used in chain.
+ ///
+ ///
+ /// the index at which specified annotation will be added. If
+ /// -1
+ /// then annotation will be added
+ /// to the end of array.
+ ///
+ ///
+ /// the
+ ///
+ /// to add.
+ ///
+ ///
+ /// if
+ ///
+ /// the added annotation will be autotagged.
+ /// (see
+ ///
+ /// )
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.PdfPage AddAnnotation(int index, PdfAnnotation annotation, bool tagAnnotation
) {
if (GetDocument().IsTagged() && tagAnnotation) {
@@ -578,7 +1009,11 @@ public virtual iText.Kernel.Pdf.PdfPage AddAnnotation(int index, PdfAnnotation a
/// NOTE: If document is tagged, PdfDocument's PdfTagStructure instance will point at annotation tag parent after method call.
///
/// an annotation to be removed.
- /// this PdfPage instance.
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.PdfPage RemoveAnnotation(PdfAnnotation annotation) {
PdfArray annots = GetAnnots(false);
if (annots != null) {
@@ -605,6 +1040,18 @@ public virtual iText.Kernel.Pdf.PdfPage RemoveAnnotation(PdfAnnotation annotatio
return this;
}
+ ///
+ /// Gets the number of
+ ///
+ /// associated with this page.
+ ///
+ ///
+ /// the
+ /// int
+ /// number of
+ ///
+ /// associated with this page.
+ ///
public virtual int GetAnnotsSize() {
PdfArray annots = GetAnnots(false);
if (annots == null) {
@@ -616,7 +1063,6 @@ public virtual int GetAnnotsSize() {
/// This method gets outlines of a current page
///
/// return all outlines of a current page
- ///
public virtual IList GetOutlines(bool updateOutlines) {
GetDocument().GetOutlines(updateOutlines);
return GetDocument().GetCatalog().GetPagesWithOutlines().Get(GetPdfObject());
@@ -654,7 +1100,11 @@ public virtual iText.Kernel.Pdf.PdfPage SetIgnorePageRotationForContent(bool ign
/// May be NULL
///
/// The label prefix for page labels in this range. May be NULL
- ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.PdfPage SetPageLabel(PageLabelNumberingStyleConstants numberingStyle, String
labelPrefix) {
return SetPageLabel(numberingStyle, labelPrefix, 1);
@@ -670,7 +1120,11 @@ public virtual iText.Kernel.Pdf.PdfPage SetPageLabel(PageLabelNumberingStyleCons
/// The value of the numeric portion for the first page label in the range. Must be greater or
/// equal 1.
///
- ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.PdfPage SetPageLabel(PageLabelNumberingStyleConstants numberingStyle, String
labelPrefix, int firstPage) {
if (firstPage < 1) {
@@ -720,6 +1174,27 @@ public virtual iText.Kernel.Pdf.PdfPage SetPageLabel(PageLabelNumberingStyleCons
return this;
}
+ ///
+ /// Helper method that associate specified value with specified key in the underlined
+ ///
+ /// .
+ /// May be used in chain.
+ ///
+ ///
+ /// the
+ ///
+ /// key with which the specified value is to be associated.
+ ///
+ ///
+ /// the
+ ///
+ /// value to be associated with the specified key.
+ ///
+ ///
+ /// this
+ ///
+ /// object.
+ ///
public virtual iText.Kernel.Pdf.PdfPage Put(PdfName key, PdfObject value) {
GetPdfObject().Put(key, value);
return this;
@@ -818,22 +1293,71 @@ private PdfStream NewContentStream(bool before) {
return contentStream;
}
- private void FlushXObjects(ICollection xObjects) {
- foreach (PdfObject obj in xObjects) {
- PdfStream xObject = (PdfStream)obj;
- PdfDictionary innerResources = xObject.GetAsDictionary(PdfName.Resources);
- ICollection innerXObjects = null;
- if (innerResources != null) {
- PdfDictionary innerXObjectsDict = innerResources.GetAsDictionary(PdfName.XObject);
- innerXObjects = innerXObjectsDict != null ? innerXObjectsDict.Values() : null;
+ private void TryFlushPageTags() {
+ try {
+ GetDocument().GetTagStructureContext().FlushPageTags(this);
+ GetDocument().GetStructTreeRoot().CreateParentTreeEntryForPage(this);
+ }
+ catch (Exception ex) {
+ throw new PdfException(PdfException.TagStructureFlushingFailedItMightBeCorrupted, ex);
+ }
+ }
+
+ private void FlushContentStreams() {
+ FlushContentStreams(GetResources().GetPdfObject());
+ PdfArray annots = GetAnnots(false);
+ if (annots != null) {
+ for (int i = 0; i < annots.Size(); ++i) {
+ PdfDictionary apDict = annots.GetAsDictionary(i).GetAsDictionary(PdfName.AP);
+ if (apDict != null) {
+ FlushAppearanceStreams(apDict);
+ }
+ }
+ }
+ }
+
+ private void FlushContentStreams(PdfDictionary resources) {
+ if (resources != null) {
+ FlushWithResources(resources.GetAsDictionary(PdfName.XObject));
+ FlushWithResources(resources.GetAsDictionary(PdfName.Pattern));
+ FlushWithResources(resources.GetAsDictionary(PdfName.Shading));
+ }
+ }
+
+ private void FlushWithResources(PdfDictionary objsCollection) {
+ if (objsCollection == null) {
+ return;
+ }
+ foreach (PdfObject obj in objsCollection.Values()) {
+ if (obj.IsFlushed()) {
+ continue;
}
- obj.Flush();
- if (innerXObjects != null) {
- FlushXObjects(innerXObjects);
+ FlushContentStreams(((PdfDictionary)obj).GetAsDictionary(PdfName.Resources));
+ FlushMustBeIndirectObject(obj);
+ }
+ }
+
+ private void FlushAppearanceStreams(PdfDictionary appearanceStreamsDict) {
+ foreach (PdfObject val in appearanceStreamsDict.Values()) {
+ if (val is PdfDictionary) {
+ PdfDictionary ap = (PdfDictionary)val;
+ if (ap.IsDictionary()) {
+ FlushAppearanceStreams(ap);
+ }
+ else {
+ if (ap.IsStream()) {
+ FlushMustBeIndirectObject(ap);
+ }
+ }
}
}
}
+ private void FlushMustBeIndirectObject(PdfObject obj) {
+ // TODO DEVSIX-744
+ obj.MakeIndirect(GetDocument()).Flush();
+ }
+
/*
* initialization parentPages if needed
*/
diff --git a/itext/itext.kernel/itext/kernel/pdf/PdfPagesTree.cs b/itext/itext.kernel/itext/kernel/pdf/PdfPagesTree.cs
index 2d2dcec441..2e687082a2 100644
--- a/itext/itext.kernel/itext/kernel/pdf/PdfPagesTree.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/PdfPagesTree.cs
@@ -50,7 +50,7 @@ source product.
namespace iText.Kernel.Pdf {
///
/// Algorithm for construction
- /// PdfPages
+ ///
/// tree
///
internal class PdfPagesTree {
@@ -221,7 +221,8 @@ public virtual void AddPage(PdfPage pdfPage) {
/// one-base index of the page
///
///
- /// PdfPage
+ ///
+ /// to insert.
///
public virtual void AddPage(int index, PdfPage pdfPage) {
--index;
@@ -268,7 +269,7 @@ public virtual PdfPage RemovePage(int pageNum) {
/// Generate PdfPages tree.
///
/// root
- /// PdfPages
+ ///
///
/// in case empty document
protected internal virtual PdfObject GenerateTree() {
diff --git a/itext/itext.kernel/itext/kernel/pdf/PdfReader.cs b/itext/itext.kernel/itext/kernel/pdf/PdfReader.cs
index d33c574167..f95396941b 100644
--- a/itext/itext.kernel/itext/kernel/pdf/PdfReader.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/PdfReader.cs
@@ -122,7 +122,6 @@ public PdfReader(IRandomAccessSource byteSource, ReaderProperties properties) {
///
/// properties of the created reader
/// on error
- /// on error
public PdfReader(Stream @is, ReaderProperties properties)
: this(new RandomAccessSourceFactory().CreateSource(@is), properties) {
}
@@ -135,7 +134,6 @@ public PdfReader(Stream @is, ReaderProperties properties)
/// if user doesn't want to close stream, he should set closeStream=false;
///
/// on error
- /// on error
public PdfReader(Stream @is)
: this(@is, new ReaderProperties()) {
}
@@ -212,7 +210,6 @@ public virtual long GetLastXref() {
/// true if to get decoded stream bytes, false if to leave it originally encoded.
/// byte[]
///
- ///
public virtual byte[] ReadStreamBytes(PdfStream stream, bool decode) {
byte[] b = ReadStreamBytesRaw(stream);
if (decode && b != null) {
@@ -288,7 +285,6 @@ public virtual byte[] ReadStreamBytesRaw(PdfStream stream) {
/// true if to get decoded stream, false if to leave it originally encoded.
/// InputStream
///
- ///
public virtual Stream ReadStream(PdfStream stream, bool decode) {
byte[] bytes = ReadStreamBytes(stream, decode);
return bytes != null ? new MemoryStream(bytes) : null;
@@ -473,6 +469,9 @@ private void ReadDecryptObj() {
encrypted = true;
PdfName filter = enc.GetAsName(PdfName.Filter);
if (PdfName.Adobe_PubSec.Equals(filter)) {
+ if (properties.certificate == null) {
+ throw new PdfException(PdfException.CertificateIsNotProvidedDocumentIsEncryptedWithPublicKeyCertificate);
+ }
decrypt = new PdfEncryption(enc, properties.certificateKey, properties.certificate);
}
else {
@@ -516,7 +515,7 @@ protected internal virtual void ReadObjectStream(PdfStream objectStream) {
address[k] = tokens.GetIntValue() + first;
}
if (!ok) {
- throw new PdfException(PdfException.ErrorReadingObjectStream);
+ throw new PdfException(PdfException.ErrorWhileReadingObjectStream);
}
for (int k_1 = 0; k_1 < n; ++k_1) {
tokens.Seek(address[k_1]);
@@ -602,7 +601,7 @@ protected internal virtual PdfObject ReadObject(bool readAsDirect, bool objStm)
pdfString.SetDecryptInfoNum(currentIndirectReference.GetObjNumber());
pdfString.SetDecryptInfoGen(currentIndirectReference.GetGenNumber());
}
- return properties.password == null || objStm ? pdfString : pdfString.Decrypt(decrypt);
+ return !IsEncrypted() || objStm ? pdfString : pdfString.Decrypt(decrypt);
}
case PdfTokenizer.TokenType.Name: {
@@ -805,6 +804,22 @@ protected internal virtual PdfDictionary ReadXrefSection() {
tokens.NextValidToken();
int gen = tokens.GetIntValue();
tokens.NextValidToken();
+ if (pos == 0L && gen == 65535 && num == 1) {
+ // Very rarely can an XREF have an incorrect start number. (SUP-1557)
+ // e.g.
+ // xref
+ // 1 13
+ // 0000000000 65535 f
+ // 0000000009 00000 n
+ // 0000215136 00000 n
+ // [...]
+ // Because of how iText reads (and initializes) the XREF, this will lead to the XREF having two 0000 65535 entries.
+ // This throws off the parsing and other operations you'd like to perform.
+ // To fix this we reset our index and decrease the limit when we've encountered the magic entry at position 1.
+ num = 0;
+ end--;
+ continue;
+ }
PdfIndirectReference reference = xref.Get(num);
if (reference == null) {
reference = new PdfIndirectReference(pdfDocument, num, gen, pos);
@@ -821,7 +836,7 @@ protected internal virtual PdfDictionary ReadXrefSection() {
if (tokens.TokenValueEqualsTo(PdfTokenizer.N)) {
if (xref.Get(num) == null) {
if (pos == 0) {
- tokens.ThrowError(PdfException.FilePosition0CrossReferenceEntryInThisXrefSubsection);
+ tokens.ThrowError(PdfException.FilePosition1CrossReferenceEntryInThisXrefSubsection);
}
xref.Add(reference);
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/PdfResources.cs b/itext/itext.kernel/itext/kernel/pdf/PdfResources.cs
index 09b0f98f1f..48c1905130 100644
--- a/itext/itext.kernel/itext/kernel/pdf/PdfResources.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/PdfResources.cs
@@ -43,12 +43,22 @@ source product.
*/
using System;
using System.Collections.Generic;
+using iText.IO.Util;
+using iText.Kernel;
using iText.Kernel.Font;
using iText.Kernel.Pdf.Colorspace;
using iText.Kernel.Pdf.Extgstate;
using iText.Kernel.Pdf.Xobject;
namespace iText.Kernel.Pdf {
+ ///
+ /// Wrapper class that represent resource dictionary - that define named resources
+ /// used by content streams operators.
+ ///
+ ///
+ /// Wrapper class that represent resource dictionary - that define named resources
+ /// used by content streams operators. (ISO 32000-1, 7.8.3 Resource Dictionaries)
+ ///
public class PdfResources : PdfObjectWrapper {
private const String F = "F";
@@ -96,35 +106,130 @@ public class PdfResources : PdfObjectWrapper {
private bool isModified = false;
+ /// Creates new instance from given dictionary.
+ ///
+ /// the
+ ///
+ /// object from which the resource object will be created.
+ ///
public PdfResources(PdfDictionary pdfObject)
: base(pdfObject) {
BuildResources(pdfObject);
}
+ /// Creates new instance from empty dictionary.
public PdfResources()
: this(new PdfDictionary()) {
}
- /// Add font to resources and register PdfFont in the document for further flushing.
- /// font resource name.
+ /// Adds font to resources and register PdfFont in the document for further flushing.
+ /// added font resource name.
public virtual PdfName AddFont(PdfDocument pdfDocument, PdfFont font) {
pdfDocument.GetDocumentFonts().Add(font);
return AddResource(font, fontNamesGen);
}
+ ///
+ /// Adds
+ ///
+ /// object to the resources.
+ ///
+ ///
+ /// the
+ ///
+ /// to add.
+ ///
+ /// added image resource name.
public virtual PdfName AddImage(PdfImageXObject image) {
return AddResource(image, imageNamesGen);
}
+ ///
+ /// Adds
+ ///
+ /// to the resources as image.
+ ///
+ ///
+ /// the
+ ///
+ /// to add.
+ ///
+ /// added image resources name.
+ public virtual PdfName AddImage(PdfStream image) {
+ return AddResource(image, imageNamesGen);
+ }
+
+ ///
+ /// Adds
+ ///
+ /// to the resources as image.
+ ///
+ ///
+ /// the
+ ///
+ /// to add. Should be
+ ///
+ /// .
+ ///
+ /// added image resources name.
+ [System.ObsoleteAttribute(@"Will be removed in iText 7.1. Use more safe AddImage(PdfStream) instead.")]
public virtual PdfName AddImage(PdfObject image) {
+ if (image.GetObjectType() != PdfObject.STREAM) {
+ throw new PdfException(PdfException.CannotAddNonStreamImageToResources1).SetMessageParams(image.GetType().
+ ToString());
+ }
return AddResource(image, imageNamesGen);
}
+ ///
+ /// Adds
+ ///
+ /// object to the resources.
+ ///
+ ///
+ /// the
+ ///
+ /// to add.
+ ///
+ /// added form resource name.
public virtual PdfName AddForm(PdfFormXObject form) {
return AddResource(form, formNamesGen);
}
+ ///
+ /// Adds
+ ///
+ /// to the resources as form.
+ ///
+ ///
+ /// the
+ ///
+ /// to add.
+ ///
+ /// added form resources name.
+ public virtual PdfName AddForm(PdfStream form) {
+ return AddResource(form, formNamesGen);
+ }
+
+ ///
+ /// Adds
+ ///
+ /// to the resources as form.
+ ///
+ ///
+ /// the
+ ///
+ /// to add. Should be
+ ///
+ /// .
+ ///
+ /// added form resources name.
+ [System.ObsoleteAttribute(@"Will be removed in iText 7.1. Use more safe AddForm(PdfStream) instead.")]
public virtual PdfName AddForm(PdfObject form) {
+ if (form.GetObjectType() != PdfObject.STREAM) {
+ throw new PdfException(PdfException.CannotAddNonStreamFormToResources1).SetMessageParams(form.GetType().ToString
+ ());
+ }
return AddResource(form, formNamesGen);
}
@@ -150,39 +255,234 @@ public virtual PdfName AddForm(PdfFormXObject form, PdfName name) {
return name;
}
+ ///
+ /// Adds
+ ///
+ /// object to the resources.
+ ///
+ ///
+ /// the
+ ///
+ /// to add.
+ ///
+ /// added graphics state parameter dictionary resource name.
public virtual PdfName AddExtGState(PdfExtGState extGState) {
return AddResource(extGState, egsNamesGen);
}
+ ///
+ /// Adds
+ ///
+ /// to the resources as graphics state parameter dictionary.
+ ///
+ ///
+ /// the
+ ///
+ /// to add.
+ ///
+ /// added graphics state parameter dictionary resources name.
+ public virtual PdfName AddExtGState(PdfDictionary extGState) {
+ return AddResource(extGState, egsNamesGen);
+ }
+
+ ///
+ /// Adds
+ ///
+ /// to the resources as graphics state parameter dictionary.
+ ///
+ ///
+ /// the
+ ///
+ /// to add. Should be
+ ///
+ /// .
+ ///
+ /// added graphics state parameter dictionary resources name.
+ [System.ObsoleteAttribute(@"Will be removed in iText 7.1. Use more safe AddExtGState(PdfDictionary) instead."
+ )]
public virtual PdfName AddExtGState(PdfObject extGState) {
+ if (extGState.GetObjectType() != PdfObject.DICTIONARY) {
+ throw new PdfException(PdfException.CannotAddNonDictionaryExtGStateToResources1).SetMessageParams(extGState
+ .GetType().ToString());
+ }
return AddResource(extGState, egsNamesGen);
}
+ ///
+ /// Adds
+ ///
+ /// to the resources as properties list.
+ ///
+ ///
+ /// the
+ ///
+ /// to add.
+ ///
+ /// added properties list resources name.
+ public virtual PdfName AddProperties(PdfDictionary properties) {
+ return AddResource(properties, propNamesGen);
+ }
+
+ ///
+ /// Adds
+ ///
+ /// to the resources as properties list.
+ ///
+ ///
+ /// the
+ ///
+ /// to add. Should be
+ ///
+ /// .
+ ///
+ /// added properties list resources name.
+ [System.ObsoleteAttribute(@"Will be removed in iText 7.1. Use more safe AddProperties(PdfDictionary) instead."
+ )]
public virtual PdfName AddProperties(PdfObject properties) {
+ if (properties.GetObjectType() != PdfObject.DICTIONARY) {
+ throw new PdfException(PdfException.CannotAddNonDictionaryPropertiesToResources1).SetMessageParams(properties
+ .GetType().ToString());
+ }
return AddResource(properties, propNamesGen);
}
+ ///
+ /// Adds
+ ///
+ /// object to the resources.
+ ///
+ ///
+ /// the
+ ///
+ /// to add.
+ ///
+ /// added color space resource name.
public virtual PdfName AddColorSpace(PdfColorSpace cs) {
return AddResource(cs, csNamesGen);
}
+ ///
+ /// Adds
+ ///
+ /// to the resources as color space.
+ ///
+ ///
+ /// the
+ ///
+ /// to add.
+ ///
+ /// added color space resources name.
public virtual PdfName AddColorSpace(PdfObject colorSpace) {
return AddResource(colorSpace, csNamesGen);
}
+ ///
+ /// Adds
+ ///
+ /// object to the resources.
+ ///
+ ///
+ /// the
+ ///
+ /// to add.
+ ///
+ /// added pattern resource name.
public virtual PdfName AddPattern(PdfPattern pattern) {
return AddResource(pattern, patternNamesGen);
}
+ ///
+ /// Adds
+ ///
+ /// to the resources as pattern.
+ ///
+ ///
+ /// the
+ ///
+ /// to add.
+ ///
+ /// added pattern resources name.
+ public virtual PdfName AddPattern(PdfDictionary pattern) {
+ return AddResource(pattern, patternNamesGen);
+ }
+
+ ///
+ /// Adds
+ ///
+ /// to the resources as pattern.
+ ///
+ ///
+ /// the
+ ///
+ /// to add. Should be
+ ///
+ /// or
+ ///
+ /// .
+ ///
+ /// added pattern resources name.
+ [System.ObsoleteAttribute(@"Will be removed in iText 7.1. Use more safe AddPattern(PdfDictionary) instead."
+ )]
public virtual PdfName AddPattern(PdfObject pattern) {
+ if (pattern is PdfDictionary) {
+ throw new PdfException(PdfException.CannotAddNonDictionaryPatternToResources1).SetMessageParams(pattern.GetType
+ ().ToString());
+ }
return AddResource(pattern, patternNamesGen);
}
+ ///
+ /// Adds
+ ///
+ /// object to the resources.
+ ///
+ ///
+ /// the
+ ///
+ /// to add.
+ ///
+ /// added shading resource name.
public virtual PdfName AddShading(PdfShading shading) {
return AddResource(shading, shadingNamesGen);
}
+ ///
+ /// Adds
+ ///
+ /// to the resources as shading dictionary.
+ ///
+ ///
+ /// the
+ ///
+ /// to add.
+ ///
+ /// added shading dictionary resources name.
+ public virtual PdfName AddShading(PdfDictionary shading) {
+ return AddResource(shading, shadingNamesGen);
+ }
+
+ ///
+ /// Adds
+ ///
+ /// to the resources as shading dictionary.
+ ///
+ ///
+ /// the
+ ///
+ /// to add. Should be
+ ///
+ /// or
+ ///
+ /// .
+ ///
+ /// added shading dictionary resources name.
+ [System.ObsoleteAttribute(@"Will be removed in iText 7.1. Use more safe AddShading(PdfDictionary) instead."
+ )]
public virtual PdfName AddShading(PdfObject shading) {
+ if (shading is PdfDictionary) {
+ throw new PdfException(PdfException.CannotAddNonDictionaryShadingToResources1).SetMessageParams(shading.GetType
+ ().ToString());
+ }
return AddResource(shading, shadingNamesGen);
}
@@ -202,31 +502,84 @@ protected internal virtual void SetModified(bool isModified) {
this.isModified = isModified;
}
- /// Sets the default color space.
- ///
- ///
- ///
+ /// Sets the default color space (see ISO-320001 Paragraph 8.6.5.6).
+ ///
+ /// the name of Default Color Space. Should be
+ ///
+ /// ,
+ ///
+ /// , or
+ ///
+ /// .
+ ///
+ /// the value of the default color space to be set.
+ [System.ObsoleteAttribute(@"Will be removed in iText 7.1.0. Use SetDefaultGray(iText.Kernel.Pdf.Colorspace.PdfColorSpace) ,SetDefaultRgb(iText.Kernel.Pdf.Colorspace.PdfColorSpace) or SetDefaultCmyk(iText.Kernel.Pdf.Colorspace.PdfColorSpace) instead."
+ )]
public virtual void SetDefaultColorSpace(PdfName defaultCsKey, PdfColorSpace defaultCsValue) {
+ if (!defaultCsKey.Equals(PdfName.DefaultCMYK) && !defaultCsKey.Equals(PdfName.DefaultGray) && !defaultCsKey
+ .Equals(PdfName.DefaultRGB)) {
+ throw new PdfException(PdfException.UnsupportedDefaultColorSpaceName1).SetMessageParams(defaultCsKey.ToString
+ ());
+ }
AddResource(defaultCsValue.GetPdfObject(), PdfName.ColorSpace, defaultCsKey);
}
+ /// Sets the value of default Gray Color Space (see ISO-320001 Paragraph 8.6.5.6).
+ /// the color space to set.
public virtual void SetDefaultGray(PdfColorSpace defaultCs) {
- SetDefaultColorSpace(PdfName.DefaultGray, defaultCs);
+ AddResource(defaultCs.GetPdfObject(), PdfName.ColorSpace, PdfName.DefaultGray);
}
+ /// Sets the value of default RGB Color Space (see ISO-320001 Paragraph 8.6.5.6).
+ /// the color space to set.
public virtual void SetDefaultRgb(PdfColorSpace defaultCs) {
- SetDefaultColorSpace(PdfName.DefaultRGB, defaultCs);
+ AddResource(defaultCs.GetPdfObject(), PdfName.ColorSpace, PdfName.DefaultRGB);
}
+ /// Sets the value of default CMYK Color Space (see ISO-320001 Paragraph 8.6.5.6).
+ /// the color space to set.
public virtual void SetDefaultCmyk(PdfColorSpace defaultCs) {
- SetDefaultColorSpace(PdfName.DefaultCMYK, defaultCs);
+ AddResource(defaultCs.GetPdfObject(), PdfName.ColorSpace, PdfName.DefaultCMYK);
}
+ ///
+ /// Gets the mapped resource name of the
+ ///
+ /// under the given wrapper.
+ ///
+ ///
+ /// Note: if the name for the object won't be found, then the name of object's Indirect Reference will be searched.
+ ///
+ ///
+ /// the wrapper of the
+ ///
+ /// , for which the name will be searched.
+ ///
+ ///
+ ///
+ /// the mapped resource name or
+ ///
+ /// if object isn't added to resources.
+ ///
public virtual PdfName GetResourceName(PdfObjectWrapper resource)
where T : PdfObject {
- return resourceToName.Get(resource.GetPdfObject());
+ return GetResourceName(resource.GetPdfObject());
}
+ ///
+ /// Gets the mapped resource name of the given
+ ///
+ /// .
+ ///
+ ///
+ /// Note: if the name for the object won't be found, then the name of object's Indirect Reference will be searched.
+ ///
+ /// the object, for which the name will be searched.
+ ///
+ /// the mapped resource name or
+ ///
+ /// if object isn't added to resources.
+ ///
public virtual PdfName GetResourceName(PdfObject resource) {
PdfName resName = resourceToName.Get(resource);
if (resName == null) {
@@ -235,6 +588,8 @@ public virtual PdfName GetResourceName(PdfObject resource) {
return resName;
}
+ /// Gets the names of all the added resources.
+ /// the name of all the added resources.
public virtual ICollection GetResourceNames() {
ICollection names = new SortedSet();
// TODO: isn't it better to use HashSet? Do we really need certain order?
@@ -244,44 +599,76 @@ public virtual ICollection GetResourceNames() {
return names;
}
+ /// Gets the array of predefined procedure set names (see ISO-320001 Paragraph 14.2).
+ /// the array of predefined procedure set names.
public virtual PdfArray GetProcSet() {
return GetPdfObject().GetAsArray(PdfName.ProcSet);
}
+ /// Sets the array of predefined procedure set names (see ISO-320001 Paragraph 14.2).
+ /// the array of predefined procedure set names to be set.
public virtual void SetProcSet(PdfArray array) {
GetPdfObject().Put(PdfName.ProcSet, array);
}
+ /// Gets the names of all resources of specified type.
+ ///
+ /// the resource type. Should be
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ /// .
+ ///
+ ///
+ /// set of resources name of corresponding type. May be empty.
+ /// Will be empty in case of incorrect resource type.
+ ///
public virtual ICollection GetResourceNames(PdfName resType) {
PdfDictionary resourceCategory = GetPdfObject().GetAsDictionary(resType);
return resourceCategory == null ? new SortedSet() : resourceCategory.KeySet();
}
// TODO: TreeSet or HashSet enough?
- public virtual PdfDictionary GetResource(PdfName pdfName) {
- return GetPdfObject().GetAsDictionary(pdfName);
- }
-
- // public List getFonts(boolean updateFonts) throws IOException {
- // if (updateFonts) {
- // getPdfObject().remove(PdfName.Font);
- // PdfDictionary fMap = getResource(PdfName.Font);
- // if (fMap != null) {
- // addFont(fMap.entrySet());
- // }
- // PdfDictionary xMap = getResource(PdfName.XObject);
- // if (xMap != null && !xMap.isEmpty()) {
- // callXObjectFont(xMap.entrySet(), new HashSet());
- // }
- // }
- // List fonts = new ArrayList<>();
- // for (PdfObject fontDict : getPdfObject().getAsDictionary(PdfName.Font).values()) {
- // if (fontDict.isDictionary()) {
- // fonts.add((PdfDictionary) fontDict);
- // }
- // }
- // return fonts;
- // }
+ ///
+ /// Get the
+ ///
+ /// object that that contain resources of specified type.
+ ///
+ ///
+ /// the resource type. Should be
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ /// .
+ ///
+ ///
+ /// the
+ ///
+ /// object containing all resources of specified type,
+ /// or
+ ///
+ /// in case of incorrect resource type.
+ ///
+ public virtual PdfDictionary GetResource(PdfName resType) {
+ return GetPdfObject().GetAsDictionary(resType);
+ }
+
protected internal override bool IsWrappedObjectMustBeIndirect() {
return false;
}
@@ -297,7 +684,7 @@ protected internal virtual void AddResource(PdfObject resource, PdfName resType,
CheckAndResolveCircularReferences(resource);
}
if (readOnly) {
- SetPdfObject(new PdfDictionary(GetPdfObject()));
+ SetPdfObject(GetPdfObject().Clone(JavaCollectionsUtil.EmptyList()));
BuildResources(GetPdfObject());
isModified = true;
readOnly = false;
@@ -343,47 +730,6 @@ protected internal virtual void BuildResources(PdfDictionary dictionary) {
}
}
- // private void addFont(Collection entrySet) throws IOException {
- // for (PdfObject entry : entrySet) {
- // PdfDictionary fonts = getPdfObject().getAsDictionary(PdfName.Font);
- // if (entry.isIndirectReference() && !fonts.containsValue(entry)) {
- // fonts.put((PdfIndirectReference) entry.getValue(),
- // PdfFont.createFont((PdfDictionary) ((PdfIndirectReference) entry.getValue()).getRefersTo()));
- // } else if (entry.getValue().isDictionary()) {
- // PdfFont font = PdfFont.createFont((PdfDictionary) entry.getValue());
- // fontsMap.put(font.getPdfObject().getIndirectReference(), font);
- // }
- // }
- // }
- // private void addFontFromXObject(Set> entrySet, Set visitedResources) throws IOException {
- // PdfDictionary xObject = new PdfDictionary(entrySet);
- // PdfDictionary resources = xObject.getAsDictionary(PdfName.Resources);
- // if (resources == null)
- // return;
- // PdfDictionary font = resources.getAsDictionary(PdfName.Font);
- //
- // if (font != null) {
- // addFont(font.values());
- // }
- // PdfDictionary xobj = resources.getAsDictionary(PdfName.XObject);
- // if (xobj != null) {
- // if (visitedResources.add(xobj)) {
- // callXObjectFont(xobj.entrySet(), visitedResources);
- // visitedResources.remove(xobj);
- // } else {
- // throw new IOException(IOException.IllegalResourceTree);
- // }
- // }
- // }
- // private void callXObjectFont(Set> entrySet, Set visitedResources) throws IOException {
- // for (Map.Entry entry : entrySet) {
- // if (entry.getValue().isIndirectReference()) {
- // if (((PdfIndirectReference) entry.getValue()).getRefersTo().isStream()) {
- // addFontFromXObject(((PdfStream) ((PdfIndirectReference) entry.getValue()).getRefersTo()).entrySet(), visitedResources);
- // }
- // }
- // }
- // }
private void CheckAndResolveCircularReferences(PdfObject pdfObject) {
// Consider the situation when an XObject references the resources of the first page.
// We add this XObject to the first page, there is no need to resolve any circular references
@@ -424,11 +770,19 @@ internal class ResourceNameGenerator {
/// class.
///
///
- /// Type of resource (
+ /// Type of resource. Should be
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ /// ,
///
/// ,
///
- /// etc).
+ /// .
///
/// Prefix used for generating names.
///
@@ -447,23 +801,52 @@ public ResourceNameGenerator(PdfName resourceType, String prefix, int seed) {
/// class.
///
///
- /// Type of resource (
+ /// Type of resource. Should be
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ /// ,
///
/// ,
///
- /// etc).
+ /// .
///
/// Prefix used for generating names.
public ResourceNameGenerator(PdfName resourceType, String prefix)
: this(resourceType, prefix, 1) {
}
+ /// Gets the resource type of generator.
+ ///
+ /// Type of resource. May be
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ /// .
+ ///
public virtual PdfName GetResourceType() {
return resourceType;
}
/// Generates new (unique) resource name.
- /// New (unique) resource name.
+ ///
+ /// the
+ ///
+ /// object for which name will be generated.
+ ///
+ /// new (unique) resource name.
public virtual PdfName Generate(PdfResources resources) {
PdfName newName = new PdfName(prefix + counter++);
PdfDictionary r = resources.GetPdfObject();
diff --git a/itext/itext.kernel/itext/kernel/pdf/PdfStream.cs b/itext/itext.kernel/itext/kernel/pdf/PdfStream.cs
index 18e9ee3c98..f1c79bc6fd 100644
--- a/itext/itext.kernel/itext/kernel/pdf/PdfStream.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/PdfStream.cs
@@ -72,7 +72,6 @@ public class PdfStream : PdfDictionary {
///
/// the compression level (0 = best speed, 9 = best compression, -1 is default)
///
- /// on error.
public PdfStream(byte[] bytes, int compressionLevel)
: base() {
// Output stream associated with PDF stream.
@@ -111,7 +110,6 @@ public PdfStream(byte[] bytes)
/// the data to write to this stream
/// the compression level (0 = best speed, 9 = best compression, -1 is default)
///
- /// on error.
public PdfStream(PdfDocument doc, Stream inputStream, int compressionLevel)
: base() {
if (doc == null) {
@@ -141,7 +139,6 @@ public PdfStream(PdfDocument doc, Stream inputStream, int compressionLevel)
///
///
/// the data to write to this stream
- /// on error.
public PdfStream(PdfDocument doc, Stream inputStream)
: this(doc, inputStream, CompressionConstants.UNDEFINED_COMPRESSION) {
}
@@ -153,7 +150,6 @@ public PdfStream(PdfDocument doc, Stream inputStream)
///
/// the compression level (0 = best speed, 9 = best compression, -1 is default)
///
- /// on error.
public PdfStream(int compressionLevel)
: this(null, compressionLevel) {
}
@@ -219,7 +215,6 @@ public virtual int GetLength() {
/// Gets decoded stream bytes.
/// byte[]
- ///
public virtual byte[] GetBytes() {
return GetBytes(true);
}
@@ -238,7 +233,6 @@ public virtual byte[] GetBytes() {
/// InputStream
/// .
///
- /// error.
public virtual byte[] GetBytes(bool decoded) {
if (inputStream != null) {
LoggerFactory.GetLogger(typeof(iText.Kernel.Pdf.PdfStream)).Warn("PdfStream was created by InputStream." +
@@ -300,7 +294,7 @@ public virtual void SetData(byte[] bytes) {
///
public virtual void SetData(byte[] bytes, bool append) {
if (inputStream != null) {
- throw new PdfException(PdfException.CannotSetDataToPdfstreamWhichWasCreatedByInputstream);
+ throw new PdfException(PdfException.CannotSetDataToPdfstreamWhichWasCreatedByInputStream);
}
bool outputStreamIsUninitialized = outputStream == null;
if (outputStreamIsUninitialized) {
@@ -392,7 +386,6 @@ protected internal virtual long GetOffset() {
/// PdfReader.checkPdfStreamLength()
/// method.
///
- /// error.
protected internal virtual void UpdateLength(int length) {
this.length = length;
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/PdfString.cs b/itext/itext.kernel/itext/kernel/pdf/PdfString.cs
index 0ceb6b15db..d608819e13 100644
--- a/itext/itext.kernel/itext/kernel/pdf/PdfString.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/PdfString.cs
@@ -70,8 +70,6 @@ namespace iText.Kernel.Pdf {
///
///
public class PdfString : PdfPrimitiveObject {
- private static String defaultCharset = "UTF-8";
-
protected internal String value;
protected internal String encoding;
@@ -156,9 +154,13 @@ public virtual String GetEncoding() {
/// Sets the encoding of this string.
/// NOTE. Byte content will be removed.
///
+ [System.ObsoleteAttribute(@"Create a new instance with PdfString(System.String, System.String) instead.")]
public virtual void SetEncoding(String encoding) {
+ if (value == null) {
+ GenerateValue();
+ this.content = null;
+ }
this.encoding = encoding;
- this.content = null;
}
///
@@ -240,6 +242,26 @@ public override PdfObject CopyTo(PdfDocument document, bool allowDuplicating) {
return (iText.Kernel.Pdf.PdfString)base.CopyTo(document, allowDuplicating);
}
+ public override bool Equals(Object o) {
+ if (this == o) {
+ return true;
+ }
+ if (o == null || GetType() != o.GetType()) {
+ return false;
+ }
+ iText.Kernel.Pdf.PdfString that = (iText.Kernel.Pdf.PdfString)o;
+ String v1 = GetValue();
+ String v2 = that.GetValue();
+ if (v1 != null && v1.Equals(v2)) {
+ String e1 = GetEncoding();
+ String e2 = that.GetEncoding();
+ if ((e1 == null && e2 == null) || (e1 != null && e1.Equals(e2))) {
+ return true;
+ }
+ }
+ return false;
+ }
+
public override String ToString() {
if (value == null) {
return iText.IO.Util.JavaUtil.GetStringForBytes(PdfTokenizer.DecodeStringContent(content, hexWriting));
@@ -249,6 +271,13 @@ public override String ToString() {
}
}
+ public override int GetHashCode() {
+ String v = GetValue();
+ String e = GetEncoding();
+ int result = v != null ? v.GetHashCode() : 0;
+ return 31 * result + (e != null ? e.GetHashCode() : 0);
+ }
+
protected internal virtual void GenerateValue() {
System.Diagnostics.Debug.Assert(content != null, "No byte[] content to generate value");
value = PdfEncodings.ConvertToString(PdfTokenizer.DecodeStringContent(content, hexWriting), null);
diff --git a/itext/itext.kernel/itext/kernel/pdf/PdfVersion.cs b/itext/itext.kernel/itext/kernel/pdf/PdfVersion.cs
index 2975b99f39..bc2d3423c3 100644
--- a/itext/itext.kernel/itext/kernel/pdf/PdfVersion.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/PdfVersion.cs
@@ -45,14 +45,14 @@ source product.
using System.Collections.Generic;
namespace iText.Kernel.Pdf {
- /// Enum listing all official PDF versions.
+ /// This class represents all official PDF versions.
public class PdfVersion : IComparable {
private static readonly IList values = new List(
);
public static readonly iText.Kernel.Pdf.PdfVersion PDF_1_0 = CreatePdfVersion(1, 0);
- public static readonly iText.Kernel.Pdf.PdfVersion PDF_1_1 = CreatePdfVersion(1, 0);
+ public static readonly iText.Kernel.Pdf.PdfVersion PDF_1_1 = CreatePdfVersion(1, 1);
public static readonly iText.Kernel.Pdf.PdfVersion PDF_1_2 = CreatePdfVersion(1, 2);
@@ -72,7 +72,7 @@ public class PdfVersion : IComparable {
private int minor;
- /// Creates a PdfVersion enum.
+ /// Creates a PdfVersion class.
/// major version number
/// minor version number
private PdfVersion(int major, int minor) {
@@ -89,7 +89,7 @@ public virtual PdfName ToPdfName() {
}
///
- /// Creates a PdfVersion enum from a String object if the specified version
+ /// Creates a PdfVersion class from a String object if the specified version
/// can be found.
///
/// version number
@@ -104,7 +104,7 @@ public static iText.Kernel.Pdf.PdfVersion FromString(String value) {
}
///
- /// Creates a PdfVersion enum from a
+ /// Creates a PdfVersion class from a
///
/// object if the specified version
/// can be found.
diff --git a/itext/itext.kernel/itext/kernel/pdf/PdfWriter.cs b/itext/itext.kernel/itext/kernel/pdf/PdfWriter.cs
index 07bbbcceea..b2b46ddbe6 100644
--- a/itext/itext.kernel/itext/kernel/pdf/PdfWriter.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/PdfWriter.cs
@@ -57,11 +57,6 @@ public class PdfWriter : PdfOutputStream {
private static readonly byte[] endobj = ByteUtils.GetIsoBytes("\nendobj\n");
- private Dictionary streamMap = new Dictionary();
-
- private readonly IntHashtable serialized = new IntHashtable();
-
private PdfOutputStream duplicateStream = null;
protected internal WriterProperties properties;
@@ -73,9 +68,21 @@ public class PdfWriter : PdfOutputStream {
///
internal PdfObjectStream objectStream = null;
+ /// Is used to avoid duplications on object copying.
+ ///
+ /// Is used to avoid duplications on object copying.
+ /// It stores hashes of the indirect reference from the source document and the corresponding
+ /// indirect references of the copied objects from the new document.
+ ///
protected internal IDictionary copiedObjects = new Dictionary();
+ /// Is used in smart mode to store serialized objects content.
+ private Dictionary serializedContentToObjectRef = new
+ Dictionary();
+
+ private Dictionary objectRefToSerializedContent = new Dictionary();
+
protected internal bool isUserWarnedAboutAcroFormCopying;
public PdfWriter(Stream os)
@@ -83,7 +90,7 @@ public PdfWriter(Stream os)
}
public PdfWriter(Stream os, WriterProperties properties)
- : base(os) {
+ : base(FileUtil.WrapWithBufferedOutputStream(os)) {
// For internal usage only
//forewarned is forearmed
this.properties = properties;
@@ -185,16 +192,25 @@ public override void Write(byte[] b, int off, int len) {
///
public override void Close() {
- base.Close();
- if (duplicateStream != null) {
- duplicateStream.Close();
+ try {
+ base.Close();
+ }
+ finally {
+ try {
+ if (duplicateStream != null) {
+ duplicateStream.Close();
+ }
+ }
+ catch (Exception ex) {
+ ILogger logger = LoggerFactory.GetLogger(typeof(iText.Kernel.Pdf.PdfWriter));
+ logger.Error("Closing of the duplicatedStream failed.", ex);
+ }
}
}
/// Gets the current object stream.
/// object stream.
///
- ///
internal virtual PdfObjectStream GetObjectStream() {
if (!IsFullCompression()) {
return null;
@@ -216,8 +232,7 @@ internal virtual PdfObjectStream GetObjectStream() {
///
/// object to flush.
/// indicates whether object can be placed into object stream.
- ///
- ///
+ /// on error.
protected internal virtual void FlushObject(PdfObject pdfObject, bool canBeInObjStm) {
PdfIndirectReference indirectReference = pdfObject.GetIndirectReference();
if (IsFullCompression() && canBeInObjStm) {
@@ -276,28 +291,36 @@ protected internal virtual PdfObject CopyObject(PdfObject obj, PdfDocument docum
obj = PdfNull.PDF_NULL;
}
PdfIndirectReference indirectReference = obj.GetIndirectReference();
- PdfIndirectReference copiedIndirectReference;
int copyObjectKey = 0;
- if (!allowDuplicating && indirectReference != null) {
- copyObjectKey = GetCopyObjectKey(obj);
- copiedIndirectReference = copiedObjects.Get(copyObjectKey);
+ bool tryToFindDuplicate = !allowDuplicating && indirectReference != null;
+ if (tryToFindDuplicate) {
+ copyObjectKey = CalculateIndRefKey(indirectReference);
+ PdfIndirectReference copiedIndirectReference = copiedObjects.Get(copyObjectKey);
if (copiedIndirectReference != null) {
return copiedIndirectReference.GetRefersTo();
}
}
- if (properties.smartMode && !CheckTypeOfPdfDictionary(obj, PdfName.Page)) {
- PdfObject copiedObject = SmartCopyObject(obj);
- if (copiedObject != null) {
- return copiedObjects.Get(GetCopyObjectKey(copiedObject)).GetRefersTo();
+ if (obj.IsDictionary()) {
+ PdfName subtype = ((PdfDictionary)obj).GetAsName(PdfName.Subtype);
+ if (subtype != null && subtype.Equals(PdfName.Widget)) {
+ tryToFindDuplicate = false;
+ }
+ }
+ if (properties.smartMode && tryToFindDuplicate && !CheckTypeOfPdfDictionary(obj, PdfName.Page)) {
+ PdfIndirectReference copiedObjectRef = TryToFindPreviouslyCopiedEqualObject(obj);
+ if (copiedObjectRef != null) {
+ PdfIndirectReference copiedIndirectReference = copiedObjects.Get(CalculateIndRefKey(copiedObjectRef));
+ copiedObjects[copyObjectKey] = copiedIndirectReference;
+ return copiedIndirectReference.GetRefersTo();
}
}
PdfObject newObject = obj.NewInstance();
if (indirectReference != null) {
if (copyObjectKey == 0) {
- copyObjectKey = GetCopyObjectKey(obj);
+ copyObjectKey = CalculateIndRefKey(indirectReference);
}
- PdfIndirectReference reference = newObject.MakeIndirect(document).GetIndirectReference();
- copiedObjects[copyObjectKey] = reference;
+ PdfIndirectReference indRef = newObject.MakeIndirect(document).GetIndirectReference();
+ copiedObjects[copyObjectKey] = indRef;
}
newObject.CopyContent(obj, document);
return newObject;
@@ -306,7 +329,6 @@ protected internal virtual PdfObject CopyObject(PdfObject obj, PdfDocument docum
/// Writes object to body of PDF document.
/// object to write.
///
- ///
protected internal virtual void WriteToBody(PdfObject pdfObj) {
if (crypto != null) {
crypto.SetHashKeyForNextObject(pdfObj.GetIndirectReference().GetObjNumber(), pdfObj.GetIndirectReference()
@@ -319,14 +341,12 @@ protected internal virtual void WriteToBody(PdfObject pdfObj) {
}
/// Writes PDF header.
- ///
protected internal virtual void WriteHeader() {
WriteByte('%').WriteString(document.GetPdfVersion().ToString()).WriteString("\n%\u00e2\u00e3\u00cf\u00d3\n"
);
}
/// Flushes all objects which have not been flushed yet.
- ///
protected internal virtual void FlushWaitingObjects() {
PdfXrefTable xref = document.GetXref();
bool needFlush = true;
@@ -351,7 +371,6 @@ protected internal virtual void FlushWaitingObjects() {
/// Flushes all modified objects which have not been flushed yet.
/// Flushes all modified objects which have not been flushed yet. Used in case incremental updates.
- ///
protected internal virtual void FlushModifiedWaitingObjects() {
PdfXrefTable xref = document.GetXref();
for (int i = 1; i < xref.Size(); i++) {
@@ -369,6 +388,15 @@ protected internal virtual void FlushModifiedWaitingObjects() {
}
}
+ /// Calculates hash code for the indirect reference taking into account the document it belongs to.
+ /// object to be hashed.
+ /// calculated hash code.
+ protected internal static int CalculateIndRefKey(PdfIndirectReference indRef) {
+ int result = indRef.GetHashCode();
+ result = 31 * result + indRef.GetDocument().GetHashCode();
+ return result;
+ }
+
/// Calculates hash code for object to be copied.
///
/// Calculates hash code for object to be copied.
@@ -376,27 +404,41 @@ protected internal virtual void FlushModifiedWaitingObjects() {
///
/// object to be copied.
/// calculated hash code.
+ [System.ObsoleteAttribute(@"Functionality will be removed.")]
protected internal virtual int GetCopyObjectKey(PdfObject obj) {
- PdfIndirectReference reference;
- if (obj.IsIndirectReference()) {
- reference = (PdfIndirectReference)obj;
- }
- else {
- reference = obj.GetIndirectReference();
+ return CalculateIndRefKey(obj.GetIndirectReference());
+ }
+
+ /// Used in the smart mode.
+ ///
+ /// Used in the smart mode.
+ /// It serializes given object content and tries to find previously copied object with the same content.
+ /// If already copied object is not found, it saves current object serialized content into the map.
+ ///
+ /// an object to check if some other object with the same content was already copied.
+ /// indirect reference of the object with the same content, which already has a copy in the new document.
+ ///
+ private PdfIndirectReference TryToFindPreviouslyCopiedEqualObject(PdfObject @object) {
+ PdfWriter.SerializedPdfObject objectKey;
+ if (@object.IsStream() || @object.IsDictionary()) {
+ objectKey = new PdfWriter.SerializedPdfObject(@object, objectRefToSerializedContent);
+ PdfIndirectReference objectRef = serializedContentToObjectRef.Get(objectKey);
+ if (objectRef != null) {
+ return objectRef;
+ }
+ serializedContentToObjectRef[objectKey] = @object.GetIndirectReference();
}
- int result = reference.GetHashCode();
- result = 31 * result + reference.GetDocument().GetHashCode();
- return result;
+ return null;
}
private void MarkArrayContentToFlush(PdfArray array) {
- foreach (PdfObject item in array) {
- MarkObjectToFlush(item);
+ for (int i = 0; i < array.Size(); i++) {
+ MarkObjectToFlush(array.Get(i, false));
}
}
private void MarkDictionaryContentToFlush(PdfDictionary dictionary) {
- foreach (PdfObject item in dictionary.Values()) {
+ foreach (PdfObject item in dictionary.Values(false)) {
MarkObjectToFlush(item);
}
}
@@ -434,29 +476,6 @@ private iText.Kernel.Pdf.PdfWriter SetDebugMode() {
return this;
}
- private PdfObject SmartCopyObject(PdfObject obj) {
- PdfWriter.ByteStore streamKey;
- if (obj.IsStream()) {
- streamKey = new PdfWriter.ByteStore((PdfStream)obj, serialized);
- PdfIndirectReference streamRef = streamMap.Get(streamKey);
- if (streamRef != null) {
- return streamRef;
- }
- streamMap[streamKey] = obj.GetIndirectReference();
- }
- else {
- if (obj.IsDictionary()) {
- streamKey = new PdfWriter.ByteStore((PdfDictionary)obj, serialized);
- PdfIndirectReference streamRef = streamMap.Get(streamKey);
- if (streamRef != null) {
- return streamRef.GetRefersTo();
- }
- streamMap[streamKey] = obj.GetIndirectReference();
- }
- }
- return null;
- }
-
///
private byte[] GetDebugBytes() {
if (duplicateStream != null) {
@@ -473,14 +492,35 @@ private static bool CheckTypeOfPdfDictionary(PdfObject dictionary, PdfName expec
));
}
- internal class ByteStore {
- private readonly byte[] b;
+ internal class SerializedPdfObject {
+ private readonly byte[] serializedContent;
private readonly int hash;
private IDigest md5;
- private void SerObject(PdfObject obj, int level, ByteBufferOutputStream bb, IntHashtable serialized) {
+ private Dictionary objToSerializedContent;
+
+ internal SerializedPdfObject(PdfObject obj, Dictionary objToSerializedContent) {
+ System.Diagnostics.Debug.Assert(obj.IsDictionary() || obj.IsStream());
+ this.objToSerializedContent = objToSerializedContent;
+ try {
+ md5 = Org.BouncyCastle.Security.DigestUtilities.GetDigest("MD5");
+ }
+ catch (Exception e) {
+ throw new PdfException(e);
+ }
+ ByteBufferOutputStream bb = new ByteBufferOutputStream();
+ int level = 100;
+ SerObject(obj, level, bb);
+ this.serializedContent = bb.ToByteArray();
+ hash = CalculateHash(this.serializedContent);
+ md5 = null;
+ }
+
+ // TODO 2: object is not checked if it was already serialized on start, double work could be done
+ // TODO 3: indirect objects often stored multiple times as parts of the other objects
+ private void SerObject(PdfObject obj, int level, ByteBufferOutputStream bb) {
if (level <= 0) {
return;
}
@@ -490,21 +530,24 @@ private void SerObject(PdfObject obj, int level, ByteBufferOutputStream bb, IntH
}
PdfIndirectReference reference = null;
ByteBufferOutputStream savedBb = null;
+ int indRefKey = -1;
if (obj.IsIndirectReference()) {
reference = (PdfIndirectReference)obj;
- int key = GetCopyObjectKey(obj);
- if (serialized.ContainsKey(key)) {
- bb.Append((int)serialized.Get(key));
+ indRefKey = CalculateIndRefKey(reference);
+ byte[] cached = objToSerializedContent.Get(indRefKey);
+ if (cached != null) {
+ bb.Append(cached);
return;
}
else {
savedBb = bb;
bb = new ByteBufferOutputStream();
+ obj = reference.GetRefersTo();
}
}
if (obj.IsStream()) {
bb.Append("$B");
- SerDic((PdfDictionary)obj, level - 1, bb, serialized);
+ SerDic((PdfDictionary)obj, level - 1, bb);
if (level > 0) {
md5.Reset();
bb.Append(md5.Digest(((PdfStream)obj).GetBytes(false)));
@@ -512,11 +555,11 @@ private void SerObject(PdfObject obj, int level, ByteBufferOutputStream bb, IntH
}
else {
if (obj.IsDictionary()) {
- SerDic((PdfDictionary)obj, level - 1, bb, serialized);
+ SerDic((PdfDictionary)obj, level - 1, bb);
}
else {
if (obj.IsArray()) {
- SerArray((PdfArray)obj, level - 1, bb, serialized);
+ SerArray((PdfArray)obj, level - 1, bb);
}
else {
if (obj.IsString()) {
@@ -533,22 +576,20 @@ private void SerObject(PdfObject obj, int level, ByteBufferOutputStream bb, IntH
}
}
}
+ // PdfNull case is also here
if (savedBb != null) {
- int key = GetCopyObjectKey(reference);
- if (!serialized.ContainsKey(key)) {
- serialized.Put(key, CalculateHash(bb.GetBuffer()));
- }
+ objToSerializedContent[indRefKey] = bb.GetBuffer();
savedBb.Append(bb);
}
}
- private void SerDic(PdfDictionary dic, int level, ByteBufferOutputStream bb, IntHashtable serialized) {
+ private void SerDic(PdfDictionary dic, int level, ByteBufferOutputStream bb) {
bb.Append("$D");
if (level <= 0) {
return;
}
PdfName[] keys = new PdfName[dic.KeySet().Count];
- dic.KeySet().ToArray(keys);
+ keys = dic.KeySet().ToArray(keys);
iText.IO.Util.JavaUtil.Sort(keys);
foreach (Object key in keys) {
if (key.Equals(PdfName.P) && (dic.Get((PdfName)key).IsIndirectReference() || dic.Get((PdfName)key).IsDictionary
@@ -556,49 +597,19 @@ private void SerDic(PdfDictionary dic, int level, ByteBufferOutputStream bb, Int
// ignore recursive call
continue;
}
- SerObject((PdfObject)key, level, bb, serialized);
- SerObject(dic.Get((PdfName)key, false), level, bb, serialized);
+ SerObject((PdfObject)key, level, bb);
+ SerObject(dic.Get((PdfName)key, false), level, bb);
}
}
- private void SerArray(PdfArray array, int level, ByteBufferOutputStream bb, IntHashtable serialized) {
+ private void SerArray(PdfArray array, int level, ByteBufferOutputStream bb) {
bb.Append("$A");
if (level <= 0) {
return;
}
for (int k = 0; k < array.Size(); ++k) {
- SerObject(array.Get(k, false), level, bb, serialized);
- }
- }
-
- internal ByteStore(PdfStream str, IntHashtable serialized) {
- try {
- md5 = Org.BouncyCastle.Security.DigestUtilities.GetDigest("MD5");
- }
- catch (Exception e) {
- throw new PdfException(e);
- }
- ByteBufferOutputStream bb = new ByteBufferOutputStream();
- int level = 100;
- SerObject(str, level, bb, serialized);
- this.b = bb.ToByteArray();
- hash = CalculateHash(this.b);
- md5 = null;
- }
-
- internal ByteStore(PdfDictionary dict, IntHashtable serialized) {
- try {
- md5 = Org.BouncyCastle.Security.DigestUtilities.GetDigest("MD5");
- }
- catch (Exception e) {
- throw new PdfException(e);
+ SerObject(array.Get(k, false), level, bb);
}
- ByteBufferOutputStream bb = new ByteBufferOutputStream();
- int level = 100;
- SerObject(dict, level, bb, serialized);
- this.b = bb.ToByteArray();
- hash = CalculateHash(this.b);
- md5 = null;
}
private static int CalculateHash(byte[] b) {
@@ -611,26 +622,13 @@ private static int CalculateHash(byte[] b) {
}
public override bool Equals(Object obj) {
- return obj is PdfWriter.ByteStore && GetHashCode() == obj.GetHashCode() && iText.IO.Util.JavaUtil.ArraysEquals
- (b, ((PdfWriter.ByteStore)obj).b);
+ return obj is PdfWriter.SerializedPdfObject && GetHashCode() == obj.GetHashCode() && iText.IO.Util.JavaUtil.ArraysEquals
+ (serializedContent, ((PdfWriter.SerializedPdfObject)obj).serializedContent);
}
public override int GetHashCode() {
return hash;
}
-
- protected internal virtual int GetCopyObjectKey(PdfObject obj) {
- PdfIndirectReference reference;
- if (obj.IsIndirectReference()) {
- reference = (PdfIndirectReference)obj;
- }
- else {
- reference = obj.GetIndirectReference();
- }
- int result = reference.GetHashCode();
- result = 31 * result + reference.GetDocument().GetHashCode();
- return result;
- }
}
}
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/PdfXrefTable.cs b/itext/itext.kernel/itext/kernel/pdf/PdfXrefTable.cs
index 888d49e3b7..7a2216eec8 100644
--- a/itext/itext.kernel/itext/kernel/pdf/PdfXrefTable.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/PdfXrefTable.cs
@@ -43,8 +43,8 @@ source product.
*/
using System;
using System.Collections.Generic;
+using System.Text;
using iText.IO.Source;
-using iText.IO.Util;
using iText.Kernel;
namespace iText.Kernel.Pdf {
@@ -53,10 +53,6 @@ internal class PdfXrefTable {
private const int MAX_GENERATION = 65535;
- private const String objectOffsetFormatter = "0000000000";
-
- private const String objectGenerationFormatter = "00000";
-
private static readonly byte[] freeXRefEntry = ByteUtils.GetIsoBytes("f \n");
private static readonly byte[] inUseXRefEntry = ByteUtils.GetIsoBytes("n \n");
@@ -125,6 +121,13 @@ protected internal virtual PdfIndirectReference CreateNextIndirectReference(PdfD
return ((PdfIndirectReference)reference.SetState(PdfObject.MODIFIED));
}
+ //For Object streams
+ internal virtual PdfIndirectReference CreateNewIndirectReference(PdfDocument document) {
+ PdfIndirectReference reference = new PdfIndirectReference(document, ++count);
+ Add(reference);
+ return ((PdfIndirectReference)reference.SetState(PdfObject.MODIFIED));
+ }
+
protected internal virtual void FreeReference(PdfIndirectReference reference) {
reference.SetOffset(0);
reference.SetState(PdfObject.FREE);
@@ -148,7 +151,6 @@ protected internal virtual void SetCapacity(int capacity) {
/// Writes cross reference table and trailer to PDF.
///
- ///
protected internal virtual void WriteXrefTableAndTrailer(PdfDocument document, PdfObject fileId, PdfObject
crypto) {
PdfWriter writer = document.GetWriter();
@@ -282,9 +284,10 @@ protected internal virtual void WriteXrefTableAndTrailer(PdfDocument document, P
writer.WriteInteger(first).WriteSpace().WriteInteger(len).WriteByte((byte)'\n');
for (int i_2 = first; i_2 < first + len; i_2++) {
PdfIndirectReference reference = xrefTable.Get(i_2);
- writer.WriteString(DecimalFormatUtil.FormatNumber(reference.GetOffset(), objectOffsetFormatter)).WriteSpace
- ().WriteString(DecimalFormatUtil.FormatNumber(reference.GetGenNumber(), objectGenerationFormatter)).WriteSpace
- ();
+ StringBuilder off = new StringBuilder("0000000000").Append(reference.GetOffset());
+ StringBuilder gen = new StringBuilder("00000").Append(reference.GetGenNumber());
+ writer.WriteString(off.JSubstring(off.Length - 10, off.Length)).WriteSpace().WriteString(gen.JSubstring(gen
+ .Length - 5, gen.Length)).WriteSpace();
if (reference.IsFree()) {
writer.WriteBytes(freeXRefEntry);
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/action/PdfAction.cs b/itext/itext.kernel/itext/kernel/pdf/action/PdfAction.cs
index dbb88c42a7..55f006ac9e 100644
--- a/itext/itext.kernel/itext/kernel/pdf/action/PdfAction.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/action/PdfAction.cs
@@ -50,103 +50,182 @@ source product.
using iText.Kernel.Pdf.Navigation;
namespace iText.Kernel.Pdf.Action {
+ /// A wrapper for action dictionaries (ISO 32000-1 section 12.6).
+ ///
+ /// A wrapper for action dictionaries (ISO 32000-1 section 12.6).
+ /// An action dictionary defines the characteristics and behaviour of an action.
+ ///
public class PdfAction : PdfObjectWrapper {
- /// a possible submitvalue
+ /// A possible submit value
public const int SUBMIT_EXCLUDE = 1;
- /// a possible submitvalue
+ /// A possible submit value
public const int SUBMIT_INCLUDE_NO_VALUE_FIELDS = 2;
- /// a possible submitvalue
+ /// A possible submit value
public const int SUBMIT_HTML_FORMAT = 4;
- /// a possible submitvalue
+ /// A possible submit value
public const int SUBMIT_HTML_GET = 8;
- /// a possible submitvalue
+ /// A possible submit value
public const int SUBMIT_COORDINATES = 16;
- /// a possible submitvalue
+ /// A possible submit value
public const int SUBMIT_XFDF = 32;
- /// a possible submitvalue
+ /// A possible submit value
public const int SUBMIT_INCLUDE_APPEND_SAVES = 64;
- /// a possible submitvalue
+ /// A possible submit value
public const int SUBMIT_INCLUDE_ANNOTATIONS = 128;
- /// a possible submitvalue
+ /// A possible submit value
public const int SUBMIT_PDF = 256;
- /// a possible submitvalue
+ /// A possible submit value
public const int SUBMIT_CANONICAL_FORMAT = 512;
- /// a possible submitvalue
+ /// A possible submit value
public const int SUBMIT_EXCL_NON_USER_ANNOTS = 1024;
- /// a possible submitvalue
+ /// A possible submit value
public const int SUBMIT_EXCL_F_KEY = 2048;
- /// a possible submitvalue
+ /// A possible submit value
public const int SUBMIT_EMBED_FORM = 8196;
- /// a possible submitvalue
+ /// A possible submit value
public const int RESET_EXCLUDE = 1;
+ /// Constructs an empty action that can be further modified.
public PdfAction()
: this(new PdfDictionary()) {
Put(PdfName.Type, PdfName.Action);
}
+ ///
+ /// Constructs a
+ ///
+ /// instance with a given dictionary. It can be used for handy
+ /// property reading in reading mode or modifying in stamping mode.
+ ///
+ /// the dictionary to construct the wrapper around
public PdfAction(PdfDictionary pdfObject)
: base(pdfObject) {
MarkObjectAsIndirect(GetPdfObject());
}
+ /// Creates a GoTo action (section 12.6.4.2 of ISO 32000-1) via a given destination.
+ /// the desired destination of the action
+ /// created action
public static iText.Kernel.Pdf.Action.PdfAction CreateGoTo(PdfDestination destination) {
return new iText.Kernel.Pdf.Action.PdfAction().Put(PdfName.S, PdfName.GoTo).Put(PdfName.D, destination.GetPdfObject
());
}
+ ///
+ /// Creates a GoTo action (section 12.6.4.2 of ISO 32000-1) via a given
+ ///
+ /// name.
+ ///
+ ///
+ ///
+ ///
+ /// name
+ ///
+ /// created action
public static iText.Kernel.Pdf.Action.PdfAction CreateGoTo(String destination) {
return CreateGoTo(new PdfStringDestination(destination));
}
+ /// Creates a GoToR action, or remote action (section 12.6.4.3 of ISO 32000-1).
+ /// the file in which the destination shall be located
+ /// the destination in the remote document to jump to
+ /// a flag specifying whether to open the destination document in a new window
+ /// created action
public static iText.Kernel.Pdf.Action.PdfAction CreateGoToR(PdfFileSpec fileSpec, PdfDestination destination
, bool newWindow) {
return new iText.Kernel.Pdf.Action.PdfAction().Put(PdfName.S, PdfName.GoToR).Put(PdfName.F, fileSpec.GetPdfObject
()).Put(PdfName.D, destination.GetPdfObject()).Put(PdfName.NewWindow, new PdfBoolean(newWindow));
}
+ /// Creates a GoToR action, or remote action (section 12.6.4.3 of ISO 32000-1).
+ /// the file in which the destination shall be located
+ /// the destination in the remote document to jump to
+ /// created action
public static iText.Kernel.Pdf.Action.PdfAction CreateGoToR(PdfFileSpec fileSpec, PdfDestination destination
) {
return new iText.Kernel.Pdf.Action.PdfAction().Put(PdfName.S, PdfName.GoToR).Put(PdfName.F, fileSpec.GetPdfObject
()).Put(PdfName.D, destination.GetPdfObject());
}
+ /// Creates a GoToR action, or remote action (section 12.6.4.3 of ISO 32000-1).
+ /// the remote destination file to jump to
+ /// the remote destination document page to jump to
+ /// created action
public static iText.Kernel.Pdf.Action.PdfAction CreateGoToR(String filename, int pageNum) {
return CreateGoToR(filename, pageNum, false);
}
+ /// Creates a GoToR action, or remote action (section 12.6.4.3 of ISO 32000-1).
+ /// the remote destination file to jump to
+ /// the remote destination document page to jump to
+ /// a flag specifying whether to open the destination document in a new window
+ /// created action
public static iText.Kernel.Pdf.Action.PdfAction CreateGoToR(String filename, int pageNum, bool newWindow) {
return CreateGoToR(new PdfStringFS(filename), PdfExplicitDestination.CreateFitH(pageNum, 10000), newWindow
);
}
+ /// Creates a GoToR action, or remote action (section 12.6.4.3 of ISO 32000-1).
+ /// the remote destination file to jump to
+ /// the string destination in the remote document to jump to
+ /// a flag specifying whether to open the destination document in a new window
+ /// created action
public static iText.Kernel.Pdf.Action.PdfAction CreateGoToR(String filename, String destination, bool newWindow
) {
return CreateGoToR(new PdfStringFS(filename), new PdfStringDestination(destination), newWindow);
}
+ /// Creates a GoToR action, or remote action (section 12.6.4.3 of ISO 32000-1).
+ /// the remote destination file to jump to
+ /// the string destination in the remote document to jump to
+ /// created action
public static iText.Kernel.Pdf.Action.PdfAction CreateGoToR(String filename, String destination) {
return CreateGoToR(filename, destination, false);
}
+ /// Creates a GoToE action, or embedded file action (section 12.6.4.4 of ISO 32000-1).
+ /// the destination in the target to jump to
+ ///
+ /// if true, the destination document should be opened in a new window;
+ /// if false, the destination document should replace the current document in the same window
+ ///
+ ///
+ /// A target dictionary specifying path information to the target document.
+ /// Each target dictionary specifies one element in the full path to the target and
+ /// may have nested target dictionaries specifying additional elements
+ ///
+ /// created action
public static iText.Kernel.Pdf.Action.PdfAction CreateGoToE(PdfDestination destination, bool newWindow, PdfTargetDictionary
targetDictionary) {
return CreateGoToE(null, destination, newWindow, targetDictionary);
}
+ /// Creates a GoToE action, or embedded file action (section 12.6.4.4 of ISO 32000-1).
+ /// The root document of the target relative to the root document of the source
+ /// the destination in the target to jump to
+ ///
+ /// if true, the destination document should be opened in a new window;
+ /// if false, the destination document should replace the current document in the same window
+ ///
+ ///
+ /// A target dictionary specifying path information to the target document.
+ /// Each target dictionary specifies one element in the full path to the target and
+ /// may have nested target dictionaries specifying additional elements
+ ///
+ /// created action
public static iText.Kernel.Pdf.Action.PdfAction CreateGoToE(PdfFileSpec fileSpec, PdfDestination destination
, bool newWindow, PdfTargetDictionary targetDictionary) {
iText.Kernel.Pdf.Action.PdfAction action = new iText.Kernel.Pdf.Action.PdfAction().Put(PdfName.S, PdfName.
@@ -163,10 +242,19 @@ public static iText.Kernel.Pdf.Action.PdfAction CreateGoToE(PdfFileSpec fileSpec
return action;
}
+ /// Creates a Launch action (section 12.6.4.5 of ISO 32000-1).
+ /// the application that shall be launched or the document that shall beopened or printed
+ ///
+ /// a flag specifying whether to open the destination document in a new window
+ /// created action
public static iText.Kernel.Pdf.Action.PdfAction CreateLaunch(PdfFileSpec fileSpec, bool newWindow) {
return CreateLaunch(fileSpec, null, newWindow);
}
+ /// Creates a Launch action (section 12.6.4.5 of ISO 32000-1).
+ /// the application that shall be launched or the document that shall beopened or printed
+ ///
+ /// created action
public static iText.Kernel.Pdf.Action.PdfAction CreateLaunch(PdfFileSpec fileSpec) {
iText.Kernel.Pdf.Action.PdfAction action = new iText.Kernel.Pdf.Action.PdfAction().Put(PdfName.S, PdfName.
Launch);
@@ -176,6 +264,12 @@ public static iText.Kernel.Pdf.Action.PdfAction CreateLaunch(PdfFileSpec fileSpe
return action;
}
+ /// Creates a Launch action (section 12.6.4.5 of ISO 32000-1).
+ /// the application that shall be launched or the document that shall beopened or printed
+ ///
+ /// A dictionary containing Windows-specific launch parameters
+ /// a flag specifying whether to open the destination document in a new window
+ /// created action
public static iText.Kernel.Pdf.Action.PdfAction CreateLaunch(PdfFileSpec fileSpec, PdfWin win, bool newWindow
) {
iText.Kernel.Pdf.Action.PdfAction action = new iText.Kernel.Pdf.Action.PdfAction().Put(PdfName.S, PdfName.
@@ -189,6 +283,18 @@ public static iText.Kernel.Pdf.Action.PdfAction CreateLaunch(PdfFileSpec fileSpe
return action;
}
+ /// Creates a Thread action (section 12.6.4.6 of ISO 32000-1).
+ ///
+ /// Creates a Thread action (section 12.6.4.6 of ISO 32000-1).
+ /// A thread action jumps to a specified bead on an article thread (see 12.4.3, “Articles”),
+ /// in either the current document or a different one. Table 205 shows the action dictionary
+ /// entries specific to this type of action.
+ ///
+ /// the file containing the thread. If this entry is absent, the thread is in the current file
+ ///
+ /// the destination thread
+ /// the bead in the destination thread
+ /// created action
public static iText.Kernel.Pdf.Action.PdfAction CreateThread(PdfFileSpec fileSpec, PdfObject destinationThread
, PdfObject bead) {
iText.Kernel.Pdf.Action.PdfAction action = new iText.Kernel.Pdf.Action.PdfAction().Put(PdfName.S, PdfName.
@@ -199,30 +305,84 @@ public static iText.Kernel.Pdf.Action.PdfAction CreateThread(PdfFileSpec fileSpe
return action;
}
+ /// Creates a Thread action (section 12.6.4.6 of ISO 32000-1).
+ ///
+ /// Creates a Thread action (section 12.6.4.6 of ISO 32000-1).
+ /// A thread action jumps to a specified bead on an article thread (see 12.4.3, “Articles”),
+ /// in either the current document or a different one. Table 205 shows the action dictionary
+ /// entries specific to this type of action.
+ ///
+ /// the file containing the thread. If this entry is absent, the thread is in the current file
+ ///
+ /// created action
public static iText.Kernel.Pdf.Action.PdfAction CreateThread(PdfFileSpec fileSpec) {
return CreateThread(fileSpec, null, null);
}
+ /// Creates a URI action (section 12.6.4.7 of ISO 32000-1).
+ /// the uniform resource identifier to resolve
+ /// created action
public static iText.Kernel.Pdf.Action.PdfAction CreateURI(String uri) {
return CreateURI(uri, false);
}
+ /// Creates a URI action (section 12.6.4.7 of ISO 32000-1).
+ /// the uniform resource identifier to resolve
+ /// a flag specifying whether to track the mouse position when the URI is resolved
+ /// created action
public static iText.Kernel.Pdf.Action.PdfAction CreateURI(String uri, bool isMap) {
return new iText.Kernel.Pdf.Action.PdfAction().Put(PdfName.S, PdfName.URI).Put(PdfName.URI, new PdfString(
uri)).Put(PdfName.IsMap, new PdfBoolean(isMap));
}
+ /// Creates a Sound action (section 12.6.4.8 of ISO 32000-1).
+ /// a sound object defining the sound that shall be played (see section 13.3 of ISO 32000-1)
+ ///
+ /// created action
public static iText.Kernel.Pdf.Action.PdfAction CreateSound(PdfStream sound) {
return new iText.Kernel.Pdf.Action.PdfAction().Put(PdfName.S, PdfName.Sound).Put(PdfName.Sound, sound);
}
+ /// Creates a Sound action (section 12.6.4.8 of ISO 32000-1).
+ /// a sound object defining the sound that shall be played (see section 13.3 of ISO 32000-1)
+ ///
+ /// the volume at which to play the sound, in the range -1.0 to 1.0. Default value: 1.0
+ ///
+ /// a flag specifying whether to play the sound synchronously or asynchronously.
+ /// If this flag is true, the conforming reader retains control, allowing no further user
+ /// interaction other than canceling the sound, until the sound has been completely played.
+ /// Default value: false
+ ///
+ ///
+ /// a flag specifying whether to repeat the sound indefinitely
+ /// If this entry is present, the Synchronous entry shall be ignored. Default value: false
+ ///
+ /// a flag specifying whether to mix this sound with any other sound already playing
+ /// created action
public static iText.Kernel.Pdf.Action.PdfAction CreateSound(PdfStream sound, float volume, bool synchronous
, bool repeat, bool mix) {
+ if (volume < -1 || volume > 1) {
+ throw new ArgumentException("volume");
+ }
return new iText.Kernel.Pdf.Action.PdfAction().Put(PdfName.S, PdfName.Sound).Put(PdfName.Sound, sound).Put
(PdfName.Volume, new PdfNumber(volume)).Put(PdfName.Synchronous, new PdfBoolean(synchronous)).Put(PdfName
.Repeat, new PdfBoolean(repeat)).Put(PdfName.Mix, new PdfBoolean(mix));
}
+ /// Creates a Movie annotation (section 12.6.4.9 of ISO 32000-1).
+ /// a movie annotation identifying the movie that shall be played
+ /// the title of a movie annotation identifying the movie that shall be played
+ ///
+ /// the operation that shall be performed on the movie. Shall be one of the following:
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ ///
+ /// created annotation
public static iText.Kernel.Pdf.Action.PdfAction CreateMovie(PdfAnnotation annotation, String title, PdfName
operation) {
iText.Kernel.Pdf.Action.PdfAction action = new iText.Kernel.Pdf.Action.PdfAction().Put(PdfName.S, PdfName.
@@ -233,34 +393,90 @@ public static iText.Kernel.Pdf.Action.PdfAction CreateMovie(PdfAnnotation annota
return action;
}
+ /// Creates a Hide action (section 12.6.4.10 of ISO 32000-1).
+ /// the annotation to be hidden or shown
+ /// a flag indicating whether to hide the annotation (true) or show it (false)
+ ///
+ /// created action
public static iText.Kernel.Pdf.Action.PdfAction CreateHide(PdfAnnotation annotation, bool hidden) {
return new iText.Kernel.Pdf.Action.PdfAction().Put(PdfName.S, PdfName.Hide).Put(PdfName.T, annotation.GetPdfObject
()).Put(PdfName.H, new PdfBoolean(hidden));
}
+ /// Creates a Hide action (section 12.6.4.10 of ISO 32000-1).
+ /// the annotations to be hidden or shown
+ /// a flag indicating whether to hide the annotation (true) or show it (false)
+ ///
+ /// created action
public static iText.Kernel.Pdf.Action.PdfAction CreateHide(PdfAnnotation[] annotations, bool hidden) {
return new iText.Kernel.Pdf.Action.PdfAction().Put(PdfName.S, PdfName.Hide).Put(PdfName.T, GetPdfArrayFromAnnotationsList
(annotations)).Put(PdfName.H, new PdfBoolean(hidden));
}
+ /// Creates a Hide action (section 12.6.4.10 of ISO 32000-1).
+ ///
+ /// a text string giving the fully qualified field name of an interactive form field whose
+ /// associated widget annotation or annotations are to be affected
+ ///
+ /// a flag indicating whether to hide the annotation (true) or show it (false)
+ ///
+ /// created action
public static iText.Kernel.Pdf.Action.PdfAction CreateHide(String text, bool hidden) {
return new iText.Kernel.Pdf.Action.PdfAction().Put(PdfName.S, PdfName.Hide).Put(PdfName.T, new PdfString(text
)).Put(PdfName.H, new PdfBoolean(hidden));
}
+ /// Creates a Hide action (section 12.6.4.10 of ISO 32000-1).
+ ///
+ /// a text string array giving the fully qualified field names of interactive form fields whose
+ /// associated widget annotation or annotations are to be affected
+ ///
+ /// a flag indicating whether to hide the annotation (true) or show it (false)
+ ///
+ /// created action
public static iText.Kernel.Pdf.Action.PdfAction CreateHide(String[] text, bool hidden) {
return new iText.Kernel.Pdf.Action.PdfAction().Put(PdfName.S, PdfName.Hide).Put(PdfName.T, GetArrayFromStringList
(text)).Put(PdfName.H, new PdfBoolean(hidden));
}
+ /// Creates a Named action (section 12.6.4.11 of ISO 32000-1).
+ ///
+ /// the name of the action that shall be performed. Shall be one of the following:
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ ///
+ /// created action
public static iText.Kernel.Pdf.Action.PdfAction CreateNamed(PdfName namedAction) {
return new iText.Kernel.Pdf.Action.PdfAction().Put(PdfName.S, PdfName.Named).Put(PdfName.N, namedAction);
}
+ /// Creates a Set-OCG-State action (section 12.6.4.12 of ISO 32000-1).
+ ///
+ /// a list of
+ ///
+ /// state descriptions
+ ///
+ /// created action
public static iText.Kernel.Pdf.Action.PdfAction CreateSetOcgState(IList states) {
return CreateSetOcgState(states, false);
}
+ /// Creates a Set-OCG-State action (section 12.6.4.12 of ISO 32000-1).
+ ///
+ /// states a list of
+ ///
+ /// state descriptions
+ ///
+ ///
+ /// If true, indicates that radio-button state relationships between optional content groups
+ /// should be preserved when the states are applied
+ ///
+ /// created action
public static iText.Kernel.Pdf.Action.PdfAction CreateSetOcgState(IList states, bool preserveRb
) {
PdfArray stateArr = new PdfArray();
@@ -271,6 +487,12 @@ public static iText.Kernel.Pdf.Action.PdfAction CreateSetOcgState(IListCreates a Rendition action (section 12.6.4.13 of ISO 32000-1).
+ /// the name of the media clip, for use in the user interface.
+ /// a full file specification or form XObject that specifies the actual media data
+ /// an ASCII string identifying the type of data
+ /// a screen annotation
+ /// created action
public static iText.Kernel.Pdf.Action.PdfAction CreateRendition(String file, PdfFileSpec fileSpec, String
mimeType, PdfAnnotation screenAnnotation) {
return new iText.Kernel.Pdf.Action.PdfAction().Put(PdfName.S, PdfName.Rendition).Put(PdfName.OP, new PdfNumber
@@ -278,18 +500,33 @@ public static iText.Kernel.Pdf.Action.PdfAction CreateRendition(String file, Pdf
mimeType).GetPdfObject());
}
+ /// Creates a JavaScript action (section 12.6.4.16 of ISO 32000-1).
+ /// a text string containing the JavaScript script to be executed.
+ /// created action
public static iText.Kernel.Pdf.Action.PdfAction CreateJavaScript(String javaScript) {
return new iText.Kernel.Pdf.Action.PdfAction().Put(PdfName.S, PdfName.JavaScript).Put(PdfName.JS, new PdfString
(javaScript));
}
+ /// Creates a Submit-Form Action (section 12.7.5.2 of ISO 32000-1).
+ /// a uniform resource locator, as described in 7.11.5, "URL Specifications"
+ ///
+ /// an array identifying which fields to include in the submission or which to exclude,
+ /// depending on the setting of the Include/Exclude flag in the Flags entry.
+ /// This is an optional parameter and can be null
+ ///
+ ///
+ /// a set of flags specifying various characteristics of the action (see Table 237 of ISO 32000-1).
+ /// Default value to be passed: 0.
+ ///
+ /// created action
public static iText.Kernel.Pdf.Action.PdfAction CreateSubmitForm(String file, Object[] names, int flags) {
iText.Kernel.Pdf.Action.PdfAction action = new iText.Kernel.Pdf.Action.PdfAction();
action.Put(PdfName.S, PdfName.SubmitForm);
- PdfDictionary dic = new PdfDictionary();
- dic.Put(PdfName.F, new PdfString(file));
- dic.Put(PdfName.FS, PdfName.URL);
- action.Put(PdfName.F, dic);
+ PdfDictionary urlFileSpec = new PdfDictionary();
+ urlFileSpec.Put(PdfName.F, new PdfString(file));
+ urlFileSpec.Put(PdfName.FS, PdfName.URL);
+ action.Put(PdfName.F, urlFileSpec);
if (names != null) {
action.Put(PdfName.Fields, BuildArray(names));
}
@@ -297,6 +534,16 @@ public static iText.Kernel.Pdf.Action.PdfAction CreateSubmitForm(String file, Ob
return action;
}
+ /// Creates a Reset-Form Action (section 12.7.5.3 of ISO 32000-1).
+ ///
+ /// an array identifying which fields to reset or which to exclude from resetting,
+ /// depending on the setting of the Include/Exclude flag in the Flags entry (see Table 239 of ISO 32000-1).
+ ///
+ ///
+ /// a set of flags specifying various characteristics of the action (see Table 239 of ISO 32000-1).
+ /// Default value to be passed: 0.
+ ///
+ /// created action
public static iText.Kernel.Pdf.Action.PdfAction CreateResetForm(Object[] names, int flags) {
iText.Kernel.Pdf.Action.PdfAction action = new iText.Kernel.Pdf.Action.PdfAction();
action.Put(PdfName.S, PdfName.ResetForm);
@@ -307,6 +554,22 @@ public static iText.Kernel.Pdf.Action.PdfAction CreateResetForm(Object[] names,
return action;
}
+ ///
+ /// Adds an additional action to the provided
+ /// PdfObjectWrapper
+ /// wrapper.
+ ///
+ /// the wrapper to add an additional action to
+ ///
+ /// a
+ ///
+ /// specifying the name of an additional action
+ ///
+ ///
+ /// the
+ ///
+ /// to add as an additional action
+ ///
public static void SetAdditionalAction(PdfObjectWrapper wrapper, PdfName key, iText.Kernel.Pdf.Action.PdfAction
action) {
PdfDictionary dic;
@@ -321,30 +584,62 @@ public static void SetAdditionalAction(PdfObjectWrapper wrapper,
wrapper.GetPdfObject().Put(PdfName.AA, dic);
}
- /// Add a chained action.
- ///
- public virtual void Next(iText.Kernel.Pdf.Action.PdfAction na) {
- PdfObject nextAction = GetPdfObject().Get(PdfName.Next);
- if (nextAction == null) {
- Put(PdfName.Next, na.GetPdfObject());
+ /// Adds a chained action.
+ /// the next action or sequence of actions that shall be performed after the current action
+ ///
+ public virtual void Next(iText.Kernel.Pdf.Action.PdfAction nextAction) {
+ PdfObject currentNextAction = GetPdfObject().Get(PdfName.Next);
+ if (currentNextAction == null) {
+ Put(PdfName.Next, nextAction.GetPdfObject());
}
else {
- if (nextAction.IsDictionary()) {
- PdfArray array = new PdfArray(nextAction);
- array.Add(na.GetPdfObject());
+ if (currentNextAction.IsDictionary()) {
+ PdfArray array = new PdfArray(currentNextAction);
+ array.Add(nextAction.GetPdfObject());
Put(PdfName.Next, array);
}
else {
- ((PdfArray)nextAction).Add(na.GetPdfObject());
+ ((PdfArray)currentNextAction).Add(nextAction.GetPdfObject());
}
}
}
+ ///
+ /// Inserts the value into the underlying object of this
+ ///
+ /// and associates it with the specified key.
+ /// If the key is already present in this
+ ///
+ /// , this method will override the old value with the specified one.
+ ///
+ /// key to insert or to override
+ /// the value to associate with the specified key
+ ///
+ /// this
+ ///
+ /// instance
+ ///
public virtual iText.Kernel.Pdf.Action.PdfAction Put(PdfName key, PdfObject value) {
GetPdfObject().Put(key, value);
return this;
}
+ ///
+ /// To manually flush a
+ /// PdfObject
+ /// behind this wrapper, you have to ensure
+ /// that this object is added to the document, i.e. it has an indirect reference.
+ /// Basically this means that before flushing you need to explicitly call
+ ///
+ /// .
+ /// For example: wrapperInstance.makeIndirect(document).flush();
+ /// Note that not every wrapper require this, only those that have such warning in documentation.
+ ///
+ public override void Flush() {
+ base.Flush();
+ }
+
+ ///
protected internal override bool IsWrappedObjectMustBeIndirect() {
return true;
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/action/PdfActionOcgState.cs b/itext/itext.kernel/itext/kernel/pdf/action/PdfActionOcgState.cs
index 32f88de906..059645960d 100644
--- a/itext/itext.kernel/itext/kernel/pdf/action/PdfActionOcgState.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/action/PdfActionOcgState.cs
@@ -45,26 +45,74 @@ source product.
using iText.Kernel.Pdf;
namespace iText.Kernel.Pdf.Action {
- /// USed in Set OCG State actions.
+ /// This is a helper class for optional content states use in Set-OCG-State actions.
+ ///
+ /// This is a helper class for optional content states use in Set-OCG-State actions.
+ /// See
+ ///
+ /// .
+ ///
public class PdfActionOcgState {
- /// Can be: OFF, ON, Toggle
+ ///
+ /// Can be:
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ ///
private PdfName state;
+ /// Optional content group dictionaries
private IList ocgs;
+ /// Constructs an optional content state object.
+ ///
+ /// a
+ ///
+ /// describing the state. Shall be one of the following:
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ ///
+ /// a list of the OCG dictionaries
public PdfActionOcgState(PdfName state, IList ocgs) {
this.state = state;
this.ocgs = ocgs;
}
+ /// Gets the state the optional content groups should be switched to
+ ///
+ /// the state, one of the following:
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ ///
public virtual PdfName GetState() {
return state;
}
+ /// Gets a list of optional content groups that shall have the state changed
+ /// the list of optional content groups
public virtual IList GetOcgs() {
return ocgs;
}
+ ///
+ /// Gets a list of
+ ///
+ /// that is describing this particular optional content group states.
+ ///
+ ///
+ /// a list of
+ ///
+ /// for construction of a
+ ///
+ ///
public virtual IList GetObjectList() {
IList states = new List();
states.Add(state);
diff --git a/itext/itext.kernel/itext/kernel/pdf/action/PdfMediaClipData.cs b/itext/itext.kernel/itext/kernel/pdf/action/PdfMediaClipData.cs
index 952fbfdb15..be03c5f71a 100644
--- a/itext/itext.kernel/itext/kernel/pdf/action/PdfMediaClipData.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/action/PdfMediaClipData.cs
@@ -46,13 +46,29 @@ source product.
using iText.Kernel.Pdf.Filespec;
namespace iText.Kernel.Pdf.Action {
+ /// This class is a wrapper of media clip data dictionary that defines the data for a media object that can be played.
+ ///
public class PdfMediaClipData : PdfObjectWrapper {
private static readonly PdfString TEMPACCESS = new PdfString("TEMPACCESS");
+ ///
+ /// Constructs a new
+ ///
+ /// wrapper using an existing dictionary.
+ ///
+ /// the dictionary to construct the wrapper from
public PdfMediaClipData(PdfDictionary pdfObject)
: base(pdfObject) {
}
+ ///
+ /// Constructs a new
+ ///
+ /// wrapper around a newly created dictionary.
+ ///
+ /// the name of the file to create a media clip for
+ /// a file specification that specifies the actual media data
+ /// an ASCII string identifying the type of data
public PdfMediaClipData(String file, PdfFileSpec fs, String mimeType)
: this(new PdfDictionary()) {
PdfDictionary dic = new PdfDictionary();
@@ -66,6 +82,22 @@ public PdfMediaClipData(String file, PdfFileSpec fs, String mimeType)
GetPdfObject().Put(PdfName.D, fs.GetPdfObject());
}
+ ///
+ /// To manually flush a
+ /// PdfObject
+ /// behind this wrapper, you have to ensure
+ /// that this object is added to the document, i.e. it has an indirect reference.
+ /// Basically this means that before flushing you need to explicitly call
+ ///
+ /// .
+ /// For example: wrapperInstance.makeIndirect(document).flush();
+ /// Note that not every wrapper require this, only those that have such warning in documentation.
+ ///
+ public override void Flush() {
+ base.Flush();
+ }
+
+ ///
protected internal override bool IsWrappedObjectMustBeIndirect() {
return true;
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/action/PdfRendition.cs b/itext/itext.kernel/itext/kernel/pdf/action/PdfRendition.cs
index a303a64553..3e7d0bcbb8 100644
--- a/itext/itext.kernel/itext/kernel/pdf/action/PdfRendition.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/action/PdfRendition.cs
@@ -46,11 +46,22 @@ source product.
using iText.Kernel.Pdf.Filespec;
namespace iText.Kernel.Pdf.Action {
+ /// This a wrapper around a rendition dictionary.
+ /// This a wrapper around a rendition dictionary. See ISO 32000-1 sections 13.2.3.2, 13.2.3.3.
public class PdfRendition : PdfObjectWrapper {
+ ///
+ /// Creates a new wrapper around an existing
+ ///
+ ///
+ /// a rendition object to create a wrapper for
public PdfRendition(PdfDictionary pdfObject)
: base(pdfObject) {
}
+ /// Creates a new wrapper around a newly created media rendition dictionary object.
+ /// a text string specifying the name of the file to display
+ /// a file specification that specifies the actual media data
+ /// an ASCII string identifying the type of data
public PdfRendition(String file, PdfFileSpec fs, String mimeType)
: this(new PdfDictionary()) {
GetPdfObject().Put(PdfName.S, PdfName.MR);
@@ -58,6 +69,22 @@ public PdfRendition(String file, PdfFileSpec fs, String mimeType)
GetPdfObject().Put(PdfName.C, new PdfMediaClipData(file, fs, mimeType).GetPdfObject());
}
+ ///
+ /// To manually flush a
+ /// PdfObject
+ /// behind this wrapper, you have to ensure
+ /// that this object is added to the document, i.e. it has an indirect reference.
+ /// Basically this means that before flushing you need to explicitly call
+ ///
+ /// .
+ /// For example: wrapperInstance.makeIndirect(document).flush();
+ /// Note that not every wrapper require this, only those that have such warning in documentation.
+ ///
+ public override void Flush() {
+ base.Flush();
+ }
+
+ ///
protected internal override bool IsWrappedObjectMustBeIndirect() {
return true;
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/action/PdfTargetDictionary.cs b/itext/itext.kernel/itext/kernel/pdf/action/PdfTargetDictionary.cs
index a2341487ee..2744a07d0a 100644
--- a/itext/itext.kernel/itext/kernel/pdf/action/PdfTargetDictionary.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/action/PdfTargetDictionary.cs
@@ -45,92 +45,249 @@ source product.
using iText.Kernel.Pdf;
namespace iText.Kernel.Pdf.Action {
+ ///
+ /// A target dictionary locates the target in relation to the source,
+ /// in much the same way that a relative path describes the physical
+ /// relationship between two files in a file system.
+ ///
+ ///
+ /// A target dictionary locates the target in relation to the source,
+ /// in much the same way that a relative path describes the physical
+ /// relationship between two files in a file system. Target dictionaries may be
+ /// nested recursively to specify one or more intermediate targets before reaching the final one.
+ ///
public class PdfTargetDictionary : PdfObjectWrapper {
+ ///
+ /// Creates a new
+ ///
+ /// object by the underlying dictionary.
+ ///
+ /// the underlying dictionary object
public PdfTargetDictionary(PdfDictionary pdfObject)
: base(pdfObject) {
}
+ ///
+ /// Creates a new
+ ///
+ /// object given its type. The type must be either
+ ///
+ /// , or
+ ///
+ /// . If it is
+ ///
+ /// , additional entries must be specified
+ /// according to the spec.
+ ///
+ /// the relationship between the current document and the target
public PdfTargetDictionary(PdfName r)
: this(new PdfDictionary()) {
Put(PdfName.R, r);
}
+ ///
+ /// Creates a new
+ ///
+ /// object.
+ ///
+ /// the relationship between the current document and the target
+ /// the name of the file in the EmbeddedFiles name tree
+ ///
+ /// if the value is an integer, it specifies the page number (zero-based) in the current
+ /// document containing the file attachment annotation. If the value is a string,
+ /// it specifies a named destination in the current document that provides the page
+ /// number of the file attachment annotation
+ ///
+ ///
+ /// If the value is an integer, it specifies the index (zero-based) of the annotation in the
+ /// Annots array of the page specified by P. If the value is a text string,
+ /// it specifies the value of NM in the annotation dictionary
+ ///
+ ///
+ /// A target dictionary specifying additional path information to the target document.
+ /// If this entry is absent, the current document is the target file containing the destination
+ ///
public PdfTargetDictionary(PdfName r, PdfString n, PdfObject p, PdfObject a, iText.Kernel.Pdf.Action.PdfTargetDictionary
t)
: this(new PdfDictionary()) {
Put(PdfName.R, r).Put(PdfName.N, n).Put(PdfName.P, p).Put(PdfName.A, a).Put(PdfName.T, t.GetPdfObject());
}
- /// Sets the name of the file in the EmbeddedFiles name tree.
+ /// Creates a new target object pointing to the parent of the current document.
+ ///
+ /// created
+ ///
+ ///
+ public static iText.Kernel.Pdf.Action.PdfTargetDictionary CreateParentTarget() {
+ return new iText.Kernel.Pdf.Action.PdfTargetDictionary(PdfName.P);
+ }
+
+ /// Creates a new target object pointing to a file in the EmbeddedFiles name tree.
+ /// the name of the file in the EmbeddedFiles name tree
+ /// created object
+ public static iText.Kernel.Pdf.Action.PdfTargetDictionary CreateChildTarget(String embeddedFileName) {
+ return new iText.Kernel.Pdf.Action.PdfTargetDictionary(PdfName.C).Put(PdfName.N, new PdfString(embeddedFileName
+ ));
+ }
+
+ /// Creates a new target object pointing to a file attachment annotation.
+ ///
+ /// a named destination in the current document that
+ /// provides the page number of the file attachment annotation
+ ///
+ ///
+ /// a unique annotation identifier (
+ ///
+ /// entry) of the annotation
+ ///
+ /// created object
+ public static iText.Kernel.Pdf.Action.PdfTargetDictionary CreateChildTarget(String namedDestination, String
+ annotationIdentifier) {
+ return new iText.Kernel.Pdf.Action.PdfTargetDictionary(PdfName.C).Put(PdfName.P, new PdfString(namedDestination
+ )).Put(PdfName.A, new PdfString(annotationIdentifier));
+ }
+
+ /// Creates a new target object pointing to a file attachment annotation.
+ /// the number of the page in the current document, one-based
+ /// the index of the annotation in the Annots entry of the page, zero-based
+ /// created object
+ public static iText.Kernel.Pdf.Action.PdfTargetDictionary CreateChildTarget(int pageNumber, int annotationIndex
+ ) {
+ return new iText.Kernel.Pdf.Action.PdfTargetDictionary(PdfName.C).Put(PdfName.P, new PdfNumber(pageNumber
+ - 1)).Put(PdfName.A, new PdfNumber(annotationIndex));
+ }
+
+ ///
+ /// Sets the name of the file in the EmbeddedFiles name tree for the child target located
+ /// in the EmbeddedFiles.
+ ///
/// the name of the file
- ///
+ /// this object wrapper
public virtual iText.Kernel.Pdf.Action.PdfTargetDictionary SetName(String name) {
return Put(PdfName.N, new PdfString(name));
}
- /// Gets name of the file
- ///
+ ///
+ /// Gets name of the file in the EmbeddedFiles name tree for the child target located
+ /// in the EmbeddedFiles.
+ ///
+ /// the name of the child file for this target
public virtual PdfString GetName() {
return GetPdfObject().GetAsString(PdfName.N);
}
- /// Sets the page number in the current document containing the file attachment annotation.
- ///
- ///
+ ///
+ /// Sets the page number in the current document containing the file attachment annotation for the
+ /// child target associates with a file attachment annotation.
+ ///
+ ///
+ /// the page number (one-based) in the current document containing
+ /// the file attachment annotation
+ ///
+ /// this object wrapper
public virtual iText.Kernel.Pdf.Action.PdfTargetDictionary SetPage(int pageNumber) {
- return Put(PdfName.P, new PdfNumber(pageNumber));
+ return Put(PdfName.P, new PdfNumber(pageNumber - 1));
}
- /// Sets a named destination in the current document that provides the page number of the file attachment annotation.
- ///
- ///
- ///
+ ///
+ /// Sets a named destination in the current document that provides the page number of the file
+ /// attachment annotation for the child target associated with a file attachment annotation.
+ ///
+ ///
+ /// a named destination in the current document that provides the page
+ /// number of the file attachment annotation
+ ///
+ /// this object wrapper
public virtual iText.Kernel.Pdf.Action.PdfTargetDictionary SetPage(String namedDestination) {
return Put(PdfName.P, new PdfString(namedDestination));
}
- /// Get the page number or a named destination that provides the page number containing the file attachment annotation
- ///
- ///
+ /// Get the contents of the /P entry of this target object.
+ ///
+ /// Get the contents of the /P entry of this target object.
+ /// If the value is an integer, it specifies the page number (zero-based)
+ /// in the current document containing the file attachment annotation.
+ /// If the value is a string, it specifies a named destination in the current
+ /// document that provides the page number of the file attachment annotation.
+ ///
+ /// the /P entry of target object
public virtual PdfObject GetPage() {
return GetPdfObject().Get(PdfName.P);
}
- /// Sets the index of the annotation in Annots array of the page specified by /P entry.
- ///
- ///
- public virtual iText.Kernel.Pdf.Action.PdfTargetDictionary SetAnnotation(int annotNumber) {
- return Put(PdfName.A, new PdfNumber(annotNumber));
+ ///
+ /// Sets the index of the annotation in Annots array of the page specified by /P entry
+ /// for the child target associated with a file attachment annotation.
+ ///
+ /// the index (zero-based) of the annotation in the Annots array
+ /// this object wrapper
+ public virtual iText.Kernel.Pdf.Action.PdfTargetDictionary SetAnnotation(int annotationIndex) {
+ return Put(PdfName.A, new PdfNumber(annotationIndex));
}
- /// Sets the text value, which specifies the value of the /NM entry in the annotation dictionary.
- ///
- ///
+ ///
+ /// Sets the text value, which uniquely identifies an annotation (/NM entry) in an annotation dictionary
+ /// for the child target associated with a file attachment annotation.
+ ///
+ /// specifies the value of NM in the annotation dictionary of the target annotation
+ ///
+ /// this object wrapper
public virtual iText.Kernel.Pdf.Action.PdfTargetDictionary SetAnnotation(String annotationName) {
return Put(PdfName.A, new PdfString(annotationName));
}
+ /// Gets the object in the /A entry of the underlying object.
+ ///
+ /// Gets the object in the /A entry of the underlying object. If the value is an integer,
+ /// it specifies the index (zero-based) of the annotation in the Annots array of the page specified by P.
+ /// If the value is a text string, it specifies the value of NM in the annotation dictionary.
+ ///
+ /// the /A entry in the target object
public virtual PdfObject GetAnnotation() {
return GetPdfObject().Get(PdfName.A);
}
/// Sets a target dictionary specifying additional path information to the target document.
- ///
- ///
+ ///
+ /// Sets a target dictionary specifying additional path information to the target document.
+ /// If this entry is absent, the current document is the target file containing the destination.
+ ///
+ /// the additional path target dictionary
+ /// this object wrapper
public virtual iText.Kernel.Pdf.Action.PdfTargetDictionary SetTarget(iText.Kernel.Pdf.Action.PdfTargetDictionary
target) {
return Put(PdfName.T, target.GetPdfObject());
}
+ /// Get a target dictionary specifying additional path information to the target document.
+ ///
+ /// Get a target dictionary specifying additional path information to the target document.
+ /// If the current target object is the final node in the target path, null is returned.
+ ///
+ /// a target dictionary specifying additional path information to the target document
public virtual iText.Kernel.Pdf.Action.PdfTargetDictionary GetTarget() {
- return new iText.Kernel.Pdf.Action.PdfTargetDictionary(GetPdfObject().GetAsDictionary(PdfName.T));
+ PdfDictionary targetDictObject = GetPdfObject().GetAsDictionary(PdfName.T);
+ return targetDictObject != null ? new iText.Kernel.Pdf.Action.PdfTargetDictionary(targetDictObject) : null;
}
+ ///
+ /// This is a convenient method to put key-value pairs to the underlying
+ ///
+ /// .
+ ///
+ ///
+ /// the key, a
+ ///
+ /// instance
+ ///
+ /// the value
+ /// this object wrapper
public virtual iText.Kernel.Pdf.Action.PdfTargetDictionary Put(PdfName key, PdfObject value) {
GetPdfObject().Put(key, value);
return this;
}
+ ///
protected internal override bool IsWrappedObjectMustBeIndirect() {
return false;
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/action/PdfWin.cs b/itext/itext.kernel/itext/kernel/pdf/action/PdfWin.cs
index 985489c02b..31f5eafc60 100644
--- a/itext/itext.kernel/itext/kernel/pdf/action/PdfWin.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/action/PdfWin.cs
@@ -44,16 +44,40 @@ source product.
using iText.Kernel.Pdf;
namespace iText.Kernel.Pdf.Action {
+ /// This class is a wrapper around a Windows launch parameter dictionary.
public class PdfWin : PdfObjectWrapper {
+ /// Creates a new wrapper around an existing Windows launch parameter dictionary.
+ /// the dictionary to create a wrapper for
public PdfWin(PdfDictionary pdfObject)
: base(pdfObject) {
}
+ /// Creates a new wrapper around a newly created Windows launch parameter dictionary.
+ ///
+ /// the file name of the application that shall be launched or the document that shall be opened or printed,
+ /// in standard Windows pathname format. If the name string includes a backslash character (\),
+ /// the backslash shall itself be preceded by a backslash.
+ ///
public PdfWin(PdfString f)
: this(new PdfDictionary()) {
GetPdfObject().Put(PdfName.F, f);
}
+ /// Creates a new wrapper around a newly created Windows launch parameter dictionary.
+ ///
+ /// the file name of the application that shall be launched or the document that shall be opened or printed,
+ /// in standard Windows pathname format. If the name string includes a backslash character (\),
+ /// the backslash shall itself be preceded by a backslash
+ ///
+ /// a bye string specifying the default directory in standard DOS syntax
+ ///
+ /// an ASCII string specifying the operation to perform on the file. Shall be one of the following:
+ /// "open", "print"
+ ///
+ ///
+ /// a parameter string that shall be passed to the application.
+ /// This entry shall be omitted if a document is abound to be opened
+ ///
public PdfWin(PdfString f, PdfString d, PdfString o, PdfString p)
: this(new PdfDictionary()) {
GetPdfObject().Put(PdfName.F, f);
@@ -62,6 +86,7 @@ public PdfWin(PdfString f, PdfString d, PdfString o, PdfString p)
GetPdfObject().Put(PdfName.P, p);
}
+ ///
protected internal override bool IsWrappedObjectMustBeIndirect() {
return false;
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/annot/PdfAnnotation.cs b/itext/itext.kernel/itext/kernel/pdf/annot/PdfAnnotation.cs
index 7c728ce764..12d4b2d1a6 100644
--- a/itext/itext.kernel/itext/kernel/pdf/annot/PdfAnnotation.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/annot/PdfAnnotation.cs
@@ -49,74 +49,290 @@ source product.
using iText.Kernel.Pdf.Layer;
namespace iText.Kernel.Pdf.Annot {
+ /// This is a super class for the annotation dictionary wrappers.
+ ///
+ /// This is a super class for the annotation dictionary wrappers. Derived classes represent
+ /// different standard types of annotations. See ISO-320001 12.5.6, “Annotation Types.”
+ ///
public abstract class PdfAnnotation : PdfObjectWrapper {
- /// Annotation flags.
+ /// Annotation flag.
+ ///
+ /// Annotation flag.
+ /// See also
+ ///
+ /// and ISO-320001, table 165.
+ ///
public const int INVISIBLE = 1;
+ /// Annotation flag.
+ ///
+ /// Annotation flag.
+ /// See also
+ ///
+ /// and ISO-320001, table 165.
+ ///
public const int HIDDEN = 2;
+ /// Annotation flag.
+ ///
+ /// Annotation flag.
+ /// See also
+ ///
+ /// and ISO-320001, table 165.
+ ///
public const int PRINT = 4;
+ /// Annotation flag.
+ ///
+ /// Annotation flag.
+ /// See also
+ ///
+ /// and ISO-320001, table 165.
+ ///
public const int NO_ZOOM = 8;
+ /// Annotation flag.
+ ///
+ /// Annotation flag.
+ /// See also
+ ///
+ /// and ISO-320001, table 165.
+ ///
public const int NO_ROTATE = 16;
+ /// Annotation flag.
+ ///
+ /// Annotation flag.
+ /// See also
+ ///
+ /// and ISO-320001, table 165.
+ ///
public const int NO_VIEW = 32;
+ /// Annotation flag.
+ ///
+ /// Annotation flag.
+ /// See also
+ ///
+ /// and ISO-320001, table 165.
+ ///
public const int READ_ONLY = 64;
+ /// Annotation flag.
+ ///
+ /// Annotation flag.
+ /// See also
+ ///
+ /// and ISO-320001, table 165.
+ ///
public const int LOCKED = 128;
+ /// Annotation flag.
+ ///
+ /// Annotation flag.
+ /// See also
+ ///
+ /// and ISO-320001, table 165.
+ ///
public const int TOGGLE_NO_VIEW = 256;
+ /// Annotation flag.
+ ///
+ /// Annotation flag.
+ /// See also
+ ///
+ /// and ISO-320001, table 165.
+ ///
public const int LOCKED_CONTENTS = 512;
- /// Annotation highlighting modes.
+ /// Widget annotation highlighting mode.
+ ///
+ /// Widget annotation highlighting mode. See ISO-320001, Table 188 (H key).
+ /// Also see
+ ///
+ /// .
+ ///
public static readonly PdfName HIGHLIGHT_NONE = PdfName.N;
+ /// Widget annotation highlighting mode.
+ ///
+ /// Widget annotation highlighting mode. See ISO-320001, Table 188 (H key).
+ /// Also see
+ ///
+ /// .
+ ///
public static readonly PdfName HIGHLIGHT_INVERT = PdfName.I;
+ /// Widget annotation highlighting mode.
+ ///
+ /// Widget annotation highlighting mode. See ISO-320001, Table 188 (H key).
+ /// Also see
+ ///
+ /// .
+ ///
public static readonly PdfName HIGHLIGHT_OUTLINE = PdfName.O;
+ /// Widget annotation highlighting mode.
+ ///
+ /// Widget annotation highlighting mode. See ISO-320001, Table 188 (H key).
+ /// Also see
+ ///
+ /// .
+ ///
public static readonly PdfName HIGHLIGHT_PUSH = PdfName.P;
+ /// Widget annotation highlighting mode.
+ ///
+ /// Widget annotation highlighting mode. See ISO-320001, Table 188 (H key).
+ /// Also see
+ ///
+ /// .
+ ///
public static readonly PdfName HIGHLIGHT_TOGGLE = PdfName.T;
- /// Annotation highlighting modes.
+ /// Annotation border style.
+ ///
+ /// Annotation border style. See ISO-320001, Table 166 (S key).
+ /// Also see
+ ///
+ ///
public static readonly PdfName STYLE_SOLID = PdfName.S;
+ /// Annotation border style.
+ ///
+ /// Annotation border style. See ISO-320001, Table 166 (S key).
+ /// Also see
+ ///
+ ///
public static readonly PdfName STYLE_DASHED = PdfName.D;
+ /// Annotation border style.
+ ///
+ /// Annotation border style. See ISO-320001, Table 166 (S key).
+ /// Also see
+ ///
+ ///
public static readonly PdfName STYLE_BEVELED = PdfName.B;
+ /// Annotation border style.
+ ///
+ /// Annotation border style. See ISO-320001, Table 166 (S key).
+ /// Also see
+ ///
+ ///
public static readonly PdfName STYLE_INSET = PdfName.I;
+ /// Annotation border style.
+ ///
+ /// Annotation border style. See ISO-320001, Table 166 (S key).
+ /// Also see
+ ///
+ ///
public static readonly PdfName STYLE_UNDERLINE = PdfName.U;
- /// Annotation states.
+ /// Annotation state.
+ ///
+ /// Annotation state. See ISO-320001 12.5.6.3 "Annotation States" and Table 171 in particular.
+ /// Also see
+ ///
+ /// .
+ ///
public static readonly PdfString Marked = new PdfString("Marked");
+ /// Annotation state.
+ ///
+ /// Annotation state. See ISO-320001 12.5.6.3 "Annotation States" and Table 171 in particular.
+ /// Also see
+ ///
+ /// .
+ ///
public static readonly PdfString Unmarked = new PdfString("Unmarked");
+ /// Annotation state.
+ ///
+ /// Annotation state. See ISO-320001 12.5.6.3 "Annotation States" and Table 171 in particular.
+ /// Also see
+ ///
+ /// .
+ ///
public static readonly PdfString Accepted = new PdfString("Accepted");
+ /// Annotation state.
+ ///
+ /// Annotation state. See ISO-320001 12.5.6.3 "Annotation States" and Table 171 in particular.
+ /// Also see
+ ///
+ /// .
+ ///
public static readonly PdfString Rejected = new PdfString("Rejected");
+ /// Annotation state.
+ ///
+ /// Annotation state. See ISO-320001 12.5.6.3 "Annotation States" and Table 171 in particular.
+ /// Also see
+ ///
+ /// .
+ ///
public static readonly PdfString Canceled = new PdfString("Cancelled");
+ /// Annotation state.
+ ///
+ /// Annotation state. See ISO-320001 12.5.6.3 "Annotation States" and Table 171 in particular.
+ /// Also see
+ ///
+ /// .
+ ///
public static readonly PdfString Completed = new PdfString("Completed");
+ /// Annotation state.
+ ///
+ /// Annotation state. See ISO-320001 12.5.6.3 "Annotation States" and Table 171 in particular.
+ /// Also see
+ ///
+ /// .
+ ///
public static readonly PdfString None = new PdfString("None");
- /// Annotation state models.
+ /// Annotation state model.
+ ///
+ /// Annotation state model. See ISO-320001, Table 172 (StateModel key).
+ /// Also see
+ ///
+ /// .
+ ///
public static readonly PdfString MarkedModel = new PdfString("Marked");
+ /// Annotation state model.
+ ///
+ /// Annotation state model. See ISO-320001, Table 172 (StateModel key).
+ /// Also see
+ ///
+ /// .
+ ///
public static readonly PdfString ReviewModel = new PdfString("Review");
protected internal PdfPage page;
- public static iText.Kernel.Pdf.Annot.PdfAnnotation MakeAnnotation(PdfObject pdfObject, iText.Kernel.Pdf.Annot.PdfAnnotation
- parent) {
+ ///
+ /// Factory method that creates the type specific
+ ///
+ /// from the given
+ ///
+ /// that represents annotation object. This method is useful for property reading in reading mode or
+ /// modifying in stamping mode. See derived classes of this class to see possible specific annotation types
+ /// created.
+ ///
+ ///
+ /// a
+ ///
+ /// that represents annotation in the document.
+ ///
+ ///
+ /// created
+ ///
+ /// .
+ ///
+ public static iText.Kernel.Pdf.Annot.PdfAnnotation MakeAnnotation(PdfObject pdfObject) {
iText.Kernel.Pdf.Annot.PdfAnnotation annotation = null;
if (pdfObject.IsIndirectReference()) {
pdfObject = ((PdfIndirectReference)pdfObject).GetRefersTo();
@@ -229,17 +445,40 @@ public static iText.Kernel.Pdf.Annot.PdfAnnotation MakeAnnotation(PdfObject pdfO
}
}
}
- if (annotation is PdfMarkupAnnotation) {
- PdfMarkupAnnotation markup = (PdfMarkupAnnotation)annotation;
- PdfDictionary inReplyTo = markup.GetInReplyToObject();
- if (inReplyTo != null) {
- markup.SetInReplyTo(MakeAnnotation(inReplyTo));
- }
- PdfDictionary popup = markup.GetPopupObject();
- if (popup != null) {
- markup.SetPopup((PdfPopupAnnotation)MakeAnnotation(popup, markup));
- }
- }
+ return annotation;
+ }
+
+ ///
+ /// Factory method that creates the type specific
+ ///
+ /// from the given
+ ///
+ /// that represents annotation object. This method is useful for property reading in reading mode or
+ /// modifying in stamping mode.
+ ///
+ ///
+ /// a
+ ///
+ /// that represents annotation in the document.
+ ///
+ ///
+ /// parent annotation of the
+ ///
+ /// to be created. This parameter is
+ /// only needed if passed
+ ///
+ /// represents a pop-up annotation in the document.
+ ///
+ ///
+ /// created
+ ///
+ /// .
+ ///
+ [System.ObsoleteAttribute(@"This method will be removed in iText 7.1. Please, simply use MakeAnnotation(iText.Kernel.Pdf.PdfObject) ."
+ )]
+ public static iText.Kernel.Pdf.Annot.PdfAnnotation MakeAnnotation(PdfObject pdfObject, iText.Kernel.Pdf.Annot.PdfAnnotation
+ parent) {
+ iText.Kernel.Pdf.Annot.PdfAnnotation annotation = MakeAnnotation(pdfObject);
if (annotation is PdfPopupAnnotation) {
PdfPopupAnnotation popup = (PdfPopupAnnotation)annotation;
if (parent != null) {
@@ -260,6 +499,13 @@ protected internal PdfAnnotation(PdfDictionary pdfObject)
MarkObjectAsIndirect(GetPdfObject());
}
+ ///
+ /// Gets a
+ ///
+ /// which value is a subtype of this annotation.
+ /// See ISO-320001 12.5.6, “Annotation Types” for the reference to the possible types.
+ ///
+ /// subtype of this annotation.
public abstract PdfName GetSubtype();
/// Sets the layer this annotation belongs to.
@@ -268,56 +514,242 @@ public virtual void SetLayer(IPdfOCG layer) {
GetPdfObject().Put(PdfName.OC, layer.GetIndirectReference());
}
+ ///
+ /// Sets a
+ ///
+ /// to this annotation which will be performed when the annotation is activated.
+ ///
+ ///
+ ///
+ ///
+ /// to set to this annotation.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetAction(PdfAction action) {
return Put(PdfName.A, action.GetPdfObject());
}
+ ///
+ /// Sets an additional
+ ///
+ /// to this annotation which will be performed in response to
+ /// the specific trigger event defined by
+ ///
+ /// . See ISO-320001 12.6.3, "Trigger Events".
+ ///
+ ///
+ /// a
+ ///
+ /// that denotes a type of the additional action to set.
+ ///
+ ///
+ ///
+ ///
+ /// to set as additional to this annotation.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetAdditionalAction(PdfName key, PdfAction action) {
PdfAction.SetAdditionalAction(this, key, action);
return this;
}
+ ///
+ /// Gets the text that shall be displayed for the annotation or, if this type of annotation does not display text,
+ /// an alternate description of the annotation’s contents in human-readable form.
+ ///
+ /// annotation text content.
public virtual PdfString GetContents() {
return GetPdfObject().GetAsString(PdfName.Contents);
}
+ ///
+ /// Sets the text that shall be displayed for the annotation or, if this type of annotation does not display text,
+ /// an alternate description of the annotation’s contents in human-readable form.
+ ///
+ ///
+ /// a
+ ///
+ /// containing text content to be set to the annotation.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetContents(PdfString contents) {
return Put(PdfName.Contents, contents);
}
+ ///
+ /// Sets the text that shall be displayed for the annotation or, if this type of annotation does not display text,
+ /// an alternate description of the annotation’s contents in human-readable form.
+ ///
+ ///
+ /// a java
+ ///
+ /// containing text content to be set to the annotation.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetContents(String contents) {
return SetContents(new PdfString(contents));
}
+ ///
+ /// Gets a
+ ///
+ /// that represents a page of the document on which annotation is placed,
+ /// i.e. which has this annotation in it's /Annots array.
+ ///
+ ///
+ ///
+ ///
+ /// that is a page pdf object or null if annotation is not added to the page yet.
+ ///
public virtual PdfDictionary GetPageObject() {
return GetPdfObject().GetAsDictionary(PdfName.P);
}
+ ///
+ /// Gets a
+ ///
+ /// on which annotation is placed.
+ ///
+ ///
+ ///
+ ///
+ /// on which annotation is placed or null if annotation is not placed yet.
+ ///
public virtual PdfPage GetPage() {
+ if (page == null && GetPdfObject().IsIndirect()) {
+ PdfIndirectReference annotationIndirectReference = GetPdfObject().GetIndirectReference();
+ PdfDocument doc = annotationIndirectReference.GetDocument();
+ PdfDictionary pageDictionary = GetPageObject();
+ if (pageDictionary != null) {
+ page = doc.GetPage(pageDictionary);
+ }
+ else {
+ for (int i = 1; i <= doc.GetNumberOfPages(); i++) {
+ PdfPage docPage = doc.GetPage(i);
+ foreach (iText.Kernel.Pdf.Annot.PdfAnnotation annot in docPage.GetAnnotations()) {
+ if (annot.GetPdfObject().GetIndirectReference().Equals(annotationIndirectReference)) {
+ page = docPage;
+ break;
+ }
+ }
+ }
+ }
+ }
return page;
}
+ /// Method that modifies annotation page property, which defines to which page annotation belongs.
+ ///
+ /// Method that modifies annotation page property, which defines to which page annotation belongs.
+ /// Keep in mind that this doesn't actually add an annotation to the page,
+ /// it should be done via
+ ///
+ /// .
+ /// Also you don't need to set this property manually, this is done automatically on addition to the page.
+ ///
+ ///
+ /// the
+ ///
+ /// to which annotation will be added.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetPage(PdfPage page) {
this.page = page;
return Put(PdfName.P, page.GetPdfObject());
}
+ ///
+ /// Gets the annotation name, a text string uniquely identifying it among all the
+ /// annotations on its page.
+ ///
+ ///
+ /// a
+ ///
+ /// with annotation name as it's value or null if name
+ /// is not specified.
+ ///
public virtual PdfString GetName() {
return GetPdfObject().GetAsString(PdfName.NM);
}
+ ///
+ /// Sets the annotation name, a text string uniquely identifying it among all the
+ /// annotations on its page.
+ ///
+ ///
+ /// a
+ ///
+ /// to be set as annotation name.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetName(PdfString name) {
return Put(PdfName.NM, name);
}
+ /// The date and time when the annotation was most recently modified.
+ ///
+ /// The date and time when the annotation was most recently modified.
+ /// This is an optional property of the annotation.
+ ///
+ ///
+ /// a
+ ///
+ /// with the modification date as it's value or null if date is not specified.
+ ///
public virtual PdfString GetDate() {
return GetPdfObject().GetAsString(PdfName.M);
}
+ /// The date and time when the annotation was most recently modified.
+ ///
+ /// a
+ ///
+ /// with date. The format should be a date string as described
+ /// in ISO-320001 7.9.4, “Dates”.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetDate(PdfString date) {
return Put(PdfName.M, date);
}
+ /// A set of flags specifying various characteristics of the annotation (see ISO-320001 12.5.3, “Annotation Flags”).
+ ///
+ ///
+ /// A set of flags specifying various characteristics of the annotation (see ISO-320001 12.5.3, “Annotation Flags”).
+ /// For specific annotation flag constants see
+ ///
+ /// .
+ /// Default value: 0.
+ ///
+ /// an integer interpreted as one-bit flags specifying various characteristics of the annotation.
public virtual int GetFlags() {
PdfNumber f = GetPdfObject().GetAsNumber(PdfName.F);
if (f != null) {
@@ -328,51 +760,273 @@ public virtual int GetFlags() {
}
}
+ /// Sets a set of flags specifying various characteristics of the annotation (see ISO-320001 12.5.3, “Annotation Flags”).
+ ///
+ ///
+ /// Sets a set of flags specifying various characteristics of the annotation (see ISO-320001 12.5.3, “Annotation Flags”).
+ /// On the contrary from
+ ///
+ /// , this method sets a complete set of enabled and disabled flags at once.
+ /// If not set specifically the default value is 0.
+ ///
+ /// an integer interpreted as set of one-bit flags specifying various characteristics of the annotation.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetFlags(int flags) {
return Put(PdfName.F, new PdfNumber(flags));
}
+ /// Sets a flag that specifies a characteristic of the annotation to enabled state (see ISO-320001 12.5.3, “Annotation Flags”).
+ ///
+ ///
+ /// Sets a flag that specifies a characteristic of the annotation to enabled state (see ISO-320001 12.5.3, “Annotation Flags”).
+ /// On the contrary from
+ ///
+ /// , this method sets only specified flags to enabled state,
+ /// but doesn't disable other flags.
+ /// Possible flags:
+ ///
+ /// -
+ ///
+ /// - If set, do not display the annotation if it does not belong to one of the
+ /// standard annotation types and no annotation handler is available. If clear, display such unknown annotation
+ /// using an appearance stream specified by its appearance dictionary, if any.
+ ///
+ /// -
+ ///
+ /// - If set, do not display or print the annotation or allow it to interact with
+ /// the user, regardless of its annotation type or whether an annotation handler is available.
+ ///
+ /// -
+ ///
+ /// - If set, print the annotation when the page is printed. If clear, never print
+ /// the annotation, regardless of whether it is displayed on the screen.
+ ///
+ /// -
+ ///
+ /// - If set, do not scale the annotation’s appearance to match the magnification of
+ /// the page. The location of the annotation on the page (defined by the upper-left corner of its annotation
+ /// rectangle) shall remain fixed, regardless of the page magnification.}
+ ///
+ /// -
+ ///
+ /// - If set, do not rotate the annotation’s appearance to match the rotation
+ /// of the page. The upper-left corner of the annotation rectangle shall remain in a fixed location on the page,
+ /// regardless of the page rotation.
+ ///
+ /// -
+ ///
+ /// - If set, do not display the annotation on the screen or allow it to interact
+ /// with the user. The annotation may be printed (depending on the setting of the Print flag) but should be considered
+ /// hidden for purposes of on-screen display and user interaction.
+ ///
+ /// -
+ ///
+ /// - If set, do not allow the annotation to interact with the user. The annotation
+ /// may be displayed or printed (depending on the settings of the NoView and Print flags) but should not respond to mouse
+ /// clicks or change its appearance in response to mouse motions.
+ ///
+ /// -
+ ///
+ /// - If set, do not allow the annotation to be deleted or its properties
+ /// (including position and size) to be modified by the user. However, this flag does not restrict changes to
+ /// the annotation’s contents, such as the value of a form field.
+ ///
+ /// -
+ ///
+ /// - If set, invert the interpretation of the NoView flag for certain events.
+ ///
+ /// -
+ ///
+ /// - If set, do not allow the contents of the annotation to be modified
+ /// by the user. This flag does not restrict deletion of the annotation or changes to other annotation properties,
+ /// such as position and size.
+ ///
+ ///
+ ///
+ /// - an integer interpreted as set of one-bit flags which will be enabled for this annotation.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetFlag(int flag) {
int flags = GetFlags();
flags = flags | flag;
return SetFlags(flags);
}
+ /// Resets a flag that specifies a characteristic of the annotation to disabled state (see ISO-320001 12.5.3, “Annotation Flags”).
+ ///
+ /// an integer interpreted as set of one-bit flags which will be reset to disabled state.
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation ResetFlag(int flag) {
int flags = GetFlags();
- flags = flags & (~flag & 0xff);
+ flags = flags & ~flag;
return SetFlags(flags);
}
+ ///
+ /// Checks if the certain flag that specifies a characteristic of the annotation
+ /// is in enabled state (see ISO-320001 12.5.3, “Annotation Flags”).
+ ///
+ ///
+ /// Checks if the certain flag that specifies a characteristic of the annotation
+ /// is in enabled state (see ISO-320001 12.5.3, “Annotation Flags”).
+ /// This method allows only one flag to be checked at once, use constants listed in
+ ///
+ /// .
+ ///
+ ///
+ /// an integer interpreted as set of one-bit flags. Only one bit must be set in this integer, otherwise
+ /// exception is thrown.
+ ///
+ /// true if the given flag is in enabled state.
public virtual bool HasFlag(int flag) {
+ if (flag == 0) {
+ return false;
+ }
+ if ((flag & flag - 1) != 0) {
+ throw new ArgumentException("Only one flag must be checked at once.");
+ }
int flags = GetFlags();
return (flags & flag) != 0;
}
+ ///
+ /// An appearance dictionary specifying how the annotation shall be presented visually on the page during its
+ /// interactions with the user (see ISO-320001 12.5.5, “Appearance Streams”).
+ ///
+ ///
+ /// An appearance dictionary specifying how the annotation shall be presented visually on the page during its
+ /// interactions with the user (see ISO-320001 12.5.5, “Appearance Streams”). An appearance dictionary is a dictionary
+ /// containing one or several appearance streams or subdictionaries.
+ ///
+ ///
+ /// an appearance
+ ///
+ /// or null if it is not specified.
+ ///
public virtual PdfDictionary GetAppearanceDictionary() {
return GetPdfObject().GetAsDictionary(PdfName.AP);
}
+ /// Specific appearance object corresponding to the specific appearance type.
+ ///
+ /// Specific appearance object corresponding to the specific appearance type. This object might be either an appearance
+ /// stream or an appearance subdictionary. In the latter case, the subdictionary defines multiple appearance streams
+ /// corresponding to different appearance states of the annotation. See ISO-320001 12.5.5, “Appearance Streams”.
+ ///
+ ///
+ /// a
+ ///
+ /// specifying appearance type. Possible types are
+ /// Normal
+ /// ,
+ /// Rollover
+ /// and
+ /// Down
+ /// .
+ ///
+ ///
+ /// null if their is no such appearance type or an appearance object which might be either
+ /// an appearance stream or an appearance subdictionary.
+ ///
public virtual PdfDictionary GetAppearanceObject(PdfName appearanceType) {
PdfDictionary ap = GetAppearanceDictionary();
if (ap != null) {
- return ap.GetAsDictionary(appearanceType);
+ PdfObject apObject = ap.Get(appearanceType);
+ if (apObject is PdfDictionary) {
+ return (PdfDictionary)apObject;
+ }
}
return null;
}
+ /// The normal appearance is used when the annotation is not interacting with the user.
+ ///
+ /// The normal appearance is used when the annotation is not interacting with the user.
+ /// This appearance is also used for printing the annotation.
+ /// See also
+ ///
+ /// .
+ ///
+ /// an appearance object which might be either an appearance stream or an appearance subdictionary.
public virtual PdfDictionary GetNormalAppearanceObject() {
return GetAppearanceObject(PdfName.N);
}
+ ///
+ /// The rollover appearance is used when the user moves the cursor into the annotation’s active area
+ /// without pressing the mouse button.
+ ///
+ ///
+ /// The rollover appearance is used when the user moves the cursor into the annotation’s active area
+ /// without pressing the mouse button. If not specified normal appearance is used.
+ /// See also
+ ///
+ /// .
+ ///
+ ///
+ /// null if rollover appearance is not specified or an appearance object which might be either
+ /// an appearance stream or an appearance subdictionary.
+ ///
public virtual PdfDictionary GetRolloverAppearanceObject() {
return GetAppearanceObject(PdfName.R);
}
+ /// The down appearance is used when the mouse button is pressed or held down within the annotation’s active area.
+ ///
+ ///
+ /// The down appearance is used when the mouse button is pressed or held down within the annotation’s active area.
+ /// If not specified normal appearance is used.
+ /// See also
+ ///
+ /// .
+ ///
+ ///
+ /// null if down appearance is not specified or an appearance object which might be either
+ /// an appearance stream or an appearance subdictionary.
+ ///
public virtual PdfDictionary GetDownAppearanceObject() {
return GetAppearanceObject(PdfName.D);
}
+ /// Sets a specific type of the appearance.
+ ///
+ /// Sets a specific type of the appearance. See
+ ///
+ /// and
+ ///
+ /// for more info.
+ ///
+ ///
+ /// a
+ ///
+ /// specifying appearance type. Possible types are
+ /// Normal
+ /// ,
+ /// Rollover
+ /// and
+ /// Down
+ /// .
+ ///
+ /// an appearance object which might be either an appearance stream or an appearance subdictionary.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetAppearance(PdfName appearanceType, PdfDictionary appearance
) {
PdfDictionary ap = GetAppearanceDictionary();
@@ -384,69 +1038,345 @@ public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetAppearance(PdfName appear
return this;
}
+ /// Sets normal appearance.
+ ///
+ /// Sets normal appearance. See
+ ///
+ /// and
+ ///
+ /// for more info.
+ ///
+ /// an appearance object which might be either an appearance stream or an appearance subdictionary.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetNormalAppearance(PdfDictionary appearance) {
return SetAppearance(PdfName.N, appearance);
}
+ /// Sets rollover appearance.
+ ///
+ /// Sets rollover appearance. See
+ ///
+ /// and
+ ///
+ /// for more info.
+ ///
+ /// an appearance object which might be either an appearance stream or an appearance subdictionary.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetRolloverAppearance(PdfDictionary appearance) {
return SetAppearance(PdfName.R, appearance);
}
+ /// Sets down appearance.
+ ///
+ /// Sets down appearance. See
+ ///
+ /// and
+ ///
+ /// for more info.
+ ///
+ /// an appearance object which might be either an appearance stream or an appearance subdictionary.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetDownAppearance(PdfDictionary appearance) {
return SetAppearance(PdfName.D, appearance);
}
+ ///
+ /// Sets a specific type of the appearance using
+ ///
+ /// wrapper.
+ /// This method is used to set only an appearance subdictionary. See
+ ///
+ /// and
+ ///
+ /// for more info.
+ ///
+ ///
+ /// a
+ ///
+ /// specifying appearance type. Possible types are
+ /// Normal
+ /// ,
+ /// Rollover
+ /// and
+ /// Down
+ /// .
+ ///
+ ///
+ /// an appearance subdictionary wrapped in
+ ///
+ /// .
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetAppearance(PdfName appearanceType, PdfAnnotationAppearance
appearance) {
return SetAppearance(appearanceType, appearance.GetPdfObject());
}
+ ///
+ /// Sets normal appearance using
+ ///
+ /// wrapper. This method is used to set only
+ /// appearance subdictionary. See
+ ///
+ /// and
+ ///
+ /// for more info.
+ ///
+ ///
+ /// an appearance subdictionary wrapped in
+ ///
+ /// .
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetNormalAppearance(PdfAnnotationAppearance appearance
) {
return SetAppearance(PdfName.N, appearance);
}
+ ///
+ /// Sets rollover appearance using
+ ///
+ /// wrapper. This method is used to set only
+ /// appearance subdictionary. See
+ ///
+ /// and
+ ///
+ /// for more info.
+ ///
+ ///
+ /// an appearance subdictionary wrapped in
+ ///
+ /// .
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetRolloverAppearance(PdfAnnotationAppearance appearance
) {
return SetAppearance(PdfName.R, appearance);
}
+ ///
+ /// Sets down appearance using
+ ///
+ /// wrapper. This method is used to set only
+ /// appearance subdictionary. See
+ ///
+ /// and
+ ///
+ /// for more info.
+ ///
+ ///
+ /// an appearance subdictionary wrapped in
+ ///
+ /// .
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetDownAppearance(PdfAnnotationAppearance appearance) {
return SetAppearance(PdfName.D, appearance);
}
+ ///
+ /// The annotation’s appearance state, which selects the applicable appearance stream
+ /// from an appearance subdictionary if there is such.
+ ///
+ ///
+ /// The annotation’s appearance state, which selects the applicable appearance stream
+ /// from an appearance subdictionary if there is such. See
+ ///
+ /// for more info.
+ ///
+ ///
+ /// a
+ ///
+ /// which defines selected appearance state.
+ ///
public virtual PdfName GetAppearanceState() {
return GetPdfObject().GetAsName(PdfName.AS);
}
+ ///
+ /// Sets the annotation’s appearance state, which selects the applicable appearance stream
+ /// from an appearance subdictionary.
+ ///
+ ///
+ /// Sets the annotation’s appearance state, which selects the applicable appearance stream
+ /// from an appearance subdictionary. See
+ ///
+ /// for more info.
+ ///
+ ///
+ /// a
+ ///
+ /// which defines appearance state to be selected.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetAppearanceState(PdfName @as) {
return Put(PdfName.AS, @as);
}
+ ///
+ ///
+ /// An array specifying the characteristics of the annotation’s border.
+ ///
+ ///
+ ///
+ /// An array specifying the characteristics of the annotation’s border.
+ /// The array consists of three numbers defining the horizontal corner radius,
+ /// vertical corner radius, and border width, all in default user space units.
+ /// If the corner radii are 0, the border has square (not rounded) corners; if
+ /// the border width is 0, no border is drawn.
+ ///
+ /// The array may have a fourth element, an optional dash array (see ISO-320001 8.4.3.6, “Line Dash Pattern”).
+ ///
+ ///
+ /// an
+ ///
+ /// specifying the characteristics of the annotation’s border.
+ ///
public virtual PdfArray GetBorder() {
return GetPdfObject().GetAsArray(PdfName.Border);
}
+ /// Sets the characteristics of the annotation’s border.
+ ///
+ /// an
+ ///
+ /// specifying the characteristics of the annotation’s border.
+ /// See
+ ///
+ /// for more detailes.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetBorder(PdfArray border) {
return Put(PdfName.Border, border);
}
+ ///
+ /// An array of numbers in the range 0.0 to 1.0, representing a colour used for the following purposes:
+ ///
+ /// - The background of the annotation’s icon when closed
+ /// - The title bar of the annotation’s pop-up window
+ /// - The border of a link annotation
+ ///
+ /// The number of array elements determines the colour space in which the colour shall be defined:
+ ///
+ /// - 0 - No colour; transparent
+ /// - 1 - DeviceGray
+ /// - 3 - DeviceRGB
+ /// - 4 - DeviceCMYK
+ ///
+ ///
+ /// An array of numbers in the range 0.0 to 1.0, representing an annotation colour.
public virtual PdfArray GetColorObject() {
return GetPdfObject().GetAsArray(PdfName.C);
}
+ /// Sets an annotation color.
+ ///
+ /// Sets an annotation color. For more details on annotation color purposes and the format
+ /// of the passing
+ ///
+ /// see
+ ///
+ /// .
+ ///
+ /// an array of numbers in the range 0.0 to 1.0, specifying color.
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetColor(PdfArray color) {
return Put(PdfName.C, color);
}
+ /// Sets an annotation color.
+ ///
+ /// Sets an annotation color. For more details on annotation color purposes and the format
+ /// of the passing array see
+ ///
+ /// .
+ ///
+ /// an array of numbers in the range 0.0 to 1.0, specifying color.
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetColor(float[] color) {
return SetColor(new PdfArray(color));
}
+ /// Sets an annotation color.
+ ///
+ /// Sets an annotation color. For more details on annotation color purposes
+ /// see
+ ///
+ /// .
+ ///
+ ///
+ ///
+ ///
+ /// object of the either
+ ///
+ /// ,
+ ///
+ /// or
+ ///
+ /// type.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetColor(Color color) {
return SetColor(new PdfArray(color.GetColorValue()));
}
+ ///
+ /// The integer key of the annotation’s entry in the structural parent tree
+ /// (see ISO-320001 14.7.4.4, “Finding Structure Elements from Content Items”).
+ ///
+ /// integer key in structural parent tree or -1 if annotation is not tagged.
public virtual int GetStructParentIndex() {
PdfNumber n = GetPdfObject().GetAsNumber(PdfName.StructParent);
if (n == null) {
@@ -457,34 +1387,136 @@ public virtual int GetStructParentIndex() {
}
}
+ ///
+ /// Sets he integer key of the annotation’s entry in the structural parent tree
+ /// (see ISO-320001 14.7.4.4, “Finding Structure Elements from Content Items”).
+ ///
+ ///
+ /// Sets he integer key of the annotation’s entry in the structural parent tree
+ /// (see ISO-320001 14.7.4.4, “Finding Structure Elements from Content Items”).
+ /// Note: Normally, there is no need to take care of this manually, struct parent index is set automatically
+ /// if annotation is added to the tagged document's page.
+ ///
+ ///
+ /// integer which is to be the key of the annotation's entry
+ /// in structural parent tree.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetStructParentIndex(int structParentIndex) {
return Put(PdfName.StructParent, new PdfNumber(structParentIndex));
}
- public virtual PdfArray GetQuadPoints() {
- return GetPdfObject().GetAsArray(PdfName.QuadPoints);
- }
-
+ /// A flag specifying whether the annotation shall initially be displayed open.
+ ///
+ /// A flag specifying whether the annotation shall initially be displayed open.
+ /// This flag has affect to not all kinds of annotations.
+ ///
+ /// true if annotation is initially open, false - if closed.
public virtual bool GetOpen() {
PdfBoolean open = GetPdfObject().GetAsBoolean(PdfName.Open);
return open != null && open.GetValue();
}
+ /// Sets a flag specifying whether the annotation shall initially be displayed open.
+ ///
+ /// Sets a flag specifying whether the annotation shall initially be displayed open.
+ /// This flag has affect to not all kinds of annotations.
+ ///
+ /// true if annotation shall initially be open, false - if closed.
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetOpen(bool open) {
return Put(PdfName.Open, new PdfBoolean(open));
}
+ /// An array of 8 × n numbers specifying the coordinates of n quadrilaterals in default user space.
+ ///
+ /// An array of 8 × n numbers specifying the coordinates of n quadrilaterals in default user space.
+ /// Quadrilaterals are used to define:
+ ///
+ /// - regions inside annotation rectangle in which the link annotation should be activated;
+ /// - a word or group of contiguous words in the text underlying the text markup annotation;
+ /// - the content region that is intended to be removed for a redaction annotation;
+ ///
+ ///
+ /// IMPORTANT NOTE: According to Table 179 in ISO 32000-1, the QuadPoints array lists the vertices in counterclockwise
+ /// order and the text orientation is defined by the first and second vertex. This basically means QuadPoints is
+ /// specified as lower-left, lower-right, top-right, top-left. HOWEVER, Adobe's interpretation
+ /// (tested at least with Acrobat 10, Acrobat 11, Reader 11) is top-left, top-right, lower-left, lower-right (Z-shaped order).
+ /// This means that if the QuadPoints array is specified according to the standard, the rendering is not as expected.
+ /// Other viewers seem to follow Adobe's interpretation. Hence we recommend to use and expect QuadPoints array in Z-order,
+ /// just as Acrobat and probably most other viewers expect.
+ ///
+ ///
+ /// an
+ ///
+ /// of 8 × n numbers specifying the coordinates of n quadrilaterals.
+ ///
+ public virtual PdfArray GetQuadPoints() {
+ return GetPdfObject().GetAsArray(PdfName.QuadPoints);
+ }
+
+ ///
+ /// Sets n quadrilaterals in default user space by passing an
+ ///
+ /// of 8 × n numbers. For more info of what
+ /// quadrilaterals define see
+ ///
+ /// .
+ ///
+ /// IMPORTANT NOTE: According to Table 179 in ISO 32000-1, the QuadPoints array lists the vertices in counterclockwise
+ /// order and the text orientation is defined by the first and second vertex. This basically means QuadPoints is
+ /// specified as lower-left, lower-right, top-right, top-left. HOWEVER, Adobe's interpretation
+ /// (tested at least with Acrobat 10, Acrobat 11, Reader 11) is top-left, top-right, lower-left, lower-right (Z-shaped order).
+ /// This means that if the QuadPoints array is specified according to the standard, the rendering is not as expected.
+ /// Other viewers seem to follow Adobe's interpretation. Hence we recommend to use and expect QuadPoints array in Z-order,
+ /// just as Acrobat and probably most other viewers expect.
+ ///
+ ///
+ /// an
+ ///
+ /// of 8 × n numbers specifying the coordinates of n quadrilaterals.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetQuadPoints(PdfArray quadPoints) {
return Put(PdfName.QuadPoints, quadPoints);
}
+ ///
+ /// Sets border style dictionary that has more settings than the array specified for the Border entry (
+ ///
+ /// ).
+ /// See ISO-320001, Table 166 and
+ ///
+ /// for more info.
+ ///
+ ///
+ /// a border style dictionary specifying the line width and dash pattern that shall be used
+ /// in drawing the annotation’s border.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetBorderStyle(PdfDictionary borderStyle) {
return Put(PdfName.BS, borderStyle);
}
- /// Setter for the annotation's border style.
+ /// Setter for the annotation's preset border style.
///
- /// Setter for the annotation's border style. Possible values are
+ /// Setter for the annotation's preset border style. Possible values are
///
/// -
///
@@ -502,9 +1534,11 @@ public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetBorderStyle(PdfDictionary
///
/// - A single line along the bottom of the annotation rectangle.
///
+ /// See also ISO-320001, Table 166.
///
/// The new value for the annotation's border style.
/// The annotation which this method was called on.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetBorderStyle(PdfName style) {
PdfDictionary styleDict = GetBorderStyle();
if (null == styleDict) {
@@ -514,6 +1548,24 @@ public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetBorderStyle(PdfName style
return SetBorderStyle(styleDict);
}
+ /// Setter for the annotation's preset dashed border style.
+ ///
+ /// Setter for the annotation's preset dashed border style. This property has affect only if
+ ///
+ /// style was used for the annotation border style (see
+ ///
+ /// .
+ /// See ISO-320001 8.4.3.6, “Line Dash Pattern” for the format in which dash pattern shall be specified.
+ ///
+ ///
+ /// a dash array defining a pattern of dashes and gaps that
+ /// shall be used in drawing a dashed border.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetDashPattern(PdfArray dashPattern) {
PdfDictionary styleDict = GetBorderStyle();
if (null == styleDict) {
@@ -523,57 +1575,221 @@ public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetDashPattern(PdfArray dash
return SetBorderStyle(styleDict);
}
+ /// The dictionaries for some annotation types (such as free text and polygon annotations) can include the BS entry.
+ ///
+ ///
+ /// The dictionaries for some annotation types (such as free text and polygon annotations) can include the BS entry.
+ /// That entry specifies a border style dictionary that has more settings than the array specified for the Border
+ /// entry (see
+ ///
+ /// ). If an annotation dictionary includes the BS entry, then the Border
+ /// entry is ignored. If annotation includes AP (see
+ ///
+ /// ) it takes
+ /// precedence over the BS entry. For more info on BS entry see ISO-320001, Table 166.
+ ///
+ ///
+ ///
+ ///
+ /// which is a border style dictionary or null if it is not specified.
+ ///
public virtual PdfDictionary GetBorderStyle() {
return GetPdfObject().GetAsDictionary(PdfName.BS);
}
- public static iText.Kernel.Pdf.Annot.PdfAnnotation MakeAnnotation(PdfObject pdfObject) {
- return MakeAnnotation(pdfObject, null);
- }
-
+ /// Sets annotation title.
+ /// Sets annotation title. This property affects not all annotation types.
+ ///
+ /// a
+ ///
+ /// which value is to be annotation title.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetTitle(PdfString title) {
return Put(PdfName.T, title);
}
+ /// Annotation title.
+ ///
+ /// Annotation title. For example for markup annotations, the title is the text label that shall be displayed in the
+ /// title bar of the annotation’s pop-up window when open and active. For movie annotation Movie actions
+ /// (ISO-320001 12.6.4.9, “Movie Actions”) may use this title to reference the movie annotation.
+ ///
+ ///
+ ///
+ ///
+ /// which value is an annotation title or null if it isn't specifed.
+ ///
public virtual PdfString GetTitle() {
return GetPdfObject().GetAsString(PdfName.T);
}
+ ///
+ /// Sets an appearance characteristics dictionary containing additional information for constructing the
+ /// annotation’s appearance stream.
+ ///
+ ///
+ /// Sets an appearance characteristics dictionary containing additional information for constructing the
+ /// annotation’s appearance stream. See ISO-320001, Table 189.
+ /// This property affects
+ ///
+ /// and
+ ///
+ /// .
+ ///
+ ///
+ /// the
+ ///
+ /// with additional information for appearance stream.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetAppearanceCharacteristics(PdfDictionary characteristics
) {
return Put(PdfName.MK, characteristics);
}
+ ///
+ /// An appearance characteristics dictionary containing additional information for constructing the
+ /// annotation’s appearance stream.
+ ///
+ ///
+ /// An appearance characteristics dictionary containing additional information for constructing the
+ /// annotation’s appearance stream. See ISO-320001, Table 189.
+ /// This property affects
+ ///
+ /// and
+ ///
+ /// .
+ ///
+ /// an appearance characteristics dictionary or null if it isn't specified.
public virtual PdfDictionary GetAppearanceCharacteristics() {
return GetPdfObject().GetAsDictionary(PdfName.MK);
}
+ ///
+ /// An
+ ///
+ /// to perform, such as launching an application, playing a sound,
+ /// changing an annotation’s appearance state etc, when the annotation is activated.
+ ///
+ ///
+ ///
+ ///
+ /// which defines the characteristics and behaviour of an action.
+ ///
public virtual PdfDictionary GetAction() {
return GetPdfObject().GetAsDictionary(PdfName.A);
}
+ /// An additional actions dictionary that extends the set of events that can trigger the execution of an action.
+ ///
+ ///
+ /// An additional actions dictionary that extends the set of events that can trigger the execution of an action.
+ /// See ISO-320001 12.6.3 Trigger Events.
+ ///
+ ///
+ /// an additional actions
+ ///
+ /// .
+ ///
+ ///
public virtual PdfDictionary GetAdditionalAction() {
return GetPdfObject().GetAsDictionary(PdfName.AA);
}
+ /// The annotation rectangle, defining the location of the annotation on the page in default user space units.
+ ///
+ ///
+ /// a
+ ///
+ /// which specifies a rectangle by two diagonally opposite corners.
+ /// Typically, the array is of form [llx lly urx ury].
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation SetRectangle(PdfArray array) {
return Put(PdfName.Rect, array);
}
+ /// The annotation rectangle, defining the location of the annotation on the page in default user space units.
+ ///
+ ///
+ /// a
+ ///
+ /// which specifies a rectangle by two diagonally opposite corners.
+ /// Typically, the array is of form [llx lly urx ury].
+ ///
public virtual PdfArray GetRectangle() {
return GetPdfObject().GetAsArray(PdfName.Rect);
}
+ ///
+ /// Inserts the value into into the underlying
+ ///
+ /// of this
+ ///
+ /// and associates it
+ /// with the specified key. If the key is already present in this
+ ///
+ /// , this method will override
+ /// the old value with the specified one.
+ ///
+ /// key to insert or to override
+ /// the value to associate with the specified key
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation Put(PdfName key, PdfObject value) {
GetPdfObject().Put(key, value);
return this;
}
+ ///
+ /// Removes the specified key from the underlying
+ ///
+ /// of this
+ ///
+ /// .
+ ///
+ /// key to be removed
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfAnnotation Remove(PdfName key) {
GetPdfObject().Remove(key);
return this;
}
+ ///
+ /// To manually flush a
+ /// PdfObject
+ /// behind this wrapper, you have to ensure
+ /// that this object is added to the document, i.e. it has an indirect reference.
+ /// Basically this means that before flushing you need to explicitly call
+ ///
+ /// .
+ /// For example: wrapperInstance.makeIndirect(document).flush();
+ /// Note that not every wrapper require this, only those that have such warning in documentation.
+ ///
+ public override void Flush() {
+ base.Flush();
+ }
+
protected internal override bool IsWrappedObjectMustBeIndirect() {
return true;
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/annot/PdfLineAnnotation.cs b/itext/itext.kernel/itext/kernel/pdf/annot/PdfLineAnnotation.cs
index 949da1e132..9bb987e724 100644
--- a/itext/itext.kernel/itext/kernel/pdf/annot/PdfLineAnnotation.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/annot/PdfLineAnnotation.cs
@@ -41,96 +41,477 @@ source product.
For more information, please contact iText Software Corp. at this
address: sales@itextpdf.com
*/
+using System;
using iText.Kernel.Geom;
using iText.Kernel.Pdf;
namespace iText.Kernel.Pdf.Annot {
+ /// The purpose of a line annotation is to display a single straight line on the page.
+ ///
+ /// The purpose of a line annotation is to display a single straight line on the page.
+ /// When opened, it displays a pop-up window containing the text of the associated note.
+ /// See also ISO-320001 12.5.6.7 "Line Annotations".
+ ///
public class PdfLineAnnotation : PdfMarkupAnnotation {
+ ///
+ /// Creates a
+ ///
+ /// instance.
+ ///
+ ///
+ /// the annotation rectangle, defining the location of the annotation on the page
+ /// in default user space units. See
+ ///
+ /// .
+ ///
+ ///
+ /// an array of four numbers, [x1 y1 x2 y2], specifying the starting and ending coordinates
+ /// of the line in default user space. See also
+ ///
+ /// .
+ ///
public PdfLineAnnotation(Rectangle rect, float[] line)
: base(rect) {
Put(PdfName.L, new PdfArray(line));
}
- public PdfLineAnnotation(PdfDictionary pdfObject)
- : base(pdfObject) {
+ ///
+ /// Creates a
+ ///
+ /// instance from the given
+ ///
+ /// that represents annotation object. This method is useful for property reading in reading mode or
+ /// modifying in stamping mode.
+ ///
+ ///
+ /// a
+ ///
+ /// that represents existing annotation in the document.
+ ///
+ public PdfLineAnnotation(PdfDictionary pdfDictionary)
+ : base(pdfDictionary) {
}
+ ///
public override PdfName GetSubtype() {
return PdfName.Line;
}
+ ///
+ /// An array of four numbers, [x1 y1 x2 y2], specifying the starting and ending coordinates of the line
+ /// in default user space.
+ ///
+ ///
+ /// An array of four numbers, [x1 y1 x2 y2], specifying the starting and ending coordinates of the line
+ /// in default user space. If the
+ ///
+ /// (see
+ ///
+ /// ) entry is present, this value represents
+ /// the endpoints of the leader lines rather than the endpoints of the line itself.
+ ///
+ /// An array of four numbers specifying the starting and ending coordinates of the line in default user space.
+ ///
public virtual PdfArray GetLine() {
return GetPdfObject().GetAsArray(PdfName.L);
}
+ /// An array of two names specifying the line ending styles that is used in drawing the line.
+ ///
+ /// An array of two names specifying the line ending styles that is used in drawing the line.
+ /// The first and second elements of the array shall specify the line ending styles for the endpoints defined,
+ /// respectively, by the first and second pairs of coordinates, (x1, y1) and (x2, y2), in the
+ ///
+ /// array
+ /// (see
+ ///
+ /// . For possible values see
+ ///
+ /// .
+ ///
+ ///
+ /// An array of two names specifying the line ending styles that is used in drawing the line; or null if line
+ /// endings style is not explicitly defined, default value is [/None /None].
+ ///
public virtual PdfArray GetLineEndingStyles() {
return GetPdfObject().GetAsArray(PdfName.LE);
}
+ /// Sets the line ending styles that are used in drawing the line.
+ ///
+ /// Sets the line ending styles that are used in drawing the line.
+ /// The first and second elements of the array shall specify the line ending styles for the endpoints defined,
+ /// respectively, by the first and second pairs of coordinates, (x1, y1) and (x2, y2), in the
+ ///
+ /// array
+ /// (see
+ ///
+ /// . Possible values for styles are:
+ ///
+ /// -
+ ///
+ /// - A square filled with the annotation's interior color, if any;
+ /// -
+ ///
+ /// - A circle filled with the annotation's interior color, if any;
+ /// -
+ ///
+ /// - A diamond shape filled with the annotation's interior color, if any;
+ /// -
+ ///
+ /// - Two short lines meeting in an acute angle to form an open arrowhead;
+ /// -
+ ///
+ /// - Two short lines meeting in an acute angle as in the
+ ///
+ /// style and
+ /// connected by a third line to form a triangular closed arrowhead filled with the annotation's interior color, if any;
+ /// -
+ ///
+ /// - No line ending;
+ /// -
+ ///
+ /// - A short line at the endpoint perpendicular to the line itself;
+ /// -
+ ///
+ /// - Two short lines in the reverse direction from
+ ///
+ /// ;
+ /// -
+ ///
+ /// - A triangular closed arrowhead in the reverse direction from
+ ///
+ /// ;
+ /// -
+ ///
+ /// - A short line at the endpoint approximately 30 degrees clockwise from perpendicular to the line itself;
+ ///
+ /// see also ISO-320001, Table 176 "Line ending styles".
+ ///
+ /// An array of two names specifying the line ending styles that is used in drawing the line.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation SetLineEndingStyles(PdfArray lineEndingStyles) {
return (iText.Kernel.Pdf.Annot.PdfLineAnnotation)Put(PdfName.LE, lineEndingStyles);
}
+ ///
+ /// The length of leader lines in default user space that extend from each endpoint of the line perpendicular
+ /// to the line itself.
+ ///
+ ///
+ /// The length of leader lines in default user space that extend from each endpoint of the line perpendicular
+ /// to the line itself. A positive value means that the leader lines appear in the direction that is clockwise
+ /// when traversing the line from its starting point to its ending point (as specified by
+ ///
+ /// (see
+ ///
+ /// );
+ /// a negative value indicates the opposite direction.
+ ///
+ /// a float specifying the length of leader lines in default user space.
+ [System.ObsoleteAttribute(@"use GetLeaderLineLength() instead.")]
public virtual float GetLeaderLine() {
- PdfNumber n = GetPdfObject().GetAsNumber(PdfName.LE);
+ PdfNumber n = GetPdfObject().GetAsNumber(PdfName.LL);
return n == null ? 0 : n.FloatValue();
}
+ ///
+ /// Sets the length of leader lines in default user space that extend from each endpoint of the line perpendicular
+ /// to the line itself.
+ ///
+ ///
+ /// Sets the length of leader lines in default user space that extend from each endpoint of the line perpendicular
+ /// to the line itself. A positive value means that the leader lines appear in the direction that is clockwise
+ /// when traversing the line from its starting point to its ending point (as specified by
+ ///
+ /// (see
+ ///
+ /// );
+ /// a negative value indicates the opposite direction.
+ ///
+ /// a float specifying the length of leader lines in default user space.
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
+ [System.ObsoleteAttribute(@"use SetLeaderLineLength(float) instead.")]
public virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation SetLeaderLine(float leaderLine) {
- return (iText.Kernel.Pdf.Annot.PdfLineAnnotation)Put(PdfName.LE, new PdfNumber(leaderLine));
+ return (iText.Kernel.Pdf.Annot.PdfLineAnnotation)Put(PdfName.LL, new PdfNumber(leaderLine));
}
+ ///
+ /// The length of leader lines in default user space that extend from each endpoint of the line perpendicular
+ /// to the line itself.
+ ///
+ ///
+ /// The length of leader lines in default user space that extend from each endpoint of the line perpendicular
+ /// to the line itself. A positive value means that the leader lines appear in the direction that is clockwise
+ /// when traversing the line from its starting point to its ending point (as specified by
+ ///
+ /// (see
+ ///
+ /// );
+ /// a negative value indicates the opposite direction.
+ ///
+ /// a float specifying the length of leader lines in default user space.
+ public virtual float GetLeaderLineLength() {
+ PdfNumber n = GetPdfObject().GetAsNumber(PdfName.LL);
+ return n == null ? 0 : n.FloatValue();
+ }
+
+ ///
+ /// Sets the length of leader lines in default user space that extend from each endpoint of the line perpendicular
+ /// to the line itself.
+ ///
+ ///
+ /// Sets the length of leader lines in default user space that extend from each endpoint of the line perpendicular
+ /// to the line itself. A positive value means that the leader lines appear in the direction that is clockwise
+ /// when traversing the line from its starting point to its ending point (as specified by
+ ///
+ /// (see
+ ///
+ /// );
+ /// a negative value indicates the opposite direction.
+ ///
+ /// a float specifying the length of leader lines in default user space.
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
+ public virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation SetLeaderLineLength(float leaderLineLength) {
+ return (iText.Kernel.Pdf.Annot.PdfLineAnnotation)Put(PdfName.LL, new PdfNumber(leaderLineLength));
+ }
+
+ ///
+ /// A non-negative number that represents the length of leader line extensions that extend from the line proper
+ /// 180 degrees from the leader lines.
+ ///
+ ///
+ /// a non-negative float that represents the length of leader line extensions; or if the leader line extension
+ /// is not explicitly set, returns the default value, which is 0.
+ ///
public virtual float GetLeaderLineExtension() {
PdfNumber n = GetPdfObject().GetAsNumber(PdfName.LLE);
return n == null ? 0 : n.FloatValue();
}
+ /// Sets the length of leader line extensions that extend from the line proper 180 degrees from the leader lines.
+ ///
+ ///
+ /// Sets the length of leader line extensions that extend from the line proper 180 degrees from the leader lines.
+ /// This value shall not be set unless
+ ///
+ /// (see
+ ///
+ /// ) is set.
+ ///
+ /// a non-negative float that represents the length of leader line extensions.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation SetLeaderLineExtension(float leaderLineExtension) {
return (iText.Kernel.Pdf.Annot.PdfLineAnnotation)Put(PdfName.LLE, new PdfNumber(leaderLineExtension));
}
+ ///
+ /// A non-negative number that represents the length of the leader line offset, which is the amount of empty space
+ /// between the endpoints of the annotation and the beginning of the leader lines.
+ ///
+ ///
+ /// a non-negative number that represents the length of the leader line offset,
+ /// or null if leader line offset is not set.
+ ///
public virtual float GetLeaderLineOffset() {
PdfNumber n = GetPdfObject().GetAsNumber(PdfName.LLO);
return n == null ? 0 : n.FloatValue();
}
+ ///
+ /// Sets the length of the leader line offset, which is the amount of empty space between the endpoints of the
+ /// annotation and the beginning of the leader lines.
+ ///
+ /// a non-negative number that represents the length of the leader line offset.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation SetLeaderLineOffset(float leaderLineOffset) {
return (iText.Kernel.Pdf.Annot.PdfLineAnnotation)Put(PdfName.LLO, new PdfNumber(leaderLineOffset));
}
+ ///
+ /// If true, the text specified by the
+ ///
+ /// or
+ ///
+ /// entries
+ /// (see
+ ///
+ /// and
+ ///
+ /// )
+ /// is replicated as a caption in the appearance of the line.
+ ///
+ ///
+ /// true, if the annotation text is replicated as a caption, false otherwise. If this property is
+ /// not set, default value is used which is false.
+ ///
public virtual bool GetContentsAsCaption() {
PdfBoolean b = GetPdfObject().GetAsBoolean(PdfName.Cap);
return b != null && b.GetValue();
}
+ ///
+ /// If set to true, the text specified by the
+ ///
+ /// or
+ ///
+ /// entries
+ /// (see
+ ///
+ /// and
+ ///
+ /// )
+ /// will be replicated as a caption in the appearance of the line.
+ ///
+ /// true, if the annotation text should be replicated as a caption, false otherwise.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation SetContentsAsCaption(bool contentsAsCaption) {
return (iText.Kernel.Pdf.Annot.PdfLineAnnotation)Put(PdfName.Cap, new PdfBoolean(contentsAsCaption));
}
+ /// A name describing the annotation's caption positioning.
+ ///
+ /// A name describing the annotation's caption positioning. Valid values are
+ ///
+ /// , meaning the caption
+ /// is centered inside the line, and
+ ///
+ /// , meaning the caption is on top of the line.
+ ///
+ ///
+ /// a name describing the annotation's caption positioning, or null if the caption positioning is not
+ /// explicitly defined (in this case the default value is used, which is
+ ///
+ /// ).
+ ///
public virtual PdfName GetCaptionPosition() {
return GetPdfObject().GetAsName(PdfName.CP);
}
+ /// Sets annotation's caption positioning.
+ ///
+ /// Sets annotation's caption positioning. Valid values are
+ ///
+ /// , meaning the caption
+ /// is centered inside the line, and
+ ///
+ /// , meaning the caption is on top of the line.
+ ///
+ /// a name describing the annotation's caption positioning.
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation SetCaptionPosition(PdfName captionPosition) {
return (iText.Kernel.Pdf.Annot.PdfLineAnnotation)Put(PdfName.CP, captionPosition);
}
+ /// A measure dictionary (see ISO-320001, Table 261) that specifies the scale and units that apply to the line annotation.
+ ///
+ ///
+ /// a
+ ///
+ /// that represents a measure dictionary.
+ ///
public virtual PdfDictionary GetMeasure() {
return GetPdfObject().GetAsDictionary(PdfName.Measure);
}
+ /// Sets a measure dictionary that specifies the scale and units that apply to the line annotation.
+ ///
+ /// a
+ ///
+ /// that represents a measure dictionary, see ISO-320001, Table 261 for valid
+ /// contents specification.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation SetMeasure(PdfDictionary measure) {
return (iText.Kernel.Pdf.Annot.PdfLineAnnotation)Put(PdfName.Measure, measure);
}
+ /// An array of two numbers that specifies the offset of the caption text from its normal position.
+ ///
+ /// An array of two numbers that specifies the offset of the caption text from its normal position.
+ /// The first value is the horizontal offset along the annotation line from its midpoint, with a positive value
+ /// indicating offset to the right and a negative value indicating offset to the left. The second value is the vertical
+ /// offset perpendicular to the annotation line, with a positive value indicating a shift up and a negative value indicating
+ /// a shift down.
+ ///
+ ///
+ /// a
+ ///
+ /// of two numbers that specifies the offset of the caption text from its normal position,
+ /// or null if caption offset is not explicitly specified (in this case a default value is used, which is [0, 0]).
+ ///
public virtual PdfArray GetCaptionOffset() {
return GetPdfObject().GetAsArray(PdfName.CO);
}
+ /// Sets the offset of the caption text from its normal position.
+ ///
+ /// a
+ ///
+ /// of two numbers that specifies the offset of the caption text from its
+ /// normal position. The first value defines the horizontal offset along the annotation line from
+ /// its midpoint, with a positive value indicating offset to the right and a negative value indicating
+ /// offset to the left. The second value defines the vertical offset perpendicular to the annotation line,
+ /// with a positive value indicating a shift up and a negative value indicating a shift down.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation SetCaptionOffset(PdfArray captionOffset) {
return (iText.Kernel.Pdf.Annot.PdfLineAnnotation)Put(PdfName.CO, captionOffset);
}
+ /// Sets the offset of the caption text from its normal position.
+ ///
+ /// an array of two floats that specifies the offset of the caption text from its
+ /// normal position. The first value defines the horizontal offset along the annotation line from
+ /// its midpoint, with a positive value indicating offset to the right and a negative value indicating
+ /// offset to the left. The second value defines the vertical offset perpendicular to the annotation line,
+ /// with a positive value indicating a shift up and a negative value indicating a shift down.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfLineAnnotation SetCaptionOffset(float[] captionOffset) {
return SetCaptionOffset(new PdfArray(captionOffset));
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/annot/PdfMarkupAnnotation.cs b/itext/itext.kernel/itext/kernel/pdf/annot/PdfMarkupAnnotation.cs
index 40996719a0..d20f6cb612 100644
--- a/itext/itext.kernel/itext/kernel/pdf/annot/PdfMarkupAnnotation.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/annot/PdfMarkupAnnotation.cs
@@ -41,11 +41,24 @@ source product.
For more information, please contact iText Software Corp. at this
address: sales@itextpdf.com
*/
+using iText.IO;
+using iText.IO.Log;
using iText.Kernel.Colors;
using iText.Kernel.Geom;
using iText.Kernel.Pdf;
namespace iText.Kernel.Pdf.Annot {
+ ///
+ /// This is a super class for the annotations which are defined as markup annotations
+ /// because they are used primarily to mark up PDF documents.
+ ///
+ ///
+ /// This is a super class for the annotations which are defined as markup annotations
+ /// because they are used primarily to mark up PDF documents. These annotations have
+ /// text that appears as part of the annotation and may be displayed in other ways
+ /// by a conforming reader, such as in a Comments pane.
+ /// See also ISO-320001 12.5.6.2 "Markup Annotations".
+ ///
public abstract class PdfMarkupAnnotation : PdfAnnotation {
protected internal PdfAnnotation inReplyTo = null;
@@ -59,113 +72,573 @@ protected internal PdfMarkupAnnotation(PdfDictionary pdfObject)
: base(pdfObject) {
}
+ ///
+ /// The text label that will be displayed in the title bar of the annotation's pop-up window
+ /// when open and active.
+ ///
+ ///
+ /// The text label that will be displayed in the title bar of the annotation's pop-up window
+ /// when open and active. This entry shall identify the user who added the annotation.
+ ///
+ ///
+ ///
+ ///
+ /// which value is an annotation text label content
+ /// or null if text is not specified.
+ ///
public virtual PdfString GetText() {
return GetPdfObject().GetAsString(PdfName.T);
}
+ ///
+ /// Sets the text label that will be displayed in the title bar of the annotation's pop-up window
+ /// when open and active.
+ ///
+ ///
+ /// Sets the text label that will be displayed in the title bar of the annotation's pop-up window
+ /// when open and active. This entry shall identify the user who added the annotation.
+ ///
+ ///
+ ///
+ ///
+ /// which value is an annotation text label content.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfMarkupAnnotation SetText(PdfString text) {
return (iText.Kernel.Pdf.Annot.PdfMarkupAnnotation)Put(PdfName.T, text);
}
+ /// The constant opacity value that will be used in painting the annotation.
+ ///
+ /// The constant opacity value that will be used in painting the annotation.
+ /// This value is applied to all visible elements of the annotation in its closed state
+ /// (including its background and border) but not to the pop-up window that appears when
+ /// the annotation is opened. Default value: 1.0.
+ ///
+ ///
+ /// a
+ ///
+ /// which value is in range between 0 and 1, which specifies the
+ /// level of opacity. This method returns null if opacity is not specified; in this case default
+ /// value is used, which is 1.
+ ///
public virtual PdfNumber GetOpacity() {
return GetPdfObject().GetAsNumber(PdfName.CA);
}
+ /// Sets the constant opacity value that will be used in painting the annotation.
+ ///
+ /// a
+ ///
+ /// which value is in range between 0 and 1, which specifies the
+ /// level of opacity.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfMarkupAnnotation SetOpacity(PdfNumber ca) {
return (iText.Kernel.Pdf.Annot.PdfMarkupAnnotation)Put(PdfName.CA, ca);
}
+ ///
+ /// A rich text string (see ISO-320001 12.7.3.4, “Rich Text Strings”) that
+ /// shall be displayed in the pop-up window when the annotation is opened.
+ ///
+ ///
+ /// text string or text stream that specifies rich text or null if
+ /// rich text is not specified.
+ ///
public virtual PdfObject GetRichText() {
- return GetPdfObject().GetAsDictionary(PdfName.RC);
- }
-
+ return GetPdfObject().Get(PdfName.RC);
+ }
+
+ ///
+ /// Sets a rich text string (see ISO-320001 12.7.3.4, “Rich Text Strings”) that
+ /// shall be displayed in the pop-up window when the annotation is opened.
+ ///
+ /// text string or text stream that specifies rich text.
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfMarkupAnnotation SetRichText(PdfObject richText) {
return (iText.Kernel.Pdf.Annot.PdfMarkupAnnotation)Put(PdfName.RC, richText);
}
+ /// The date and time when the annotation was created.
+ ///
+ /// a
+ ///
+ /// which value should be in the date format specified in (ISO-320001 7.9.4, “Dates”).
+ ///
public virtual PdfString GetCreationDate() {
return GetPdfObject().GetAsString(PdfName.CreationDate);
}
+ /// Sets the date and time when the annotation was created.
+ ///
+ ///
+ ///
+ /// which value should be in the date format
+ /// specified in (ISO-320001 7.9.4, “Dates”).
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfMarkupAnnotation SetCreationDate(PdfString creationDate) {
return (iText.Kernel.Pdf.Annot.PdfMarkupAnnotation)Put(PdfName.CreationDate, creationDate);
}
+ ///
+ /// An annotation object that this annotation is “in reply to.”
+ /// Both annotations shall be on the same page of the document.
+ ///
+ ///
+ /// An annotation object that this annotation is “in reply to.”
+ /// Both annotations shall be on the same page of the document.
+ /// The relationship between the two annotations shall be specified by the RT entry
+ /// (see
+ ///
+ /// ).
+ ///
+ ///
+ /// a
+ ///
+ /// that represents an annotation that this annotation is “in reply to.”
+ ///
public virtual PdfDictionary GetInReplyToObject() {
return GetPdfObject().GetAsDictionary(PdfName.IRT);
}
+ ///
+ /// An annotation that this annotation is “in reply to.”
+ /// Both annotations shall be on the same page of the document.
+ ///
+ ///
+ /// An annotation that this annotation is “in reply to.”
+ /// Both annotations shall be on the same page of the document.
+ /// The relationship between the two annotations shall be specified by the RT entry
+ /// (see
+ ///
+ /// ).
+ ///
+ ///
+ /// a
+ ///
+ /// that this annotation is “in reply to.”
+ ///
public virtual PdfAnnotation GetInReplyTo() {
+ if (inReplyTo == null) {
+ inReplyTo = MakeAnnotation(GetInReplyToObject());
+ }
return inReplyTo;
}
+ ///
+ /// Sets an annotation that this annotation is “in reply to.”
+ /// Both annotations shall be on the same page of the document.
+ ///
+ ///
+ /// Sets an annotation that this annotation is “in reply to.”
+ /// Both annotations shall be on the same page of the document.
+ /// The relationship between the two annotations shall be specified by the RT entry
+ /// (see
+ ///
+ /// ).
+ ///
+ ///
+ /// a
+ ///
+ /// that this annotation is “in reply to.”
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfMarkupAnnotation SetInReplyTo(PdfAnnotation inReplyTo) {
this.inReplyTo = inReplyTo;
return (iText.Kernel.Pdf.Annot.PdfMarkupAnnotation)Put(PdfName.IRT, inReplyTo.GetPdfObject());
}
+ /// Sets a pop-up annotation for entering or editing the text associated with this annotation.
+ ///
+ /// Sets a pop-up annotation for entering or editing the text associated with this annotation.
+ /// Pop-up annotation defines an associated with this annotation pop-up window that may contain text.
+ /// The Contents (see
+ ///
+ /// ) entry of the annotation that has
+ /// an associated popup specifies the text that shall be displayed when the pop-up window is opened.
+ ///
+ ///
+ /// an
+ ///
+ /// that will be associated with this annotation.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfMarkupAnnotation SetPopup(PdfPopupAnnotation popup) {
this.popup = popup;
- popup.Put(PdfName.Parent, GetPdfObject());
+ popup.SetParent(this);
return (iText.Kernel.Pdf.Annot.PdfMarkupAnnotation)Put(PdfName.Popup, popup.GetPdfObject());
}
+ /// An associated pop-up annotation object.
+ ///
+ /// An associated pop-up annotation object. See
+ ///
+ /// for more info.
+ ///
+ ///
+ /// a
+ ///
+ /// that represents an associated pop-up annotation,
+ /// or null if popup annotation is not specified.
+ ///
public virtual PdfDictionary GetPopupObject() {
return GetPdfObject().GetAsDictionary(PdfName.Popup);
}
+ /// An associated pop-up annotation for entering or editing the text associated with this annotation.
+ ///
+ ///
+ /// An associated pop-up annotation for entering or editing the text associated with this annotation.
+ /// Pop-up annotation defines an associated with this annotation pop-up window that may contain text.
+ /// The Contents (see
+ ///
+ /// ) entry of the annotation that has
+ /// an associated popup specifies the text that shall be displayed when the pop-up window is opened.
+ ///
+ ///
+ /// an
+ ///
+ /// that is associated with this annotation, or null if there is none.
+ ///
public virtual PdfPopupAnnotation GetPopup() {
+ if (popup == null) {
+ PdfAnnotation annotation = MakeAnnotation(GetPopupObject());
+ if (!(annotation is PdfPopupAnnotation)) {
+ ILogger logger = LoggerFactory.GetLogger(typeof(iText.Kernel.Pdf.Annot.PdfMarkupAnnotation));
+ logger.Warn(LogMessageConstant.POPUP_ENTRY_IS_NOT_POPUP_ANNOTATION);
+ return null;
+ }
+ popup = (PdfPopupAnnotation)annotation;
+ }
return popup;
}
+ /// Text representing a short description of the subject being addressed by the annotation.
+ ///
+ /// a
+ ///
+ /// which value is a annotation subject.
+ ///
public virtual PdfString GetSubject() {
return GetPdfObject().GetAsString(PdfName.Subj);
}
+ /// Sets the text representing a short description of the subject being addressed by the annotation.
+ ///
+ /// a
+ ///
+ /// which value is a annotation subject.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfMarkupAnnotation SetSubject(PdfString subject) {
return (iText.Kernel.Pdf.Annot.PdfMarkupAnnotation)Put(PdfName.Subj, subject);
}
+ ///
+ /// A name specifying the relationship (the “reply type”) between this annotation and one specified by IRT entry
+ /// (see
+ ///
+ /// ). Valid values are:
+ ///
+ /// -
+ ///
+ /// - The annotation shall be considered a reply to the annotation specified by IRT.
+ /// Conforming readers shall not display replies to an annotation individually but together in the form of
+ /// threaded comments.
+ /// -
+ ///
+ /// - The annotation shall be grouped with the annotation specified by IRT.
+ ///
+ ///
+ ///
+ /// a
+ ///
+ /// specifying relationship with the specified by the IRT entry; or null if reply
+ /// type is not specified, in this case the default value is
+ ///
+ /// .
+ ///
public virtual PdfName GetReplyType() {
return GetPdfObject().GetAsName(PdfName.RT);
}
+ ///
+ /// Sets the relationship (the “reply type”) between this annotation and one specified by IRT entry
+ /// (see
+ ///
+ /// ). For valid values see
+ ///
+ /// .
+ ///
+ ///
+ /// a
+ ///
+ /// specifying relationship with the specified by the IRT entry.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfMarkupAnnotation SetReplyType(PdfName replyType) {
return (iText.Kernel.Pdf.Annot.PdfMarkupAnnotation)Put(PdfName.RT, replyType);
}
+ /// A name describing the intent of the markup annotation.
+ ///
+ /// A name describing the intent of the markup annotation.
+ /// See
+ ///
+ /// for more info.
+ ///
+ ///
+ /// a
+ ///
+ /// describing the intent of the markup annotation, or null if not specified.
+ ///
public virtual PdfName GetIntent() {
return GetPdfObject().GetAsName(PdfName.IT);
}
+ /// Sets a name describing the intent of the markup annotation.
+ ///
+ /// Sets a name describing the intent of the markup annotation.
+ /// Intents allow conforming readers to distinguish between different uses and behaviors
+ /// of a single markup annotation type. If this entry is not present or its value is the same as the annotation type,
+ /// the annotation shall have no explicit intent and should behave in a generic manner in a conforming reader.
+ ///
+ /// See ISO-320001, free text annotations (Table 174), line annotations (Table 175), polygon annotations (Table 178),
+ /// and polyline annotations (Table 178) for the specific intent values for those types.
+ ///
+ ///
+ ///
+ /// a
+ ///
+ /// describing the intent of the markup annotation.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfMarkupAnnotation SetIntent(PdfName intent) {
return (iText.Kernel.Pdf.Annot.PdfMarkupAnnotation)Put(PdfName.IT, intent);
}
+ /// An external data dictionary specifying data that shall be associated with the annotation.
+ ///
+ /// An external data dictionary specifying data that shall be associated with the annotation.
+ /// This dictionary contains the following entries:
+ ///
+ /// -
+ ///
+ /// - (optional) If present, shall be
+ ///
+ /// .
+ /// -
+ ///
+ /// - (required) a name specifying the type of data that the markup annotation
+ /// shall be associated with. The only defined value is
+ ///
+ /// . Table 298 (ISO-320001)
+ /// lists the values that correspond to a subtype of Markup3D (See also
+ ///
+ /// ).
+ ///
+ ///
+ ///
+ /// An external data
+ ///
+ /// , or null if not specified.
+ ///
public virtual PdfDictionary GetExternalData() {
return GetPdfObject().GetAsDictionary(PdfName.ExData);
}
+ /// Sets an external data dictionary specifying data that shall be associated with the annotation.
+ ///
+ /// Sets an external data dictionary specifying data that shall be associated with the annotation.
+ /// This dictionary should contain the following entries:
+ ///
+ /// -
+ ///
+ /// - (optional) If present, shall be
+ ///
+ /// .
+ /// -
+ ///
+ /// - (required) a name specifying the type of data that the markup annotation
+ /// shall be associated with. The only defined value is
+ ///
+ /// . Table 298 (ISO-320001)
+ /// lists the values that correspond to a subtype of Markup3D (See also
+ ///
+ /// ).
+ ///
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfMarkupAnnotation SetExternalData(PdfName exData) {
return (iText.Kernel.Pdf.Annot.PdfMarkupAnnotation)Put(PdfName.ExData, exData);
}
+ ///
+ /// A set of four numbers describing the numerical differences between two rectangles:
+ /// the Rect entry of the annotation and another rectangle within that one, which
+ /// meaning depends on the type of the annotation:
+ ///
+ /// - for
+ ///
+ /// the inner rectangle is where the annotation's text should be displayed;
+ /// -
+ /// for
+ ///
+ /// and
+ ///
+ /// the inner rectangle is the actual boundaries
+ /// of the underlying square or circle;
+ ///
+ /// - for
+ ///
+ /// the inner rectangle is the actual boundaries of the underlying caret.
+ ///
+ ///
+ ///
+ /// a
+ ///
+ /// with four numbers which correspond to the differences in default user space between
+ /// the left, top, right, and bottom coordinates of Rect and those of the inner rectangle, respectively.
+ /// Each value shall be greater than or equal to 0. The sum of the top and bottom differences shall be
+ /// less than the height of Rect, and the sum of the left and right differences shall be less than
+ /// the width of Rect.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfMarkupAnnotation SetRectangleDifferences(PdfArray rect) {
return (iText.Kernel.Pdf.Annot.PdfMarkupAnnotation)Put(PdfName.RD, rect);
}
+ ///
+ /// A set of four numbers describing the numerical differences between two rectangles:
+ /// the Rect entry of the annotation and another rectangle within that one, which
+ /// meaning depends on the type of the annotation (see
+ ///
+ /// ).
+ ///
+ ///
+ /// null if not specified, otherwise a
+ ///
+ /// with four numbers which correspond to the
+ /// differences in default user space between the left, top, right, and bottom coordinates of Rect and those
+ /// of the inner rectangle, respectively.
+ ///
public virtual PdfArray GetRectangleDifferences() {
return GetPdfObject().GetAsArray(PdfName.RD);
}
- public virtual PdfDictionary GetBorderEffect() {
- return GetPdfObject().GetAsDictionary(PdfName.BE);
- }
-
+ ///
+ /// Some annotations types (
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ /// and
+ ///
+ /// ) may have a
+ ///
+ /// entry, which is a border effect dictionary that specifies
+ /// an effect that shall be applied to the border of the annotations.
+ ///
+ ///
+ /// a
+ ///
+ /// which contents shall be specified in accordance to ISO-320001, Table 167.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfMarkupAnnotation SetBorderEffect(PdfDictionary borderEffect) {
return (iText.Kernel.Pdf.Annot.PdfMarkupAnnotation)Put(PdfName.BE, borderEffect);
}
+ /// A border effect dictionary that specifies an effect that shall be applied to the border of the annotations.
+ ///
+ ///
+ /// a
+ ///
+ /// , which is a border effect dictionary (see ISO-320001, Table 167).
+ ///
+ public virtual PdfDictionary GetBorderEffect() {
+ return GetPdfObject().GetAsDictionary(PdfName.BE);
+ }
+
+ /// The interior color which is used to fill areas specific for different types of annotation.
+ ///
+ /// The interior color which is used to fill areas specific for different types of annotation. For
+ ///
+ /// and polyline annotation (
+ ///
+ /// - the annotation's line endings, for
+ ///
+ /// and
+ ///
+ /// - the annotation's rectangle or ellipse, for
+ ///
+ /// - the redacted
+ /// region after the affected content has been removed.
+ ///
+ ///
+ ///
+ ///
+ /// of either
+ ///
+ /// ,
+ ///
+ /// or
+ ///
+ /// type which defines
+ /// interior color of the annotation, or null if interior color is not specified.
+ ///
public virtual Color GetInteriorColor() {
PdfArray color = GetPdfObject().GetAsArray(PdfName.IC);
if (color == null) {
@@ -192,35 +665,170 @@ public virtual Color GetInteriorColor() {
}
}
+ ///
+ /// An array of numbers in the range 0.0 to 1.0 specifying the interior color which is used to fill areas specific
+ /// for different types of annotation.
+ ///
+ ///
+ /// An array of numbers in the range 0.0 to 1.0 specifying the interior color which is used to fill areas specific
+ /// for different types of annotation. For
+ ///
+ /// and polyline annotation (
+ ///
+ /// -
+ /// the annotation's line endings, for
+ ///
+ /// and
+ ///
+ /// - the annotation's
+ /// rectangle or ellipse, for
+ ///
+ /// - the redacted region after the affected content has been removed.
+ ///
+ ///
+ /// a
+ ///
+ /// of numbers in the range 0.0 to 1.0. The number of array elements determines
+ /// the colour space in which the colour is defined: 0 - No colour, transparent; 1 - DeviceGray,
+ /// 3 - DeviceRGB, 4 - DeviceCMYK. For the
+ ///
+ /// number of elements shall be
+ /// equal to 3 (which defines DeviceRGB colour space).
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfMarkupAnnotation SetInteriorColor(PdfArray interiorColor) {
return (iText.Kernel.Pdf.Annot.PdfMarkupAnnotation)Put(PdfName.IC, interiorColor);
}
+ ///
+ /// An array of numbers in the range 0.0 to 1.0 specifying the interior color which is used to fill areas specific
+ /// for different types of annotation.
+ ///
+ ///
+ /// An array of numbers in the range 0.0 to 1.0 specifying the interior color which is used to fill areas specific
+ /// for different types of annotation. See
+ ///
+ /// for more info.
+ ///
+ /// an array of floats in the range 0.0 to 1.0.
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfMarkupAnnotation SetInteriorColor(float[] interiorColor) {
return SetInteriorColor(new PdfArray(interiorColor));
}
+ /// The name of an icon that is used in displaying the annotation.
+ ///
+ /// The name of an icon that is used in displaying the annotation. Possible values are different for different
+ /// annotation types. See
+ ///
+ /// .
+ ///
+ ///
+ /// a
+ ///
+ /// that specifies the icon for displaying annotation, or null if icon name is not specified.
+ ///
public virtual PdfName GetIconName() {
return GetPdfObject().GetAsName(PdfName.Name);
}
+ /// The name of an icon that is used in displaying the annotation.
+ ///
+ /// a
+ ///
+ /// that specifies the icon for displaying annotation. Possible values are different
+ /// for different annotation types:
+ ///
+ /// -
+ ///
+ /// - Comment, Key, Note, Help, NewParagraph, Paragraph, Insert;
+ /// -
+ ///
+ /// - Approved, Experimental, NotApproved, AsIs, Expired, NotForPublicRelease,
+ /// Confidential, Final, Sold, Departmental, ForComment, TopSecret, Draft, ForPublicRelease.
+ /// -
+ ///
+ /// - GraphPushPin, PaperclipTag. Additional names may be supported as well.
+ /// -
+ ///
+ /// - Speaker and Mic. Additional names may be supported as well.
+ ///
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfMarkupAnnotation SetIconName(PdfName name) {
return (iText.Kernel.Pdf.Annot.PdfMarkupAnnotation)Put(PdfName.Name, name);
}
+ /// The default appearance string that shall be used in formatting the text.
+ /// The default appearance string that shall be used in formatting the text. See ISO-32001 12.7.3.3, “Variable Text”.
+ ///
+ ///
+ /// a
+ ///
+ /// that specifies the default appearance.
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfMarkupAnnotation SetDefaultAppearance(PdfString appearanceString) {
return (iText.Kernel.Pdf.Annot.PdfMarkupAnnotation)Put(PdfName.DA, appearanceString);
}
+ /// The default appearance string that shall be used in formatting the text.
+ /// The default appearance string that shall be used in formatting the text. See ISO-32001 12.7.3.3, “Variable Text”.
+ ///
+ ///
+ /// a
+ ///
+ /// that specifies the default appearance, or null if default appereance is not specified.
+ ///
public virtual PdfString GetDefaultAppearance() {
return GetPdfObject().GetAsString(PdfName.DA);
}
+ ///
+ /// A code specifying the form of quadding (justification) that is used in displaying the annotation's text:
+ /// 0 - Left-justified, 1 - Centered, 2 - Right-justified.
+ ///
+ ///
+ /// A code specifying the form of quadding (justification) that is used in displaying the annotation's text:
+ /// 0 - Left-justified, 1 - Centered, 2 - Right-justified. Default value: 0 (left-justified).
+ ///
+ /// a code specifying the form of quadding (justification), returns the default value if not explicitly specified.
+ ///
public virtual int GetJustification() {
PdfNumber q = GetPdfObject().GetAsNumber(PdfName.Q);
return q == null ? 0 : q.IntValue();
}
+ ///
+ /// A code specifying the form of quadding (justification) that is used in displaying the annotation's text:
+ /// 0 - Left-justified, 1 - Centered, 2 - Right-justified.
+ ///
+ ///
+ /// A code specifying the form of quadding (justification) that is used in displaying the annotation's text:
+ /// 0 - Left-justified, 1 - Centered, 2 - Right-justified. Default value: 0 (left-justified).
+ ///
+ /// a code specifying the form of quadding (justification).
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
public virtual iText.Kernel.Pdf.Annot.PdfMarkupAnnotation SetJustification(int justification) {
return (iText.Kernel.Pdf.Annot.PdfMarkupAnnotation)Put(PdfName.Q, new PdfNumber(justification));
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/annot/PdfPopupAnnotation.cs b/itext/itext.kernel/itext/kernel/pdf/annot/PdfPopupAnnotation.cs
index 7f991519c0..55eaf302c9 100644
--- a/itext/itext.kernel/itext/kernel/pdf/annot/PdfPopupAnnotation.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/annot/PdfPopupAnnotation.cs
@@ -65,6 +65,9 @@ public virtual PdfDictionary GetParentObject() {
}
public virtual PdfAnnotation GetParent() {
+ if (parent == null) {
+ parent = MakeAnnotation(GetParentObject());
+ }
return parent;
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/annot/PdfTextMarkupAnnotation.cs b/itext/itext.kernel/itext/kernel/pdf/annot/PdfTextMarkupAnnotation.cs
index 84436c0ee6..35b7016023 100644
--- a/itext/itext.kernel/itext/kernel/pdf/annot/PdfTextMarkupAnnotation.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/annot/PdfTextMarkupAnnotation.cs
@@ -65,21 +65,129 @@ public PdfTextMarkupAnnotation(PdfDictionary pdfObject)
: base(pdfObject) {
}
+ /// Creates a text markup annotation of highlight style subtype.
+ ///
+ /// Creates a text markup annotation of highlight style subtype.
+ ///
+ /// IMPORTANT NOTE on quadPoints argument:
+ /// According to Table 179 in ISO 32000-1, the QuadPoints array lists the vertices in counterclockwise
+ /// order and the text orientation is defined by the first and second vertex. This basically means QuadPoints is
+ /// specified as lower-left, lower-right, top-right, top-left. HOWEVER, Adobe's interpretation
+ /// (tested at least with Acrobat 10, Acrobat 11, Reader 11) is top-left, top-right, lower-left, lower-right (Z-shaped order).
+ /// This means that if the QuadPoints array is specified according to the standard, the rendering is not as expected.
+ /// Other viewers seem to follow Adobe's interpretation. Hence we recommend to use and expect QuadPoints array in Z-order,
+ /// just as Acrobat and probably most other viewers expect.
+ ///
+ ///
+ /// the annotation rectangle, defining the location of the annotation on the page
+ /// in default user space units.
+ ///
+ ///
+ /// An array of 8 × n numbers specifying the coordinates of n quadrilaterals in default user space.
+ /// Each quadrilateral shall encompasses a word or group of contiguous words in the text underlying
+ /// the annotation. The text is oriented with respect to the edge connecting first two vertices.
+ ///
+ ///
+ /// created
+ ///
+ /// of Highlight type.
+ ///
public static iText.Kernel.Pdf.Annot.PdfTextMarkupAnnotation CreateHighLight(Rectangle rect, float[] quadPoints
) {
return new iText.Kernel.Pdf.Annot.PdfTextMarkupAnnotation(rect, MarkupHighlight, quadPoints);
}
+ /// Creates a text markup annotation of underline style subtype.
+ ///
+ /// Creates a text markup annotation of underline style subtype.
+ ///
+ /// IMPORTANT NOTE on quadPoints argument:
+ /// According to Table 179 in ISO 32000-1, the QuadPoints array lists the vertices in counterclockwise
+ /// order and the text orientation is defined by the first and second vertex. This basically means QuadPoints is
+ /// specified as lower-left, lower-right, top-right, top-left. HOWEVER, Adobe's interpretation
+ /// (tested at least with Acrobat 10, Acrobat 11, Reader 11) is top-left, top-right, lower-left, lower-right (Z-shaped order).
+ /// This means that if the QuadPoints array is specified according to the standard, the rendering is not as expected.
+ /// Other viewers seem to follow Adobe's interpretation. Hence we recommend to use and expect QuadPoints array in Z-order,
+ /// just as Acrobat and probably most other viewers expect.
+ ///
+ ///
+ /// the annotation rectangle, defining the location of the annotation on the page
+ /// in default user space units.
+ ///
+ ///
+ /// An array of 8 × n numbers specifying the coordinates of n quadrilaterals in default user space.
+ /// Each quadrilateral shall encompasses a word or group of contiguous words in the text underlying
+ /// the annotation. The text is oriented with respect to the edge connecting first two vertices.
+ ///
+ ///
+ /// created
+ ///
+ /// of Underline type.
+ ///
public static iText.Kernel.Pdf.Annot.PdfTextMarkupAnnotation CreateUnderline(Rectangle rect, float[] quadPoints
) {
return new iText.Kernel.Pdf.Annot.PdfTextMarkupAnnotation(rect, MarkupUnderline, quadPoints);
}
+ /// Creates a text markup annotation of strikeout style subtype.
+ ///
+ /// Creates a text markup annotation of strikeout style subtype.
+ ///
+ /// IMPORTANT NOTE on quadPoints argument:
+ /// According to Table 179 in ISO 32000-1, the QuadPoints array lists the vertices in counterclockwise
+ /// order and the text orientation is defined by the first and second vertex. This basically means QuadPoints is
+ /// specified as lower-left, lower-right, top-right, top-left. HOWEVER, Adobe's interpretation
+ /// (tested at least with Acrobat 10, Acrobat 11, Reader 11) is top-left, top-right, lower-left, lower-right (Z-shaped order).
+ /// This means that if the QuadPoints array is specified according to the standard, the rendering is not as expected.
+ /// Other viewers seem to follow Adobe's interpretation. Hence we recommend to use and expect QuadPoints array in Z-order,
+ /// just as Acrobat and probably most other viewers expect.
+ ///
+ ///
+ /// the annotation rectangle, defining the location of the annotation on the page
+ /// in default user space units.
+ ///
+ ///
+ /// An array of 8 × n numbers specifying the coordinates of n quadrilaterals in default user space.
+ /// Each quadrilateral shall encompasses a word or group of contiguous words in the text underlying
+ /// the annotation. The text is oriented with respect to the edge connecting first two vertices.
+ ///
+ ///
+ /// created
+ ///
+ /// of Strikeout type.
+ ///
public static iText.Kernel.Pdf.Annot.PdfTextMarkupAnnotation CreateStrikeout(Rectangle rect, float[] quadPoints
) {
return new iText.Kernel.Pdf.Annot.PdfTextMarkupAnnotation(rect, MarkupStrikeout, quadPoints);
}
+ /// Creates a text markup annotation of squiggly-underline type.
+ ///
+ /// Creates a text markup annotation of squiggly-underline type.
+ ///
+ /// IMPORTANT NOTE on quadPoints argument:
+ /// According to Table 179 in ISO 32000-1, the QuadPoints array lists the vertices in counterclockwise
+ /// order and the text orientation is defined by the first and second vertex. This basically means QuadPoints is
+ /// specified as lower-left, lower-right, top-right, top-left. HOWEVER, Adobe's interpretation
+ /// (tested at least with Acrobat 10, Acrobat 11, Reader 11) is top-left, top-right, lower-left, lower-right (Z-shaped order).
+ /// This means that if the QuadPoints array is specified according to the standard, the rendering is not as expected.
+ /// Other viewers seem to follow Adobe's interpretation. Hence we recommend to use and expect QuadPoints array in Z-order,
+ /// just as Acrobat and probably most other viewers expect.
+ ///
+ ///
+ /// the annotation rectangle, defining the location of the annotation on the page
+ /// in default user space units.
+ ///
+ ///
+ /// An array of 8 × n numbers specifying the coordinates of n quadrilaterals in default user space.
+ /// Each quadrilateral shall encompasses a word or group of contiguous words in the text underlying
+ /// the annotation. The text is oriented with respect to the edge connecting first two vertices.
+ ///
+ ///
+ /// created
+ ///
+ /// of squiggly-underline type.
+ ///
public static iText.Kernel.Pdf.Annot.PdfTextMarkupAnnotation CreateSquiggly(Rectangle rect, float[] quadPoints
) {
return new iText.Kernel.Pdf.Annot.PdfTextMarkupAnnotation(rect, MarkupSquiggly, quadPoints);
diff --git a/itext/itext.kernel/itext/kernel/pdf/canvas/PdfCanvas.cs b/itext/itext.kernel/itext/kernel/pdf/canvas/PdfCanvas.cs
index eb56f93807..ba19bccffd 100644
--- a/itext/itext.kernel/itext/kernel/pdf/canvas/PdfCanvas.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/canvas/PdfCanvas.cs
@@ -362,6 +362,33 @@ public virtual iText.Kernel.Pdf.Canvas.PdfCanvas ConcatMatrix(double a, double b
return this;
}
+ ///
+ /// Concatenates the 2x3 affine transformation matrix to the current matrix
+ /// in the content stream managed by this Canvas.
+ ///
+ ///
+ /// Concatenates the 2x3 affine transformation matrix to the current matrix
+ /// in the content stream managed by this Canvas.
+ /// If an array not containing the 6 values of the matrix is passed,
+ /// The current canvas is returned unchanged.
+ ///
+ /// affine transformation stored as a PdfArray with 6 values
+ /// current canvas
+ public virtual iText.Kernel.Pdf.Canvas.PdfCanvas ConcatMatrix(PdfArray array) {
+ if (array.Size() != 6) {
+ //Throw exception or warning here
+ return this;
+ }
+ for (int i = 0; i < array.Size(); i++) {
+ if (!array.Get(i).IsNumber()) {
+ return this;
+ }
+ }
+ return ConcatMatrix(array.GetAsNumber(0).DoubleValue(), array.GetAsNumber(1).DoubleValue(), array.GetAsNumber
+ (2).DoubleValue(), array.GetAsNumber(3).DoubleValue(), array.GetAsNumber(4).DoubleValue(), array.GetAsNumber
+ (5).DoubleValue());
+ }
+
///
/// Concatenates the affine transformation matrix to the current matrix
/// in the content stream managed by this Canvas.
@@ -411,7 +438,7 @@ public virtual iText.Kernel.Pdf.Canvas.PdfCanvas EndVariableText() {
/// current canvas.
public virtual iText.Kernel.Pdf.Canvas.PdfCanvas SetFontAndSize(PdfFont font, float size) {
if (size < 0.0001f && size > -0.0001f) {
- throw new PdfException(PdfException.FontSizeTooSmall, size);
+ throw new PdfException(PdfException.FontSizeIsTooSmall, size);
}
currentGs.SetFontSize(size);
font.MakeIndirect(document);
@@ -620,8 +647,38 @@ public virtual iText.Kernel.Pdf.Canvas.PdfCanvas ShowText(GlyphLine text) {
float xPlacement = float.NaN;
float yPlacement = float.NaN;
if (glyph.HasPlacement()) {
- xPlacement = -GetSubrangeWidth(text, i + glyph.GetAnchorDelta(), i) + glyph.GetXPlacement() * fontSize;
- yPlacement = glyph.GetYAdvance() * fontSize;
+ {
+ float xPlacementAddition = 0;
+ int currentGlyphIndex = i;
+ Glyph currentGlyph = text.Get(i);
+ while (currentGlyph != null && currentGlyph.GetXPlacement() != 0) {
+ xPlacementAddition += currentGlyph.GetXPlacement();
+ if (currentGlyph.GetAnchorDelta() == 0) {
+ break;
+ }
+ else {
+ currentGlyphIndex += currentGlyph.GetAnchorDelta();
+ currentGlyph = text.Get(currentGlyphIndex);
+ }
+ }
+ xPlacement = -GetSubrangeWidth(text, currentGlyphIndex, i) + xPlacementAddition * fontSize;
+ }
+ {
+ float yPlacementAddition = 0;
+ int currentGlyphIndex = i;
+ Glyph currentGlyph = text.Get(i);
+ while (currentGlyph != null && currentGlyph.GetYPlacement() != 0) {
+ yPlacementAddition += currentGlyph.GetYPlacement();
+ if (currentGlyph.GetAnchorDelta() == 0) {
+ break;
+ }
+ else {
+ currentGlyph = text.Get(currentGlyphIndex + currentGlyph.GetAnchorDelta());
+ currentGlyphIndex += currentGlyph.GetAnchorDelta();
+ }
+ }
+ yPlacement = glyph.GetYAdvance() * fontSize + yPlacementAddition * fontSize;
+ }
contentStream.GetOutputStream().WriteFloat(xPlacement, true).WriteSpace().WriteFloat(yPlacement, true).WriteSpace
().WriteBytes(Td);
}
@@ -1570,7 +1627,6 @@ public virtual PdfXObject AddImage(ImageData image, float a, float b, float c, f
///
/// true if to add image as in-line.
/// created XObject or null in case of in-line image (asInline = true).
- ///
public virtual PdfXObject AddImage(ImageData image, iText.Kernel.Geom.Rectangle rect, bool asInline) {
return AddImage(image, rect.GetWidth(), 0, 0, rect.GetHeight(), rect.GetX(), rect.GetY(), asInline);
}
@@ -1581,7 +1637,6 @@ public virtual PdfXObject AddImage(ImageData image, iText.Kernel.Geom.Rectangle
///
/// true if to add image as in-line.
/// created XObject or null in case of in-line image (asInline = true).
- ///
public virtual PdfXObject AddImage(ImageData image, float x, float y, bool asInline) {
if (image.GetOriginalType() == ImageType.WMF) {
WmfImageHelper wmf = new WmfImageHelper(image);
@@ -1640,7 +1695,6 @@ public virtual PdfXObject AddImage(ImageData image, float x, float y, float widt
/// true if to add image as in-line.
///
/// created XObject or null in case of in-line image (asInline = true).
- ///
public virtual PdfXObject AddImage(ImageData image, float x, float y, float height, bool asInline, bool dummy
) {
return AddImage(image, height / image.GetHeight() * image.GetWidth(), 0, 0, height, x, y, asInline);
@@ -2001,7 +2055,6 @@ private iText.Kernel.Pdf.Canvas.PdfCanvas AddForm(PdfFormXObject form, float a,
///
///
/// current canvas.
- ///
private iText.Kernel.Pdf.Canvas.PdfCanvas AddForm(PdfFormXObject form, float x, float y) {
return AddForm(form, 1, 0, 0, 1, x, y);
}
@@ -2014,7 +2067,6 @@ private iText.Kernel.Pdf.Canvas.PdfCanvas AddForm(PdfFormXObject form, float x,
///
///
/// current canvas.
- ///
private iText.Kernel.Pdf.Canvas.PdfCanvas AddForm(PdfFormXObject form, iText.Kernel.Geom.Rectangle rect) {
return AddForm(form, rect.GetWidth(), 0, 0, rect.GetHeight(), rect.GetX(), rect.GetY());
}
@@ -2029,7 +2081,6 @@ private iText.Kernel.Pdf.Canvas.PdfCanvas AddForm(PdfFormXObject form, iText.Ker
///
///
/// current canvas.
- ///
private iText.Kernel.Pdf.Canvas.PdfCanvas AddForm(PdfFormXObject form, float x, float y, float width) {
PdfArray bbox = form.GetPdfObject().GetAsArray(PdfName.BBox);
if (bbox == null) {
diff --git a/itext/itext.kernel/itext/kernel/pdf/canvas/draw/DashedLine.cs b/itext/itext.kernel/itext/kernel/pdf/canvas/draw/DashedLine.cs
index 01a00b83ab..7a9bf8de3a 100644
--- a/itext/itext.kernel/itext/kernel/pdf/canvas/draw/DashedLine.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/canvas/draw/DashedLine.cs
@@ -72,8 +72,8 @@ public DashedLine(float lineWidth) {
public virtual void Draw(PdfCanvas canvas, Rectangle drawArea) {
canvas.SaveState().SetLineWidth(lineWidth).SetStrokeColor(color).SetLineDash(2, 2).MoveTo(drawArea.GetX(),
- drawArea.GetY() + drawArea.GetHeight() / 2).LineTo(drawArea.GetX() + drawArea.GetWidth(), drawArea.GetY
- () + drawArea.GetHeight() / 2).Stroke().RestoreState();
+ drawArea.GetY() + lineWidth / 2).LineTo(drawArea.GetX() + drawArea.GetWidth(), drawArea.GetY() + lineWidth
+ / 2).Stroke().RestoreState();
}
/// Gets line width in points
diff --git a/itext/itext.kernel/itext/kernel/pdf/canvas/draw/DottedLine.cs b/itext/itext.kernel/itext/kernel/pdf/canvas/draw/DottedLine.cs
index 399bdf5677..9b45b4b920 100644
--- a/itext/itext.kernel/itext/kernel/pdf/canvas/draw/DottedLine.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/canvas/draw/DottedLine.cs
@@ -83,8 +83,8 @@ public DottedLine(float lineWidth) {
public virtual void Draw(PdfCanvas canvas, Rectangle drawArea) {
canvas.SaveState().SetLineWidth(lineWidth).SetStrokeColor(color).SetLineDash(0, gap, gap / 2).SetLineCapStyle
- (PdfCanvasConstants.LineCapStyle.ROUND).MoveTo(drawArea.GetX(), drawArea.GetY()).LineTo(drawArea.GetX(
- ) + drawArea.GetWidth(), drawArea.GetY()).Stroke().RestoreState();
+ (PdfCanvasConstants.LineCapStyle.ROUND).MoveTo(drawArea.GetX(), drawArea.GetY() + lineWidth / 2).LineTo
+ (drawArea.GetX() + drawArea.GetWidth(), drawArea.GetY() + lineWidth / 2).Stroke().RestoreState();
}
/// Getter for the gap between the center of the dots of the dotted line.
diff --git a/itext/itext.kernel/itext/kernel/pdf/canvas/draw/SolidLine.cs b/itext/itext.kernel/itext/kernel/pdf/canvas/draw/SolidLine.cs
index 65202a2cb1..10eac8bf22 100644
--- a/itext/itext.kernel/itext/kernel/pdf/canvas/draw/SolidLine.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/canvas/draw/SolidLine.cs
@@ -68,8 +68,9 @@ public SolidLine(float lineWidth) {
}
public virtual void Draw(PdfCanvas canvas, Rectangle drawArea) {
- canvas.SaveState().SetStrokeColor(color).MoveTo(drawArea.GetX(), drawArea.GetY()).LineTo(drawArea.GetX() +
- drawArea.GetWidth(), drawArea.GetY()).Stroke().RestoreState();
+ canvas.SaveState().SetStrokeColor(color).SetLineWidth(lineWidth).MoveTo(drawArea.GetX(), drawArea.GetY() +
+ lineWidth / 2).LineTo(drawArea.GetX() + drawArea.GetWidth(), drawArea.GetY() + lineWidth / 2).Stroke(
+ ).RestoreState();
}
/// Gets line width in points
diff --git a/itext/itext.kernel/itext/kernel/pdf/canvas/parser/PdfCanvasProcessor.cs b/itext/itext.kernel/itext/kernel/pdf/canvas/parser/PdfCanvasProcessor.cs
index ba9b629c03..1b7c1a3483 100644
--- a/itext/itext.kernel/itext/kernel/pdf/canvas/parser/PdfCanvasProcessor.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/canvas/parser/PdfCanvasProcessor.cs
@@ -113,7 +113,7 @@ public class PdfCanvasProcessor {
private Stack markedContentStack = new Stack();
///
- /// Creates a new PDF Content Stream Processor that will send it's output to the
+ /// Creates a new PDF Content Stream Processor that will send its output to the
/// designated render listener.
///
///
@@ -131,6 +131,34 @@ public PdfCanvasProcessor(IEventListener eventListener) {
Reset();
}
+ ///
+ /// Creates a new PDF Content Stream Processor that will send its output to the
+ /// designated render listener.
+ ///
+ ///
+ /// Creates a new PDF Content Stream Processor that will send its output to the
+ /// designated render listener.
+ /// Also allows registration of custom IContentOperators that can influence
+ /// how (and whether or not) the PDF instructions will be parsed.
+ ///
+ ///
+ /// the
+ ///
+ /// that will receive rendering notifications
+ ///
+ ///
+ /// an optional map of custom
+ ///
+ /// s for rendering instructions
+ ///
+ public PdfCanvasProcessor(IEventListener eventListener, IDictionary additionalContentOperators
+ )
+ : this(eventListener) {
+ foreach (KeyValuePair entry in additionalContentOperators) {
+ RegisterContentOperator(entry.Key, entry.Value);
+ }
+ }
+
/// Registers a Do handler that will be called when Do for the provided XObject subtype is encountered during content processing.
///
///
diff --git a/itext/itext.kernel/itext/kernel/pdf/canvas/parser/PdfDocumentContentParser.cs b/itext/itext.kernel/itext/kernel/pdf/canvas/parser/PdfDocumentContentParser.cs
index d95120c092..93ae300ef2 100644
--- a/itext/itext.kernel/itext/kernel/pdf/canvas/parser/PdfDocumentContentParser.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/canvas/parser/PdfDocumentContentParser.cs
@@ -62,7 +62,8 @@ public PdfDocumentContentParser(PdfDocument pdfDocument) {
/// Processes content from the specified page number using the specified listener.
///
/// Processes content from the specified page number using the specified listener.
- /// Also allows registration of custom ContentOperators
+ /// Also allows registration of custom IContentOperators that can influence
+ /// how (and whether or not) the PDF instructions will be parsed.
///
///
/// the page number to process
@@ -73,10 +74,7 @@ public PdfDocumentContentParser(PdfDocument pdfDocument) {
public virtual E ProcessContent(int pageNumber, E renderListener, IDictionary
additionalContentOperators)
where E : IEventListener {
- PdfCanvasProcessor processor = new PdfCanvasProcessor(renderListener);
- foreach (KeyValuePair entry in additionalContentOperators) {
- processor.RegisterContentOperator(entry.Key, entry.Value);
- }
+ PdfCanvasProcessor processor = new PdfCanvasProcessor(renderListener, additionalContentOperators);
processor.ProcessPageContent(pdfDocument.GetPage(pageNumber));
return renderListener;
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/canvas/parser/PdfTextExtractor.cs b/itext/itext.kernel/itext/kernel/pdf/canvas/parser/PdfTextExtractor.cs
index 960f3bcd7b..dbf2c42572 100644
--- a/itext/itext.kernel/itext/kernel/pdf/canvas/parser/PdfTextExtractor.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/canvas/parser/PdfTextExtractor.cs
@@ -42,6 +42,7 @@ source product.
address: sales@itextpdf.com
*/
using System;
+using System.Collections.Generic;
using iText.Kernel.Pdf;
using iText.Kernel.Pdf.Canvas.Parser.Listener;
@@ -51,15 +52,34 @@ private PdfTextExtractor() {
}
/// Extract text from a specified page using an extraction strategy.
+ ///
+ /// Extract text from a specified page using an extraction strategy.
+ /// Also allows registration of custom IContentOperators that can influence
+ /// how (and whether or not) the PDF instructions will be parsed.
+ ///
/// the page for the text to be extracted from
/// the strategy to use for extracting text
+ ///
+ /// an optional map of custom
+ ///
+ /// s for rendering instructions
+ ///
/// the extracted text
- public static String GetTextFromPage(PdfPage page, ITextExtractionStrategy strategy) {
- PdfCanvasProcessor parser = new PdfCanvasProcessor(strategy);
+ public static String GetTextFromPage(PdfPage page, ITextExtractionStrategy strategy, IDictionary additionalContentOperators) {
+ PdfCanvasProcessor parser = new PdfCanvasProcessor(strategy, additionalContentOperators);
parser.ProcessPageContent(page);
return strategy.GetResultantText();
}
+ /// Extract text from a specified page using an extraction strategy.
+ /// the page for the text to be extracted from
+ /// the strategy to use for extracting text
+ /// the extracted text
+ public static String GetTextFromPage(PdfPage page, ITextExtractionStrategy strategy) {
+ return GetTextFromPage(page, strategy, new Dictionary());
+ }
+
/// Extract text from a specified page using the default strategy.
///
/// Extract text from a specified page using the default strategy.
@@ -71,7 +91,6 @@ public static String GetTextFromPage(PdfPage page, ITextExtractionStrategy strat
///
/// the page for the text to be extracted from
/// the extracted text
- ///
public static String GetTextFromPage(PdfPage page) {
return GetTextFromPage(page, new LocationTextExtractionStrategy());
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/canvas/parser/clipperlib/ClipperBridge.cs b/itext/itext.kernel/itext/kernel/pdf/canvas/parser/clipperlib/ClipperBridge.cs
index 618fdf8b6e..c38e0e9c10 100644
--- a/itext/itext.kernel/itext/kernel/pdf/canvas/parser/clipperlib/ClipperBridge.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/canvas/parser/clipperlib/ClipperBridge.cs
@@ -272,7 +272,7 @@ public static PolyFillType GetFillType(int fillingRule) {
return fillType;
}
- [Obsolete]
+ [System.ObsoleteAttribute(@"close will be boolean . Visibility will be changed to internal.")]
public static void AddContour(Path path, IList contour, bool? close) {
IList floatContour = ConvertToFloatPoints(contour);
Point point = floatContour[0];
diff --git a/itext/itext.kernel/itext/kernel/pdf/canvas/parser/data/TextRenderInfo.cs b/itext/itext.kernel/itext/kernel/pdf/canvas/parser/data/TextRenderInfo.cs
index 32f4abbe0f..c6ba00829b 100644
--- a/itext/itext.kernel/itext/kernel/pdf/canvas/parser/data/TextRenderInfo.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/canvas/parser/data/TextRenderInfo.cs
@@ -198,8 +198,7 @@ public virtual LineSegment GetUnscaledBaseline() {
///
/// the ascentline line segment
public virtual LineSegment GetAscentLine() {
- float ascent = gs.GetFont().GetFontProgram().GetFontMetrics().GetTypoAscender() * gs.GetFontSize() / 1000f;
- return GetUnscaledBaselineWithOffset(ascent + gs.GetTextRise()).TransformBy(textToUserSpaceTransformMatrix
+ return GetUnscaledBaselineWithOffset(GetAscentDescent()[0] + gs.GetTextRise()).TransformBy(textToUserSpaceTransformMatrix
);
}
@@ -212,9 +211,7 @@ public virtual LineSegment GetAscentLine() {
///
/// the descentline line segment
public virtual LineSegment GetDescentLine() {
- // per getFontDescription() API, descent is returned as a negative number, so we apply that as a normal vertical offset
- float descent = gs.GetFont().GetFontProgram().GetFontMetrics().GetTypoDescender() * gs.GetFontSize() / 1000f;
- return GetUnscaledBaselineWithOffset(descent + gs.GetTextRise()).TransformBy(textToUserSpaceTransformMatrix
+ return GetUnscaledBaselineWithOffset(GetAscentDescent()[1] + gs.GetTextRise()).TransformBy(textToUserSpaceTransformMatrix
);
}
@@ -476,5 +473,18 @@ private PdfString[] SplitString(PdfString @string) {
}
return strings.ToArray(new PdfString[strings.Count]);
}
+
+ private float[] GetAscentDescent() {
+ float ascent = gs.GetFont().GetFontProgram().GetFontMetrics().GetTypoAscender();
+ float descent = gs.GetFont().GetFontProgram().GetFontMetrics().GetTypoDescender();
+ // If descent is positive, we consider it a bug and fix it
+ if (descent > 0) {
+ descent = -descent;
+ }
+ float scale = ascent - descent < 700 ? ascent - descent : 1000;
+ descent = descent / scale * gs.GetFontSize();
+ ascent = ascent / scale * gs.GetFontSize();
+ return new float[] { ascent, descent };
+ }
}
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/canvas/parser/listener/LocationTextExtractionStrategy.cs b/itext/itext.kernel/itext/kernel/pdf/canvas/parser/listener/LocationTextExtractionStrategy.cs
index b74f434507..8b7768718a 100644
--- a/itext/itext.kernel/itext/kernel/pdf/canvas/parser/listener/LocationTextExtractionStrategy.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/canvas/parser/listener/LocationTextExtractionStrategy.cs
@@ -314,7 +314,7 @@ internal virtual bool SameLine(LocationTextExtractionStrategy.TextChunk lastChun
}
}
- private class TextChunkLocationDefaultImp : LocationTextExtractionStrategy.ITextChunkLocation {
+ public class TextChunkLocationDefaultImp : LocationTextExtractionStrategy.ITextChunkLocation {
/// the starting location of the chunk
private readonly Vector startLocation;
diff --git a/itext/itext.kernel/itext/kernel/pdf/canvas/parser/listener/TextMarginFinder.cs b/itext/itext.kernel/itext/kernel/pdf/canvas/parser/listener/TextMarginFinder.cs
index 855a495a83..d57a05dff0 100644
--- a/itext/itext.kernel/itext/kernel/pdf/canvas/parser/listener/TextMarginFinder.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/canvas/parser/listener/TextMarginFinder.cs
@@ -58,12 +58,12 @@ public virtual void EventOccurred(IEventData data, EventType type) {
if (type == EventType.RENDER_TEXT) {
TextRenderInfo info = (TextRenderInfo)data;
if (textRectangle == null) {
- textRectangle = info.GetDescentLine().GetBoundingRectange();
+ textRectangle = info.GetDescentLine().GetBoundingRectangle();
}
else {
- textRectangle = Rectangle.GetCommonRectangle(textRectangle, info.GetDescentLine().GetBoundingRectange());
+ textRectangle = Rectangle.GetCommonRectangle(textRectangle, info.GetDescentLine().GetBoundingRectangle());
}
- textRectangle = Rectangle.GetCommonRectangle(textRectangle, info.GetAscentLine().GetBoundingRectange());
+ textRectangle = Rectangle.GetCommonRectangle(textRectangle, info.GetAscentLine().GetBoundingRectangle());
}
else {
throw new InvalidOperationException(String.Format("Event type not supported: {0}", type));
diff --git a/itext/itext.kernel/itext/kernel/pdf/canvas/parser/util/PdfCanvasParser.cs b/itext/itext.kernel/itext/kernel/pdf/canvas/parser/util/PdfCanvasParser.cs
index d3de559299..63311740d7 100644
--- a/itext/itext.kernel/itext/kernel/pdf/canvas/parser/util/PdfCanvasParser.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/canvas/parser/util/PdfCanvasParser.cs
@@ -160,7 +160,8 @@ public virtual PdfArray ReadArray() {
if (tokeniser.GetTokenType() == PdfTokenizer.TokenType.EndArray) {
break;
}
- if (tokeniser.GetTokenType() == PdfTokenizer.TokenType.EndDic) {
+ if (tokeniser.GetTokenType() == PdfTokenizer.TokenType.EndDic && obj.GetObjectType() != PdfObject.DICTIONARY
+ ) {
tokeniser.ThrowError(PdfException.UnexpectedGtGt);
}
array.Add(obj);
diff --git a/itext/itext.kernel/itext/kernel/pdf/canvas/wmf/WmfImageData.cs b/itext/itext.kernel/itext/kernel/pdf/canvas/wmf/WmfImageData.cs
index 14c907beee..5c33f3e640 100644
--- a/itext/itext.kernel/itext/kernel/pdf/canvas/wmf/WmfImageData.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/canvas/wmf/WmfImageData.cs
@@ -65,7 +65,7 @@ public WmfImageData(Uri url)
: base(url, ImageType.WMF) {
byte[] imageType = ReadImageType(url);
if (!ImageTypeIs(imageType, wmf)) {
- throw new PdfException(PdfException.IsNotWmfImage);
+ throw new PdfException(PdfException.NotAWmfImage);
}
}
@@ -75,7 +75,7 @@ public WmfImageData(byte[] bytes)
: base(bytes, ImageType.WMF) {
byte[] imageType = ReadImageType(url);
if (!ImageTypeIs(imageType, wmf)) {
- throw new PdfException(PdfException.IsNotWmfImage);
+ throw new PdfException(PdfException.NotAWmfImage);
}
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/canvas/wmf/WmfImageHelper.cs b/itext/itext.kernel/itext/kernel/pdf/canvas/wmf/WmfImageHelper.cs
index 7ff5658b20..3afbab4a98 100644
--- a/itext/itext.kernel/itext/kernel/pdf/canvas/wmf/WmfImageHelper.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/canvas/wmf/WmfImageHelper.cs
@@ -83,7 +83,6 @@ public WmfImageHelper(ImageData wmf) {
}
/// This method checks if the image is a valid WMF and processes some parameters.
- ///
private void ProcessParameters() {
Stream @is = null;
try {
diff --git a/itext/itext.kernel/itext/kernel/pdf/collection/PdfCollectionField.cs b/itext/itext.kernel/itext/kernel/pdf/collection/PdfCollectionField.cs
index c790de38d6..594d527a93 100644
--- a/itext/itext.kernel/itext/kernel/pdf/collection/PdfCollectionField.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/collection/PdfCollectionField.cs
@@ -220,7 +220,7 @@ public virtual PdfObject GetValue(String value) {
return new PdfNumber(System.Double.Parse(value.Trim(), System.Globalization.CultureInfo.InvariantCulture));
}
}
- throw new PdfException(PdfException.IsNotAnAcceptableValueForTheField).SetMessageParams(value, GetPdfObject
+ throw new PdfException(PdfException._1IsNotAnAcceptableValueForTheField2).SetMessageParams(value, GetPdfObject
().GetAsName(PdfName.N).GetValue());
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/collection/PdfCollectionSort.cs b/itext/itext.kernel/itext/kernel/pdf/collection/PdfCollectionSort.cs
index 17dc703d5a..4b3e691763 100644
--- a/itext/itext.kernel/itext/kernel/pdf/collection/PdfCollectionSort.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/collection/PdfCollectionSort.cs
@@ -86,7 +86,7 @@ public virtual iText.Kernel.Pdf.Collection.PdfCollectionSort SetSortOrder(bool[]
PdfObject obj = GetPdfObject().Get(PdfName.S);
if (obj.IsArray()) {
if (((PdfArray)obj).Size() != ascending.Length) {
- throw new PdfException(PdfException.TheNumberOfBooleansInTheArrayDoesntCorrespondWithTheNumberOfFields);
+ throw new PdfException(PdfException.NumberOfBooleansInTheArrayDoesntCorrespondWithTheNumberOfFields);
}
GetPdfObject().Put(PdfName.A, new PdfArray(ascending));
return this;
diff --git a/itext/itext.kernel/itext/kernel/pdf/colorspace/PdfCieBasedCs.cs b/itext/itext.kernel/itext/kernel/pdf/colorspace/PdfCieBasedCs.cs
index 681d6e06ff..8d08ffb732 100644
--- a/itext/itext.kernel/itext/kernel/pdf/colorspace/PdfCieBasedCs.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/colorspace/PdfCieBasedCs.cs
@@ -49,6 +49,21 @@ source product.
namespace iText.Kernel.Pdf.Colorspace {
public abstract class PdfCieBasedCs : PdfColorSpace {
+ ///
+ /// To manually flush a
+ /// PdfObject
+ /// behind this wrapper, you have to ensure
+ /// that this object is added to the document, i.e. it has an indirect reference.
+ /// Basically this means that before flushing you need to explicitly call
+ ///
+ /// .
+ /// For example: wrapperInstance.makeIndirect(document).flush();
+ /// Note that not every wrapper require this, only those that have such warning in documentation.
+ ///
+ public override void Flush() {
+ base.Flush();
+ }
+
protected internal override bool IsWrappedObjectMustBeIndirect() {
return true;
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/colorspace/PdfColorSpace.cs b/itext/itext.kernel/itext/kernel/pdf/colorspace/PdfColorSpace.cs
index 151e33172a..0124d77149 100644
--- a/itext/itext.kernel/itext/kernel/pdf/colorspace/PdfColorSpace.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/colorspace/PdfColorSpace.cs
@@ -45,6 +45,7 @@ source product.
using iText.Kernel.Pdf;
namespace iText.Kernel.Pdf.Colorspace {
+ /// Represents the most common properties of color spaces.
public abstract class PdfColorSpace : PdfObjectWrapper {
public static readonly ICollection directColorSpaces = new HashSet(iText.IO.Util.JavaUtil.ArraysAsList
(PdfName.DeviceGray, PdfName.DeviceRGB, PdfName.DeviceCMYK, PdfName.Pattern));
diff --git a/itext/itext.kernel/itext/kernel/pdf/colorspace/PdfPattern.cs b/itext/itext.kernel/itext/kernel/pdf/colorspace/PdfPattern.cs
index c3cf9f5c77..0f0e24b199 100644
--- a/itext/itext.kernel/itext/kernel/pdf/colorspace/PdfPattern.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/colorspace/PdfPattern.cs
@@ -73,6 +73,21 @@ public virtual void SetMatrix(PdfArray matrix) {
SetModified();
}
+ ///
+ /// To manually flush a
+ /// PdfObject
+ /// behind this wrapper, you have to ensure
+ /// that this object is added to the document, i.e. it has an indirect reference.
+ /// Basically this means that before flushing you need to explicitly call
+ ///
+ /// .
+ /// For example: wrapperInstance.makeIndirect(document).flush();
+ /// Note that not every wrapper require this, only those that have such warning in documentation.
+ ///
+ public override void Flush() {
+ base.Flush();
+ }
+
protected internal override bool IsWrappedObjectMustBeIndirect() {
return true;
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/colorspace/PdfShading.cs b/itext/itext.kernel/itext/kernel/pdf/colorspace/PdfShading.cs
index 8d6b7222be..df6c62cf4e 100644
--- a/itext/itext.kernel/itext/kernel/pdf/colorspace/PdfShading.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/colorspace/PdfShading.cs
@@ -47,26 +47,61 @@ source product.
using iText.Kernel.Pdf.Function;
namespace iText.Kernel.Pdf.Colorspace {
+ /// The abstract PdfShading class that represents the Shading Dictionary PDF object.
public abstract class PdfShading : PdfObjectWrapper {
+ ///
+ /// constants of shading type
+ /// ISO-320001 Table 78
+ ///
+ ///
private class ShadingType {
+ /// The int value of function-based shading type
public const int FUNCTION_BASED = 1;
+ /// The int value of axial shading type
public const int AXIAL = 2;
+ /// The int value of radial shading type
public const int RADIAL = 3;
+ /// The int value of free-form Gouraud-shaded triangle mesh shading type
public const int FREE_FORM_GOURAUD_SHADED_TRIANGLE_MESH = 4;
+ /// The int value of lattice-form Gouraud-shaded triangle mesh shading type
public const int LATTICE_FORM_GOURAUD_SHADED_TRIANGLE_MESH = 5;
+ /// The int value of coons patch meshes shading type
public const int COONS_PATCH_MESH = 6;
+ /// The int value of tensor-product patch meshes shading type
public const int TENSOR_PRODUCT_PATCH_MESH = 7;
}
+ ///
+ /// Creates the
+ ///
+ /// object from the existing
+ ///
+ /// with corresponding type.
+ ///
+ ///
+ ///
+ ///
+ /// from which the
+ ///
+ /// object will be created.
+ ///
+ ///
+ /// Created
+ ///
+ /// object.
+ ///
public static PdfShading MakeShading(PdfDictionary shadingDictionary) {
if (!shadingDictionary.ContainsKey(PdfName.ShadingType)) {
- throw new PdfException(PdfException.UnexpectedShadingType);
+ throw new PdfException(PdfException.ShadingTypeNotFound);
+ }
+ if (!shadingDictionary.ContainsKey(PdfName.ColorSpace)) {
+ throw new PdfException(PdfException.ColorSpaceNotFound);
}
PdfShading shading;
switch (shadingDictionary.GetAsNumber(PdfName.ShadingType).IntValue()) {
@@ -128,29 +163,78 @@ protected internal PdfShading(PdfDictionary pdfObject)
: base(pdfObject) {
}
+ [System.ObsoleteAttribute(@"Use PdfShading(iText.Kernel.Pdf.PdfDictionary, int, PdfColorSpace) instead.")]
protected internal PdfShading(PdfDictionary pdfObject, int type, PdfObject colorSpace)
: base(pdfObject) {
GetPdfObject().Put(PdfName.ShadingType, new PdfNumber(type));
GetPdfObject().Put(PdfName.ColorSpace, colorSpace);
}
+ protected internal PdfShading(PdfDictionary pdfObject, int type, PdfColorSpace colorSpace)
+ : base(pdfObject) {
+ GetPdfObject().Put(PdfName.ShadingType, new PdfNumber(type));
+ if (colorSpace is PdfSpecialCs.Pattern) {
+ throw new ArgumentException("colorSpace");
+ }
+ GetPdfObject().Put(PdfName.ColorSpace, colorSpace.GetPdfObject());
+ }
+
+ /// Gets the shading type.
+ ///
+ /// int value of
+ ///
+ /// .
+ ///
public virtual int GetShadingType() {
return (int)GetPdfObject().GetAsInt(PdfName.ShadingType);
}
+ /// Gets the color space in which colour values shall be expressed.
+ ///
+ ///
+ ///
+ /// Color space
+ ///
public virtual PdfObject GetColorSpace() {
return GetPdfObject().Get(PdfName.ColorSpace);
}
+ ///
+ /// Gets the function PdfObject that represents color transitions
+ /// across the shading geometry.
+ ///
+ ///
+ ///
+ ///
+ /// Function
+ ///
public virtual PdfObject GetFunction() {
return GetPdfObject().Get(PdfName.Function);
}
+ ///
+ /// Sets the function that represents color transitions
+ /// across the shading geometry as one object.
+ ///
+ ///
+ /// The
+ ///
+ /// to set.
+ ///
public virtual void SetFunction(PdfFunction function) {
GetPdfObject().Put(PdfName.Function, function.GetPdfObject());
SetModified();
}
+ ///
+ /// Sets the function object that represents color transitions
+ /// across the shading geometry as an array of functions.
+ ///
+ ///
+ /// The array of
+ ///
+ /// to be set.
+ ///
public virtual void SetFunction(PdfFunction[] functions) {
PdfArray arr = new PdfArray();
foreach (PdfFunction func in functions) {
@@ -160,38 +244,135 @@ public virtual void SetFunction(PdfFunction[] functions) {
SetModified();
}
+ ///
+ /// To manually flush a
+ /// PdfObject
+ /// behind this wrapper, you have to ensure
+ /// that this object is added to the document, i.e. it has an indirect reference.
+ /// Basically this means that before flushing you need to explicitly call
+ ///
+ /// .
+ /// For example: wrapperInstance.makeIndirect(document).flush();
+ /// Note that not every wrapper require this, only those that have such warning in documentation.
+ ///
+ public override void Flush() {
+ base.Flush();
+ }
+
protected internal override bool IsWrappedObjectMustBeIndirect() {
return true;
}
+ ///
+ /// The class that extends
+ ///
+ /// class and is in charge of Shading Dictionary with function-based type,
+ /// that defines color at every point in the domain by a specified mathematical function.
+ ///
public class FunctionBased : PdfShading {
- public FunctionBased(PdfDictionary pdfObject)
- : base(pdfObject) {
+ ///
+ /// Creates the new instance of the class from the existing
+ ///
+ /// object.
+ ///
+ ///
+ ///
+ ///
+ /// from which the instance is created.
+ ///
+ [System.ObsoleteAttribute(@"Intended only for private use. You should use PdfShading.MakeShading(iText.Kernel.Pdf.PdfDictionary) instead."
+ )]
+ public FunctionBased(PdfDictionary pdfDictionary)
+ : base(pdfDictionary) {
}
+ /// Creates the new instance of the class.
+ ///
+ /// the
+ ///
+ /// object in which colour values shall be expressed.
+ ///
+ ///
+ /// the
+ ///
+ /// , that is used to calculate color transitions.
+ ///
public FunctionBased(PdfColorSpace colorSpace, PdfFunction function)
: this(colorSpace.GetPdfObject(), function) {
}
+ /// Creates the new instance of the class.
+ ///
+ /// the
+ ///
+ /// , that represents color space in which colour values shall be expressed.
+ ///
+ ///
+ /// the
+ ///
+ /// , that is used to calculate color transitions.
+ ///
public FunctionBased(PdfObject colorSpace, PdfFunction function)
- : base(new PdfDictionary(), PdfShading.ShadingType.FUNCTION_BASED, colorSpace) {
+ : base(new PdfDictionary(), PdfShading.ShadingType.FUNCTION_BASED, PdfColorSpace.MakeColorSpace(colorSpace
+ )) {
SetFunction(function);
}
+ ///
+ /// Gets the
+ ///
+ /// domain rectangle object that establishes an internal coordinate space
+ /// for the shading that is independent of the target coordinate space in which it shall be painted.
+ ///
+ ///
+ ///
+ ///
+ /// domain rectangle.
+ ///
public virtual PdfArray GetDomain() {
return GetPdfObject().GetAsArray(PdfName.Domain);
}
+ ///
+ /// Sets the
+ ///
+ /// domain rectangle object that establishes an internal coordinate space
+ /// for the shading that is independent of the target coordinate space in which it shall be painted.
+ ///
+ /// the Xmin coordinate of rectangle.
+ /// the Xmax coordinate of rectangle.
+ /// the Ymin coordinate of rectangle.
+ /// the Ymax coordinate of rectangle.
public virtual void SetDomain(float xmin, float xmax, float ymin, float ymax) {
GetPdfObject().Put(PdfName.Domain, new PdfArray(new float[] { xmin, xmax, ymin, ymax }));
SetModified();
}
+ ///
+ /// Sets the
+ ///
+ /// domain rectangle object that establishes an internal coordinate space
+ /// for the shading that is independent of the target coordinate space in which it shall be painted.
+ ///
+ ///
+ /// the
+ ///
+ /// domain rectangle object to be set.
+ ///
public virtual void SetDomain(PdfArray domain) {
GetPdfObject().Put(PdfName.Domain, domain);
SetModified();
}
+ ///
+ /// Gets the array of floats that represents the transformation matrix that maps the domain rectangle
+ /// into a corresponding figure in the target coordinate space.
+ ///
+ ///
+ /// the
+ /// float[]
+ /// of transformation matrix (identical matrix by default).
+ ///
public virtual float[] GetMatrix() {
PdfArray matrix = GetPdfObject().GetAsArray(PdfName.Matrix);
if (matrix == null) {
@@ -204,59 +385,197 @@ public virtual float[] GetMatrix() {
return result;
}
+ ///
+ /// Sets the array of floats that represents the transformation matrix that maps the domain rectangle
+ /// into a corresponding figure in the target coordinate space.
+ ///
+ ///
+ /// the
+ /// float[]
+ /// of transformation matrix to be set.
+ ///
public virtual void SetMatrix(float[] matrix) {
SetMatrix(new PdfArray(matrix));
}
+ ///
+ /// Sets the array of floats that represents the transformation matrix that maps the domain rectangle
+ /// into a corresponding figure in the target coordinate space.
+ ///
+ ///
+ /// the
+ ///
+ /// transformation matrix object to be set.
+ ///
public virtual void SetMatrix(PdfArray matrix) {
GetPdfObject().Put(PdfName.Matrix, matrix);
SetModified();
}
}
+ ///
+ /// The class that extends
+ ///
+ /// class and is in charge of Shading Dictionary with axial type,
+ /// that define a colour blend that varies along a linear axis between two endpoints
+ /// and extends indefinitely perpendicular to that axis.
+ ///
public class Axial : PdfShading {
+ ///
+ /// Creates the new instance of the class from the existing
+ ///
+ /// object.
+ ///
+ ///
+ ///
+ ///
+ /// from which the instance is created.
+ ///
+ [System.ObsoleteAttribute(@"Intended only for private use. You should use PdfShading.MakeShading(iText.Kernel.Pdf.PdfDictionary) instead."
+ )]
public Axial(PdfDictionary pdfDictionary)
: base(pdfDictionary) {
}
+ /// Creates the new instance of the class.
+ ///
+ /// the
+ ///
+ /// object in which colour values shall be expressed.
+ /// The special Pattern space isn't excepted.
+ ///
+ /// the start coordinate of X axis expressed in the shading's target coordinate space.
+ /// the start coordinate of Y axis expressed in the shading's target coordinate space.
+ ///
+ /// the
+ /// float[]
+ /// that represents the color in the start point.
+ ///
+ /// the end coordinate of X axis expressed in the shading's target coordinate space.
+ /// the end coordinate of Y axis expressed in the shading's target coordinate space.
+ ///
+ /// the
+ /// float[]
+ /// that represents the color in the end point.
+ ///
public Axial(PdfColorSpace cs, float x0, float y0, float[] color0, float x1, float y1, float[] color1)
- : base(new PdfDictionary(), PdfShading.ShadingType.AXIAL, cs.GetPdfObject()) {
- if (cs is PdfSpecialCs.Pattern) {
- throw new ArgumentException("colorSpace");
- }
+ : base(new PdfDictionary(), PdfShading.ShadingType.AXIAL, cs) {
SetCoords(x0, y0, x1, y1);
PdfFunction func = new PdfFunction.Type2(new PdfArray(new float[] { 0, 1 }), null, new PdfArray(color0), new
PdfArray(color1), new PdfNumber(1));
SetFunction(func);
}
+ /// Creates the new instance of the class.
+ ///
+ /// the
+ ///
+ /// object in which colour values shall be expressed.
+ /// The special Pattern space isn't excepted.
+ ///
+ /// the start coordinate of X axis expressed in the shading's target coordinate space.
+ /// the start coordinate of Y axis expressed in the shading's target coordinate space.
+ ///
+ /// the
+ /// float[]
+ /// that represents the color in the start point.
+ ///
+ /// the end coordinate of X axis expressed in the shading's target coordinate space.
+ /// the end coordinate of Y axis expressed in the shading's target coordinate space.
+ ///
+ /// the
+ /// float[]
+ /// that represents the color in the end point.
+ ///
+ ///
+ /// the array of two booleans that specified whether to extend the shading
+ /// beyond the starting and ending points of the axis, respectively.
+ ///
public Axial(PdfColorSpace cs, float x0, float y0, float[] color0, float x1, float y1, float[] color1, bool
[] extend)
: this(cs, x0, y0, color0, x1, y1, color1) {
- if (extend != null) {
- SetExtend(extend[0], extend[1]);
+ if (extend == null || extend.Length != 2) {
+ throw new ArgumentException("extend");
}
- }
-
+ SetExtend(extend[0], extend[1]);
+ }
+
+ /// Creates the new instance of the class.
+ ///
+ /// the
+ ///
+ /// object in which colour values shall be expressed.
+ /// The special Pattern space isn't excepted.
+ ///
+ ///
+ /// the
+ ///
+ /// of four number four numbers [x0 y0 x1 y1] that specified the starting
+ /// and the endings coordinates of thew axis, expressed in the shading's target coordinate space.
+ ///
+ ///
+ /// the
+ ///
+ /// object, that is used to calculate color transitions.
+ ///
public Axial(PdfColorSpace cs, PdfArray coords, PdfFunction function)
- : base(new PdfDictionary(), PdfShading.ShadingType.AXIAL, cs.GetPdfObject()) {
+ : base(new PdfDictionary(), PdfShading.ShadingType.AXIAL, cs) {
SetCoords(coords);
SetFunction(function);
}
+ ///
+ /// Gets the Coords object - a
+ ///
+ /// of four numbers [x0 y0 x1 y1] that specified the starting
+ /// and the endings coordinates of thew axis, expressed in the shading's target coordinate space.
+ ///
+ ///
+ /// the
+ ///
+ /// Coords object.
+ ///
public virtual PdfArray GetCoords() {
return GetPdfObject().GetAsArray(PdfName.Coords);
}
+ /// Sets the Choords object with the four params expressed in the shading's target coordinate space.
+ /// the start coordinate of X axis to be set.
+ /// the start coordinate of Y axis to be set.
+ /// the end coordinate of X axis to be set.
+ /// the end coordinate of Y axis to be set.
public virtual void SetCoords(float x0, float y0, float x1, float y1) {
SetCoords(new PdfArray(new float[] { x0, y0, x1, y1 }));
}
+ ///
+ /// Sets the Choords object with the
+ ///
+ /// of four numbers [x0 y0 x1 y1],
+ /// that specified the starting and the endings coordinates of thew axis,
+ /// expressed in the shading's target coordinate space.
+ ///
+ ///
+ /// the Chords
+ ///
+ /// to be set.
+ ///
public virtual void SetCoords(PdfArray coords) {
GetPdfObject().Put(PdfName.Coords, coords);
SetModified();
}
+ ///
+ /// Gets the array of two
+ /// float
+ /// [t0, t1] that represent the limiting values of a parametric
+ /// variable t, that becomes an input of color function(s).
+ ///
+ ///
+ ///
+ /// float[]
+ /// of Domain object ([0.0 1.0] by default)
+ ///
public virtual float[] GetDomain() {
PdfArray domain = GetPdfObject().GetAsArray(PdfName.Domain);
if (domain == null) {
@@ -265,66 +584,270 @@ public virtual float[] GetDomain() {
return new float[] { domain.GetAsNumber(0).FloatValue(), domain.GetAsNumber(1).FloatValue() };
}
+ ///
+ /// Sets the Domain with the array of two
+ /// float
+ /// [t0, t1] that represent the limiting values
+ /// of a parametric variable t, that becomes an input of color function(s).
+ ///
+ /// first limit of variable t
+ /// second limit of variable t
public virtual void SetDomain(float t0, float t1) {
GetPdfObject().Put(PdfName.Domain, new PdfArray(new float[] { t0, t1 }));
SetModified();
}
+ ///
+ /// Gets the array of two
+ /// boolean
+ /// that specified whether to extend the shading
+ /// beyond the starting and ending points of the axis, respectively.
+ ///
+ ///
+ ///
+ /// boolean[]
+ /// of Extended object ([false false] by default)
+ ///
public virtual bool[] GetExtend() {
PdfArray extend = GetPdfObject().GetAsArray(PdfName.Extend);
if (extend == null) {
- return new bool[] { true, true };
+ return new bool[] { false, false };
}
return new bool[] { extend.GetAsBoolean(0).GetValue(), extend.GetAsBoolean(1).GetValue() };
}
+ ///
+ /// Sets the Extend object with the two
+ /// boolean
+ /// value.
+ ///
+ /// if true will extend shading beyond the starting point of Coords
+ /// if true will extend shading beyond the ending point of Coords
public virtual void SetExtend(bool extendStart, bool extendEnd) {
GetPdfObject().Put(PdfName.Extend, new PdfArray(new bool[] { extendStart, extendEnd }));
SetModified();
}
}
+ ///
+ /// The class that extends
+ ///
+ /// class and is in charge of Shading Dictionary with radial type,
+ /// that define a colour blend that varies between two circles.
+ /// This type of shading shall not be used with an Indexed colour space
+ ///
public class Radial : PdfShading {
+ ///
+ /// Creates the new instance of the class from the existing
+ ///
+ /// object.
+ ///
+ ///
+ /// -
+ ///
+ /// from which the instance is created.
+ ///
+ [System.ObsoleteAttribute(@"Intended only for private use. You should use PdfShading.MakeShading(iText.Kernel.Pdf.PdfDictionary) instead."
+ )]
public Radial(PdfDictionary pdfDictionary)
: base(pdfDictionary) {
}
+ /// Creates the new instance of the class.
+ ///
+ /// the
+ ///
+ /// object in which colour values shall be expressed.
+ /// The Indexed color space isn't excepted.
+ ///
+ /// the X coordinate of starting circle's centre, expressed in in the shading’s target coordinate space.
+ ///
+ /// the Y coordinate of starting circle's centre, expressed in in the shading’s target coordinate space.
+ ///
+ ///
+ /// the radius of starting circle's centre, should be greater or equal to 0.
+ /// If 0 then starting circle is treated as point.
+ /// If both radii are 0, nothing shall be painted.
+ ///
+ ///
+ /// the
+ /// float[]
+ /// that represents the color in the start circle.
+ ///
+ /// the X coordinate of ending circle's centre, expressed in in the shading’s target coordinate space.
+ ///
+ /// the Y coordinate of ending circle's centre, expressed in in the shading’s target coordinate space.
+ ///
+ ///
+ /// the radius of ending circle's centre, should be greater or equal to 0.
+ /// If 0 then ending circle is treated as point.
+ /// If both radii are 0, nothing shall be painted.
+ ///
+ ///
+ /// the
+ /// float[]
+ /// that represents the color in the end circle.
+ ///
public Radial(PdfColorSpace cs, float x0, float y0, float r0, float[] color0, float x1, float y1, float r1
, float[] color1)
- : base(new PdfDictionary(), PdfShading.ShadingType.RADIAL, cs.GetPdfObject()) {
+ : base(new PdfDictionary(), PdfShading.ShadingType.RADIAL, cs) {
SetCoords(x0, y0, r0, x1, y1, r1);
PdfFunction func = new PdfFunction.Type2(new PdfArray(new float[] { 0, 1 }), null, new PdfArray(color0), new
PdfArray(color1), new PdfNumber(1));
SetFunction(func);
}
+ /// Creates the new instance of the class.
+ ///
+ /// the
+ ///
+ /// object in which colour values shall be expressed.
+ /// The Indexed color space isn't excepted.
+ ///
+ /// the X coordinate of starting circle's centre, expressed in in the shading’s target coordinate space.
+ ///
+ /// the Y coordinate of starting circle's centre, expressed in in the shading’s target coordinate space.
+ ///
+ ///
+ /// the radius of starting circle's centre, should be greater or equal to 0.
+ /// If 0 then starting circle is treated as point.
+ /// If both radii are 0, nothing shall be painted.
+ ///
+ ///
+ /// the
+ /// float[]
+ /// that represents the color in the start circle.
+ ///
+ /// the X coordinate of ending circle's centre, expressed in in the shading’s target coordinate space.
+ ///
+ /// the Y coordinate of ending circle's centre, expressed in in the shading’s target coordinate space.
+ ///
+ ///
+ /// the radius of ending circle's centre, should be greater or equal to 0.
+ /// If 0 then ending circle is treated as point.
+ /// If both radii are 0, nothing shall be painted.
+ ///
+ ///
+ /// the
+ /// float[]
+ /// that represents the color in the end circle.
+ ///
+ ///
+ /// the array of two
+ /// boolean
+ /// that specified whether to extend the shading
+ /// beyond the starting and ending points of the axis, respectively.
+ ///
public Radial(PdfColorSpace cs, float x0, float y0, float r0, float[] color0, float x1, float y1, float r1
, float[] color1, bool[] extend)
: this(cs, x0, y0, r0, color0, x1, y1, r1, color1) {
- if (extend != null) {
- SetExtend(extend[0], extend[1]);
+ if (extend == null || extend.Length != 2) {
+ throw new ArgumentException("extend");
}
- }
-
+ SetExtend(extend[0], extend[1]);
+ }
+
+ /// Creates the new instance of the class.
+ ///
+ /// the
+ ///
+ /// object in which colour values shall be expressed.
+ /// The Indexed color space isn't excepted.
+ ///
+ ///
+ /// the
+ ///
+ /// of of six numbers [x0 y0 r0 x1 y1 r1],
+ /// specifying the centres and radii of the starting and ending circles,
+ /// expressed in the shading’s target coordinate space.
+ /// The radii r0 and r1 shall both be greater than or equal to 0.
+ /// If one radius is 0, the corresponding circle shall be treated as a point;
+ /// if both are 0, nothing shall be painted.
+ ///
+ ///
+ /// the
+ ///
+ /// object, that is used to calculate color transitions.
+ ///
public Radial(PdfColorSpace cs, PdfArray coords, PdfFunction function)
- : base(new PdfDictionary(), PdfShading.ShadingType.RADIAL, cs.GetPdfObject()) {
+ : base(new PdfDictionary(), PdfShading.ShadingType.RADIAL, cs) {
SetCoords(coords);
SetFunction(function);
}
+ ///
+ /// Gets the coords
+ ///
+ /// object - an array of six numbers [x0 y0 r0 x1 y1 r1],
+ /// specifying the centres and radii of the starting and ending circles,
+ /// expressed in the shading’s target coordinate space.
+ /// The radii r0 and r1 shall both be greater than or equal to 0.
+ /// If one radius is 0, the corresponding circle shall be treated as a point;
+ /// if both are 0, nothing shall be painted.
+ ///
+ ///
+ /// the
+ ///
+ /// coords object.
+ ///
public virtual PdfArray GetCoords() {
return GetPdfObject().GetAsArray(PdfName.Coords);
}
+ /// Sets the coords object.
+ /// the X coordinate of starting circle's centre, expressed in in the shading’s target coordinate space.
+ ///
+ /// the Y coordinate of starting circle's centre, expressed in in the shading’s target coordinate space.
+ ///
+ ///
+ /// the radius of starting circle's centre, should be greater or equal to 0.
+ /// If 0 then starting circle is treated as point.
+ /// If both radii are 0, nothing shall be painted.
+ ///
+ /// the X coordinate of ending circle's centre, expressed in in the shading’s target coordinate space.
+ ///
+ /// the Y coordinate of ending circle's centre, expressed in in the shading’s target coordinate space.
+ ///
+ ///
+ /// the radius of ending circle's centre, should be greater or equal to 0.
+ /// If 0 then ending circle is treated as point.
+ /// If both radii are 0, nothing shall be painted.
+ ///
public virtual void SetCoords(float x0, float y0, float r0, float x1, float y1, float r1) {
SetCoords(new PdfArray(new float[] { x0, y0, r0, x1, y1, r1 }));
}
+ ///
+ /// Sets the coords
+ ///
+ /// object - an array of six numbers [x0 y0 r0 x1 y1 r1],
+ /// specifying the centres and radii of the starting and ending circles,
+ /// expressed in the shading’s target coordinate space.
+ /// The radii r0 and r1 shall both be greater than or equal to 0.
+ /// If one radius is 0, the corresponding circle shall be treated as a point;
+ /// if both are 0, nothing shall be painted.
+ ///
+ ///
+ /// -
+ ///
+ /// choords object to be set.
+ ///
public virtual void SetCoords(PdfArray coords) {
GetPdfObject().Put(PdfName.Coords, coords);
SetModified();
}
+ ///
+ /// Gets the array of two
+ /// float
+ /// [t0, t1] that represent the limiting values of a parametric
+ /// variable t, that becomes an input of color function(s).
+ ///
+ ///
+ ///
+ /// float[]
+ /// of Domain object ([0.0 1.0] by default)
+ ///
public virtual float[] GetDomain() {
PdfArray domain = GetPdfObject().GetAsArray(PdfName.Domain);
if (domain == null) {
@@ -333,257 +856,864 @@ public virtual float[] GetDomain() {
return new float[] { domain.GetAsNumber(0).FloatValue(), domain.GetAsNumber(1).FloatValue() };
}
+ ///
+ /// Sets the Domain with the array of two
+ /// float
+ /// [t0, t1] that represent the limiting values
+ /// of a parametric variable t, that becomes an input of color function(s).
+ ///
+ /// first limit of variable t
+ /// second limit of variable t
public virtual void SetDomain(float t0, float t1) {
GetPdfObject().Put(PdfName.Domain, new PdfArray(new float[] { t0, t1 }));
SetModified();
}
+ ///
+ /// Gets the array of two
+ /// boolean
+ /// that specified whether to extend the shading
+ /// beyond the starting and ending circles of the axis, respectively.
+ ///
+ ///
+ ///
+ /// boolean[]
+ /// of Extended object ([false false] by default)
+ ///
public virtual bool[] GetExtend() {
PdfArray extend = GetPdfObject().GetAsArray(PdfName.Extend);
if (extend == null) {
- return new bool[] { true, true };
+ return new bool[] { false, false };
}
return new bool[] { extend.GetAsBoolean(0).GetValue(), extend.GetAsBoolean(1).GetValue() };
}
+ ///
+ /// Sets the Extend object with the two
+ /// boolean
+ /// value.
+ ///
+ /// if true will extend shading beyond the starting circle of Coords.
+ /// if true will extend shading beyond the ending circle of Coords.
public virtual void SetExtend(bool extendStart, bool extendEnd) {
GetPdfObject().Put(PdfName.Extend, new PdfArray(new bool[] { extendStart, extendEnd }));
SetModified();
}
}
+ ///
+ /// The class that extends
+ ///
+ /// class and is in charge of Shading Dictionary with
+ /// free-form Gouraud-shaded triangle mesh type.
+ /// The area to be shaded is defined by a path composed entirely of triangles.
+ /// The colour at each vertex of the triangles is specified,
+ /// and a technique known as Gouraud interpolation is used to colour the interiors.
+ /// The object shall be represented as stream containing a sequence of vertex data.
+ /// Each vertex is specified by the following values, in the order shown:
+ /// f x y c1 … cn where:
+ /// f - the vertex’s edge flag, that determines the vertex is connected to other vertices of the triangle mesh.
+ /// For full description
+ /// ISO-320001 Paragph 8.7.4.5.5
+ /// x, y - vertex’s horizontal and vertical coordinates, expressed in the shading’s target coordinate space.
+ /// c1…cn - vertex’s colour components.
+ /// If the shading dictionary includes a Function entry, only a single parametric value, t,
+ /// shall be specified for each vertex in place of the colour components c1…cn.
+ ///
public class FreeFormGouraudShadedTriangleMesh : PdfShading {
+ ///
+ /// Creates the new instance of the class from the existing
+ ///
+ /// object.
+ ///
+ ///
+ ///
+ ///
+ /// from which the instance is created.
+ ///
+ [System.ObsoleteAttribute(@"Intended only for private use. You should use PdfShading.MakeShading(iText.Kernel.Pdf.PdfDictionary) instead."
+ )]
public FreeFormGouraudShadedTriangleMesh(PdfStream pdfStream)
: base(pdfStream) {
}
+ /// Creates the new instance of the class.
+ ///
+ /// the
+ ///
+ /// object in which colour values shall be expressed.
+ /// The special Pattern space isn't excepted.
+ ///
+ ///
+ /// the number of bits used to represent each vertex coordinate.
+ /// The value shall be 1, 2, 4, 8, 12, 16, 24, or 32.
+ ///
+ ///
+ /// the number of bits used to represent each colour component.
+ /// The value shall be 1, 2, 4, 8, 12, or 16.
+ ///
+ ///
+ /// the number of bits used to represent the edge flag for each vertex.
+ /// The value of BitsPerFlag shall be 2, 4, or 8,
+ /// but only the least significant 2 bits in each flag value shall be used.
+ /// The value for the edge flag shall be 0, 1, or 2.
+ ///
+ ///
+ /// the
+ /// int[]
+ /// of numbers specifying how to map vertex coordinates and colour components
+ /// into the appropriate ranges of values. The ranges shall be specified as follows:
+ /// [x_min x_max y_min y_max c1_min c1_max … cn_min cn_max].
+ /// Only one pair of color values shall be specified if a Function entry is present.
+ ///
public FreeFormGouraudShadedTriangleMesh(PdfColorSpace cs, int bitsPerCoordinate, int bitsPerComponent, int
bitsPerFlag, float[] decode)
: this(cs, bitsPerCoordinate, bitsPerComponent, bitsPerFlag, new PdfArray(decode)) {
}
+ /// Creates the new instance of the class.
+ ///
+ /// the
+ ///
+ /// object in which colour values shall be expressed.
+ /// The special Pattern space isn't excepted.
+ ///
+ ///
+ /// the number of bits used to represent each vertex coordinate.
+ /// The value shall be 1, 2, 4, 8, 12, 16, 24, or 32.
+ ///
+ ///
+ /// the number of bits used to represent each colour component.
+ /// The value shall be 1, 2, 4, 8, 12, or 16.
+ ///
+ ///
+ /// the number of bits used to represent the edge flag for each vertex.
+ /// The value of BitsPerFlag shall be 2, 4, or 8,
+ /// but only the least significant 2 bits in each flag value shall be used.
+ /// The value for the edge flag shall be 0, 1, or 2.
+ ///
+ ///
+ /// the
+ ///
+ /// of numbers specifying how to map vertex coordinates and colour components
+ /// into the appropriate ranges of values. The ranges shall be specified as follows:
+ /// [x_min x_max y_min y_max c1_min c1_max … cn_min cn_max].
+ /// Only one pair of color values shall be specified if a Function entry is present.
+ ///
public FreeFormGouraudShadedTriangleMesh(PdfColorSpace cs, int bitsPerCoordinate, int bitsPerComponent, int
bitsPerFlag, PdfArray decode)
- : base(new PdfStream(), PdfShading.ShadingType.FREE_FORM_GOURAUD_SHADED_TRIANGLE_MESH, cs.GetPdfObject()) {
+ : base(new PdfStream(), PdfShading.ShadingType.FREE_FORM_GOURAUD_SHADED_TRIANGLE_MESH, cs) {
SetBitsPerCoordinate(bitsPerCoordinate);
SetBitsPerComponent(bitsPerComponent);
SetBitsPerFlag(bitsPerFlag);
SetDecode(decode);
}
+ /// Gets the number of bits used to represent each vertex coordinate.
+ /// the number of bits. Can be 1, 2, 4, 8, 12, 16, 24, or 32.
public virtual int GetBitsPerCoordinate() {
return (int)GetPdfObject().GetAsInt(PdfName.BitsPerCoordinate);
}
+ /// Sets the number of bits used to represent each vertex coordinate.
+ /// the number of bits to be set. Shall be 1, 2, 4, 8, 12, 16, 24, or 32.
public virtual void SetBitsPerCoordinate(int bitsPerCoordinate) {
GetPdfObject().Put(PdfName.BitsPerCoordinate, new PdfNumber(bitsPerCoordinate));
SetModified();
}
+ /// Gets the number of bits used to represent each colour component.
+ /// the number of bits. Can be 1, 2, 4, 8, 12, or 16.
public virtual int GetBitsPerComponent() {
return (int)GetPdfObject().GetAsInt(PdfName.BitsPerComponent);
}
+ /// Sets the number of bits used to represent each colour component.
+ /// the number of bits to be set. Shall be 1, 2, 4, 8, 12, or 16.
public virtual void SetBitsPerComponent(int bitsPerComponent) {
GetPdfObject().Put(PdfName.BitsPerComponent, new PdfNumber(bitsPerComponent));
SetModified();
}
+ /// Gets the number of bits used to represent the edge flag for each vertex.
+ ///
+ /// Gets the number of bits used to represent the edge flag for each vertex.
+ /// But only the least significant 2 bits in each flag value shall be used.
+ /// The valid flag values are 0, 1 or 2.
+ ///
+ /// the number of bits. Can be 2, 4 or 8.
public virtual int GetBitsPerFlag() {
return (int)GetPdfObject().GetAsInt(PdfName.BitsPerFlag);
}
+ /// Sets the number of bits used to represent the edge flag for each vertex.
+ ///
+ /// Sets the number of bits used to represent the edge flag for each vertex.
+ /// But only the least significant 2 bits in each flag value shall be used.
+ /// The valid flag values are 0, 1 or 2.
+ ///
+ /// the number of bits to be set. Shall be 2, 4 or 8.
public virtual void SetBitsPerFlag(int bitsPerFlag) {
GetPdfObject().Put(PdfName.BitsPerFlag, new PdfNumber(bitsPerFlag));
SetModified();
}
+ ///
+ /// Gets the
+ ///
+ /// of numbers specifying how to map vertex coordinates and colour components
+ /// into the appropriate ranges of values. The ranges shall be specified as follows:
+ /// [x_min x_max y_min y_max c1_min c1_max … cn_min cn_max].
+ /// Only one pair of color values shall be specified if a Function entry is present.
+ ///
+ ///
+ /// the
+ ///
+ /// Decode object.
+ ///
public virtual PdfArray GetDecode() {
return GetPdfObject().GetAsArray(PdfName.Decode);
}
+ ///
+ /// Sets the
+ /// float[]
+ /// of numbers specifying how to map vertex coordinates and colour components
+ /// into the appropriate ranges of values. The ranges shall be specified as follows:
+ /// [x_min x_max y_min y_max c1_min c1_max … cn_min cn_max].
+ /// Only one pair of color values shall be specified if a Function entry is present.
+ ///
+ ///
+ /// the
+ /// float[]
+ /// of Decode object to set.
+ ///
public virtual void SetDecode(float[] decode) {
GetPdfObject().Put(PdfName.Decode, new PdfArray(decode));
}
+ ///
+ /// Sets the
+ ///
+ /// of numbers specifying how to map vertex coordinates and colour components
+ /// into the appropriate ranges of values. The ranges shall be specified as follows:
+ /// [x_min x_max y_min y_max c1_min c1_max … cn_min cn_max].
+ /// Only one pair of color values shall be specified if a Function entry is present.
+ ///
+ ///
+ /// the
+ ///
+ /// Decode object to set.
+ ///
public virtual void SetDecode(PdfArray decode) {
GetPdfObject().Put(PdfName.Decode, decode);
}
}
+ ///
+ /// The class that extends
+ ///
+ /// class and is in charge of Shading Dictionary with
+ /// lattice-form Gouraud-shaded triangle mesh type.
+ /// This type is similar to
+ ///
+ /// but instead of using free-form geometry,
+ /// the vertices are arranged in a pseudorectangular lattice,
+ /// which is topologically equivalent to a rectangular grid.
+ /// The vertices are organized into rows, which need not be geometrically linear.
+ /// The verticals data in stream is similar to
+ ///
+ /// ,
+ /// except there is no edge flag.
+ ///
public class LatticeFormGouraudShadedTriangleMesh : PdfShading {
+ ///
+ /// Creates the new instance of the class from the existing
+ ///
+ /// object.
+ ///
+ ///
+ ///
+ ///
+ /// from which the instance is created.
+ ///
+ [System.ObsoleteAttribute(@"Intended only for private use. You should use PdfShading.MakeShading(iText.Kernel.Pdf.PdfDictionary) instead."
+ )]
public LatticeFormGouraudShadedTriangleMesh(PdfStream pdfStream)
: base(pdfStream) {
}
+ /// Creates the new instance of the class.
+ ///
+ /// the
+ ///
+ /// object in which colour values shall be expressed.
+ /// The special Pattern space isn't excepted.
+ ///
+ ///
+ /// the number of bits used to represent each vertex coordinate.
+ /// The value shall be 1, 2, 4, 8, 12, 16, 24, or 32.
+ ///
+ ///
+ /// the number of bits used to represent each colour component.
+ /// The value shall be 1, 2, 4, 8, 12, or 16.
+ ///
+ ///
+ /// the number of vertices in each row of the lattice (shall be > 1).
+ /// The number of rows need not be specified.
+ ///
+ ///
+ /// the
+ /// int[]
+ /// of numbers specifying how to map vertex coordinates and colour components
+ /// into the appropriate ranges of values. The ranges shall be specified as follows:
+ /// [x_min x_max y_min y_max c1_min c1_max … cn_min cn_max].
+ /// Only one pair of color values shall be specified if a Function entry is present.
+ ///
public LatticeFormGouraudShadedTriangleMesh(PdfColorSpace cs, int bitsPerCoordinate, int bitsPerComponent,
int verticesPerRow, float[] decode)
: this(cs, bitsPerCoordinate, bitsPerComponent, verticesPerRow, new PdfArray(decode)) {
}
+ /// Creates the new instance of the class.
+ ///
+ /// the
+ ///
+ /// object in which colour values shall be expressed.
+ /// The special Pattern space isn't excepted.
+ ///
+ ///
+ /// the number of bits used to represent each vertex coordinate.
+ /// The value shall be 1, 2, 4, 8, 12, 16, 24, or 32.
+ ///
+ ///
+ /// the number of bits used to represent each colour component.
+ /// The value shall be 1, 2, 4, 8, 12, or 16.
+ ///
+ ///
+ /// the number of vertices in each row of the lattice (shall be > 1).
+ /// The number of rows need not be specified.
+ ///
+ ///
+ /// the
+ ///
+ /// of numbers specifying how to map vertex coordinates and colour components
+ /// into the appropriate ranges of values. The ranges shall be specified as follows:
+ /// [x_min x_max y_min y_max c1_min c1_max … cn_min cn_max].
+ /// Only one pair of color values shall be specified if a Function entry is present.
+ ///
public LatticeFormGouraudShadedTriangleMesh(PdfColorSpace cs, int bitsPerCoordinate, int bitsPerComponent,
int verticesPerRow, PdfArray decode)
- : base(new PdfStream(), PdfShading.ShadingType.LATTICE_FORM_GOURAUD_SHADED_TRIANGLE_MESH, cs.GetPdfObject(
- )) {
+ : base(new PdfStream(), PdfShading.ShadingType.LATTICE_FORM_GOURAUD_SHADED_TRIANGLE_MESH, cs) {
SetBitsPerCoordinate(bitsPerCoordinate);
SetBitsPerComponent(bitsPerComponent);
SetVerticesPerRow(verticesPerRow);
SetDecode(decode);
}
+ /// Gets the number of bits used to represent each vertex coordinate.
+ /// the number of bits. Can be 1, 2, 4, 8, 12, 16, 24, or 32.
public virtual int GetBitsPerCoordinate() {
return (int)GetPdfObject().GetAsInt(PdfName.BitsPerCoordinate);
}
+ /// Sets the number of bits used to represent each vertex coordinate.
+ /// the number of bits to be set. Shall be 1, 2, 4, 8, 12, 16, 24, or 32.
public virtual void SetBitsPerCoordinate(int bitsPerCoordinate) {
GetPdfObject().Put(PdfName.BitsPerCoordinate, new PdfNumber(bitsPerCoordinate));
SetModified();
}
+ /// Gets the number of bits used to represent each colour component.
+ /// the number of bits. Can be 1, 2, 4, 8, 12, or 16.
public virtual int GetBitsPerComponent() {
return (int)GetPdfObject().GetAsInt(PdfName.BitsPerComponent);
}
+ /// Sets the number of bits used to represent each colour component.
+ /// the number of bits to be set. Shall be 1, 2, 4, 8, 12, or 16.
public virtual void SetBitsPerComponent(int bitsPerComponent) {
GetPdfObject().Put(PdfName.BitsPerComponent, new PdfNumber(bitsPerComponent));
SetModified();
}
+ /// Gets the number of vertices in each row of the lattice.
+ /// the number of vertices. Can only be greater than 1.
public virtual int GetVerticesPerRow() {
return (int)GetPdfObject().GetAsInt(PdfName.VerticesPerRow);
}
+ /// Sets the number of vertices in each row of the lattice.
+ ///
+ /// Sets the number of vertices in each row of the lattice.
+ /// The number of rows need not be specified.
+ ///
+ /// the number of vertices to be set. Shall be greater than 1.
public virtual void SetVerticesPerRow(int verticesPerRow) {
GetPdfObject().Put(PdfName.VerticesPerRow, new PdfNumber(verticesPerRow));
SetModified();
}
+ ///
+ /// Gets the
+ ///
+ /// of numbers specifying how to map vertex coordinates and colour components
+ /// into the appropriate ranges of values. The ranges shall be specified as follows:
+ /// [x_min x_max y_min y_max c1_min c1_max … cn_min cn_max].
+ /// Only one pair of color values shall be specified if a Function entry is present.
+ ///
+ ///
+ /// the
+ ///
+ /// Decode object.
+ ///
public virtual PdfArray GetDecode() {
return GetPdfObject().GetAsArray(PdfName.Decode);
}
+ ///
+ /// Sets the
+ /// float[]
+ /// of numbers specifying how to map vertex coordinates and colour components
+ /// into the appropriate ranges of values. The ranges shall be specified as follows:
+ /// [x_min x_max y_min y_max c1_min c1_max … cn_min cn_max].
+ /// Only one pair of color values shall be specified if a Function entry is present.
+ ///
+ ///
+ /// the
+ /// float[]
+ /// of Decode object to set.
+ ///
public virtual void SetDecode(float[] decode) {
GetPdfObject().Put(PdfName.Decode, new PdfArray(decode));
}
+ ///
+ /// Sets the
+ ///
+ /// of numbers specifying how to map vertex coordinates and colour components
+ /// into the appropriate ranges of values. The ranges shall be specified as follows:
+ /// [x_min x_max y_min y_max c1_min c1_max … cn_min cn_max].
+ /// Only one pair of color values shall be specified if a Function entry is present.
+ ///
+ ///
+ /// the
+ ///
+ /// Decode object to set.
+ ///
public virtual void SetDecode(PdfArray decode) {
GetPdfObject().Put(PdfName.Decode, decode);
}
}
+ ///
+ /// The class that extends
+ ///
+ /// class and is in charge of Shading Dictionary with
+ /// Coons Patch mesh type.
+ /// This type of shading is constructed from one or more colour patches, each bounded by four cubic Bézier curves.
+ /// Degenerate Bézier curves are allowed and are useful for certain graphical effects.
+ /// At least one complete patch shall be specified.
+ /// The shape of patch is defined by 12 control points.
+ /// Colours are specified for each corner of the unit square,
+ /// and bilinear interpolation is used to fill in colours over the entire unit square.
+ /// Coordinates are mapped from the unit square into a four-sided patch whose sides are not necessarily linear.
+ /// The mapping is continuous: the corners of the unit square map to corners of the patch
+ /// and the sides of the unit square map to sides of the patch.
+ /// For the format of data stream, that defines patches
+ /// ISO-320001 Table 85
+ /// .
+ /// If the shading dictionary contains a Function entry, the colour data for each corner of a patch
+ /// shall be specified by a single parametric value t rather than by n separate colour components c1…cn.
+ ///
public class CoonsPatchMesh : PdfShading {
+ ///
+ /// Creates the new instance of the class from the existing
+ ///
+ /// object.
+ ///
+ ///
+ ///
+ ///
+ /// from which the instance is created.
+ ///
+ [System.ObsoleteAttribute(@"Intended only for private use. You should use PdfShading.MakeShading(iText.Kernel.Pdf.PdfDictionary) instead."
+ )]
public CoonsPatchMesh(PdfStream pdfStream)
: base(pdfStream) {
}
+ /// Creates the new instance of the class.
+ ///
+ /// the
+ ///
+ /// object in which colour values shall be expressed.
+ /// The special Pattern space isn't excepted.
+ ///
+ ///
+ /// the number of bits used to represent each vertex coordinate.
+ /// The value shall be 1, 2, 4, 8, 12, 16, 24, or 32.
+ ///
+ ///
+ /// the number of bits used to represent each colour component.
+ /// The value shall be 1, 2, 4, 8, 12, or 16.
+ ///
+ ///
+ /// the number of bits used to represent the edge flag for each vertex.
+ /// The value of BitsPerFlag shall be 2, 4, or 8,
+ /// but only the least significant 2 bits in each flag value shall be used.
+ /// The value for the edge flag shall be 0, 1, 2 or 3.
+ ///
+ ///
+ /// the
+ /// int[]
+ /// of numbers specifying how to map vertex coordinates and colour components
+ /// into the appropriate ranges of values. The ranges shall be specified as follows:
+ /// [x_min x_max y_min y_max c1_min c1_max … cn_min cn_max].
+ /// Only one pair of color values shall be specified if a Function entry is present.
+ ///
public CoonsPatchMesh(PdfColorSpace cs, int bitsPerCoordinate, int bitsPerComponent, int bitsPerFlag, float
[] decode)
: this(cs, bitsPerCoordinate, bitsPerComponent, bitsPerFlag, new PdfArray(decode)) {
}
+ /// Creates the new instance of the class.
+ ///
+ /// the
+ ///
+ /// object in which colour values shall be expressed.
+ /// The special Pattern space isn't excepted.
+ ///
+ ///
+ /// the number of bits used to represent each vertex coordinate.
+ /// The value shall be 1, 2, 4, 8, 12, 16, 24, or 32.
+ ///
+ ///
+ /// the number of bits used to represent each colour component.
+ /// The value shall be 1, 2, 4, 8, 12, or 16.
+ ///
+ ///
+ /// the number of bits used to represent the edge flag for each vertex.
+ /// The value of BitsPerFlag shall be 2, 4, or 8,
+ /// but only the least significant 2 bits in each flag value shall be used.
+ /// The value for the edge flag shall be 0, 1, 2 or 3.
+ ///
+ ///
+ /// the
+ ///
+ /// of numbers specifying how to map vertex coordinates and colour components
+ /// into the appropriate ranges of values. The ranges shall be specified as follows:
+ /// [x_min x_max y_min y_max c1_min c1_max … cn_min cn_max].
+ /// Only one pair of color values shall be specified if a Function entry is present.
+ ///
public CoonsPatchMesh(PdfColorSpace cs, int bitsPerCoordinate, int bitsPerComponent, int bitsPerFlag, PdfArray
decode)
- : base(new PdfStream(), PdfShading.ShadingType.COONS_PATCH_MESH, cs.GetPdfObject()) {
+ : base(new PdfStream(), PdfShading.ShadingType.COONS_PATCH_MESH, cs) {
SetBitsPerCoordinate(bitsPerCoordinate);
SetBitsPerComponent(bitsPerComponent);
SetBitsPerFlag(bitsPerFlag);
SetDecode(decode);
}
+ /// Gets the number of bits used to represent each vertex coordinate.
+ /// the number of bits. Can be 1, 2, 4, 8, 12, 16, 24, or 32.
public virtual int GetBitsPerCoordinate() {
return (int)GetPdfObject().GetAsInt(PdfName.BitsPerCoordinate);
}
+ /// Sets the number of bits used to represent each vertex coordinate.
+ /// the number of bits to be set. Shall be 1, 2, 4, 8, 12, 16, 24, or 32.
public virtual void SetBitsPerCoordinate(int bitsPerCoordinate) {
GetPdfObject().Put(PdfName.BitsPerCoordinate, new PdfNumber(bitsPerCoordinate));
SetModified();
}
+ /// Gets the number of bits used to represent each colour component.
+ /// the number of bits. Can be 1, 2, 4, 8, 12, or 16.
public virtual int GetBitsPerComponent() {
return (int)GetPdfObject().GetAsInt(PdfName.BitsPerComponent);
}
+ /// Sets the number of bits used to represent each colour component.
+ /// the number of bits to be set. Shall be 1, 2, 4, 8, 12, or 16.
public virtual void SetBitsPerComponent(int bitsPerComponent) {
GetPdfObject().Put(PdfName.BitsPerComponent, new PdfNumber(bitsPerComponent));
SetModified();
}
+ /// Gets the number of bits used to represent the edge flag for each vertex.
+ ///
+ /// Gets the number of bits used to represent the edge flag for each vertex.
+ /// But only the least significant 2 bits in each flag value shall be used.
+ /// The valid flag values are 0, 1, 2 or 3.
+ ///
+ /// the number of bits. Can be 2, 4 or 8.
public virtual int GetBitsPerFlag() {
return (int)GetPdfObject().GetAsInt(PdfName.BitsPerFlag);
}
+ /// Sets the number of bits used to represent the edge flag for each vertex.
+ ///
+ /// Sets the number of bits used to represent the edge flag for each vertex.
+ /// But only the least significant 2 bits in each flag value shall be used.
+ /// The valid flag values are 0, 1, 2 or 3.
+ ///
+ /// the number of bits to be set. Shall be 2, 4 or 8.
public virtual void SetBitsPerFlag(int bitsPerFlag) {
GetPdfObject().Put(PdfName.BitsPerFlag, new PdfNumber(bitsPerFlag));
SetModified();
}
+ ///
+ /// Gets the
+ ///
+ /// of numbers specifying how to map vertex coordinates and colour components
+ /// into the appropriate ranges of values. The ranges shall be specified as follows:
+ /// [x_min x_max y_min y_max c1_min c1_max … cn_min cn_max].
+ /// Only one pair of color values shall be specified if a Function entry is present.
+ ///
+ ///
+ /// the
+ ///
+ /// Decode object.
+ ///
public virtual PdfArray GetDecode() {
return GetPdfObject().GetAsArray(PdfName.Decode);
}
+ ///
+ /// Sets the
+ /// float[]
+ /// of numbers specifying how to map vertex coordinates and colour components
+ /// into the appropriate ranges of values. The ranges shall be specified as follows:
+ /// [x_min x_max y_min y_max c1_min c1_max … cn_min cn_max].
+ /// Only one pair of color values shall be specified if a Function entry is present.
+ ///
+ ///
+ /// the
+ /// float[]
+ /// of Decode object to set.
+ ///
public virtual void SetDecode(float[] decode) {
GetPdfObject().Put(PdfName.Decode, new PdfArray(decode));
}
+ ///
+ /// Sets the
+ ///
+ /// of numbers specifying how to map vertex coordinates and colour components
+ /// into the appropriate ranges of values. The ranges shall be specified as follows:
+ /// [x_min x_max y_min y_max c1_min c1_max … cn_min cn_max].
+ /// Only one pair of color values shall be specified if a Function entry is present.
+ ///
+ ///
+ /// the
+ ///
+ /// Decode object to set.
+ ///
public virtual void SetDecode(PdfArray decode) {
GetPdfObject().Put(PdfName.Decode, decode);
}
}
+ ///
+ /// The class that extends
+ ///
+ /// class and is in charge of Shading Dictionary with
+ /// Tensor-Product Patch mesh type.
+ /// This type of shading is identical to
+ ///
+ /// , except that it's based on a
+ /// bicubic tensor-product patch defined by 16 control points.
+ /// For the format of data stream, that defines patches
+ /// ISO-320001 Table 86
+ /// .
+ ///
public class TensorProductPatchMesh : PdfShading {
+ ///
+ /// Creates the new instance of the class from the existing
+ ///
+ /// object.
+ ///
+ ///
+ ///
+ ///
+ /// from which the instance is created.
+ ///
+ [System.ObsoleteAttribute(@"Intended only for private use. You should use PdfShading.MakeShading(iText.Kernel.Pdf.PdfDictionary) instead."
+ )]
public TensorProductPatchMesh(PdfStream pdfStream)
: base(pdfStream) {
}
+ /// Creates the new instance of the class.
+ ///
+ /// the
+ ///
+ /// object in which colour values shall be expressed.
+ /// The special Pattern space isn't excepted.
+ ///
+ ///
+ /// the number of bits used to represent each vertex coordinate.
+ /// The value shall be 1, 2, 4, 8, 12, 16, 24, or 32.
+ ///
+ ///
+ /// the number of bits used to represent each colour component.
+ /// The value shall be 1, 2, 4, 8, 12, or 16.
+ ///
+ ///
+ /// the number of bits used to represent the edge flag for each vertex.
+ /// The value of BitsPerFlag shall be 2, 4, or 8,
+ /// but only the least significant 2 bits in each flag value shall be used.
+ /// The value for the edge flag shall be 0, 1, 2 or 3.
+ ///
+ ///
+ /// the
+ /// int[]
+ /// of numbers specifying how to map vertex coordinates and colour components
+ /// into the appropriate ranges of values. The ranges shall be specified as follows:
+ /// [x_min x_max y_min y_max c1_min c1_max … cn_min cn_max].
+ /// Only one pair of color values shall be specified if a Function entry is present.
+ ///
public TensorProductPatchMesh(PdfColorSpace cs, int bitsPerCoordinate, int bitsPerComponent, int bitsPerFlag
, float[] decode)
: this(cs, bitsPerCoordinate, bitsPerComponent, bitsPerFlag, new PdfArray(decode)) {
}
+ /// Creates the new instance of the class.
+ ///
+ /// the
+ ///
+ /// object in which colour values shall be expressed.
+ /// The special Pattern space isn't excepted.
+ ///
+ ///
+ /// the number of bits used to represent each vertex coordinate.
+ /// The value shall be 1, 2, 4, 8, 12, 16, 24, or 32.
+ ///
+ ///
+ /// the number of bits used to represent each colour component.
+ /// The value shall be 1, 2, 4, 8, 12, or 16.
+ ///
+ ///
+ /// the number of bits used to represent the edge flag for each vertex.
+ /// The value of BitsPerFlag shall be 2, 4, or 8,
+ /// but only the least significant 2 bits in each flag value shall be used.
+ /// The value for the edge flag shall be 0, 1, 2 or 3.
+ ///
+ ///
+ /// the
+ ///
+ /// of numbers specifying how to map vertex coordinates and colour components
+ /// into the appropriate ranges of values. The ranges shall be specified as follows:
+ /// [x_min x_max y_min y_max c1_min c1_max … cn_min cn_max].
+ /// Only one pair of color values shall be specified if a Function entry is present.
+ ///
public TensorProductPatchMesh(PdfColorSpace cs, int bitsPerCoordinate, int bitsPerComponent, int bitsPerFlag
, PdfArray decode)
- : base(new PdfStream(), PdfShading.ShadingType.TENSOR_PRODUCT_PATCH_MESH, cs.GetPdfObject()) {
+ : base(new PdfStream(), PdfShading.ShadingType.TENSOR_PRODUCT_PATCH_MESH, cs) {
SetBitsPerCoordinate(bitsPerCoordinate);
SetBitsPerComponent(bitsPerComponent);
SetBitsPerFlag(bitsPerFlag);
SetDecode(decode);
}
+ /// Gets the number of bits used to represent each vertex coordinate.
+ /// the number of bits. Can be 1, 2, 4, 8, 12, 16, 24, or 32.
public virtual int GetBitsPerCoordinate() {
return (int)GetPdfObject().GetAsInt(PdfName.BitsPerCoordinate);
}
+ /// Sets the number of bits used to represent each vertex coordinate.
+ /// the number of bits to be set. Shall be 1, 2, 4, 8, 12, 16, 24, or 32.
public virtual void SetBitsPerCoordinate(int bitsPerCoordinate) {
GetPdfObject().Put(PdfName.BitsPerCoordinate, new PdfNumber(bitsPerCoordinate));
SetModified();
}
+ /// Gets the number of bits used to represent each colour component.
+ /// the number of bits. Can be 1, 2, 4, 8, 12, or 16.
public virtual int GetBitsPerComponent() {
return (int)GetPdfObject().GetAsInt(PdfName.BitsPerComponent);
}
+ /// Sets the number of bits used to represent each colour component.
+ /// the number of bits to be set. Shall be 1, 2, 4, 8, 12, or 16.
public virtual void SetBitsPerComponent(int bitsPerComponent) {
GetPdfObject().Put(PdfName.BitsPerComponent, new PdfNumber(bitsPerComponent));
SetModified();
}
+ /// Gets the number of bits used to represent the edge flag for each vertex.
+ ///
+ /// Gets the number of bits used to represent the edge flag for each vertex.
+ /// But only the least significant 2 bits in each flag value shall be used.
+ /// The valid flag values are 0, 1, 2 or 3.
+ ///
+ /// the number of bits. Can be 2, 4 or 8.
public virtual int GetBitsPerFlag() {
return (int)GetPdfObject().GetAsInt(PdfName.BitsPerFlag);
}
+ /// Sets the number of bits used to represent the edge flag for each vertex.
+ ///
+ /// Sets the number of bits used to represent the edge flag for each vertex.
+ /// But only the least significant 2 bits in each flag value shall be used.
+ /// The valid flag values are 0, 1, 2 or 3.
+ ///
+ /// the number of bits to be set. Shall be 2, 4 or 8.
public virtual void SetBitsPerFlag(int bitsPerFlag) {
GetPdfObject().Put(PdfName.BitsPerFlag, new PdfNumber(bitsPerFlag));
SetModified();
}
+ ///
+ /// Gets the
+ ///
+ /// of numbers specifying how to map vertex coordinates and colour components
+ /// into the appropriate ranges of values. The ranges shall be specified as follows:
+ /// [x_min x_max y_min y_max c1_min c1_max … cn_min cn_max].
+ /// Only one pair of color values shall be specified if a Function entry is present.
+ ///
+ ///
+ /// the
+ ///
+ /// Decode object.
+ ///
public virtual PdfArray GetDecode() {
return GetPdfObject().GetAsArray(PdfName.Decode);
}
+ ///
+ /// Sets the
+ /// float[]
+ /// of numbers specifying how to map vertex coordinates and colour components
+ /// into the appropriate ranges of values. The ranges shall be specified as follows:
+ /// [x_min x_max y_min y_max c1_min c1_max … cn_min cn_max].
+ /// Only one pair of color values shall be specified if a Function entry is present.
+ ///
+ ///
+ /// the
+ /// float[]
+ /// of Decode object to set.
+ ///
public virtual void SetDecode(float[] decode) {
GetPdfObject().Put(PdfName.Decode, new PdfArray(decode));
}
+ ///
+ /// Sets the
+ ///
+ /// of numbers specifying how to map vertex coordinates and colour components
+ /// into the appropriate ranges of values. The ranges shall be specified as follows:
+ /// [x_min x_max y_min y_max c1_min c1_max … cn_min cn_max].
+ /// Only one pair of color values shall be specified if a Function entry is present.
+ ///
+ ///
+ /// the
+ ///
+ /// Decode object to set.
+ ///
public virtual void SetDecode(PdfArray decode) {
GetPdfObject().Put(PdfName.Decode, decode);
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/colorspace/PdfSpecialCs.cs b/itext/itext.kernel/itext/kernel/pdf/colorspace/PdfSpecialCs.cs
index 7bce84ce70..465bed14e5 100644
--- a/itext/itext.kernel/itext/kernel/pdf/colorspace/PdfSpecialCs.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/colorspace/PdfSpecialCs.cs
@@ -53,6 +53,21 @@ protected internal PdfSpecialCs(PdfArray pdfObject)
: base(pdfObject) {
}
+ ///
+ /// To manually flush a
+ /// PdfObject
+ /// behind this wrapper, you have to ensure
+ /// that this object is added to the document, i.e. it has an indirect reference.
+ /// Basically this means that before flushing you need to explicitly call
+ ///
+ /// .
+ /// For example: wrapperInstance.makeIndirect(document).flush();
+ /// Note that not every wrapper require this, only those that have such warning in documentation.
+ ///
+ public override void Flush() {
+ base.Flush();
+ }
+
protected internal override bool IsWrappedObjectMustBeIndirect() {
return true;
}
@@ -212,6 +227,21 @@ public override int GetNumberOfComponents() {
}
public class UncoloredTilingPattern : PdfSpecialCs.Pattern {
+ ///
+ /// To manually flush a
+ /// PdfObject
+ /// behind this wrapper, you have to ensure
+ /// that this object is added to the document, i.e. it has an indirect reference.
+ /// Basically this means that before flushing you need to explicitly call
+ ///
+ /// .
+ /// For example: wrapperInstance.makeIndirect(document).flush();
+ /// Note that not every wrapper require this, only those that have such warning in documentation.
+ ///
+ public override void Flush() {
+ base.Flush();
+ }
+
protected internal override bool IsWrappedObjectMustBeIndirect() {
return true;
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/extgstate/PdfExtGState.cs b/itext/itext.kernel/itext/kernel/pdf/extgstate/PdfExtGState.cs
index 2de6029cca..4d88460ec3 100644
--- a/itext/itext.kernel/itext/kernel/pdf/extgstate/PdfExtGState.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/extgstate/PdfExtGState.cs
@@ -41,278 +41,1093 @@ source product.
For more information, please contact iText Software Corp. at this
address: sales@itextpdf.com
*/
+using System;
using iText.Kernel.Pdf;
namespace iText.Kernel.Pdf.Extgstate {
+ /// Graphics state parameter dictionary wrapper.
+ ///
+ /// Graphics state parameter dictionary wrapper.
+ /// See ISO-320001, 8.4.5 Graphics State Parameter Dictionaries.
+ ///
public class PdfExtGState : PdfObjectWrapper {
- /// Blend mode constants
+ /// Standard separable blend mode.
+ /// Standard separable blend mode. See ISO-320001, table 136
public static PdfName BM_NORMAL = PdfName.Normal;
+ /// Standard separable blend mode.
+ /// Standard separable blend mode. See ISO-320001, table 136
public static PdfName BM_MULTIPLY = PdfName.Multiply;
+ /// Standard separable blend mode.
+ /// Standard separable blend mode. See ISO-320001, table 136
public static PdfName BM_SCREEN = PdfName.Screen;
+ /// Standard separable blend mode.
+ /// Standard separable blend mode. See ISO-320001, table 136
public static PdfName BM_OVERLAY = PdfName.Overlay;
+ /// Standard separable blend mode.
+ /// Standard separable blend mode. See ISO-320001, table 136
public static PdfName BM_DARKEN = PdfName.Darken;
+ /// Standard separable blend mode.
+ /// Standard separable blend mode. See ISO-320001, table 136
public static PdfName BM_LIGHTEN = PdfName.Lighten;
+ /// Standard separable blend mode.
+ /// Standard separable blend mode. See ISO-320001, table 136
public static PdfName BM_COLOR_DODGE = PdfName.ColorDodge;
+ /// Standard separable blend mode.
+ /// Standard separable blend mode. See ISO-320001, table 136
public static PdfName BM_COLOR_BURN = PdfName.ColorBurn;
+ /// Standard separable blend mode.
+ /// Standard separable blend mode. See ISO-320001, table 136
public static PdfName BM_HARD_LIGHT = PdfName.HardLight;
+ /// Standard separable blend mode.
+ /// Standard separable blend mode. See ISO-320001, table 136
public static PdfName BM_SOFT_LIGHT = PdfName.SoftLight;
+ /// Standard separable blend mode.
+ /// Standard separable blend mode. See ISO-320001, table 136
public static PdfName BM_DIFFERENCE = PdfName.Difference;
+ /// Standard separable blend mode.
+ /// Standard separable blend mode. See ISO-320001, table 136
public static PdfName BM_EXCLUSION = PdfName.Exclusion;
+ /// Standard nonseparable blend mode.
+ /// Standard nonseparable blend mode. See ISO-320001, table 137
public static PdfName BM_HUE = PdfName.Hue;
+ /// Standard nonseparable blend mode.
+ /// Standard nonseparable blend mode. See ISO-320001, table 137
public static PdfName BM_SATURATION = PdfName.Saturation;
+ /// Standard nonseparable blend mode.
+ /// Standard nonseparable blend mode. See ISO-320001, table 137
public static PdfName BM_COLOR = PdfName.Color;
+ /// Standard nonseparable blend mode.
+ /// Standard nonseparable blend mode. See ISO-320001, table 137
public static PdfName BM_LUMINOSITY = PdfName.Luminosity;
+ ///
+ /// Create instance of graphics state parameter dictionary wrapper
+ /// by existed
+ /// PdfDictionary
+ /// object
+ ///
+ /// instance of graphics state parameter dictionary
public PdfExtGState(PdfDictionary pdfObject)
: base(pdfObject) {
- MarkObjectAsIndirect(GetPdfObject());
}
+ /// Create default instance of graphics state parameter dictionary
public PdfExtGState()
: this(new PdfDictionary()) {
}
+ ///
+ /// Gets line width value,
+ /// LW
+ /// key.
+ ///
+ ///
+ /// a
+ /// float
+ /// value if exist, otherwise
+ ///
+ /// .
+ ///
public virtual float? GetLineWidth() {
return GetPdfObject().GetAsFloat(PdfName.LW);
}
+ ///
+ /// Sets line width value,
+ /// LW
+ /// key.
+ ///
+ ///
+ /// a
+ /// float
+ /// value.
+ ///
+ /// object itself.
public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetLineWidth(float lineWidth) {
return Put(PdfName.LW, new PdfNumber(lineWidth));
}
+ ///
+ /// Gets line gap style value,
+ /// LC
+ /// key.
+ ///
+ /// 0 - butt cap, 1 - round cap, 2 - projecting square cap.
public virtual int? GetLineCapStyle() {
return GetPdfObject().GetAsInt(PdfName.LC);
}
+ ///
+ /// Sets line gap style value,
+ /// LC
+ /// key.
+ ///
+ /// 0 - butt cap, 1 - round cap, 2 - projecting square cap.
+ /// object itself.
+ [System.ObsoleteAttribute(@"Use SetLineCapStyle(int) instead.")]
public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetLineCapStryle(int lineCapStyle) {
return Put(PdfName.LC, new PdfNumber(lineCapStyle));
}
+ ///
+ /// Sets line gap style value,
+ /// LC
+ /// key.
+ ///
+ /// 0 - butt cap, 1 - round cap, 2 - projecting square cap.
+ /// object itself.
+ public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetLineCapStyle(int lineCapStyle) {
+ return Put(PdfName.LC, new PdfNumber(lineCapStyle));
+ }
+
+ ///
+ /// Gets line join style value,
+ /// LJ
+ /// key.
+ ///
+ /// 0 - miter join (see also miter limit), 1 - round join, 2 - bevel join.
public virtual int? GetLineJoinStyle() {
return GetPdfObject().GetAsInt(PdfName.LJ);
}
+ ///
+ /// Sets line join style value,
+ /// LJ
+ /// key.
+ ///
+ /// 0 - miter join (see also miter limit), 1 - round join, 2 - bevel join.
+ /// object itself.
public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetLineJoinStyle(int lineJoinStyle) {
return Put(PdfName.LJ, new PdfNumber(lineJoinStyle));
}
+ ///
+ /// Gets miter limit value,
+ /// ML key
+ /// . See also line join style.
+ ///
+ ///
+ /// a
+ /// float
+ /// value if exist, otherwise
+ ///
+ /// .
+ ///
public virtual float? GetMiterLimit() {
return GetPdfObject().GetAsFloat(PdfName.ML);
}
+ ///
+ /// Sets miter limit value,
+ /// ML key
+ /// . See also line join style.
+ ///
+ ///
+ /// a
+ /// float
+ /// value.
+ ///
+ /// object itself.
public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetMiterLimit(float miterLimit) {
return Put(PdfName.ML, new PdfNumber(miterLimit));
}
+ ///
+ /// Gets line dash pattern value,
+ /// D
+ /// key.
+ ///
+ ///
+ /// a
+ /// PdfArray
+ /// , that represents line dash pattern.
+ ///
public virtual PdfArray GetDashPattern() {
return GetPdfObject().GetAsArray(PdfName.D);
}
+ ///
+ /// Sets line dash pattern value,
+ /// D
+ /// key.
+ ///
+ ///
+ /// a
+ /// PdfArray
+ /// , that represents line dash pattern.
+ ///
+ /// object itself.
public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetDashPattern(PdfArray dashPattern) {
return Put(PdfName.D, dashPattern);
}
+ ///
+ /// Gets rendering intent value,
+ /// RI
+ /// key.
+ /// Valid values are:
+ /// AbsoluteColorimetric
+ /// ,
+ /// RelativeColorimetric
+ /// ,
+ /// Saturation
+ /// ,
+ /// Perceptual
+ /// .
+ ///
+ ///
+ /// a
+ /// PdfName
+ /// instance.
+ ///
public virtual PdfName GetRenderingIntent() {
return GetPdfObject().GetAsName(PdfName.RI);
}
+ ///
+ /// Sets rendering intent value,
+ /// RI
+ /// key.
+ ///
+ ///
+ /// a
+ /// PdfName
+ /// instance, Valid values are:
+ /// AbsoluteColorimetric
+ /// ,
+ /// RelativeColorimetric
+ /// ,
+ /// Saturation
+ /// ,
+ /// Perceptual
+ /// .
+ ///
+ /// object itself.
public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetRenderingIntent(PdfName renderingIntent) {
return Put(PdfName.RI, renderingIntent);
}
- public virtual int? GetOverprintMode() {
- return GetPdfObject().GetAsInt(PdfName.OPM);
+ ///
+ /// Get overprint flag value for stroking operations,
+ /// OP
+ /// key.
+ ///
+ ///
+ /// a
+ /// boolean
+ /// value if exist, otherwise
+ ///
+ /// .
+ ///
+ public virtual bool? GetStrokeOverprintFlag() {
+ return GetPdfObject().GetAsBool(PdfName.OP);
}
- public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetOverprintMode(int overprintMode) {
- return Put(PdfName.OPM, new PdfNumber(overprintMode));
+ ///
+ /// Set overprint flag value for stroking operations,
+ /// OP
+ /// key.
+ ///
+ ///
+ ///
+ ///
+ /// , for applying overprint for stroking operations.
+ ///
+ /// object itself.
+ public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetStrokeOverPrintFlag(bool strokeOverPrintFlag) {
+ return Put(PdfName.OP, new PdfBoolean(strokeOverPrintFlag));
}
+ ///
+ /// Get overprint flag value for non-stroking operations,
+ /// op
+ /// key.
+ ///
+ ///
+ /// a
+ /// boolean
+ /// value if exist, otherwise
+ ///
+ /// .
+ ///
public virtual bool? GetFillOverprintFlag() {
return GetPdfObject().GetAsBool(PdfName.op);
}
+ ///
+ /// Set overprint flag value for non-stroking operations,
+ /// op
+ /// key.
+ ///
+ ///
+ ///
+ ///
+ /// , for applying overprint for non-stroking operations.
+ ///
+ /// object itself.
public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetFillOverPrintFlag(bool fillOverprintFlag) {
return Put(PdfName.op, new PdfBoolean(fillOverprintFlag));
}
- public virtual bool? GetStrokeOverprintFlag() {
- return GetPdfObject().GetAsBool(PdfName.OP);
+ ///
+ /// Get overprint control mode,
+ /// OPM
+ /// key.
+ ///
+ ///
+ /// an
+ /// int
+ /// value if exist, otherwise
+ ///
+ /// .
+ ///
+ public virtual int? GetOverprintMode() {
+ return GetPdfObject().GetAsInt(PdfName.OPM);
}
- public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetStrokeOverPrintFlag(bool strokeOverPrintFlag) {
- return Put(PdfName.OP, new PdfBoolean(strokeOverPrintFlag));
+ ///
+ /// Set overprint control mode,
+ /// OPM
+ /// key.
+ ///
+ ///
+ /// an
+ /// int
+ /// value, see ISO-320001, 8.6.7 Overprint Control.
+ ///
+ /// object itself.
+ public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetOverprintMode(int overprintMode) {
+ return Put(PdfName.OPM, new PdfNumber(overprintMode));
}
+ ///
+ /// Gets font and size,
+ /// Font
+ /// key.
+ ///
+ ///
+ /// a
+ ///
+ /// of the form
+ /// [font size]
+ /// , where
+ /// font
+ /// shall be an indirect reference to a font dictionary and
+ /// size
+ /// shall be a number expressed in text space units.
+ ///
public virtual PdfArray GetFont() {
return GetPdfObject().GetAsArray(PdfName.Font);
}
+ ///
+ /// Sets font and size,
+ /// Font
+ /// key.
+ ///
+ ///
+ /// a
+ ///
+ /// of the form
+ /// [font size]
+ /// , where
+ ///
+ /// shall be an indirect reference to a font dictionary and
+ /// size
+ /// shall be a number expressed in text space units.
+ ///
+ /// object itself.
public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetFont(PdfArray font) {
return Put(PdfName.Font, font);
}
+ ///
+ /// Gets the black-generation function value,
+ /// BG
+ /// .
+ ///
+ ///
+ /// a
+ ///
+ /// , should be
+ ///
+ /// .
+ ///
public virtual PdfObject GetBlackGenerationFunction() {
return GetPdfObject().Get(PdfName.BG);
}
+ ///
+ /// Sets the black-generation function value,
+ /// BG
+ /// .
+ ///
+ ///
+ /// a
+ ///
+ /// , shall be
+ ///
+ /// .
+ ///
+ /// object itself.
public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetBlackGenerationFunction(PdfObject blackGenerationFunction
) {
return Put(PdfName.BG, blackGenerationFunction);
}
+ ///
+ /// Gets the black-generation function value or
+ /// Default
+ /// ,
+ /// BG2
+ /// key.
+ ///
+ ///
+ /// a
+ ///
+ /// value, should be either
+ ///
+ /// or
+ ///
+ /// .
+ ///
public virtual PdfObject GetBlackGenerationFunction2() {
return GetPdfObject().Get(PdfName.BG2);
}
+ ///
+ /// Sets the black-generation function value or
+ /// Default
+ /// ,
+ /// BG2
+ /// key.
+ /// Note, if both
+ /// BG
+ /// and
+ /// BG2
+ /// are present in the same graphics state parameter dictionary,
+ /// BG2
+ /// takes precedence.
+ ///
+ ///
+ /// a
+ ///
+ /// value, shall be either
+ ///
+ /// or
+ /// Default
+ /// .
+ ///
+ /// object itself.
public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetBlackGenerationFunction2(PdfObject blackGenerationFunction2
) {
return Put(PdfName.BG2, blackGenerationFunction2);
}
+ ///
+ /// Gets the undercolor-removal function,
+ /// UCR
+ /// key.
+ ///
+ ///
+ /// a
+ ///
+ /// , should be
+ ///
+ /// .
+ ///
public virtual PdfObject GetUndercolorRemovalFunction() {
return GetPdfObject().Get(PdfName.UCR);
}
+ ///
+ /// Sets the undercolor-removal function,
+ /// UCR
+ /// key.
+ ///
+ ///
+ /// a
+ ///
+ /// , shall be
+ ///
+ /// .
+ ///
+ /// object itself.
public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetUndercolorRemovalFunction(PdfObject undercolorRemovalFunction
) {
return Put(PdfName.UCR, undercolorRemovalFunction);
}
+ ///
+ /// Gets the undercolor-removal function value or
+ /// Default
+ /// ,
+ /// UCR2
+ /// key.
+ ///
+ ///
+ /// a
+ ///
+ /// value, should be either
+ ///
+ /// or
+ ///
+ /// .
+ ///
public virtual PdfObject GetUndercolorRemovalFunction2() {
return GetPdfObject().Get(PdfName.UCR2);
}
+ ///
+ /// Sets the undercolor-removal function value or
+ /// Default
+ /// ,
+ /// UCR2
+ /// key.
+ /// Note, if both
+ /// UCR
+ /// and
+ /// UCR2
+ /// are present in the same graphics state parameter dictionary,
+ /// UCR2
+ /// takes precedence.
+ ///
+ ///
+ /// a
+ ///
+ /// value, shall be either
+ ///
+ /// or
+ /// Default
+ /// .
+ ///
+ /// object itself.
public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetUndercolorRemovalFunction2(PdfObject undercolorRemovalFunction2
) {
return Put(PdfName.UCR2, undercolorRemovalFunction2);
}
+ ///
+ /// Gets the transfer function value,
+ /// TR
+ /// key.
+ ///
+ ///
+ /// a
+ ///
+ /// , should be either
+ ///
+ /// ,
+ ///
+ /// or
+ ///
+ /// .
+ ///
public virtual PdfObject GetTransferFunction() {
return GetPdfObject().Get(PdfName.TR);
}
+ ///
+ /// Sets the transfer function value,
+ /// TR
+ /// key.
+ ///
+ ///
+ /// a
+ ///
+ /// , shall be either
+ ///
+ /// ,
+ ///
+ /// or
+ ///
+ /// .
+ ///
+ /// object itself.
public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetTransferFunction(PdfObject transferFunction) {
return Put(PdfName.TR, transferFunction);
}
+ ///
+ /// Gets the transfer function value or
+ /// Default
+ /// ,
+ /// TR2
+ /// key.
+ ///
+ ///
+ /// a
+ ///
+ /// , should be either
+ ///
+ /// ,
+ ///
+ /// or
+ ///
+ /// .
+ ///
public virtual PdfObject GetTransferFunction2() {
return GetPdfObject().Get(PdfName.TR2);
}
- public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetTransferFunction2(PdfObject transferFunction) {
- return Put(PdfName.TR2, transferFunction);
+ ///
+ /// Sets the transfer function value or
+ /// Default
+ /// ,
+ /// TR2
+ /// key.
+ /// Note, if both
+ /// TR
+ /// and
+ /// TR2
+ /// are present in the same graphics state parameter dictionary,
+ /// TR2
+ /// takes precedence.
+ ///
+ ///
+ /// a
+ ///
+ /// , shall be either
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ /// or
+ /// Default
+ /// .
+ ///
+ /// object itself.
+ public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetTransferFunction2(PdfObject transferFunction2) {
+ return Put(PdfName.TR2, transferFunction2);
}
+ ///
+ /// Gets the halftone dictionary, stream or
+ /// Default
+ /// ,
+ /// HT
+ /// key.
+ ///
+ ///
+ /// a
+ ///
+ /// , should be either
+ ///
+ /// ,
+ ///
+ /// or
+ ///
+ /// .
+ ///
public virtual PdfObject GetHalftone() {
return GetPdfObject().Get(PdfName.HT);
}
+ ///
+ /// Sets the halftone or
+ /// Default
+ /// ,
+ /// HT
+ /// key.
+ ///
+ ///
+ /// a
+ ///
+ /// , shall be either
+ ///
+ /// ,
+ ///
+ /// or
+ ///
+ /// .
+ ///
+ /// object itself.
public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetHalftone(PdfObject halftone) {
return Put(PdfName.HT, halftone);
}
+ ///
+ /// Gets
+ /// HTP
+ /// key.
+ ///
+ [Obsolete]
public virtual PdfObject GetHTP() {
return GetPdfObject().Get(PdfName.HTP);
}
+ ///
+ /// Sets
+ /// HTP
+ /// key.
+ ///
+ ///
+ /// a
+ ///
+ /// .
+ ///
+ /// object itself.
+ [Obsolete]
public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetHTP(PdfObject htp) {
return Put(PdfName.HTP, htp);
}
+ ///
+ /// Gets the flatness tolerance value,
+ /// FL
+ /// key.
+ ///
+ ///
+ /// a
+ /// float
+ /// value if exist, otherwise
+ ///
+ /// .
+ ///
public virtual float? GetFlatnessTolerance() {
- return GetPdfObject().GetAsFloat(PdfName.FT);
+ return GetPdfObject().GetAsFloat(PdfName.FL);
}
+ ///
+ /// Sets the flatness tolerance value,
+ /// FL
+ /// key.
+ ///
+ ///
+ /// a
+ /// float
+ /// value.
+ ///
+ /// object itself.
public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetFlatnessTolerance(float flatnessTolerance) {
- return Put(PdfName.FT, new PdfNumber(flatnessTolerance));
+ return Put(PdfName.FL, new PdfNumber(flatnessTolerance));
}
+ ///
+ /// Gets the smoothness tolerance value,
+ /// SM
+ /// key.
+ ///
+ ///
+ /// a
+ /// float
+ /// value if exist, otherwise
+ ///
+ /// .
+ ///
public virtual float? GetSmothnessTolerance() {
return GetPdfObject().GetAsFloat(PdfName.SM);
}
+ ///
+ /// Sets the smoothness tolerance value,
+ /// SM
+ /// key.
+ ///
+ ///
+ /// a
+ /// float
+ /// value.
+ ///
+ /// object itself.
public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetSmoothnessTolerance(float smoothnessTolerance) {
return Put(PdfName.SM, new PdfNumber(smoothnessTolerance));
}
+ ///
+ /// Gets value of an automatic stroke adjustment flag,
+ /// SA
+ /// key.
+ ///
+ ///
+ /// a
+ /// boolean
+ /// value if exist, otherwise
+ ///
+ /// .
+ ///
public virtual bool? GetAutomaticStrokeAdjustmentFlag() {
return GetPdfObject().GetAsBool(PdfName.SA);
}
+ ///
+ /// Sets value of an automatic stroke adjustment flag,
+ /// SA
+ /// key.
+ ///
+ ///
+ /// a
+ /// boolean
+ /// value.
+ ///
+ /// object itself.
public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetAutomaticStrokeAdjustmentFlag(bool strokeAdjustment
) {
return Put(PdfName.SA, new PdfBoolean(strokeAdjustment));
}
+ ///
+ /// Gets the current blend mode for the transparent imaging model,
+ /// BM
+ /// key.
+ ///
+ ///
+ /// a
+ ///
+ /// , should be either
+ ///
+ /// or
+ ///
+ /// .
+ ///
public virtual PdfObject GetBlendMode() {
return GetPdfObject().Get(PdfName.BM);
}
+ ///
+ /// Sets the current blend mode for the transparent imaging model,
+ /// BM
+ /// key.
+ ///
+ ///
+ /// a
+ ///
+ /// , shall be either
+ ///
+ /// or
+ ///
+ /// .
+ ///
+ /// object itself.
public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetBlendMode(PdfObject blendMode) {
return Put(PdfName.BM, blendMode);
}
+ ///
+ /// Gets the current soft mask,
+ /// SMask
+ /// key.
+ ///
+ ///
+ /// a
+ ///
+ /// , should be either
+ ///
+ /// or
+ ///
+ /// .
+ ///
public virtual PdfObject GetSoftMask() {
return GetPdfObject().Get(PdfName.SMask);
}
+ ///
+ /// Sets the current soft mask,
+ /// SMask
+ /// key.
+ ///
+ ///
+ /// a
+ ///
+ /// , shall be either
+ ///
+ /// or
+ ///
+ /// .
+ ///
+ /// object itself.
public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetSoftMask(PdfObject sMask) {
return Put(PdfName.SMask, sMask);
}
+ ///
+ /// Gets the current alpha constant, specifying the constant shape or constant opacity value
+ /// for stroking operations in the transparent imaging model,
+ /// CA
+ /// key.
+ ///
+ ///
+ /// a
+ /// float
+ /// value if exist, otherwise
+ ///
+ /// .
+ ///
public virtual float? GetStrokeOpacity() {
return GetPdfObject().GetAsFloat(PdfName.CA);
}
+ ///
+ /// Sets the current alpha constant, specifying the constant shape or constant opacity value
+ /// for stroking operations in the transparent imaging model,
+ /// CA
+ /// key.
+ ///
+ ///
+ /// a
+ /// float
+ /// value.
+ ///
+ /// object itself.
public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetStrokeOpacity(float strokingAlphaConstant) {
return Put(PdfName.CA, new PdfNumber(strokingAlphaConstant));
}
+ ///
+ /// Gets the current alpha constant, specifying the constant shape or constant opacity value
+ /// for non-stroking operations in the transparent imaging model,
+ /// ca
+ /// key.
+ ///
+ ///
+ /// a
+ /// float
+ /// value if exist, otherwise
+ ///
+ /// .
+ ///
public virtual float? GetFillOpacity() {
return GetPdfObject().GetAsFloat(PdfName.ca);
}
+ ///
+ /// Sets the current alpha constant, specifying the constant shape or constant opacity value
+ /// for non-stroking operations in the transparent imaging model,
+ /// ca
+ /// key.
+ ///
+ ///
+ /// a
+ /// float
+ /// value.
+ ///
+ /// object itself.
public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetFillOpacity(float fillingAlphaConstant) {
return Put(PdfName.ca, new PdfNumber(fillingAlphaConstant));
}
+ ///
+ /// Gets the alpha source flag (“alpha is shape”), specifying whether the current soft mask and alpha constant
+ /// shall be interpreted as shape values (
+ ///
+ /// ) or opacity values (
+ ///
+ /// ),
+ /// AIS
+ /// key.
+ ///
+ ///
+ /// a
+ /// boolean
+ /// value if exist, otherwise
+ ///
+ /// .
+ ///
public virtual bool? GetAlphaSourceFlag() {
return GetPdfObject().GetAsBool(PdfName.AIS);
}
+ ///
+ /// Sets the alpha source flag (“alpha is shape”), specifying whether the current soft mask and alpha constant
+ /// shall be interpreted as shape values (
+ ///
+ /// ) or opacity values (
+ ///
+ /// ),
+ /// AIS
+ /// key.
+ ///
+ ///
+ /// if
+ ///
+ /// - alpha as shape values, if
+ ///
+ /// — as opacity values.
+ ///
+ /// object itself.
public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetAlphaSourceFlag(bool alphaSourceFlag) {
return Put(PdfName.AIS, new PdfBoolean(alphaSourceFlag));
}
+ ///
+ /// Gets the text knockout flag, which determine the behaviour of overlapping glyphs
+ /// within a text object in the transparent imaging model,
+ /// TK
+ /// key.
+ ///
+ ///
+ /// a
+ /// boolean
+ /// value if exist, otherwise
+ ///
+ /// .
+ ///
public virtual bool? GetTextKnockoutFlag() {
return GetPdfObject().GetAsBool(PdfName.TK);
}
+ ///
+ /// Sets the text knockout flag, which determine the behaviour of overlapping glyphs
+ /// within a text object in the transparent imaging model,
+ /// TK
+ /// key.
+ ///
+ ///
+ ///
+ ///
+ /// if enabled.
+ ///
+ /// object itself.
public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState SetTextKnockoutFlag(bool textKnockoutFlag) {
return Put(PdfName.TK, new PdfBoolean(textKnockoutFlag));
}
+ /// Puts the value into Graphics state parameter dictionary and associates it with the specified key.
+ ///
+ ///
+ /// Puts the value into Graphics state parameter dictionary and associates it with the specified key.
+ /// If the key is already present, it will override the old value with the specified one.
+ ///
+ /// key to insert or to override
+ /// the value to associate with the specified key
+ /// object itself.
public virtual iText.Kernel.Pdf.Extgstate.PdfExtGState Put(PdfName key, PdfObject value) {
GetPdfObject().Put(key, value);
return this;
}
+ ///
+ /// To manually flush a
+ /// PdfObject
+ /// behind this wrapper, you have to ensure
+ /// that this object is added to the document, i.e. it has an indirect reference.
+ /// Basically this means that before flushing you need to explicitly call
+ ///
+ /// .
+ /// For example: wrapperInstance.makeIndirect(document).flush();
+ /// Note that not every wrapper require this, only those that have such warning in documentation.
+ ///
+ public override void Flush() {
+ base.Flush();
+ }
+
+ ///
protected internal override bool IsWrappedObjectMustBeIndirect() {
return true;
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/filters/FilterHandlers.cs b/itext/itext.kernel/itext/kernel/pdf/filters/FilterHandlers.cs
index 40bd940e0c..78baed5b64 100644
--- a/itext/itext.kernel/itext/kernel/pdf/filters/FilterHandlers.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/filters/FilterHandlers.cs
@@ -66,7 +66,7 @@ static FilterHandlers() {
// it may also be better to split the sub-classes out into a separate package
IDictionary map = new Dictionary();
map[PdfName.FlateDecode] = new FlateDecodeFilter();
- map[PdfName.FL] = new FlateDecodeFilter();
+ map[PdfName.Fl] = new FlateDecodeFilter();
map[PdfName.ASCIIHexDecode] = new ASCIIHexDecodeFilter();
map[PdfName.AHx] = new ASCIIHexDecodeFilter();
map[PdfName.ASCII85Decode] = new ASCII85DecodeFilter();
diff --git a/itext/itext.kernel/itext/kernel/pdf/function/PdfFunction.cs b/itext/itext.kernel/itext/kernel/pdf/function/PdfFunction.cs
index 006902a218..f7a644f069 100644
--- a/itext/itext.kernel/itext/kernel/pdf/function/PdfFunction.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/function/PdfFunction.cs
@@ -68,6 +68,21 @@ public virtual int GetOutputSize() {
return range == null ? 0 : range.Size() / 2;
}
+ ///
+ /// To manually flush a
+ /// PdfObject
+ /// behind this wrapper, you have to ensure
+ /// that this object is added to the document, i.e. it has an indirect reference.
+ /// Basically this means that before flushing you need to explicitly call
+ ///
+ /// .
+ /// For example: wrapperInstance.makeIndirect(document).flush();
+ /// Note that not every wrapper require this, only those that have such warning in documentation.
+ ///
+ public override void Flush() {
+ base.Flush();
+ }
+
protected internal override bool IsWrappedObjectMustBeIndirect() {
return true;
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/layer/PdfLayer.cs b/itext/itext.kernel/itext/kernel/pdf/layer/PdfLayer.cs
index ccea712620..da581a8586 100644
--- a/itext/itext.kernel/itext/kernel/pdf/layer/PdfLayer.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/layer/PdfLayer.cs
@@ -78,7 +78,6 @@ public class PdfLayer : PdfObjectWrapper, IPdfOCG {
/// Creates a new layer by existing dictionary, which must be an indirect object.
/// the layer dictionary, must have an indirect reference.
- ///
public PdfLayer(PdfDictionary layerDictionary)
: base(layerDictionary) {
EnsureObjectIsAddedToDocument(layerDictionary);
@@ -87,7 +86,6 @@ public PdfLayer(PdfDictionary layerDictionary)
/// Creates a new layer by its name and document.
/// the layer name
/// the PdfDocument which the layer belongs to
- ///
public PdfLayer(String name, PdfDocument document)
: this(document) {
SetName(name);
@@ -224,7 +222,6 @@ public virtual void SetOnPanel(bool onPanel) {
/// resultant colletion if no intents are currently specified.
///
/// the collection of intents.
- ///
public virtual ICollection GetIntents() {
PdfObject intent = GetPdfObject().Get(PdfName.Intent);
if (intent is PdfName) {
@@ -433,7 +430,6 @@ public virtual void SetPageElement(String pe) {
/// making it indirect first if necessary.
///
/// the indirect reference to the object representing the layer
- ///
public virtual PdfIndirectReference GetIndirectReference() {
GetPdfObject().MakeIndirect(GetDocument());
return GetPdfObject().GetIndirectReference();
@@ -467,7 +463,6 @@ protected internal virtual PdfDocument GetDocument() {
/// the title of the layer
/// the document this title layer belongs to
/// the created layer
- ///
protected internal static iText.Kernel.Pdf.Layer.PdfLayer CreateTitleSilent(String title, PdfDocument document
) {
if (title == null) {
@@ -480,7 +475,6 @@ protected internal static iText.Kernel.Pdf.Layer.PdfLayer CreateTitleSilent(Stri
/// Gets the /Usage dictionary, creating a new one if necessary.
/// the /Usage dictionary
- ///
protected internal virtual PdfDictionary GetUsage() {
PdfDictionary usage = GetPdfObject().GetAsDictionary(PdfName.Usage);
if (usage == null) {
diff --git a/itext/itext.kernel/itext/kernel/pdf/layer/PdfLayerMembership.cs b/itext/itext.kernel/itext/kernel/pdf/layer/PdfLayerMembership.cs
index 43c0b310aa..cd92966ae1 100644
--- a/itext/itext.kernel/itext/kernel/pdf/layer/PdfLayerMembership.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/layer/PdfLayerMembership.cs
@@ -65,7 +65,6 @@ namespace iText.Kernel.Pdf.Layer {
///
public class PdfLayerMembership : PdfObjectWrapper, IPdfOCG {
/// Creates a new, empty membership layer.
- ///
public PdfLayerMembership(PdfDocument doc)
: base(new PdfDictionary()) {
MakeIndirect(doc);
@@ -75,7 +74,6 @@ public PdfLayerMembership(PdfDocument doc)
/// Creates a new PdfLayerMembership instance by its PdfDictionary, which must be an indirect object.
///
/// the membership dictionary, must have an indirect reference.
- ///
public PdfLayerMembership(PdfDictionary membershipDictionary)
: base(membershipDictionary) {
EnsureObjectIsAddedToDocument(membershipDictionary);
@@ -85,7 +83,6 @@ public PdfLayerMembership(PdfDictionary membershipDictionary)
}
/// Gets the collection of the layers this layer membership operates with.
- ///
public virtual ICollection GetLayers() {
PdfObject layers = GetPdfObject().Get(PdfName.OCGs);
if (layers is PdfDictionary) {
@@ -108,7 +105,6 @@ public virtual ICollection GetLayers() {
/// Adds a new layer to the current layer membership.
/// the layer to be added
- ///
public virtual void AddLayer(PdfLayer layer) {
PdfArray layers = GetPdfObject().GetAsArray(PdfName.OCGs);
if (layers == null) {
@@ -146,7 +142,6 @@ public virtual void SetVisibilityPolicy(PdfName visibilityPolicy) {
/// Gets the visibility policy for content belonging to this
/// optional content membership dictionary.
///
- ///
public virtual PdfName GetVisibilityPolicy() {
PdfName visibilityPolicy = GetPdfObject().GetAsName(PdfName.P);
if (visibilityPolicy == null || !visibilityPolicy.Equals(PdfName.AllOn) && !visibilityPolicy.Equals(PdfName
@@ -174,7 +169,6 @@ public virtual void SetVisibilityExpression(PdfVisibilityExpression visibilityEx
/// Gets the visibility expression for content belonging to this
/// optional content membership dictionary.
///
- ///
public virtual PdfVisibilityExpression GetVisibilityExpression() {
PdfArray ve = GetPdfObject().GetAsArray(PdfName.VE);
return ve != null ? new PdfVisibilityExpression(ve) : null;
diff --git a/itext/itext.kernel/itext/kernel/pdf/layer/PdfOCProperties.cs b/itext/itext.kernel/itext/kernel/pdf/layer/PdfOCProperties.cs
index ab30f8e33a..ebc2cad1ac 100644
--- a/itext/itext.kernel/itext/kernel/pdf/layer/PdfOCProperties.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/layer/PdfOCProperties.cs
@@ -66,7 +66,6 @@ public class PdfOCProperties : PdfObjectWrapper {
/// Creates a new PdfOCProperties instance.
/// the document the optional content belongs to
- ///
public PdfOCProperties(PdfDocument document)
: this(((PdfDictionary)new PdfDictionary().MakeIndirect(document))) {
}
@@ -77,7 +76,6 @@ public PdfOCProperties(PdfDocument document)
///
/// the dictionary of optional content properties, must have an indirect reference.
///
- ///
public PdfOCProperties(PdfDictionary ocPropertiesDict)
: base(ocPropertiesDict) {
EnsureObjectIsAddedToDocument(ocPropertiesDict);
@@ -254,7 +252,6 @@ private static void GetOCGOrder(PdfArray order, PdfLayer layer) {
}
/// Populates the /AS entry in the /D dictionary.
- ///
private void AddASEvent(PdfName @event, PdfName category) {
PdfArray arr = new PdfArray();
foreach (PdfLayer layer in layers) {
@@ -284,7 +281,6 @@ private void AddASEvent(PdfName @event, PdfName category) {
}
/// Reads the layers from the document to be able to modify them in the future.
- ///
private void ReadLayersFromDictionary() {
PdfArray ocgs = GetPdfObject().GetAsArray(PdfName.OCGs);
if (ocgs == null || ocgs.IsEmpty()) {
@@ -303,13 +299,15 @@ private void ReadLayersFromDictionary() {
if (d != null && !d.IsEmpty()) {
PdfArray off = d.GetAsArray(PdfName.OFF);
if (off != null) {
- foreach (PdfObject offLayer in off) {
+ for (int i = 0; i < off.Size(); i++) {
+ PdfObject offLayer = off.Get(i, false);
layerMap.Get((PdfIndirectReference)offLayer).on = false;
}
}
PdfArray locked = d.GetAsArray(PdfName.Locked);
if (locked != null) {
- foreach (PdfObject lockedLayer in locked) {
+ for (int i = 0; i < locked.Size(); i++) {
+ PdfObject lockedLayer = locked.Get(i, false);
layerMap.Get((PdfIndirectReference)lockedLayer).locked = true;
}
}
@@ -327,7 +325,6 @@ private void ReadLayersFromDictionary() {
}
/// Reads the /Order in the /D entry and initialized the parent-child hierarchy.
- ///
private void ReadOrderFromDictionary(PdfLayer parent, PdfArray orderArray, IDictionary layerMap) {
for (int i = 0; i < orderArray.Size(); i++) {
diff --git a/itext/itext.kernel/itext/kernel/pdf/layer/PdfVisibilityExpression.cs b/itext/itext.kernel/itext/kernel/pdf/layer/PdfVisibilityExpression.cs
index ccfc7cb6db..b35e880220 100644
--- a/itext/itext.kernel/itext/kernel/pdf/layer/PdfVisibilityExpression.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/layer/PdfVisibilityExpression.cs
@@ -52,7 +52,6 @@ namespace iText.Kernel.Pdf.Layer {
public class PdfVisibilityExpression : PdfObjectWrapper {
/// Constructs a new PdfVisibilityExpression instance by its raw PdfArray.
/// the array representing the visibility expression
- ///
public PdfVisibilityExpression(PdfArray visibilityExpressionArray)
: base(visibilityExpressionArray) {
PdfName @operator = visibilityExpressionArray.GetAsName(0);
diff --git a/itext/itext.kernel/itext/kernel/pdf/tagging/ParentTreeHandler.cs b/itext/itext.kernel/itext/kernel/pdf/tagging/ParentTreeHandler.cs
index 5b35d52a4b..7f96b30c96 100644
--- a/itext/itext.kernel/itext/kernel/pdf/tagging/ParentTreeHandler.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/tagging/ParentTreeHandler.cs
@@ -42,6 +42,8 @@ source product.
address: sales@itextpdf.com
*/
using System.Collections.Generic;
+using iText.IO;
+using iText.IO.Log;
using iText.Kernel;
using iText.Kernel.Pdf;
@@ -138,10 +140,16 @@ public virtual PdfDictionary BuildParentTree() {
}
public virtual void RegisterMcr(PdfMcr mcr) {
- SortedDictionary pageMcrs = pageToPageMcrs.Get(mcr.GetPageObject().GetIndirectReference());
+ PdfDictionary mcrPageObject = mcr.GetPageObject();
+ if (mcrPageObject == null || (!(mcr is PdfObjRef) && mcr.GetMcid() < 0)) {
+ ILogger logger = LoggerFactory.GetLogger(typeof(iText.Kernel.Pdf.Tagging.ParentTreeHandler));
+ logger.Error(LogMessageConstant.ENCOUNTERED_INVALID_MCR);
+ return;
+ }
+ SortedDictionary pageMcrs = pageToPageMcrs.Get(mcrPageObject.GetIndirectReference());
if (pageMcrs == null) {
pageMcrs = new SortedDictionary();
- pageToPageMcrs[mcr.GetPageObject().GetIndirectReference()] = pageMcrs;
+ pageToPageMcrs[mcrPageObject.GetIndirectReference()] = pageMcrs;
}
if (mcr is PdfObjRef) {
PdfDictionary obj = ((PdfDictionary)mcr.GetPdfObject()).GetAsDictionary(PdfName.Obj);
@@ -164,6 +172,10 @@ public virtual void RegisterMcr(PdfMcr mcr) {
public virtual void UnregisterMcr(PdfMcr mcrToUnregister) {
PdfDictionary pageDict = mcrToUnregister.GetPageObject();
+ if (pageDict == null) {
+ // invalid mcr, ignore
+ return;
+ }
if (pageDict.IsFlushed()) {
throw new PdfException(PdfException.CannotRemoveMarkedContentReferenceBecauseItsPageWasAlreadyFlushed);
}
@@ -259,6 +271,7 @@ private void UpdateStructParentTreeEntries(int? pageStructParentIndex, IDictiona
if (parentsOfPageMcrs.Size() > 0) {
parentsOfPageMcrs.MakeIndirect(structTreeRoot.GetDocument());
parentTree.AddEntry(pageStructParentIndex, parentsOfPageMcrs);
+ structTreeRoot.GetDocument().CheckIsoConformance(parentsOfPageMcrs, IsoKey.TAG_STRUCTURE_ELEMENT);
parentsOfPageMcrs.Flush();
}
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/tagging/PdfMcrDictionary.cs b/itext/itext.kernel/itext/kernel/pdf/tagging/PdfMcrDictionary.cs
index 4e2ac794af..157c1f9636 100644
--- a/itext/itext.kernel/itext/kernel/pdf/tagging/PdfMcrDictionary.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/tagging/PdfMcrDictionary.cs
@@ -58,7 +58,8 @@ public PdfMcrDictionary(PdfPage page, PdfStructElem parent)
}
public override int GetMcid() {
- return ((PdfDictionary)GetPdfObject()).GetAsNumber(PdfName.MCID).IntValue();
+ PdfNumber mcidNumber = ((PdfDictionary)GetPdfObject()).GetAsNumber(PdfName.MCID);
+ return mcidNumber != null ? mcidNumber.IntValue() : -1;
}
public override PdfDictionary GetPageObject() {
diff --git a/itext/itext.kernel/itext/kernel/pdf/tagging/PdfStructElem.cs b/itext/itext.kernel/itext/kernel/pdf/tagging/PdfStructElem.cs
index f8c19667e8..ac51ac4e1d 100644
--- a/itext/itext.kernel/itext/kernel/pdf/tagging/PdfStructElem.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/tagging/PdfStructElem.cs
@@ -144,7 +144,7 @@ public PdfStructElem(PdfDocument document, PdfName role, PdfPage page)
public PdfStructElem(PdfDocument document, PdfName role, PdfAnnotation annot)
: this(document, role) {
if (annot.GetPage() == null) {
- throw new PdfException(PdfException.AnnotShallHaveReferenceToPage);
+ throw new PdfException(PdfException.AnnotationShallHaveReferenceToPage);
}
GetPdfObject().Put(PdfName.Pg, annot.GetPage().GetPdfObject());
}
@@ -172,7 +172,6 @@ public static bool IsStructElem(PdfDictionary dictionary) {
/// The attributes dictionary will be stored inside element.
///
/// attributes dictionary.
- ///
public virtual PdfObject GetAttributes(bool createNewIfNull) {
PdfObject attributes = GetPdfObject().Get(PdfName.A);
if (attributes == null && createNewIfNull) {
@@ -369,7 +368,7 @@ public virtual iText.Kernel.Pdf.Tagging.PdfStructElem Put(PdfName key, PdfObject
}
public override void Flush() {
- //TODO log that to prevent undefined behaviour, use StructTreeRoot#flushStructElem method
+ GetDocument().CheckIsoConformance(GetPdfObject(), IsoKey.TAG_STRUCTURE_ELEMENT);
base.Flush();
}
@@ -431,9 +430,6 @@ private void AddKidObjectToStructElemList(PdfObject k, IList lis
}
private IPdfStructElem ConvertPdfObjectToIPdfStructElem(PdfObject obj) {
- if (obj.IsIndirectReference()) {
- obj = ((PdfIndirectReference)obj).GetRefersTo();
- }
IPdfStructElem elem = null;
switch (obj.GetObjectType()) {
case PdfObject.DICTIONARY: {
diff --git a/itext/itext.kernel/itext/kernel/pdf/tagging/PdfStructTreeRoot.cs b/itext/itext.kernel/itext/kernel/pdf/tagging/PdfStructTreeRoot.cs
index 46824c491d..8875b2f240 100644
--- a/itext/itext.kernel/itext/kernel/pdf/tagging/PdfStructTreeRoot.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/tagging/PdfStructTreeRoot.cs
@@ -195,7 +195,6 @@ public override void Flush() {
///
/// document to copy structure to. Shall not be current document.
/// association between original page and copied page.
- ///
public virtual void CopyTo(PdfDocument destDocument, IDictionary page2page) {
StructureTreeCopier.CopyTo(destDocument, page2page, GetDocument());
}
@@ -213,7 +212,6 @@ public virtual void CopyTo(PdfDocument destDocument, IDictionarydocument to copy structure to.
/// indicates where the structure to be inserted.
/// association between original page and copied page.
- ///
public virtual void CopyTo(PdfDocument destDocument, int insertBeforePage, IDictionary page2page
) {
StructureTreeCopier.CopyTo(destDocument, insertBeforePage, page2page, GetDocument());
diff --git a/itext/itext.kernel/itext/kernel/pdf/tagging/StructureTreeCopier.cs b/itext/itext.kernel/itext/kernel/pdf/tagging/StructureTreeCopier.cs
index e4f2334e24..f7ba4a3a72 100644
--- a/itext/itext.kernel/itext/kernel/pdf/tagging/StructureTreeCopier.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/tagging/StructureTreeCopier.cs
@@ -73,7 +73,6 @@ static StructureTreeCopier() {
///
/// document to copy structure to. Shall not be current document.
/// association between original page and copied page.
- ///
public static void CopyTo(PdfDocument destDocument, IDictionary page2page, PdfDocument callingDocument
) {
if (!destDocument.IsTagged()) {
@@ -98,7 +97,6 @@ public static void CopyTo(PdfDocument destDocument, IDictionarydocument to copy structure to.
/// indicates where the structure to be inserted.
/// association between original page and copied page.
- ///
public static void CopyTo(PdfDocument destDocument, int insertBeforePage, IDictionary page2page
, PdfDocument callingDocument) {
if (!destDocument.IsTagged()) {
@@ -161,7 +159,6 @@ public static void CopyTo(PdfDocument destDocument, int insertBeforePage, IDicti
///
/// .
///
- ///
private static void CopyTo(PdfDocument destDocument, IDictionary page2page, PdfDocument
callingDocument, bool copyFromDestDocument) {
CopyTo(destDocument, page2page, callingDocument, copyFromDestDocument, -1);
@@ -273,7 +270,7 @@ private static PdfObject CopyObjectKid(PdfObject kid, PdfDictionary copiedParent
return kid;
}
else {
- // TODO do we always copy numbers?
+ // TODO do we always copy numbers? don't we need to check if it is supposed to be copied like objs in objectsToCopy?
if (kid.IsDictionary()) {
PdfDictionary kidAsDict = (PdfDictionary)kid;
if (objectsToCopy.Contains(kidAsDict)) {
diff --git a/itext/itext.kernel/itext/kernel/pdf/tagutils/TagStructureContext.cs b/itext/itext.kernel/itext/kernel/pdf/tagutils/TagStructureContext.cs
index a5de70cce7..55c993b93c 100644
--- a/itext/itext.kernel/itext/kernel/pdf/tagutils/TagStructureContext.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/tagutils/TagStructureContext.cs
@@ -522,7 +522,7 @@ private void FlushParentIfBelongsToPage(PdfStructElem parent, PdfPage currentPag
else {
if (kid is PdfStructElem) {
// If kid is structElem and was already flushed then in kids list there will be null for it instead of
- // PdfStructElem. And therefore if we get into this if clause it means that some StructElem wasn't flushed.
+ // PdfStructElem. And therefore if we get into this if-clause it means that some StructElem wasn't flushed.
allKidsBelongToPage = false;
break;
}
diff --git a/itext/itext.kernel/itext/kernel/pdf/tagutils/TagTreePointer.cs b/itext/itext.kernel/itext/kernel/pdf/tagutils/TagTreePointer.cs
index 675ca936d6..0b03ee8d11 100644
--- a/itext/itext.kernel/itext/kernel/pdf/tagutils/TagTreePointer.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/tagutils/TagTreePointer.cs
@@ -55,6 +55,7 @@ namespace iText.Kernel.Pdf.Tagutils {
/// it's role and properties, etc. Also, using instance of this class, you can change tag position in the tag structure,
/// you can flush current tag or remove it.
///
+ ///
/// There could be any number of the instances of this class, simultaneously pointing to different (or the same) parts of
/// the tag structure. Because of this, you can for example remove the tag at which another instance is currently pointing.
/// In this case, this another instance becomes invalid, and invocation of any method on it will result in exception. To make
@@ -137,7 +138,7 @@ public TagTreePointer(iText.Kernel.Pdf.Tagutils.TagTreePointer tagPointer) {
///
public virtual iText.Kernel.Pdf.Tagutils.TagTreePointer SetPageForTagging(PdfPage page) {
if (page.IsFlushed()) {
- throw new PdfException(PdfException.PageWasAlreadyFlushed);
+ throw new PdfException(PdfException.PageAlreadyFlushed);
}
this.currentPage = page;
return this;
@@ -337,6 +338,7 @@ public virtual iText.Kernel.Pdf.Tagutils.TagTreePointer AddTag(int index, IAcces
/// TagTreePointer
/// instance would move to connected kid instead of creating tag twice.
/// But if it is added to some other parent, then connection will be removed.
+ ///
///
/// This call is equivalent of calling sequentially
///
@@ -707,6 +709,7 @@ public virtual iText.Kernel.Pdf.Tagutils.TagTreePointer MoveToKid(int n, PdfName
/// Moves this
/// TagTreePointer
/// instance to a tag, which is connected with the given accessible element.
+ ///
///
/// The connection between the tag and the accessible element instance is used as a sign that tag is not yet finished
/// and therefore should not be flushed or removed if page tags are flushed or removed. Also, any
@@ -764,6 +767,7 @@ public virtual IList GetKidsRoles() {
/// This method call moves this
/// TagTreePointer
/// to the current tag parent.
+ ///
///
/// If some of the tags to be flushed are still connected to the accessible elements, then these tags are considered
/// as not yet finished ones, and they won't be flushed immediately, but they will be flushed, when the connection
diff --git a/itext/itext.kernel/itext/kernel/pdf/xobject/PdfFormXObject.cs b/itext/itext.kernel/itext/kernel/pdf/xobject/PdfFormXObject.cs
index d85d3cabef..312da52930 100644
--- a/itext/itext.kernel/itext/kernel/pdf/xobject/PdfFormXObject.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/xobject/PdfFormXObject.cs
@@ -47,9 +47,13 @@ source product.
using iText.Kernel.Pdf.Canvas.Wmf;
namespace iText.Kernel.Pdf.Xobject {
+ /// A wrapper for Form XObject.
+ /// A wrapper for Form XObject. ISO 32000-1, 8.10 FormXObjects.
public class PdfFormXObject : PdfXObject {
private PdfResources resources = null;
+ /// Creates a new instance of Form XObject.
+ /// the form XObject’s bounding box.
public PdfFormXObject(Rectangle bBox)
: base(new PdfStream()) {
GetPdfObject().Put(PdfName.Type, PdfName.XObject);
@@ -59,8 +63,22 @@ public PdfFormXObject(Rectangle bBox)
}
}
- public PdfFormXObject(PdfStream pdfObject)
- : base(pdfObject) {
+ ///
+ /// Create
+ ///
+ /// instance by
+ ///
+ /// .
+ /// Note, this constructor doesn't perform any additional checks
+ ///
+ ///
+ ///
+ ///
+ /// with Form XObject.
+ ///
+ ///
+ public PdfFormXObject(PdfStream pdfStream)
+ : base(pdfStream) {
}
/// Creates form XObject from page content.
@@ -68,7 +86,10 @@ public PdfFormXObject(PdfStream pdfObject)
/// Creates form XObject from page content.
/// The page shall be from the document, to which FormXObject will be added.
///
- ///
+ ///
+ /// an instance of
+ ///
+ ///
public PdfFormXObject(PdfPage page)
: this(page.GetCropBox()) {
GetPdfObject().GetOutputStream().WriteBytes(page.GetContentBytes());
@@ -94,6 +115,17 @@ public PdfFormXObject(WmfImageData image, PdfDocument pdfDocument)
: this(new WmfImageHelper(image).CreatePdfForm(pdfDocument).GetPdfObject()) {
}
+ ///
+ /// Gets
+ ///
+ /// of the Form XObject.
+ /// Note, if there is no resources, a new instance will be created.
+ ///
+ ///
+ /// not null instance of
+ ///
+ /// .
+ ///
public virtual PdfResources GetResources() {
if (this.resources == null) {
PdfDictionary resourcesDict = GetPdfObject().GetAsDictionary(PdfName.Resources);
@@ -106,6 +138,83 @@ public virtual PdfResources GetResources() {
return resources;
}
+ ///
+ /// Gets Form XObject's BBox,
+ ///
+ /// key.
+ ///
+ ///
+ /// a
+ ///
+ /// , that represents
+ ///
+ /// .
+ ///
+ public virtual PdfArray GetBBox() {
+ return GetPdfObject().GetAsArray(PdfName.BBox);
+ }
+
+ ///
+ /// Sets Form XObject's BBox,
+ ///
+ /// key.
+ ///
+ ///
+ /// a
+ ///
+ /// , that represents
+ ///
+ /// .
+ ///
+ /// object itself.
+ public virtual iText.Kernel.Pdf.Xobject.PdfFormXObject SetBBox(PdfArray bBox) {
+ return Put(PdfName.BBox, bBox);
+ }
+
+ ///
+ /// Sets a group attributes dictionary indicating that the contents of the form XObject
+ /// shall be treated as a group and specifying the attributes of that group.
+ ///
+ ///
+ /// Sets a group attributes dictionary indicating that the contents of the form XObject
+ /// shall be treated as a group and specifying the attributes of that group.
+ ///
+ /// key.
+ ///
+ ///
+ /// instance of
+ ///
+ /// .
+ ///
+ /// object itself.
+ ///
+ public virtual iText.Kernel.Pdf.Xobject.PdfFormXObject SetGroup(PdfTransparencyGroup transparency) {
+ return Put(PdfName.Group, transparency.GetPdfObject());
+ }
+
+ /// Gets width based on XObject's BBox.
+ /// float value.
+ public override float GetWidth() {
+ return GetBBox() == null ? 0 : GetBBox().GetAsNumber(2).FloatValue();
+ }
+
+ /// Gets height based on XObject's BBox.
+ /// float value.
+ public override float GetHeight() {
+ return GetBBox() == null ? 0 : GetBBox().GetAsNumber(3).FloatValue();
+ }
+
+ ///
+ /// To manually flush a
+ /// PdfObject
+ /// behind this wrapper, you have to ensure
+ /// that this object is added to the document, i.e. it has an indirect reference.
+ /// Basically this means that before flushing you need to explicitly call
+ ///
+ /// .
+ /// For example: wrapperInstance.makeIndirect(document).flush();
+ /// Note that not every wrapper require this, only those that have such warning in documentation.
+ ///
public override void Flush() {
resources = null;
if (GetPdfObject().Get(PdfName.BBox) == null) {
@@ -114,68 +223,182 @@ public override void Flush() {
base.Flush();
}
- //Additional entries in form dictionary for Trap Network annotation
+ //-----Additional entries in form dictionary for Trap Network annotation
+ ///
+ /// Sets process color model for trap network appearance,
+ ///
+ /// key.
+ ///
+ ///
+ /// shall be one of the valid values:
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ /// , and
+ ///
+ /// .
+ ///
+ /// object itself.
public virtual iText.Kernel.Pdf.Xobject.PdfFormXObject SetProcessColorModel(PdfName model) {
return Put(PdfName.PCM, model);
}
+ ///
+ /// Gets process color model of trap network appearance,
+ ///
+ /// key.
+ ///
+ ///
+ /// a
+ ///
+ /// instance, possible values:
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ /// , and
+ ///
+ /// .
+ ///
public virtual PdfName GetProcessColorModel() {
return GetPdfObject().GetAsName(PdfName.PCM);
}
+ ///
+ /// Sets separation color names for the trap network appearance,
+ ///
+ /// key.
+ ///
+ ///
+ /// an array of names identifying the colorants that were assumed
+ /// when the trap network appearance was created.
+ ///
+ /// object itself.
public virtual iText.Kernel.Pdf.Xobject.PdfFormXObject SetSeparationColorNames(PdfArray colorNames) {
return Put(PdfName.SeparationColorNames, colorNames);
}
+ ///
+ /// Gets separation color names of trap network appearance,
+ ///
+ /// key.
+ ///
+ ///
+ /// an
+ ///
+ /// of names identifying the colorants.
+ ///
public virtual PdfArray GetSeparationColorNames() {
return GetPdfObject().GetAsArray(PdfName.SeparationColorNames);
}
+ ///
+ /// Sets an array of TrapRegion objects defining the page’s trapping zones
+ /// and the associated trapping parameters, as described in Adobe Technical Note #5620,
+ /// Portable Job Ticket Format.
+ ///
+ ///
+ /// Sets an array of TrapRegion objects defining the page’s trapping zones
+ /// and the associated trapping parameters, as described in Adobe Technical Note #5620,
+ /// Portable Job Ticket Format.
+ ///
+ /// key.
+ ///
+ ///
+ /// A
+ ///
+ /// of indirect references to TrapRegion objects.
+ ///
+ /// object itself.
public virtual iText.Kernel.Pdf.Xobject.PdfFormXObject SetTrapRegions(PdfArray regions) {
return Put(PdfName.TrapRegions, regions);
}
+ ///
+ /// Gets an array of TrapRegion objects defining the page’s trapping zones
+ /// and the associated trapping parameters, as described in Adobe Technical Note #5620,
+ /// Portable Job Ticket Format.
+ ///
+ ///
+ /// Gets an array of TrapRegion objects defining the page’s trapping zones
+ /// and the associated trapping parameters, as described in Adobe Technical Note #5620,
+ /// Portable Job Ticket Format.
+ ///
+ /// key.
+ ///
+ ///
+ /// A
+ ///
+ /// of indirect references to TrapRegion objects.
+ ///
public virtual PdfArray GetTrapRegions() {
return GetPdfObject().GetAsArray(PdfName.TrapRegions);
}
+ /// Sets a human-readable text string that described this trap network to the user.
+ ///
+ /// Sets a human-readable text string that described this trap network to the user.
+ ///
+ /// key.
+ ///
+ ///
+ /// a
+ ///
+ /// value.
+ ///
+ /// object itself.
public virtual iText.Kernel.Pdf.Xobject.PdfFormXObject SetTrapStyles(PdfString trapStyles) {
return Put(PdfName.TrapStyles, trapStyles);
}
+ /// Gets a human-readable text string that described this trap network to the user.
+ ///
+ /// Gets a human-readable text string that described this trap network to the user.
+ ///
+ /// key.
+ ///
+ ///
+ /// a
+ ///
+ /// value.
+ ///
public virtual PdfString GetTrapStyles() {
return GetPdfObject().GetAsString(PdfName.TrapStyles);
}
- //Additional entries in form dictionary for Printer Mark annotation
+ //-----Additional entries in form dictionary for Printer Mark annotation
+ /// Sets a text string representing the printer’s mark in human-readable form.
+ /// a string value.
+ /// object itself.
public virtual iText.Kernel.Pdf.Xobject.PdfFormXObject SetMarkStyle(PdfString markStyle) {
return Put(PdfName.MarkStyle, markStyle);
}
+ /// Gets a text string representing the printer’s mark in human-readable form.
+ /// a string value.
public virtual PdfString GetMarkStyle() {
return GetPdfObject().GetAsString(PdfName.MarkStyle);
}
- public virtual PdfArray GetBBox() {
- return GetPdfObject().GetAsArray(PdfName.BBox);
- }
-
- public virtual iText.Kernel.Pdf.Xobject.PdfFormXObject SetBBox(PdfArray bBox) {
- return Put(PdfName.BBox, bBox);
- }
-
- public virtual iText.Kernel.Pdf.Xobject.PdfFormXObject SetGroup(PdfTransparencyGroup transparency) {
- return Put(PdfName.Group, transparency.GetPdfObject());
- }
-
- public override float GetWidth() {
- return GetBBox() == null ? 0 : GetBBox().GetAsNumber(2).FloatValue();
- }
-
- public override float GetHeight() {
- return GetBBox() == null ? 0 : GetBBox().GetAsNumber(3).FloatValue();
- }
-
+ /// Puts the value into Image XObject dictionary and associates it with the specified key.
+ ///
+ /// Puts the value into Image XObject dictionary and associates it with the specified key.
+ /// If the key is already present, it will override the old value with the specified one.
+ ///
+ /// key to insert or to override
+ /// the value to associate with the specified key
+ /// object itself.
public virtual iText.Kernel.Pdf.Xobject.PdfFormXObject Put(PdfName key, PdfObject value) {
GetPdfObject().Put(key, value);
return this;
diff --git a/itext/itext.kernel/itext/kernel/pdf/xobject/PdfImageXObject.cs b/itext/itext.kernel/itext/kernel/pdf/xobject/PdfImageXObject.cs
index 9b7227cc0b..8615e492bd 100644
--- a/itext/itext.kernel/itext/kernel/pdf/xobject/PdfImageXObject.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/xobject/PdfImageXObject.cs
@@ -52,6 +52,8 @@ source product.
using iText.Kernel.Pdf.Filters;
namespace iText.Kernel.Pdf.Xobject {
+ /// A wrapper for Image XObject.
+ /// A wrapper for Image XObject. ISO 32000-1, 8.9 Images.
public class PdfImageXObject : PdfXObject {
private float width;
@@ -73,20 +75,57 @@ public class PdfImageXObject : PdfXObject {
private int stride;
+ /// Creates Image XObject by image.
+ ///
+ ///
+ ///
+ /// with actual image data.
+ ///
public PdfImageXObject(ImageData image)
: this(image, null) {
}
+ /// Creates Image XObject by image.
+ ///
+ ///
+ ///
+ /// with actual image data.
+ ///
+ ///
+ ///
+ ///
+ /// with image mask.
+ ///
public PdfImageXObject(ImageData image, iText.Kernel.Pdf.Xobject.PdfImageXObject imageMask)
: this(CreatePdfStream(CheckImageType(image), imageMask)) {
mask = image.IsMask();
softMask = image.IsSoftMask();
}
- public PdfImageXObject(PdfStream pdfObject)
- : base(pdfObject) {
+ ///
+ /// Create
+ ///
+ /// instance by
+ ///
+ /// .
+ /// Note, this constructor doesn't perform any additional checks
+ ///
+ ///
+ ///
+ ///
+ /// with Image XObject.
+ ///
+ ///
+ public PdfImageXObject(PdfStream pdfStream)
+ : base(pdfStream) {
}
+ ///
+ /// Gets width of image,
+ /// Width
+ /// key.
+ ///
+ /// float value.
public override float GetWidth() {
if (!IsFlushed()) {
return GetPdfObject().GetAsNumber(PdfName.Width).FloatValue();
@@ -96,6 +135,12 @@ public override float GetWidth() {
}
}
+ ///
+ /// Gets height of image,
+ /// Height
+ /// key.
+ ///
+ /// float value.
public override float GetHeight() {
if (!IsFlushed()) {
return GetPdfObject().GetAsNumber(PdfName.Height).FloatValue();
@@ -105,6 +150,17 @@ public override float GetHeight() {
}
}
+ ///
+ /// To manually flush a
+ /// PdfObject
+ /// behind this wrapper, you have to ensure
+ /// that this object is added to the document, i.e. it has an indirect reference.
+ /// Basically this means that before flushing you need to explicitly call
+ ///
+ /// .
+ /// For example: wrapperInstance.makeIndirect(document).flush();
+ /// Note, that not every wrapper require this, only those that have such warning in documentation.
+ ///
public override void Flush() {
if (!IsFlushed()) {
width = GetPdfObject().GetAsNumber(PdfName.Width).FloatValue();
@@ -113,6 +169,13 @@ public override void Flush() {
}
}
+ /// Copy Image XObject to the specified document.
+ /// target document
+ ///
+ /// just created instance of
+ ///
+ /// .
+ ///
public virtual iText.Kernel.Pdf.Xobject.PdfImageXObject CopyTo(PdfDocument document) {
iText.Kernel.Pdf.Xobject.PdfImageXObject image = new iText.Kernel.Pdf.Xobject.PdfImageXObject(((PdfStream)
GetPdfObject().CopyTo(document)));
@@ -123,10 +186,29 @@ public virtual iText.Kernel.Pdf.Xobject.PdfImageXObject CopyTo(PdfDocument docum
return image;
}
+ /// Gets decoded image bytes.
+ /// byte array.
public virtual byte[] GetImageBytes() {
return GetImageBytes(true);
}
+ /// Gets image bytes.
+ ///
+ /// Gets image bytes.
+ /// Note,
+ ///
+ /// ,
+ ///
+ /// and
+ ///
+ /// filters will be ignored.
+ ///
+ ///
+ /// if
+ ///
+ /// , decodes stream bytes.
+ ///
+ /// byte array.
public virtual byte[] GetImageBytes(bool decoded) {
byte[] bytes;
bytes = GetPdfObject().GetBytes(false);
@@ -150,11 +232,126 @@ public virtual byte[] GetImageBytes(bool decoded) {
return bytes;
}
+ ///
+ /// Identifies the type of the image that is stored in the bytes of this
+ ///
+ /// .
+ /// Note that this has nothing to do with the original type of the image. For instance, the return value
+ /// of this method will never be
+ ///
+ /// as we loose this information when converting a
+ /// PNG image into something that can be put into a PDF file.
+ /// The possible values are:
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ /// ,
+ ///
+ ///
+ /// the identified type of image
+ public virtual ImageType IdentifyImageType() {
+ PdfObject filter = GetPdfObject().Get(PdfName.Filter);
+ PdfArray filters = new PdfArray();
+ if (filter != null) {
+ if (filter.GetObjectType() == PdfObject.NAME) {
+ filters.Add(filter);
+ }
+ else {
+ if (filter.GetObjectType() == PdfObject.ARRAY) {
+ filters = ((PdfArray)filter);
+ }
+ }
+ }
+ for (int i = filters.Size() - 1; i >= 0; i--) {
+ PdfName filterName = (PdfName)filters.Get(i);
+ if (PdfName.DCTDecode.Equals(filterName)) {
+ return ImageType.JPEG;
+ }
+ else {
+ if (PdfName.JBIG2Decode.Equals(filterName)) {
+ return ImageType.JBIG2;
+ }
+ else {
+ if (PdfName.JPXDecode.Equals(filterName)) {
+ return ImageType.JPEG2000;
+ }
+ }
+ }
+ }
+ // None of the previous types match
+ PdfObject colorspace = GetPdfObject().Get(PdfName.ColorSpace);
+ PrepareAndFindColorspace(colorspace);
+ if (pngColorType < 0) {
+ return ImageType.TIFF;
+ }
+ else {
+ return ImageType.PNG;
+ }
+ }
+
+ ///
+ /// Identifies recommended file extension to store the bytes of this
+ ///
+ /// .
+ /// Possible values are: 'png', 'jpg', 'jp2', 'tif', 'jbig2'.
+ /// This extension can later be used together with the result of
+ ///
+ /// .
+ ///
+ ///
+ /// a
+ ///
+ /// with recommended file extension
+ ///
+ ///
+ public virtual String IdentifyImageFileExtension() {
+ ImageType bytesType = IdentifyImageType();
+ switch (bytesType) {
+ case ImageType.PNG: {
+ return "png";
+ }
+
+ case ImageType.JPEG: {
+ return "jpg";
+ }
+
+ case ImageType.JPEG2000: {
+ return "jp2";
+ }
+
+ case ImageType.TIFF: {
+ return "tif";
+ }
+
+ case ImageType.JBIG2: {
+ return "jbig2";
+ }
+
+ default: {
+ throw new InvalidOperationException("Should have never happened. This type of image is not allowed for ImageXObject"
+ );
+ }
+ }
+ }
+
+ /// Puts the value into Image XObject dictionary and associates it with the specified key.
+ ///
+ /// Puts the value into Image XObject dictionary and associates it with the specified key.
+ /// If the key is already present, it will override the old value with the specified one.
+ ///
+ /// key to insert or to override
+ /// the value to associate with the specified key
+ /// object itself.
public virtual iText.Kernel.Pdf.Xobject.PdfImageXObject Put(PdfName key, PdfObject value) {
GetPdfObject().Put(key, value);
return this;
}
+ [Obsolete]
protected internal static PdfStream CreatePdfStream(ImageData image, iText.Kernel.Pdf.Xobject.PdfImageXObject
imageMask) {
PdfStream stream;
@@ -336,8 +533,13 @@ private static PdfArray CreateArray(PdfStream stream, Object[] objects) {
array.Add(new PdfNumber((float)obj));
}
else {
- //TODO instance of was removed due to autoport
- array.Add(CreateDictionaryFromMap(stream, (IDictionary)obj));
+ if (obj is Object[]) {
+ array.Add(CreateArray(stream, (Object[])obj));
+ }
+ else {
+ //TODO instance of was removed due to autoport
+ array.Add(CreateDictionaryFromMap(stream, (IDictionary)obj));
+ }
}
}
}
@@ -345,19 +547,22 @@ private static PdfArray CreateArray(PdfStream stream, Object[] objects) {
return array;
}
- ///
- private byte[] DecodeTiffAndPngBytes(byte[] imageBytes) {
+ private void PrepareAndFindColorspace(PdfObject colorspace) {
pngColorType = -1;
- PdfArray decode = GetPdfObject().GetAsArray(PdfName.Decode);
width = GetPdfObject().GetAsNumber(PdfName.Width).IntValue();
height = GetPdfObject().GetAsNumber(PdfName.Height).IntValue();
bpc = GetPdfObject().GetAsNumber(PdfName.BitsPerComponent).IntValue();
pngBitDepth = bpc;
- PdfObject colorspace = GetPdfObject().Get(PdfName.ColorSpace);
palette = null;
icc = null;
stride = 0;
FindColorspace(colorspace, true);
+ }
+
+ ///
+ private byte[] DecodeTiffAndPngBytes(byte[] imageBytes) {
+ PdfObject colorspace = GetPdfObject().Get(PdfName.ColorSpace);
+ PrepareAndFindColorspace(colorspace);
MemoryStream ms = new MemoryStream();
if (pngColorType < 0) {
if (bpc != 8) {
@@ -413,6 +618,7 @@ private byte[] DecodeTiffAndPngBytes(byte[] imageBytes) {
}
else {
PngWriter png = new PngWriter(ms);
+ PdfArray decode = GetPdfObject().GetAsArray(PdfName.Decode);
if (decode != null) {
if (pngBitDepth == 1) {
// if the decode array is 1,0, then we need to invert the image
diff --git a/itext/itext.kernel/itext/kernel/pdf/xobject/PdfXObject.cs b/itext/itext.kernel/itext/kernel/pdf/xobject/PdfXObject.cs
index 1bb90160fc..5a7b4c5df0 100644
--- a/itext/itext.kernel/itext/kernel/pdf/xobject/PdfXObject.cs
+++ b/itext/itext.kernel/itext/kernel/pdf/xobject/PdfXObject.cs
@@ -42,42 +42,84 @@ source product.
address: sales@itextpdf.com
*/
using System;
+using iText.Kernel;
using iText.Kernel.Pdf;
using iText.Kernel.Pdf.Layer;
namespace iText.Kernel.Pdf.Xobject {
+ /// An abstract wrapper for supported types of XObject.
+ ///
+ ///
public class PdfXObject : PdfObjectWrapper {
+ [Obsolete]
public PdfXObject()
: this(new PdfStream()) {
}
+ [Obsolete]
public PdfXObject(PdfStream pdfObject)
: base(pdfObject) {
}
+ ///
+ /// Create
+ ///
+ /// or
+ ///
+ /// by
+ ///
+ /// .
+ ///
+ ///
+ ///
+ ///
+ /// with either
+ ///
+ /// or
+ ///
+ ///
+ ///
+ ///
+ ///
+ /// either
+ ///
+ /// or
+ ///
+ /// .
+ ///
public static iText.Kernel.Pdf.Xobject.PdfXObject MakeXObject(PdfStream stream) {
- if (PdfName.Form.Equals(stream.GetAsName(PdfName.Subtype)) || stream.ContainsKey(PdfName.BBox)) {
+ if (PdfName.Form.Equals(stream.GetAsName(PdfName.Subtype))) {
return new PdfFormXObject(stream);
}
else {
- return new PdfImageXObject(stream);
+ if (PdfName.Image.Equals(stream.GetAsName(PdfName.Subtype))) {
+ return new PdfImageXObject(stream);
+ }
+ else {
+ throw new NotSupportedException(PdfException.UnsupportedXObjectType);
+ }
}
}
/// Sets the layer this XObject belongs to.
- /// the layer this XObject belongs to
+ /// the layer this XObject belongs to.
public virtual void SetLayer(IPdfOCG layer) {
GetPdfObject().Put(PdfName.OC, layer.GetIndirectReference());
}
+ /// Gets width of XObject.
+ /// float value.
public virtual float GetWidth() {
throw new NotSupportedException();
}
+ /// Gets height of XObject.
+ /// float value.
public virtual float GetHeight() {
throw new NotSupportedException();
}
+ ///
protected internal override bool IsWrappedObjectMustBeIndirect() {
return true;
}
diff --git a/itext/itext.kernel/itext/kernel/utils/CompareTool.cs b/itext/itext.kernel/itext/kernel/utils/CompareTool.cs
index f5023659a1..9fb4caed73 100644
--- a/itext/itext.kernel/itext/kernel/utils/CompareTool.cs
+++ b/itext/itext.kernel/itext/kernel/utils/CompareTool.cs
@@ -41,2165 +41,2312 @@ source product.
For more information, please contact iText Software Corp. at this
address: sales@itextpdf.com
*/
-
using System;
using System.Collections;
using System.Collections.Generic;
-using System.Diagnostics;
using System.IO;
-using System.Linq;
using System.Text;
using System.Xml;
-using System.Xml.Linq;
using iText.IO.Font;
-using iText.IO.Source;
using iText.IO.Util;
using iText.Kernel.Geom;
using iText.Kernel.Pdf;
using iText.Kernel.Pdf.Annot;
+using iText.Kernel.Pdf.Canvas;
using iText.Kernel.XMP;
using iText.Kernel.XMP.Options;
-using Path = System.IO.Path;
-namespace iText.Kernel.Utils
-{
- public class CompareTool
- {
- private const String cannotOpenOutputDirectory = "Cannot open output directory for .";
+namespace iText.Kernel.Utils {
+ ///
+ /// This class provides means to compare two PDF files both by content and visually
+ /// and gives the report of their differences.
+ ///
+ ///
+ /// This class provides means to compare two PDF files both by content and visually
+ /// and gives the report of their differences.
+ ///
+ /// For visual comparison it uses external tools: Ghostscript and ImageMagick, which
+ /// should be installed on your machine. To allow CompareTool to use them, you need
+ /// to pass either java properties or environment variables with names "gsExec" and
+ /// "compareExec", which would contain the paths to the executables of correspondingly
+ /// Ghostscript and ImageMagick tools.
+ ///
+ /// CompareTool class was mainly designed for the testing purposes of iText in order to
+ /// ensure that the same code produces the same PDF document. For this reason you will
+ /// often encounter such parameter names as "outDoc" and "cmpDoc" which stand for output
+ /// document and document-for-comparison. The first one is viewed as the current result,
+ /// and the second one is referred as normal or ideal result. OutDoc is compared to the
+ /// ideal cmpDoc. Therefore all reports of the comparison are in the form: "Expected ...,
+ /// but was ...". This should be interpreted in the following way: "expected" part stands
+ /// for the content of the cmpDoc and "but was" part stands for the content of the outDoc.
+ ///
+ public class CompareTool {
+ private const String cannotOpenOutputDirectory = "Cannot open output directory for .";
+
+ private const String gsFailed = "GhostScript failed for .";
+
+ private const String unexpectedNumberOfPages = "Unexpected number of pages for .";
+
+ private const String differentPages = "File differs on page .";
+
+ private const String undefinedGsPath = "Path to GhostScript is not specified. Please use -DgsExec= (e.g. -DgsExec=\"C:/Program Files/gs/gs9.14/bin/gswin32c.exe\")";
+
+ private const String ignoredAreasPrefix = "ignored_areas_";
+
+ private const String gsParams = " -dNOPAUSE -dBATCH -sDEVICE=png16m -r150 -sOutputFile= ";
+
+ private const String compareParams = " \"\" \"\" \"\"";
+
+ private String gsExec;
+
+ private String compareExec;
+
+ private String cmpPdf;
+
+ private String cmpPdfName;
+
+ private String cmpImage;
+
+ private String outPdf;
+
+ private String outPdfName;
+
+ private String outImage;
+
+ private ReaderProperties outProps;
+
+ private ReaderProperties cmpProps;
+
+ private IList outPagesRef;
+
+ private IList cmpPagesRef;
+
+ private int compareByContentErrorsLimit = 1;
+
+ private bool generateCompareByContentXmlReport = false;
+
+ private bool encryptionCompareEnabled = false;
+
+ private bool useCachedPagesForComparison = true;
+
+ /// Creates an instance of the CompareTool.
+ public CompareTool() {
+ gsExec = iText.IO.Util.SystemUtil.GetEnvironmentVariable("gsExec");
+ compareExec = iText.IO.Util.SystemUtil.GetEnvironmentVariable("compareExec");
+ }
+
+ ///
+ /// Compares two PDF documents by content starting from Catalog dictionary and then recursively comparing
+ /// corresponding objects which are referenced from it.
+ ///
+ ///
+ /// Compares two PDF documents by content starting from Catalog dictionary and then recursively comparing
+ /// corresponding objects which are referenced from it. You can roughly imagine it as depth-first traversal
+ /// of the two trees that represent pdf objects structure of the documents.
+ ///
+ /// The main difference between this method and the
+ ///
+ /// methods is the return value. This method returns a
+ ///
+ /// class instance, which could be used
+ /// in code, however compareByContent methods in case of the differences simply return String value, which could
+ /// only be printed. Also, keep in mind that this method doesn't perform visual comparison of the documents.
+ ///
+ /// For more explanations about what is outDoc and cmpDoc see last paragraph of the
+ ///
+ /// class description.
+ ///
+ /// the absolute path to the output file, which is to be compared to cmp-file.
+ /// the absolute path to the cmp-file, which is to be compared to output file.
+ ///
+ /// the report of comparison of two files in the form of the custom class instance.
+ /// See
+ ///
+ /// for more info.
+ ///
+ ///
+ public virtual CompareTool.CompareResult CompareByCatalog(PdfDocument outDocument, PdfDocument cmpDocument
+ ) {
+ CompareTool.CompareResult compareResult = null;
+ compareResult = new CompareTool.CompareResult(this, compareByContentErrorsLimit);
+ CompareTool.ObjectPath catalogPath = new CompareTool.ObjectPath(cmpDocument.GetCatalog().GetPdfObject().GetIndirectReference
+ (), outDocument.GetCatalog().GetPdfObject().GetIndirectReference());
+ ICollection ignoredCatalogEntries = new LinkedHashSet(iText.IO.Util.JavaUtil.ArraysAsList
+ (PdfName.Metadata));
+ CompareDictionariesExtended(outDocument.GetCatalog().GetPdfObject(), cmpDocument.GetCatalog().GetPdfObject
+ (), catalogPath, compareResult, ignoredCatalogEntries);
+ return compareResult;
+ }
+
+ /// Disables the default logic of pages comparison.
+ ///
+ /// Disables the default logic of pages comparison.
+ /// This option makes sense only for
+ ///
+ /// method.
+ ///
+ /// By default, pages are treated as special objects and if they are met in the process of comparison, then they are
+ /// not checked as objects, but rather simply checked that they has same page numbers in both documents.
+ /// This behaviour is intended for the
+ ///
+ /// set of methods, because in them documents are compared in page by page basis. Thus, we don't need to check if pages
+ /// are of the same content when they are met in comparison process, we are sure that we will compare their content or
+ /// we have already compared them.
+ ///
+ /// However, if you would use
+ ///
+ /// with default behaviour
+ /// of pages comparison, pages won't be checked at all, every time when reference to the page dictionary is met,
+ /// only page numbers will be compared for both documents. You can say that in this case, comparison will be performed
+ /// for all document's catalog entries except /Pages (However in fact, document's page tree structures will be compared,
+ /// but pages themselves - won't).
+ ///
+ ///
+ /// this
+ ///
+ /// instance.
+ ///
+ public virtual iText.Kernel.Utils.CompareTool DisableCachedPagesComparison() {
+ this.useCachedPagesForComparison = false;
+ return this;
+ }
+
+ /// Sets the maximum errors count which will be returned as the result of the comparison.
+ /// the errors count.
+ /// this CompareTool instance.
+ public virtual iText.Kernel.Utils.CompareTool SetCompareByContentErrorsLimit(int compareByContentMaxErrorCount
+ ) {
+ this.compareByContentErrorsLimit = compareByContentMaxErrorCount;
+ return this;
+ }
+
+ /// Enables or disables the generation of the comparison report in the form of the xml document.
+ ///
+ /// Enables or disables the generation of the comparison report in the form of the xml document.
+ ///
+ /// IMPORTANT NOTE: this flag affect only the comparison made by compareByContent methods!
+ ///
+ /// true to enable xml report generation, false - to disable.
+ /// this CompareTool instance.
+ public virtual iText.Kernel.Utils.CompareTool SetGenerateCompareByContentXmlReport(bool generateCompareByContentXmlReport
+ ) {
+ this.generateCompareByContentXmlReport = generateCompareByContentXmlReport;
+ return this;
+ }
+
+ /// Enables the comparison of the encryption properties of the documents.
+ ///
+ /// Enables the comparison of the encryption properties of the documents. Encryption properties comparison
+ /// results are returned along with all other comparison results.
+ ///
+ /// IMPORTANT NOTE: this flag affect only the comparison made by compareByContent methods!
+ ///
+ /// this CompareTool instance.
+ public virtual iText.Kernel.Utils.CompareTool EnableEncryptionCompare() {
+ this.encryptionCompareEnabled = true;
+ return this;
+ }
+
+ /// Documents for comparison are opened in reader mode.
+ ///
+ /// Documents for comparison are opened in reader mode. This method is intended to alter
+ ///
+ /// which are used to open output document. This is particularly useful for comparison of encrypted documents.
+ ///
+ /// For more explanations about what is outDoc and cmpDoc see last paragraph of the
+ ///
+ /// class description.
+ ///
+ ///
+ ///
+ ///
+ /// instance which will be later passed to the output document
+ ///
+ /// .
+ ///
+ public virtual ReaderProperties GetOutReaderProperties() {
+ if (outProps == null) {
+ outProps = new ReaderProperties();
+ }
+ return outProps;
+ }
+
+ /// Documents for comparison are opened in reader mode.
+ ///
+ /// Documents for comparison are opened in reader mode. This method is intended to alter
+ ///
+ /// which are used to open cmp document. This is particularly useful for comparison of encrypted documents.
+ ///
+ /// For more explanations about what is outDoc and cmpDoc see last paragraph of the
+ ///
+ /// class description.
+ ///
+ ///
+ ///
+ ///
+ /// instance which will be later passed to the cmp document
+ ///
+ /// .
+ ///
+ public virtual ReaderProperties GetCmpReaderProperties() {
+ if (cmpProps == null) {
+ cmpProps = new ReaderProperties();
+ }
+ return cmpProps;
+ }
+
+ /// Compares two documents visually.
+ ///
+ /// Compares two documents visually. For the comparison two external tools are used: Ghostscript and ImageMagick.
+ /// For more info about needed configuration for visual comparison process see
+ ///
+ /// class description.
+ ///
+ /// During comparison for every page of two documents an image file will be created in the folder specified by
+ /// outPath absolute path. Then those page images will be compared and if there are any differences for some pages,
+ /// another image file will be created with marked differences on it.
+ ///
+ /// the absolute path to the output file, which is to be compared to cmp-file.
+ /// the absolute path to the cmp-file, which is to be compared to output file.
+ /// the absolute path to the folder, which will be used to store image files for visual comparison.
+ ///
+ /// file name prefix for image files with marked differences if there is any.
+ ///
+ /// string containing list of the pages that are visually different, or null if there are no visual differences.
+ ///
+ ///
+ ///
+ public virtual String CompareVisually(String outPdf, String cmpPdf, String outPath, String differenceImagePrefix
+ ) {
+ return CompareVisually(outPdf, cmpPdf, outPath, differenceImagePrefix, null);
+ }
+
+ /// Compares two documents visually.
+ ///
+ /// Compares two documents visually. For the comparison two external tools are used: Ghostscript and ImageMagick.
+ /// For more info about needed configuration for visual comparison process see
+ ///
+ /// class description.
+ ///
+ /// During comparison for every page of two documents an image file will be created in the folder specified by
+ /// outPath absolute path. Then those page images will be compared and if there are any differences for some pages,
+ /// another image file will be created with marked differences on it.
+ ///
+ /// It is possible to ignore certain areas of the document pages during visual comparison. This is useful for example
+ /// in case if documents should be the same except certain page area with date on it. In this case, in the folder
+ /// specified by the outPath, new pdf documents will be created with the black rectangles at the specified ignored
+ /// areas, and visual comparison will be performed on these new documents.
+ ///
+ /// the absolute path to the output file, which is to be compared to cmp-file.
+ /// the absolute path to the cmp-file, which is to be compared to output file.
+ /// the absolute path to the folder, which will be used to store image files for visual comparison.
+ ///
+ /// file name prefix for image files with marked differences if there is any.
+ ///
+ /// a map with one-based page numbers as keys and lists of ignored rectangles as values.
+ ///
+ /// string containing list of the pages that are visually different, or null if there are no visual differences.
+ ///
+ ///
+ ///
+ public virtual String CompareVisually(String outPdf, String cmpPdf, String outPath, String differenceImagePrefix
+ , IDictionary> ignoredAreas) {
+ Init(outPdf, cmpPdf);
+ return CompareVisually(outPath, differenceImagePrefix, ignoredAreas);
+ }
+
+ ///
+ /// Compares two PDF documents by content starting from page dictionaries and then recursively comparing
+ /// corresponding objects which are referenced from them.
+ ///
+ ///
+ /// Compares two PDF documents by content starting from page dictionaries and then recursively comparing
+ /// corresponding objects which are referenced from them. You can roughly imagine it as depth-first traversal
+ /// of the two trees that represent pdf objects structure of the documents.
+ ///
+ /// Unlike
+ ///
+ /// this method performs content comparison page by page
+ /// and doesn't compare the tag structure, acroforms and all other things that doesn't belong to specific pages.
+ ///
+ /// When comparison by content is finished, if any differences were found, visual comparison is automatically started.
+ /// For more info see
+ ///
+ /// .
+ ///
+ /// For more explanations about what is outPdf and cmpPdf see last paragraph of the
+ ///
+ /// class description.
+ ///
+ /// the absolute path to the output file, which is to be compared to cmp-file.
+ /// the absolute path to the cmp-file, which is to be compared to output file.
+ /// the absolute path to the folder, which will be used to store image files for visual comparison.
+ ///
+ /// file name prefix for image files with marked visual differences if there is any.
+ ///
+ ///
+ /// string containing text report of the encountered content differences and also list of the pages that are
+ /// visually different, or null if there are no content and therefore no visual differences.
+ ///
+ ///
+ ///
+ public virtual String CompareByContent(String outPdf, String cmpPdf, String outPath, String differenceImagePrefix
+ ) {
+ return CompareByContent(outPdf, cmpPdf, outPath, differenceImagePrefix, null, null, null);
+ }
+
+ /// This method overload is used to compare two encrypted PDF documents.
+ ///
+ /// This method overload is used to compare two encrypted PDF documents. Document passwords are passed with
+ /// outPass and cmpPass parameters.
+ ///
+ /// Compares two PDF documents by content starting from page dictionaries and then recursively comparing
+ /// corresponding objects which are referenced from them. You can roughly imagine it as depth-first traversal
+ /// of the two trees that represent pdf objects structure of the documents.
+ ///
+ /// Unlike
+ ///
+ /// this method performs content comparison page by page
+ /// and doesn't compare the tag structure, acroforms and all other things that doesn't belong to specific pages.
+ ///
+ /// When comparison by content is finished, if any differences were found, visual comparison is automatically started.
+ /// For more info see
+ ///
+ /// .
+ ///
+ /// For more explanations about what is outPdf and cmpPdf see last paragraph of the
+ ///
+ /// class description.
+ ///
+ /// the absolute path to the output file, which is to be compared to cmp-file.
+ /// the absolute path to the cmp-file, which is to be compared to output file.
+ /// the absolute path to the folder, which will be used to store image files for visual comparison.
+ ///
+ /// file name prefix for image files with marked visual differences if there is any.
+ ///
+ /// password for the encrypted document specified by the outPdf absolute path.
+ /// password for the encrypted document specified by the cmpPdf absolute path.
+ ///
+ /// string containing text report of the encountered content differences and also list of the pages that are
+ /// visually different, or null if there are no content and therefore no visual differences.
+ ///
+ ///
+ ///
+ public virtual String CompareByContent(String outPdf, String cmpPdf, String outPath, String differenceImagePrefix
+ , byte[] outPass, byte[] cmpPass) {
+ return CompareByContent(outPdf, cmpPdf, outPath, differenceImagePrefix, null, outPass, cmpPass);
+ }
+
+ ///
+ /// Compares two PDF documents by content starting from page dictionaries and then recursively comparing
+ /// corresponding objects which are referenced from them.
+ ///
+ ///
+ /// Compares two PDF documents by content starting from page dictionaries and then recursively comparing
+ /// corresponding objects which are referenced from them. You can roughly imagine it as depth-first traversal
+ /// of the two trees that represent pdf objects structure of the documents.
+ ///
+ /// Unlike
+ ///
+ /// this method performs content comparison page by page
+ /// and doesn't compare the tag structure, acroforms and all other things that doesn't belong to specific pages.
+ ///
+ /// When comparison by content is finished, if any differences were found, visual comparison is automatically started.
+ /// For more info see
+ ///
+ /// .
+ ///
+ /// For more explanations about what is outPdf and cmpPdf see last paragraph of the
+ ///
+ /// class description.
+ ///
+ /// the absolute path to the output file, which is to be compared to cmp-file.
+ /// the absolute path to the cmp-file, which is to be compared to output file.
+ /// the absolute path to the folder, which will be used to store image files for visual comparison.
+ ///
+ /// file name prefix for image files with marked visual differences if there is any.
+ ///
+ /// a map with one-based page numbers as keys and lists of ignored rectangles as values.
+ ///
+ ///
+ /// string containing text report of the encountered content differences and also list of the pages that are
+ /// visually different, or null if there are no content and therefore no visual differences.
+ ///
+ ///
+ ///
+ public virtual String CompareByContent(String outPdf, String cmpPdf, String outPath, String differenceImagePrefix
+ , IDictionary> ignoredAreas) {
+ Init(outPdf, cmpPdf);
+ return CompareByContent(outPath, differenceImagePrefix, ignoredAreas);
+ }
+
+ /// This method overload is used to compare two encrypted PDF documents.
+ ///
+ /// This method overload is used to compare two encrypted PDF documents. Document passwords are passed with
+ /// outPass and cmpPass parameters.
+ ///
+ /// Compares two PDF documents by content starting from page dictionaries and then recursively comparing
+ /// corresponding objects which are referenced from them. You can roughly imagine it as depth-first traversal
+ /// of the two trees that represent pdf objects structure of the documents.
+ ///
+ /// Unlike
+ ///
+ /// this method performs content comparison page by page
+ /// and doesn't compare the tag structure, acroforms and all other things that doesn't belong to specific pages.
+ ///
+ /// When comparison by content is finished, if any differences were found, visual comparison is automatically started.
+ /// For more info see
+ ///
+ /// .
+ ///
+ /// For more explanations about what is outPdf and cmpPdf see last paragraph of the
+ ///
+ /// class description.
+ ///
+ /// the absolute path to the output file, which is to be compared to cmp-file.
+ /// the absolute path to the cmp-file, which is to be compared to output file.
+ /// the absolute path to the folder, which will be used to store image files for visual comparison.
+ ///
+ /// file name prefix for image files with marked visual differences if there is any.
+ ///
+ /// a map with one-based page numbers as keys and lists of ignored rectangles as values.
+ ///
+ /// password for the encrypted document specified by the outPdf absolute path.
+ /// password for the encrypted document specified by the cmpPdf absolute path.
+ ///
+ /// string containing text report of the encountered content differences and also list of the pages that are
+ /// visually different, or null if there are no content and therefore no visual differences.
+ ///
+ ///
+ ///
+ public virtual String CompareByContent(String outPdf, String cmpPdf, String outPath, String differenceImagePrefix
+ , IDictionary> ignoredAreas, byte[] outPass, byte[] cmpPass) {
+ Init(outPdf, cmpPdf);
+ SetPassword(outPass, cmpPass);
+ return CompareByContent(outPath, differenceImagePrefix, ignoredAreas);
+ }
+
+ /// Simple method that compares two given PdfDictionaries by content.
+ ///
+ /// Simple method that compares two given PdfDictionaries by content. This is "deep" comparing, which means that all
+ /// nested objects are also compared by content.
+ ///
+ /// dictionary to compare.
+ /// dictionary to compare.
+ /// true if dictionaries are equal by content, otherwise false.
+ ///
+ public virtual bool CompareDictionaries(PdfDictionary outDict, PdfDictionary cmpDict) {
+ return CompareDictionariesExtended(outDict, cmpDict, null, null);
+ }
+
+ /// Simple method that compares two given PdfStreams by content.
+ ///
+ /// Simple method that compares two given PdfStreams by content. This is "deep" comparing, which means that all
+ /// nested objects are also compared by content.
+ ///
+ /// stream to compare.
+ /// stream to compare.
+ /// true if stream are equal by content, otherwise false.
+ ///
+ public virtual bool CompareStreams(PdfStream outStream, PdfStream cmpStream) {
+ return CompareStreamsExtended(outStream, cmpStream, null, null);
+ }
+
+ /// Simple method that compares two given PdfArrays by content.
+ ///
+ /// Simple method that compares two given PdfArrays by content. This is "deep" comparing, which means that all
+ /// nested objects are also compared by content.
+ ///
+ /// array to compare.
+ /// array to compare.
+ /// true if arrays are equal by content, otherwise false.
+ ///
+ public virtual bool CompareArrays(PdfArray outArray, PdfArray cmpArray) {
+ return CompareArraysExtended(outArray, cmpArray, null, null);
+ }
+
+ /// Simple method that compares two given PdfNames.
+ /// name to compare.
+ /// name to compare.
+ /// true if names are equal, otherwise false.
+ public virtual bool CompareNames(PdfName outName, PdfName cmpName) {
+ return cmpName.Equals(outName);
+ }
+
+ /// Simple method that compares two given PdfNumbers.
+ /// number to compare.
+ /// number to compare.
+ /// true if numbers are equal, otherwise false.
+ public virtual bool CompareNumbers(PdfNumber outNumber, PdfNumber cmpNumber) {
+ return cmpNumber.GetValue() == outNumber.GetValue();
+ }
- private const String gsFailed = "GhostScript failed for .";
+ /// Simple method that compares two given PdfStrings.
+ /// string to compare.
+ /// string to compare.
+ /// true if strings are equal, otherwise false.
+ public virtual bool CompareStrings(PdfString outString, PdfString cmpString) {
+ return cmpString.GetValue().Equals(outString.GetValue());
+ }
- private const String unexpectedNumberOfPages = "Unexpected number of pages for .";
+ /// Simple method that compares two given PdfBooleans.
+ /// boolean to compare.
+ /// boolean to compare.
+ /// true if booleans are equal, otherwise false.
+ public virtual bool CompareBooleans(PdfBoolean outBoolean, PdfBoolean cmpBoolean) {
+ return cmpBoolean.GetValue() == outBoolean.GetValue();
+ }
- private const String differentPages = "File differs on page .";
+ /// Compares xmp metadata of the two given PDF documents.
+ /// the absolute path to the output file, which xmp is to be compared to cmp-file.
+ /// the absolute path to the cmp-file, which xmp is to be compared to output file.
+ /// text report of the xmp differences, or null if there are no differences.
+ public virtual String CompareXmp(String outPdf, String cmpPdf) {
+ return CompareXmp(outPdf, cmpPdf, false);
+ }
- private const String undefinedGsPath = "Path to GhostScript is not specified. Please use -DgsExec= (e.g. -DgsExec=\"C:/Program Files/gs/gs9.14/bin/gswin32c.exe\")";
+ /// Compares xmp metadata of the two given PDF documents.
+ /// the absolute path to the output file, which xmp is to be compared to cmp-file.
+ /// the absolute path to the cmp-file, which xmp is to be compared to output file.
+ ///
+ /// true, if to ignore differences in date or producer xmp metadata
+ /// properties.
+ ///
+ /// text report of the xmp differences, or null if there are no differences.
+ public virtual String CompareXmp(String outPdf, String cmpPdf, bool ignoreDateAndProducerProperties) {
+ Init(outPdf, cmpPdf);
+ PdfDocument cmpDocument = null;
+ PdfDocument outDocument = null;
+ try {
+ cmpDocument = new PdfDocument(new PdfReader(this.cmpPdf));
+ outDocument = new PdfDocument(new PdfReader(this.outPdf));
+ byte[] cmpBytes = cmpDocument.GetXmpMetadata();
+ byte[] outBytes = outDocument.GetXmpMetadata();
+ if (ignoreDateAndProducerProperties) {
+ XMPMeta xmpMeta = XMPMetaFactory.ParseFromBuffer(cmpBytes);
+ XMPUtils.RemoveProperties(xmpMeta, XMPConst.NS_XMP, PdfConst.CreateDate, true, true);
+ XMPUtils.RemoveProperties(xmpMeta, XMPConst.NS_XMP, PdfConst.ModifyDate, true, true);
+ XMPUtils.RemoveProperties(xmpMeta, XMPConst.NS_XMP, PdfConst.MetadataDate, true, true);
+ XMPUtils.RemoveProperties(xmpMeta, XMPConst.NS_PDF, PdfConst.Producer, true, true);
+ cmpBytes = XMPMetaFactory.SerializeToBuffer(xmpMeta, new SerializeOptions(SerializeOptions.SORT));
+ xmpMeta = XMPMetaFactory.ParseFromBuffer(outBytes);
+ XMPUtils.RemoveProperties(xmpMeta, XMPConst.NS_XMP, PdfConst.CreateDate, true, true);
+ XMPUtils.RemoveProperties(xmpMeta, XMPConst.NS_XMP, PdfConst.ModifyDate, true, true);
+ XMPUtils.RemoveProperties(xmpMeta, XMPConst.NS_XMP, PdfConst.MetadataDate, true, true);
+ XMPUtils.RemoveProperties(xmpMeta, XMPConst.NS_PDF, PdfConst.Producer, true, true);
+ outBytes = XMPMetaFactory.SerializeToBuffer(xmpMeta, new SerializeOptions(SerializeOptions.SORT));
+ }
+ if (!CompareXmls(cmpBytes, outBytes)) {
+ return "The XMP packages different!";
+ }
+ }
+ catch (Exception) {
+ return "XMP parsing failure!";
+ }
+ finally {
+ if (cmpDocument != null) {
+ cmpDocument.Close();
+ }
+ if (outDocument != null) {
+ outDocument.Close();
+ }
+ }
+ return null;
+ }
- private const String ignoredAreasPrefix = "ignored_areas_";
+ /// Utility method that provides simple comparison of the two xml files stored in byte arrays.
+ /// first xml file data to compare.
+ /// second xml file data to compare.
+ /// true if xml structures are identical, false otherwise.
+ ///
+ ///
+ ///
+ public virtual bool CompareXmls(byte[] xml1, byte[] xml2) {
+ return XmlUtils.CompareXmls(new MemoryStream(xml1), new MemoryStream(xml2));
+ }
- private const String gsParams = " -dNOPAUSE -dBATCH -sDEVICE=png16m -r150 -sOutputFile= ";
+ /// Utility method that provides simple comparison of the two xml files.
+ /// absolute path to the first xml file to compare.
+ /// absolute path to the second xml file to compare.
+ /// true if xml structures are identical, false otherwise.
+ ///
+ ///
+ ///
+ public virtual bool CompareXmls(String xmlFilePath1, String xmlFilePath2) {
+ return XmlUtils.CompareXmls(new FileStream(xmlFilePath1, FileMode.Open, FileAccess.Read), new FileStream(xmlFilePath2
+ , FileMode.Open, FileAccess.Read));
+ }
- private const String compareParams = " \"\" \"\" \"\"";
+ /// This method overload is used to compare two encrypted PDF documents.
+ ///
+ /// This method overload is used to compare two encrypted PDF documents. Document passwords are passed with
+ /// outPass and cmpPass parameters.
+ ///
+ /// Compares document info dictionaries of two pdf documents.
+ ///
+ /// the absolute path to the output file, which info is to be compared to cmp-file info.
+ /// the absolute path to the cmp-file, which info is to be compared to output file info.
+ /// password for the encrypted document specified by the outPdf absolute path.
+ /// password for the encrypted document specified by the cmpPdf absolute path.
+ /// text report of the differences in documents infos.
+ ///
+ public virtual String CompareDocumentInfo(String outPdf, String cmpPdf, byte[] outPass, byte[] cmpPass) {
+ System.Console.Out.Write("[itext] INFO Comparing document info.......");
+ String message = null;
+ SetPassword(outPass, cmpPass);
+ PdfDocument outDocument = new PdfDocument(new PdfReader(outPdf, GetOutReaderProperties()));
+ PdfDocument cmpDocument = new PdfDocument(new PdfReader(cmpPdf, GetCmpReaderProperties()));
+ String[] cmpInfo = ConvertInfo(cmpDocument.GetDocumentInfo());
+ String[] outInfo = ConvertInfo(outDocument.GetDocumentInfo());
+ for (int i = 0; i < cmpInfo.Length; ++i) {
+ if (!cmpInfo[i].Equals(outInfo[i])) {
+ message = "Document info fail";
+ break;
+ }
+ }
+ outDocument.Close();
+ cmpDocument.Close();
+ if (message == null) {
+ System.Console.Out.WriteLine("OK");
+ }
+ else {
+ System.Console.Out.WriteLine("Fail");
+ }
+ System.Console.Out.Flush();
+ return message;
+ }
- private String gsExec;
+ /// Compares document info dictionaries of two pdf documents.
+ /// the absolute path to the output file, which info is to be compared to cmp-file info.
+ /// the absolute path to the cmp-file, which info is to be compared to output file info.
+ /// text report of the differences in documents infos.
+ ///
+ public virtual String CompareDocumentInfo(String outPdf, String cmpPdf) {
+ return CompareDocumentInfo(outPdf, cmpPdf, null, null);
+ }
- private String compareExec;
+ /// Compares if two documents has identical link annotations on corresponding pages.
+ /// the absolute path to the output file, which links are to be compared to cmp-file links.
+ ///
+ /// the absolute path to the cmp-file, which links are to be compared to output file links.
+ ///
+ /// text report of the differences in documents links.
+ ///
+ public virtual String CompareLinkAnnotations(String outPdf, String cmpPdf) {
+ System.Console.Out.Write("[itext] INFO Comparing link annotations....");
+ String message = null;
+ PdfDocument outDocument = new PdfDocument(new PdfReader(outPdf));
+ PdfDocument cmpDocument = new PdfDocument(new PdfReader(cmpPdf));
+ for (int i = 0; i < outDocument.GetNumberOfPages() && i < cmpDocument.GetNumberOfPages(); i++) {
+ IList outLinks = GetLinkAnnotations(i + 1, outDocument);
+ IList cmpLinks = GetLinkAnnotations(i + 1, cmpDocument);
+ if (cmpLinks.Count != outLinks.Count) {
+ message = String.Format("Different number of links on page {0}.", i + 1);
+ break;
+ }
+ for (int j = 0; j < cmpLinks.Count; j++) {
+ if (!CompareLinkAnnotations(cmpLinks[j], outLinks[j], cmpDocument, outDocument)) {
+ message = String.Format("Different links on page {0}.\n{1}\n{2}", i + 1, cmpLinks[j].ToString(), outLinks[
+ j].ToString());
+ break;
+ }
+ }
+ }
+ outDocument.Close();
+ cmpDocument.Close();
+ if (message == null) {
+ System.Console.Out.WriteLine("OK");
+ }
+ else {
+ System.Console.Out.WriteLine("Fail");
+ }
+ System.Console.Out.Flush();
+ return message;
+ }
- private String cmpPdf;
-
- private String cmpPdfName;
+ /// Compares tag structures of the two PDF documents.
+ ///
+ /// Compares tag structures of the two PDF documents.
+ ///
+ /// This method creates xml files in the same folder with outPdf file. These xml files contain documents tag structures
+ /// converted into the xml structure. These xml files are compared if they are equal.
+ ///
+ /// the absolute path to the output file, which tags are to be compared to cmp-file tags.
+ ///
+ /// the absolute path to the cmp-file, which tags are to be compared to output file tags.
+ ///
+ /// text report of the differences in documents tags.
+ ///
+ ///
+ ///
+ public virtual String CompareTagStructures(String outPdf, String cmpPdf) {
+ System.Console.Out.Write("[itext] INFO Comparing tag structures......");
+ String outXmlPath = outPdf.Replace(".pdf", ".xml");
+ String cmpXmlPath = outPdf.Replace(".pdf", ".cmp.xml");
+ String message = null;
+ PdfReader readerOut = new PdfReader(outPdf);
+ PdfDocument docOut = new PdfDocument(readerOut);
+ FileStream xmlOut = new FileStream(outXmlPath, FileMode.Create);
+ new TaggedPdfReaderTool(docOut).SetRootTag("root").ConvertToXml(xmlOut);
+ docOut.Close();
+ xmlOut.Close();
+ PdfReader readerCmp = new PdfReader(cmpPdf);
+ PdfDocument docCmp = new PdfDocument(readerCmp);
+ FileStream xmlCmp = new FileStream(cmpXmlPath, FileMode.Create);
+ new TaggedPdfReaderTool(docCmp).SetRootTag("root").ConvertToXml(xmlCmp);
+ docCmp.Close();
+ xmlCmp.Close();
+ if (!CompareXmls(outXmlPath, cmpXmlPath)) {
+ message = "The tag structures are different.";
+ }
+ if (message == null) {
+ System.Console.Out.WriteLine("OK");
+ }
+ else {
+ System.Console.Out.WriteLine("Fail");
+ }
+ System.Console.Out.Flush();
+ return message;
+ }
- private String cmpImage;
-
- private String outPdf;
-
- private String outPdfName;
-
- private String outImage;
-
- private IList outPagesRef;
-
- private IList cmpPagesRef;
-
- private int compareByContentErrorsLimit = 1;
-
- private bool generateCompareByContentXmlReport = false;
-
- private bool encryptionCompareEnabled = false;
-
- private bool useCachedPagesForComparison = true;
-
- public CompareTool()
- {
- gsExec = System.Environment.GetEnvironmentVariable("gsExec");
- compareExec = System.Environment.GetEnvironmentVariable("compareExec");
- }
-
- ///
- public virtual CompareTool.CompareResult CompareByCatalog(PdfDocument outDocument
- , PdfDocument cmpDocument)
- {
- CompareTool.CompareResult compareResult = null;
- compareResult = new CompareTool.CompareResult(this, compareByContentErrorsLimit);
- CompareTool.ObjectPath catalogPath = new CompareTool.ObjectPath(cmpDocument
- .GetCatalog().GetPdfObject().GetIndirectReference(), outDocument.GetCatalog().GetPdfObject
- ().GetIndirectReference());
- ICollection ignoredCatalogEntries = new LinkedHashSet(iText.IO.Util.JavaUtil.ArraysAsList
- (PdfName.Metadata));
- CompareDictionariesExtended(outDocument.GetCatalog().GetPdfObject(), cmpDocument.
- GetCatalog().GetPdfObject(), catalogPath, compareResult, ignoredCatalogEntries);
- return compareResult;
- }
-
- public virtual iText.Kernel.Utils.CompareTool DisableCachedPagesComparison()
- {
- this.useCachedPagesForComparison = false;
- return this;
- }
-
- /// Sets the maximum errors count which will be returned as the result of the comparison.
- ///
- /// the errors count.
- /// Returns this.
- public virtual iText.Kernel.Utils.CompareTool SetCompareByContentErrorsLimit
- (int compareByContentMaxErrorCount)
- {
- this.compareByContentErrorsLimit = compareByContentMaxErrorCount;
- return this;
- }
-
- public virtual iText.Kernel.Utils.CompareTool SetGenerateCompareByContentXmlReport
- (bool generateCompareByContentXmlReport)
- {
- this.generateCompareByContentXmlReport = generateCompareByContentXmlReport;
- return this;
- }
-
- public virtual iText.Kernel.Utils.CompareTool EnableEncryptionCompare()
- {
- this.encryptionCompareEnabled = true;
- return this;
- }
-
- ///
- ///
- public virtual String CompareVisually(String outPdf, String cmpPdf, String outPath
- , String differenceImagePrefix)
- {
- return CompareVisually(outPdf, cmpPdf, outPath, differenceImagePrefix, null);
- }
-
- ///
- ///
- public virtual String CompareVisually(String outPdf, String cmpPdf, String outPath
- , String differenceImagePrefix, IDictionary> ignoredAreas
- )
- {
- Init(outPdf, cmpPdf);
- return CompareVisually(outPath, differenceImagePrefix, ignoredAreas);
- }
-
- ///
- ///
- public virtual String CompareByContent(String outPdf, String cmpPdf, String outPath
- , String differenceImagePrefix)
- {
- return CompareByContent(outPdf, cmpPdf, outPath, differenceImagePrefix, null, null
- , null);
- }
-
- ///
- ///
- public virtual String CompareByContent(String outPdf, String cmpPdf, String outPath
- , String differenceImagePrefix, byte[] outPass, byte[] cmpPass)
- {
- return CompareByContent(outPdf, cmpPdf, outPath, differenceImagePrefix, null, outPass
- , cmpPass);
- }
-
- ///
- ///
- public virtual String CompareByContent(String outPdf, String cmpPdf, String outPath
- , String differenceImagePrefix, IDictionary> ignoredAreas
- )
- {
- Init(outPdf, cmpPdf);
- return CompareByContent(outPath, differenceImagePrefix, ignoredAreas, null, null);
- }
-
- ///
- ///
- public virtual String CompareByContent(String outPdf, String cmpPdf, String outPath
- , String differenceImagePrefix, IDictionary> ignoredAreas
- , byte[] outPass, byte[] cmpPass)
- {
- Init(outPdf, cmpPdf);
- return CompareByContent(outPath, differenceImagePrefix, ignoredAreas, outPass, cmpPass
- );
- }
-
- ///
- public virtual bool CompareDictionaries(PdfDictionary outDict, PdfDictionary cmpDict
- )
- {
- return CompareDictionariesExtended(outDict, cmpDict, null, null);
- }
-
- ///
- public virtual bool CompareStreams(PdfStream outStream, PdfStream cmpStream)
- {
- return CompareStreamsExtended(outStream, cmpStream, null, null);
- }
-
- ///
- public virtual bool CompareArrays(PdfArray outArray, PdfArray cmpArray)
- {
- return CompareArraysExtended(outArray, cmpArray, null, null);
- }
-
- public virtual bool CompareNames(PdfName outName, PdfName cmpName)
- {
- return cmpName.Equals(outName);
- }
-
- public virtual bool CompareNumbers(PdfNumber outNumber, PdfNumber cmpNumber) {
- return 0 == cmpNumber.GetValue().CompareTo(outNumber.GetValue());
- }
-
- public virtual bool CompareStrings(PdfString outString, PdfString cmpString)
- {
- return cmpString.GetValue().Equals(outString.GetValue());
- }
-
- public virtual bool CompareBooleans(PdfBoolean outBoolean, PdfBoolean cmpBoolean)
- {
- return cmpBoolean.GetValue() == outBoolean.GetValue();
- }
-
- public virtual String CompareXmp(String outPdf, String cmpPdf)
- {
- return CompareXmp(outPdf, cmpPdf, false);
- }
-
- public virtual String CompareXmp(String outPdf, String cmpPdf, bool ignoreDateAndProducerProperties
- )
- {
- Init(outPdf, cmpPdf);
- PdfDocument cmpDocument = null;
- PdfDocument outDocument = null;
- try
- {
- cmpDocument = new PdfDocument(new PdfReader(this.cmpPdf));
- outDocument = new PdfDocument(new PdfReader(this.outPdf));
- byte[] cmpBytes = cmpDocument.GetXmpMetadata();
- byte[] outBytes = outDocument.GetXmpMetadata();
- if (ignoreDateAndProducerProperties)
- {
- XMPMeta xmpMeta = XMPMetaFactory.ParseFromBuffer(cmpBytes);
- XMPUtils.RemoveProperties(xmpMeta, XMPConst.NS_XMP, PdfConst.CreateDate, true, true
- );
- XMPUtils.RemoveProperties(xmpMeta, XMPConst.NS_XMP, PdfConst.ModifyDate, true, true
- );
- XMPUtils.RemoveProperties(xmpMeta, XMPConst.NS_XMP, PdfConst.MetadataDate, true,
- true);
- XMPUtils.RemoveProperties(xmpMeta, XMPConst.NS_PDF, PdfConst.Producer, true, true
- );
- cmpBytes = XMPMetaFactory.SerializeToBuffer(xmpMeta, new SerializeOptions(SerializeOptions
- .SORT));
- xmpMeta = XMPMetaFactory.ParseFromBuffer(outBytes);
- XMPUtils.RemoveProperties(xmpMeta, XMPConst.NS_XMP, PdfConst.CreateDate, true, true
- );
- XMPUtils.RemoveProperties(xmpMeta, XMPConst.NS_XMP, PdfConst.ModifyDate, true, true
- );
- XMPUtils.RemoveProperties(xmpMeta, XMPConst.NS_XMP, PdfConst.MetadataDate, true,
- true);
- XMPUtils.RemoveProperties(xmpMeta, XMPConst.NS_PDF, PdfConst.Producer, true, true
- );
- outBytes = XMPMetaFactory.SerializeToBuffer(xmpMeta, new SerializeOptions(SerializeOptions
- .SORT));
- }
- if (!CompareXmls(cmpBytes, outBytes))
- {
- return "The XMP packages different!";
- }
- }
- catch (XMPException)
- {
- return "XMP parsing failure!";
- }
- catch (System.IO.IOException)
- {
- return "XMP parsing failure!";
- }
- finally
- {
- if (cmpDocument != null)
- {
- cmpDocument.Close();
- }
- if (outDocument != null)
- {
- outDocument.Close();
- }
- }
- return null;
- }
-
- ///
- ///
- ///
- public virtual bool CompareXmls(byte[] xml1, byte[] xml2)
- {
- return CompareXmls(new MemoryStream(xml1), new MemoryStream(xml2));
- }
-
- ///
- ///
- ///
- public virtual bool CompareXmls(String xmlFilePath1, String xmlFilePath2)
- {
- return CompareXmls(new FileStream(xmlFilePath1, FileMode.Open, FileAccess.Read), new FileStream(xmlFilePath2
- , FileMode.Open, FileAccess.Read));
- }
-
- ///
- public virtual String CompareDocumentInfo(String outPdf, String cmpPdf, byte[] outPass
- , byte[] cmpPass)
- {
- System.Console.Out.Write("[itext] INFO Comparing document info.......");
- String message = null;
- PdfDocument outDocument = new PdfDocument(new PdfReader(outPdf, new ReaderProperties
- ().SetPassword(outPass)));
- PdfDocument cmpDocument = new PdfDocument(new PdfReader(cmpPdf, new ReaderProperties
- ().SetPassword(cmpPass)));
- String[] cmpInfo = ConvertInfo(cmpDocument.GetDocumentInfo());
- String[] outInfo = ConvertInfo(outDocument.GetDocumentInfo());
- for (int i = 0; i < cmpInfo.Length; ++i)
- {
- if (!cmpInfo[i].Equals(outInfo[i]))
- {
- message = "Document info fail";
- break;
- }
- }
- outDocument.Close();
- cmpDocument.Close();
- if (message == null)
- {
- System.Console.Out.WriteLine("OK");
- }
- else
- {
- System.Console.Out.WriteLine("Fail");
- }
- System.Console.Out.Flush();
- return message;
- }
-
- ///
- public virtual String CompareDocumentInfo(String outPdf, String cmpPdf)
- {
- return CompareDocumentInfo(outPdf, cmpPdf, null, null);
- }
-
- ///
- public virtual String CompareLinkAnnotations(String outPdf, String cmpPdf)
- {
- System.Console.Out.Write("[itext] INFO Comparing link annotations....");
- String message = null;
- PdfDocument outDocument = new PdfDocument(new PdfReader(outPdf));
- PdfDocument cmpDocument = new PdfDocument(new PdfReader(cmpPdf));
- for (int i = 0; i < outDocument.GetNumberOfPages() && i < cmpDocument.GetNumberOfPages
- (); i++)
- {
- IList outLinks = GetLinkAnnotations(i + 1, outDocument);
- IList cmpLinks = GetLinkAnnotations(i + 1, cmpDocument);
- if (cmpLinks.Count != outLinks.Count)
- {
- message = String.Format("Different number of links on page {0}.", i + 1);
- break;
- }
- for (int j = 0; j < cmpLinks.Count; j++)
- {
- if (!CompareLinkAnnotations(cmpLinks[j], outLinks[j], cmpDocument, outDocument))
- {
- message = String.Format("Different links on page {0}.\n{1}\n{2}", i + 1, cmpLinks
- [j].ToString(), outLinks[j].ToString());
- break;
- }
- }
- }
- outDocument.Close();
- cmpDocument.Close();
- if (message == null)
- {
- System.Console.Out.WriteLine("OK");
- }
- else
- {
- System.Console.Out.WriteLine("Fail");
- }
- System.Console.Out.Flush();
- return message;
- }
-
- ///
- ///
- ///
- public virtual String CompareTagStructures(String outPdf, String cmpPdf)
- {
- System.Console.Out.Write("[itext] INFO Comparing tag structures......");
- String outXmlPath = outPdf.Replace(".pdf", ".xml");
- String cmpXmlPath = outPdf.Replace(".pdf", ".cmp.xml");
- String message = null;
- PdfReader readerOut = new PdfReader(outPdf);
- PdfDocument docOut = new PdfDocument(readerOut);
- FileStream xmlOut = new FileStream(outXmlPath, FileMode.Create);
- new TaggedPdfReaderTool(docOut).SetRootTag("root").ConvertToXml(xmlOut);
- docOut.Close();
- xmlOut.Close();
- PdfReader readerCmp = new PdfReader(cmpPdf);
- PdfDocument docCmp = new PdfDocument(readerCmp);
- FileStream xmlCmp = new FileStream(cmpXmlPath, FileMode.Create);
- new TaggedPdfReaderTool(docCmp).SetRootTag("root").ConvertToXml(xmlCmp);
- docCmp.Close();
- xmlCmp.Close();
- if (!CompareXmls(outXmlPath, cmpXmlPath))
- {
- message = "The tag structures are different.";
- }
- if (message == null)
- {
- System.Console.Out.WriteLine("OK");
- }
- else
- {
- System.Console.Out.WriteLine("Fail");
- }
- System.Console.Out.Flush();
- return message;
- }
-
- private void Init(String outPdf, String cmpPdf)
- {
- this.outPdf = outPdf;
- this.cmpPdf = cmpPdf;
- outPdfName = new FileInfo(outPdf).Name;
+ private void Init(String outPdf, String cmpPdf) {
+ this.outPdf = outPdf;
+ this.cmpPdf = cmpPdf;
+ outPdfName = new FileInfo(outPdf).Name;
cmpPdfName = new FileInfo(cmpPdf).Name;
- outImage = outPdfName + "-%03d.png";
- if (cmpPdfName.StartsWith("cmp_"))
- {
- cmpImage = cmpPdfName + "-%03d.png";
- }
- else
- {
- cmpImage = "cmp_" + cmpPdfName + "-%03d.png";
- }
- }
-
- ///
- ///
- private String CompareVisually(String outPath, String differenceImagePrefix, IDictionary
- > ignoredAreas)
- {
- return CompareVisually(outPath, differenceImagePrefix, ignoredAreas, null);
- }
-
- ///
- ///
- private String CompareVisually(String outPath, String differenceImagePrefix, IDictionary
- > ignoredAreas, IList equalPages)
- {
- if (gsExec == null)
- {
- return undefinedGsPath;
- }
- if (!FileUtil.FileExists(gsExec))
- {
- return Path.GetFullPath(gsExec) + " does not exist";
- }
- if (!outPath.EndsWith("/"))
- {
- outPath = outPath + "/";
- }
- PrepareOutputDirs(outPath, differenceImagePrefix);
- if (ignoredAreas != null && ignoredAreas.Count > 0)
- {
- CreateIgnoredAreasPdfs(outPath, ignoredAreas);
- }
- String imagesGenerationResult = RunGhostScriptImageGeneration(outPath);
- if (imagesGenerationResult != null)
- {
- return imagesGenerationResult;
- }
- return CompareImagesOfPdfs(outPath, differenceImagePrefix, equalPages);
- }
-
- ///
- ///
- private String CompareImagesOfPdfs(String outPath, String differenceImagePrefix,
- IList equalPages)
- {
- String[] imageFiles = FileUtil.ListFilesInDirectoryByFilter(outPath, false, new PngFileFilter(this));
- String[] cmpImageFiles = FileUtil.ListFilesInDirectoryByFilter(outPath, false, new CmpPngFileFilter(this));
-
- bool bUnexpectedNumberOfPages = false;
- if (imageFiles.Length != cmpImageFiles.Length)
- {
- bUnexpectedNumberOfPages = true;
- }
- int cnt = Math.Min(imageFiles.Length, cmpImageFiles.Length);
- if (cnt < 1)
- {
- return "No files for comparing.\nThe result or sample pdf file is not processed by GhostScript.";
- }
- System.Array.Sort(imageFiles, new CompareTool.ImageNameComparator(this));
- System.Array.Sort(cmpImageFiles, new CompareTool.ImageNameComparator(this));
- String differentPagesFail = null;
- bool compareExecIsOk = compareExec != null && FileUtil.FileExists(compareExec);
- IList diffPages = new List();
- for (int i = 0; i < cnt; i++)
- {
- if (equalPages != null && equalPages.Contains(i))
- {
- continue;
- }
- System.Console.Out.Write("Comparing page " + iText.IO.Util.JavaUtil.IntegerToString
- (i + 1) + " (" + imageFiles[i] + ")...");
- FileStream is1 = new FileStream(imageFiles[i], FileMode.Open, FileAccess.Read);
- FileStream is2 = new FileStream(cmpImageFiles[i], FileMode.Open, FileAccess.Read);
- bool cmpResult = CompareStreams(is1, is2);
- is1.Close();
- is2.Close();
- if (!cmpResult)
- {
- differentPagesFail = " Page is different!";
- diffPages.Add(i + 1);
- if (compareExecIsOk)
- {
- String currCompareParams = compareParams.Replace("", imageFiles[i])
- .Replace("", cmpImageFiles[i]).Replace(""
- , outPath + differenceImagePrefix + iText.IO.Util.JavaUtil.IntegerToString(
- i + 1) + ".png");
- if (RunProcessAndWait(compareExec, currCompareParams))
- {
- differentPagesFail += "\nPlease, examine " + outPath + differenceImagePrefix + iText.IO.Util.JavaUtil.IntegerToString
- (i + 1) + ".png for more details.";
- }
- }
- System.Console.Out.WriteLine(differentPagesFail);
- }
- else
- {
- System.Console.Out.WriteLine(" done.");
- }
- }
- if (differentPagesFail != null)
- {
- String errorMessage = differentPages.Replace("", outPdf).Replace(""
- , diffPages.ToString());
- if (!compareExecIsOk)
- {
- errorMessage += "\nYou can optionally specify path to ImageMagick compare tool (e.g. -DcompareExec=\"C:/Program Files/ImageMagick-6.5.4-2/compare.exe\") to visualize differences.";
- }
- return errorMessage;
- }
- else
- {
- if (bUnexpectedNumberOfPages)
- {
- return unexpectedNumberOfPages.Replace("", outPdf);
- }
- }
- return null;
- }
-
- ///
- private void CreateIgnoredAreasPdfs(String outPath, IDictionary> ignoredAreas)
- {
- PdfWriter outWriter = new PdfWriter(new FileStream(outPath + ignoredAreasPrefix +
- outPdfName, FileMode.Create));
- PdfWriter cmpWriter = new PdfWriter(new FileStream(outPath + ignoredAreasPrefix +
- cmpPdfName, FileMode.Create));
- PdfDocument pdfOutDoc = new PdfDocument(new PdfReader(outPdf), outWriter);
- PdfDocument pdfCmpDoc = new PdfDocument(new PdfReader(cmpPdf), cmpWriter);
- foreach (KeyValuePair> entry in ignoredAreas)
- {
- int pageNumber = (int) entry.Key;
- IList rectangles = entry.Value;
- if (rectangles != null && rectangles.Count > 0)
- {
- //drawing rectangles manually, because we don't want to create dependency on itextpdf.canvas module for itextpdf.kernel
- PdfStream outStream = GetPageContentStream(pdfOutDoc.GetPage(pageNumber));
- PdfStream cmpStream = GetPageContentStream(pdfCmpDoc.GetPage(pageNumber));
- outStream.GetOutputStream().WriteBytes(ByteUtils.GetIsoBytes("q\n"));
- outStream.GetOutputStream().WriteFloats(new float[] { 0.0f, 0.0f, 0.0f }).WriteSpace
- ().WriteBytes(ByteUtils.GetIsoBytes("rg\n"));
- cmpStream.GetOutputStream().WriteBytes(ByteUtils.GetIsoBytes("q\n"));
- cmpStream.GetOutputStream().WriteFloats(new float[] { 0.0f, 0.0f, 0.0f }).WriteSpace
- ().WriteBytes(ByteUtils.GetIsoBytes("rg\n"));
- foreach (Rectangle rect in rectangles)
- {
- outStream.GetOutputStream().WriteFloats(new float[] { rect.GetX(), rect.GetY(), rect
- .GetWidth(), rect.GetHeight() }).WriteSpace().WriteBytes(ByteUtils.GetIsoBytes("re\n"
- )).WriteBytes(ByteUtils.GetIsoBytes("f\n"));
- cmpStream.GetOutputStream().WriteFloats(new float[] { rect.GetX(), rect.GetY(), rect
- .GetWidth(), rect.GetHeight() }).WriteSpace().WriteBytes(ByteUtils.GetIsoBytes("re\n"
- )).WriteBytes(ByteUtils.GetIsoBytes("f\n"));
- }
- outStream.GetOutputStream().WriteBytes(ByteUtils.GetIsoBytes("Q\n"));
- cmpStream.GetOutputStream().WriteBytes(ByteUtils.GetIsoBytes("Q\n"));
- }
- }
- pdfOutDoc.Close();
- pdfCmpDoc.Close();
- Init(outPath + ignoredAreasPrefix + outPdfName, outPath + ignoredAreasPrefix + cmpPdfName
- );
- }
-
- private PdfStream GetPageContentStream(PdfPage page)
- {
- PdfStream stream = page.GetContentStream(page.GetContentStreamCount() - 1);
- return stream.GetOutputStream() == null ? page.NewContentStreamAfter() : stream;
- }
-
- private void PrepareOutputDirs(String outPath, String differenceImagePrefix)
- {
- String[] imageFiles;
- String[] cmpImageFiles;
- String[] diffFiles;
- if (FileUtil.DirectoryExists(outPath)) {
- Directory.CreateDirectory(outPath);
- }
- else
- {
- imageFiles = FileUtil.ListFilesInDirectoryByFilter(outPath, false, new CompareTool.PngFileFilter(this));
- foreach (String file in imageFiles)
- {
- File.Delete(file);
- }
- cmpImageFiles = FileUtil.ListFilesInDirectoryByFilter(outPath, false, new CompareTool.CmpPngFileFilter(this));
- foreach (String file in cmpImageFiles)
- {
- File.Delete(file);
- }
- diffFiles = FileUtil.ListFilesInDirectoryByFilter(outPath, false, new CompareTool.DiffPngFileFilter(this, differenceImagePrefix
- ));
- foreach (String file in diffFiles)
- {
- File.Delete(file);
- }
- }
- }
-
- /// Runs ghostscript to create images of pdfs.
- /// Path to the output folder.
- /// Returns null if result is successful, else returns error message.
- ///
- ///
- private String RunGhostScriptImageGeneration(String outPath)
- {
- if (!FileUtil.DirectoryExists(outPath))
- {
- return cannotOpenOutputDirectory.Replace("", outPdf);
- }
- String currGsParams = gsParams.Replace("", outPath + cmpImage).Replace
- ("", cmpPdf);
- if (!RunProcessAndWait(gsExec, currGsParams))
- {
- return gsFailed.Replace("", cmpPdf);
- }
- currGsParams = gsParams.Replace("", outPath + outImage).Replace(""
- , outPdf);
- if (!RunProcessAndWait(gsExec, currGsParams))
- {
- return gsFailed.Replace("", outPdf);
- }
- return null;
- }
-
- ///
- ///
- private bool RunProcessAndWait(String execPath, String @params)
- {
- StringTokenizer st = new StringTokenizer(@params);
- String[] cmdArray = new String[st.CountTokens() + 1];
- cmdArray[0] = execPath;
- for (int i = 1; st.HasMoreTokens(); ++i)
- {
- cmdArray[i] = st.NextToken();
- }
- Process p = new Process();
- p.StartInfo = new ProcessStartInfo(execPath, @params);
- p.StartInfo.RedirectStandardOutput = true;
- p.StartInfo.RedirectStandardError = true;
- p.StartInfo.UseShellExecute = false;
- p.StartInfo.CreateNoWindow = true;
- p.Start();
-
- PrintProcessOutput(p);
- p.WaitForExit();
- return true;
- }
-
- ///
- private void PrintProcessOutput(Process p) {
- StringBuilder bri = new StringBuilder();
- StringBuilder bre = new StringBuilder();
- while (!p.HasExited) {
- bri.Append(p.StandardOutput.ReadToEnd());
- bre.Append(p.StandardError.ReadToEnd());
- }
- System.Console.Out.WriteLine(bri.ToString());
- System.Console.Out.WriteLine(bre.ToString());
- }
-
- ///
- ///
- private String CompareByContent(String outPath, String differenceImagePrefix, IDictionary
- > ignoredAreas)
- {
- return CompareByContent(outPath, differenceImagePrefix, ignoredAreas, null, null);
- }
-
- ///
- ///
- private String CompareByContent(String outPath, String differenceImagePrefix, IDictionary
- > ignoredAreas, byte[] outPass, byte[] cmpPass)
- {
- System.Console.Out.Write("[itext] INFO Comparing by content..........");
- PdfDocument outDocument;
- try
- {
- outDocument = new PdfDocument(new PdfReader(outPdf, new ReaderProperties().SetPassword
- (outPass)));
- }
- catch (System.IO.IOException e)
- {
- throw new System.IO.IOException("File \"" + outPdf + "\" not found", e);
- }
- IList outPages = new List();
- outPagesRef = new List();
- LoadPagesFromReader(outDocument, outPages, outPagesRef);
- PdfDocument cmpDocument;
- try
- {
- cmpDocument = new PdfDocument(new PdfReader(cmpPdf, new ReaderProperties().SetPassword
- (cmpPass)));
- }
- catch (System.IO.IOException e)
- {
- throw new System.IO.IOException("File \"" + cmpPdf + "\" not found", e);
- }
- IList cmpPages = new List();
- cmpPagesRef = new List();
- LoadPagesFromReader(cmpDocument, cmpPages, cmpPagesRef);
- if (outPages.Count != cmpPages.Count)
- {
- return CompareVisually(outPath, differenceImagePrefix, ignoredAreas);
- }
- CompareTool.CompareResult compareResult = new CompareTool.CompareResult(this, compareByContentErrorsLimit
- );
- IList equalPages = new List(cmpPages.Count);
- for (int i = 0; i < cmpPages.Count; i++)
- {
- CompareTool.ObjectPath currentPath = new CompareTool.ObjectPath(cmpPagesRef
- [i], outPagesRef[i]);
- if (CompareDictionariesExtended(outPages[i], cmpPages[i], currentPath, compareResult
- ))
- {
- equalPages.Add(i);
- }
- }
- CompareTool.ObjectPath catalogPath = new CompareTool.ObjectPath(cmpDocument
- .GetCatalog().GetPdfObject().GetIndirectReference(), outDocument.GetCatalog().GetPdfObject
- ().GetIndirectReference());
- ICollection ignoredCatalogEntries = new LinkedHashSet(iText.IO.Util.JavaUtil.ArraysAsList
- (PdfName.Pages, PdfName.Metadata));
- CompareDictionariesExtended(outDocument.GetCatalog().GetPdfObject(), cmpDocument.
- GetCatalog().GetPdfObject(), catalogPath, compareResult, ignoredCatalogEntries);
- if (encryptionCompareEnabled)
- {
- CompareDocumentsEncryption(outDocument, cmpDocument, compareResult);
- }
- outDocument.Close();
- cmpDocument.Close();
- if (generateCompareByContentXmlReport)
- {
- try
- {
- String filename = Path.GetFileName(outPdf);
- FileStream xml = new FileStream(outPath + "/" + filename.Substring(0, filename.Length - 3) + "report.xml",
- FileMode.Create
- );
- compareResult.WriteReportToXml(xml);
+ outImage = outPdfName + "-%03d.png";
+ if (cmpPdfName.StartsWith("cmp_")) {
+ cmpImage = cmpPdfName + "-%03d.png";
+ }
+ else {
+ cmpImage = "cmp_" + cmpPdfName + "-%03d.png";
+ }
+ }
+
+ private void SetPassword(byte[] outPass, byte[] cmpPass) {
+ if (outPass != null) {
+ GetOutReaderProperties().SetPassword(outPass);
+ }
+ if (cmpPass != null) {
+ GetCmpReaderProperties().SetPassword(outPass);
+ }
+ }
+
+ ///
+ ///
+ private String CompareVisually(String outPath, String differenceImagePrefix, IDictionary> ignoredAreas) {
+ return CompareVisually(outPath, differenceImagePrefix, ignoredAreas, null);
+ }
+
+ ///
+ ///
+ private String CompareVisually(String outPath, String differenceImagePrefix, IDictionary> ignoredAreas, IList equalPages) {
+ if (gsExec == null) {
+ return undefinedGsPath;
+ }
+ if (!(new FileInfo(gsExec).Exists)) {
+ return new FileInfo(gsExec).FullName + " does not exist";
+ }
+ if (!outPath.EndsWith("/")) {
+ outPath = outPath + "/";
+ }
+ PrepareOutputDirs(outPath, differenceImagePrefix);
+ if (ignoredAreas != null && !ignoredAreas.IsEmpty()) {
+ CreateIgnoredAreasPdfs(outPath, ignoredAreas);
+ }
+ String imagesGenerationResult = RunGhostScriptImageGeneration(outPath);
+ if (imagesGenerationResult != null) {
+ return imagesGenerationResult;
+ }
+ return CompareImagesOfPdfs(outPath, differenceImagePrefix, equalPages);
+ }
+
+ ///
+ ///
+ private String CompareImagesOfPdfs(String outPath, String differenceImagePrefix, IList equalPages) {
+ FileInfo[] imageFiles = FileUtil.ListFilesInDirectoryByFilter(outPath, new CompareTool.PngFileFilter(this)
+ );
+ FileInfo[] cmpImageFiles = FileUtil.ListFilesInDirectoryByFilter(outPath, new CompareTool.CmpPngFileFilter
+ (this));
+ bool bUnexpectedNumberOfPages = false;
+ if (imageFiles.Length != cmpImageFiles.Length) {
+ bUnexpectedNumberOfPages = true;
+ }
+ int cnt = Math.Min(imageFiles.Length, cmpImageFiles.Length);
+ if (cnt < 1) {
+ return "No files for comparing.\nThe result or sample pdf file is not processed by GhostScript.";
+ }
+ iText.IO.Util.JavaUtil.Sort(imageFiles, new CompareTool.ImageNameComparator(this));
+ iText.IO.Util.JavaUtil.Sort(cmpImageFiles, new CompareTool.ImageNameComparator(this));
+ String differentPagesFail = null;
+ bool compareExecIsOk = compareExec != null && new FileInfo(compareExec).Exists;
+ IList diffPages = new List();
+ for (int i = 0; i < cnt; i++) {
+ if (equalPages != null && equalPages.Contains(i)) {
+ continue;
+ }
+ System.Console.Out.Write("Comparing page " + iText.IO.Util.JavaUtil.IntegerToString(i + 1) + " (" + imageFiles
+ [i].FullName + ")...");
+ FileStream is1 = new FileStream(imageFiles[i].FullName, FileMode.Open, FileAccess.Read);
+ FileStream is2 = new FileStream(cmpImageFiles[i].FullName, FileMode.Open, FileAccess.Read);
+ bool cmpResult = CompareStreams(is1, is2);
+ is1.Close();
+ is2.Close();
+ if (!cmpResult) {
+ differentPagesFail = " Page is different!";
+ diffPages.Add(i + 1);
+ if (compareExecIsOk) {
+ String currCompareParams = compareParams.Replace("", imageFiles[i].FullName).Replace("", cmpImageFiles
+ [i].FullName).Replace("", outPath + differenceImagePrefix + iText.IO.Util.JavaUtil.IntegerToString
+ (i + 1) + ".png");
+ if (SystemUtil.RunProcessAndWait(compareExec, currCompareParams)) {
+ differentPagesFail += "\nPlease, examine " + outPath + differenceImagePrefix + iText.IO.Util.JavaUtil.IntegerToString
+ (i + 1) + ".png for more details.";
+ }
+ }
+ System.Console.Out.WriteLine(differentPagesFail);
+ }
+ else {
+ System.Console.Out.WriteLine(" done.");
+ }
+ }
+ if (differentPagesFail != null) {
+ String errorMessage = differentPages.Replace("", outPdf).Replace("", ListDiffPagesAsString
+ (diffPages));
+ if (!compareExecIsOk) {
+ errorMessage += "\nYou can optionally specify path to ImageMagick compare tool (e.g. -DcompareExec=\"C:/Program Files/ImageMagick-6.5.4-2/compare.exe\") to visualize differences.";
+ }
+ return errorMessage;
+ }
+ else {
+ if (bUnexpectedNumberOfPages) {
+ return unexpectedNumberOfPages.Replace("", outPdf);
+ }
+ }
+ return null;
+ }
+
+ private String ListDiffPagesAsString(IList diffPages) {
+ StringBuilder sb = new StringBuilder("[");
+ for (int i = 0; i < diffPages.Count; i++) {
+ sb.Append(diffPages[i]);
+ if (i < diffPages.Count - 1) {
+ sb.Append(", ");
+ }
+ }
+ sb.Append("]");
+ return sb.ToString();
+ }
+
+ ///
+ private void CreateIgnoredAreasPdfs(String outPath, IDictionary> ignoredAreas) {
+ PdfWriter outWriter = new PdfWriter(outPath + ignoredAreasPrefix + outPdfName);
+ PdfWriter cmpWriter = new PdfWriter(outPath + ignoredAreasPrefix + cmpPdfName);
+ PdfDocument pdfOutDoc = new PdfDocument(new PdfReader(outPdf), outWriter);
+ PdfDocument pdfCmpDoc = new PdfDocument(new PdfReader(cmpPdf), cmpWriter);
+ foreach (KeyValuePair> entry in ignoredAreas) {
+ int pageNumber = entry.Key;
+ IList rectangles = entry.Value;
+ if (rectangles != null && !rectangles.IsEmpty()) {
+ PdfCanvas outCanvas = new PdfCanvas(pdfOutDoc.GetPage(pageNumber));
+ PdfCanvas cmpCanvas = new PdfCanvas(pdfCmpDoc.GetPage(pageNumber));
+ outCanvas.SaveState();
+ cmpCanvas.SaveState();
+ foreach (Rectangle rect in rectangles) {
+ outCanvas.Rectangle(rect).Fill();
+ cmpCanvas.Rectangle(rect).Fill();
+ }
+ outCanvas.RestoreState();
+ cmpCanvas.RestoreState();
+ }
+ }
+ pdfOutDoc.Close();
+ pdfCmpDoc.Close();
+ Init(outPath + ignoredAreasPrefix + outPdfName, outPath + ignoredAreasPrefix + cmpPdfName);
+ }
+
+ private void PrepareOutputDirs(String outPath, String differenceImagePrefix) {
+ FileInfo[] imageFiles;
+ FileInfo[] cmpImageFiles;
+ FileInfo[] diffFiles;
+ if (!FileUtil.DirectoryExists(outPath)) {
+ FileUtil.CreateDirectories(outPath);
+ }
+ else {
+ imageFiles = FileUtil.ListFilesInDirectoryByFilter(outPath, new CompareTool.PngFileFilter(this));
+ foreach (FileInfo file in imageFiles) {
+ file.Delete();
+ }
+ cmpImageFiles = FileUtil.ListFilesInDirectoryByFilter(outPath, new CompareTool.CmpPngFileFilter(this));
+ foreach (FileInfo file_1 in cmpImageFiles) {
+ file_1.Delete();
+ }
+ diffFiles = FileUtil.ListFilesInDirectoryByFilter(outPath, new CompareTool.DiffPngFileFilter(this, differenceImagePrefix
+ ));
+ foreach (FileInfo file_2 in diffFiles) {
+ file_2.Delete();
+ }
+ }
+ }
+
+ /// Runs ghostscript to create images of pdfs.
+ /// Path to the output folder.
+ /// Returns null if result is successful, else returns error message.
+ ///
+ ///
+ private String RunGhostScriptImageGeneration(String outPath) {
+ if (!FileUtil.DirectoryExists(outPath)) {
+ return cannotOpenOutputDirectory.Replace("", outPdf);
+ }
+ String currGsParams = gsParams.Replace("", outPath + cmpImage).Replace("