Image

Inheritance: java.lang.Object, com.aspose.psd.DisposableObject, com.aspose.psd.DataStreamSupporter

All Implemented Interfaces: com.aspose.psd.IObjectWithBounds, com.aspose.internal.progressmanagement.IProgressInformer, com.aspose.internal.progressmanagement.IProgressEventHandler

public abstract class Image extends DataStreamSupporter implements IObjectWithBounds, IProgressInformer, IProgressEventHandler

The image is the base class for all type of images.

Fields

Field	Description
OnCreate_internalized	Occurs when image was loaded
OnLoad_internalized	Occurs when image was loaded by createFirstSupportedLoader
OnSave_internalized	Occurs when image was loaded or saved
OnUseCredit_internalized	Occurs when credit was used

Methods

Method	Description
cacheData()	Caches the data and ensures no additional data loading will be performed from the underlying DataStreamSupporter.DataStreamContainer .
canLoad(InputStream stream)	Determines whether image can be loaded from the specified stream.
canLoad(InputStream stream, LoadOptions loadOptions)	Determines whether image can be loaded from the specified stream and optionally using the specified loadOptions .
canLoad(String filePath)	Determines whether image can be loaded from the specified file path.
canLoad(String filePath, LoadOptions loadOptions)	Determines whether image can be loaded from the specified file path and optionally using the specified open options.
canLoadInternal_internalized(System.IO.Stream stream)
canLoadInternal_internalized(System.IO.Stream stream, LoadOptions loadOptions)
canSave(ImageOptionsBase options)	Determines whether image can be saved to the specified file format represented by the passed save options.
close()	Implements the Closable interface and can be used in the try-with-resources statement since JDK 1.7.
convertToAps_internalized(ImageOptionsBase imageOptions, int mode, Rectangle clippingRectangle)	Converts to aps.
create(ImageOptionsBase imageOptions, int width, int height)	Creates a new image using the specified create options.
create(Image[] images)	Creates a new image using the specified images as pages
create(Image[] images, boolean disposeImages)	Creates a new image the specified images as pages.
dispose()	Disposes the current instance.
doAfterSave_internalized(System.IO.Stream stream)
equals(Object arg0)
getAutoAdjustPalette()	Gets a value indicating whether automatic adjust palette.
getBackgroundColor()	Gets or sets a value for the background color.
getBitsPerPixel()	Gets the image bits per pixel count.
getBounds()	Gets the image bounds.
getBufferSizeHint()	Gets the buffer size hint which is defined max allowed size for all internal buffers.
getClass()
getContainer()	Gets the Image container.
getDataStreamContainer()	Gets the object’s data stream.
getDeeplyAdjustPalette_internalized()	Gets the deeply adjust palette.
getDefaultOptions(Object[] args)	Gets the default options.
getDisposed()	Gets a value indicating whether this instance is disposed.
getFileFormat()	Gets a value of file format
getFileFormat(System.IO.Stream stream)	Gets the file format.
getFileFormat(InputStream stream)	Gets the file format.
getFileFormat(String filePath)	Gets the file format.
getFittingRectangle(Rectangle rectangle, int width, int height)	Gets rectangle which fits the current image.
getFittingRectangle(Rectangle rectangle, int[] pixels, int width, int height)	Gets rectangle which fits the current image.
getHeight()	Gets the image height.
getInterruptMonitor()	Gets the interrupt monitor.
getMemoryMgr_internalized()	Gets the memory manager.
getOriginalOptions()	Gets the options based on the original file settings.
getPaintableImage_internalized(ImageOptionsBase paintableOptions)	Gets the paintable image.
getPalette()	Gets the color palette.
getPrivateFontCache_internalized()	Creates the private font cache.
getProgressEventHandler()	Gets the progress event handler information.
getProgressEventHandlerInfo()	Gets the progress event handler information.
getProportionalHeight(int width, int height, int newWidth)	Gets a proportional height.
getProportionalWidth(int width, int height, int newHeight)	Gets a proportional width.
getSize()	Gets the image size.
getSourceImagePath_internalized()	Gets the file path of source image if it’s exist.
getUseMemoryStrategy_internalized()	Gets a value indicating whether object uses memory optimization strategy
getVentureLicense_internalized()	Gets the venture license.
getWidth()	Gets the image width.
hasBackgroundColor()	Gets a value indicating whether image has background color.
hasImageChanged_internalized()	Gets or sets a value indicating whether this instance of image has changed after loading.
hashCode()
incrementProgressMaxValue_internalized(int value)	Gets or sets the progress max value
indicateProgress_internalized(EventType eventType)	Indicates the progress.
isCached()	Gets a value indicating whether object’s data is cached currently and no data reading is required.
isUsePalette()	Gets a value indicating whether the image palette is used.
load(InputStream stream)	Loads a new image from the specified stream.
load(InputStream stream, LoadOptions loadOptions)	Loads a new image from the specified stream.
load(RandomAccessFile file)	Loads a new image from the specified stream.
load(RandomAccessFile file, LoadOptions loadOptions)	Loads a new image from the specified stream.
load(String filePath)	Loads a new image from the specified file.
load(String filePath, LoadOptions loadOptions)	Loads a new image from the specified file.
loadInternal_internalized(System.IO.Stream stream)
loadInternal_internalized(System.IO.Stream stream, LoadOptions loadOptions)
load_internalized(System.IO.Stream stream)
load_internalized(System.IO.Stream stream, long startPosition)	Loads a new image from the specified stream.
load_internalized(System.IO.Stream stream, long startPosition, LoadOptions loadOptions)	Loads a new image from the specified stream.
notify()
notifyAll()
onContainerSet_internalized()	Invoke when container of this Image was set.
resize(int newWidth, int newHeight)	Resizes the image.
resize(int newWidth, int newHeight, ImageResizeSettings settings)	Resizes the image.
resize(int newWidth, int newHeight, int resizeType)	Resizes the image.
resizeHeightProportionally(int newHeight)	Resizes the height proportionally.
resizeHeightProportionally(int newHeight, ImageResizeSettings settings)	Resizes the height proportionally.
resizeHeightProportionally(int newHeight, int resizeType)	Resizes the height proportionally.
resizeWidthProportionally(int newWidth)	Resizes the width proportionally.
resizeWidthProportionally(int newWidth, ImageResizeSettings settings)	Resizes the width proportionally.
resizeWidthProportionally(int newWidth, int resizeType)	Resizes the width proportionally.
rotateFlip(int rotateFlipType)	Rotates, flips, or rotates and flips the image.
save()	Saves the image data to the underlying stream.
save(OutputStream stream)	Saves the object’s data to the specified stream.
save(OutputStream stream, ImageOptionsBase optionsBase)	Saves the image’s data to the specified stream in the specified file format according to save options.
save(OutputStream stream, ImageOptionsBase optionsBase, Rectangle boundsRectangle)	Saves the image’s data to the specified stream in the specified file format according to save options.
save(RandomAccessFile file)	Saves the object’s data to the specified stream.
save(RandomAccessFile file, ImageOptionsBase options)	Saves the object’s data to the specified file location in the specified file format according to save options.
save(RandomAccessFile file, ImageOptionsBase optionsBase, Rectangle boundsRectangle)	Saves the image’s data to the specified stream in the specified file format according to save options.
save(String filePath)	Saves the object’s data to the specified file location.
save(String filePath, boolean overWrite)	Saves the object’s data to the specified file location.
save(String filePath, ImageOptionsBase options)	Saves the object’s data to the specified file location in the specified file format according to save options.
save(String filePath, ImageOptionsBase options, Rectangle boundsRectangle)	Saves the object’s data to the specified file location in the specified file format according to save options.
save_internalized(System.IO.Stream stream)
save_internalized(System.IO.Stream stream, ImageOptionsBase optionsBase, Rectangle boundsRectangle)
setAutoAdjustPalette(boolean value)	Sets a value indicating whether automatic adjust palette.
setBackgroundColor(boolean value)	Gets or sets a value indicating whether image has background color.
setBackgroundColor(Color value)	Gets or sets a value for the background color.
setBufferSizeHint(int value)	Sets the buffer size hint which is defined max allowed size for all internal buffers.
setContainer_internalized(Image container)	Sets the Image container.
setDataStreamContainer(StreamContainer value)	Sets the object’s data stream.
setIgnoreAfterSave_internalized(boolean value)	Sets a value indicating whether [ignore after save].
setImageChanged_internalized(boolean value)	Gets or sets a value indicating whether this instance of image has changed after loading.
setInterruptMonitor(InterruptMonitor value)	Sets the interrupt monitor.
setMemoryManager_internalized(MemMgr memoryManager, boolean needDispose)	Sets the memory manager.
setPalette(IColorPalette value)	Sets the color palette.
setPalette(IColorPalette palette, boolean updateColors)	Sets the image palette.
setVentureLicense_internalized(Object ventureLicense)	All Aspose products should implement this method.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

OnCreate_internalized

public static final Event<AfterCreate> OnCreate_internalized

Occurs when image was loaded

OnLoad_internalized

public static final Event<AfterLoad> OnLoad_internalized

Occurs when image was loaded by createFirstSupportedLoader

OnSave_internalized

public static final Event<AfterSave> OnSave_internalized

Occurs when image was loaded or saved

OnUseCredit_internalized

public static final Event<AfterUseCredit> OnUseCredit_internalized

Occurs when credit was used

cacheData()

public abstract void cacheData()

Caches the data and ensures no additional data loading will be performed from the underlying DataStreamSupporter.DataStreamContainer .

canLoad(InputStream stream)

public static boolean canLoad(InputStream stream)

Determines whether image can be loaded from the specified stream.

Parameters:

Parameter	Type	Description
stream	java.io.InputStream	The stream to load from.

Returns: boolean - true if image can be loaded from the specified stream; otherwise, false .

canLoad(InputStream stream, LoadOptions loadOptions)

public static boolean canLoad(InputStream stream, LoadOptions loadOptions)

Determines whether image can be loaded from the specified stream and optionally using the specified loadOptions .

Parameters:

Parameter	Type	Description
stream	java.io.InputStream	The stream to load from.
loadOptions	LoadOptions	The load options.

Returns: boolean - true if image can be loaded from the specified stream; otherwise, false .

canLoad(String filePath)

public static boolean canLoad(String filePath)

Determines whether image can be loaded from the specified file path.

Parameters:

Parameter	Type	Description
filePath	java.lang.String	The file path.

Returns: boolean - true if image can be loaded from the specified file; otherwise, false .

canLoad(String filePath, LoadOptions loadOptions)

public static boolean canLoad(String filePath, LoadOptions loadOptions)

Determines whether image can be loaded from the specified file path and optionally using the specified open options.

Parameters:

Parameter	Type	Description
filePath	java.lang.String	The file path.
loadOptions	LoadOptions	The load options.

Returns: boolean - true if image can be loaded from the specified file; otherwise, false .

canLoadInternal_internalized(System.IO.Stream stream)

public static boolean canLoadInternal_internalized(System.IO.Stream stream)

Parameters:

Parameter	Type	Description
stream	com.aspose.ms.System.IO.Stream

Returns: boolean

canLoadInternal_internalized(System.IO.Stream stream, LoadOptions loadOptions)

public static boolean canLoadInternal_internalized(System.IO.Stream stream, LoadOptions loadOptions)

Parameters:

Parameter	Type	Description
stream	com.aspose.ms.System.IO.Stream
loadOptions	LoadOptions

Returns: boolean

canSave(ImageOptionsBase options)

public boolean canSave(ImageOptionsBase options)

Determines whether image can be saved to the specified file format represented by the passed save options.

Parameters:

Parameter	Type	Description
options	ImageOptionsBase	The save options to use.

Returns: boolean - true if image can be saved to the specified file format represented by the passed save options; otherwise, false .

close()

public void close()

Implements the Closable interface and can be used in the try-with-resources statement since JDK 1.7. This method simply call dispose method.

convertToAps_internalized(ImageOptionsBase imageOptions, int mode, Rectangle clippingRectangle)

public abstract ApsPage convertToAps_internalized(ImageOptionsBase imageOptions, int mode, Rectangle clippingRectangle)

Converts to aps.

Parameters:

Parameter	Type	Description
imageOptions	ImageOptionsBase	The image options.
mode	int	The mode.
clippingRectangle	Rectangle	The clipping rectangle.

Returns: com.aspose.foundation.rendering.ApsPage - The APS page.

create(ImageOptionsBase imageOptions, int width, int height)

public static Image create(ImageOptionsBase imageOptions, int width, int height)

Creates a new image using the specified create options.

Parameters:

Parameter	Type	Description
imageOptions	ImageOptionsBase	The image options.
width	int	The width.
height	int	The height.

Returns: Image - The newly created image.

create(Image[] images)

public static Image create(Image[] images)

Creates a new image using the specified images as pages

Parameters:

Parameter	Type	Description
images	Image[]	The images.

Returns: Image - The Image as IMultipageImage

create(Image[] images, boolean disposeImages)

public static Image create(Image[] images, boolean disposeImages)

Creates a new image the specified images as pages.

Parameters:

Parameter	Type	Description
images	Image[]	The images.
disposeImages	boolean	if set to true [dispose images].

Returns: Image - The Image as IMultipageImage

dispose()

public final void dispose()

Disposes the current instance.

doAfterSave_internalized(System.IO.Stream stream)

public void doAfterSave_internalized(System.IO.Stream stream)

Parameters:

Parameter	Type	Description
stream	com.aspose.ms.System.IO.Stream

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

getAutoAdjustPalette()

public boolean getAutoAdjustPalette()

Gets a value indicating whether automatic adjust palette.

Returns: boolean - true if enable automatic adjust palette; otherwise, false .

getBackgroundColor()

public Color getBackgroundColor()

Gets or sets a value for the background color.

Returns: Color

getBitsPerPixel()

public abstract int getBitsPerPixel()

Gets the image bits per pixel count.

Returns: int - The image bits per pixel count.

getBounds()

public Rectangle getBounds()

Gets the image bounds.

Returns: Rectangle - The image bounds.

getBufferSizeHint()

public final int getBufferSizeHint()

Gets the buffer size hint which is defined max allowed size for all internal buffers.

Value: The buffer size hint, in megabytes. Non-positive value means no memory limitation for internal buffers

Returns: int - the buffer size hint which is defined max allowed size for all internal buffers.

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getContainer()

public Image getContainer()

Gets the Image container.

Value: The Image container.

If this property is not null it indicates the image is contained whithin another image.

Returns: Image

getDataStreamContainer()

public StreamContainer getDataStreamContainer()

Gets the object’s data stream.

Returns: StreamContainer - The object’s data stream.

getDeeplyAdjustPalette_internalized()

public boolean getDeeplyAdjustPalette_internalized()

Gets the deeply adjust palette.

Returns: boolean - The deeply adjust palette.

getDefaultOptions(Object[] args)

public ImageOptionsBase getDefaultOptions(Object[] args)

Gets the default options.

Parameters:

Parameter	Type	Description
args	java.lang.Object[]	The arguments.

Returns: ImageOptionsBase - Default options

getDisposed()

public final boolean getDisposed()

Gets a value indicating whether this instance is disposed.

Returns: boolean - true if disposed; otherwise, false .

getFileFormat()

public long getFileFormat()

Gets a value of file format

Returns: long

getFileFormat(System.IO.Stream stream)

public static long getFileFormat(System.IO.Stream stream)

Gets the file format.

Parameters:

Parameter	Type	Description
stream	com.aspose.ms.System.IO.Stream	The stream.

The file format determined does not mean that the specified image may be loaded. Use one of the CanLoad method overloads to determine whether stream may be loaded. |

Returns: long - The determined file format.

getFileFormat(InputStream stream)

public static long getFileFormat(InputStream stream)

Gets the file format.

Parameters:

Parameter	Type	Description
stream	java.io.InputStream	The stream.

The file format determined does not mean that the specified image may be loaded. Use one of the CanLoad method overloads to determine whether stream may be loaded. |

Returns: long - The determined file format.

getFileFormat(String filePath)

public static long getFileFormat(String filePath)

Gets the file format.

Parameters:

Parameter	Type	Description
filePath	java.lang.String	The file path.

The file format determined does not mean that the specified image may be loaded. Use one of the CanLoad method overloads to determine whether file may be loaded. |

Returns: long - The determined file format.

getFittingRectangle(Rectangle rectangle, int width, int height)

public static Rectangle getFittingRectangle(Rectangle rectangle, int width, int height)

Gets rectangle which fits the current image.

Parameters:

Parameter	Type	Description
rectangle	Rectangle	The rectangle to get fitting rectangle for.
width	int	The object width.
height	int	The object height.

Returns: Rectangle - The fitting rectangle or exception if no fitting rectangle can be found.

getFittingRectangle(Rectangle rectangle, int[] pixels, int width, int height)

public static Rectangle getFittingRectangle(Rectangle rectangle, int[] pixels, int width, int height)

Gets rectangle which fits the current image.

Parameters:

Parameter	Type	Description
rectangle	Rectangle	The rectangle to get fitting rectangle for.
pixels	int[]	The 32-bit ARGB pixels.
width	int	The object width.
height	int	The object height.

Returns: Rectangle - The fitting rectangle or exception if no fitting rectangle can be found.

getHeight()

public abstract int getHeight()

Gets the image height.

Returns: int - The image height.

getInterruptMonitor()

public InterruptMonitor getInterruptMonitor()

Gets the interrupt monitor.

Returns: InterruptMonitor - the interrupt monitor.

getMemoryMgr_internalized()

public MemMgr getMemoryMgr_internalized()

Gets the memory manager.

Value: The memory manager.

Returns: com.aspose.internal.memorymanagement.MemMgr - the memory manager.

getOriginalOptions()

public ImageOptionsBase getOriginalOptions()

Gets the options based on the original file settings. This can be helpful to keep bit-depth and other parameters of the original image unchanged. For example, if we load a black-white PNG image with 1 bit per pixel and then save it using the DataStreamSupporter.Save(string) method, the output PNG image with 8-bit per pixel will be produced. To avoid it and save PNG image with 1-bit per pixel, use this method to get corresponding saving options and pass them to the Image.Save(string, ImageOptionsBase) method as the second parameter.

Returns: ImageOptionsBase - The options based on the original file settings.

getPaintableImage_internalized(ImageOptionsBase paintableOptions)

public Image getPaintableImage_internalized(ImageOptionsBase paintableOptions)

Gets the paintable image.

Parameters:

Parameter	Type	Description
paintableOptions	ImageOptionsBase

Returns: Image - the paintable image.

getPalette()

public IColorPalette getPalette()

Gets the color palette. The color palette is not used when pixels are represented directly.

Returns: IColorPalette - The color palette.

getPrivateFontCache_internalized()

public final PalPrivateFontCache getPrivateFontCache_internalized()

Creates the private font cache.

Returns: com.aspose.foundation.pal.PalPrivateFontCache - The private font cache.

getProgressEventHandler()

public final ProgressEventHandler getProgressEventHandler()

Gets the progress event handler information.

Returns: ProgressEventHandler - the progress event handler information.

getProgressEventHandlerInfo()

public final ProgressEventHandlerInfo getProgressEventHandlerInfo()

Gets the progress event handler information.

Value: The progress event handler information.

Returns: ProgressEventHandlerInfo - the progress event handler information.

getProportionalHeight(int width, int height, int newWidth)

public static int getProportionalHeight(int width, int height, int newWidth)

Gets a proportional height.

Parameters:

Parameter	Type	Description
width	int	The width.
height	int	The height.
newWidth	int	The new width.

Returns: int - The proportional height.

getProportionalWidth(int width, int height, int newHeight)

public static int getProportionalWidth(int width, int height, int newHeight)

Gets a proportional width.

Parameters:

Parameter	Type	Description
width	int	The width.
height	int	The height.
newHeight	int	The new height.

Returns: int - The proportional width.

getSize()

public Size getSize()

Gets the image size.

Returns: Size - The image size.

getSourceImagePath_internalized()

public String getSourceImagePath_internalized()

Gets the file path of source image if it’s exist. Returns an empty string if can’t find the source path.

Returns: java.lang.String - The file path of source image.

getUseMemoryStrategy_internalized()

public boolean getUseMemoryStrategy_internalized()

Gets a value indicating whether object uses memory optimization strategy

Value: true if object uses memory optimization strategy; otherwise, false .

Returns: boolean - a value indicating whether object uses memory optimization strategy

getVentureLicense_internalized()

public Object getVentureLicense_internalized()

Gets the venture license.

Returns: java.lang.Object - Teh venture license as object.

getWidth()

public abstract int getWidth()

Gets the image width.

Returns: int - The image width.

hasBackgroundColor()

public boolean hasBackgroundColor()

Gets a value indicating whether image has background color.

Returns: boolean

hasImageChanged_internalized()

public boolean hasImageChanged_internalized()

Gets or sets a value indicating whether this instance of image has changed after loading.

Returns: boolean - true if this instance has image changed; otherwise, false .

hashCode()

public native int hashCode()

Returns: int

incrementProgressMaxValue_internalized(int value)

public final void incrementProgressMaxValue_internalized(int value)

Gets or sets the progress max value

Value: The progress max value

Parameters:

Parameter	Type	Description
value	int

indicateProgress_internalized(EventType eventType)

public final void indicateProgress_internalized(EventType eventType)

Indicates the progress.

Parameters:

Parameter	Type	Description
eventType	EventType

isCached()

public abstract boolean isCached()

Gets a value indicating whether object’s data is cached currently and no data reading is required.

Returns: boolean - a value indicating whether object’s data is cached currently and no data reading is required.

isUsePalette()

public boolean isUsePalette()

Gets a value indicating whether the image palette is used.

Value: true if the palette is used in the image; otherwise, false .

Returns: boolean - a value indicating whether the image palette is used.

load(InputStream stream)

public static Image load(InputStream stream)

Loads a new image from the specified stream.

Parameters:

Parameter	Type	Description
stream	java.io.InputStream	The stream to load image from.

Returns: Image - The loaded image.

load(InputStream stream, LoadOptions loadOptions)

public static Image load(InputStream stream, LoadOptions loadOptions)

Loads a new image from the specified stream.

Parameters:

Parameter	Type	Description
stream	java.io.InputStream	The stream to load image from.
loadOptions	LoadOptions	The load options.

Returns: Image - The loaded image.

load(RandomAccessFile file)

public static Image load(RandomAccessFile file)

Loads a new image from the specified stream.

Parameters:

Parameter	Type	Description
file	java.io.RandomAccessFile	The file to load image from.

Returns: Image - The loaded image.

load(RandomAccessFile file, LoadOptions loadOptions)

public static Image load(RandomAccessFile file, LoadOptions loadOptions)

Loads a new image from the specified stream.

Parameters:

Parameter	Type	Description
file	java.io.RandomAccessFile	The file to load image from.
loadOptions	LoadOptions	The load options.

Returns: Image - The loaded image.

load(String filePath)

public static Image load(String filePath)

Loads a new image from the specified file.

Parameters:

Parameter	Type	Description
filePath	java.lang.String	The file path to load image from.

Returns: Image - The loaded image.

load(String filePath, LoadOptions loadOptions)

public static Image load(String filePath, LoadOptions loadOptions)

Loads a new image from the specified file.

Parameters:

Parameter	Type	Description
filePath	java.lang.String	The file path to load image from.
loadOptions	LoadOptions	The load options.

Returns: Image - The loaded image.

loadInternal_internalized(System.IO.Stream stream)

public static Image loadInternal_internalized(System.IO.Stream stream)

Parameters:

Parameter	Type	Description
stream	com.aspose.ms.System.IO.Stream

Returns: Image

loadInternal_internalized(System.IO.Stream stream, LoadOptions loadOptions)

public static Image loadInternal_internalized(System.IO.Stream stream, LoadOptions loadOptions)

Parameters:

Parameter	Type	Description
stream	com.aspose.ms.System.IO.Stream
loadOptions	LoadOptions

Returns: Image

load_internalized(System.IO.Stream stream)

public static Image load_internalized(System.IO.Stream stream)

Parameters:

Parameter	Type	Description
stream	com.aspose.ms.System.IO.Stream

Returns: Image

load_internalized(System.IO.Stream stream, long startPosition)

public static Image load_internalized(System.IO.Stream stream, long startPosition)

Loads a new image from the specified stream.

Parameters:

Parameter	Type	Description
stream	com.aspose.ms.System.IO.Stream	The stream to load image from.
startPosition	long	The start position to load image from.

Returns: Image - The loaded image.

load_internalized(System.IO.Stream stream, long startPosition, LoadOptions loadOptions)

public static Image load_internalized(System.IO.Stream stream, long startPosition, LoadOptions loadOptions)

Loads a new image from the specified stream.

Parameters:

Parameter	Type	Description
stream	com.aspose.ms.System.IO.Stream	The stream to load image from.
startPosition	long	The start position to load image from.
loadOptions	LoadOptions	The load options.

Returns: Image - The loaded image.

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

onContainerSet_internalized()

public void onContainerSet_internalized()

Invoke when container of this Image was set.

resize(int newWidth, int newHeight)

public void resize(int newWidth, int newHeight)

Resizes the image. The default ResizeType.LeftTopToLeftTop is used.

Parameters:

Parameter	Type	Description
newWidth	int	The new width.
newHeight	int	The new height.

resize(int newWidth, int newHeight, ImageResizeSettings settings)

public abstract void resize(int newWidth, int newHeight, ImageResizeSettings settings)

Resizes the image.

Parameters:

Parameter	Type	Description
newWidth	int	The new width.
newHeight	int	The new height.
settings	ImageResizeSettings	The resize settings.

resize(int newWidth, int newHeight, int resizeType)

public abstract void resize(int newWidth, int newHeight, int resizeType)

Resizes the image.

Parameters:

Parameter	Type	Description
newWidth	int	The new width.
newHeight	int	The new height.
resizeType	int	The resize type.

resizeHeightProportionally(int newHeight)

public void resizeHeightProportionally(int newHeight)

Resizes the height proportionally.

Parameters:

Parameter	Type	Description
newHeight	int	The new height.

resizeHeightProportionally(int newHeight, ImageResizeSettings settings)

public void resizeHeightProportionally(int newHeight, ImageResizeSettings settings)

Resizes the height proportionally.

Parameters:

Parameter	Type	Description
newHeight	int	The new height.
settings	ImageResizeSettings	The image resize settings.

resizeHeightProportionally(int newHeight, int resizeType)

public void resizeHeightProportionally(int newHeight, int resizeType)

Resizes the height proportionally.

Parameters:

Parameter	Type	Description
newHeight	int	The new height.
resizeType	int	Type of the resize.

resizeWidthProportionally(int newWidth)

public void resizeWidthProportionally(int newWidth)

Resizes the width proportionally.

Parameters:

Parameter	Type	Description
newWidth	int	The new width.

resizeWidthProportionally(int newWidth, ImageResizeSettings settings)

public void resizeWidthProportionally(int newWidth, ImageResizeSettings settings)

Resizes the width proportionally.

Parameters:

Parameter	Type	Description
newWidth	int	The new width.
settings	ImageResizeSettings	The image resize settings.

resizeWidthProportionally(int newWidth, int resizeType)

public void resizeWidthProportionally(int newWidth, int resizeType)

Resizes the width proportionally.

Parameters:

Parameter	Type	Description
newWidth	int	The new width.
resizeType	int	Type of the resize.

rotateFlip(int rotateFlipType)

public abstract void rotateFlip(int rotateFlipType)

Rotates, flips, or rotates and flips the image.

Parameters:

Parameter	Type	Description
rotateFlipType	int	Type of the rotate flip.

save()

public final void save()

Saves the image data to the underlying stream.

save(OutputStream stream)

public void save(OutputStream stream)

Saves the object’s data to the specified stream.

Parameters:

Parameter	Type	Description
stream	java.io.OutputStream	The stream to save the object’s data to.

save(OutputStream stream, ImageOptionsBase optionsBase)

public void save(OutputStream stream, ImageOptionsBase optionsBase)

Saves the image’s data to the specified stream in the specified file format according to save options.

Parameters:

Parameter	Type	Description
stream	java.io.OutputStream	The stream to save the image’s data to.
optionsBase	ImageOptionsBase	The save options.

save(OutputStream stream, ImageOptionsBase optionsBase, Rectangle boundsRectangle)

public void save(OutputStream stream, ImageOptionsBase optionsBase, Rectangle boundsRectangle)

Saves the image’s data to the specified stream in the specified file format according to save options.

Parameters:

Parameter	Type	Description
stream	java.io.OutputStream	The stream to save the image’s data to.
optionsBase	ImageOptionsBase	The save options.
boundsRectangle	Rectangle	The destination image bounds rectangle. Set the empty rectangle for use source bounds.

save(RandomAccessFile file)

public void save(RandomAccessFile file)

Saves the object’s data to the specified stream.

Parameters:

Parameter	Type	Description
file	java.io.RandomAccessFile	The stream to save the object’s data to.

save(RandomAccessFile file, ImageOptionsBase options)

public void save(RandomAccessFile file, ImageOptionsBase options)

Saves the object’s data to the specified file location in the specified file format according to save options.

Parameters:

Parameter	Type	Description
file	java.io.RandomAccessFile	The file to save the image’s data to.
options	ImageOptionsBase	The options.

save(RandomAccessFile file, ImageOptionsBase optionsBase, Rectangle boundsRectangle)

public void save(RandomAccessFile file, ImageOptionsBase optionsBase, Rectangle boundsRectangle)

Saves the image’s data to the specified stream in the specified file format according to save options.

Parameters:

Parameter	Type	Description
file	java.io.RandomAccessFile	The file to save the image’s data to.
optionsBase	ImageOptionsBase	The save options.
boundsRectangle	Rectangle	The destination image bounds rectangle. Set the empty rectangle for use sourse bounds.

save(String filePath)

public void save(String filePath)

Saves the object’s data to the specified file location.

Parameters:

Parameter	Type	Description
filePath	java.lang.String	The file path to save the object’s data to.

save(String filePath, boolean overWrite)

public void save(String filePath, boolean overWrite)

Saves the object’s data to the specified file location.

Parameters:

Parameter	Type	Description
filePath	java.lang.String	The file path to save the object’s data to.
overWrite	boolean	if set to true over write the file contents, otherwise append will occur.

save(String filePath, ImageOptionsBase options)

public void save(String filePath, ImageOptionsBase options)

Saves the object’s data to the specified file location in the specified file format according to save options.

Parameters:

Parameter	Type	Description
filePath	java.lang.String	The file path.
options	ImageOptionsBase	The options.

save(String filePath, ImageOptionsBase options, Rectangle boundsRectangle)

public void save(String filePath, ImageOptionsBase options, Rectangle boundsRectangle)

Saves the object’s data to the specified file location in the specified file format according to save options.

Parameters:

Parameter	Type	Description
filePath	java.lang.String	The file path.
options	ImageOptionsBase	The options.
boundsRectangle	Rectangle	The destination image bounds rectangle. Set the empty rectangle for use sourse bounds.

save_internalized(System.IO.Stream stream)

public void save_internalized(System.IO.Stream stream)

Parameters:

Parameter	Type	Description
stream	com.aspose.ms.System.IO.Stream

save_internalized(System.IO.Stream stream, ImageOptionsBase optionsBase, Rectangle boundsRectangle)

public void save_internalized(System.IO.Stream stream, ImageOptionsBase optionsBase, Rectangle boundsRectangle)

Parameters:

Parameter	Type	Description
stream	com.aspose.ms.System.IO.Stream
optionsBase	ImageOptionsBase
boundsRectangle	Rectangle

setAutoAdjustPalette(boolean value)

public void setAutoAdjustPalette(boolean value)

Sets a value indicating whether automatic adjust palette.

Parameters:

Parameter	Type	Description
value	boolean	true if enable automatic adjust palette; otherwise, false .

setBackgroundColor(boolean value)

public void setBackgroundColor(boolean value)

Gets or sets a value indicating whether image has background color.

Parameters:

Parameter	Type	Description
value	boolean

setBackgroundColor(Color value)

public void setBackgroundColor(Color value)

Gets or sets a value for the background color.

Parameters:

Parameter	Type	Description
value	Color

setBufferSizeHint(int value)

public final void setBufferSizeHint(int value)

Sets the buffer size hint which is defined max allowed size for all internal buffers.

Value: The buffer size hint, in megabytes. Non-positive value means no memory limitation for internal buffers

Parameters:

Parameter	Type	Description
value	int	the buffer size hint which is defined max allowed size for all internal buffers.

setContainer_internalized(Image container)

public void setContainer_internalized(Image container)

Sets the Image container.

Parameters:

Parameter	Type	Description
container	Image	The Image container.

setDataStreamContainer(StreamContainer value)

public void setDataStreamContainer(StreamContainer value)

Sets the object’s data stream.

Parameters:

Parameter	Type	Description
value	StreamContainer	The object’s data stream.

setIgnoreAfterSave_internalized(boolean value)

public void setIgnoreAfterSave_internalized(boolean value)

Sets a value indicating whether [ignore after save].

Parameters:

Parameter	Type	Description
value	boolean	true if [ignore after save]; otherwise, false .

setImageChanged_internalized(boolean value)

public void setImageChanged_internalized(boolean value)

Gets or sets a value indicating whether this instance of image has changed after loading.

Parameters:

Parameter	Type	Description
value	boolean	true if this instance has image changed; otherwise, false .

setInterruptMonitor(InterruptMonitor value)

public void setInterruptMonitor(InterruptMonitor value)

Sets the interrupt monitor.

Parameters:

Parameter	Type	Description
value	InterruptMonitor	the interrupt monitor.

setMemoryManager_internalized(MemMgr memoryManager, boolean needDispose)

public void setMemoryManager_internalized(MemMgr memoryManager, boolean needDispose)

Sets the memory manager.

Parameters:

Parameter	Type	Description
memoryManager	com.aspose.internal.memorymanagement.MemMgr	The memory manager.
needDispose	boolean	if set to true [need dispose].

setPalette(IColorPalette value)

public void setPalette(IColorPalette value)

Sets the color palette. The color palette is not used when pixels are represented directly.

Parameters:

Parameter	Type	Description
value	IColorPalette	The color palette.

setPalette(IColorPalette palette, boolean updateColors)

public abstract void setPalette(IColorPalette palette, boolean updateColors)

Sets the image palette.

Parameters:

Parameter	Type	Description
palette	IColorPalette	The palette to set.
updateColors	boolean	if set to true colors will be updated according to the new palette; otherwise color indexes remain unchanged. Note that unchanged indexes may crash the image on loading if some indexes have no corresponding palette entries.

setVentureLicense_internalized(Object ventureLicense)

public void setVentureLicense_internalized(Object ventureLicense)

All Aspose products should implement this method. It is called by a GroupDocs product to indicate whether GroupDocs itself is licensed or not and specify a custom watermark. When GroupDocs is licensed, this document instance should behave as licensed too even if the Aspose product is not licensed.

Parameters:

Parameter	Type	Description
ventureLicense	java.lang.Object

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int

HotkeyPrefix ImageAttributes