com.aspose.imaging.fileformats.opendocument

Class OdImage

java.lang.Object

com.aspose.imaging.DisposableObject

com.aspose.imaging.DataStreamSupporter

com.aspose.imaging.Image

com.aspose.imaging.VectorImage

com.aspose.imaging.VectorMultipageImage

com.aspose.imaging.fileformats.opendocument.OdImage

All Implemented Interfaces:

IHasExifData, IHasMetadata, IMetadataContainer, IMultipageImage, IObjectWithSizeF, IObjectWithBounds, IHasXmpData, com.aspose.internal.fileformats.opendocument.IOdImage, com.aspose.internal.progressmanagement.IProgressEventHandler, com.aspose.internal.progressmanagement.IProgressInformer, com.aspose.ms.System.IDisposable, Closeable, AutoCloseable

Direct Known Subclasses:

OdgImage, OtgImage

public abstract class OdImage
extends VectorMultipageImage
implements com.aspose.internal.fileformats.opendocument.IOdImage

The open document

Method Summary

Modifier and Type	Method and Description
int	getBitsPerPixel() Retrieves the count of bits per pixel for the image.
Image	getDefaultPage() Deprecated. Please use getPages()[index]
OdMetadata	getOdMetadata() Retrieves metadata specific to OpenDocument files.
int	getPageCount() Retrieves the total count of pages within the image.
OdObject[]	getRecords() Retrieves the OpenDocument records stored within the image.
boolean	isCached() Obtains a boolean value indicating whether the data of the object is currently cached, thus eliminating the need for data reading.

Methods inherited from class com.aspose.imaging.VectorMultipageImage

cacheData, crop, getEmbeddedImages, getHeight, getMetadata, getPageExportingAction, getWidth, removeBackground, removeBackground, resize, resize, rotate, rotateFlip, setPageExportingAction, setPalette

Methods inherited from class com.aspose.imaging.VectorImage

getDefaultOptions, getHeightF, getSizeF, getWidthF

Methods inherited from class com.aspose.imaging.Image

canLoad, canLoad, canLoad, canLoad, canSave, create, create, create, create, create, create, create, crop, getBackgroundColor, getBounds, getBufferSizeHint, getContainer, getExifData, getFileFormat, getFileFormat, getFileFormat, getFittingRectangle, getFittingRectangle, getInterruptMonitor, getIProgressEventHandler, getOriginalOptions, getPalette, getProgressEventHandlerInfo, getProportionalHeight, getProportionalWidth, getSerializedStream, getSize, getXmpData, hasBackgroundColor, isAutoAdjustPalette, isUsePalette, load, load, load, load, load, load, removeMetadata, resize, resizeHeightProportionally, resizeHeightProportionally, resizeHeightProportionally, resizeWidthProportionally, resizeWidthProportionally, resizeWidthProportionally, save, save, save, save, save, save, save, save, setAutoAdjustPalette, setBackgroundColor, setBackgroundColor, setBufferSizeHint, setExifData, setInterruptMonitor, setPalette, setXmpData, trySetMetadata

Methods inherited from class com.aspose.imaging.DataStreamSupporter

getDataStreamContainer, save, save, save

Methods inherited from class com.aspose.imaging.DisposableObject

close, dispose, getDisposed

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.aspose.imaging.IMultipageImage

getPages

Method Detail

getDefaultPage

@Deprecated
public Image getDefaultPage()

Deprecated. Please use getPages()[index]

Retrieves the default page associated with the image, providing essential access to the primary page within the image collection. This property streamlines navigation and manipulation of image data, enhancing the efficiency of software development workflows.

Specified by:

getDefaultPage in class VectorMultipageImage

Returns:

the default page.

isCached

public boolean isCached()

Obtains a boolean value indicating whether the data of the object is currently cached, thus eliminating the need for data reading. This property serves as an optimization indicator, enhancing performance by minimizing redundant data access operation.

Overrides:

isCached in class VectorMultipageImage

Returns:

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

Throws:

com.aspose.ms.System.NotImplementedException - The not implemented this method Value: true if object's data is cached; otherwise, false.

getBitsPerPixel

public int getBitsPerPixel()

Retrieves the count of bits per pixel for the image. This property provides insight into the level of detail and color depth represented in the image, aiding in various image processing tasks and optimizations.

Overrides:

getBitsPerPixel in class VectorMultipageImage

Returns:

the image bits per pixel count.

Throws:

com.aspose.ms.System.NotImplementedException - The not implemented this property Value: The image bits per pixel count.

getPageCount

public int getPageCount()

Retrieves the total count of pages within the image. This property is essential for applications managing multipage images, enabling them to accurately determine the number of pages available for processing or display.

Specified by:

getPageCount in interface IMultipageImage

Returns:

the page count.

getOdMetadata

public final OdMetadata getOdMetadata()

Retrieves metadata specific to OpenDocument files. This property allows access to essential information embedded within OD files, facilitating various operations such as extraction, modification, or analysis of metadata.

Returns:

the metadata.

getRecords

public final OdObject[] getRecords()

Retrieves the OpenDocument records stored within the image. This property grants access to specific structured data elements embedded within OpenDocument files, facilitating retrieval or manipulation of relevant information for further processing or analysis.

Specified by:

getRecords in interface com.aspose.internal.fileformats.opendocument.IOdImage

Returns:

the records.