Class HTMLCompleteImageHandler
java.lang.Object
org.eclipse.birt.report.engine.api.HTMLImageHandler
org.eclipse.birt.report.engine.api.HTMLCompleteImageHandler
- All Implemented Interfaces:
IHTMLImageHandler
Default implementation for writing images in a form that is compatible with a
web browser's "HTML Complete" save option, i.e., writes images to a
predefined folder.
ImageDirectory: absolute path save the image into that directy, return the
aboluste URL of that image.
ImageDirectory: null, treat it as "." ImageDirectory: relative relative to
the base folder.
BaseFolder: parent folder of the output file, save the file into image
directory and return the relative path (base on the base folder).
BaseFolder:null, use "." as the base folder and return the aboluste path,
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected File
createUniqueFile
(String imageDir, String prefix, String postfix) Creates a unique temporary file to store an imageprotected String
getImageMapID
(IImage image) returns the unique identifier for the imageprotected String
handleImage
(IImage image, Object context, String prefix, boolean needMap) handles an image report item and returns an image URLonCustomImage
(IImage image, Object context) Deprecated.onDesignImage
(IImage image, Object context) Deprecated.onDocImage
(IImage image, Object context) Deprecated.onFileImage
(IImage image, Object context) Deprecated.onURLImage
(IImage image, Object context) Deprecated.Methods inherited from class org.eclipse.birt.report.engine.api.HTMLImageHandler
addCachedImage, getCachedImage, getRenderContext, onCustomImage, onDesignImage, onDocImage, onFileImage, onURLImage
-
Field Details
-
log
-
-
Constructor Details
-
HTMLCompleteImageHandler
public HTMLCompleteImageHandler()dummy constructor
-
-
Method Details
-
onDesignImage
Deprecated.(non-Javadoc)- Specified by:
onDesignImage
in interfaceIHTMLImageHandler
- Overrides:
onDesignImage
in classHTMLImageHandler
- Parameters:
image
- the image definition objectcontext
- the context for generating the URL- Returns:
- the URL for the image
- See Also:
-
org.eclipse.birt.report.engine.api2.IHTMLImageHandler#onDesignImage(org.eclipse.birt.report.engine.api2.IImage, java.lang.Object)
-
onDocImage
Deprecated.(non-Javadoc)- Specified by:
onDocImage
in interfaceIHTMLImageHandler
- Overrides:
onDocImage
in classHTMLImageHandler
- Parameters:
image
- the image definition objectcontext
- the context for generating the URL- Returns:
- the URL for the image
- See Also:
-
org.eclipse.birt.report.engine.api2.IHTMLImageHandler#onDocImage(org.eclipse.birt.report.engine.api2.IImage, java.lang.Object)
-
onURLImage
Deprecated.(non-Javadoc)- Specified by:
onURLImage
in interfaceIHTMLImageHandler
- Overrides:
onURLImage
in classHTMLImageHandler
- Parameters:
image
- the image definition objectcontext
- the context for generating the URL- Returns:
- the URL for the image
- See Also:
-
org.eclipse.birt.report.engine.api2.IHTMLImageHandler#onURLImage(org.eclipse.birt.report.engine.api2.IImage, java.lang.Object)
-
onCustomImage
Deprecated.(non-Javadoc)- Specified by:
onCustomImage
in interfaceIHTMLImageHandler
- Overrides:
onCustomImage
in classHTMLImageHandler
- Parameters:
image
- the image definition objectcontext
- the context for generating the URL- Returns:
- the URL for the image
- See Also:
-
org.eclipse.birt.report.engine.api2.IHTMLImageHandler#onCustomImage(org.eclipse.birt.report.engine.api2.IImage, java.lang.Object)
-
createUniqueFile
Creates a unique temporary file to store an image- Parameters:
imageDir
- directory to put image intoprefix
- file name prefixpostfix
- file name suffix- Returns:
- a Java File Object
-
onFileImage
Deprecated.(non-Javadoc)- Specified by:
onFileImage
in interfaceIHTMLImageHandler
- Overrides:
onFileImage
in classHTMLImageHandler
- Parameters:
image
- the image definition objectcontext
- the context for generating the URL- Returns:
- the URL for the image
- See Also:
-
org.eclipse.birt.report.engine.api2.IHTMLImageHandler#onFileImage(org.eclipse.birt.report.engine.api2.IImage, java.lang.Object)
-
handleImage
handles an image report item and returns an image URL- Parameters:
image
- represents the image design informationcontext
- context informationprefix
- image prefix in URLneedMap
- whether image map is needed- Returns:
- URL for the image
-
getImageMapID
returns the unique identifier for the image- Parameters:
image
- the image object- Returns:
- the image id
-