Merge branch 'develop' of ssh://git.itextsupport.com:7999/i7j/itextcore into develop

Author: joris.schellekens

forms/src/main/java/com/itextpdf/forms/fields/PdfFormField.java

@@ -86,8 +86,6 @@ This file is part of the iText (R) project.
 import com.itextpdf.layout.property.Property;
 import com.itextpdf.layout.property.TextAlignment;
 import com.itextpdf.layout.property.VerticalAlignment;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
@@ -96,6 +94,9 @@ This file is part of the iText (R) project.
 import java.util.List;
 import java.util.Set;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 /**
  * This class represents a single field or field group in an {@link com.itextpdf.forms.PdfAcroForm
  * AcroForm}.
@@ -1911,6 +1912,7 @@ public boolean regenerateField() {
                 appearance.getResources().addFont(getDocument(), localFont);
                 PdfDictionary ap = new PdfDictionary();
                 ap.put(PdfName.N, appearance.getPdfObject());
+                ap.setModified();
                 put(PdfName.AP, ap);
 
                 return true;

forms/src/test/resources/com/itextpdf/forms/FormFieldsTaggingTest/cmp_taggedPdfWithForms01.pdf

@@ -73,7 +73,6 @@ public class PdfPage extends PdfObjectWrapper<PdfDictionary> {
     private static final long serialVersionUID = -952395541908379500L;
 	private PdfResources resources = null;
     private int mcid = -1;
-    private int structParents = -1;
     PdfPages parentPages;
     private List<PdfName> excludedKeys = new ArrayList<>(Arrays.asList(
             PdfName.Parent,
@@ -106,8 +105,6 @@ protected PdfPage(PdfDocument pdfDocument, PageSize pageSize) {
         getPdfObject().put(PdfName.MediaBox, new PdfArray(pageSize));
         getPdfObject().put(PdfName.TrimBox, new PdfArray(pageSize));
         if (pdfDocument.isTagged()) {
-            structParents = (int) pdfDocument.getNextStructParentIndex();
-            getPdfObject().put(PdfName.StructParents, new PdfNumber(structParents));
             setTabOrder(PdfName.S);
         }
     }
@@ -391,10 +388,6 @@ public PdfPage copyTo(PdfDocument toDocument, IPdfPageExtraCopier copier) {
                 page.addAnnotation(-1, newAnnot, false);
             }
         }
-        if (toDocument.isTagged()) {
-            page.structParents = (int) toDocument.getNextStructParentIndex();
-            page.getPdfObject().put(PdfName.StructParents, new PdfNumber(page.structParents));
-        }
 
         if (copier != null) {
             copier.copy(this, page);
@@ -720,17 +713,10 @@ public int getNextMcid() {
      * Gets {@link Integer} key of the page’s entry in the structural parent tree.
      *
      * @return {@link Integer} key of the page’s entry in the structural parent tree.
+     * If page has no entry in the structural parent tree, returned value is -1.
      */
     public Integer getStructParentIndex() {
-        if (structParents == -1) {
-            PdfNumber n = getPdfObject().getAsNumber(PdfName.StructParents);
-            if (n != null) {
-                structParents = n.intValue();
-            } else {
-                structParents = (int) getDocument().getNextStructParentIndex();
-            }
-        }
-        return structParents;
+        return getPdfObject().getAsNumber(PdfName.StructParents) != null ? getPdfObject().getAsNumber(PdfName.StructParents).intValue() : -1;
     }
 
     /**

forms/src/test/resources/com/itextpdf/forms/FormFieldsTaggingTest/cmp_taggedPdfWithForms02.pdf

@@ -122,7 +122,7 @@ public PdfObjRef findObjRefByStructParentIndex(PdfDictionary pageDict, int struc
     }
 
     public int getNextMcidForPage(PdfPage page) {
-        TreeMap<Integer, PdfMcr> pageMcrs = pageToPageMcrs.get(page.getPdfObject().getIndirectReference());
+        TreeMap<Integer, PdfMcr> pageMcrs = (TreeMap) getPageMarkedContentReferences(page);
         if (pageMcrs == null || pageMcrs.size() == 0) {
             return 0;
         } else {
@@ -146,7 +146,7 @@ public void createParentTreeEntryForPage(PdfPage page) {
             return;
         }
         pageToPageMcrs.remove(page.getPdfObject().getIndirectReference());
-        updateStructParentTreeEntries(page.getStructParentIndex(), mcrs);
+        updateStructParentTreeEntries(page, mcrs);
         structTreeRoot.setModified();
     }
 
@@ -269,7 +269,7 @@ private void registerAllMcrs() {
         }
     }
 
-    private void updateStructParentTreeEntries(Integer pageStructParentIndex, Map<Integer, PdfMcr> mcrs) {
+    private void updateStructParentTreeEntries(PdfPage page, Map<Integer, PdfMcr> mcrs) {
         // element indexes in parentsOfPageMcrs shall be the same as mcid of one of their kids.
         // See "Finding Structure Elements from Content Items" in pdf spec.
         PdfArray parentsOfPageMcrs = new PdfArray();
@@ -289,10 +289,11 @@ private void updateStructParentTreeEntries(Integer pageStructParentIndex, Map<In
             }
         }
 
-
         if (parentsOfPageMcrs.size() > 0) {
             parentsOfPageMcrs.makeIndirect(structTreeRoot.getDocument());
-            parentTree.addEntry(pageStructParentIndex, parentsOfPageMcrs);
+            int structParents = (int) page.getStructParentIndex() != -1 ? (int) page.getStructParentIndex() : (int) page.getDocument().getNextStructParentIndex();
+            page.getPdfObject().put(PdfName.StructParents, new PdfNumber(structParents));
+            parentTree.addEntry((Integer) structParents, parentsOfPageMcrs);
             structTreeRoot.getDocument().checkIsoConformance(parentsOfPageMcrs, IsoKey.TAG_STRUCTURE_ELEMENT);
             parentsOfPageMcrs.flush();
         }

forms/src/test/resources/com/itextpdf/forms/FormFieldsTaggingTest/cmp_taggedPdfWithForms03.pdf

@@ -187,6 +187,25 @@ public CompareResult compareByCatalog(PdfDocument outDocument, PdfDocument cmpDo
         Set<PdfName> ignoredCatalogEntries = new LinkedHashSet<>(Arrays.asList(PdfName.Metadata));
         compareDictionariesExtended(outDocument.getCatalog().getPdfObject(), cmpDocument.getCatalog().getPdfObject(),
                 catalogPath, compareResult, ignoredCatalogEntries);
+
+        // Method compareDictionariesExtended eventually calls compareObjects method which doesn't compare page objects.
+        // At least for now compare page dictionaries explicitly here like this.
+        if (cmpPagesRef == null || outPagesRef == null) {
+            return compareResult;
+        }
+
+        if (outPagesRef.size() != cmpPagesRef.size() && !compareResult.isMessageLimitReached()) {
+            compareResult.addError(catalogPath, "Documents have different numbers of pages.");
+        }
+        for (int i = 0; i < Math.min(cmpPagesRef.size(), outPagesRef.size()); i++) {
+            if (compareResult.isMessageLimitReached()) {
+                break;
+            }
+            ObjectPath currentPath = new ObjectPath(cmpPagesRef.get(i), outPagesRef.get(i));
+            PdfDictionary outPageDict = (PdfDictionary) outPagesRef.get(i).getRefersTo();
+            PdfDictionary cmpPageDict = (PdfDictionary) cmpPagesRef.get(i).getRefersTo();
+            compareDictionariesExtended(outPageDict, cmpPageDict, currentPath, compareResult);
+        }
         return compareResult;
     }