Interface IImage
- All Superinterfaces:
IReportPart
Defines an interface to communicate info about an image to image handler
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
static final int
-
Method Summary
Modifier and TypeMethodDescriptionreturn the image postfix, such as jpg, pnggetID()
returns an identifier for the imagebyte[]
returns binary image data.The image map is used in HTML output.returns an input stream where the mage can be readint
returns the source type of the image.void
setImageRawSize
(ImageSize rawSize) void
writeImage
(File dest) write the image to a destination fileMethods inherited from interface org.eclipse.birt.report.engine.api.IReportPart
getRenderOption, getReportRunnable
-
Field Details
-
DESIGN_IMAGE
static final int DESIGN_IMAGE- See Also:
-
REPORTDOC_IMAGE
static final int REPORTDOC_IMAGE- See Also:
-
URL_IMAGE
static final int URL_IMAGE- See Also:
-
FILE_IMAGE
static final int FILE_IMAGE- See Also:
-
CUSTOM_IMAGE
static final int CUSTOM_IMAGE- See Also:
-
INVALID_IMAGE
static final int INVALID_IMAGE- See Also:
-
-
Method Details
-
getID
String getID()returns an identifier for the image- Returns:
- an identifier for the image.
-
getSource
int getSource()returns the source type of the image. Could be DESIGN_IMAGE, REPORTDOC_IMAGE, URL_IMAGE or CUSTOM_IMAGE- Returns:
- the type of the image
-
getImageData
returns binary image data. The function should be called with caution- Returns:
- the binary image data
- Throws:
OutOfMemoryError
-
getImageStream
InputStream getImageStream()returns an input stream where the mage can be read- Returns:
- an input stream where the image can be read
-
writeImage
write the image to a destination file- Parameters:
dest
- destination file to write the image to- Throws:
IOException
-
getExtension
String getExtension()return the image postfix, such as jpg, png -
getMimeType
String getMimeType()- Returns:
- the mime type of the image
-
getImageMap
String getImageMap()The image map is used in HTML output.- Returns:
- the image map associate with this image.
-
getImageSize
ImageSize getImageSize()- Returns:
- the size of the image
-
setImageRawSize
- Parameters:
rawSize
- image raw size
-
getImageRawSize
ImageSize getImageRawSize()- Returns:
- the size of the image
-