Class BinaryPartAbstractImage


  • public class BinaryPartAbstractImage
    extends java.lang.Object
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected static org.slf4j.Logger log  
    • Constructor Summary

      Constructors 
      Constructor Description
      BinaryPartAbstractImage​(org.docx4j.openpackaging.parts.WordprocessingML.BinaryPartAbstractImage abstractImage)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      org.docx4j.relationships.Relationship addTargetPart​(org.docx4j.openpackaging.parts.Part targetpart)  
      org.docx4j.relationships.Relationship addTargetPart​(org.docx4j.openpackaging.parts.Part targetpart, java.lang.String proposedRelId)  
      org.docx4j.relationships.Relationship addTargetPart​(org.docx4j.openpackaging.parts.Part targetpart, org.docx4j.openpackaging.parts.relationships.RelationshipsPart.AddPartBehaviour mode)  
      org.docx4j.relationships.Relationship addTargetPart​(org.docx4j.openpackaging.parts.Part targetpart, org.docx4j.openpackaging.parts.relationships.RelationshipsPart.AddPartBehaviour mode, java.lang.String proposedRelId)  
      static void convertToPNG​(java.io.InputStream is, java.io.OutputStream os, int density)  
      static void copy2​(java.io.InputStream is, java.io.OutputStream os)  
      org.docx4j.dml.wordprocessingDrawing.Anchor createImageAnchor​(java.lang.String filenameHint, java.lang.String altText, int id1, int id2, boolean link, int maxWidth, int maxHeight, long posHOffset, long posVOffset)  
      org.docx4j.dml.wordprocessingDrawing.Anchor createImageAnchor​(java.lang.String filenameHint, java.lang.String altText, int id1, int id2, boolean link, long posHOffset, long posVOffset)
      Create a <wp:inline> element suitable for this image, which can be linked or embedded in w:p/w:r/w:drawing.
      org.docx4j.dml.wordprocessingDrawing.Anchor createImageAnchor​(java.lang.String filenameHint, java.lang.String altText, int id1, int id2, long cx, boolean link, long posHOffset, long posVOffset)
      Create a <wp:inline> element suitable for this image, which can be _embedded_ in w:p/w:r/w:drawing.
      org.docx4j.dml.wordprocessingDrawing.Anchor createImageAnchor​(java.lang.String filenameHint, java.lang.String altText, int id1, int id2, long cx, long cy, boolean link, long posHOffset, long posVOffset)
      Create a <wp:anchor> element suitable for this image, which can be linked or embedded in w:p/w:r/w:drawing, specifying height and width.
      org.docx4j.dml.wordprocessingDrawing.Inline createImageInline​(java.lang.String filenameHint, java.lang.String altText, int id1, int id2)
      Deprecated.
      org.docx4j.dml.wordprocessingDrawing.Inline createImageInline​(java.lang.String filenameHint, java.lang.String altText, int id1, int id2, boolean link)  
      org.docx4j.dml.wordprocessingDrawing.Inline createImageInline​(java.lang.String filenameHint, java.lang.String altText, int id1, int id2, boolean link, int maxWidth)  
      org.docx4j.dml.wordprocessingDrawing.Inline createImageInline​(java.lang.String filenameHint, java.lang.String altText, int id1, int id2, boolean link, int maxWidth, int maxHeight)  
      org.docx4j.dml.wordprocessingDrawing.Inline createImageInline​(java.lang.String filenameHint, java.lang.String altText, int id1, int id2, long cx)
      Deprecated.
      org.docx4j.dml.wordprocessingDrawing.Inline createImageInline​(java.lang.String filenameHint, java.lang.String altText, int id1, int id2, long cx, boolean link)  
      org.docx4j.dml.wordprocessingDrawing.Inline createImageInline​(java.lang.String filenameHint, java.lang.String altText, int id1, int id2, long cx, long cy, boolean link)  
      static java.lang.String createImageName​(org.docx4j.openpackaging.Base sourcePart, java.lang.String proposedRelId, java.lang.String ext)
      Deprecated.
      static java.lang.String createImageName​(org.docx4j.openpackaging.packages.OpcPackage opcPackage, org.docx4j.openpackaging.Base sourcePart, java.lang.String proposedRelId, java.lang.String ext)  
      static BinaryPartAbstractImage createImagePart​(org.docx4j.openpackaging.packages.OpcPackage opcPackage, org.docx4j.openpackaging.parts.Part sourcePart, byte[] bytes)
      Create an image part from the provided byte array, attach it to the source part (eg the main document part, a header part etc), and return it.
      static org.docx4j.openpackaging.parts.WordprocessingML.BinaryPartAbstractImage createImagePart​(org.docx4j.openpackaging.packages.OpcPackage opcPackage, org.docx4j.openpackaging.parts.Part sourcePart, byte[] bytes, java.lang.String mime)  
      static org.docx4j.openpackaging.parts.WordprocessingML.BinaryPartAbstractImage createImagePart​(org.docx4j.openpackaging.packages.OpcPackage opcPackage, org.docx4j.openpackaging.parts.Part sourcePart, byte[] bytes, java.lang.String mime, java.lang.String ext)
      Deprecated.
      static org.docx4j.openpackaging.parts.WordprocessingML.BinaryPartAbstractImage createImagePart​(org.docx4j.openpackaging.packages.OpcPackage opcPackage, org.docx4j.openpackaging.parts.Part sourcePart, java.io.File imageFile)  
      static org.docx4j.openpackaging.parts.WordprocessingML.BinaryPartAbstractImage createImagePart​(org.docx4j.openpackaging.packages.WordprocessingMLPackage wordMLPackage, byte[] bytes)  
      static org.docx4j.openpackaging.parts.WordprocessingML.BinaryPartAbstractImage createImagePart​(org.docx4j.openpackaging.packages.WordprocessingMLPackage wordMLPackage, java.io.File imageFile)  
      static org.docx4j.openpackaging.parts.WordprocessingML.BinaryPartAbstractImage createLinkedImagePart​(org.docx4j.openpackaging.packages.OpcPackage opcPackage, org.docx4j.openpackaging.parts.Part sourcePart, java.net.URL url)  
      static org.docx4j.openpackaging.parts.WordprocessingML.BinaryPartAbstractImage createLinkedImagePart​(org.docx4j.openpackaging.packages.WordprocessingMLPackage wordMLPackage, java.net.URL fileurl)  
      static void displayImageInfo​(org.apache.xmlgraphics.image.loader.ImageInfo info)  
      java.nio.ByteBuffer getBuffer()  
      byte[] getBytes()  
      long getContentLengthAsLoaded()  
      java.lang.String getContentType()  
      org.docx4j.openpackaging.parts.ExternalTarget getExternalTarget()  
      static byte[] getImage​(org.docx4j.openpackaging.packages.WordprocessingMLPackage wmlPkg, org.docx4j.dml.Graphic graphic)  
      org.apache.xmlgraphics.image.loader.ImageInfo getImageInfo()
      Deprecated.
      static org.apache.xmlgraphics.image.loader.ImageInfo getImageInfo​(java.net.URL url)  
      org.docx4j.openpackaging.parts.relationships.RelationshipsPart getOwningRelationshipPart()
      Deprecated.
      org.docx4j.openpackaging.packages.OpcPackage getPackage()  
      org.docx4j.openpackaging.parts.PartName getPartName()  
      org.docx4j.openpackaging.parts.relationships.RelationshipsPart getRelationshipsPart()  
      org.docx4j.openpackaging.parts.relationships.RelationshipsPart getRelationshipsPart​(boolean createIfAbsent)  
      java.lang.String getRelationshipType()  
      org.docx4j.relationships.Relationship getRelLast()  
      java.util.List<org.docx4j.relationships.Relationship> getRels()  
      org.docx4j.relationships.Relationship getSourceRelationship()
      Deprecated.
      java.util.List<org.docx4j.relationships.Relationship> getSourceRelationships()  
      java.lang.Object getUserData​(java.lang.String key)  
      long getVersion()  
      boolean isContentEqual​(org.docx4j.openpackaging.parts.Part other)  
      boolean isLoaded()  
      static void main​(java.lang.String[] args)  
      void remove()  
      void rename​(org.docx4j.openpackaging.parts.PartName newName)  
      void reset()  
      static org.docx4j.openpackaging.parts.WordprocessingML.BinaryPartAbstractImage.CxCy scale​(org.apache.xmlgraphics.image.loader.ImageInfo imageInfo, org.docx4j.model.structure.PageDimensions page, int maxWidth, int maxHeight)
      Return scaling values constrained by specified maxWidth/maxHeight.
      void setBinaryData​(byte[] bytes)  
      void setBinaryData​(java.io.InputStream binaryData)  
      void setBinaryData​(java.nio.ByteBuffer bb)  
      void setContentType​(org.docx4j.openpackaging.contenttype.ContentType contentType)  
      static void setDensity​(int density)  
      void setImageInfo​(org.apache.xmlgraphics.image.loader.ImageInfo imageInfo)
      Deprecated.
      void setOwningRelationshipPart​(org.docx4j.openpackaging.parts.relationships.RelationshipsPart owningRelationshipPart)
      Deprecated.
      void setPackage​(org.docx4j.openpackaging.packages.OpcPackage pack)  
      void setPartName​(org.docx4j.openpackaging.parts.PartName partName)  
      boolean setPartShortcut​(org.docx4j.openpackaging.parts.Part part, java.lang.String relationshipType)  
      void setRelationships​(org.docx4j.openpackaging.parts.relationships.RelationshipsPart relationships)  
      void setRelationshipType​(java.lang.String relationshipType)  
      void setSourceRelationship​(org.docx4j.relationships.Relationship sourceRelationship)
      Deprecated.
      void setUserData​(java.lang.String key, java.lang.Object value)  
      void setVersion​(long version)  
      void writeDataToOutputStream​(java.io.OutputStream out)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • log

        protected static org.slf4j.Logger log
    • Constructor Detail

      • BinaryPartAbstractImage

        public BinaryPartAbstractImage​(org.docx4j.openpackaging.parts.WordprocessingML.BinaryPartAbstractImage abstractImage)
    • Method Detail

      • createImageAnchor

        public org.docx4j.dml.wordprocessingDrawing.Anchor createImageAnchor​(java.lang.String filenameHint,
                                                                             java.lang.String altText,
                                                                             int id1,
                                                                             int id2,
                                                                             boolean link,
                                                                             long posHOffset,
                                                                             long posVOffset)
                                                                      throws java.lang.Exception
        Create a <wp:inline> element suitable for this image, which can be linked or embedded in w:p/w:r/w:drawing. If the image is wider than the page, it will be scaled automatically.
        Parameters:
        filenameHint - Any text, for example the original filename
        altText - Like HTML's alt text
        id1 - An id unique in the document
        id2 - Another id unique in the document
        link - true if this is to be linked not embedded None of these things seem to be exposed in Word 2007's user interface, but Word won't open the document if any of the attributes these go in (except @ desc) aren't present!
        posHOffset - offset from column, Long.MAX_VALUE for right aligned, Long.MIN_VALUE for left aligned, Long.MAX_VALUE/2 for centered
        posVOffset - offset from paragraph
        Returns:
        anchor element
        Throws:
        java.lang.Exception - throws exceptions on failure
      • createImageAnchor

        public org.docx4j.dml.wordprocessingDrawing.Anchor createImageAnchor​(java.lang.String filenameHint,
                                                                             java.lang.String altText,
                                                                             int id1,
                                                                             int id2,
                                                                             boolean link,
                                                                             int maxWidth,
                                                                             int maxHeight,
                                                                             long posHOffset,
                                                                             long posVOffset)
                                                                      throws java.lang.Exception
        Parameters:
        filenameHint - file name hint
        altText - description
        id1 - <wp:docPr id
        id2 - <pic:cNvPr id
        link - true if to link, else embed
        maxWidth - max width of image
        maxHeight - max height of image
        posHOffset - offset from column, Long.MAX_VALUE for right aligned, Long.MIN_VALUE for left aligned, Long.MAX_VALUE/2 for centered
        posVOffset - offset from paragraph
        Returns:
        anchor element
        Throws:
        java.lang.Exception - throws exceptions on failure
      • scale

        public static org.docx4j.openpackaging.parts.WordprocessingML.BinaryPartAbstractImage.CxCy scale​(org.apache.xmlgraphics.image.loader.ImageInfo imageInfo,
                                                                                                         org.docx4j.model.structure.PageDimensions page,
                                                                                                         int maxWidth,
                                                                                                         int maxHeight)
        Return scaling values constrained by specified maxWidth/maxHeight. Useful if the image is to be inserted into a table cell of known width.
        Parameters:
        imageInfo - image info
        page - page dimensions
        maxWidth - max width
        maxHeight - max height
        Returns:
        cx cy sizes
        Since:
        3.3.0
      • createImageAnchor

        public org.docx4j.dml.wordprocessingDrawing.Anchor createImageAnchor​(java.lang.String filenameHint,
                                                                             java.lang.String altText,
                                                                             int id1,
                                                                             int id2,
                                                                             long cx,
                                                                             boolean link,
                                                                             long posHOffset,
                                                                             long posVOffset)
                                                                      throws java.lang.Exception
        Create a <wp:inline> element suitable for this image, which can be _embedded_ in w:p/w:r/w:drawing.
        Parameters:
        filenameHint - Any text, for example the original filename
        altText - Like HTML's alt text
        id1 - <wp:docPr id
        id2 - <pic:cNvPr id
        cx - Image width in twip
        link - true if this is to be linked not embedded None of these things seem to be exposed in Word 2007's user interface, but Word won't open the document if any of the attributes these go in (except @ desc) aren't present!
        posHOffset - offset from column, Long.MAX_VALUE for right aligned, Long.MIN_VALUE for left aligned, Long.MAX_VALUE/2 for centered
        posVOffset - offset from paragraph
        Returns:
        anchor element
        Throws:
        java.lang.Exception - throws exceptions on failure
      • createImageAnchor

        public org.docx4j.dml.wordprocessingDrawing.Anchor createImageAnchor​(java.lang.String filenameHint,
                                                                             java.lang.String altText,
                                                                             int id1,
                                                                             int id2,
                                                                             long cx,
                                                                             long cy,
                                                                             boolean link,
                                                                             long posHOffset,
                                                                             long posVOffset)
                                                                      throws java.lang.Exception
        Create a <wp:anchor> element suitable for this image, which can be linked or embedded in w:p/w:r/w:drawing, specifying height and width. Note that you'd ordinarily use one of the methods which don't require you to specify height (cy).
        Parameters:
        filenameHint - Any text, for example the original filename
        altText - Like HTML's alt text
        id1 - <wp:docPr id
        id2 - <pic:cNvPr id
        cx - Image width in EMU
        cy - Image height in EMU
        link - true if this is to be linked not embedded
        posHOffset - offset from column, Long.MAX_VALUE for right aligned, Long.MIN_VALUE for left aligned, Long.MAX_VALUE/2 for centered
        posVOffset - offset from paragraph
        Returns:
        anchor element
        Throws:
        java.lang.Exception - throws exceptions on failure
      • createImageInline

        public org.docx4j.dml.wordprocessingDrawing.Inline createImageInline​(java.lang.String filenameHint,
                                                                             java.lang.String altText,
                                                                             int id1,
                                                                             int id2,
                                                                             boolean link,
                                                                             int maxWidth,
                                                                             int maxHeight)
                                                                      throws java.lang.Exception
        Parameters:
        filenameHint - Any text, for example the original filename
        altText - Like HTML's alt text
        id1 - <wp:docPr id
        id2 - <pic:cNvPr id
        link - true if this is to be linked not embedded
        maxWidth - max width
        maxHeight - max height
        Returns:
        inline element
        Throws:
        java.lang.Exception - throws exceptions on failure
        Since:
        3.3.0
      • createImagePart

        public static BinaryPartAbstractImage createImagePart​(org.docx4j.openpackaging.packages.OpcPackage opcPackage,
                                                              org.docx4j.openpackaging.parts.Part sourcePart,
                                                              byte[] bytes)
                                                       throws java.lang.Exception
        Create an image part from the provided byte array, attach it to the source part (eg the main document part, a header part etc), and return it.

        Works for both docx and pptx.

        Note: this method creates a temp file (and attempts to delete it). That's because it uses org.apache.xmlgraphics

        Parameters:
        opcPackage - package
        sourcePart - part
        bytes - image bytes
        Returns:
        binary image
        Throws:
        java.lang.Exception - throws exceptions on failure
      • getImageInfo

        @Deprecated
        public org.apache.xmlgraphics.image.loader.ImageInfo getImageInfo()
        Deprecated.
      • setImageInfo

        @Deprecated
        public void setImageInfo​(org.apache.xmlgraphics.image.loader.ImageInfo imageInfo)
        Deprecated.
      • getRels

        public java.util.List<org.docx4j.relationships.Relationship> getRels()
      • getRelLast

        public org.docx4j.relationships.Relationship getRelLast()
      • setDensity

        public static void setDensity​(int density)
      • createImagePart

        public static org.docx4j.openpackaging.parts.WordprocessingML.BinaryPartAbstractImage createImagePart​(org.docx4j.openpackaging.packages.WordprocessingMLPackage wordMLPackage,
                                                                                                              byte[] bytes)
                                                                                                       throws java.lang.Exception
        Throws:
        java.lang.Exception
      • createImagePart

        public static org.docx4j.openpackaging.parts.WordprocessingML.BinaryPartAbstractImage createImagePart​(org.docx4j.openpackaging.packages.WordprocessingMLPackage wordMLPackage,
                                                                                                              java.io.File imageFile)
                                                                                                       throws java.lang.Exception
        Throws:
        java.lang.Exception
      • createImageName

        @Deprecated
        public static java.lang.String createImageName​(org.docx4j.openpackaging.Base sourcePart,
                                                       java.lang.String proposedRelId,
                                                       java.lang.String ext)
        Deprecated.
      • createImageName

        public static java.lang.String createImageName​(org.docx4j.openpackaging.packages.OpcPackage opcPackage,
                                                       org.docx4j.openpackaging.Base sourcePart,
                                                       java.lang.String proposedRelId,
                                                       java.lang.String ext)
      • createImagePart

        @Deprecated
        public static org.docx4j.openpackaging.parts.WordprocessingML.BinaryPartAbstractImage createImagePart​(org.docx4j.openpackaging.packages.OpcPackage opcPackage,
                                                                                                              org.docx4j.openpackaging.parts.Part sourcePart,
                                                                                                              byte[] bytes,
                                                                                                              java.lang.String mime,
                                                                                                              java.lang.String ext)
                                                                                                       throws java.lang.Exception
        Deprecated.
        Throws:
        java.lang.Exception
      • createImagePart

        public static org.docx4j.openpackaging.parts.WordprocessingML.BinaryPartAbstractImage createImagePart​(org.docx4j.openpackaging.packages.OpcPackage opcPackage,
                                                                                                              org.docx4j.openpackaging.parts.Part sourcePart,
                                                                                                              byte[] bytes,
                                                                                                              java.lang.String mime)
                                                                                                       throws java.lang.Exception
        Throws:
        java.lang.Exception
      • createImagePart

        public static org.docx4j.openpackaging.parts.WordprocessingML.BinaryPartAbstractImage createImagePart​(org.docx4j.openpackaging.packages.OpcPackage opcPackage,
                                                                                                              org.docx4j.openpackaging.parts.Part sourcePart,
                                                                                                              java.io.File imageFile)
                                                                                                       throws java.lang.Exception
        Throws:
        java.lang.Exception
      • createLinkedImagePart

        public static org.docx4j.openpackaging.parts.WordprocessingML.BinaryPartAbstractImage createLinkedImagePart​(org.docx4j.openpackaging.packages.WordprocessingMLPackage wordMLPackage,
                                                                                                                    java.net.URL fileurl)
                                                                                                             throws java.lang.Exception
        Throws:
        java.lang.Exception
      • createLinkedImagePart

        public static org.docx4j.openpackaging.parts.WordprocessingML.BinaryPartAbstractImage createLinkedImagePart​(org.docx4j.openpackaging.packages.OpcPackage opcPackage,
                                                                                                                    org.docx4j.openpackaging.parts.Part sourcePart,
                                                                                                                    java.net.URL url)
                                                                                                             throws java.lang.Exception
        Throws:
        java.lang.Exception
      • createImageInline

        @Deprecated
        public org.docx4j.dml.wordprocessingDrawing.Inline createImageInline​(java.lang.String filenameHint,
                                                                             java.lang.String altText,
                                                                             int id1,
                                                                             int id2)
                                                                      throws java.lang.Exception
        Deprecated.
        Throws:
        java.lang.Exception
      • createImageInline

        public org.docx4j.dml.wordprocessingDrawing.Inline createImageInline​(java.lang.String filenameHint,
                                                                             java.lang.String altText,
                                                                             int id1,
                                                                             int id2,
                                                                             boolean link)
                                                                      throws java.lang.Exception
        Throws:
        java.lang.Exception
      • createImageInline

        public org.docx4j.dml.wordprocessingDrawing.Inline createImageInline​(java.lang.String filenameHint,
                                                                             java.lang.String altText,
                                                                             int id1,
                                                                             int id2,
                                                                             boolean link,
                                                                             int maxWidth)
                                                                      throws java.lang.Exception
        Throws:
        java.lang.Exception
      • createImageInline

        @Deprecated
        public org.docx4j.dml.wordprocessingDrawing.Inline createImageInline​(java.lang.String filenameHint,
                                                                             java.lang.String altText,
                                                                             int id1,
                                                                             int id2,
                                                                             long cx)
                                                                      throws java.lang.Exception
        Deprecated.
        Throws:
        java.lang.Exception
      • createImageInline

        public org.docx4j.dml.wordprocessingDrawing.Inline createImageInline​(java.lang.String filenameHint,
                                                                             java.lang.String altText,
                                                                             int id1,
                                                                             int id2,
                                                                             long cx,
                                                                             boolean link)
                                                                      throws java.lang.Exception
        Throws:
        java.lang.Exception
      • createImageInline

        public org.docx4j.dml.wordprocessingDrawing.Inline createImageInline​(java.lang.String filenameHint,
                                                                             java.lang.String altText,
                                                                             int id1,
                                                                             int id2,
                                                                             long cx,
                                                                             long cy,
                                                                             boolean link)
                                                                      throws java.lang.Exception
        Throws:
        java.lang.Exception
      • getImageInfo

        public static org.apache.xmlgraphics.image.loader.ImageInfo getImageInfo​(java.net.URL url)
                                                                          throws java.lang.Exception
        Throws:
        java.lang.Exception
      • main

        public static void main​(java.lang.String[] args)
                         throws java.lang.Exception
        Throws:
        java.lang.Exception
      • displayImageInfo

        public static void displayImageInfo​(org.apache.xmlgraphics.image.loader.ImageInfo info)
      • getImage

        public static byte[] getImage​(org.docx4j.openpackaging.packages.WordprocessingMLPackage wmlPkg,
                                      org.docx4j.dml.Graphic graphic)
      • convertToPNG

        public static void convertToPNG​(java.io.InputStream is,
                                        java.io.OutputStream os,
                                        int density)
                                 throws java.io.IOException,
                                        java.lang.InterruptedException
        Throws:
        java.io.IOException
        java.lang.InterruptedException
      • copy2

        public static void copy2​(java.io.InputStream is,
                                 java.io.OutputStream os)
                          throws java.io.IOException
        Throws:
        java.io.IOException
      • getExternalTarget

        public org.docx4j.openpackaging.parts.ExternalTarget getExternalTarget()
      • setBinaryData

        public void setBinaryData​(java.io.InputStream binaryData)
      • setBinaryData

        public void setBinaryData​(byte[] bytes)
      • setBinaryData

        public void setBinaryData​(java.nio.ByteBuffer bb)
      • isLoaded

        public boolean isLoaded()
      • getBuffer

        public java.nio.ByteBuffer getBuffer()
      • writeDataToOutputStream

        public void writeDataToOutputStream​(java.io.OutputStream out)
                                     throws java.io.IOException
        Throws:
        java.io.IOException
      • getBytes

        public byte[] getBytes()
      • isContentEqual

        public boolean isContentEqual​(org.docx4j.openpackaging.parts.Part other)
                               throws org.docx4j.openpackaging.exceptions.Docx4JException
        Throws:
        org.docx4j.openpackaging.exceptions.Docx4JException
      • getSourceRelationships

        public java.util.List<org.docx4j.relationships.Relationship> getSourceRelationships()
      • getSourceRelationship

        @Deprecated
        public org.docx4j.relationships.Relationship getSourceRelationship()
        Deprecated.
      • setSourceRelationship

        @Deprecated
        public void setSourceRelationship​(org.docx4j.relationships.Relationship sourceRelationship)
        Deprecated.
      • getRelationshipType

        public java.lang.String getRelationshipType()
      • setRelationshipType

        public void setRelationshipType​(java.lang.String relationshipType)
      • getOwningRelationshipPart

        @Deprecated
        public org.docx4j.openpackaging.parts.relationships.RelationshipsPart getOwningRelationshipPart()
        Deprecated.
      • setOwningRelationshipPart

        @Deprecated
        public void setOwningRelationshipPart​(org.docx4j.openpackaging.parts.relationships.RelationshipsPart owningRelationshipPart)
        Deprecated.
      • getContentLengthAsLoaded

        public long getContentLengthAsLoaded()
      • getPackage

        public org.docx4j.openpackaging.packages.OpcPackage getPackage()
      • setPackage

        public void setPackage​(org.docx4j.openpackaging.packages.OpcPackage pack)
      • setPartShortcut

        public boolean setPartShortcut​(org.docx4j.openpackaging.parts.Part part,
                                       java.lang.String relationshipType)
      • setVersion

        public void setVersion​(long version)
      • getVersion

        public long getVersion()
      • rename

        public void rename​(org.docx4j.openpackaging.parts.PartName newName)
      • remove

        public void remove()
      • getUserData

        public java.lang.Object getUserData​(java.lang.String key)
      • setUserData

        public void setUserData​(java.lang.String key,
                                java.lang.Object value)
      • getRelationshipsPart

        public org.docx4j.openpackaging.parts.relationships.RelationshipsPart getRelationshipsPart()
      • getRelationshipsPart

        public org.docx4j.openpackaging.parts.relationships.RelationshipsPart getRelationshipsPart​(boolean createIfAbsent)
      • setRelationships

        public void setRelationships​(org.docx4j.openpackaging.parts.relationships.RelationshipsPart relationships)
      • getContentType

        public java.lang.String getContentType()
      • setContentType

        public void setContentType​(org.docx4j.openpackaging.contenttype.ContentType contentType)
      • setPartName

        public void setPartName​(org.docx4j.openpackaging.parts.PartName partName)
      • getPartName

        public org.docx4j.openpackaging.parts.PartName getPartName()
      • addTargetPart

        public org.docx4j.relationships.Relationship addTargetPart​(org.docx4j.openpackaging.parts.Part targetpart,
                                                                   org.docx4j.openpackaging.parts.relationships.RelationshipsPart.AddPartBehaviour mode)
                                                            throws org.docx4j.openpackaging.exceptions.InvalidFormatException
        Throws:
        org.docx4j.openpackaging.exceptions.InvalidFormatException
      • addTargetPart

        public org.docx4j.relationships.Relationship addTargetPart​(org.docx4j.openpackaging.parts.Part targetpart)
                                                            throws org.docx4j.openpackaging.exceptions.InvalidFormatException
        Throws:
        org.docx4j.openpackaging.exceptions.InvalidFormatException
      • addTargetPart

        public org.docx4j.relationships.Relationship addTargetPart​(org.docx4j.openpackaging.parts.Part targetpart,
                                                                   java.lang.String proposedRelId)
                                                            throws org.docx4j.openpackaging.exceptions.InvalidFormatException
        Throws:
        org.docx4j.openpackaging.exceptions.InvalidFormatException
      • addTargetPart

        public org.docx4j.relationships.Relationship addTargetPart​(org.docx4j.openpackaging.parts.Part targetpart,
                                                                   org.docx4j.openpackaging.parts.relationships.RelationshipsPart.AddPartBehaviour mode,
                                                                   java.lang.String proposedRelId)
                                                            throws org.docx4j.openpackaging.exceptions.InvalidFormatException
        Throws:
        org.docx4j.openpackaging.exceptions.InvalidFormatException
      • reset

        public void reset()