com.canto.cumulus.utils

Class ImagingPixmap

java.lang.Object

com.canto.cumulus.utils.ImagingPixmap

All Implemented Interfaces:

java.lang.AutoCloseable

public class ImagingPixmap
extends java.lang.Object
implements java.lang.AutoCloseable

This class provides a fast access to asset previews and also provides functions on these previews. This class is not stable and might change in upcoming versions.

Since:

8.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImagingPixmap.ColorSpace
static class	ImagingPixmap.Compression
static class	ImagingPixmap.Filter
static class	ImagingPixmap.FlipDirection
static class	ImagingPixmap.Format
static class	ImagingPixmap.RotateAngle

Method Summary

Methods

Modifier and Type	Method and Description
void	adjustBrightnessContrast(double brightness, double contrast, boolean preserveColors)
void	adjustBrightnessContrast(double brightness, double contrast, boolean preserveColors, java.awt.image.BufferedImage bufferedImage)
void	adjustColors(double[] colors)
void	adjustColors(double[] colors, java.awt.image.BufferedImage bufferedImage)
void	adjustGamma(double gamma, boolean preserveColors)
void	adjustGamma(double gamma, boolean preserveColors, java.awt.image.BufferedImage bufferedImage)
void	close() Free all associated resources of this instance.
void	crop(int x, int y, int width, int height) Crops the pixmap to the specified rectangle.
void	filter(ImagingPixmap.Filter filterType, double radius, double strength)
void	filter(ImagingPixmap.Filter filterType, double radius, double strength, java.awt.image.BufferedImage bufferedImage)
void	flip(ImagingPixmap.FlipDirection direction) Flips the pixmap.
java.awt.image.BufferedImage	getBufferedImage() Returns the pixmap as Java buffered image.
java.awt.image.BufferedImage	getBufferedImage(int width, int height) Returns the pixmap as Java buffered image with the requested image dimension.
int	getColorDepth() Returns the color depth of the pixmap in bits.
ImagingPixmap.ColorSpace	getColorSpace() Returns the color space for the pixmap.
static java.lang.String	getColorSpaceName(ImagingPixmap.ColorSpace colorSpace) Returns a label for the given color space.
int	getHeight() Returns the pixel height of the pixmap.
int	getNumberOfPages() Returns the number of pages for the underlying asset.
static ImagingPixmap	getPixmap(Item item) Returns a new pixmap instance for the given record item that works on the preview of the related asset.
static ImagingPixmap	getPixmap(Item item, Asset asset, java.lang.String assetHandlingSet, int page) Returns a new pixmap instance for the given record item that works on the preview (generated by using the specified asset handling set) of the given asset.
static ImagingPixmap	getPixmap(Item item, java.lang.String assetHandlingSet) Returns a new pixmap instance for the given record item that works on the preview (generated by using the specified asset handling set) of the related asset.
static ImagingPixmap	getPixmap(Item item, java.lang.String assetHandlingSet, int version) Returns a new pixmap instance for the given record item that works on the preview (generated by using the specified asset handling set) of the related asset.
static ImagingPixmap	getPixmap(Item item, java.lang.String assetHandlingSet, int version, int page) Returns a new pixmap instance for the given record item that works on the preview (generated by using the specified asset handling set) of the related asset.
int	getWidth() Returns the pixel width of the pixmap.
void	rotate(ImagingPixmap.RotateAngle rotateAngle) Rotates the pixmap.
void	save(java.io.File file, ImagingPixmap.Format format, ImagingPixmap.ColorSpace colorspace, ImagingPixmap.Compression compression, int jpegQualityOrZIPCompression, boolean embedTransparencyGrid, int boundingBox) Saves the current pixmap as a new file at the given location using the specified parameters.
void	save(java.io.File file, ImagingPixmap.Format format, ImagingPixmap.ColorSpace colorspace, ImagingPixmap.Compression compression, int jpegQualityOrZIPCompression, boolean embedTransparencyGrid, int boundingBoxWidth, int boundingBoxHeight) Saves the current pixmap as a new file at the given location using the specified parameters.
void	save(java.io.File file, ImagingPixmap.Format format, ImagingPixmap.ColorSpace colorspace, ImagingPixmap.Compression compression, int resolution, int jpegQualityOrZIPCompression, boolean embedTransparencyGrid, int boundingBoxWidth, int boundingBoxHeight) Saves the current pixmap as a new file at the given location using the specified parameters.
void	scale(int width, int height) Scales the pixmap to the specified width and height in pixels.
void	setICCSupport(boolean supportICCProfile) Specify whether the ImagingPixmap should support ICC profiles.
void	setPage(int page) Select a new page to render.

Methods inherited from class java.lang.Object

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

Method Detail

getPixmap

public static ImagingPixmap getPixmap(Item item)

Returns a new pixmap instance for the given record item that works on the preview of the related asset.

Parameters:

item - item specifying the asset to work on

Returns:

pixmap instance

getPixmap

public static ImagingPixmap getPixmap(Item item,
                      java.lang.String assetHandlingSet)

Returns a new pixmap instance for the given record item that works on the preview (generated by using the specified asset handling set) of the related asset.

Parameters:

item - item specifying the asset to work on

assetHandlingSet - asset handling set to use for generating the preview

Returns:

pixmap instance

Since:

8.1.4

getPixmap

public static ImagingPixmap getPixmap(Item item,
                      java.lang.String assetHandlingSet,
                      int version)

Returns a new pixmap instance for the given record item that works on the preview (generated by using the specified asset handling set) of the related asset. This method allows to specify a version of the asset to use.

Parameters:

item - item specifying the asset to work on

assetHandlingSet - asset handling set to use for generating the preview

version - the version of the asset to use. Specify 0 to use the latest version.

Returns:

pixmap instance

Since:

8.5.2

getPixmap

public static ImagingPixmap getPixmap(Item item,
                      java.lang.String assetHandlingSet,
                      int version,
                      int page)

Returns a new pixmap instance for the given record item that works on the preview (generated by using the specified asset handling set) of the related asset. This method allows to specify a version and page number of the asset to use.

Parameters:

item - item specifying the asset to work on

assetHandlingSet - asset handling set to use for generating the preview

version - the version of the asset to use. Specify 0 to use the latest version.

page - the page number of the asset to use starting at 1 for the first page. Specify 0 to use the default (first) page.

Returns:

pixmap instance

Since:

10.0

getPixmap

public static ImagingPixmap getPixmap(Item item,
                      Asset asset,
                      java.lang.String assetHandlingSet,
                      int page)

Returns a new pixmap instance for the given record item that works on the preview (generated by using the specified asset handling set) of the given asset. This method allows to specify a version and page number of the asset to use.

Parameters:

item - item specifying the asset to work on

asset - asset to work on

assetHandlingSet - asset handling set to use for generating the preview

page - the page number of the asset to use starting at 1 for the first page. Specify 0 to use the default (first) page.

Returns:

pixmap instance

Since:

11.0.1

close

public void close()

Free all associated resources of this instance. Do not call any other method after this one.

Specified by:

close in interface java.lang.AutoCloseable

Since:

8.5

getHeight

public int getHeight()

Returns the pixel height of the pixmap.

Returns:

pixel height of the pixmap

getWidth

public int getWidth()

Returns the pixel width of the pixmap.

Returns:

pixel width of the pixmap

getColorDepth

public int getColorDepth()

Returns the color depth of the pixmap in bits. Possible values are:

1. 1: Lineart
2. 8: Grayscale
3. 16: Grayscale with alpha channel
4. 24: RGB
5. 32: RGB with alpha channel

Returns:

color depth

getColorSpace

public ImagingPixmap.ColorSpace getColorSpace()

Returns the color space for the pixmap.

Returns:

color space constant

getNumberOfPages

public int getNumberOfPages()

Returns the number of pages for the underlying asset.

Returns:

the number of pages

Since:

10.0

getBufferedImage

public java.awt.image.BufferedImage getBufferedImage()

Returns the pixmap as Java buffered image.

Returns:

pixmap as Java buffered image

getBufferedImage

public java.awt.image.BufferedImage getBufferedImage(int width,
                                            int height)

Returns the pixmap as Java buffered image with the requested image dimension.

Parameters:

width - requested width for the returned image

height - requested height for the returned image

Returns:

pixmap as Java buffered image

Since:

9.0

crop

public void crop(int x,
        int y,
        int width,
        int height)

Crops the pixmap to the specified rectangle.

Parameters:

x - distance from the left border to the crop rectangle in pixels

y - distance from the top border to the crop rectangle in pixels

width - width of the crop rectangle in pixels

height - height of the crop rectangle in pixels

rotate

public void rotate(ImagingPixmap.RotateAngle rotateAngle)

Rotates the pixmap.

Parameters:

rotateAngle - the rotate parameter

flip

public void flip(ImagingPixmap.FlipDirection direction)

Flips the pixmap.

Parameters:

direction - the flip parameter

scale

public void scale(int width,
         int height)

Scales the pixmap to the specified width and height in pixels.

Parameters:

width - new pixmap width in pixels

height - new pixmap height in pixels

filter

public void filter(ImagingPixmap.Filter filterType,
          double radius,
          double strength)

filter

public void filter(ImagingPixmap.Filter filterType,
          double radius,
          double strength,
          java.awt.image.BufferedImage bufferedImage)

adjustBrightnessContrast

public void adjustBrightnessContrast(double brightness,
                            double contrast,
                            boolean preserveColors)

adjustBrightnessContrast

public void adjustBrightnessContrast(double brightness,
                            double contrast,
                            boolean preserveColors,
                            java.awt.image.BufferedImage bufferedImage)

adjustGamma

public void adjustGamma(double gamma,
               boolean preserveColors)

adjustGamma

public void adjustGamma(double gamma,
               boolean preserveColors,
               java.awt.image.BufferedImage bufferedImage)

adjustColors

public void adjustColors(double[] colors)

adjustColors

public void adjustColors(double[] colors,
                java.awt.image.BufferedImage bufferedImage)

save

public void save(java.io.File file,
        ImagingPixmap.Format format,
        ImagingPixmap.ColorSpace colorspace,
        ImagingPixmap.Compression compression,
        int jpegQualityOrZIPCompression,
        boolean embedTransparencyGrid,
        int boundingBoxWidth,
        int boundingBoxHeight)

Saves the current pixmap as a new file at the given location using the specified parameters.

Possible formats are BMP, CompuServe GIF, JPEG, PCX, PDF, PNG, Scitex CT and TIFF.

The possible colorspaces depend on the used format:

Format / Color Space	Grayscale	RGB	CMYK
BMP	Supported	Supported	-
CompuServe GIF	Supported	Supported	-
JPEG	Supported	Supported	Supported
PCX	Supported	Supported	-
PDF	Supported	Supported	Supported
PNG	Supported	Supported	-
Scitex CT	Supported	Supported	Supported
TIFF	Supported	Supported	Supported

The compression depends on the used format as well:

Format / Compression	None	Flate
BMP	Supported	-
CompuServe GIF	Supported	-
JPEG	Supported	-
PCX	Supported	-
PDF	Supported	-
PNG	Supported	-
Scitex CT	Supported	-
TIFF	Supported	Supported

The jpeg quality obviously is only being used when using the JPEG format and has to be between 1 (minimum quality) and 10 (maximum quality).

Parameters:

file - the file to save to

format - the wanted format

colorspace - wanted color space

compression - the wanted compression if supported by the format

jpegQualityOrZIPCompression - the jpeg quality if using the JPEG format between 1 and 10, for PNG this is the ZIP compression level (0..9).

embedTransparencyGrid - specify whether transparent images should get the users transparency grid embedded in transparent areas

boundingBoxWidth - optionally resize image on saving into a bounding box of the given width

boundingBoxHeight - optionally resize image on saving into a bounding box of the given height

Since:

9.0

save

public void save(java.io.File file,
        ImagingPixmap.Format format,
        ImagingPixmap.ColorSpace colorspace,
        ImagingPixmap.Compression compression,
        int jpegQualityOrZIPCompression,
        boolean embedTransparencyGrid,
        int boundingBox)

Saves the current pixmap as a new file at the given location using the specified parameters.

Possible formats are BMP, CompuServe GIF, JPEG, PCX, PDF, PNG, Scitex CT and TIFF.

The possible colorspaces depend on the used format:

Format / Color Space	Grayscale	RGB	CMYK
BMP	Supported	Supported	-
CompuServe GIF	Supported	Supported	-
JPEG	Supported	Supported	Supported
PCX	Supported	Supported	-
PDF	Supported	Supported	Supported
PNG	Supported	Supported	-
Scitex CT	Supported	Supported	Supported
TIFF	Supported	Supported	Supported

The compression depends on the used format as well:

Format / Compression	None	Flate
BMP	Supported	-
CompuServe GIF	Supported	-
JPEG	Supported	-
PCX	Supported	-
PDF	Supported	-
PNG	Supported	-
Scitex CT	Supported	-
TIFF	Supported	Supported

The jpeg quality obviously is only being used when using the JPEG format and has to be between 1 (minimum quality) and 10 (maximum quality).

Parameters:

file - the file to save to

format - the wanted format

colorspace - wanted color space

compression - the wanted compression if supported by the format

jpegQualityOrZIPCompression - the jpeg quality if using the JPEG format between 1 and 10, for PNG this is the ZIP compression level (0..9).

embedTransparencyGrid - specify whether transparent images should get the users transparency grid embedded in transparent areas

boundingBox - optionally resize image on saving

save

public void save(java.io.File file,
        ImagingPixmap.Format format,
        ImagingPixmap.ColorSpace colorspace,
        ImagingPixmap.Compression compression,
        int resolution,
        int jpegQualityOrZIPCompression,
        boolean embedTransparencyGrid,
        int boundingBoxWidth,
        int boundingBoxHeight)

Saves the current pixmap as a new file at the given location using the specified parameters.

Possible formats are BMP, CompuServe GIF, JPEG, PCX, PDF, PNG, Scitex CT and TIFF.

The possible colorspaces depend on the used format:

Format / Color Space	Grayscale	RGB	CMYK
BMP	Supported	Supported	-
CompuServe GIF	Supported	Supported	-
JPEG	Supported	Supported	Supported
PCX	Supported	Supported	-
PDF	Supported	Supported	Supported
PNG	Supported	Supported	-
Scitex CT	Supported	Supported	Supported
TIFF	Supported	Supported	Supported

The compression depends on the used format as well:

Format / Compression	None	Flate
BMP	Supported	-
CompuServe GIF	Supported	-
JPEG	Supported	-
PCX	Supported	-
PDF	Supported	-
PNG	Supported	-
Scitex CT	Supported	-
TIFF	Supported	Supported

The jpeg quality obviously is only being used when using the JPEG format and has to be between 1 (minimum quality) and 10 (maximum quality).

Parameters:

file - the file to save to

format - the wanted format

colorspace - wanted color space

compression - the wanted compression if supported by the format

resolution - wanted resolution

jpegQualityOrZIPCompression - the jpeg quality if using the JPEG format between 1 and 10, for PNG this is the ZIP compression level (0..9).

embedTransparencyGrid - specify whether transparent images should get the users transparency grid embedded in transparent areas

boundingBoxWidth - optionally resize image on saving into a bounding box of the given width

boundingBoxHeight - optionally resize image on saving into a bounding box of the given height

Since:

9.0

getColorSpaceName

public static java.lang.String getColorSpaceName(ImagingPixmap.ColorSpace colorSpace)

Returns a label for the given color space.

Parameters:

colorSpace - color space to get the label for

Returns:

ColorSpace label

setPage

public void setPage(int page)

Select a new page to render. This resets all other operations like cropping, scaling to the default values.

Parameters:

page - the page number of the asset to use starting at 1 for the first page. Specify 0 to use the default (first) page.

Since:

10.0

setICCSupport

public void setICCSupport(boolean supportICCProfile)

Specify whether the ImagingPixmap should support ICC profiles. You can switch this off to ensure best performance.

Parameters:

supportICCProfile - support ICC profiles

Since:

10.0