Support basic implementation of text form fields new drawing logic

DEVSIX-7362

Author: Eugene Bochilo

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

@@ -1,8 +1,20 @@
 package com.itextpdf.commons.utils;
 
+/**
+ * Experimental features class which contains constants related to experimental form fields drawing.
+ */
+// TODO Shall be removed in the scope of DEVSIX-7385
 public final class ExperimentalFeatures {
+    /**
+     * Determines, whether the old or the new checkbox form field drawing logic will be used.
+     */
     public static boolean ENABLE_EXPERIMENTAL_CHECKBOX_RENDERING = false;
 
+    /**
+     * Determines, whether the old or the new text form field drawing logic will be used.
+     */
+    public static boolean ENABLE_EXPERIMENTAL_TEXT_FORM_RENDERING = false;
+
     private ExperimentalFeatures() {
         // utility class
     }

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

@@ -560,7 +560,7 @@ public PdfString getDefaultAppearance() {
      *
      * @param justification an integer representing a justification value
      * @return current AcroForm
-     * @see PdfFormField#setJustification(com.itextpdf.layout.properties.HorizontalAlignment)
+     * @see PdfFormField#setJustification(com.itextpdf.layout.properties.TextAlignment)
      */
     public PdfAcroForm setDefaultJustification(int justification) {
         return put(PdfName.Q, new PdfNumber(justification));

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

@@ -28,7 +28,11 @@ This file is part of the iText (R) project.
 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.FormField;
+import com.itextpdf.forms.form.element.IFormField;
+import com.itextpdf.forms.form.element.InputField;
 import com.itextpdf.forms.form.element.Radio;
+import com.itextpdf.forms.form.element.TextArea;
 import com.itextpdf.forms.logs.FormsLogMessageConstants;
 import com.itextpdf.forms.util.DrawingUtil;
 import com.itextpdf.forms.util.FontSizeUtil;
@@ -66,6 +70,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.layout.element.Div;
 import com.itextpdf.layout.element.Paragraph;
 import com.itextpdf.layout.element.Text;
+import com.itextpdf.layout.properties.Background;
 import com.itextpdf.layout.properties.BoxSizingPropertyValue;
 import com.itextpdf.layout.properties.Leading;
 import com.itextpdf.layout.properties.OverflowPropertyValue;
@@ -114,7 +119,6 @@ public class PdfFormAnnotation extends AbstractPdfFormField {
     protected float borderWidth = 1;
     protected Color backgroundColor;
     protected Color borderColor;
-    protected int rotation = 0;
 
     /**
      * Creates a form field annotation as a wrapper of a {@link PdfWidgetAnnotation}.
@@ -205,20 +209,22 @@ public PdfFormAnnotation setRotation(int degRotation) {
             if (degRotation < 0) {
                 degRotation += 360;
             }
-
-            this.rotation = degRotation;
         }
         PdfDictionary mk = getWidget().getAppearanceCharacteristics();
         if (mk == null) {
             mk = new PdfDictionary();
             this.put(PdfName.MK, mk);
         }
         mk.put(PdfName.R, new PdfNumber(degRotation));
-
-        this.rotation = degRotation;
+        
         regenerateField();
         return this;
     }
+    
+    public int getRotation() {
+        PdfDictionary mk = getWidget().getAppearanceCharacteristics();
+        return mk == null || mk.getAsInt(PdfName.R) == null ? 0 : (int) mk.getAsInt(PdfName.R);
+    }
 
     /**
      * Sets the action on {@link PdfWidgetAnnotation widget} of this annotation form field.
@@ -291,6 +297,21 @@ public float getBorderWidth() {
         return borderWidth;
     }
 
+    /**
+     * Get border object specified in the widget annotation dictionary.
+     * 
+     * @return {@link Border} specified in the widget annotation dictionary
+     */
+    public Border getBorder() {
+        float borderWidth = getBorderWidth();
+        Border border = FormBorderFactory.getBorder(
+                this.getWidget().getBorderStyle(), borderWidth, borderColor, backgroundColor);
+        if (border == null && borderWidth > 0 && borderColor != null) {
+            border = new SolidBorder(borderColor, Math.max(1, borderWidth));
+        }
+        return border;
+    }
+
     /**
      * Sets the border width for the field.
      *
@@ -299,13 +320,15 @@ public float getBorderWidth() {
      * @return The edited {@link PdfFormAnnotation}.
      */
     public PdfFormAnnotation setBorderWidth(float borderWidth) {
+        // Acrobat doesn't support float border width therefore we round it.
+        int roundedBorderWidth = (int) Math.round(borderWidth);
         PdfDictionary bs = getWidget().getBorderStyle();
         if (bs == null) {
             bs = new PdfDictionary();
             put(PdfName.BS, bs);
         }
-        bs.put(PdfName.W, new PdfNumber(borderWidth));
-        this.borderWidth = borderWidth;
+        bs.put(PdfName.W, new PdfNumber(roundedBorderWidth));
+        this.borderWidth = roundedBorderWidth;
 
         regenerateField();
         return this;
@@ -497,7 +520,8 @@ protected void drawTextAppearance(Rectangle rect, PdfFont font, float fontSize,
                 saveState().
                 endPath();
 
-        TextAlignment textAlignment = parent.convertJustificationToTextAlignment();
+        TextAlignment textAlignment =
+                parent.getJustification() == null ? TextAlignment.LEFT : parent.getJustification();
         float x = 0;
         if (textAlignment == TextAlignment.RIGHT) {
             x = rect.getWidth();
@@ -584,7 +608,7 @@ protected void drawMultiLineTextAppearance(Rectangle rect, PdfFont font, String
             paragraph.setFontSize(getFontSize());
         }
         paragraph.setProperty(Property.FORCED_PLACEMENT, Boolean.TRUE);
-        paragraph.setTextAlignment(parent.convertJustificationToTextAlignment());
+        paragraph.setTextAlignment(parent.getJustification());
 
         if (getColor() != null) {
             paragraph.setFontColor(getColor());
@@ -891,6 +915,54 @@ protected void drawRadioButtonAndSaveAppearance(String value) {
         getWidget().setNormalAppearance(normalAppearance);
     }
 
+    /**
+     * Draws the appearance of a text form field with and saves it into an appearance stream.
+     */
+    protected void drawTextFormFieldAndSaveAppearance() {
+        Rectangle rectangle = getRect(this.getPdfObject());
+        if (rectangle == null) {
+            return;
+        }
+
+        IFormField textFormField;
+        if (parent.isMultiline()) {
+            textFormField = new TextArea(getParentField().getPartialFieldName().toUnicodeString());
+            textFormField.setProperty(Property.FONT_SIZE, UnitValue.createPointValue(getFontSize()));
+        } else {
+            textFormField = new InputField(getParentField().getPartialFieldName().toUnicodeString());
+            textFormField.setProperty(Property.FONT_SIZE,
+                    UnitValue.createPointValue(getFontSize(new PdfArray(rectangle), parent.getValueAsString())));
+        }
+        textFormField.setProperty(FormProperty.FORM_FIELD_VALUE, parent.getDisplayValue());
+        textFormField.setProperty(Property.FONT, getFont());
+        textFormField.setProperty(Property.TEXT_ALIGNMENT, parent.getJustification());
+        textFormField.setProperty(FormProperty.FORM_FIELD_PASSWORD_FLAG, getParentField().isPassword());
+        textFormField.setProperty(Property.ADD_MARKED_CONTENT_TEXT, true);
+        if (getColor() != null) {
+            textFormField.setProperty(Property.FONT_COLOR, new TransparentColor(getColor()));
+        }
+
+        textFormField.setProperty(Property.BORDER, getBorder());
+
+        if (backgroundColor != null) {
+            textFormField.setProperty(Property.BACKGROUND, new Background(backgroundColor, 1f, 0, 0, 0, 0));
+        }
+
+        textFormField.setProperty(Property.WIDTH, UnitValue.createPointValue(rectangle.getWidth()));
+        textFormField.setProperty(Property.HEIGHT, UnitValue.createPointValue(rectangle.getHeight()));
+        // Always flatten
+        textFormField.setProperty(FormProperty.FORM_FIELD_FLATTEN, true);
+
+        PdfFormXObject xObject = new PdfFormXObject(
+                new Rectangle(0, 0, rectangle.getWidth(), rectangle.getHeight()));
+        applyRotation(xObject, rectangle.getWidth(), rectangle.getHeight());
+        Canvas canvas = new Canvas(xObject, this.getDocument());
+        canvas.setProperty(Property.APPEARANCE_STREAM_LAYOUT, Boolean.TRUE);
+        canvas.add(textFormField);
+
+        getWidget().setNormalAppearance(xObject.getPdfObject());
+    }
+
     @Override
     void retrieveStyles() {
         super.retrieveStyles();
@@ -951,7 +1023,7 @@ void drawChoiceAppearance(Rectangle rect, float fontSize, String value, PdfFormX
             Paragraph paragraph = new Paragraph(strings.get(index)).setFont(getFont())
                     .setFontSize(fontSize).setMargins(0, 0, 0, 0).setMultipliedLeading(1);
             paragraph.setProperty(Property.FORCED_PLACEMENT, Boolean.TRUE);
-            paragraph.setTextAlignment(parent.convertJustificationToTextAlignment());
+            paragraph.setTextAlignment(parent.getJustification());
 
             if (getColor() != null) {
                 paragraph.setFontColor(getColor());
@@ -1190,7 +1262,10 @@ boolean regenerateWidget() {
         }
         final PdfName type = parent.getFormType();
 
-        if (PdfName.Tx.equals(type) || PdfName.Ch.equals(type)) {
+        if (PdfName.Tx.equals(type) && ExperimentalFeatures.ENABLE_EXPERIMENTAL_TEXT_FORM_RENDERING) {
+            drawTextFormFieldAndSaveAppearance();
+            return true;
+        } else if (PdfName.Ch.equals(type) || PdfName.Tx.equals(type)) {
             return regenerateTextAndChoiceField();
         } else if (PdfName.Btn.equals(type)) {
             if (parent.getFieldFlag(PdfButtonFormField.FF_PUSH_BUTTON)) {
@@ -1391,7 +1466,7 @@ private static String obfuscatePassword(String text) {
     }
 
     private void applyRotation(PdfFormXObject xObject, float height, float width) {
-        switch (rotation) {
+        switch (getRotation()) {
             case 90:
                 xObject.put(PdfName.Matrix, new PdfArray(new float[] {0, 1, -1, 0, height, 0}));
                 break;

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

@@ -988,7 +988,7 @@ public void updateDefaultAppearance() {
      *
      * @return the current justification attribute.
      */
-    public HorizontalAlignment getJustification() {
+    public TextAlignment getJustification() {
         Integer justification = getPdfObject().getAsInt(PdfName.Q);
         if (justification == null && getParent() != null) {
             justification = getParent().getAsInt(PdfName.Q);
@@ -1005,9 +1005,11 @@ public HorizontalAlignment getJustification() {
      * @param justification the value to set the justification attribute to.
      * @return the edited {@link PdfFormField}.
      */
-    public PdfFormField setJustification(HorizontalAlignment justification) {
-        put(PdfName.Q, new PdfNumber(justification.ordinal()));
-        regenerateField();
+    public PdfFormField setJustification(TextAlignment justification) {
+        if (justification != null) {
+            put(PdfName.Q, new PdfNumber(justification.ordinal()));
+            regenerateField();
+        }
         return this;
     }
 
@@ -1259,20 +1261,6 @@ static String optionsArrayToString(PdfArray options) {
         return sb.toString();
     }
 
-    TextAlignment convertJustificationToTextAlignment() {
-        HorizontalAlignment justification = getJustification();
-        
-        TextAlignment textAlignment;
-        if (justification == HorizontalAlignment.RIGHT) {
-            textAlignment = TextAlignment.RIGHT;
-        } else if (justification == HorizontalAlignment.CENTER) {
-            textAlignment = TextAlignment.CENTER;
-        } else {
-            textAlignment = TextAlignment.LEFT;
-        }
-        return textAlignment;
-    }
-
     /**
      * Adds a field to the children of the current field.
      *
@@ -1364,14 +1352,14 @@ private static PdfName getTypeFromParent(PdfDictionary field) {
         return formType;
     }
 
-    private static HorizontalAlignment numberToHorizontalAlignment(int alignment) {
+    private static TextAlignment numberToHorizontalAlignment(int alignment) {
         switch (alignment) {
             case 1:
-                return HorizontalAlignment.CENTER;
+                return TextAlignment.CENTER;
             case 2:
-                return HorizontalAlignment.RIGHT;
+                return TextAlignment.RIGHT;
             default:
-                return HorizontalAlignment.LEFT;
+                return TextAlignment.LEFT;
         }
     }
 

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

@@ -24,6 +24,8 @@ This file is part of the iText (R) project.
 
 import com.itextpdf.forms.form.FormProperty;
 import com.itextpdf.layout.element.AbstractElement;
+import com.itextpdf.layout.properties.Property;
+import com.itextpdf.layout.properties.UnitValue;
 
 /**
  * Implementation of the {@link AbstractElement} class for form fields.
@@ -70,15 +72,65 @@ public <T1> T1 getDefaultProperty(int property) {
         }
     }
 
+    /**
+     * Sets the form field's width and height.
+     *
+     * @param size form field's width and height.
+     * 
+     * @return this same {@link FormField} element.
+     */
+    public T setSize(float size) {
+        setProperty(Property.WIDTH, UnitValue.createPointValue(size));
+        setProperty(Property.HEIGHT, UnitValue.createPointValue(size));
+
+        return (T) (Object) this;
+    }
+
+    /**
+     * Set the form field's width.
+     * 
+     * @param width form field's width
+     * 
+     * @return this {@link FormField} element.
+     */
+    public T setWidth(float width) {
+        setProperty(Property.WIDTH, UnitValue.createPointValue(width));
+        return (T) (Object) this;
+    }
+
+    /**
+     * Set the form field's height.
+     *
+     * @param height form field's height
+     *
+     * @return this {@link FormField} element.
+     */
+    public T setHeight(float height) {
+        setProperty(Property.HEIGHT, UnitValue.createPointValue(height));
+        return (T) (Object) this;
+    }
+
     /**
      * Set the form field to be interactive and added into Acroform instead of drawing it on a page.
      *
      * @param interactive {@code true} if the form field element shall be added into Acroform, {@code false} otherwise.
      *                By default, the form field element is not interactive and drawn on a page.
      * @return this same {@link FormField} instance.
      */
-    public FormField<T> setInteractive(boolean interactive) {
+    public T setInteractive(boolean interactive) {
         setProperty(FormProperty.FORM_FIELD_FLATTEN, !interactive);
-        return this;
+        return (T) (Object) this;
+    }
+
+    /**
+     * Set value to the form field. Meaning of this depends on the form field type.
+     * 
+     * @param value string value to be set
+     * 
+     * @return this {@link FormField} element.
+     */
+    public T setValue(String value) {
+        setProperty(FormProperty.FORM_FIELD_VALUE, value);
+        return (T) (Object) this;
     }
 }