de.innovationgate.utils.imgscalr

Class ImgScalrScaler

java.lang.Object

de.innovationgate.utils.imgscalr.ImgScalrScaler

All Implemented Interfaces:

ImageScaler, MimeTypeSpecificImageScaler

public class ImgScalrScaler
extends java.lang.Object
implements ImageScaler, MimeTypeSpecificImageScaler

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.List<java.lang.String>	SUPPORTED_MIMETYPES
static java.lang.String	SYSPROPERTY_METHOD

Constructor Summary

Constructors

Constructor and Description
ImgScalrScaler()

Method Summary

Methods

Modifier and Type	Method and Description
void	crop(int x, int y, int width, int height) This method crops out the selected area from an image The parameters x and y defines the start coordinate.
long	determineRenderedSize() Determines the bytes size of the image if it would be written to an output stream.
float	getAspectRatio() Returns the aspect ratio (width/height) of the image
java.lang.String	getFormat() Returns the output format.
java.lang.String	getFormatSuffix() Returns the normale file suffix for the current output format, including leading "."
int	getHeight() Returns the current image height
java.lang.Object	getImageEncodeParam() Returns the image encoding params.
float	getQuality() Returns the quality of the output format.
java.lang.String	getSourceFileName() Returns the name of the sourcefile
int	getWidth() Returns the current image width
void	growToSize(int width, int height) Scales the images up to fit given minimum sizes.
boolean	isTransparencySupportedForOutput() Returns if transparency is supported by the current output format
void	load(java.io.InputStream is) Loads image data.
void	load(java.io.InputStream is, java.lang.String mimeType) Loads image data.
void	scaleByFactor(int hfactor, int vfactor) Scales the image based on the given scaling factors.
void	scaleToSize(int width, int height) Scales the image to a determined target size This method uses the parameter width and height as target sizes for the scaled image.
void	scaleToSize(int width, int height, boolean keepRatio) Scales the image to the determined target size if keepRation==true image orientation is determined (landscape or portrait) on landscape the image is scaled with the same ratio to the given width on portrait the image is scaled with the same ratio to the given height
void	setFormat(java.lang.String format) Sets the output format
void	setImageEncodeParam(java.lang.Object imageEncodeParam) Sets the image encoding params
void	setQuality(float q) Sets the quality of the output format.
void	setSourceFileName(java.lang.String name) Sets the name of the sourcefile
void	shrinkToSize(int width, int height) Scales the images down to fit into given maximum sizes.
void	useJPEGForOutput() Sets the scaler to use JPEG images for output with 90% quality.
void	usePNGForOutput() Sets the scaler to use PNG images (with color palette) for output,
void	writeImage(java.io.File outFile) Writes the rendered and scaled image to a file.
void	writeImage(java.io.OutputStream out) Writes the rendered and scaled image to an outputstream

Methods inherited from class java.lang.Object

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

Field Detail

SYSPROPERTY_METHOD

public static final java.lang.String SYSPROPERTY_METHOD

See Also:

Constant Field Values

SUPPORTED_MIMETYPES

public static final java.util.List<java.lang.String> SUPPORTED_MIMETYPES

Constructor Detail

ImgScalrScaler

public ImgScalrScaler()

Method Detail

load

public void load(java.io.InputStream is)
          throws java.io.IOException

Description copied from interface: ImageScaler

Loads image data.

Specified by:

load in interface ImageScaler

Parameters:

is - image data input stream.

Throws:

java.io.IOException

useJPEGForOutput

public void useJPEGForOutput()

Description copied from interface: ImageScaler

Sets the scaler to use JPEG images for output with 90% quality.

Specified by:

useJPEGForOutput in interface ImageScaler

usePNGForOutput

public void usePNGForOutput()

Description copied from interface: ImageScaler

Sets the scaler to use PNG images (with color palette) for output,

Specified by:

usePNGForOutput in interface ImageScaler

scaleToSize

public void scaleToSize(int width,
               int height)

Description copied from interface: ImageScaler

Scales the image to a determined target size This method uses the parameter width and height as target sizes for the scaled image. Images may get larger if target sizes exceed the source sizes. If either width or height is specified as -1, it is automatically calculated to keep the ratio of the picture. If both sizes are -1 the image will keep its size.

Specified by:

scaleToSize in interface ImageScaler

Parameters:

width - The target width. Use -1 to automatically calculate target width for keeping the image ratio

height - The target height. Use -1 to automatically calculate target height for keeping the image ratio

scaleToSize

public void scaleToSize(int width,
               int height,
               boolean keepRatio)

Description copied from interface: ImageScaler

Scales the image to the determined target size if keepRation==true image orientation is determined (landscape or portrait) on landscape the image is scaled with the same ratio to the given width on portrait the image is scaled with the same ratio to the given height

Specified by:

scaleToSize in interface ImageScaler

Specified by:

scaleToSize in interface MimeTypeSpecificImageScaler

Parameters:

width - The target width

height - The target height

keepRatio - true/ false

getAspectRatio

public float getAspectRatio()

Returns the aspect ratio (width/height) of the image

scaleByFactor

public void scaleByFactor(int hfactor,
                 int vfactor)

Description copied from interface: ImageScaler

Scales the image based on the given scaling factors. A scaling factor of 1 keeps the size. Scaling factors larger than 1 make the image larger, factors smaller than 1 make it smaller. The amount of scaling is represented by the comparison between the factor and 1. A factor of 2 will double the image size. A factor of 0.5 will make it half size.

Specified by:

scaleByFactor in interface ImageScaler

Specified by:

scaleByFactor in interface MimeTypeSpecificImageScaler

Parameters:

hfactor - The horizontal scaling factor

vfactor - The vertical scaling factor

shrinkToSize

public void shrinkToSize(int width,
                int height)

Description copied from interface: ImageScaler

Scales the images down to fit into given maximum sizes. This method uses the parameters width and height as "maximum sizes" for the picture. It will determine if any dimension of the source image exceeds the given maximum size and scale it down if so. The ratio of the picture is always preserved as the smaller of the neccessary scale factors (for width and height) is used for both dimensions. If the image does not exceed any of the given maximum sizes, it will not be scaled.

Specified by:

shrinkToSize in interface ImageScaler

Specified by:

shrinkToSize in interface MimeTypeSpecificImageScaler

Parameters:

width - The maximum width

height - The maximum height

growToSize

public void growToSize(int width,
              int height)

Description copied from interface: ImageScaler

Scales the images up to fit given minimum sizes. This method uses the parameters width and height as "minimum sizes" for the picture. It will determine if any dimension of the source image is lower than the given minimum size and scale it up if so. The ratio of the picture is always preserved as the larger of the neccessary scale factors (for width and height) is used for both dimensions. If the image is already as large or larget than the given minimum sizes, it will not be scaled.

Specified by:

growToSize in interface ImageScaler

Specified by:

growToSize in interface MimeTypeSpecificImageScaler

Parameters:

width - The maximum width

height - The maximum height

writeImage

public void writeImage(java.io.OutputStream out)

Description copied from interface: ImageScaler

Writes the rendered and scaled image to an outputstream

Specified by:

writeImage in interface ImageScaler

Specified by:

writeImage in interface MimeTypeSpecificImageScaler

writeImage

public void writeImage(java.io.File outFile)
                throws java.io.IOException

Description copied from interface: ImageScaler

Writes the rendered and scaled image to a file.

Specified by:

writeImage in interface ImageScaler

Throws:

java.io.IOException - if the file cannot be written

getFormat

public java.lang.String getFormat()

Description copied from interface: ImageScaler

Returns the output format.

Specified by:

getFormat in interface ImageScaler

setFormat

public void setFormat(java.lang.String format)

Description copied from interface: ImageScaler

Sets the output format

Specified by:

setFormat in interface ImageScaler

Parameters:

format - The format to set.

getImageEncodeParam

public java.lang.Object getImageEncodeParam()

Description copied from interface: ImageScaler

Returns the image encoding params.

Specified by:

getImageEncodeParam in interface ImageScaler

Specified by:

getImageEncodeParam in interface MimeTypeSpecificImageScaler

setImageEncodeParam

public void setImageEncodeParam(java.lang.Object imageEncodeParam)

Description copied from interface: ImageScaler

Sets the image encoding params

Specified by:

setImageEncodeParam in interface ImageScaler

Specified by:

setImageEncodeParam in interface MimeTypeSpecificImageScaler

Parameters:

imageEncodeParam - The imageEncodeParam to set.

getQuality

public float getQuality()

Description copied from interface: ImageScaler

Returns the quality of the output format. This is a value between 0 and 1 for JPEG encoding (since this is a lossy format) and 1 for all other formats who are lossless.

Specified by:

getQuality in interface ImageScaler

setQuality

public void setQuality(float q)

Description copied from interface: ImageScaler

Sets the quality of the output format. This only applies to JPEG output and can be set to a value between something above 0 and 1, where higher means better quality.

Specified by:

setQuality in interface ImageScaler

getWidth

public int getWidth()

Description copied from interface: ImageScaler

Returns the current image width

Specified by:

getWidth in interface ImageScaler

Specified by:

getWidth in interface MimeTypeSpecificImageScaler

getHeight

public int getHeight()

Description copied from interface: ImageScaler

Returns the current image height

Specified by:

getHeight in interface ImageScaler

Specified by:

getHeight in interface MimeTypeSpecificImageScaler

determineRenderedSize

public long determineRenderedSize()

Description copied from interface: ImageScaler

Determines the bytes size of the image if it would be written to an output stream.

Specified by:

determineRenderedSize in interface ImageScaler

Specified by:

determineRenderedSize in interface MimeTypeSpecificImageScaler

isTransparencySupportedForOutput

public boolean isTransparencySupportedForOutput()

Description copied from interface: ImageScaler

Returns if transparency is supported by the current output format

Specified by:

isTransparencySupportedForOutput in interface ImageScaler

Specified by:

isTransparencySupportedForOutput in interface MimeTypeSpecificImageScaler

getFormatSuffix

public java.lang.String getFormatSuffix()

Description copied from interface: ImageScaler

Returns the normale file suffix for the current output format, including leading "."

Specified by:

getFormatSuffix in interface ImageScaler

getSourceFileName

public java.lang.String getSourceFileName()

Description copied from interface: ImageScaler

Returns the name of the sourcefile

Specified by:

getSourceFileName in interface ImageScaler

setSourceFileName

public void setSourceFileName(java.lang.String name)

Description copied from interface: ImageScaler

Sets the name of the sourcefile

Specified by:

setSourceFileName in interface ImageScaler

load

public void load(java.io.InputStream is,
        java.lang.String mimeType)
          throws java.lang.IllegalArgumentException,
                 java.io.IOException

Description copied from interface: MimeTypeSpecificImageScaler

Loads image data.

Specified by:

load in interface MimeTypeSpecificImageScaler

Parameters:

is - image data input stream.

mimeType - of the loaded image

Throws:

java.lang.IllegalArgumentException - if the mimetype is not supported

java.io.IOException - if something goes wrong on loading

crop

public void crop(int x,
        int y,
        int width,
        int height)
          throws java.lang.UnsupportedOperationException,
                 java.io.IOException

Description copied from interface: MimeTypeSpecificImageScaler

This method crops out the selected area from an image The parameters x and y defines the start coordinate. The parameters width and height defines the dimension to crop.

Specified by:

crop in interface MimeTypeSpecificImageScaler

Throws:

java.lang.UnsupportedOperationException - If this scaler does not support cropping

java.io.IOException