Class HTMLImageHandler
java.lang.Object
org.eclipse.birt.report.engine.api.HTMLImageHandler
- All Implemented Interfaces:
IHTMLImageHandler
- Direct Known Subclasses:
HTMLCompleteImageHandler
,HTMLServerImageHandler
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddCachedImage
(String id, int type, IImage image, org.eclipse.birt.report.engine.api.script.IReportContext context) add the image into cache.getCachedImage
(String id, int type, org.eclipse.birt.report.engine.api.script.IReportContext context) get the cached image.protected Object
getRenderContext
(org.eclipse.birt.report.engine.api.script.IReportContext context) Get render context.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)
-
Constructor Details
-
HTMLImageHandler
public HTMLImageHandler()
-
-
Method Details
-
onCustomImage
Deprecated.Description copied from interface:IHTMLImageHandler
handles a custom image created for example, by chart extension. The implementation supplies a URL and optionally stores the image.- Specified by:
onCustomImage
in interfaceIHTMLImageHandler
- Parameters:
image
- the image definition objectcontext
- the context for generating the URL- Returns:
- the URL for the image
-
onCustomImage
public String onCustomImage(IImage image, org.eclipse.birt.report.engine.api.script.IReportContext context) - Specified by:
onCustomImage
in interfaceIHTMLImageHandler
-
onDesignImage
Deprecated.Description copied from interface:IHTMLImageHandler
handles a design image. The implementation supplies a URL and optionally stores the image.- Specified by:
onDesignImage
in interfaceIHTMLImageHandler
- Parameters:
image
- the image definition objectcontext
- the context for generating the URL- Returns:
- the URL for the image
-
onDesignImage
public String onDesignImage(IImage image, org.eclipse.birt.report.engine.api.script.IReportContext context) - Specified by:
onDesignImage
in interfaceIHTMLImageHandler
-
onDocImage
Deprecated.Description copied from interface:IHTMLImageHandler
handles a database image. The implementation supplies a URL and optionally stores the image.- Specified by:
onDocImage
in interfaceIHTMLImageHandler
- Parameters:
image
- the image definition objectcontext
- the context for generating the URL- Returns:
- the URL for the image
-
onDocImage
public String onDocImage(IImage image, org.eclipse.birt.report.engine.api.script.IReportContext context) - Specified by:
onDocImage
in interfaceIHTMLImageHandler
-
onFileImage
Deprecated.Description copied from interface:IHTMLImageHandler
handles a image specified as a on-disk URI. The implementation supplies a URL and optionally stores the image.- Specified by:
onFileImage
in interfaceIHTMLImageHandler
- Parameters:
image
- the image definition objectcontext
- the context for generating the URL- Returns:
- the URL for the image
-
onFileImage
public String onFileImage(IImage image, org.eclipse.birt.report.engine.api.script.IReportContext context) - Specified by:
onFileImage
in interfaceIHTMLImageHandler
-
onURLImage
Deprecated.Description copied from interface:IHTMLImageHandler
handles an image specified as an external URL. The implementation supplies a URL and optionally stores the image.- Specified by:
onURLImage
in interfaceIHTMLImageHandler
- Parameters:
image
- the image definition objectcontext
- the context for generating the URL- Returns:
- the URL for the image
-
onURLImage
public String onURLImage(IImage image, org.eclipse.birt.report.engine.api.script.IReportContext context) - Specified by:
onURLImage
in interfaceIHTMLImageHandler
-
getRenderContext
Get render context.- Parameters:
context
-- Returns:
-
getCachedImage
public CachedImage getCachedImage(String id, int type, org.eclipse.birt.report.engine.api.script.IReportContext context) get the cached image.- Specified by:
getCachedImage
in interfaceIHTMLImageHandler
- Parameters:
id
- cache keytype
- image type.context
- report context- Returns:
- the cached image
-
addCachedImage
public CachedImage addCachedImage(String id, int type, IImage image, org.eclipse.birt.report.engine.api.script.IReportContext context) add the image into cache.- Specified by:
addCachedImage
in interfaceIHTMLImageHandler
- Parameters:
id
- cached keytype
- image typeimage
- image object.context
- report context- Returns:
- the cached image.
-