Class HTMLServerImageHandler
- java.lang.Object
-
- org.eclipse.birt.report.engine.api.HTMLImageHandler
-
- org.eclipse.birt.report.engine.api.HTMLServerImageHandler
-
- All Implemented Interfaces:
IHTMLImageHandler
public class HTMLServerImageHandler extends HTMLImageHandler
Default implementation for writing images in a form that is used in a web-application.
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.logging.Logger
log
-
Constructor Summary
Constructors Constructor Description HTMLServerImageHandler()
dummy constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected java.lang.String
createUniqueFileName(java.lang.String imageDir, java.lang.String prefix)
returns a unique file name based on a directory and name prefixprotected java.lang.String
createUniqueFileName(java.lang.String imageDir, java.lang.String prefix, java.lang.String postfix)
creates a unique tempoary file to store an imagevoid
getImage(java.io.OutputStream out, java.lang.String imageDir, java.lang.String imageID)
get imageprotected java.lang.String
getImageMapID(IImage image)
returns the unique identifier for the imageprotected java.lang.String
handleImage(IImage image, java.lang.Object context, java.lang.String prefix, boolean needMap)
handles an image report item and returns an image URLprotected java.lang.String
handleTempImage(IImage image, java.lang.String prefix, boolean needMap)
Handle a temporary image .java.lang.String
onCustomImage(IImage image, java.lang.Object context)
Deprecated.java.lang.String
onDesignImage(IImage image, java.lang.Object context)
Deprecated.java.lang.String
onDocImage(IImage image, java.lang.Object context)
Deprecated.java.lang.String
onFileImage(IImage image, java.lang.Object context)
Deprecated.java.lang.String
onURLImage(IImage image, java.lang.Object context)
Deprecated.-
Methods inherited from class org.eclipse.birt.report.engine.api.HTMLImageHandler
addCachedImage, getCachedImage, getRenderContext, onCustomImage, onDesignImage, onDocImage, onFileImage, onURLImage
-
-
-
-
Method Detail
-
onDesignImage
@Deprecated public java.lang.String onDesignImage(IImage image, java.lang.Object context)
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 public java.lang.String onDocImage(IImage image, java.lang.Object context)
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 public java.lang.String onURLImage(IImage image, java.lang.Object context)
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 public java.lang.String onCustomImage(IImage image, java.lang.Object context)
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
protected java.lang.String createUniqueFileName(java.lang.String imageDir, java.lang.String prefix)
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
protected java.lang.String createUniqueFileName(java.lang.String imageDir, java.lang.String prefix, java.lang.String postfix)
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 public java.lang.String onFileImage(IImage image, java.lang.Object context)
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
protected java.lang.String handleImage(IImage image, java.lang.Object context, java.lang.String prefix, boolean needMap)
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
protected java.lang.String handleTempImage(IImage image, java.lang.String prefix, boolean needMap)
Handle a temporary image .- Parameters:
image
- represents the image design informationprefix
- image prefix in URLneedMap
- whether image map is needed- Returns:
-
getImageMapID
protected java.lang.String getImageMapID(IImage image)
returns the unique identifier for the image- Parameters:
image
- the image object- Returns:
- the image id
-
getImage
public void getImage(java.io.OutputStream out, java.lang.String imageDir, java.lang.String imageID) throws EngineException
get image- Parameters:
out
- the output stream of imageimageDir
- the image directoryimageID
- id of image- Throws:
java.io.IOException
EngineException
-
-