de.innovationgate.utils

Interface ImageScaler

All Known Implementing Classes:

ImgScalrScaler

public interface ImageScaler

Interface for classes in WGA that provide format neutral image scaling functions.

Method Summary

Methods

Modifier and Type	Method and Description
long	determineRenderedSize() Determines the bytes size of the image if it would be written to an output stream.
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	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

Method Detail

load

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

Loads image data.

Parameters:

is - image data input stream.

Throws:

java.io.IOException

useJPEGForOutput

void useJPEGForOutput()

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

usePNGForOutput

void usePNGForOutput()

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

scaleToSize

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

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

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

Parameters:

width - The target width

height - The target height

keepRatio - true/ false

scaleByFactor

void scaleByFactor(int hfactor,
                 int vfactor)

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.

Parameters:

hfactor - The horizontal scaling factor

vfactor - The vertical scaling factor

shrinkToSize

void shrinkToSize(int width,
                int height)

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.

Parameters:

width - The maximum width

height - The maximum height

growToSize

void growToSize(int width,
              int height)

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.

Parameters:

width - The maximum width

height - The maximum height

writeImage

void writeImage(java.io.OutputStream out)

Writes the rendered and scaled image to an outputstream

Parameters:

out -

writeImage

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

Writes the rendered and scaled image to a file.

Parameters:

outFile -

Throws:

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

getFormat

java.lang.String getFormat()

Returns the output format.

setFormat

void setFormat(java.lang.String format)

Sets the output format

Parameters:

format - The format to set.

getImageEncodeParam

java.lang.Object getImageEncodeParam()

Returns the image encoding params.

setImageEncodeParam

void setImageEncodeParam(java.lang.Object imageEncodeParam)

Sets the image encoding params

Parameters:

imageEncodeParam - The imageEncodeParam to set.

getQuality

float getQuality()

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.

setQuality

void setQuality(float q)

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.

Parameters:

q -

getWidth

int getWidth()

Returns the current image width

getHeight

int getHeight()

Returns the current image height

determineRenderedSize

long determineRenderedSize()

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

isTransparencySupportedForOutput

boolean isTransparencySupportedForOutput()

Returns if transparency is supported by the current output format

getFormatSuffix

java.lang.String getFormatSuffix()

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

getSourceFileName

java.lang.String getSourceFileName()

Returns the name of the sourcefile

setSourceFileName

void setSourceFileName(java.lang.String name)

Sets the name of the sourcefile