com.communote.common.image

Class ImageScaler

java.lang.Object

com.communote.common.image.ImageScaler

public class ImageScaler
extends Object

Scales an image to a predefined size. By default the aspect ratio will be preserved. If isDrawBackground() is activated the resulting image will have the defined size. Any non image data will be filled with the color defined by setBackgroundColor(Color), isSameAspectRatio() must return true in that case. In case the image is smaller than the target size it won't be upscaled but the remaining data will be filled with the background color if isDrawBackground() returns true.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
ImageScaler(ImageSize size, ImageFormatType imageFormatType) Construct a new scaler
ImageScaler(int height, int width, ImageFormatType imageFormatType) Construct a new scaler

Method Summary

Modifier and Type	Method and Description
ImageFormatType	getFormatType()
int	getHeight()
int	getWidth()
boolean	isDrawBackground()
boolean	isSameAspectRatio()
byte[]	resizeImage(byte[] data) Resizes a byte array of an image and returns the transformed byte array image.
void	setBackgroundColor(Color backgroundColor)
void	setDimension(ImageSize size)
void	setDrawBackground(boolean drawBackground)
void	setFormatType(ImageFormatType formatType)
void	setHeight(int height)
void	setHorizontalAlignment(int alignment) Set the alignment to use for positioning the image horizontally within the scaled image.
void	setSameAspectRatio(boolean sameAspectRatio)
void	setVerticalAlignment(int alignment) Set the alignment to use for positioning the image vertically within the scaled image.
void	setWidth(int width)

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageScaler

public ImageScaler(ImageSize size,
                   ImageFormatType imageFormatType)

Construct a new scaler

Parameters:

size - the maximum size of the resulting image

imageFormatType - the image format type

ImageScaler

public ImageScaler(int height,
                   int width,
                   ImageFormatType imageFormatType)

Construct a new scaler

Parameters:

height - maximal height of the resulting image

width - maximal width of the resulting image

imageFormatType - the image format of the scaled image

Method Detail

getFormatType

public ImageFormatType getFormatType()

Returns:

the image format type

getHeight

public int getHeight()

Returns:

the maximum height

getWidth

public int getWidth()

Returns:

the maximum width

isDrawBackground

public boolean isDrawBackground()

Returns:

true to draw a background

isSameAspectRatio

public boolean isSameAspectRatio()

Returns:

if the aspect ratio will be preserved

resizeImage

public byte[] resizeImage(byte[] data)

Resizes a byte array of an image and returns the transformed byte array image. If sameAspectRatio is true the resulting image is scaled proportionally to the specified width or height. Images smaller than the defined dimensions will not be changed.

Parameters:

data - Binary image data

Returns:

returns the scaled byte array or null if the image data couldn't be parsed

setBackgroundColor

public void setBackgroundColor(Color backgroundColor)

Parameters:

backgroundColor - the background color to use when isDrawBackground() is true

setDimension

public void setDimension(ImageSize size)

Parameters:

size - the maximum size of the resulting image

setDrawBackground

public void setDrawBackground(boolean drawBackground)

Parameters:

drawBackground - true to draw a background to reach the exact size as defined (only used if setSameAspectRatio(boolean) is true)

setFormatType

public void setFormatType(ImageFormatType formatType)

Parameters:

formatType - the ImageFormatType to use

setHeight

public void setHeight(int height)

Parameters:

height - the maximum height of the image

setHorizontalAlignment

public void setHorizontalAlignment(int alignment)

Set the alignment to use for positioning the image horizontally within the scaled image. A value of less than 0 means to place the image at the left edge, a value of 0 leads to centering the image and a value greater than 0 means to place the image at the right edge. This setting only has an effect if a background should be drawn.

Parameters:

alignment - a value describing the horizontal alignment of the image

setSameAspectRatio

public void setSameAspectRatio(boolean sameAspectRatio)

Parameters:

sameAspectRatio - Set to true to preserve the aspect ratio.

setVerticalAlignment

public void setVerticalAlignment(int alignment)

Set the alignment to use for positioning the image vertically within the scaled image. A value of less than 0 means to place the image at the top edge, a value of 0 leads to centering the image and a value greater than 0 means to place the image at the bottom edge. This setting only has an effect if a background should be drawn.

Parameters:

alignment - a value describing the vertical alignment of the image

setWidth

public void setWidth(int width)

Parameters:

width - the maximum width for the resulting image