Packages

 

com.aspose.cad

Class Image

    • Method Detail

      • getBitsPerPixel

        public abstract int getBitsPerPixel()

        Gets the image bits per pixel count.

        Value: The image bits per pixel count.
      • 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.

      • getHeight

        public abstract int getHeight()

        Gets the image height.

        Value: The image height.
        Specified by:
        getHeight in interface IObjectWithBounds
      • getPalette

        public IColorPalette getPalette()

        Gets or sets the color palette.

        Value: The color palette.
      • setPalette

        public void setPalette(IColorPalette value)

        Gets or sets the color palette.

        Value: The color palette.
      • getWidth

        public abstract int getWidth()

        Gets the image width.

        Value: The image width.
        Specified by:
        getWidth in interface IObjectWithBounds
      • hasBackgroundColor

        public boolean hasBackgroundColor()

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

      • setBackgroundColor

        public void setBackgroundColor(boolean value)

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

      • getBackgroundColor

        public Color getBackgroundColor()

        Gets or sets a value for the background color.

      • setBackgroundColor

        public void setBackgroundColor(Color value)

        Gets or sets a value for the background color.

      • getUnitType

        public int getUnitType()

        Gets current unit type.

      • canLoad

        public static boolean canLoad(String filePath)

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

        Parameters:
        filePath - The file path.
        Returns:
        true if image can be loaded from the specified file; otherwise, false.
      • canLoad

        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:
        filePath - The file path.
        loadOptions - The load options.
        Returns:
        true if image can be loaded from the specified file; otherwise, false.
      • canLoad

        public static boolean canLoad(InputStream stream)

        Determines whether image can be loaded from the specified stream.

        Parameters:
        stream - The stream to load from.
        Returns:
        true if image can be loaded from the specified stream; otherwise, false.
      • canLoad_internalized

        public static boolean canLoad_internalized(com.aspose.ms.System.IO.Stream stream)
      • canLoad

        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:
        stream - The stream to load from.
        loadOptions - The load options.
        Returns:
        true if image can be loaded from the specified stream; otherwise, false.
      • canLoad_internalized

        public static boolean canLoad_internalized(com.aspose.ms.System.IO.Stream stream,
                                                   LoadOptions loadOptions)
      • getFileFormat

        public static long getFileFormat(String filePath)

        Gets the file format.

        Parameters:
        filePath - 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:
        The determined file format.
      • getFileFormat

        public static long getFileFormat(InputStream stream)

        Gets the file format.

        Parameters:
        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:
        The determined file format.
      • getFileFormat_internalized

        public static long getFileFormat_internalized(com.aspose.ms.System.IO.Stream stream)
      • getFittingRectangle

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

        Gets rectangle which fits the current image.

        Parameters:
        rectangle - The rectangle to get fitting rectangle for.
        width - The object width.
        height - The object height.
        Returns:
        The fitting rectangle or exception if no fitting rectangle can be found.
      • getFittingRectangle

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

        Gets rectangle which fits the current image.

        Parameters:
        rectangle - The rectangle to get fitting rectangle for.
        pixels - The 32-bit ARGB pixels.
        width - The object width.
        height - The object height.
        Returns:
        The fitting rectangle or exception if no fitting rectangle can be found.
      • load

        public static Image load(String filePath,
                                 LoadOptions loadOptions)

        Loads a new image from the specified file.

        Parameters:
        filePath - The file path to load image from.
        loadOptions - The load options.
        Returns:
        The loaded image.
      • load

        public static Image load(String filePath)

        Loads a new image from the specified file.

        Parameters:
        filePath - The file path to load image from.
        Returns:
        The loaded image.
      • load

        public static Image load(InputStream stream,
                                 LoadOptions loadOptions)

        Loads a new image from the specified stream.

        Parameters:
        stream - The stream to load image from.
        loadOptions - The load options.
        Returns:
        The loaded image.
      • load_internalized

        public static Image load_internalized(com.aspose.ms.System.IO.Stream stream,
                                              LoadOptions loadOptions)
      • load

        public static Image load(InputStream stream)

        Loads a new image from the specified stream.

        Parameters:
        stream - The stream to load image from.
        Returns:
        The loaded image.
      • load_internalized

        public static Image load_internalized(com.aspose.ms.System.IO.Stream stream)
      • canSave

        public boolean canSave(ImageOptionsBase options)

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

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

        public void resize(int newWidth,
                           int newHeight)

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

        Parameters:
        newWidth - The new width.
        newHeight - The new height.
      • resize

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

        Resizes the image.

        Parameters:
        newWidth - The new width.
        newHeight - The new height.
        resizeType - The resize type.
      • resize

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

        Resizes the image.

        Parameters:
        newWidth - The new width.
        newHeight - The new height.
        settings - The resize settings.
      • resizeWidthProportionally

        public void resizeWidthProportionally(int newWidth)

        Resizes the width proportionally.

        Parameters:
        newWidth - The new width.
      • resizeHeightProportionally

        public void resizeHeightProportionally(int newHeight)

        Resizes the height proportionally.

        Parameters:
        newHeight - The new height.
      • resizeWidthProportionally

        public void resizeWidthProportionally(int newWidth,
                                              int resizeType)

        Resizes the width proportionally.

        Parameters:
        newWidth - The new width.
        resizeType - Type of the resize.
      • resizeHeightProportionally

        public void resizeHeightProportionally(int newHeight,
                                               int resizeType)

        Resizes the height proportionally.

        Parameters:
        newHeight - The new height.
        resizeType - Type of the resize.
      • resizeWidthProportionally

        public void resizeWidthProportionally(int newWidth,
                                              ImageResizeSettings settings)

        Resizes the width proportionally.

        Parameters:
        newWidth - The new width.
        settings - The image resize settings.
      • resizeHeightProportionally

        public void resizeHeightProportionally(int newHeight,
                                               ImageResizeSettings settings)

        Resizes the height proportionally.

        Parameters:
        newHeight - The new height.
        settings - The image resize settings.
      • rotateFlip

        public abstract void rotateFlip(int rotateFlipType)

        Rotates, flips, or rotates and flips the image.

        Parameters:
        rotateFlipType - Type of the rotate flip.
      • save

        public final void save()

        Saves the image data to the underlying stream.

        Overrides:
        save in class DataStreamSupporter
      • saveInternal_internalized

        public void saveInternal_internalized()

        Saves the image data to the underlying stream.

      • save

        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:
        filePath - The file path.
        options - The options.
      • save

        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:
        filePath - The file path.
        options - The options.
        boundsRectangle - The destination image bounds rectangle. Set the empty rectangle for use sourse bounds.
        Throws:
        com.aspose.ms.System.ArgumentNullException - options
        ImageSaveException - Image saving failed.
      • save

        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:
        stream - The stream to save the image's data to.
        optionsBase - The save options.
        Throws:
        com.aspose.ms.System.ArgumentNullException - optionsBase
        com.aspose.ms.System.ArgumentException - Cannot save to the specified format as it is not supported at the moment.;optionsBase
        ImageSaveException - Image export failed.
      • save_internalized

        public void save_internalized(com.aspose.ms.System.IO.Stream stream,
                                      ImageOptionsBase optionsBase)
      • save

        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:
        stream - The stream to save the image's data to.
        optionsBase - The save options.
        boundsRectangle - The destination image bounds rectangle. Set the empty rectangle for use sourse bounds.
        Throws:
        com.aspose.ms.System.ArgumentNullException - optionsBase
        com.aspose.ms.System.ArgumentException - Cannot save to the specified format as it is not supported at the moment.;optionsBase
        ImageSaveException - Image export failed.
      • saveInternal_internalized

        public void saveInternal_internalized(com.aspose.ms.System.IO.Stream stream,
                                              ImageOptionsBase optionsBase,
                                              Rectangle boundsRectangle)
      • save_internalized

        public void save_internalized(com.aspose.ms.System.IO.Stream stream,
                                      ImageOptionsBase optionsBase,
                                      Rectangle boundsRectangle)
      • setPalette

        public abstract void setPalette(IColorPalette palette,
                                        boolean updateColors)

        Sets the image palette.

        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.
      • getProportionalWidth

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

        Gets a proportional width.

        Parameters:
        width - The width.
        height - The height.
        newHeight - The new height.
        Returns:
        The proportional width.
      • getProportionalHeight

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

        Gets a proportional height.

        Parameters:
        width - The width.
        height - The height.
        newWidth - The new width.
        Returns:
        The proportional height.
      • setVentureLicense_internalized

        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.

      • getVentureLicense_internalized

        public Object getVentureLicense_internalized()

        Gets the venture license.

        Returns:
        Teh venture license as object.
      • setContainer_internalized

        public void setContainer_internalized(Image container)

        Sets the Image container.

        Parameters:
        container - The Image container.