Fix text clipping, rotation for input field drawing; switch some tests for new drawing mechanism

DEVSIX-7433

Author: vitali-pr

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

@@ -45,6 +45,7 @@ public final class FormsExceptionMessageConstant {
     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";
+    public static final String INVALID_ROTATION_VALUE = "Invalid rotation. Rotation must be a multiple of 90 degrees.";
 
     private FormsExceptionMessageConstant(){}
 }

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

@@ -28,12 +28,12 @@ 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.form.element.Button;
+import com.itextpdf.forms.form.renderer.FormFieldValueNonTrimmingTextRenderer;
 import com.itextpdf.forms.logs.FormsLogMessageConstants;
 import com.itextpdf.forms.util.DrawingUtil;
 import com.itextpdf.forms.util.FontSizeUtil;
@@ -679,7 +679,10 @@ protected void drawBorder(PdfCanvas canvas, PdfFormXObject xObject, float width,
             }
         }
 
-        applyRotation(xObject, height, width);
+        PdfArray matrix = getRotationMatrix(getRotation() % 360, height, width);
+        if (matrix != null) {
+            xObject.put(PdfName.Matrix, matrix);
+        }
         canvas.restoreState();
     }
 
@@ -778,7 +781,10 @@ protected void drawPushButtonFieldAndSaveAppearance() {
         createInputButton();
 
         PdfFormXObject xObject = new PdfFormXObject(new Rectangle(0, 0, width, height));
-        applyRotation(xObject, height, width);
+        PdfArray matrix = getRotationMatrix(getRotation() % 360, height, width);
+        if (matrix != null) {
+            xObject.put(PdfName.Matrix, matrix);
+        }
         Canvas canvas = new Canvas(xObject, this.getDocument());
         setMetaInfoToCanvas(canvas);
 
@@ -957,14 +963,28 @@ protected void drawTextFormFieldAndSaveAppearance() {
             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);
 
+        // Rotation
+        final int fieldRotation = getRotation() % 360;
+        PdfArray matrix = getRotationMatrix(fieldRotation, rectangle.getHeight(), rectangle.getWidth());
+        if (fieldRotation == 90 || fieldRotation == 270) {
+            Rectangle invertedRectangle = rectangle.clone();
+            invertedRectangle.setWidth(rectangle.getHeight());
+            invertedRectangle.setHeight(rectangle.getWidth());
+            rectangle = invertedRectangle;
+        }
+
+        // Set fixed size
+        textFormField.setProperty(Property.WIDTH, UnitValue.createPointValue(rectangle.getWidth()));
+        textFormField.setProperty(Property.HEIGHT, UnitValue.createPointValue(rectangle.getHeight()));
+
         PdfFormXObject xObject = new PdfFormXObject(
                 new Rectangle(0, 0, rectangle.getWidth(), rectangle.getHeight()));
-        applyRotation(xObject, rectangle.getWidth(), rectangle.getHeight());
+        if (matrix != null) {
+            xObject.put(PdfName.Matrix, matrix);
+        }
         Canvas canvas = new Canvas(xObject, this.getDocument());
         canvas.setProperty(Property.APPEARANCE_STREAM_LAYOUT, Boolean.TRUE);
         canvas.add(textFormField);
@@ -1143,7 +1163,7 @@ boolean regenerateTextAndChoiceField() {
         } else {
             //Avoid NPE when handling corrupt pdfs
             Logger logger = LoggerFactory.getLogger(PdfFormAnnotation.class);
-            logger.error(FormsLogMessageConstants.INCORRECT_PAGEROTATION);
+            logger.error(FormsLogMessageConstants.INCORRECT_PAGE_ROTATION);
             matrix = new PdfArray(new double[] {1, 0, 0, 1, 0, 0});
         }
         //Apply field rotation
@@ -1479,20 +1499,20 @@ private static String obfuscatePassword(String text) {
         return new String(pchar);
     }
 
-    private void applyRotation(PdfFormXObject xObject, float height, float width) {
-        switch (getRotation()) {
+    private static PdfArray getRotationMatrix(int rotation, float height, float width) {
+        switch (rotation) {
+            case 0:
+                return null;
             case 90:
-                xObject.put(PdfName.Matrix, new PdfArray(new float[] {0, 1, -1, 0, height, 0}));
-                break;
+                return new PdfArray(new float[] {0, 1, -1, 0, height, 0});
             case 180:
-                xObject.put(PdfName.Matrix, new PdfArray(new float[] {-1, 0, 0, -1, width, height}));
-                break;
+                return new PdfArray(new float[] {-1, 0, 0, -1, width, height});
             case 270:
-                xObject.put(PdfName.Matrix, new PdfArray(new float[] {0, -1, 1, 0, 0, width}));
-                break;
+                return new PdfArray(new float[] {0, -1, 1, 0, 0, width});
             default:
-                // Rotation 0 - do nothing
-                break;
+                Logger logger = LoggerFactory.getLogger(PdfFormAnnotation.class);
+                logger.error(FormsLogMessageConstants.INCORRECT_WIDGET_ROTATION);
+                return null;
         }
     }
 

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

@@ -22,6 +22,7 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.forms.form.element;
 
+import com.itextpdf.forms.exceptions.FormsExceptionMessageConstant;
 import com.itextpdf.forms.form.renderer.InputFieldRenderer;
 import com.itextpdf.forms.form.FormProperty;
 import com.itextpdf.layout.element.Paragraph;
@@ -47,6 +48,11 @@ public class InputField extends FormField<InputField> implements IPlaceholderabl
      */
     private Paragraph placeholder;
 
+    /**
+     * Field rotation, counterclockwise. Must be a multiple of 90 degrees.
+     */
+    private int rotation = 0;
+
     /**
      * Creates a new input field.
      *
@@ -106,6 +112,31 @@ public <T1> T1 getDefaultProperty(int property) {
         }
     }
 
+    /**
+     * Set rotation of the input field.
+     *
+     * @param rotation new rotation value, counterclockwise. Must be a multiple of 90 degrees.
+     *                It has sense only in interactive mode, see {@link FormField#setInteractive}.
+     * @return the edited {@link InputField}.
+     */
+    public InputField setRotation(int rotation) {
+        if (rotation % 90 != 0) {
+            throw new IllegalArgumentException(FormsExceptionMessageConstant.INVALID_ROTATION_VALUE);
+        }
+
+        this.rotation = rotation;
+        return this;
+    }
+
+    /**
+     * Get rotation.
+     *
+     * @return rotation value.
+     */
+    public int getRotation() {
+        return this.rotation;
+    }
+
     /* (non-Javadoc)
      * @see com.itextpdf.layout.element.AbstractElement#makeNewRenderer()
      */

forms/src/main/java/com/itextpdf/forms/fields/FormFieldValueNonTrimmingTextRenderer.java renamed to forms/src/main/java/com/itextpdf/forms/form/renderer/FormFieldValueNonTrimmingTextRenderer.java

@@ -20,20 +20,31 @@ This file is part of the iText (R) project.
     You should have received a copy of the GNU Affero General Public License
     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
-package com.itextpdf.forms.fields;
+package com.itextpdf.forms.form.renderer;
 
+import com.itextpdf.commons.utils.MessageFormatUtil;
+import com.itextpdf.io.font.otf.GlyphLine;
+import com.itextpdf.io.logs.IoLogMessageConstant;
+import com.itextpdf.kernel.font.PdfFont;
 import com.itextpdf.layout.element.Text;
 import com.itextpdf.layout.layout.LayoutContext;
 import com.itextpdf.layout.layout.LayoutResult;
 import com.itextpdf.layout.layout.TextLayoutResult;
 import com.itextpdf.layout.renderer.IRenderer;
 import com.itextpdf.layout.renderer.TextRenderer;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 /**
  * Custom implementation for rendering form field values. It makes sure that text value
  * trimming strategy matches Acrobat's behavior
  */
-class FormFieldValueNonTrimmingTextRenderer extends TextRenderer {
+
+// Temporarily public, make it package private on cleanup of PdfFormAnnotation
+// TODO DEVSIX-7423 (or put another devsix if the usage of this class is not removed from PdfFormAnnotation
+//  as part of DEVSIX-7423)
+public class FormFieldValueNonTrimmingTextRenderer extends TextRenderer {
     // Determines whether we want to trim leading space. In particular we don't want to trim
     // the very first leading spaces of the text value. When text overflows to the next lines,
     // whether we should trim the text depends on why the overflow happened
@@ -68,6 +79,20 @@ public void trimFirst() {
        }
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    protected TextRenderer createCopy(GlyphLine gl, PdfFont font) {
+        if (FormFieldValueNonTrimmingTextRenderer.class != this.getClass()) {
+            Logger logger = LoggerFactory.getLogger(FormFieldValueNonTrimmingTextRenderer.class);
+            logger.error(MessageFormatUtil.format(IoLogMessageConstant.CREATE_COPY_SHOULD_BE_OVERRIDDEN));
+        }
+        FormFieldValueNonTrimmingTextRenderer copy = new FormFieldValueNonTrimmingTextRenderer((Text)this.modelElement);
+        copy.setProcessedGlyphLineAndFont(gl, font);
+        return copy;
+    }
+
     private void setCallTrimFirst(boolean callTrimFirst) {
         this.callTrimFirst = callTrimFirst;
     }

forms/src/main/java/com/itextpdf/forms/form/renderer/InputFieldRenderer.java

@@ -34,6 +34,8 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.pdf.PdfDocument;
 import com.itextpdf.kernel.pdf.PdfPage;
 import com.itextpdf.kernel.pdf.PdfString;
+import com.itextpdf.layout.element.Paragraph;
+import com.itextpdf.layout.element.Text;
 import com.itextpdf.layout.layout.LayoutContext;
 import com.itextpdf.layout.minmaxwidth.MinMaxWidth;
 import com.itextpdf.layout.properties.Property;
@@ -96,7 +98,17 @@ IRenderer createParagraphRenderer(String defaultValue) {
                 && !((InputField) modelElement).getPlaceholder().isEmpty()) {
             return ((InputField) modelElement).getPlaceholder().createRendererSubTree();
         }
-        return super.createParagraphRenderer(defaultValue);
+        if (defaultValue.isEmpty()) {
+            defaultValue = "\u00A0";
+        }
+
+        Text text = new Text(defaultValue);
+        FormFieldValueNonTrimmingTextRenderer nextRenderer = new FormFieldValueNonTrimmingTextRenderer(text);
+        text.setNextRenderer(nextRenderer);
+
+        IRenderer flatRenderer = new Paragraph(text).setMargin(0).createRendererSubTree();
+        flatRenderer.setProperty(Property.NO_SOFT_WRAP_INLINE, true);
+        return flatRenderer;
     }
 
     /* (non-Javadoc)
@@ -131,6 +143,7 @@ protected IRenderer createFlatRenderer() {
         if (flatten && password) {
             defaultValue = obfuscatePassword(defaultValue);
         }
+
         return createParagraphRenderer(defaultValue);
     }
 
@@ -162,6 +175,10 @@ protected void applyAcroField(DrawContext drawContext) {
         } else {
             inputField.setDefaultValue(new PdfString(value));
         }
+        final int rotation = ((InputField)modelElement).getRotation();
+        if (rotation != 0) {
+            inputField.getFirstFormAnnotation().setRotation(rotation);
+        }
         applyDefaultFieldProperties(inputField);
         PdfAcroForm.getAcroForm(doc, true).addField(inputField, page);
 

forms/src/main/java/com/itextpdf/forms/logs/FormsLogMessageConstants.java

@@ -48,8 +48,12 @@ public final class FormsLogMessageConstants {
     public static final String FORM_FIELD_WAS_FLUSHED =
             "A form field was flushed. There's no way to create this field in the AcroForm dictionary.";
 
-    public static final String INCORRECT_PAGEROTATION =
-            "Encounterd a page rotation that was not a multiple of 90°/ (Pi/2) when generating default appearances "
+    public static final String INCORRECT_PAGE_ROTATION =
+            "Encountered a page rotation that was not a multiple of 90°/ (Pi/2) when generating default appearances "
+                    + "for form fields";
+
+    public static final String INCORRECT_WIDGET_ROTATION =
+            "Encountered a widget rotation that was not a multiple of 90°/ (Pi/2) when generating default appearances "
                     + "for form fields";
 
     public static final String INPUT_FIELD_DOES_NOT_FIT = "Input field doesn't fit in outer object. It will be clipped";

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

@@ -22,57 +22,85 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.forms;
 
+import com.itextpdf.commons.utils.ExperimentalFeatures;
 import com.itextpdf.forms.fields.PdfFormField;
-import com.itextpdf.commons.utils.MessageFormatUtil;
+import com.itextpdf.kernel.colors.ColorConstants;
 import com.itextpdf.kernel.pdf.PdfDocument;
 import com.itextpdf.kernel.pdf.PdfReader;
 import com.itextpdf.kernel.pdf.PdfWriter;
 import com.itextpdf.kernel.utils.CompareTool;
 import com.itextpdf.test.ExtendedITextTest;
 import com.itextpdf.test.annotations.type.IntegrationTest;
 import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+import org.junit.AfterClass;
 import org.junit.Assert;
 import org.junit.BeforeClass;
 import org.junit.Test;
 import org.junit.experimental.categories.Category;
+import org.junit.runner.RunWith;
+import org.junit.runners.Parameterized;
 
+@RunWith(Parameterized.class)
 @Category(IntegrationTest.class)
 public class FlatteningRotatedTest extends ExtendedITextTest {
 
     public static final String sourceFolder = "./src/test/resources/com/itextpdf/forms/FlatteningRotatedTest/";
     public static final String destinationFolder = "./target/test/com/itextpdf/forms/FlatteningRotatedTest/";
 
+    private final String inputPdfFileName;
+    private static boolean experimentalRenderingPreviousValue;
+
+    @Parameterized.Parameters(name = "{0}")
+    public static Collection<Object[]> inputFileNames() {
+        List<Object[]> inputFileNames = new ArrayList<Object[]>();
+        for (int pageRot = 0; pageRot < 360; pageRot += 90) {
+            for (int fieldRot = 0; fieldRot < 360; fieldRot += 90) {
+                inputFileNames.add(new Object[] {"FormFlatteningDefaultAppearance_" + pageRot + "_" + fieldRot});
+            }
+        }
+        return inputFileNames;
+    }
+
+    public FlatteningRotatedTest(Object inputPdfFileName) {
+        this.inputPdfFileName = (String) inputPdfFileName;
+    }
+
     @BeforeClass
     public static void beforeClass() {
         createOrClearDestinationFolder(destinationFolder);
+        experimentalRenderingPreviousValue = ExperimentalFeatures.ENABLE_EXPERIMENTAL_TEXT_FORM_RENDERING;
+        ExperimentalFeatures.ENABLE_EXPERIMENTAL_TEXT_FORM_RENDERING = true;
+    }
+
+    @AfterClass
+    public static void afterClass() {
+        ExperimentalFeatures.ENABLE_EXPERIMENTAL_TEXT_FORM_RENDERING = experimentalRenderingPreviousValue;
     }
 
     @Test
     public void formFlatteningTest_DefaultAppearanceGeneration_Rot() throws IOException, InterruptedException {
-        String srcFilePatternPattern = "FormFlatteningDefaultAppearance_{0}_";
-        String destPatternPattern = "FormFlatteningDefaultAppearance_{0}_";
-
-        String[] rotAngle = new String[] {"0", "90", "180", "270"};
-
-        for (String angle : rotAngle) {
-            String srcFilePattern = MessageFormatUtil.format(srcFilePatternPattern, angle);
-            String destPattern = MessageFormatUtil.format(destPatternPattern, angle);
-            for (int i = 0; i < 360; i += 90) {
-                String src = sourceFolder + srcFilePattern + i + ".pdf";
-                String dest = destinationFolder + destPattern + i + "_flattened.pdf";
-                String cmp = sourceFolder + "cmp_" + srcFilePattern + i + ".pdf";
-                PdfDocument doc = new PdfDocument(new PdfReader(src), new PdfWriter(dest));
-
-                PdfAcroForm form = PdfAcroForm.getAcroForm(doc, true);
-                for (PdfFormField field : form.getAllFormFields().values()) {
-                    field.setValue("Test");
-                }
-                form.flattenFields();
+        String src = sourceFolder + inputPdfFileName + ".pdf";
+        String dest = destinationFolder + inputPdfFileName + ".pdf";
+        String dest_flattened = destinationFolder + inputPdfFileName + "_flattened.pdf";
+        String cmp = sourceFolder + "cmp_" + inputPdfFileName + ".pdf";
+        String cmp_flattened = sourceFolder + "cmp_" + inputPdfFileName + "_flattened.pdf";
 
-                doc.close();
-
-                Assert.assertNull(new CompareTool().compareByContent(dest, cmp, destinationFolder, "diff_"));
+        try (PdfDocument doc = new PdfDocument(new PdfReader(src), new PdfWriter(dest))) {
+            PdfAcroForm form = PdfAcroForm.getAcroForm(doc, true);
+            for (PdfFormField field : form.getAllFormFields().values()) {
+                field.setValue("Long Long Text");
+                field.getFirstFormAnnotation().setBorderWidth(1);
+                field.getFirstFormAnnotation().setBorderColor(ColorConstants.BLUE);
             }
         }
+        Assert.assertNull(new CompareTool().compareByContent(dest, cmp, destinationFolder, "diff_"));
+
+        try (PdfDocument doc = new PdfDocument(new PdfReader(dest), new PdfWriter(dest_flattened))) {
+            PdfAcroForm.getAcroForm(doc, true).flattenFields();
+        }
+        Assert.assertNull(new CompareTool().compareByContent(dest_flattened, cmp_flattened, destinationFolder, "diff_"));
     }
 }