Interface IHTMLImageHandler
- All Known Implementing Classes:
HTMLCompleteImageHandler
,HTMLImageHandler
,HTMLServerImageHandler
public interface IHTMLImageHandler
Defines the image handler interface for use in HTML format
-
Method Summary
Modifier and TypeMethodDescriptionaddCachedImage
(String id, int type, IImage image, org.eclipse.birt.report.engine.api.script.IReportContext context) add the image into image cache, so it can be accessed throughgetCachedImage
.getCachedImage
(String id, int type, org.eclipse.birt.report.engine.api.script.IReportContext context) get the cached image for that id.onCustomImage
(IImage image, Object context) Deprecated.onCustomImage
(IImage image, org.eclipse.birt.report.engine.api.script.IReportContext context) onDesignImage
(IImage image, Object context) Deprecated.onDesignImage
(IImage image, org.eclipse.birt.report.engine.api.script.IReportContext context) onDocImage
(IImage image, Object context) Deprecated.onDocImage
(IImage image, org.eclipse.birt.report.engine.api.script.IReportContext context) onFileImage
(IImage image, Object context) Deprecated.onFileImage
(IImage image, org.eclipse.birt.report.engine.api.script.IReportContext context) onURLImage
(IImage image, Object context) Deprecated.onURLImage
(IImage image, org.eclipse.birt.report.engine.api.script.IReportContext context)
-
Method Details
-
onDesignImage
Deprecated.handles a design image. The implementation supplies a URL and optionally stores the image.- Parameters:
image
- the image definition objectcontext
- the context for generating the URL- Returns:
- the URL for the image
-
onDesignImage
-
onDocImage
Deprecated.handles a database image. The implementation supplies a URL and optionally stores the image.- Parameters:
image
- the image definition objectcontext
- the context for generating the URL- Returns:
- the URL for the image
-
onDocImage
-
onFileImage
Deprecated.handles a image specified as a on-disk URI. The implementation supplies a URL and optionally stores the image.- Parameters:
image
- the image definition objectcontext
- the context for generating the URL- Returns:
- the URL for the image
-
onFileImage
-
onURLImage
Deprecated.handles an image specified as an external URL. The implementation supplies a URL and optionally stores the image.- Parameters:
image
- the image definition objectcontext
- the context for generating the URL- Returns:
- the URL for the image
-
onURLImage
-
onCustomImage
Deprecated.handles a custom image created for example, by chart extension. The implementation supplies a URL and optionally stores the image.- Parameters:
image
- the image definition objectcontext
- the context for generating the URL- Returns:
- the URL for the image
-
onCustomImage
-
getCachedImage
CachedImage getCachedImage(String id, int type, org.eclipse.birt.report.engine.api.script.IReportContext context) get the cached image for that id. The CachedImage object contains: URL: the absolute file path of the image. MIMETYPE: the mimetype of the image IMAGEMAP: the image map of the image.- Parameters:
id
- id of the imagetype
- type of the image, one defined in the IImagecontext
- script context- Returns:
- CachedImage object if find, otherwise, return null.
-
addCachedImage
CachedImage addCachedImage(String id, int type, IImage image, org.eclipse.birt.report.engine.api.script.IReportContext context) add the image into image cache, so it can be accessed throughgetCachedImage
.- Parameters:
id
- cache keytype
- image typeimage
- image objectcontext
- report context- Returns:
- the cached image.
-