Unify appearance generation for radio and check buttons

DEVSIX-2172

Author: pavel-alay

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

@@ -797,11 +797,7 @@ public static PdfFormField createRadioButton(PdfDocument doc, Rectangle rect, Pd
         } else {
             annot.setAppearanceState(new PdfName("Off"));
         }
-        if (pdfAConformanceLevel != null && "1".equals(pdfAConformanceLevel.getPart())) {
-            radio.drawPdfA1RadioAppearance(rect.getWidth(), rect.getHeight(), value);
-        } else {
-            radio.drawRadioAppearance(rect.getWidth(), rect.getHeight(), value);
-        }
+        radio.drawRadioAppearance(rect.getWidth(), rect.getHeight(), value);
 
         radioGroup.addKid(radio);
         return radio;
@@ -922,27 +918,16 @@ public static PdfButtonFormField createCheckBox(PdfDocument doc, Rectangle rect,
         PdfWidgetAnnotation annot = new PdfWidgetAnnotation(rect);
         PdfButtonFormField check = new PdfButtonFormField(annot, doc);
         check.pdfAConformanceLevel = pdfAConformanceLevel;
-        if (null != pdfAConformanceLevel) {
-            annot.setFlag(PdfAnnotation.PRINT);
-        }
         check.setCheckType(checkType);
         check.setFieldName(name);
         check.put(PdfName.V, new PdfName(value));
         annot.setAppearanceState(new PdfName(value));
-        String pdfAVersion = pdfAConformanceLevel != null ? pdfAConformanceLevel.getPart() : "";
-        switch (pdfAVersion) {
-            case "1":
-                check.drawPdfA1CheckAppearance(rect.getWidth(), rect.getHeight(), "Off".equals(value) ? "Yes" : value, checkType);
-                break;
-            case "2":
-                check.drawPdfA2CheckAppearance(rect.getWidth(), rect.getHeight(), "Off".equals(value) ? "Yes" : value, checkType);
-                break;
-            case "3":
-                check.drawPdfA2CheckAppearance(rect.getWidth(), rect.getHeight(), "Off".equals(value) ? "Yes" : value, checkType);
-                break;
-            default:
-                check.drawCheckAppearance(rect.getWidth(), rect.getHeight(), "Off".equals(value) ? "Yes" : value);
-                break;
+
+        if (pdfAConformanceLevel != null) {
+            check.drawPdfA2CheckAppearance(rect.getWidth(), rect.getHeight(), "Off".equals(value) ? "Yes" : value, checkType);
+            annot.setFlag(PdfAnnotation.PRINT);
+        } else {
+            check.drawCheckAppearance(rect.getWidth(), rect.getHeight(), "Off".equals(value) ? "Yes" : value);
         }
 
         return check;
@@ -2125,11 +2110,7 @@ public boolean regenerateField() {
                     Rectangle rect = getRect(getPdfObject());
                     value = getRadioButtonValue(value);
                     if (rect != null && !"".equals(value)) {
-                        if (pdfAConformanceLevel != null && "1".equals(pdfAConformanceLevel.getPart())) {
-                            drawPdfA1RadioAppearance(rect.getWidth(), rect.getHeight(), value);
-                        } else {
-                            drawRadioAppearance(rect.getWidth(), rect.getHeight(), value);
-                        }
+                        drawRadioAppearance(rect.getWidth(), rect.getHeight(), value);
                     }
                 } else if (getKids() != null) {
                     for (PdfObject kid : getKids()) {
@@ -2149,29 +2130,18 @@ public boolean regenerateField() {
                     }
                 }
             } else {
-                String onStateName = value;
-                if ("Off".equals(onStateName)) {
-                    onStateName = "Yes";
-                }
                 Rectangle rect = getRect(getPdfObject());
                 setCheckType(checkType);
 
-                String pdfAVersion = pdfAConformanceLevel != null ? pdfAConformanceLevel.getPart() : "";
-                switch (pdfAVersion) {
-                    case "1":
-                        drawPdfA1CheckAppearance(rect.getWidth(), rect.getHeight(), value, checkType);
-                        break;
-                    case "2":
-                        drawPdfA2CheckAppearance(rect.getWidth(), rect.getHeight(), onStateName, checkType);
-                        break;
-                    case "3":
-                        drawPdfA2CheckAppearance(rect.getWidth(), rect.getHeight(), onStateName, checkType);
-                        break;
-                    default:
-                        drawCheckAppearance(rect.getWidth(), rect.getHeight(), onStateName);
-                        break;
-                }
                 PdfWidgetAnnotation widget = getWidgets().get(0);
+
+                if (pdfAConformanceLevel != null) {
+                    drawPdfA2CheckAppearance(rect.getWidth(), rect.getHeight(), "Off".equals(value) ? "Yes" : value, checkType);
+                    widget.setFlag(PdfAnnotation.PRINT);
+                } else {
+                    drawCheckAppearance(rect.getWidth(), rect.getHeight(), "Off".equals(value) ? "Yes" : value);
+                }
+
                 if (widget.getNormalAppearanceObject() != null && widget.getNormalAppearanceObject().containsKey(new PdfName(value))) {
                     widget.setAppearanceState(new PdfName(value));
                 } else {
@@ -3075,7 +3045,9 @@ protected void drawRadioAppearance(float width, float height, String value) {
      * @param width  the width of the radio button to draw
      * @param height the height of the radio button to draw
      * @param value  the value of the button
+     * @deprecated Please, use {@link #drawRadioAppearance(float, float, String)} instead.
      */
+    @Deprecated
     protected void drawPdfA1RadioAppearance(float width, float height, String value) {
         PdfStream stream = (PdfStream) new PdfStream().makeIndirect(getDocument());
         PdfCanvas canvas = new PdfCanvas(stream, new PdfResources(), getDocument());
@@ -3120,54 +3092,65 @@ protected void drawRadioField(PdfCanvas canvas, float width, float height, boole
      * @param onStateName the state of the form field that will be drawn
      */
     protected void drawCheckAppearance(float width, float height, String onStateName) {
+        float fontSize = this.fontSize < 0 ? 0 : this.fontSize;
+        Rectangle rect = new Rectangle(0, 0, width, height);
+
         PdfStream streamOn = (PdfStream) new PdfStream().makeIndirect(getDocument());
         PdfCanvas canvasOn = new PdfCanvas(streamOn, new PdfResources(), getDocument());
-        Rectangle rect = new Rectangle(0, 0, width, height);
         PdfFormXObject xObjectOn = new PdfFormXObject(rect);
-        PdfFormXObject xObjectOff = new PdfFormXObject(rect);
-
-        float fontSize = this.fontSize < 0 ? 0 : this.fontSize;
         drawBorder(canvasOn, xObjectOn, width, height);
         drawCheckBox(canvasOn, width, height, fontSize, true);
+        xObjectOn.getPdfObject().getOutputStream().writeBytes(streamOn.getBytes());
+        xObjectOn.getResources().addFont(getDocument(), getFont());
+
 
         PdfStream streamOff = (PdfStream) new PdfStream().makeIndirect(getDocument());
         PdfCanvas canvasOff = new PdfCanvas(streamOff, new PdfResources(), getDocument());
+        PdfFormXObject xObjectOff = new PdfFormXObject(rect);
         drawBorder(canvasOff, xObjectOff, width, height);
         drawCheckBox(canvasOff, width, height, fontSize, false);
-
-        PdfWidgetAnnotation widget = getWidgets().get(0);
-
-        xObjectOn.getPdfObject().getOutputStream().writeBytes(streamOn.getBytes());
-        xObjectOn.getResources().addFont(getDocument(), getFont());
-        setDefaultAppearance(generateDefaultAppearanceString(font, fontSize, color, xObjectOn.getResources()));
-
         xObjectOff.getPdfObject().getOutputStream().writeBytes(streamOff.getBytes());
         xObjectOff.getResources().addFont(getDocument(), getFont());
 
+        setDefaultAppearance(generateDefaultAppearanceString(font, fontSize, color, xObjectOn.getResources()));
+
         PdfDictionary normalAppearance = new PdfDictionary();
         normalAppearance.put(new PdfName(onStateName), xObjectOn.getPdfObject());
         normalAppearance.put(new PdfName("Off"), xObjectOff.getPdfObject());
 
         PdfDictionary mk = new PdfDictionary();
         mk.put(PdfName.CA, new PdfString(text));
+
+        PdfWidgetAnnotation widget = getWidgets().get(0);
         widget.getPdfObject().put(PdfName.MK, mk);
         widget.setNormalAppearance(normalAppearance);
     }
 
-    protected void drawPdfA1CheckAppearance(float width, float height, String selectedValue, int checkType) {
-        PdfStream stream = (PdfStream) new PdfStream().makeIndirect(getDocument());
-        PdfCanvas canvas = new PdfCanvas(stream, new PdfResources(), getDocument());
+    //Actually it's just PdfA check appearance. According to corrigendum there is no difference between them
+    protected void drawPdfA2CheckAppearance(float width, float height, String onStateName, int checkType) {
+        this.checkType = checkType;
         Rectangle rect = new Rectangle(0, 0, width, height);
-        PdfFormXObject xObject = new PdfFormXObject(rect);
 
-        this.checkType = checkType;
-        drawBorder(canvas, xObject, width, height);
-        drawPdfACheckBox(canvas, width, height, !"Off".equals(selectedValue));
+        PdfStream streamOn = (PdfStream) new PdfStream().makeIndirect(getDocument());
+        PdfCanvas canvasOn = new PdfCanvas(streamOn, new PdfResources(), getDocument());
+        PdfFormXObject xObjectOn = new PdfFormXObject(rect);
+        xObjectOn.getResources();
 
-        xObject.getPdfObject().getOutputStream().writeBytes(stream.getBytes());
+        drawBorder(canvasOn, xObjectOn, width, height);
+        drawPdfACheckBox(canvasOn, width, height, true);
+        xObjectOn.getPdfObject().getOutputStream().writeBytes(streamOn.getBytes());
+
+        PdfStream streamOff = (PdfStream) new PdfStream().makeIndirect(getDocument());
+        PdfCanvas canvasOff = new PdfCanvas(streamOff, new PdfResources(), getDocument());
+        PdfFormXObject xObjectOff = new PdfFormXObject(rect);
+        xObjectOff.getResources();
+
+        drawBorder(canvasOff, xObjectOff, width, height);
+        xObjectOff.getPdfObject().getOutputStream().writeBytes(streamOff.getBytes());
 
         PdfDictionary normalAppearance = new PdfDictionary();
-        normalAppearance.put(new PdfName(selectedValue), xObject.getPdfObject());
+        normalAppearance.put(new PdfName(onStateName), xObjectOn.getPdfObject());
+        normalAppearance.put(new PdfName("Off"), xObjectOff.getPdfObject());
 
         PdfDictionary mk = new PdfDictionary();
         mk.put(PdfName.CA, new PdfString(text));
@@ -3177,33 +3160,29 @@ protected void drawPdfA1CheckAppearance(float width, float height, String select
         widget.setNormalAppearance(normalAppearance);
     }
 
-    protected void drawPdfA2CheckAppearance(float width, float height, String onStateName, int checkType) {
-        PdfStream streamOn = (PdfStream) new PdfStream().makeIndirect(getDocument());
-        PdfCanvas canvasOn = new PdfCanvas(streamOn, new PdfResources(), getDocument());
-        PdfStream streamOff = (PdfStream) new PdfStream().makeIndirect(getDocument());
-        PdfCanvas canvasOff = new PdfCanvas(streamOff, new PdfResources(), getDocument());
+    /**
+     * @deprecated use {@link #drawPdfA2CheckAppearance(float, float, String, int)} instead.
+     */
+    @Deprecated
+    protected void drawPdfA1CheckAppearance(float width, float height, String selectedValue, int checkType) {
+        PdfStream stream = (PdfStream) new PdfStream().makeIndirect(getDocument());
+        PdfCanvas canvas = new PdfCanvas(stream, new PdfResources(), getDocument());
         Rectangle rect = new Rectangle(0, 0, width, height);
-        PdfFormXObject xObjectOn = new PdfFormXObject(rect);
-        PdfFormXObject xObjectOff = new PdfFormXObject(rect);
+        PdfFormXObject xObject = new PdfFormXObject(rect);
 
         this.checkType = checkType;
-        drawBorder(canvasOn, xObjectOn, width, height);
-        drawPdfACheckBox(canvasOn, width, height, true);
-        drawBorder(canvasOff, xObjectOff, width, height);
-
-        PdfWidgetAnnotation widget = getWidgets().get(0);
+        drawBorder(canvas, xObject, width, height);
+        drawPdfACheckBox(canvas, width, height, !"Off".equals(selectedValue));
 
-        xObjectOn.getPdfObject().getOutputStream().writeBytes(streamOn.getBytes());
-        xObjectOff.getPdfObject().getOutputStream().writeBytes(streamOff.getBytes());
-        xObjectOn.getResources();
-        xObjectOff.getResources();
+        xObject.getPdfObject().getOutputStream().writeBytes(stream.getBytes());
 
         PdfDictionary normalAppearance = new PdfDictionary();
-        normalAppearance.put(new PdfName(onStateName), xObjectOn.getPdfObject());
-        normalAppearance.put(new PdfName("Off"), xObjectOff.getPdfObject());
+        normalAppearance.put(new PdfName(selectedValue), xObject.getPdfObject());
 
         PdfDictionary mk = new PdfDictionary();
         mk.put(PdfName.CA, new PdfString(text));
+
+        PdfWidgetAnnotation widget = getWidgets().get(0);
         widget.put(PdfName.MK, mk);
         widget.setNormalAppearance(normalAppearance);
     }

kernel/src/main/java/com/itextpdf/kernel/pdf/PdfAConformanceLevel.java

@@ -65,8 +65,8 @@ public class PdfAConformanceLevel implements Serializable {
     public static final PdfAConformanceLevel PDF_A_3U = new PdfAConformanceLevel("3", "U");
     private static final long serialVersionUID = 1481878095812910587L;
 
-    private String conformance;
-    private String part;
+    private final String conformance;
+    private final String part;
 
     private PdfAConformanceLevel(String part, String conformance) {
         this.conformance = conformance;