org.eclipse.birt.report.engine.api
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

HTMLImageHandler()

Method Summary

CachedImage	getCachedImage(java.lang.String id, int type, org.eclipse.birt.report.engine.api.script.IReportContext context) get the cached image for that id.
protected java.lang.Object	getRenderContext(org.eclipse.birt.report.engine.api.script.IReportContext context)
java.lang.String	onCustomImage(IImage image, org.eclipse.birt.report.engine.api.script.IReportContext context)
java.lang.String	onCustomImage(IImage image, java.lang.Object context) handles a custom image created for example, by chart extension.
java.lang.String	onDesignImage(IImage image, org.eclipse.birt.report.engine.api.script.IReportContext context)
java.lang.String	onDesignImage(IImage image, java.lang.Object context) handles a design image.
java.lang.String	onDocImage(IImage image, org.eclipse.birt.report.engine.api.script.IReportContext context)
java.lang.String	onDocImage(IImage image, java.lang.Object context) handles a database image.
java.lang.String	onFileImage(IImage image, org.eclipse.birt.report.engine.api.script.IReportContext context)
java.lang.String	onFileImage(IImage image, java.lang.Object context) handles a image specified as a on-disk URI.
java.lang.String	onURLImage(IImage image, org.eclipse.birt.report.engine.api.script.IReportContext context)
java.lang.String	onURLImage(IImage image, java.lang.Object context) handles an image specified as an external URL.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HTMLImageHandler

public HTMLImageHandler()

Method Detail

onCustomImage

public java.lang.String onCustomImage(IImage image,
                                      java.lang.Object context)

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 interface IHTMLImageHandler

Parameters:

image - the image definition object

context - 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 interface IHTMLImageHandler

onDesignImage

public java.lang.String onDesignImage(IImage image,
                                      java.lang.Object context)

Description copied from interface: IHTMLImageHandler

handles a design image. The implementation supplies a URL and optionally stores the image.

Specified by:

onDesignImage in interface IHTMLImageHandler

Parameters:

image - the image definition object

context - 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 interface IHTMLImageHandler

onDocImage

public java.lang.String onDocImage(IImage image,
                                   java.lang.Object context)

Description copied from interface: IHTMLImageHandler

handles a database image. The implementation supplies a URL and optionally stores the image.

Specified by:

onDocImage in interface IHTMLImageHandler

Parameters:

image - the image definition object

context - 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 interface IHTMLImageHandler

onFileImage

public java.lang.String onFileImage(IImage image,
                                    java.lang.Object context)

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 interface IHTMLImageHandler

Parameters:

image - the image definition object

context - 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 interface IHTMLImageHandler

onURLImage

public java.lang.String onURLImage(IImage image,
                                   java.lang.Object context)

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 interface IHTMLImageHandler

Parameters:

image - the image definition object

context - 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 interface IHTMLImageHandler

getRenderContext

protected java.lang.Object getRenderContext(org.eclipse.birt.report.engine.api.script.IReportContext context)

getCachedImage

public CachedImage getCachedImage(java.lang.String id,
                                  int type,
                                  org.eclipse.birt.report.engine.api.script.IReportContext context)

Description copied from interface: IHTMLImageHandler

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.

Specified by:

getCachedImage in interface IHTMLImageHandler

Parameters:

id - id of the image

type - type of the image, one defined in the IImage

context - script context

Returns:

CachedImage object if find, otherwise, return null.