org.eclipse.birt.report.engine.api
Interface IHTMLImageHandler

All Known Implementing Classes:

HTMLCompleteImageHandler, HTMLServerImageHandler

public interface IHTMLImageHandler

Defines the image handler interface for use in HTML format

Method Summary

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, java.lang.Object context) handles a design image.
java.lang.String	onDocImage(IImage image, java.lang.Object context) handles a database image.
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, java.lang.Object context) handles an image specified as an external URL.

Method Detail

onDesignImage

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

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

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,
                                   java.lang.Object context)

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

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,
                                    java.lang.Object context)

handles a image specified as a on-disk URI. The implementation supplies a URL and optionally stores the image.

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,
                                   java.lang.Object context)

handles an image specified as an external URL. The implementation supplies a URL and optionally stores the image.

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,
                                      java.lang.Object context)

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 object

context - the context for generating the URL

Returns:

the URL for the image