Initial experimental rendering implementation checkbox

DEVSIX-7361

Author: guustysebie

commons/src/main/java/com/itextpdf/commons/utils/ExperimentalFeatures.java

@@ -0,0 +1,10 @@
+package com.itextpdf.commons.utils;
+
+public final class ExperimentalFeatures {
+    public static boolean ENABLE_EXPERIMENTAL_CHECKBOX_RENDERING = false;
+
+    private ExperimentalFeatures() {
+        // utility class
+    }
+
+}

forms/src/main/java/com/itextpdf/forms/exceptions/FormsExceptionMessageConstant.java

@@ -44,6 +44,7 @@ public final class FormsExceptionMessageConstant {
     public static final String APEARANCE_NAME_MUST_BE_PROVIDED = "Appearance name must be provided";
     public static final String WIDGET_RECTANGLE_MUST_BE_PROVIDED = "Widget rectangle must be provided";
     public static final String EMPTY_RADIO_GROUP_NAME = "Radio group name cannot be empty.";
+    public static final String CHECKBOX_TYPE_NOT_SUPPORTED = "Unsupported checkbox type for PDF/A";
 
     private FormsExceptionMessageConstant(){}
 }

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

@@ -22,6 +22,7 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.forms.fields;
 
+import com.itextpdf.commons.utils.ExperimentalFeatures;
 import com.itextpdf.forms.fields.properties.CheckBoxType;
 import com.itextpdf.kernel.pdf.PdfDocument;
 import com.itextpdf.kernel.pdf.PdfName;
@@ -38,7 +39,7 @@ public class CheckBoxFormFieldBuilder extends TerminalFormFieldBuilder<CheckBoxF
     /**
      * Creates builder for {@link PdfButtonFormField} creation.
      *
-     * @param document document to be used for form field creation
+     * @param document      document to be used for form field creation
      * @param formFieldName name of the form field
      */
     public CheckBoxFormFieldBuilder(PdfDocument document, String formFieldName) {
@@ -58,6 +59,7 @@ public CheckBoxType getCheckType() {
      * Sets check type for checkbox form field. Default value is {@link CheckBoxType#CROSS}.
      *
      * @param checkType check type to be set for checkbox form field
+     *
      * @return this builder
      */
     public CheckBoxFormFieldBuilder setCheckType(CheckBoxType checkType) {
@@ -88,6 +90,14 @@ public PdfButtonFormField createCheckBox() {
         check.put(PdfName.V, new PdfName(PdfFormAnnotation.OFF_STATE_VALUE));
 
         if (getWidgetRectangle() != null) {
+            //TODO DEVSIX-7426 remove flag
+            if (ExperimentalFeatures.ENABLE_EXPERIMENTAL_CHECKBOX_RENDERING) {
+                check.getFirstFormAnnotation()
+                        .drawCheckBoxAndSaveAppearanceExperimental(PdfFormAnnotation.ON_STATE_VALUE);
+                setPageToField(check);
+                return check;
+            }
+            //TODO DEVSIX-7426 remove from here till end
             if (getConformanceLevel() == null) {
                 check.getFirstFormAnnotation().drawCheckAppearance(getWidgetRectangle().getWidth(),
                         getWidgetRectangle().getHeight(), PdfFormAnnotation.ON_STATE_VALUE);

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

@@ -43,15 +43,17 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.forms.fields;
 
+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.CheckBox;
 import com.itextpdf.forms.form.element.Radio;
 import com.itextpdf.forms.logs.FormsLogMessageConstants;
 import com.itextpdf.forms.util.DrawingUtil;
-import com.itextpdf.io.logs.IoLogMessageConstant;
 import com.itextpdf.io.font.FontProgram;
+import com.itextpdf.io.logs.IoLogMessageConstant;
 import com.itextpdf.kernel.colors.Color;
 import com.itextpdf.kernel.colors.ColorConstants;
 import com.itextpdf.kernel.colors.DeviceCmyk;
@@ -102,7 +104,6 @@ This file is part of the iText (R) project.
 import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Set;
-
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -663,6 +664,7 @@ protected void drawBorder(PdfCanvas canvas, PdfFormXObject xObject, float width,
      * @param height      the height of the checkbox to draw
      * @param onStateName the state of the form field that will be drawn
      */
+    //TODO DEVSIX-7426 remove method
     protected void drawCheckAppearance(float width, float height, String onStateName) {
         Rectangle rect = new Rectangle(0, 0, width, height);
 
@@ -703,6 +705,7 @@ protected void drawCheckAppearance(float width, float height, String onStateName
      * @param onStateName name that corresponds to the "On" state of the checkbox
      * @param checkType   the type that determines how the checkbox will look like. Instance of {@link CheckBoxType}
      */
+    //TODO DEVSIX-7426 remove method
     protected void drawPdfA2CheckAppearance(float width, float height, String onStateName, CheckBoxType checkType) {
         parent.checkType = checkType;
         Rectangle rect = new Rectangle(0, 0, width, height);
@@ -813,6 +816,7 @@ protected void drawButton(PdfCanvas canvas, float x, float y, float width, float
      * @param height   the width of the button
      * @param fontSize the size of the font
      */
+    //TODO DEVSIX-7426 remove method
     protected void drawCheckBox(PdfCanvas canvas, float width, float height, float fontSize) {
         if (parent.checkType == CheckBoxType.CROSS) {
             DrawingUtil.drawCross(canvas, width, height, borderWidth);
@@ -834,6 +838,7 @@ protected void drawCheckBox(PdfCanvas canvas, float width, float height, float f
                 endText();
     }
 
+    //TODO DEVSIX-7426 remove method
     protected void drawPdfACheckBox(PdfCanvas canvas, float width, float height, boolean on) {
         if (!on) {
             return;
@@ -1024,13 +1029,13 @@ void regeneratePushButtonField() {
         }
     }
 
+    //TODO DEVSIX-7426 remove method
     void regenerateCheckboxField(CheckBoxType checkType) {
         parent.setCheckType(checkType);
         final String value = parent.getValueAsString();
         Rectangle rect = getRect(getPdfObject());
 
         PdfWidgetAnnotation widget = (PdfWidgetAnnotation) PdfAnnotation.makeAnnotation(getPdfObject());
-
         if (getPdfAConformanceLevel() == null) {
             drawCheckAppearance(rect.getWidth(), rect.getHeight(),
                     OFF_STATE_VALUE.equals(value) ? ON_STATE_VALUE : value);
@@ -1203,7 +1208,13 @@ boolean regenerateWidget() {
             } else if (parent.getFieldFlag(PdfButtonFormField.FF_RADIO)) {
                 drawRadioButtonAndSaveAppearance(getRadioButtonValue());
             } else {
-                regenerateCheckboxField(parent.checkType);
+                //TODO DEVSIX-7426 remove flag
+                if (ExperimentalFeatures.ENABLE_EXPERIMENTAL_CHECKBOX_RENDERING){
+                    drawCheckBoxAndSaveAppearanceExperimental(parent.getValueAsString());
+                }else{
+                    //TODO DEVSIX-7426 remove method
+                    regenerateCheckboxField(parent.checkType);
+                }
             }
             return true;
         }
@@ -1476,4 +1487,80 @@ private static Color appearancePropToColor(PdfDictionary appearanceCharacteristi
         }
         return null;
     }
+
+    /**
+     * Experimental method to draw a checkbox and save its appearance.
+     *
+     * @param onStateName the name of the appearance state for the checked state
+     */
+    //TODO DEVSIX-7426 rename experimental method
+    protected void drawCheckBoxAndSaveAppearanceExperimental(String onStateName) {
+        final Rectangle rect = getRect(this.getPdfObject());
+        if (rect == null) {
+            return;
+        }
+
+        final CheckBox formField = createCheckBox();
+        if (formField == null) {
+            return;
+        }
+        // First draw off appearance
+        if (getWidget().getNormalAppearanceObject() == null){
+            getWidget().setNormalAppearance(new PdfDictionary());
+        }
+        final PdfDictionary normalAppearance = getWidget().getNormalAppearanceObject();
+        // Draw on appearance
+        formField.setChecked(false);
+        final PdfFormXObject xObjectOff = new PdfFormXObject(new Rectangle(0, 0, rect.getWidth(), rect.getHeight()));
+        final Canvas canvasOff = new Canvas(xObjectOff, getDocument());
+        canvasOff.add(formField);
+        normalAppearance.put(new PdfName(OFF_STATE_VALUE), xObjectOff.getPdfObject());
+        if (onStateName != null && !onStateName.isEmpty() && !PdfFormAnnotation.OFF_STATE_VALUE.equals(onStateName)) {
+            formField.setChecked(true);
+            final PdfFormXObject xObject = new PdfFormXObject(new Rectangle(0, 0, rect.getWidth(), rect.getHeight()));
+            final Canvas canvas = new Canvas(xObject, this.getDocument());
+            canvas.add(formField);
+            normalAppearance.put(new PdfName(onStateName), xObject.getPdfObject());
+        }
+
+        final PdfDictionary mk = new PdfDictionary();
+        mk.put(PdfName.CA, new PdfString(parent.text));
+        getWidget().put(PdfName.MK, mk);
+        final PdfWidgetAnnotation widget = getWidget();
+        if (widget.getNormalAppearanceObject() != null &&
+                widget.getNormalAppearanceObject().containsKey(new PdfName(onStateName))) {
+            widget.setAppearanceState(new PdfName(onStateName));
+        } else {
+            widget.setAppearanceState(new PdfName(OFF_STATE_VALUE));
+        }
+    }
+
+    private CheckBox createCheckBox(){
+        final Rectangle rect = getRect(getPdfObject());
+        if (rect == null) {
+            return null;
+        }
+
+        // id doesn't matter here
+        CheckBox checkBox = new CheckBox("");
+        if (getBorderWidth() > 0 && borderColor != null ) {
+            Border border = new SolidBorder(Math.max(1, getBorderWidth()));
+            border.setColor(borderColor);
+            checkBox.setBorder(border);
+        }
+
+        if (backgroundColor != null) {
+            checkBox.setBackgroundColor(backgroundColor);
+        }
+
+        // Set fixed size
+        checkBox.setProperty(Property.WIDTH, UnitValue.createPointValue(rect.getWidth()));
+        checkBox.setProperty(Property.HEIGHT, UnitValue.createPointValue(rect.getHeight()));
+        // Always flatten
+        checkBox.setInteractive(false);
+        checkBox.setPdfAConformanceLevel(getPdfAConformanceLevel());
+        checkBox.setCheckBoxType(parent.checkType);
+
+        return checkBox;
+    }
 }

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

@@ -78,9 +78,6 @@ This file is part of the iText (R) project.
 import com.itextpdf.layout.properties.HorizontalAlignment;
 import com.itextpdf.layout.properties.TextAlignment;
 
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
@@ -93,6 +90,8 @@ This file is part of the iText (R) project.
 import java.util.List;
 import java.util.Map;
 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

forms/src/main/java/com/itextpdf/forms/form/FormProperty.java

@@ -89,6 +89,14 @@ public final class FormProperty {
     /** The Constant FORM_FIELD_RADIO_BORDER_CIRCLE. */
     public static final int FORM_FIELD_RADIO_BORDER_CIRCLE = PROPERTY_START + 13;
 
+    /**
+     * The Constant FORM_CHECKBOX_TYPE.
+     */
+    public static final int FORM_CHECKBOX_TYPE = PROPERTY_START + 14;
+
+    /** The Constant FORM_CONFORMANCE_LEVEL. */
+    public static final int FORM_CONFORMANCE_LEVEL = PROPERTY_START + 15;
+    
     private FormProperty() {
         // Empty constructor.
     }

forms/src/main/java/com/itextpdf/forms/form/element/CheckBox.java

@@ -42,14 +42,27 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.forms.form.element;
 
+import com.itextpdf.commons.utils.MessageFormatUtil;
+import com.itextpdf.forms.fields.properties.CheckBoxType;
+import com.itextpdf.forms.form.FormProperty;
 import com.itextpdf.forms.form.renderer.CheckBoxRenderer;
+import com.itextpdf.forms.logs.FormsLogMessageConstants;
+import com.itextpdf.kernel.pdf.PdfAConformanceLevel;
+import com.itextpdf.layout.properties.Property;
+import com.itextpdf.layout.properties.RenderingMode;
+import com.itextpdf.layout.properties.UnitValue;
 import com.itextpdf.layout.renderer.IRenderer;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 /**
  * Extension of the {@link FormField} class representing a checkbox so that
  * a {@link CheckBoxRenderer} is used instead of the default renderer for fields.
  */
-public class CheckBox extends FormField<TextArea> {
+public class CheckBox extends FormField<CheckBox> {
+
+    private static final Logger LOGGER = LoggerFactory.getLogger(CheckBox.class);
 
     /**
      * Creates a new {@link CheckBox} instance.
@@ -60,11 +73,91 @@ public CheckBox(String id) {
         super(id);
     }
 
+
+    /**
+     * Sets the checked state of the checkbox.
+     *
+     * @param checked the checked state to set
+     *
+     * @return this checkbox instance
+     */
+    public CheckBox setChecked(boolean checked) {
+        setProperty(FormProperty.FORM_FIELD_CHECKED, checked);
+        return this;
+    }
+
+    /**
+     * Sets the rendering mode for the checkbox.
+     *
+     * @param renderingMode the rendering mode to set
+     *
+     * @return this checkbox instance
+     */
+    public CheckBox setRenderingMode(RenderingMode renderingMode) {
+        if (renderingMode == null) {
+            LOGGER.warn(MessageFormatUtil.format(
+                    FormsLogMessageConstants.INVALID_VALUE_FALLBACK_TO_DEFAULT, "renderingMode", null));
+            return this;
+        }
+        setProperty(Property.RENDERING_MODE, renderingMode);
+        return this;
+    }
+
+    /**
+     * Sets the PDF/A conformance level for the checkbox.
+     *
+     * @param conformanceLevel the PDF/A conformance level to set
+     *
+     * @return this checkbox instance
+     */
+    public CheckBox setPdfAConformanceLevel(PdfAConformanceLevel conformanceLevel) {
+        setProperty(FormProperty.FORM_CONFORMANCE_LEVEL, conformanceLevel);
+        return this;
+    }
+
+
+    /**
+     * Sets the icon of the checkbox.
+     *
+     * @param checkBoxType the type of the checkbox to set
+     *
+     * @return this checkbox instance
+     */
+    public CheckBox setCheckBoxType(CheckBoxType checkBoxType) {
+        if (checkBoxType == null) {
+            LOGGER.warn(MessageFormatUtil.format(
+                    FormsLogMessageConstants.INVALID_VALUE_FALLBACK_TO_DEFAULT, "checkBoxType", null));
+            return this;
+        }
+        setProperty(FormProperty.FORM_CHECKBOX_TYPE, checkBoxType);
+        return this;
+    }
+
+    /**
+     * Sets the size of the checkbox.
+     *
+     * @param size the size of the checkbox to set, in points
+     *
+     * @return this checkbox instance
+     */
+    public CheckBox setSize(float size) {
+        if (size <= 0) {
+            LOGGER.warn(MessageFormatUtil.format(
+                    FormsLogMessageConstants.INVALID_VALUE_FALLBACK_TO_DEFAULT, "size", size));
+            return this;
+        }
+        setProperty(Property.WIDTH, UnitValue.createPointValue(size));
+        setProperty(Property.HEIGHT, UnitValue.createPointValue(size));
+
+        return this;
+    }
+
     /* (non-Javadoc)
      * @see com.itextpdf.layout.element.AbstractElement#makeNewRenderer()
      */
     @Override
     protected IRenderer makeNewRenderer() {
         return new CheckBoxRenderer(this);
     }
+
 }