OdImage
Inheritance: java.lang.Object, com.aspose.imaging.DisposableObject, com.aspose.imaging.DataStreamSupporter, com.aspose.imaging.Image, com.aspose.imaging.VectorImage, com.aspose.imaging.VectorMultipageImage
All Implemented Interfaces: com.aspose.internal.fileformats.opendocument.IOdImage
public abstract class OdImage extends VectorMultipageImage implements IOdImage
The open document
Constructors
| Constructor | Description |
|---|---|
| OdImage(StreamContainer streamContainer, LoadOptions options) | Initialize a new OdImage object by providing a stream container along with load options, facilitating seamless integration into software applications. |
| OdImage(StreamContainer streamContainer) | Creates a new instance of the OdImage class, designed specifically for initialization with a stream container. |
Methods
| Method | Description |
|---|---|
| getDefaultPage() | Retrieves the default page associated with the image, providing essential access to the primary page within the image collection. |
| isCached() | Obtains a boolean value indicating whether the data of the object is currently cached, thus eliminating the need for data reading. |
| getBitsPerPixel() | Retrieves the count of bits per pixel for the image. |
| getPageCount() | Retrieves the total count of pages within the image. |
| getMetadata() | Retrieves metadata specific to OpenDocument files. |
| getRecords() | Retrieves the OpenDocument records stored within the image. |
OdImage(StreamContainer streamContainer, LoadOptions options)
public OdImage(StreamContainer streamContainer, LoadOptions options)
Initialize a new OdImage object by providing a stream container along with load options, facilitating seamless integration into software applications. This constructor efficiently handle image data, offering flexibility and control over the loading process.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| streamContainer | StreamContainer | The stream. |
| options | LoadOptions | The load options. |
OdImage(StreamContainer streamContainer)
public OdImage(StreamContainer streamContainer)
Creates a new instance of the OdImage class, designed specifically for initialization with a stream container. This constructor enables seamless integration with stream-based data sources, facilitating efficient handling of OdImage instances within software systems.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| streamContainer | StreamContainer | The stream container. |
getDefaultPage()
public Image getDefaultPage()
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.
Returns: Image - 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.
Returns: boolean - a value indicating whether object’s data is cached currently and no data reading is required.
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.
Returns: int - 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 multi-page images, enabling them to accurately determine the number of pages available for processing or display.
Returns: int - the page count.
getMetadata()
public final OdMetadata getMetadata()
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: OdMetadata - 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.
Returns: com.aspose.imaging.fileformats.opendocument.OdObject[] - the records.