Replace a image with Apache POI

Question

I need help by replacing an image with another image in Word using Apache POI or any other library that might do the job. I know how to replace a word using Apache POI but I can't figure a way out to replace an image.

public static void main(String[] args) throws FileNotFoundException {

    String c22 = "OTHER WORD";

    try {
        XWPFDocument doc = new XWPFDocument(OPCPackage.open("imagine.docx"));
        for (XWPFParagraph p : doc.getParagraphs()) {
            List<XWPFRun> runs = p.getRuns();
            if (runs != null) {
                for (XWPFRun r : runs) {
                    String text = r.getText(0);
                    if (text != null ) {
                        String imgFile = "imaginedeschis.jpg";
                         try (FileInputStream is = new FileInputStream(imgFile)) {
                             r.addPicture(is, XWPFDocument.PICTURE_TYPE_JPEG, imgFile,
                                          Units.toEMU(200), Units.toEMU(200)); // 200x200 pixels
                             text = text.replace("1ST WORD", c22);
                         } // 200x200 pixels
                         r.setText(text, 0);
                    }
                }
            }  
        }       
        doc.write(new FileOutputStream("output.docx"));
    } catch (InvalidFormatException | IOException m){ }
}

Answer 1

I am using below Java code to replace one image in Word document (*.docx). Please share if anyone have better approach.

    public XWPFDocument replaceImage(XWPFDocument document, String imageOldName, String imagePathNew, int newImageWidth, int newImageHeight) throws Exception {
    try {
        LOG.info("replaceImage: old=" + imageOldName + ", new=" + imagePathNew);

        int imageParagraphPos = -1;
        XWPFParagraph imageParagraph = null;

        List<IBodyElement> documentElements = document.getBodyElements();
        for(IBodyElement documentElement : documentElements){
            imageParagraphPos ++;
            if(documentElement instanceof XWPFParagraph){
                imageParagraph = (XWPFParagraph) documentElement;
                if(imageParagraph != null && imageParagraph.getCTP() != null && imageParagraph.getCTP().toString().trim().indexOf(imageOldName) != -1) {
                    break;
                }
            }
        }

        if (imageParagraph == null) {
            throw new Exception("Unable to replace image data due to the exception:\n"
                    + "'" + imageOldName + "' not found in in document.");
        }
        ParagraphAlignment oldImageAlignment = imageParagraph.getAlignment();

        // remove old image
        document.removeBodyElement(imageParagraphPos);

        // now add new image

        // BELOW LINE WILL CREATE AN IMAGE
        // PARAGRAPH AT THE END OF THE DOCUMENT.
        // REMOVE THIS IMAGE PARAGRAPH AFTER 
        // SETTING THE NEW IMAGE AT THE OLD IMAGE POSITION
        XWPFParagraph newImageParagraph = document.createParagraph();    
        XWPFRun newImageRun = newImageParagraph.createRun();
        //newImageRun.setText(newImageText);
        newImageParagraph.setAlignment(oldImageAlignment);
        try (FileInputStream is = new FileInputStream(imagePathNew)) {
            newImageRun.addPicture(is, XWPFDocument.PICTURE_TYPE_JPEG, imagePathNew,
                         Units.toEMU(newImageWidth), Units.toEMU(newImageHeight)); 
        } 

        // set new image at the old image position
        document.setParagraph(newImageParagraph, imageParagraphPos);

        // NOW REMOVE REDUNDANT IMAGE FORM THE END OF DOCUMENT
        document.removeBodyElement(document.getBodyElements().size() - 1);

        return document;
    } catch (Exception e) {
        throw new Exception("Unable to replace image '" + imageOldName + "' due to the exception:\n" + e);
    } finally {
        // cleanup code
    }
}

Please visit https://bitbucket.org/wishcoder/java-poi-word-document/wiki/Home for more examples like:

• Open existing Microsoft Word Document (*.docx)
• Clone Table in Word Document and add new data to cloned table
• Update existing Table->Cell data in document
• Update existing Hyper Link in document
• Replace existing Image in document
• Save update Microsoft Word Document (*.docx)