Module pro.verron.officestamper
Package pro.verron.officestamper.preset

Class Image

java.lang.Object
pro.verron.officestamper.preset.Image
public final class Image extends Object
This class describes an image which will be inserted into a document.
Since:
1.0.0
Version:
${version}
Author:
Joseph Verron, Romster

  • Constructor Details

    • Image

      public Image(InputStream in) throws IOException

      Constructor for Image.

      Parameters:
      in - - content of the image as InputStream
      Throws:
      IOException - if any.

    • Image

      public Image(InputStream in, Integer maxWidth) throws IOException

      Constructor for Image.

      Parameters:
      in - - content of the image as InputStream
      maxWidth - - max width of the image in twip
      Throws:
      IOException - if any.

    • Image

      public Image(byte[] imageBytes)

      Constructor for Image.

      Parameters:
      imageBytes - - content of the image as an array of the bytes

    • Image

      public Image(byte[] imageBytes, Integer maxWidth)

      Constructor for Image.

      Parameters:
      imageBytes - - content of the image as an array of the bytes
      maxWidth - - max width of the image in twip

  • Method Details

    • newRun

      public org.docx4j.wml.R newRun(DocxPart document, String filenameHint, String altText)
      Creates a new run with the provided image and associated metadata.

      TODO: adding the same image twice will put the image twice into the docx-zip file. We should make the second addition of the same image a reference instead.

      Parameters:
      document - The document part where the image will be inserted.
      filenameHint - A hint for the filename to be used.
      altText - Alternative text for the image.
      Returns:
      The created run containing the image.
      Throws:
      OfficeStamperException - If there is an error creating the image part

    • getMaxWidth

      @Deprecated(since="2.6", forRemoval=true) public Integer getMaxWidth()
      Deprecated, for removal: This API element is subject to removal in a future version.
      use the newRun(DocxPart, String, String) method directly to generate a Run with Inline Drawing

      Getter for the field maxWidth.

      Returns:
      a Integer object

    • getImageBytes

      @Deprecated(since="2.6", forRemoval=true) public byte[] getImageBytes()
      Deprecated, for removal: This API element is subject to removal in a future version.
      use the newRun(DocxPart, String, String) method directly to generate a Run with Inline Drawing

      Getter for the field imageBytes.

      Returns:
      an array of
      invalid reference 
      byte
      objects