Layout: flush image xObjects created in Layout's Image constructor. Make work with WmfImage more consistent

DEVSIX-479

Author: Snipx

kernel/src/main/java/com/itextpdf/kernel/PdfException.java

@@ -26,6 +26,8 @@ public class PdfException extends RuntimeException {
     public static final String CannotCopyObjectContent = "cannot.copy.object.content";
     public static final String CannotCopyIndirectObjectFromTheDocumentThatIsBeingWritten = "cannot.copy.indirect.object.from.the.document.that.is.being.written";
     public static final String CannotCopyToDocumentOpenedInReadingMode = "cannot.copy.to.document.opened.in.reading.mode";
+    public static final String CannotCreateLayoutImageByWmfImage = "Cannot create layout image by WmfImage instance. First convert the image into FormXObject and then use the corresponding layout image constructor";
+    public static final String CannotCreatePdfImageXObjectByWmfImage = "Cannot create PdfImageXObject instance by WmfImage. Use PdfFormXObject constructor instead.";
     public static final String CannotCreatePdfStreamByInputStreamWithoutPdfDocument = "cannot.create.pdfstream.by.inputstream.without.pdfdocument";
     public static final String CannotGetContentBytes = "cannot.get.content.bytes";
     public static final String CannotGetPdfStreamBytes = "cannot.get.pdfstream.bytes";

kernel/src/main/java/com/itextpdf/kernel/pdf/xobject/PdfFormXObject.java

@@ -10,6 +10,8 @@
 import com.itextpdf.kernel.pdf.PdfResources;
 import com.itextpdf.kernel.pdf.PdfStream;
 import com.itextpdf.kernel.pdf.PdfString;
+import com.itextpdf.kernel.pdf.canvas.wmf.WmfImage;
+import com.itextpdf.kernel.pdf.canvas.wmf.WmfImageHelper;
 
 public class PdfFormXObject extends PdfXObject {
 
@@ -41,6 +43,17 @@ public PdfFormXObject(PdfPage page) {
         getPdfObject().put(PdfName.Resources, resources.getPdfObject());
     }
 
+    /**
+     * Creates a form XObject from {@link WmfImage}.
+     * Unlike other images, {@link WmfImage} images are represented as {@link PdfFormXObject}, not as
+     * {@link PdfImageXObject}.
+     * @param image image to create form object from
+     * @param pdfDocument document instance which is needed for writing form stream contents
+     */
+    public PdfFormXObject(WmfImage image, PdfDocument pdfDocument) {
+        this(new WmfImageHelper(image).createPdfForm(pdfDocument).getPdfObject());
+    }
+
     public PdfResources getResources() {
         if (this.resources == null) {
             PdfDictionary resources = getPdfObject().getAsDictionary(PdfName.Resources);

kernel/src/main/java/com/itextpdf/kernel/pdf/xobject/PdfImageXObject.java

@@ -7,6 +7,7 @@
 import com.itextpdf.io.image.RawImage;
 import com.itextpdf.io.image.RawImageHelper;
 import com.itextpdf.io.source.ByteArrayOutputStream;
+import com.itextpdf.kernel.PdfException;
 import com.itextpdf.kernel.Version;
 import com.itextpdf.kernel.pdf.PdfArray;
 import com.itextpdf.kernel.pdf.PdfBoolean;
@@ -20,6 +21,7 @@
 import com.itextpdf.kernel.pdf.PdfReader;
 import com.itextpdf.kernel.pdf.PdfStream;
 import com.itextpdf.kernel.pdf.PdfString;
+import com.itextpdf.kernel.pdf.canvas.wmf.WmfImage;
 import com.itextpdf.kernel.pdf.filters.DoNothingFilter;
 import com.itextpdf.kernel.pdf.filters.FilterHandler;
 import com.itextpdf.kernel.pdf.filters.FilterHandlers;
@@ -48,7 +50,7 @@ public PdfImageXObject(Image image) {
     }
 
     public PdfImageXObject(Image image, PdfImageXObject imageMask) {
-        this(createPdfStream(image, imageMask));
+        this(createPdfStream(checkImageType(image), imageMask));
         mask = image.isMask();
         softMask = image.isSoftMask();
     }
@@ -425,4 +427,12 @@ private void findColorspace(PdfObject colorspace, boolean allowIndexed) {
         }
     }
 
+    private static Image checkImageType(Image image) {
+        if (image instanceof WmfImage) {
+            throw new PdfException(PdfException.CannotCreatePdfImageXObjectByWmfImage);
+        }
+        return image;
+    }
+
+
 }

layout/src/main/java/com/itextpdf/layout/Property.java

@@ -27,6 +27,7 @@ public enum Property {
     COLSPAN,
     DESTINATION,
     FIRST_LINE_INDENT(true),
+    FLUSH_ON_DRAW,
     FONT(true),
     FONT_COLOR(true),
     FONT_KERNING(true),

layout/src/main/java/com/itextpdf/layout/element/Image.java

@@ -1,7 +1,9 @@
 package com.itextpdf.layout.element;
 
 import com.itextpdf.io.LogMessageConstant;
+import com.itextpdf.kernel.PdfException;
 import com.itextpdf.kernel.pdf.PdfName;
+import com.itextpdf.kernel.pdf.canvas.wmf.WmfImage;
 import com.itextpdf.kernel.pdf.tagutils.AccessibleElementProperties;
 import com.itextpdf.kernel.pdf.tagutils.IAccessibleElement;
 import com.itextpdf.kernel.pdf.xobject.PdfFormXObject;
@@ -96,8 +98,8 @@ public Image(PdfFormXObject xObject, float x, float y) {
      * @param img an internal representation of the {@link com.itextpdf.io.image.Image image resource}
      */
     public Image(com.itextpdf.io.image.Image img) {
-        this(new PdfImageXObject(img));
-        // TODO flush this on renderer's draw DEVSIX-479
+        this(new PdfImageXObject(checkImageType(img)));
+        setProperty(Property.FLUSH_ON_DRAW, true);
     }
 
     /**
@@ -108,14 +110,7 @@ public Image(com.itextpdf.io.image.Image img) {
      * @param y a float value representing the vertical offset of the lower left corner of the image
      */
     public Image(com.itextpdf.io.image.Image img, float x, float y) {
-        //@TODO DEVSIX-329
-//        if (img instanceof WmfImage) {
-//            this.xObject = new PdfFormXObject(new WmfImageHelper(img).createPdfForm());
-//        } else {
-//            this.xObject = new PdfImageXObject(img);
-//        }
-//        setProperty(Property.X, x).setProperty(Property.Y, y);
-        this(new PdfImageXObject(img), x, y);
+        this(new PdfImageXObject(checkImageType(img)), x, y);
     }
 
     /**
@@ -127,14 +122,7 @@ public Image(com.itextpdf.io.image.Image img, float x, float y) {
      * @param width a float value
      */
     public Image(com.itextpdf.io.image.Image img, float x, float y, float width) {
-        //@TODO DEVSIX-329
-//        if (img instanceof WmfImage) {
-//            this.xObject = new PdfFormXObject(new WmfImageHelper(img).createPdfForm());
-//        } else {
-//            this.xObject = new PdfImageXObject(img);
-//        }
-//        setProperty(Property.X, x).setProperty(Property.Y, y).setWidth(width).setProperty(Property.POSITION, LayoutPosition.FIXED);
-        this(new PdfImageXObject(img), x, y, width);
+        this(new PdfImageXObject(checkImageType(img)), x, y, width);
     }
 
     /**
@@ -422,4 +410,11 @@ public AccessibleElementProperties getAccessibilityProperties() {
     protected IRenderer makeNewRenderer() {
         return new ImageRenderer(this);
     }
+
+    private static com.itextpdf.io.image.Image checkImageType(com.itextpdf.io.image.Image image) {
+        if (image instanceof WmfImage) {
+            throw new PdfException(PdfException.CannotCreatePdfStreamByInputStreamWithoutPdfDocument);
+        }
+        return image;
+    }
 }

layout/src/main/java/com/itextpdf/layout/renderer/ImageRenderer.java

@@ -160,8 +160,11 @@ public void draw(DrawContext drawContext) {
             canvas.openTag(new CanvasArtifact());
         }
 
-        canvas.addXObject(((Image) (getModelElement())).getXObject(), matrix[0], matrix[1], matrix[2], matrix[3],
-                fixedXPosition + deltaX, fixedYPosition);
+        PdfXObject xObject = ((Image) (getModelElement())).getXObject();
+        canvas.addXObject(xObject, matrix[0], matrix[1], matrix[2], matrix[3], fixedXPosition + deltaX, fixedYPosition);
+        if (Boolean.valueOf(true).equals(getPropertyAsBoolean(Property.FLUSH_ON_DRAW))) {
+            xObject.flush();
+        }
 
         if (isTagged || isArtifact) {
             canvas.closeTag();