Class HTMLServerImageHandler
java.lang.Object
org.eclipse.birt.report.engine.api.HTMLImageHandler
org.eclipse.birt.report.engine.api.HTMLServerImageHandler
- All Implemented Interfaces:
IHTMLImageHandler
Default implementation for writing images in a form that is used in a
web-application.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected String
createUniqueFileName
(String imageDir, String prefix) returns a unique file name based on a directory and name prefixprotected String
createUniqueFileName
(String imageDir, String prefix, String postfix) creates a unique tempoary file to store an imagevoid
getImage
(OutputStream out, String imageDir, String imageID) get 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 URLprotected String
handleTempImage
(IImage image, String prefix, boolean needMap) Handle a temporary image .onCustomImage
(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
-
HTMLServerImageHandler
public HTMLServerImageHandler()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)
-
createUniqueFileName
returns a unique file name based on a directory and name prefix- Parameters:
imageDir
- directory to store the imageprefix
- prefix for the file name- Returns:
- a file name
-
createUniqueFileName
creates a unique tempoary file to store an image- Parameters:
imageDir
- directory to put image intoprefix
- file name prefixpostfix
- file name postfix- 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
-
handleTempImage
Handle a temporary image .- Parameters:
image
- represents the image design informationprefix
- image prefix in URLneedMap
- whether image map is needed- Returns:
-
getImageMapID
returns the unique identifier for the image- Parameters:
image
- the image object- Returns:
- the image id
-
getImage
get image- Parameters:
out
- the output stream of imageimageDir
- the image directoryimageID
- id of image- Throws:
IOException
EngineException
-