Add AppearanceResources and AppearanceXObject

Those classes will save font names from default resources.
Update javadoc for PdfAcroForm#setGenerateAppearance()

DEVSIX-1916

Author: pavel-alay

forms/src/main/java/com/itextpdf/forms/PdfAcroForm.java

@@ -595,6 +595,8 @@ public boolean isGenerateAppearance() {
      * If generateAppearance is set to <code>true</code>, then
      * <code>NeedAppearances</code> is set to <code>false</code>. This does not
      * apply vice versa.
+     * <p>
+     * Note, this method does not change default behaviour of {@link PdfFormField#setValue(String)} method.
      *
      * @param generateAppearance a boolean
      */

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

@@ -0,0 +1,52 @@
+package com.itextpdf.forms.fields;
+
+import com.itextpdf.kernel.font.PdfFont;
+import com.itextpdf.kernel.pdf.PdfDictionary;
+import com.itextpdf.kernel.pdf.PdfDocument;
+import com.itextpdf.kernel.pdf.PdfIndirectReference;
+import com.itextpdf.kernel.pdf.PdfName;
+import com.itextpdf.kernel.pdf.PdfResources;
+
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * AppearanceResources allows to register font names that will be used as resource name.
+ * Preserving existed font names in default resources of AcroForm is the only goal of this class.
+ * <p>
+ * Shall be used only in {@link PdfFormField}.
+ *
+ * @see AppearanceXObject
+ */
+class AppearanceResources extends PdfResources {
+
+    private static final long serialVersionUID = -1991503804376023468L;
+
+    private Map<PdfIndirectReference, PdfName> drFonts = new HashMap<>();
+
+    AppearanceResources(PdfDictionary pdfObject) {
+        super(pdfObject);
+    }
+
+    void addFontFromDefaultResources(PdfName name, PdfFont font) {
+        if (name != null && font != null && font.getPdfObject().getIndirectReference() != null) {
+            //So, most likely it's a document PdfFont
+            drFonts.put(font.getPdfObject().getIndirectReference(), name);
+        }
+    }
+
+    @Override
+    public PdfName addFont(PdfDocument pdfDocument, PdfFont font) {
+        PdfName fontName = null;
+        if (font != null && font.getPdfObject().getIndirectReference() != null) {
+            fontName = drFonts.get(font.getPdfObject().getIndirectReference());
+        }
+
+        if (fontName != null) {
+            addResource(font.getPdfObject(), PdfName.Font, fontName);
+            return fontName;
+        } else {
+            return super.addFont(pdfDocument, font);
+        }
+    }
+}

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

@@ -0,0 +1,49 @@
+package com.itextpdf.forms.fields;
+
+import com.itextpdf.kernel.font.PdfFont;
+import com.itextpdf.kernel.geom.Rectangle;
+import com.itextpdf.kernel.pdf.PdfDictionary;
+import com.itextpdf.kernel.pdf.PdfName;
+import com.itextpdf.kernel.pdf.PdfResources;
+import com.itextpdf.kernel.pdf.PdfStream;
+import com.itextpdf.kernel.pdf.xobject.PdfFormXObject;
+
+/**
+ * AppearanceXObject allows font names registration. Those names will be used as resource name
+ * for a particular {@link PdfFont}.
+ * <p>
+ * Preserving existed font names in default resources of AcroForm is the only goal of this class.
+ * <p>
+ * Shall be used only in {@link PdfFormField}.
+ */
+class AppearanceXObject extends PdfFormXObject {
+
+    private static final long serialVersionUID = 6098843657444897565L;
+
+    AppearanceXObject(PdfStream pdfStream) {
+        super(pdfStream);
+    }
+
+    AppearanceXObject(Rectangle bBox) {
+        super(bBox);
+    }
+
+    void addFontFromDR(PdfName fontName, PdfFont font) {
+        if (fontName != null && font != null) {
+            ((AppearanceResources) getResources()).addFontFromDefaultResources(fontName, font);
+        }
+    }
+
+    @Override
+    public PdfResources getResources() {
+        if (this.resources == null) {
+            PdfDictionary resourcesDict = getPdfObject().getAsDictionary(PdfName.Resources);
+            if (resourcesDict == null) {
+                resourcesDict = new PdfDictionary();
+                getPdfObject().put(PdfName.Resources, resourcesDict);
+            }
+            this.resources = new AppearanceResources(resourcesDict);
+        }
+        return resources;
+    }
+}

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

@@ -876,7 +876,7 @@ public static PdfButtonFormField createPushButton(PdfDocument doc, Rectangle rec
         field.fontSize = fontSize;
         field.backgroundColor = ColorConstants.LIGHT_GRAY;
 
-        PdfFormXObject xObject = field.drawPushButtonAppearance(rect.getWidth(), rect.getHeight(), caption, font, fontSize);
+        PdfFormXObject xObject = field.drawPushButtonAppearance(rect.getWidth(), rect.getHeight(), caption, font, null, fontSize);
         annot.setNormalAppearance(xObject.getPdfObject());
 
         PdfDictionary mk = new PdfDictionary();
@@ -1962,6 +1962,7 @@ public boolean regenerateField() {
 
                 Object[] fontAndSize = getFontAndSize(asNormal);
                 PdfFont localFont = (PdfFont) fontAndSize[0];
+                PdfName localFontName = (PdfName) fontAndSize[2];
                 float fontSize = normalizeFontSize((float) fontAndSize[1], localFont, bBox, value);
 
                 //Apply Page rotation
@@ -2043,14 +2044,16 @@ public boolean regenerateField() {
                     bBox = new PdfArray(rect);
                 }
                 //Create appearance
-                PdfFormXObject appearance = null;
+                AppearanceXObject appearance = null;
                 if (asNormal != null) {
-                    appearance = new PdfFormXObject(asNormal);
+                    appearance = new AppearanceXObject(asNormal);
+
                     appearance.setBBox(new PdfArray(new float[]{0, 0, bBox.toRectangle().getWidth(), bBox.toRectangle().getHeight()}));
                 }
                 if (appearance == null) {
-                    appearance = new PdfFormXObject(new Rectangle(0, 0, bBox.toRectangle().getWidth(), bBox.toRectangle().getHeight()));
+                    appearance = new AppearanceXObject(new Rectangle(0, 0, bBox.toRectangle().getWidth(), bBox.toRectangle().getHeight()));
                 }
+                appearance.addFontFromDR(localFontName, localFont);
                 appearance.put(PdfName.Matrix, matrix);
                 //Create text appearance
                 if (PdfName.Tx.equals(type)) {
@@ -2099,20 +2102,19 @@ public boolean regenerateField() {
                             apDic = widgets.get(0).getPdfObject().getAsDictionary(PdfName.AP);
                         }
                     }
-                    if (img != null) {
-                        appearance = drawPushButtonAppearance(rect.getWidth(), rect.getHeight(), value, null, 0);
-                    } else if (form != null) {
-                        appearance = drawPushButtonAppearance(rect.getWidth(), rect.getHeight(), value, null, 0);
+                    if (img != null || form != null) {
+                        appearance = drawPushButtonAppearance(rect.getWidth(), rect.getHeight(), value, null, null, 0);
                     } else {
                         PdfStream asNormal = null;
                         if (apDic != null) {
                             asNormal = apDic.getAsStream(PdfName.N);
                         }
                         Object[] fontAndSize = getFontAndSize(asNormal);
                         PdfFont localFont = (PdfFont) fontAndSize[0];
+                        PdfName localFontName = (PdfName) fontAndSize[2];
                         float fontSize = (float) fontAndSize[1];
-                        appearance = drawPushButtonAppearance(rect.getWidth(), rect.getHeight(), value, localFont, fontSize);
-                        appearance.getResources().addFont(getDocument(), localFont);
+                        appearance = drawPushButtonAppearance(rect.getWidth(), rect.getHeight(), value,
+                                localFont, localFontName, fontSize);
                     }
 
                     if (apDic == null) {
@@ -2632,7 +2634,7 @@ protected String generateDefaultAppearanceString(PdfFont font, float fontSize, C
     }
 
     protected Object[] getFontAndSize(PdfDictionary asNormal) throws IOException {
-        Object[] fontAndSize = new Object[2];
+        Object[] fontAndSize = new Object[3];
         PdfDictionary normalResources = null;
         PdfDictionary defaultResources = null;
         PdfDocument document = getDocument();
@@ -2648,6 +2650,7 @@ protected Object[] getFontAndSize(PdfDictionary asNormal) throws IOException {
             if ((normalFontDic != null || defaultFontDic != null) && defaultAppearance != null) {
                 Object[] dab = splitDAelements(defaultAppearance.toUnicodeString());
                 PdfName fontName = new PdfName(dab[DA_FONT].toString());
+                fontAndSize[2] = fontName;
                 PdfDictionary requiredFontDictionary = null;
                 if (normalFontDic != null && null != normalFontDic.getAsDictionary(fontName)) {
                     requiredFontDictionary = normalFontDic.getAsDictionary(fontName);
@@ -2759,7 +2762,10 @@ protected void drawTextAppearance(Rectangle rect, PdfFont font, float fontSize,
         PdfResources resources = appearance.getResources();
         PdfCanvas canvas = new PdfCanvas(stream, resources, getDocument());
 
-        setDefaultAppearance(generateDefaultAppearanceString(font, fontSize, color, resources));
+        //TODO seems that FontName shall be passed
+        if (getDefaultAppearance() == null) {
+            setDefaultAppearance(generateDefaultAppearanceString(font, fontSize, color, resources));
+        }
 
         float height = rect.getHeight();
         float width = rect.getWidth();
@@ -3157,11 +3163,12 @@ protected void drawPdfA2CheckAppearance(float width, float height, String value,
      * @param fontSize the size of the font
      * @return a new {@link PdfFormXObject}
      */
-    protected PdfFormXObject drawPushButtonAppearance(float width, float height, String text, PdfFont font, float fontSize) {
+    protected PdfFormXObject drawPushButtonAppearance(float width, float height, String text,
+                                                      PdfFont font, PdfName fontName, float fontSize) {
         PdfStream stream = (PdfStream) new PdfStream().makeIndirect(getDocument());
         PdfCanvas canvas = new PdfCanvas(stream, new PdfResources(), getDocument());
 
-        PdfFormXObject xObject = new PdfFormXObject(new Rectangle(0, 0, width, height));
+        AppearanceXObject xObject = new AppearanceXObject(new Rectangle(0, 0, width, height));
         drawBorder(canvas, xObject, width, height);
 
         if (img != null) {
@@ -3173,8 +3180,11 @@ protected PdfFormXObject drawPushButtonAppearance(float width, float height, Str
             xObject.getResources().addForm(form);
         } else {
             drawButton(canvas, 0, 0, width, height, text, font, fontSize);
-            setDefaultAppearance(generateDefaultAppearanceString(font, fontSize, color, new PdfResources()));
-            xObject.getResources().addFont(getDocument(), font);
+            xObject.addFontFromDR(fontName, font);
+            if (getDefaultAppearance() == null) {
+                setDefaultAppearance(generateDefaultAppearanceString(font, fontSize, color, new PdfResources()));
+                xObject.getResources().addFont(getDocument(), font);
+            }
         }
         xObject.getPdfObject().getOutputStream().writeBytes(stream.getBytes());
 
@@ -3223,6 +3233,7 @@ protected void drawCheckBox(PdfCanvas canvas, float width, float height, float f
             DrawingUtil.drawCross(canvas, width, height, borderWidth);
             return;
         }
+        //TODO what is current font actually?
         PdfFont ufont = getFont();
         if (fontSize <= 0) {
             fontSize = approximateFontSizeToFitBBox(ufont, new Rectangle(width, height), text);

forms/src/test/resources/com/itextpdf/forms/FormFieldFlatteningTest/cmp_multiLineFormFieldClippingTest_flattened.pdf

@@ -63,7 +63,7 @@ This file is part of the iText (R) project.
 public class PdfFormXObject extends PdfXObject {
 
     private static final long serialVersionUID = 467500482711722178L;
-    private PdfResources resources = null;
+    protected PdfResources resources = null;
 
     /**
      * Creates a new instance of Form XObject.