如何使用apache poi在word文档中用占位符或某些图像替换图形？

Question

Let's assume i have a word document, with this body. Word document before replacing images

    private void findImages(XWPFParagraph p) {
    for (XWPFRun r : p.getRuns()) {
        for (XWPFPicture pic : r.getEmbeddedPictures()) {
            XWPFPicture picture = pic;
                XWPFPictureData source = picture.getPictureData();
                BufferedImage qrCodeImage = printVersionService.generateQRCodeImage("JASAW EMA WWS");
                File imageFile = new File("image.jpg");
                try {
                    ImageIO.write(qrCodeImage, "jpg", imageFile);
                } catch (IOException e) {
                    e.printStackTrace();
                }

                try ( FileInputStream in = new FileInputStream(imageFile);
                      OutputStream out = source.getPackagePart().getOutputStream();
                ) {
                    byte[] buffer = new byte[2048];
                    int length;
                    while ((length = in.read(buffer)) > 0) {
                        out.write(buffer, 0, length);
                    }
                } catch (Exception ex) {
                    ex.printStackTrace();
                }
        }
     }
}

So this code replaces any image with QR code.

But I have one trouble.

Word Document after replacing

So my question is? How can I replace only the image i chose or how can i replace inserted figure with text with image generated by my own function?

Answer 1

Detecting the picture and replacing the picture data will be the simplest. In following answer I have shown how to detect and replace pictures by name: Java Apache POI: insert an image "infront the text" . If you do not know the name of the embedded picture, a picture also can be detected by alt text. To edit the alt text of a picture, open the context menu by right mouse click on the picture and choose Edit A̲lt Text from that context menu.

In How to read alt text of image in word document apache.poi I have shown already how to read alt text of image.

So code could look like:

import java.io.FileInputStream;
import java.io.OutputStream;
import java.io.FileOutputStream;
import org.apache.poi.xwpf.usermodel.*;

public class WordReplacePictureData {
    
 static org.apache.xmlbeans.XmlObject getInlineOrAnchor(org.openxmlformats.schemas.drawingml.x2006.picture.CTPicture ctPictureToFind, org.apache.xmlbeans.XmlObject inlineOrAnchor) {
  String declareNameSpaces = "declare namespace pic='http://schemas.openxmlformats.org/drawingml/2006/picture'; ";
  org.apache.xmlbeans.XmlObject[] selectedObjects = inlineOrAnchor.selectPath(
   declareNameSpaces 
   + "$this//pic:pic");
  for (org.apache.xmlbeans.XmlObject selectedObject : selectedObjects) {
   if (selectedObject instanceof org.openxmlformats.schemas.drawingml.x2006.picture.CTPicture) {
    org.openxmlformats.schemas.drawingml.x2006.picture.CTPicture ctPicture = (org.openxmlformats.schemas.drawingml.x2006.picture.CTPicture)selectedObject;
    if (ctPictureToFind.equals(ctPicture)) {
     // this is the inlineOrAnchor for that picture   
     return inlineOrAnchor;
    }        
   }          
  }
  return null;
 }
                
 static org.apache.xmlbeans.XmlObject getInlineOrAnchor(XWPFRun run, XWPFPicture picture) {
  org.openxmlformats.schemas.drawingml.x2006.picture.CTPicture ctPictureToFind = picture.getCTPicture();
  for (org.openxmlformats.schemas.wordprocessingml.x2006.main.CTDrawing drawing : run.getCTR().getDrawingList()) {
   for (org.openxmlformats.schemas.drawingml.x2006.wordprocessingDrawing.CTInline inline : drawing.getInlineList()) {
    org.apache.xmlbeans.XmlObject inlineOrAnchor = getInlineOrAnchor(ctPictureToFind, inline);
    // if inlineOrAnchor is not null, then this is the inline for that picture
    if (inlineOrAnchor != null) return inlineOrAnchor;
   }
   for (org.openxmlformats.schemas.drawingml.x2006.wordprocessingDrawing.CTAnchor anchor : drawing.getAnchorList()) {
    org.apache.xmlbeans.XmlObject inlineOrAnchor = getInlineOrAnchor(ctPictureToFind, anchor);
    // if inlineOrAnchor is not null, then this is the anchor for that picture
    if (inlineOrAnchor != null) return inlineOrAnchor;
   }
  }
  return null;
 }

 static org.openxmlformats.schemas.drawingml.x2006.main.CTNonVisualDrawingProps getNonVisualDrawingProps(org.apache.xmlbeans.XmlObject inlineOrAnchor) {
  if (inlineOrAnchor == null) return null;
  if (inlineOrAnchor instanceof org.openxmlformats.schemas.drawingml.x2006.wordprocessingDrawing.CTInline) {
   org.openxmlformats.schemas.drawingml.x2006.wordprocessingDrawing.CTInline inline = (org.openxmlformats.schemas.drawingml.x2006.wordprocessingDrawing.CTInline)inlineOrAnchor;
   return inline.getDocPr();    
  } else if (inlineOrAnchor instanceof org.openxmlformats.schemas.drawingml.x2006.wordprocessingDrawing.CTAnchor) {
   org.openxmlformats.schemas.drawingml.x2006.wordprocessingDrawing.CTAnchor anchor = (org.openxmlformats.schemas.drawingml.x2006.wordprocessingDrawing.CTAnchor)inlineOrAnchor;
   return anchor.getDocPr();
  }
  return null;
 }

 static String getSummary(org.openxmlformats.schemas.drawingml.x2006.main.CTNonVisualDrawingProps nonVisualDrawingProps) {
  if (nonVisualDrawingProps == null) return "";
  String summary = "Id:=" + nonVisualDrawingProps.getId();
  summary += " Name:=" + nonVisualDrawingProps.getName();
  summary += " Title:=" + nonVisualDrawingProps.getTitle();
  summary += " Descr:=" + nonVisualDrawingProps.getDescr();
  return summary;
 }
    
 static XWPFPicture getPictureByAltText(XWPFRun run, String altText) {
  if (altText == null) return null;
  for (XWPFPicture picture : run.getEmbeddedPictures()) {
   String altTextSummary = getSummary(getNonVisualDrawingProps(getInlineOrAnchor(run, picture)));
   System.out.println(altTextSummary);
   if (altTextSummary.contains(altText)) {
    return picture;   
   }
  }
  return null;
 }
 
 static void replacePictureData(XWPFPictureData source, String pictureResultPath) {
  try ( FileInputStream in = new FileInputStream(pictureResultPath); 
        OutputStream out = source.getPackagePart().getOutputStream();
       ) {
   byte[] buffer = new byte[2048];
   int length;
   while ((length = in.read(buffer)) > 0) {
    out.write(buffer, 0, length);
   }
  } catch (Exception ex) {
   ex.printStackTrace();  
  }
 }
 
 static void replacePicture(XWPFRun run, String altText, String pictureResultPath) {
  XWPFPicture picture = getPictureByAltText(run, altText);
  if (picture != null) {
   XWPFPictureData source = picture.getPictureData();
   replacePictureData(source, pictureResultPath);
  }   
 }

 public static void main(String[] args) throws Exception {
  String templatePath = "./source.docx";
  String resultPath = "./result.docx";
  String altText = "Placeholder QR-Code";
  String pictureResultPath = "./QR.jpg";
  
  try ( XWPFDocument document = new XWPFDocument(new FileInputStream(templatePath));
        FileOutputStream out = new FileOutputStream(resultPath);
       ) {
   
   for (IBodyElement bodyElement : document.getBodyElements()) {
    if (bodyElement instanceof XWPFParagraph) {
     XWPFParagraph paragraph = (XWPFParagraph)bodyElement;
     for (XWPFRun run : paragraph.getRuns()) {
      replacePicture(run, altText, pictureResultPath);
     }
    }
   }       
   document.write(out);
  }    
 }
}

This replaces the picture or pictures having alt text "Placeholder QR-Code". All other pictures remain as they are.

Replacing shapes with pictures is very laborious as shapes are stored in alternate content elements (to choice shape and fallback) and so the shape needs to be changed as well as the fallback. If one would let the fallback untouched, then applications which rely on that fallback will further show the old shape. Furthermore detecting shapes by text box content is not really much simpler than detecting pictures by alt text content.