Reconstruct checkbox type when its in Apearance characteristics

DEVSIX-2121

Author: guustysebie

commons/src/main/java/com/itextpdf/commons/datastructures/NullableContainer.java

@@ -0,0 +1,30 @@
+package com.itextpdf.commons.datastructures;
+
+/**
+ * A simple container that can hold a value.
+ * This is class is used to make the autoporting of primitive types easier.
+ * For example autoporting enums will convert them to non nullable types.
+ * But if you embed them in a NullableContainer, the autoporting will convert them to nullable types.
+ */
+public class NullableContainer<T> {
+
+    private final T value;
+
+    /**
+     * Creates a new {@link NullableContainer} instance.
+     *
+     * @param value the value
+     */
+    public NullableContainer(T value) {
+        this.value = value;
+    }
+
+    /**
+     * Gets the value.
+     *
+     * @return the value
+     */
+    public T getValue() {
+        return value;
+    }
+}

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

@@ -22,9 +22,11 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.forms.fields;
 
+import com.itextpdf.commons.datastructures.NullableContainer;
 import com.itextpdf.commons.utils.ExperimentalFeatures;
 import com.itextpdf.commons.utils.MessageFormatUtil;
 import com.itextpdf.forms.fields.borders.FormBorderFactory;
+import com.itextpdf.forms.fields.properties.CheckBoxType;
 import com.itextpdf.forms.form.FormProperty;
 import com.itextpdf.forms.form.element.Button;
 import com.itextpdf.forms.form.element.CheckBox;
@@ -74,7 +76,6 @@ This file is part of the iText (R) project.
 import com.itextpdf.layout.properties.Leading;
 import com.itextpdf.layout.properties.OverflowPropertyValue;
 import com.itextpdf.layout.properties.Property;
-import com.itextpdf.layout.properties.RenderingMode;
 import com.itextpdf.layout.properties.TextAlignment;
 import com.itextpdf.layout.properties.TransparentColor;
 import com.itextpdf.layout.properties.UnitValue;
@@ -1228,6 +1229,7 @@ protected void drawCheckBoxAndSaveAppearance(String onStateName) {
         if (rect == null) {
             return;
         }
+        reconstructCheckBoxType();
         createCheckBox();
         if (getWidget().getNormalAppearanceObject() == null) {
             getWidget().setNormalAppearance(new PdfDictionary());
@@ -1258,11 +1260,12 @@ protected void drawCheckBoxAndSaveAppearance(String onStateName) {
         getWidget().setNormalAppearance(normalAppearance);
 
         final PdfDictionary mk = new PdfDictionary();
+
         // We put the zapfDingbats code of the checkbox in the MK dictionary to make sure there is a way
         // to retrieve the checkbox type even if the appearance is not present.
         mk.put(PdfName.CA,
-                new PdfString(PdfCheckBoxRenderingStrategy.CHECKBOX_TYPE_ZAPFDINGBATS_CODE.get(parent.checkType)));
-
+                new PdfString(PdfCheckBoxRenderingStrategy.ZAPFDINGBATS_CHECKBOX_MAPPING.getByKey(
+                        parent.checkType.getValue())));
         getWidget().put(PdfName.MK, mk);
         setCheckBoxAppearanceState(onStateName);
     }
@@ -1277,6 +1280,29 @@ private void setCheckBoxAppearanceState(String onStateName) {
         }
     }
 
+    private void reconstructCheckBoxType() {
+
+        // if checkbox type is null it means we are reading from a document and we need to retrieve the type from the
+        // mk dictionary in the ca
+        if (parent.checkType == null) {
+            PdfDictionary oldMk = getWidget().getAppearanceCharacteristics();
+            if (oldMk != null) {
+                PdfString oldCa = oldMk.getAsString(PdfName.CA);
+                if (oldCa != null && PdfCheckBoxRenderingStrategy.ZAPFDINGBATS_CHECKBOX_MAPPING.containsValue(
+                        oldCa.getValue())) {
+                    parent.checkType = new NullableContainer<>(
+                            PdfCheckBoxRenderingStrategy.ZAPFDINGBATS_CHECKBOX_MAPPING.getByValue(oldCa.getValue()));
+                    // we need to set the font size to 0 to make sure the font size is recalculated
+                    fontSize = 0;
+                }
+            }
+        }
+        // if its still null default to default value
+        if (parent.checkType == null) {
+            parent.checkType = new NullableContainer<>(CheckBoxType.CROSS);
+        }
+    }
+
     private void createCheckBox() {
         if (!(formFieldElement instanceof CheckBox)) {
             // Create it one time and re-set properties during each widget regeneration.
@@ -1287,7 +1313,7 @@ private void createCheckBox() {
         formFieldElement.setProperty(Property.FONT_SIZE, UnitValue.createPointValue(getFontSize()));
         setModelElementProperties(getRect(getPdfObject()));
         ((CheckBox) formFieldElement).setPdfAConformanceLevel(getPdfAConformanceLevel());
-        ((CheckBox) formFieldElement).setCheckBoxType(parent.checkType);
+        ((CheckBox) formFieldElement).setCheckBoxType(parent.checkType.getValue());
     }
 
     private void setModelElementProperties(Rectangle rectangle) {

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

@@ -22,6 +22,7 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.forms.fields;
 
+import com.itextpdf.commons.datastructures.NullableContainer;
 import com.itextpdf.commons.utils.Base64;
 import com.itextpdf.commons.utils.MessageFormatUtil;
 import com.itextpdf.forms.PdfAcroForm;
@@ -119,7 +120,7 @@ public class PdfFormField extends AbstractPdfFormField {
     protected ImageData img;
     protected PdfFormXObject form;
 
-    protected CheckBoxType checkType = CheckBoxType.CROSS;
+    protected NullableContainer<CheckBoxType> checkType = null;
 
     private String displayValue;
 
@@ -1065,7 +1066,7 @@ public PdfFormField setCheckType(CheckBoxType checkType) {
         if (checkType == null) {
             checkType = CheckBoxType.CROSS;
         }
-        this.checkType = checkType;
+        this.checkType = new NullableContainer<>(checkType);
         if (getPdfAConformanceLevel() != null) {
             return this;
         }

forms/src/main/java/com/itextpdf/forms/form/renderer/checkboximpl/PdfCheckBoxRenderingStrategy.java

@@ -22,6 +22,7 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.forms.form.renderer.checkboximpl;
 
+import com.itextpdf.commons.datastructures.BiMap;
 import com.itextpdf.forms.fields.properties.CheckBoxType;
 import com.itextpdf.forms.form.renderer.CheckBoxRenderer;
 import com.itextpdf.forms.logs.FormsLogMessageConstants;
@@ -38,25 +39,20 @@ This file is part of the iText (R) project.
 import com.itextpdf.layout.properties.Property;
 import com.itextpdf.layout.renderer.DrawContext;
 
-import java.util.Collections;
-import java.util.HashMap;
-import java.util.Map;
-
 /**
  * This class is used to draw a checkBox icon in PDF mode this is the default strategy for drawing a checkBox.
  */
 public final class PdfCheckBoxRenderingStrategy implements ICheckBoxRenderingStrategy {
-    public static final Map<CheckBoxType, String> CHECKBOX_TYPE_ZAPFDINGBATS_CODE;
+    public static final BiMap<CheckBoxType, String> ZAPFDINGBATS_CHECKBOX_MAPPING;
 
     static {
-        Map<CheckBoxType, String> initialMap = new HashMap<>();
-        initialMap.put(CheckBoxType.CHECK, "4");
-        initialMap.put(CheckBoxType.CIRCLE, "l");
-        initialMap.put(CheckBoxType.CROSS, "8");
-        initialMap.put(CheckBoxType.DIAMOND, "u");
-        initialMap.put(CheckBoxType.SQUARE, "n");
-        initialMap.put(CheckBoxType.STAR, "H");
-        CHECKBOX_TYPE_ZAPFDINGBATS_CODE = Collections.unmodifiableMap(initialMap);
+        ZAPFDINGBATS_CHECKBOX_MAPPING = new BiMap<>();
+        ZAPFDINGBATS_CHECKBOX_MAPPING.put(CheckBoxType.CHECK, "4");
+        ZAPFDINGBATS_CHECKBOX_MAPPING.put(CheckBoxType.CIRCLE, "l");
+        ZAPFDINGBATS_CHECKBOX_MAPPING.put(CheckBoxType.CROSS, "8");
+        ZAPFDINGBATS_CHECKBOX_MAPPING.put(CheckBoxType.DIAMOND, "u");
+        ZAPFDINGBATS_CHECKBOX_MAPPING.put(CheckBoxType.SQUARE, "n");
+        ZAPFDINGBATS_CHECKBOX_MAPPING.put(CheckBoxType.STAR, "H");
 
     }
 
@@ -93,7 +89,7 @@ public void drawCheckBoxContent(DrawContext drawContext, CheckBoxRenderer checkB
             final float customBorderWidth = border == null ? 1 : borderWidth;
             DrawingUtil.drawCross(canvas, rectangle.getWidth(), rectangle.getHeight(), customBorderWidth);
         } else {
-            final String text = CHECKBOX_TYPE_ZAPFDINGBATS_CODE.get(checkBoxType);
+            final String text = ZAPFDINGBATS_CHECKBOX_MAPPING.getByKey(checkBoxType);
             final PdfFont fontContainingSymbols = loadFontContainingSymbols();
             float fontSize = calculateFontSize(checkBoxRenderer, fontContainingSymbols, text, rectangle, borderWidth);
             drawZapfdingbatsIcon(fontContainingSymbols, text, fontSize, rectangle, canvas);

forms/src/test/java/com/itextpdf/forms/PdfCheckBoxFieldTest.java

@@ -233,7 +233,7 @@ public void keepCheckTypeTest() throws IOException, InterruptedException {
 
         try (PdfDocument pdfDoc = new PdfDocument(new PdfReader(srcPdf), new PdfWriter(outPdf))) {
             PdfAcroForm form = PdfAcroForm.getAcroForm(pdfDoc, true);
-            form.getField("checkField").setValue("Yes", false);
+            form.getField("checkField").setValue("Yes");
         }
 
         Assert.assertNull(new CompareTool().compareByContent(outPdf, cmpPdf, destinationFolder, "diff_"));