de.innovationgate.utils

Interface MimeTypeSpecificImageScaler

All Known Implementing Classes:

ImgScalrScaler

public interface MimeTypeSpecificImageScaler

An image scaler for a specific mime type. Produces the same output mimetype as for input.

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.
int	getHeight() Returns the current image height
java.lang.Object	getImageEncodeParam() Returns the image encoding params.
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 used mime type
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, 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	setImageEncodeParam(java.lang.Object imageEncodeParam) Sets the image encoding params
void	shrinkToSize(int width, int height) Scales the images down to fit into given maximum sizes.
void	writeImage(java.io.OutputStream out) Writes the rendered and scaled image to an outputstream

Method Detail

load

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

Loads image data.

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

scaleToSize

void scaleToSize(int width,
               int height,
               boolean keepRatio)
                 throws java.lang.UnsupportedOperationException,
                        java.io.IOException

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

Throws:

java.lang.UnsupportedOperationException

java.io.IOException

scaleByFactor

void scaleByFactor(int hfactor,
                 int vfactor)
                   throws java.lang.UnsupportedOperationException,
                          java.io.IOException

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

Throws:

java.lang.UnsupportedOperationException

java.io.IOException

shrinkToSize

void shrinkToSize(int width,
                int height)
                  throws java.lang.UnsupportedOperationException,
                         java.io.IOException

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

Throws:

java.lang.UnsupportedOperationException

java.io.IOException

growToSize

void growToSize(int width,
              int height)
                throws java.lang.UnsupportedOperationException,
                       java.io.IOException

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

Throws:

java.lang.UnsupportedOperationException

java.io.IOException

writeImage

void writeImage(java.io.OutputStream out)
                throws java.io.IOException

Writes the rendered and scaled image to an outputstream

Parameters:

out -

Throws:

java.io.IOException

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.

getWidth

int getWidth()

Returns the current image width

getHeight

int getHeight()

Returns the current image height

determineRenderedSize

long determineRenderedSize()
                           throws java.lang.UnsupportedOperationException,
                                  java.io.IOException

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

Throws:

java.lang.UnsupportedOperationException

java.io.IOException

isTransparencySupportedForOutput

boolean isTransparencySupportedForOutput()

Returns if transparency is supported by the used mime type

crop

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

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.

Parameters:

x -

y -

width -

height -

Throws:

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

java.io.IOException