er.attachment.thumbnail
Interface IERImageProcessor

All Known Implementing Classes:

ERImageProcessor, ImageIOImageProcessor, ImageMagickImageProcessor, Java2DImageProcessor, SipsImageProcessor

public interface IERImageProcessor

Provides an interface for processing an image, performing various operations on it (most commonly, thumbnailing).

Author:

mschrag

Nested Class Summary

static class

IERImageProcessor.Quality Quality is an enumerated type used to specify the resize quality.

Method Summary

void	processImage(int resizeWidth, int resizeHeight, IERImageProcessor.Quality resizeQuality, int dpi, float sharpenRadius, float sharpenIntensity, float gamma, int cropX, int cropY, int cropWidth, int cropHeight, java.io.File watermarkFile, boolean tileWatermark, float compressionQuality, java.io.File colorProfileFile, java.io.File inputFile, java.io.File outputFile, ERMimeType outputMimeType) Processes the given image with all of the given configuration settings.
void	thumbnail(int resizeWidth, int resizeHeight, java.io.File inputFile, java.io.File outputFile) Provides a shortcut to thumbnailing an image using some default values that produce decent quality thumbnail outputs.
void	thumbnail(int resizeWidth, int resizeHeight, java.io.File inputFile, java.io.File outputFile, ERMimeType outputMimeType) Provides a shortcut to thumbnailing an image using some default values that produce decent quality thumbnail outputs.

Method Detail

processImage

void processImage(int resizeWidth,
                  int resizeHeight,
                  IERImageProcessor.Quality resizeQuality,
                  int dpi,
                  float sharpenRadius,
                  float sharpenIntensity,
                  float gamma,
                  int cropX,
                  int cropY,
                  int cropWidth,
                  int cropHeight,
                  java.io.File watermarkFile,
                  boolean tileWatermark,
                  float compressionQuality,
                  java.io.File colorProfileFile,
                  java.io.File inputFile,
                  java.io.File outputFile,
                  ERMimeType outputMimeType)
                  throws java.io.IOException

Processes the given image with all of the given configuration settings. Order: resize/dpi, colorspace, crop, sharpen, gamma, watermark

Parameters:

resizeWidth - the maximum width to resize to (or -1 to not specify)

resizeHeight - the maximum height to resize to (or -1 to not specify)

resizeQuality - influences the resize algorithm to use (or null to not specify)

dpi - the dpi to resize to (or -1 to skip)

sharpenRadius - the radius of the unsharp mask (or <= 0.0 to skip)

sharpenIntensity - the intensity of the unsharp mask (or <= 0.0 to skip)

gamma - the gamma to apply (or 0.0 to skip)

cropX - the x position of the crop (or <= 0 to skip)

cropY - the y position of the crop (or <= 0 to skip)

cropWidth - the width of the crop (or <= 0 to skip)

cropHeight - the height of the crop (or <= 0 to skip)

watermarkFile - the watermark File to apply to this image (or null to skip)

tileWatermark - whether or not to tile the watermark

compressionQuality - the compression quality of the resize to perform (0.0 to ignore) -- range is 0.0 to 1.0 (1.0 = best)

colorProfileFile - the ICC profile to use (or null to skip)

inputFile - the File to perform the given operations on

outputFile - the File to write the resulting output image to

outputMimeType - the desired mime type of the output file

Throws:

java.io.IOException - if the image processing fails

thumbnail

void thumbnail(int resizeWidth,
               int resizeHeight,
               java.io.File inputFile,
               java.io.File outputFile)
               throws java.io.IOException

Provides a shortcut to thumbnailing an image using some default values that produce decent quality thumbnail outputs.

Parameters:

resizeWidth - the maximum resize width

resizeHeight - the maximum resize height

inputFile - the input file to thumbnail

outputFile - the output file to write the thumbnail into

Throws:

java.io.IOException - if the thumbnailing fails

thumbnail

void thumbnail(int resizeWidth,
               int resizeHeight,
               java.io.File inputFile,
               java.io.File outputFile,
               ERMimeType outputMimeType)
               throws java.io.IOException

Provides a shortcut to thumbnailing an image using some default values that produce decent quality thumbnail outputs.

Parameters:

resizeWidth - the maximum resize width

resizeHeight - the maximum resize height

inputFile - the input file to thumbnail

outputFile - the output file to write the thumbnail into

outputMimeType - the output mime type

Throws:

java.io.IOException - if the thumbnailing fails