com.aspose.imaging.fileformats.cmx

Class CmxImage

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.cmx.CmxImage

All Implemented Interfaces:

ICmxImage, IMultipageImage, IObjectWithSizeF, IObjectWithBounds, com.aspose.internal.progressmanagement.IProgressEventHandler, com.aspose.internal.progressmanagement.IProgressInformer, com.aspose.ms.System.IDisposable, Closeable, AutoCloseable

public class CmxImage
extends VectorMultipageImage
implements ICmxImage

The CMX image.

See Also:

Image

Code example:

The following example shows how to cache all pages of a CMX image.

String dir = "c:\\temp\\";

// Load an image from a CMX file.
com.aspose.imaging.fileformats.cmx.CmxImage image = (com.aspose.imaging.fileformats.cmx.CmxImage) com.aspose.imaging.Image.load(dir + "sample.cmx");
try {
    // This call caches only the default page.
    image.cacheData();

    // Cache all pages so that no additional data loading will be performed from the underlying data stream.
    for (com.aspose.imaging.fileformats.cmx.CmxImagePage page : image.getPages()) {
        page.cacheData();
    }
} finally {
    image.dispose();
}

Constructor Summary

Constructors

Constructor and Description
CmxImage(StreamContainer streamContainer, LoadOptions loadOptions) Initializes a new instance of the CmxImage class.

Method Summary

Modifier and Type	Method and Description
void	cacheData() Caches the data and ensures no additional data loading will be performed from the underlying DataStreamSupporter.DataStreamContainer(DataStreamSupporter.getDataStreamContainer()/DataStreamSupporter.setDataStreamContainer_internalized(StreamContainer)).
int	getBitsPerPixel() Gets the image bits per pixel count.
CmxPage	getCmxPage() Gets the CMX page.
ImageOptionsBase	getDefaultOptions(Object[] args) Gets the default options.
Image	getDefaultPage() Deprecated. Please use getPages()[index]
CmxDocument	getDocument() Gets the CMX document.
long	getFileFormat() Gets a value of file format
float	getHeightF() Gets the object height, in inches.
int	getPageCount() Gets the page count.
PageExportingAction	getPageExportingAction() Gets the page exporting action.
Image[]	getPages() Gets the pages.
float	getWidthF() Gets the object width, in inches.
boolean	isCached() Gets a value indicating whether object's data is cached currently and no data reading is required.
void	resize(int newWidth, int newHeight, ImageResizeSettings settings) Resizes the image.
void	resize(int newWidth, int newHeight, int resizeType) Resizes the image.
void	rotateFlip(int rotateFlipType) Rotates, flips, or rotates and flips the image.
void	setPageExportingAction(PageExportingAction value) Sets the page exporting action.
void	setPalette(IColorPalette palette, boolean updateColors) Sets the image palette.

Methods inherited from class com.aspose.imaging.VectorMultipageImage

getEmbeddedImages, getHeight, getWidth

Methods inherited from class com.aspose.imaging.VectorImage

getSizeF

Methods inherited from class com.aspose.imaging.Image

canLoad, canLoad, canLoad, canLoad, canSave, create, create, create, getBackgroundColor, getBounds, getBufferSizeHint, getContainer, getFileFormat, getFileFormat, getFittingRectangle, getFittingRectangle, getInterruptMonitor, getOriginalOptions, getPalette, getProgressEventHandler, getProgressEventHandlerInfo, getProportionalHeight, getProportionalWidth, getSize, hasBackgroundColor, isAutoAdjustPalette, isUsePalette, load, load, load, load, load, load, resize, resizeHeightProportionally, resizeHeightProportionally, resizeHeightProportionally, resizeWidthProportionally, resizeWidthProportionally, resizeWidthProportionally, save, save, save, save, save, save, save, save, setAutoAdjustPalette, setBackgroundColor, setBackgroundColor, setBufferSizeHint, setInterruptMonitor, setPalette

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.interfaces.IObjectWithSizeF

getSizeF

Constructor Detail

CmxImage

public CmxImage(StreamContainer streamContainer,
                LoadOptions loadOptions)

Initializes a new instance of the CmxImage class.

Parameters:

streamContainer - The stream container.

loadOptions - The load options.

Method Detail

getFileFormat

public long getFileFormat()

Gets a value of file format

Overrides:

getFileFormat in class Image

Returns:

a value of file format

See Also:

FileFormat

getBitsPerPixel

public int getBitsPerPixel()

Gets the image bits per pixel count.

Overrides:

getBitsPerPixel in class VectorMultipageImage

Returns:

the image bits per pixel count.

getDefaultPage

@Deprecated
public Image getDefaultPage()

Deprecated. Please use getPages()[index]

Gets the default page.

Specified by:

getDefaultPage in interface IMultipageImage

Returns:

the default page.

See Also:

CmxImage.getPages()

isCached

public boolean isCached()

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

Overrides:

isCached in class VectorMultipageImage

Returns:

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

getWidthF

public float getWidthF()

Gets the object width, in inches.

Specified by:

getWidthF in interface IObjectWithSizeF

Overrides:

getWidthF in class VectorImage

Returns:

the object width, in inches.

getHeightF

public float getHeightF()

Gets the object height, in inches.

Specified by:

getHeightF in interface IObjectWithSizeF

Overrides:

getHeightF in class VectorImage

Returns:

the object height, in inches.

getDocument

public final CmxDocument getDocument()

Gets the CMX document.

Returns:

the CMX document.

getCmxPage

public final CmxPage getCmxPage()

Gets the CMX page.

Specified by:

getCmxPage in interface ICmxImage

Returns:

the CMX page.

getPageCount

public int getPageCount()

Gets the page count.

Value: The page count.

Specified by:

getPageCount in interface IMultipageImage

Returns:

the page count.

getPages

public Image[] getPages()

Gets the pages.

Specified by:

getPages in interface IMultipageImage

Returns:

the pages.

Code example:

The following example shows how to cache all pages of a CMX image.

String dir = "c:\\temp\\";

// Load an image from a CMX file.
com.aspose.imaging.fileformats.cmx.CmxImage image = (com.aspose.imaging.fileformats.cmx.CmxImage) com.aspose.imaging.Image.load(dir + "sample.cmx");
try {
    // This call caches only the default page.
    image.cacheData();

    // Cache all pages so that no additional data loading will be performed from the underlying data stream.
    for (com.aspose.imaging.fileformats.cmx.CmxImagePage page : image.getPages()) {
        page.cacheData();
    }
} finally {
    image.dispose();
}

getPageExportingAction

public PageExportingAction getPageExportingAction()

Gets the page exporting action. Please note that setting this method will automatically release page resources after it is executed. It will be executed just before each page is saved.

Value: The page exporting action.

Specified by:

getPageExportingAction in interface IMultipageImage

Overrides:

getPageExportingAction in class VectorMultipageImage

Returns:

the page exporting action.

setPageExportingAction

public void setPageExportingAction(PageExportingAction value)

Sets the page exporting action. Please note that setting this method will automatically release page resources after it is executed. It will be executed just before each page is saved.

Value: The page exporting action.

Specified by:

setPageExportingAction in interface IMultipageImage

Overrides:

setPageExportingAction in class VectorMultipageImage

Parameters:

value - the page exporting action.

getDefaultOptions

public ImageOptionsBase getDefaultOptions(Object[] args)

Gets the default options.

Overrides:

getDefaultOptions in class Image

Parameters:

args - The arguments.

Returns:

Default options

cacheData

public void cacheData()

Caches the data and ensures no additional data loading will be performed from the underlying DataStreamSupporter.DataStreamContainer(DataStreamSupporter.getDataStreamContainer()/DataStreamSupporter.setDataStreamContainer_internalized(StreamContainer)).

Overrides:

cacheData in class VectorMultipageImage

Code example:

The following example shows how to cache all pages of a CMX image.

String dir = "c:\\temp\\";

// Load an image from a CMX file.
com.aspose.imaging.fileformats.cmx.CmxImage image = (com.aspose.imaging.fileformats.cmx.CmxImage) com.aspose.imaging.Image.load(dir + "sample.cmx");
try {
    // This call caches only the default page.
    image.cacheData();

    // Cache all pages so that no additional data loading will be performed from the underlying data stream.
    for (com.aspose.imaging.fileformats.cmx.CmxImagePage page : image.getPages()) {
        page.cacheData();
    }
} finally {
    image.dispose();
}

resize

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

Resizes the image.

Overrides:

resize in class VectorMultipageImage

Parameters:

newWidth - The new width.

newHeight - The new height.

resizeType - The resize type.

resize

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

Resizes the image.

Overrides:

resize in class VectorMultipageImage

Parameters:

newWidth - The new width.

newHeight - The new height.

settings - The resize settings.

rotateFlip

public void rotateFlip(int rotateFlipType)

Rotates, flips, or rotates and flips the image.

Overrides:

rotateFlip in class VectorMultipageImage

Parameters:

rotateFlipType - Type of the rotate flip.

setPalette

public void setPalette(IColorPalette palette,
                       boolean updateColors)

Sets the image palette.

Overrides:

setPalette in class VectorMultipageImage

Parameters:

palette - The palette to set.

updateColors - 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.