Image (Aspose.Drawing for Java 25.10 API Documentation)

java.lang.Object
- com.aspose.drawing.Image

All Implemented Interfaces:

com.aspose.ms.System.IDisposable

Direct Known Subclasses:

Bitmap, Metafile
```
public abstract class Image
extends Object
implements com.aspose.ms.System.IDisposable
```
An abstract base class that provides functionality for the Bitmap and Metafile descended classes.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Image.GetThumbnailImageAbort

Nested Classes
Modifier and Type	Class and Description
`static class`	`Image.GetThumbnailImageAbort`

Constructor Summary

Constructors
Constructor and Description

Image()
Initializes a new instance of the Image class.

Constructors
Constructor and Description
`Image()` Initializes a new instance of the `Image` class.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`deepClone()` Creates an exact copy of this `Image`.
`void`	`dispose()` Releases all resources used by this Image.
`static Image`	`fromFile(String filename)` Creates an `Image` from the specified file.
`static Bitmap`	`fromHbitmap(byte[] hbitmap)` Creates a `Bitmap` from a handle to a GDI bitmap.
`static Image`	`fromStream(InputStream stream)` Creates an `Image` from the specified data stream.
`static Image`	`fromStream(InputStream stream, boolean useEmbeddedColorManagement)` Creates an `Image` from the specified data stream, optionally using embedded color management information in that stream.
`RectangleF`	`getBounds(int[] pageUnit)` Gets the bounds of the image in the specified unit.
`int`	`getFlags()` Gets the integer representing a bitwise combination of `ImageFlags` for this Image.
`int`	`getFrameCount(FrameDimension dimension)` Returns the number of frames of the specified dimension.
`UUID[]`	`getFrameDimensionsList()` Gets an array of GUIDs that represent the dimensions of frames within this `Image`.
`abstract int`	`getHeight()` Gets the height, in pixels, of this `Image`.
`float`	`getHorizontalResolution()` Gets the horizontal resolution, in pixels per inch, of this `Image`.
`abstract ColorPalette`	`getPalette()` Gets or sets the color palette used for this `Image`.
`SizeF`	`getPhysicalDimension()` Gets the width and height of this image.
`abstract int`	`getPixelFormat()` Gets the pixel format for this `Image`.
`static int`	`getPixelFormatSize(int pixfmt)` Returns the color depth, in number of bits per pixel, of the specified pixel format.
`abstract int[]`	`getPropertyIdList()` Gets IDs of the property items stored in this `Image`.
`abstract PropertyItem`	`getPropertyItem(int propid)` Gets the specified property item from this `Image`.
`abstract PropertyItem[]`	`getPropertyItems()` Gets all the property items (pieces of metadata) stored in this `Image`.
`abstract ImageFormat`	`getRawFormat()` Gets the file format of this `Image`.
`Size`	`getSize()` Gets the width and height, in pixels, of this image.
`Object`	`getTag()` Gets or sets an object that provides additional data about the image.
`Image`	`getThumbnailImage(int thumbWidth, int thumbHeight, Image.GetThumbnailImageAbort callback, byte[] callbackData)` Returns a thumbnail for this `Image`.
`float`	`getVerticalResolution()` Gets the vertical resolution, in pixels per inch, of this `Image`.
`abstract int`	`getWidth()` Gets the width, in pixels, of this `Image`.
`static boolean`	`isAlphaPixelFormat(int pixfmt)` Returns a value that indicates whether the pixel format for this `Image` contains alpha information.
`abstract void`	`removePropertyItem(int propid)` Removes the specified property item from this `Image`.
`abstract void`	`rotateFlip(int rotateFlipType)` This method rotates, flips, or rotates and flips the `Image`.
`void`	`save(OutputStream stream, ImageCodecInfo encoder, EncoderParameters encoderParams)` Saves this image to the specified stream, with the specified encoder and image encoder parameters.
`void`	`save(OutputStream stream, int format)` Saves this image to the specified stream in the specified format.
`void`	`save(String filename)` Saves this `Image` to the specified file or stream.
`void`	`save(String filename, ImageCodecInfo encoder, EncoderParameters encoderParams)` Saves this `Image` to the specified file, with the specified encoder and image-encoder parameters.
`void`	`save(String filename, int format)` Saves this `Image` to the specified file in the specified format.
`void`	`saveAdd(EncoderParameters encoderParams)` Adds a frame to the file or stream specified in a previous call to the one of Image.Save(...) methods.
`void`	`saveAdd(Image image, EncoderParameters encoderParams)` Adds a frame to the file or stream specified in a previous call to the one of Image.Save(...) methods.
`int`	`selectActiveFrame(FrameDimension dimension, int frameIndex)` Selects the frame specified by the dimension and index.
`abstract void`	`setPalette(ColorPalette value)` Gets or sets the color palette used for this `Image`.
`abstract void`	`setPropertyItem(PropertyItem propitem)` Stores a property item (piece of metadata) in this `Image`.
`void`	`setTag(Object value)` Gets or sets an object that provides additional data about the image.

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

- Constructor Detail
  - Image
```
public Image()
```
    Initializes a new instance of the Image class.
- Method Detail
  - getWidth
```
public abstract int getWidth()
```
    Gets the width, in pixels, of this Image.
  - getHeight
```
public abstract int getHeight()
```
    Gets the height, in pixels, of this Image.
  - getSize
```
public final Size getSize()
```
    Gets the width and height, in pixels, of this image.
    
    Returns:
    
    A Size(Image.getSize()) structure that represents the width and height, in pixels, of this image.
  - getHorizontalResolution
```
public final float getHorizontalResolution()
```
    Gets the horizontal resolution, in pixels per inch, of this Image.
  - getVerticalResolution
```
public final float getVerticalResolution()
```
    Gets the vertical resolution, in pixels per inch, of this Image.
  - getRawFormat
```
public abstract ImageFormat getRawFormat()
```
    Gets the file format of this Image.
    
    Returns:
    
    The ImageFormat that represents the file format of this Image.
  - getPixelFormat
```
public abstract int getPixelFormat()
```
    Gets the pixel format for this Image.
    
    Returns:
    
    A PixelFormat(Image.getPixelFormat()) that represents the pixel format for this Image.
  - getPalette
```
public abstract ColorPalette getPalette()
```
    Gets or sets the color palette used for this Image.
    
    Returns:
    
    A ColorPalette that represents the color palette used for this Image.
  - setPalette
```
public abstract void setPalette(ColorPalette value)
```
    Gets or sets the color palette used for this Image.
  - getPhysicalDimension
```
public final SizeF getPhysicalDimension()
```
    Gets the width and height of this image.
    
    Returns:
    
    A SizeF structure that represents the width and height of this Image.
  - getFrameDimensionsList
```
public UUID[] getFrameDimensionsList()
```
    Gets an array of GUIDs that represent the dimensions of frames within this Image.
    
    Returns:
    
    An array of GUIDs that specify the dimensions of frames within this Image from most significant to least significant.
  - getFlags
```
public final int getFlags()
```
    Gets the integer representing a bitwise combination of ImageFlags for this Image.
    
    Throws:
    
    com.aspose.ms.System.NotImplementedException - The feature hasn't implemented yet Value: The integer value returned from this method will correspond to a sum of ImageFlags.
  - getPropertyIdList
```
public abstract int[] getPropertyIdList()
```
    Gets IDs of the property items stored in this Image.
    
    Returns:
    
    An array of the property IDs, one for each property item stored in this image.
  - getPropertyItems
```
public abstract PropertyItem[] getPropertyItems()
```
    Gets all the property items (pieces of metadata) stored in this Image.
    
    Returns:
    
    An array of PropertyItem objects, one for each property item stored in the image.
  - getTag
```
public final Object getTag()
```
    Gets or sets an object that provides additional data about the image.
  - setTag
```
public final void setTag(Object value)
```
    Gets or sets an object that provides additional data about the image.
  - fromFile
```
public static Image fromFile(String filename)
```
    Creates an Image from the specified file.
    
    Parameters:
    
    filename - A string that contains the name of the file from which to create the Image.
    
    Returns:
    
    The Image this method creates.
  - fromStream
```
public static Image fromStream(InputStream stream)
```
    Creates an Image from the specified data stream.
    
    Parameters:
    
    stream - A InputStream that contains the data for this Image.
    
    Returns:
    
    The Image this method creates.
  - fromStream
```
public static Image fromStream(InputStream stream,
                               boolean useEmbeddedColorManagement)
```
    Creates an Image from the specified data stream, optionally using embedded color management information in that stream.
    
    Parameters:
    
    stream - A InputStream that contains the data for this Image.
    
    useEmbeddedColorManagement - true to use color management information embedded in the data stream; otherwise, false.
    
    Returns:
    
    The Image this method creates.
  - fromHbitmap
```
public static Bitmap fromHbitmap(byte[] hbitmap)
```
    Creates a Bitmap from a handle to a GDI bitmap.
    
    Parameters:
    
    hbitmap - The GDI bitmap handle from which to create the Bitmap.
    
    Returns:
    
    The Bitmap this method creates.
  - getPixelFormatSize
```
public static int getPixelFormatSize(int pixfmt)
```
    Returns the color depth, in number of bits per pixel, of the specified pixel format.
    
    Parameters:
    
    pixfmt - The PixelFormat(Image.getPixelFormat()) member that specifies the format for which to find the size.
    
    Returns:
    
    The color depth of the specified pixel format.
  - isAlphaPixelFormat
```
public static boolean isAlphaPixelFormat(int pixfmt)
```
    Returns a value that indicates whether the pixel format for this Image contains alpha information.
    
    Parameters:
    
    pixfmt - The PixelFormat(Image.getPixelFormat()) to test.
    
    Returns:
    
    true if pixfmt contains alpha information; otherwise, false.
  - getThumbnailImage
```
public final Image getThumbnailImage(int thumbWidth,
                                     int thumbHeight,
                                     Image.GetThumbnailImageAbort callback,
                                     byte[] callbackData)
```
    Returns a thumbnail for this Image.
    
    Parameters:
    
    thumbWidth - The width, in pixels, of the requested thumbnail image.
    
    thumbHeight - The height, in pixels, of the requested thumbnail image.
    
    callback - A Image.GetThumbnailImageAbort delegate. Note You must create a delegate and pass a reference to the delegate as the callback parameter, but the delegate is not used.
    
    callbackData - Must be IntPtr.Zero.
    
    Returns:
    
    An Image that represents the thumbnail.
  - dispose
```
public void dispose()
```
    Releases all resources used by this Image.
    This method actually does nothing. It's just for compatibility with System.Drawing API.
    
    Specified by:
    
    dispose in interface com.aspose.ms.System.IDisposable
  - deepClone
```
public final Object deepClone()
```
    Creates an exact copy of this Image.
    
    Returns:
    
    The Image this method creates, cast as an object.
  - getBounds
```
public final RectangleF getBounds(int[] pageUnit)
```
    Gets the bounds of the image in the specified unit.
    
    Parameters:
    
    pageUnit - One of the GraphicsUnit values indicating the unit of measure for the bounding rectangle.
    
    Returns:
    
    The RectangleF that represents the bounds of the image, in the specified unit.
  - getFrameCount
```
public final int getFrameCount(FrameDimension dimension)
```
    Returns the number of frames of the specified dimension.
    
    Parameters:
    
    dimension - A FrameDimension that specifies the identity of the dimension type.
    
    Returns:
    
    The number of frames in the specified dimension.
  - save
```
public final void save(String filename)
```
    Saves this Image to the specified file or stream.
    
    Parameters:
    
    filename - A string that contains the name of the file to which to save this Image.
  - save
```
public final void save(String filename,
                       int format)
```
    Saves this Image to the specified file in the specified format.
    
    Parameters:
    
    filename - A string that contains the name of the file to which to save this Image.
    
    format - The ImageFormat for this Image.
  - save
```
public final void save(String filename,
                       ImageCodecInfo encoder,
                       EncoderParameters encoderParams)
```
    Saves this Image to the specified file, with the specified encoder and image-encoder parameters.
    
    Parameters:
    
    filename - A string that contains the name of the file to which to save this Image.
    
    encoder - The ImageCodecInfo for this Image.
    
    encoderParams - An EncoderParameters to use for this Image.
  - save
```
public final void save(OutputStream stream,
                       int format)
```
    Saves this image to the specified stream in the specified format.
    
    Parameters:
    
    stream - The InputStream where the image will be saved.
    
    format - An ImageFormat that specifies the format of the saved image.
  - save
```
public final void save(OutputStream stream,
                       ImageCodecInfo encoder,
                       EncoderParameters encoderParams)
```
    Saves this image to the specified stream, with the specified encoder and image encoder parameters.
    
    Parameters:
    
    stream - The InputStream where the image will be saved.
    
    encoder - The ImageCodecInfo for this Image.
    
    encoderParams - An EncoderParameters that specifies parameters used by the image encoder.
  - saveAdd
```
public final void saveAdd(EncoderParameters encoderParams)
```
    Adds a frame to the file or stream specified in a previous call to the one of Image.Save(...) methods. Use this method to save selected frames from a multiple-frame image to another multiple-frame image.
    
    Parameters:
    
    encoderParams - An EncoderParameters that holds parameters required by the image encoder that is used by the save-add operation.
  - saveAdd
```
public final void saveAdd(Image image,
                          EncoderParameters encoderParams)
```
    Adds a frame to the file or stream specified in a previous call to the one of Image.Save(...) methods.
    
    Parameters:
    
    image - An Image that contains the frame to add.
    
    encoderParams - An EncoderParameters that holds parameters required by the image encoder that is used by the save-add operation.
  - rotateFlip
```
public abstract void rotateFlip(int rotateFlipType)
```
    This method rotates, flips, or rotates and flips the Image.
    
    Parameters:
    
    rotateFlipType - A RotateFlipType member that specifies the type of rotation and flip to apply to the image.
  - selectActiveFrame
```
public final int selectActiveFrame(FrameDimension dimension,
                                   int frameIndex)
```
    Selects the frame specified by the dimension and index.
    
    Parameters:
    
    dimension - A FrameDimension that specifies the identity of the dimension type.
    
    frameIndex - The index of the active frame.
    
    Returns:
    
    Always returns 0.
  - getPropertyItem
```
public abstract PropertyItem getPropertyItem(int propid)
```
    Gets the specified property item from this Image.
    
    Parameters:
    
    propid - The ID of the property item to get.
    
    Returns:
    
    The PropertyItem this method gets.
  - removePropertyItem
```
public abstract void removePropertyItem(int propid)
```
    Removes the specified property item from this Image.
    
    Parameters:
    
    propid - The ID of the property item to remove.
  - setPropertyItem
```
public abstract void setPropertyItem(PropertyItem propitem)
```
    Stores a property item (piece of metadata) in this Image.
    
    Parameters:
    
    propitem - The PropertyItem to be stored.

Class Image

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Image

Method Detail

getWidth

getHeight

getSize

getHorizontalResolution

getVerticalResolution

getRawFormat

getPixelFormat

getPalette

setPalette

getPhysicalDimension

getFrameDimensionsList

getFlags

getPropertyIdList

getPropertyItems

getTag

setTag

fromFile

fromStream

fromStream

fromHbitmap

getPixelFormatSize

isAlphaPixelFormat

getThumbnailImage

dispose

deepClone

getBounds

getFrameCount

save

save

save

save

save

saveAdd

saveAdd

rotateFlip

selectActiveFrame

getPropertyItem

removePropertyItem

setPropertyItem