com.liferay.portal.kernel.image

Interface ImageTool

@ProviderType
public interface ImageTool

Author:

Brian Wing Shun Chan, Alexander Chow

Field Summary

Fields

Modifier and Type	Field and Description
static String	ORIENTATION_VALUE_HORIZONTAL_NORMAL
static String	ORIENTATION_VALUE_MIRROR_HORIZONTAL
static String	ORIENTATION_VALUE_MIRROR_HORIZONTAL_ROTATE_270_CW
static String	ORIENTATION_VALUE_MIRROR_HORIZONTAL_ROTATE_90_CW
static String	ORIENTATION_VALUE_MIRROR_VERTICAL
static String	ORIENTATION_VALUE_ROTATE_180
static String	ORIENTATION_VALUE_ROTATE_270_CW
static String	ORIENTATION_VALUE_ROTATE_90_CW
static String	TYPE_BMP
static String	TYPE_GIF
static String	TYPE_JPEG
static String	TYPE_NOT_AVAILABLE
static String	TYPE_PNG
static String	TYPE_TIFF

Method Summary

Modifier and Type	Method and Description
Future<RenderedImage>	convertCMYKtoRGB(byte[] bytes, String type)
BufferedImage	convertImageType(BufferedImage sourceImage, int type)
RenderedImage	crop(RenderedImage renderedImage, int height, int width, int x, int y)
void	encodeGIF(RenderedImage renderedImage, OutputStream os)
void	encodeWBMP(RenderedImage renderedImage, OutputStream os)
RenderedImage	flipHorizontal(RenderedImage renderedImage)
RenderedImage	flipVertical(RenderedImage renderedImage)
BufferedImage	getBufferedImage(RenderedImage renderedImage)
byte[]	getBytes(RenderedImage renderedImage, String contentType)
Image	getDefaultCompanyLogo()
Image	getDefaultOrganizationLogo()
Image	getDefaultSpacer()
Image	getDefaultUserFemalePortrait()
Image	getDefaultUserMalePortrait()
Image	getImage(byte[] bytes)
Image	getImage(File file)
Image	getImage(InputStream is)
Image	getImage(InputStream is, boolean cleanUpStream)
boolean	isNullOrDefaultSpacer(byte[] bytes)
ImageBag	read(byte[] bytes)
ImageBag	read(File file)
ImageBag	read(InputStream inputStream)
RenderedImage	rotate(RenderedImage renderedImage, int degrees)
RenderedImage	scale(RenderedImage renderedImage, int width)
RenderedImage	scale(RenderedImage renderedImage, int maxHeight, int maxWidth)
void	write(RenderedImage renderedImage, String contentType, OutputStream os)

Field Detail

ORIENTATION_VALUE_HORIZONTAL_NORMAL

static final String ORIENTATION_VALUE_HORIZONTAL_NORMAL

See Also:

Constant Field Values

ORIENTATION_VALUE_MIRROR_HORIZONTAL

static final String ORIENTATION_VALUE_MIRROR_HORIZONTAL

See Also:

Constant Field Values

ORIENTATION_VALUE_MIRROR_HORIZONTAL_ROTATE_90_CW

static final String ORIENTATION_VALUE_MIRROR_HORIZONTAL_ROTATE_90_CW

See Also:

Constant Field Values

ORIENTATION_VALUE_MIRROR_HORIZONTAL_ROTATE_270_CW

static final String ORIENTATION_VALUE_MIRROR_HORIZONTAL_ROTATE_270_CW

See Also:

Constant Field Values

ORIENTATION_VALUE_MIRROR_VERTICAL

static final String ORIENTATION_VALUE_MIRROR_VERTICAL

See Also:

Constant Field Values

ORIENTATION_VALUE_ROTATE_90_CW

static final String ORIENTATION_VALUE_ROTATE_90_CW

See Also:

Constant Field Values

ORIENTATION_VALUE_ROTATE_180

static final String ORIENTATION_VALUE_ROTATE_180

See Also:

Constant Field Values

ORIENTATION_VALUE_ROTATE_270_CW

static final String ORIENTATION_VALUE_ROTATE_270_CW

See Also:

Constant Field Values

TYPE_BMP

static final String TYPE_BMP

See Also:

Constant Field Values

TYPE_GIF

static final String TYPE_GIF

See Also:

Constant Field Values

TYPE_JPEG

static final String TYPE_JPEG

See Also:

Constant Field Values

TYPE_NOT_AVAILABLE

static final String TYPE_NOT_AVAILABLE

See Also:

Constant Field Values

TYPE_PNG

static final String TYPE_PNG

See Also:

Constant Field Values

TYPE_TIFF

static final String TYPE_TIFF

See Also:

Constant Field Values

Method Detail

convertCMYKtoRGB

Future<RenderedImage> convertCMYKtoRGB(byte[] bytes,
                                       String type)

convertImageType

BufferedImage convertImageType(BufferedImage sourceImage,
                               int type)

crop

RenderedImage crop(RenderedImage renderedImage,
                   int height,
                   int width,
                   int x,
                   int y)

encodeGIF

void encodeGIF(RenderedImage renderedImage,
               OutputStream os)
        throws IOException

Throws:

IOException

encodeWBMP

void encodeWBMP(RenderedImage renderedImage,
                OutputStream os)
         throws IOException

Throws:

IOException

flipHorizontal

RenderedImage flipHorizontal(RenderedImage renderedImage)

flipVertical

RenderedImage flipVertical(RenderedImage renderedImage)

getBufferedImage

BufferedImage getBufferedImage(RenderedImage renderedImage)

getBytes

byte[] getBytes(RenderedImage renderedImage,
                String contentType)
         throws IOException

Throws:

IOException

getDefaultCompanyLogo

Image getDefaultCompanyLogo()

getDefaultOrganizationLogo

Image getDefaultOrganizationLogo()

getDefaultSpacer

Image getDefaultSpacer()

getDefaultUserFemalePortrait

Image getDefaultUserFemalePortrait()

getDefaultUserMalePortrait

Image getDefaultUserMalePortrait()

getImage

Image getImage(byte[] bytes)
        throws ImageResolutionException,
               IOException

Throws:

ImageResolutionException

IOException

getImage

Image getImage(File file)
        throws ImageResolutionException,
               IOException

Throws:

ImageResolutionException

IOException

getImage

Image getImage(InputStream is)
        throws ImageResolutionException,
               IOException

Throws:

ImageResolutionException

IOException

getImage

Image getImage(InputStream is,
               boolean cleanUpStream)
        throws ImageResolutionException,
               IOException

Throws:

ImageResolutionException

IOException

isNullOrDefaultSpacer

boolean isNullOrDefaultSpacer(byte[] bytes)

read

ImageBag read(byte[] bytes)
       throws ImageResolutionException,
              IOException

Throws:

ImageResolutionException

IOException

read

ImageBag read(File file)
       throws ImageResolutionException,
              IOException

Throws:

ImageResolutionException

IOException

read

ImageBag read(InputStream inputStream)
       throws ImageResolutionException,
              IOException

Throws:

ImageResolutionException

IOException

rotate

RenderedImage rotate(RenderedImage renderedImage,
                     int degrees)

scale

RenderedImage scale(RenderedImage renderedImage,
                    int width)

scale

RenderedImage scale(RenderedImage renderedImage,
                    int maxHeight,
                    int maxWidth)

write

void write(RenderedImage renderedImage,
           String contentType,
           OutputStream os)
    throws IOException

Throws:

IOException