Class HTMLImageHandler
- java.lang.Object
-
- org.eclipse.birt.report.engine.api.HTMLImageHandler
-
- All Implemented Interfaces:
IHTMLImageHandler
- Direct Known Subclasses:
HTMLCompleteImageHandler
,HTMLServerImageHandler
public class HTMLImageHandler extends java.lang.Object implements IHTMLImageHandler
-
-
Constructor Summary
Constructors Constructor Description HTMLImageHandler()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description CachedImage
addCachedImage(java.lang.String id, int type, IImage image, org.eclipse.birt.report.engine.api.script.IReportContext context)
add the image into cache.CachedImage
getCachedImage(java.lang.String id, int type, org.eclipse.birt.report.engine.api.script.IReportContext context)
get the cached image.protected java.lang.Object
getRenderContext(org.eclipse.birt.report.engine.api.script.IReportContext context)
Get render context.java.lang.String
onCustomImage(IImage image, java.lang.Object context)
Deprecated.java.lang.String
onCustomImage(IImage image, org.eclipse.birt.report.engine.api.script.IReportContext context)
java.lang.String
onDesignImage(IImage image, java.lang.Object context)
Deprecated.java.lang.String
onDesignImage(IImage image, org.eclipse.birt.report.engine.api.script.IReportContext context)
java.lang.String
onDocImage(IImage image, java.lang.Object context)
Deprecated.java.lang.String
onDocImage(IImage image, org.eclipse.birt.report.engine.api.script.IReportContext context)
java.lang.String
onFileImage(IImage image, java.lang.Object context)
Deprecated.java.lang.String
onFileImage(IImage image, org.eclipse.birt.report.engine.api.script.IReportContext context)
java.lang.String
onURLImage(IImage image, java.lang.Object context)
Deprecated.java.lang.String
onURLImage(IImage image, org.eclipse.birt.report.engine.api.script.IReportContext context)
-
-
-
Method Detail
-
onCustomImage
@Deprecated public java.lang.String onCustomImage(IImage image, java.lang.Object context)
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 java.lang.String onCustomImage(IImage image, org.eclipse.birt.report.engine.api.script.IReportContext context)
- Specified by:
onCustomImage
in interfaceIHTMLImageHandler
-
onDesignImage
@Deprecated public java.lang.String onDesignImage(IImage image, java.lang.Object context)
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 java.lang.String onDesignImage(IImage image, org.eclipse.birt.report.engine.api.script.IReportContext context)
- Specified by:
onDesignImage
in interfaceIHTMLImageHandler
-
onDocImage
@Deprecated public java.lang.String onDocImage(IImage image, java.lang.Object context)
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 java.lang.String onDocImage(IImage image, org.eclipse.birt.report.engine.api.script.IReportContext context)
- Specified by:
onDocImage
in interfaceIHTMLImageHandler
-
onFileImage
@Deprecated public java.lang.String onFileImage(IImage image, java.lang.Object context)
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 java.lang.String onFileImage(IImage image, org.eclipse.birt.report.engine.api.script.IReportContext context)
- Specified by:
onFileImage
in interfaceIHTMLImageHandler
-
onURLImage
@Deprecated public java.lang.String onURLImage(IImage image, java.lang.Object context)
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 java.lang.String onURLImage(IImage image, org.eclipse.birt.report.engine.api.script.IReportContext context)
- Specified by:
onURLImage
in interfaceIHTMLImageHandler
-
getRenderContext
protected java.lang.Object getRenderContext(org.eclipse.birt.report.engine.api.script.IReportContext context)
Get render context.- Parameters:
context
-- Returns:
-
getCachedImage
public CachedImage getCachedImage(java.lang.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(java.lang.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.
-
-