ImageData (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.ImageData

```
public class ImageData
extends java.lang.Object
```
Defines an image for a shape.
Use the Shape.getImageData() 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 getImageBytes() / setImageBytes(byte[]) property.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`fetchInheritedBorderAttr(int key)`
`boolean`	`getBiLevel()` Determines whether an image will be displayed in black and white.
`BorderCollection`	`getBorders()` Gets the collection of borders of the image.
`double`	`getBrightness()` Gets the brightness of the picture.
`java.awt.Color`	`getChromaKey()` Defines the color value of the image that will be treated as transparent.
`double`	`getContrast()` Gets the contrast for the specified picture.
`double`	`getCropBottom()` Defines the fraction of picture removal from the bottom side.
`double`	`getCropLeft()` Defines the fraction of picture removal from the left side.
`double`	`getCropRight()` Defines the fraction of picture removal from the right side.
`double`	`getCropTop()` Defines the fraction of picture removal from the top side.
`java.lang.Object`	`getDirectBorderAttr(int key)`
`boolean`	`getGrayScale()` Determines whether a picture will display in grayscale mode.
`byte[]`	`getImageBytes()` Gets the raw bytes of the image stored in the shape.
`ImageSize`	`getImageSize()` Gets the information about image size and resolution.
`int`	`getImageType()` Gets the type of the image.
`java.lang.String`	`getSourceFullName()` Gets the path and name of the source file for the linked image.
`java.lang.String`	`getTitle()` Defines the title of an image.
`boolean`	`hasImage()` Returns true if the shape has image bytes or links an image.
`boolean`	`isLink()` Returns true if the image is linked to the shape (when `getSourceFullName()` / `setSourceFullName(java.lang.String)` is specified).
`boolean`	`isLinkOnly()` Returns true if the image is linked and not stored in the document.
`void`	`save(java.io.OutputStream stream)`
`void`	`save(java.lang.String fileName)` Saves the image into a file.
`void`	`setBiLevel(boolean value)` Determines whether an image will be displayed in black and white.
`void`	`setBorderAttr(int key, java.lang.Object value)`
`void`	`setBrightness(double value)` Sets the brightness of the picture.
`void`	`setChromaKey(java.awt.Color value)` Defines the color value of the image that will be treated as transparent.
`void`	`setContrast(double value)` Sets the contrast for the specified picture.
`void`	`setCropBottom(double value)` Defines the fraction of picture removal from the bottom side.
`void`	`setCropLeft(double value)` Defines the fraction of picture removal from the left side.
`void`	`setCropRight(double value)` Defines the fraction of picture removal from the right side.
`void`	`setCropTop(double value)` Defines the fraction of picture removal from the top side.
`void`	`setGrayScale(boolean value)` Determines whether a picture will display in grayscale mode.
`void`	`setImage(java.awt.image.BufferedImage image)` Sets the image that the shape displays.
`void`	`setImage(java.io.InputStream stream)`
`void`	`setImage(java.lang.String fileName)` Sets the image that the shape displays.
`void`	`setImageBytes(byte[] value)` Sets the raw bytes of the image stored in the shape.
`void`	`setSourceFullName(java.lang.String value)` Sets the path and name of the source file for the linked image.
`void`	`setTitle(java.lang.String value)` Defines the title of an image.
`byte[]`	`toByteArray()` Returns image bytes for any image regardless whether the image is stored or linked.
`java.awt.image.BufferedImage`	`toImage()` Gets the image stored in the shape as a java `BufferedImage` object.
`java.io.InputStream`	`toStream()` Creates and returns a stream that contains the image bytes.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - 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.
    
    Throws:
    
    java.lang.Exception
  - setImage
```
public void setImage(java.io.InputStream stream)
              throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - 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.
    
    Throws:
    
    java.lang.Exception
  - toImage
```
public java.awt.image.BufferedImage toImage()
                                     throws java.lang.Exception
```
    Gets the image stored in the shape as a java BufferedImage object.
    
    Returns:
    
    Throws:
    
    java.lang.Exception
  - toStream
```
public java.io.InputStream toStream()
                             throws java.lang.Exception
```
    Creates and returns a stream that contains the image bytes.
    If the image bytes are stored in the shape, creates and returns a object.
    
    If the image is linked and stored in a file, opens the file and returns a object.
    
    If the image is linked and stored in an external URL, opens the URL and returns a object.
    
    Is it the responsibility of the caller to dispose the stream object.
    This is not ported to Java yet.
    
    Throws:
    
    java.lang.Exception
  - toByteArray
```
public byte[] toByteArray()
                   throws java.lang.Exception
```
    Returns image bytes for any image regardless whether the image is stored or linked.
    
    Returns:
    
    Throws:
    
    java.lang.Exception
    
    See Also:
    
    getImageBytes(), setImageBytes(byte[])
  - save
```
public void save(java.io.OutputStream stream)
          throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - 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.
    
    Throws:
    
    java.lang.Exception
  - getImageBytes
```
public byte[] getImageBytes()
                     throws java.lang.Exception
```
    Gets 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).
    
    Returns:
    
    The raw bytes of the image stored in the shape.
    
    Throws:
    
    java.lang.Exception
    
    See Also:
    
    setImage(java.lang.String), toByteArray(), toImage(), save(java.lang.String)
  - setImageBytes
```
public void setImageBytes(byte[] value)
                   throws java.lang.Exception
```
    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).
    
    Parameters:
    
    value - The raw bytes of the image stored in the shape.
    
    Throws:
    
    java.lang.Exception
    
    See Also:
    
    setImage(java.lang.String), toByteArray(), toImage(), save(java.lang.String)
  - hasImage
```
public boolean hasImage()
                 throws java.lang.Exception
```
    Returns true if the shape has image bytes or links an image. (4654,6)
    
    Returns:
    
    True if the shape has image bytes or links an image.
    
    Throws:
    
    java.lang.Exception
  - getImageSize
```
public ImageSize getImageSize()
                       throws java.lang.Exception
```
    Gets the information about image size and resolution. (4661,6)
    If the image is linked only and not stored in the document, returns zero size.
    
    Returns:
    
    The information about image size and resolution.
    
    Throws:
    
    java.lang.Exception
  - getImageType
```
public int getImageType()
                 throws java.lang.Exception
```
    Gets the type of the image. (4671,6)
    
    Returns:
    
    The type of the image. The returned value is one of ImageType constants.
    
    Throws:
    
    java.lang.Exception
  - isLink
```
public boolean isLink()
               throws java.lang.Exception
```
    Returns true if the image is linked to the shape (when getSourceFullName() / setSourceFullName(java.lang.String) is specified). (4678,6)
    
    Returns:
    
    True if the image is linked to the shape (when getSourceFullName() / setSourceFullName(java.lang.String) is specified).
    
    Throws:
    
    java.lang.Exception
  - isLinkOnly
```
public boolean isLinkOnly()
                   throws java.lang.Exception
```
    Returns true if the image is linked and not stored in the document. (4685,6)
    
    Returns:
    
    True if the image is linked and not stored in the document.
    
    Throws:
    
    java.lang.Exception
  - getSourceFullName
```
public java.lang.String getSourceFullName()
                                   throws java.lang.Exception
```
    Gets the path and name of the source file for the linked image.
    The default value is an empty string.
    
    If getSourceFullName() / setSourceFullName(java.lang.String) is not an empty string, the image is linked.
    
    Returns:
    
    The path and name of the source file for the linked image.
    
    Throws:
    
    java.lang.Exception
  - setSourceFullName
```
public void setSourceFullName(java.lang.String value)
                       throws java.lang.Exception
```
    Sets the path and name of the source file for the linked image.
    The default value is an empty string.
    
    If getSourceFullName() / setSourceFullName(java.lang.String) is not an empty string, the image is linked.
    
    Parameters:
    
    value - The path and name of the source file for the linked image.
    
    Throws:
    
    java.lang.Exception
  - getTitle
```
public java.lang.String getTitle()
```
    Defines the title of an image.
    The default value is an empty string.
    
    Returns:
    
    The corresponding String value.
  - setTitle
```
public void setTitle(java.lang.String value)
```
    Defines the title of an image.
    The default value is an empty string.
    
    Parameters:
    
    value - The corresponding String value.
  - getCropTop
```
public double getCropTop()
```
    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.
    
    Returns:
    
    The corresponding double value.
  - setCropTop
```
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.
    
    Parameters:
    
    value - The corresponding double value.
  - getCropBottom
```
public double getCropBottom()
```
    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.
    
    Returns:
    
    The corresponding double value.
  - setCropBottom
```
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.
    
    Parameters:
    
    value - The corresponding double value.
  - getCropLeft
```
public double getCropLeft()
```
    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.
    
    Returns:
    
    The corresponding double value.
  - setCropLeft
```
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.
    
    Parameters:
    
    value - The corresponding double value.
  - getCropRight
```
public double getCropRight()
```
    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.
    
    Returns:
    
    The corresponding double value.
  - setCropRight
```
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.
    
    Parameters:
    
    value - The corresponding double value.
  - getBorders
```
public BorderCollection getBorders()
```
    Gets the collection of borders of the image. Borders only have effect for inline images.
    
    Returns:
    
    The collection of borders of the image.
  - getChromaKey
```
public java.awt.Color getChromaKey()
```
    Defines the color value of the image that will be treated as transparent.
    The default value is 0.
    
    Returns:
    
    The corresponding Color value.
  - setChromaKey
```
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.
    
    Parameters:
    
    value - The corresponding Color value.
  - getBrightness
```
public double getBrightness()
```
    Gets 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.
    
    Returns:
    
    The brightness of the picture.
  - setBrightness
```
public void setBrightness(double value)
```
    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.
    
    Parameters:
    
    value - The brightness of the picture.
  - getContrast
```
public double getContrast()
```
    Gets 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.
    
    Returns:
    
    The contrast for the specified picture.
  - setContrast
```
public void setContrast(double value)
```
    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.
    
    Parameters:
    
    value - The contrast for the specified picture.
  - getBiLevel
```
public boolean getBiLevel()
```
    Determines whether an image will be displayed in black and white.
    The default value is false.
    
    Returns:
    
    The corresponding boolean value.
  - setBiLevel
```
public void setBiLevel(boolean value)
```
    Determines whether an image will be displayed in black and white.
    The default value is false.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getGrayScale
```
public boolean getGrayScale()
```
    Determines whether a picture will display in grayscale mode.
    The default value is false.
    
    Returns:
    
    The corresponding boolean value.
  - setGrayScale
```
public void setGrayScale(boolean value)
```
    Determines whether a picture will display in grayscale mode.
    The default value is false.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getDirectBorderAttr
```
public java.lang.Object getDirectBorderAttr(int key)
```
  - fetchInheritedBorderAttr
```
public java.lang.Object fetchInheritedBorderAttr(int key)
```
  - setBorderAttr
```
public void setBorderAttr(int key,
                          java.lang.Object value)
```

Class ImageData

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setImage

setImage

setImage

toImage

toStream

toByteArray

save

save

getImageBytes

setImageBytes

hasImage

getImageSize

getImageType

isLink

isLinkOnly

getSourceFullName

setSourceFullName

getTitle

setTitle

getCropTop

setCropTop

getCropBottom

setCropBottom

getCropLeft

setCropLeft

getCropRight

setCropRight

getBorders

getChromaKey

setChromaKey

getBrightness

setBrightness

getContrast

setContrast

getBiLevel

setBiLevel

getGrayScale

setGrayScale

getDirectBorderAttr

fetchInheritedBorderAttr

setBorderAttr