com.communote.server.api.core.image

Class ImageDescriptor

java.lang.Object

com.communote.server.api.core.image.ImageDescriptor

public class ImageDescriptor
extends Object

Describes the image.

Author:

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

Constructor Summary

Constructors

Constructor and Description
ImageDescriptor(ImageSize size, String identifier) Constructor, where scaled and drawBackground are not set (false).
ImageDescriptor(ImageSize size, String identifier, boolean scaled, boolean drawBackground)
ImageDescriptor(ImageSize size, String identifier, boolean scaled, boolean drawBackground, Color backgroundColor)
ImageDescriptor(ImageSize size, String identifier, boolean scaled, boolean drawBackground, Color backgroundColor, boolean preserveAspectRation)
ImageDescriptor(ImageSize size, String identifier, boolean scaled, boolean drawBackground, Color backgroundColor, boolean preserveAspectRation, List<ImageFormatType> validMimeTypes)
ImageDescriptor(int width, int height, String identifier)
ImageDescriptor(int width, int height, String identifier, boolean scaled, boolean drawBackground, Color backgroundColor)

Method Summary

Modifier and Type	Method and Description
Color	getBackgroundColor()
int	getHorizontalAlignment()
String	getIdentifier()
ImageSize	getSize()
List<ImageFormatType>	getValidMimeTypes()
int	getVerticalAlignment()
boolean	isDrawBackground()
boolean	isPreserveAspectRation()
boolean	isScaled()
void	setHorizontalAlignment(int alignment) Set the alignment to use for positioning the image horizontally within the scaled image.
void	setVerticalAlignment(int alignment) Set the alignment to use for positioning the image vertically within the scaled image.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageDescriptor

public ImageDescriptor(ImageSize size,
                       String identifier)

Constructor, where scaled and drawBackground are not set (false).

Parameters:

size - The size as ImageSize.

identifier - The unique identifier of the image.

ImageDescriptor

public ImageDescriptor(ImageSize size,
                       String identifier,
                       boolean scaled,
                       boolean drawBackground)

Parameters:

size - The size as ImageSize.

identifier - The unique identifier of the image.

scaled - If true, the image is scaled.

drawBackground - If true, the image will be extended to size and a background will be drawn.

ImageDescriptor

public ImageDescriptor(ImageSize size,
                       String identifier,
                       boolean scaled,
                       boolean drawBackground,
                       Color backgroundColor)

Parameters:

size - The size as ImageSize.

identifier - The unique identifier of the image.

scaled - If true, the image is scaled.

drawBackground - If true, the image will be extended to size and a background will be drawn.

backgroundColor - The background color.

ImageDescriptor

public ImageDescriptor(ImageSize size,
                       String identifier,
                       boolean scaled,
                       boolean drawBackground,
                       Color backgroundColor,
                       boolean preserveAspectRation)

Parameters:

size - The size as ImageSize.

identifier - The unique identifier of the image.

scaled - If true, the image is scaled.

drawBackground - If true, the image will be extended to size and a background will be drawn.

backgroundColor - The background color.

preserveAspectRation - If true, the aspect ration of the final image will be respected.

ImageDescriptor

public ImageDescriptor(ImageSize size,
                       String identifier,
                       boolean scaled,
                       boolean drawBackground,
                       Color backgroundColor,
                       boolean preserveAspectRation,
                       List<ImageFormatType> validMimeTypes)

Parameters:

size - The size as ImageSize.

identifier - The unique identifier of the image.

scaled - If true, the image is scaled.

drawBackground - If true, the image will be extended to size and a background will be drawn.

backgroundColor - The background color.

preserveAspectRation - If true, the aspect ration of the final image will be respected.

validMimeTypes - The mime types the image can have. If the image doesn't match any of the, the first will be used.

ImageDescriptor

public ImageDescriptor(int width,
                       int height,
                       String identifier)

Parameters:

width - The width.

height - The height.

identifier - The unique identifier of the image.

ImageDescriptor

public ImageDescriptor(int width,
                       int height,
                       String identifier,
                       boolean scaled,
                       boolean drawBackground,
                       Color backgroundColor)

Parameters:

width - The width.

height - The height.

identifier - The unique identifier of the image.

scaled - If true, the image is scaled.

drawBackground - If true, the image will be extended to size and a background will be drawn.

backgroundColor - The background color.

Method Detail

getBackgroundColor

public Color getBackgroundColor()

Returns:

the backgroundColor

getHorizontalAlignment

public int getHorizontalAlignment()

Returns:

a value describing the horizontal alignment of the image

See Also:

setHorizontalAlignment(int)

getIdentifier

public String getIdentifier()

Returns:

the identifier

getSize

public ImageSize getSize()

Returns:

the size

getValidMimeTypes

public List<ImageFormatType> getValidMimeTypes()

Returns:

Set of valid mime types.

getVerticalAlignment

public int getVerticalAlignment()

Returns:

a value describing the vertical alignment of the image

See Also:

setVerticalAlignment(int)

isDrawBackground

public boolean isDrawBackground()

Returns:

the drawBackground

isPreserveAspectRation

public boolean isPreserveAspectRation()

Returns:

the preserveAspectRation

isScaled

public boolean isScaled()

Returns:

true if the image is scaled, else not.

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

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