to.etc.domui.component.image

Interface IUIImageInstance

All Known Implementing Classes:

CachedImageInstance, LoadedImageInstance

public interface IUIImageInstance

A specialization (like a resized version) of a known IUIImage.

Author:

Frits Jalvingh Created on Nov 5, 2014

Method Summary

Modifier and Type	Method and Description
Dimension	getDimension() The size of the image, in pixels.
InputStream	getImage() Return an input stream that contains the byte data for the current image.
int	getImageSize() The size of the image, in bytes, if known; -1 if unknown.
String	getMimeType() Return the mime type of the current image, which must be one of the core image mime types for png, jpg or gif.

Method Detail

getImage

@Nonnull
InputStream getImage()
                       throws Exception

Return an input stream that contains the byte data for the current image. If the image has been set with uploaded() then this returns the input stream for that uploaded file. If the image comes from "somewhere else" this returns a stream for "somewhere else". This method will get called outside the context of the form in a separate request (from an IUnbufferedPartFactory).

Returns:

Throws:

Exception

getImageSize

int getImageSize()

The size of the image, in bytes, if known; -1 if unknown.

Returns:

getDimension

@Nonnull
Dimension getDimension()
                         throws Exception

The size of the image, in pixels.

Returns:

Throws:

Exception

getMimeType

@Nonnull
String getMimeType()
                     throws Exception

Return the mime type of the current image, which must be one of the core image mime types for png, jpg or gif.

Returns:

Throws:

Exception