ASPOSE home

com.aspose.words
Class ImageData

java.lang.Object
    extended by 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 toImage(), toInputStream() and save(java.io.OutputStream) 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.awt.image.BufferedImage) method. To link an image to a shape, set the SourceFullName property.


Property Getters/Setters Summary
booleangetBiLevel()
voidsetBiLevel(boolean value)
           Determines whether an image will be displayed in black and white.
BordersgetBorders()
           Gets the collection of borders of the image. Borders only have effect for inline images.
doublegetBrightness()
voidsetBrightness(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).
java.awt.ColorgetChromaKey()
voidsetChromaKey(java.awt.Color value)
           Defines the color value of the image that will be treated as transparent.
doublegetContrast()
voidsetContrast(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).
doublegetCropBottom()
voidsetCropBottom(double value)
           Defines the fraction of picture removal from the bottom side.
doublegetCropLeft()
voidsetCropLeft(double value)
           Defines the fraction of picture removal from the left side.
doublegetCropRight()
voidsetCropRight(double value)
           Defines the fraction of picture removal from the right side.
doublegetCropTop()
voidsetCropTop(double value)
           Defines the fraction of picture removal from the top side.
booleangetGrayScale()
voidsetGrayScale(boolean value)
           Determines whether a picture will display in grayscale mode.
booleanhasImage()
           Returns true if the shape has image bytes or links an image.
byte[]getImageBytes()
           Gets 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()
voidsetSourceFullName(java.lang.String value)
           Gets or sets the path and name of the source file for the linked image.
java.lang.StringgetTitle()
voidsetTitle(java.lang.String value)
           Defines the title of an image.
 
Method Summary
java.lang.ObjectfetchInheritedAttr(int key)
          Reserved for internal use.
java.lang.ObjectgetDirectAttr(int key)
          Reserved for internal use.
voidsave(java.io.OutputStream stream)
           Saves the image into the specified stream.
voidsave(java.lang.String fileName)
           Saves the image into a file.
voidsetAttr(int key, java.lang.Object value)
          Reserved for internal use.
voidsetImage(byte[] imageBytes)
           Sets the image that the shape displays.
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.
java.awt.image.BufferedImagetoImage()
           Gets the image stored in the shape as a java BufferedImage object.
java.io.InputStreamtoInputStream()
           Creates and returns a stream that contains the image bytes.
 

Property Getters/Setters Detail

getImageBytes

public byte[] getImageBytes()
Gets the raw bytes of the image stored in the shape.

Returns null if the image is not stored in the document.

See Also:
setImage(java.awt.image.BufferedImage), toImage(), toInputStream(), save(java.io.OutputStream)

hasImage

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

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.


getImageType

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

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.

If SourceFullName is not an empty string, but ImageBytes is null, then the image is linked and not stored in the document.


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.

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.


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.


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.


getBorders

public Borders getBorders()
Gets the collection of borders of the image. Borders only have effect for inline images.

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.


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.


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.


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.


getGrayScale/setGrayScale

public boolean getGrayScale()

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

The default value is false.


Method Detail

setImage

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

setImage

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

setImage

public void setImage(java.io.InputStream stream)
             throws java.io.IOException
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(byte[] imageBytes)
             throws java.io.IOException
Sets the image that the shape displays.
Parameters:
imageBytes - Bytes of the image.

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.


toInputStream

public java.io.InputStream toInputStream()
                         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 java.io.ByteArrayInputStream object.

If the image is linked and stored in a file, opens the file and returns a java.io.FileInputStream object.

If the image is linked and stored in an external URL, opens the URL and returns a java.io.InputStream object.

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


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.

setAttr

public void setAttr(int key, java.lang.Object value)
Reserved for internal use.

fetchInheritedAttr

public java.lang.Object fetchInheritedAttr(int key)
Reserved for internal use.

getDirectAttr

public java.lang.Object getDirectAttr(int key)
Reserved for internal use.

See Also:
          Wiki - the home page for the Aspose.Words Product Documentation that includes Programmer's Guide, Knowledge Base and other articles.
          Aspose.Words Support Forum - our preferred method of support.
          Aspose.Words Team - contact Aspose.Words Team.


ASPOSE home