org.jahia.services.image

Class AbstractImageService

java.lang.Object

org.jahia.services.image.AbstractImageService

All Implemented Interfaces:

JahiaImageService

Direct Known Subclasses:

AbstractJava2DImageService, ImageJImageService, ImageMagickImageService

public abstract class AbstractImageService
extends Object
implements JahiaImageService

Abstract class to share some methods between service implementations

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractImageService.ResizeCoords

Nested classes/interfaces inherited from interface org.jahia.services.image.JahiaImageService

JahiaImageService.ResizeType

Constructor Summary

Constructors

Constructor and Description
AbstractImageService()

Method Summary

Modifier and Type	Method and Description
boolean	createThumb(Image iw, File outputFile, int size, boolean square) Creates an image thumbnail and stores it in a specified file
AbstractImageService.ResizeCoords	getResizeCoords(JahiaImageService.ResizeType resizeType, int sourceWidth, int sourceHeight, int targetWidth, int targetHeight)
boolean	resizeImage(Image i, File outputFile, int width, int height) Resize an image using an ADJUST_SIZE resize type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jahia.services.image.JahiaImageService

cropImage, getHeight, getImage, getWidth, resizeImage, resizeImage, rotateImage, rotateImage

Constructor Detail

AbstractImageService

public AbstractImageService()

Method Detail

getResizeCoords

public AbstractImageService.ResizeCoords getResizeCoords(JahiaImageService.ResizeType resizeType,
                                                         int sourceWidth,
                                                         int sourceHeight,
                                                         int targetWidth,
                                                         int targetHeight)

createThumb

public boolean createThumb(Image iw,
                           File outputFile,
                           int size,
                           boolean square)
                    throws IOException

Description copied from interface: JahiaImageService

Creates an image thumbnail and stores it in a specified file

Specified by:

createThumb in interface JahiaImageService

Parameters:

iw - the image for which to generate a thumbnail, this image is loaded through the getImage method

outputFile - the file in which to store the generated thumbnail

size - the size in pixels of the generated thumbnail. Usually this will mean the desired width or height of the image, except if the square option is specified.

square - if false, a ResizeType.ADJUST_SIZE resize will be performed, otherwise if square is true, a ResizeType.ASPECT_FILL will be performed. For more information about these resize types, see the resize method.

Returns:

true if the operation succeeded, false otherwise

Throws:

IOException

resizeImage

public boolean resizeImage(Image i,
                           File outputFile,
                           int width,
                           int height)
                    throws IOException

Description copied from interface: JahiaImageService

Resize an image using an ADJUST_SIZE resize type. See the other resizeImage method for more details on the resize types

Specified by:

resizeImage in interface JahiaImageService

Parameters:

i - the image to resize

outputFile - the output file where to output the resized image

width - the desired image width

height - the desired image height

Returns:

true if the resize succeeded, false otherwise

Throws:

IOException