com.aspose.words

Class ImageData

  • java.lang.Object
    • com.aspose.words.ImageData
public class ImageData 
extends java.lang.Object

Defines an image for a shape.

Use the Shape.ImageData property to access and modify the image inside a shape. You do not create instances of the ImageData class directly.

An image can be stored inside a shape, linked to external file or both (linked and stored in the document).

Regardless of whether the image is stored inside the shape or linked, you can always access the actual image using the toByteArray(), toImage() or save(java.lang.String) methods. If the image is stored inside the shape, you can also directly access it using the ImageBytes property.

To store an image inside a shape use the setImage(java.lang.String) method. To link an image to a shape, set the SourceFullName property.

Example:

Shows how to extract images from a document and save them as files.
public void extractImagesToFiles() throws Exception
{
    Document doc = new Document(getMyDir() + "Image.SampleImages.doc");

    NodeCollection shapes = doc.getChildNodes(NodeType.SHAPE, true);
    int imageIndex = 0;
    for (Shape shape : (Iterable<Shape>) shapes)
    {
        if (shape.hasImage())
        {
            String imageFileName = java.text.MessageFormat.format("\\Artifacts\\Image.ExportImages.{0} Out{1}", imageIndex, FileFormatUtil.imageTypeToExtension(shape.getImageData().getImageType()));
            shape.getImageData().save(getMyDir() + imageFileName);
            imageIndex++;
        }
    }
}

Example:

Shows how to insert a linked image into a document.
DocumentBuilder builder = new DocumentBuilder();

String imageFileName = getMyDir() + "\\Images\\Hammer.wmf";

builder.write("Image linked, not stored in the document: ");

Shape linkedOnly = new Shape(builder.getDocument(), ShapeType.IMAGE);
linkedOnly.setWrapType(WrapType.INLINE);
linkedOnly.getImageData().setSourceFullName(imageFileName);

builder.insertNode(linkedOnly);
builder.writeln();

builder.write("Image linked and stored in the document: ");

Shape linkedAndStored = new Shape(builder.getDocument(), ShapeType.IMAGE);
linkedAndStored.setWrapType(WrapType.INLINE);
linkedAndStored.getImageData().setSourceFullName(imageFileName);
linkedAndStored.getImageData().setImage(imageFileName);

builder.insertNode(linkedAndStored);
builder.writeln();

builder.write("Image stored in the document, but not linked: ");

Shape stored = new Shape(builder.getDocument(), ShapeType.IMAGE);
stored.setWrapType(WrapType.INLINE);
stored.getImageData().setImage(imageFileName);

builder.insertNode(stored);
builder.writeln();

builder.getDocument().save(getMyDir() + "\\Artifacts\\Image.CreateLinkedImage.doc");

Property Getters/Setters Summary
booleangetBiLevel()
void
setBiLevel(booleanvalue)
           Determines whether an image will be displayed in black and white.
BorderCollectiongetBorders()
Gets the collection of borders of the image. Borders only have effect for inline images.
doublegetBrightness()
void
setBrightness(doublevalue)
           Gets or sets the brightness of the picture. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).
java.awt.ColorgetChromaKey()
void
setChromaKey(java.awt.Colorvalue)
           Defines the color value of the image that will be treated as transparent.
doublegetContrast()
void
setContrast(doublevalue)
           Gets or sets the contrast for the specified picture. The value for this property must be a number from 0.0 (the least contrast) to 1.0 (the greatest contrast).
doublegetCropBottom()
void
setCropBottom(doublevalue)
           Defines the fraction of picture removal from the bottom side.
doublegetCropLeft()
void
setCropLeft(doublevalue)
           Defines the fraction of picture removal from the left side.
doublegetCropRight()
void
setCropRight(doublevalue)
           Defines the fraction of picture removal from the right side.
doublegetCropTop()
void
setCropTop(doublevalue)
           Defines the fraction of picture removal from the top side.
booleangetGrayScale()
void
setGrayScale(booleanvalue)
           Determines whether a picture will display in grayscale mode.
booleanhasImage()
Returns true if the shape has image bytes or links an image.
byte[]getImageBytes()
void
setImageBytes(byte[]value)
           Gets or sets the raw bytes of the image stored in the shape.
ImageSizegetImageSize()
Gets the information about image size and resolution.
intgetImageType()
Gets the type of the image. The value of the property is ImageType integer constant.
booleanisLink()
Returns true if the image is linked to the shape (when SourceFullName is specified).
booleanisLinkOnly()
Returns true if the image is linked and not stored in the document.
java.lang.StringgetSourceFullName()
void
setSourceFullName(java.lang.Stringvalue)
           Gets or sets the path and name of the source file for the linked image.
java.lang.StringgetTitle()
void
setTitle(java.lang.Stringvalue)
           Defines the title of an image.
 
Method Summary
voidsave(java.io.OutputStream stream)
Saves the image into the specified stream.
voidsave(java.lang.String fileName)
Saves the image into a file.
voidsetImage(java.awt.image.BufferedImage image)
Sets the image that the shape displays.
voidsetImage(java.io.InputStream stream)
Sets the image that the shape displays.
voidsetImage(java.lang.String fileName)
Sets the image that the shape displays.
byte[]toByteArray()
Returns image bytes for any image regardless whether the image is stored or linked.
java.awt.image.BufferedImagetoImage()
Gets the image stored in the shape as a java BufferedImage object.
 

    • Property Getters/Setters Detail

      • getBiLevel/setBiLevel

        public boolean getBiLevel() / public void setBiLevel(boolean value)
        
        Determines whether an image will be displayed in black and white.

        The default value is false.

      • getBorders

        public BorderCollection getBorders()
        
        Gets the collection of borders of the image. Borders only have effect for inline images.
      • getBrightness/setBrightness

        public double getBrightness() / public void setBrightness(double value)
        
        Gets or sets the brightness of the picture. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).

        The default value is 0.5.

      • getChromaKey/setChromaKey

        public java.awt.Color getChromaKey() / public void setChromaKey(java.awt.Color value)
        
        Defines the color value of the image that will be treated as transparent.

        The default value is 0.

      • getContrast/setContrast

        public double getContrast() / public void setContrast(double value)
        
        Gets or sets the contrast for the specified picture. The value for this property must be a number from 0.0 (the least contrast) to 1.0 (the greatest contrast).

        The default value is 0.5.

      • getCropBottom/setCropBottom

        public double getCropBottom() / public void setCropBottom(double value)
        
        Defines the fraction of picture removal from the bottom side.

        The amount of cropping can range from -1.0 to 1.0. The default value is 0. Note that a value of 1 will display no picture at all. Negative values will result in the picture being squeezed inward from the edge being cropped (the empty space between the picture and the cropped edge will be filled by the fill color of the shape). Positive values less than 1 will result in the remaining picture being stretched to fit the shape.

        The default value is 0.

      • getCropLeft/setCropLeft

        public double getCropLeft() / public void setCropLeft(double value)
        
        Defines the fraction of picture removal from the left side.

        The amount of cropping can range from -1.0 to 1.0. The default value is 0. Note that a value of 1 will display no picture at all. Negative values will result in the picture being squeezed inward from the edge being cropped (the empty space between the picture and the cropped edge will be filled by the fill color of the shape). Positive values less than 1 will result in the remaining picture being stretched to fit the shape.

        The default value is 0.

      • getCropRight/setCropRight

        public double getCropRight() / public void setCropRight(double value)
        
        Defines the fraction of picture removal from the right side.

        The amount of cropping can range from -1.0 to 1.0. The default value is 0. Note that a value of 1 will display no picture at all. Negative values will result in the picture being squeezed inward from the edge being cropped (the empty space between the picture and the cropped edge will be filled by the fill color of the shape). Positive values less than 1 will result in the remaining picture being stretched to fit the shape.

        The default value is 0.

      • getCropTop/setCropTop

        public double getCropTop() / public void setCropTop(double value)
        
        Defines the fraction of picture removal from the top side.

        The amount of cropping can range from -1.0 to 1.0. The default value is 0. Note that a value of 1 will display no picture at all. Negative values will result in the picture being squeezed inward from the edge being cropped (the empty space between the picture and the cropped edge will be filled by the fill color of the shape). Positive values less than 1 will result in the remaining picture being stretched to fit the shape.

        The default value is 0.

      • getGrayScale/setGrayScale

        public boolean getGrayScale() / public void setGrayScale(boolean value)
        
        Determines whether a picture will display in grayscale mode.

        The default value is false.

      • hasImage

        public boolean hasImage()
        
        Returns true if the shape has image bytes or links an image.
      • getImageBytes/setImageBytes

        public byte[] getImageBytes() / public void setImageBytes(byte[] value)
        
        Gets or sets the raw bytes of the image stored in the shape.

        Setting the value to null or an empty array will remove the image from the shape.

        Returns null if the image is not stored in the document (e.g the image is probably linked in this case).

        See Also:
        setImage(java.lang.String), toByteArray(), toImage(), save(java.lang.String)
      • getImageSize

        public ImageSize getImageSize()
        
        Gets the information about image size and resolution.

        If the image is linked only and not stored in the document, returns zero size.

        Example:

        Shows how to resize an image shape.
        DocumentBuilder builder = new DocumentBuilder();
        
        // By default, the image is inserted at 100% scale.
        Shape shape = builder.insertImage(getMyDir() + "\\Images\\Aspose.Words.gif");
        
        // It is easy to change the shape size. In this case, make it 50% relative to the current shape size.
        shape.setWidth(shape.getWidth() * 0.5);
        shape.setHeight(shape.getHeight() * 0.5);
        
        // However, we can also go back to the original image size and scale from there, say 110%.
        ImageSize imageSize = shape.getImageData().getImageSize();
        shape.setWidth(imageSize.getWidthPoints() * 1.1);
        shape.setHeight(imageSize.getHeightPoints() * 1.1);
        
        builder.getDocument().save(getMyDir() + "\\Artifacts\\Image.ScaleImage.doc");
      • getImageType

        public int getImageType()
        
        Gets the type of the image. The value of the property is ImageType integer constant.

        Example:

        Shows how to extract images from a document and save them as files.
        public void extractImagesToFiles() throws Exception
        {
            Document doc = new Document(getMyDir() + "Image.SampleImages.doc");
        
            NodeCollection shapes = doc.getChildNodes(NodeType.SHAPE, true);
            int imageIndex = 0;
            for (Shape shape : (Iterable<Shape>) shapes)
            {
                if (shape.hasImage())
                {
                    String imageFileName = java.text.MessageFormat.format("\\Artifacts\\Image.ExportImages.{0} Out{1}", imageIndex, FileFormatUtil.imageTypeToExtension(shape.getImageData().getImageType()));
                    shape.getImageData().save(getMyDir() + imageFileName);
                    imageIndex++;
                }
            }
        }
      • isLink

        public boolean isLink()
        
        Returns true if the image is linked to the shape (when SourceFullName is specified).
      • isLinkOnly

        public boolean isLinkOnly()
        
        Returns true if the image is linked and not stored in the document.
      • getSourceFullName/setSourceFullName

        public java.lang.String getSourceFullName() / public void setSourceFullName(java.lang.String value)
        
        Gets or sets the path and name of the source file for the linked image.

        The default value is an empty string.

        If SourceFullName is not an empty string, the image is linked.

        Example:

        Shows how to insert a linked image into a document.
        DocumentBuilder builder = new DocumentBuilder();
        
        String imageFileName = getMyDir() + "\\Images\\Hammer.wmf";
        
        builder.write("Image linked, not stored in the document: ");
        
        Shape linkedOnly = new Shape(builder.getDocument(), ShapeType.IMAGE);
        linkedOnly.setWrapType(WrapType.INLINE);
        linkedOnly.getImageData().setSourceFullName(imageFileName);
        
        builder.insertNode(linkedOnly);
        builder.writeln();
        
        builder.write("Image linked and stored in the document: ");
        
        Shape linkedAndStored = new Shape(builder.getDocument(), ShapeType.IMAGE);
        linkedAndStored.setWrapType(WrapType.INLINE);
        linkedAndStored.getImageData().setSourceFullName(imageFileName);
        linkedAndStored.getImageData().setImage(imageFileName);
        
        builder.insertNode(linkedAndStored);
        builder.writeln();
        
        builder.write("Image stored in the document, but not linked: ");
        
        Shape stored = new Shape(builder.getDocument(), ShapeType.IMAGE);
        stored.setWrapType(WrapType.INLINE);
        stored.getImageData().setImage(imageFileName);
        
        builder.insertNode(stored);
        builder.writeln();
        
        builder.getDocument().save(getMyDir() + "\\Artifacts\\Image.CreateLinkedImage.doc");
      • getTitle/setTitle

        public java.lang.String getTitle() / public void setTitle(java.lang.String value)
        
        Defines the title of an image.

        The default value is an empty string.

    • Method Detail

      • save

        public void save(java.io.OutputStream stream)
                 throws java.lang.Exception
        Saves the image into the specified stream.

        Is it the responsibility of the caller to dispose the stream object.

        Parameters:
        stream - The stream where to save the image to.
      • save

        public void save(java.lang.String fileName)
                 throws java.lang.Exception
        Saves the image into a file.
        Parameters:
        fileName - The file name where to save the image.

        Example:

        Shows how to extract images from a document and save them as files.
        public void extractImagesToFiles() throws Exception
        {
            Document doc = new Document(getMyDir() + "Image.SampleImages.doc");
        
            NodeCollection shapes = doc.getChildNodes(NodeType.SHAPE, true);
            int imageIndex = 0;
            for (Shape shape : (Iterable<Shape>) shapes)
            {
                if (shape.hasImage())
                {
                    String imageFileName = java.text.MessageFormat.format("\\Artifacts\\Image.ExportImages.{0} Out{1}", imageIndex, FileFormatUtil.imageTypeToExtension(shape.getImageData().getImageType()));
                    shape.getImageData().save(getMyDir() + imageFileName);
                    imageIndex++;
                }
            }
        }
      • setImage

        public void setImage(java.awt.image.BufferedImage image)
                     throws java.lang.Exception
        Sets the image that the shape displays.
        Parameters:
        image - The image object.
      • setImage

        public void setImage(java.io.InputStream stream)
                     throws java.lang.Exception
        Sets the image that the shape displays.
        Parameters:
        stream - The stream that contains the image. The stream will be read from the current position, so one should be careful about stream position.
      • setImage

        public void setImage(java.lang.String fileName)
                     throws java.lang.Exception
        Sets the image that the shape displays.
        Parameters:
        fileName - The image file. Can be a file name or a URL.

        Example:

        Shows how to insert a linked image into a document.
        DocumentBuilder builder = new DocumentBuilder();
        
        String imageFileName = getMyDir() + "\\Images\\Hammer.wmf";
        
        builder.write("Image linked, not stored in the document: ");
        
        Shape linkedOnly = new Shape(builder.getDocument(), ShapeType.IMAGE);
        linkedOnly.setWrapType(WrapType.INLINE);
        linkedOnly.getImageData().setSourceFullName(imageFileName);
        
        builder.insertNode(linkedOnly);
        builder.writeln();
        
        builder.write("Image linked and stored in the document: ");
        
        Shape linkedAndStored = new Shape(builder.getDocument(), ShapeType.IMAGE);
        linkedAndStored.setWrapType(WrapType.INLINE);
        linkedAndStored.getImageData().setSourceFullName(imageFileName);
        linkedAndStored.getImageData().setImage(imageFileName);
        
        builder.insertNode(linkedAndStored);
        builder.writeln();
        
        builder.write("Image stored in the document, but not linked: ");
        
        Shape stored = new Shape(builder.getDocument(), ShapeType.IMAGE);
        stored.setWrapType(WrapType.INLINE);
        stored.getImageData().setImage(imageFileName);
        
        builder.insertNode(stored);
        builder.writeln();
        
        builder.getDocument().save(getMyDir() + "\\Artifacts\\Image.CreateLinkedImage.doc");
      • toByteArray

        public byte[] toByteArray()
                          throws java.lang.Exception
        Returns image bytes for any image regardless whether the image is stored or linked.

        If the image is linked, downloads the image every time it is called.

        Returns:
        See Also:
        ImageBytes
      • toImage

        public java.awt.image.BufferedImage toImage()
                             throws java.lang.Exception
        Gets the image stored in the shape as a java BufferedImage object.

        Tries to create a new java.awt.image.BufferedImage object from image bytes every time this method is called. If javax.imageio.ImageReader can't read image bytes (emf, wmf, tiff, etc.) the method returns null.

        It is the responsibility of the caller to dispose the image object.

        Returns: