org.eclipse.birt.report.engine.api
Class HTMLCompleteImageHandler

java.lang.Object
  extended by org.eclipse.birt.report.engine.api.HTMLImageHandler
      extended by org.eclipse.birt.report.engine.api.HTMLCompleteImageHandler
All Implemented Interfaces:
IHTMLImageHandler

public class HTMLCompleteImageHandler
extends HTMLImageHandler

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
protected static int IMAGE_CACHE_SIZE
           
protected  java.util.logging.Logger log
           
 
Constructor Summary
HTMLCompleteImageHandler()
          dummy constructor
 
Method Summary
protected  java.io.File createUniqueFile(java.lang.String imageDir, java.lang.String prefix, java.lang.String postfix)
          Creates a unique temporary file to store an image
protected  java.lang.String getImageMapID(IImage image)
          returns the unique identifier for the image
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
 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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

IMAGE_CACHE_SIZE

protected static int IMAGE_CACHE_SIZE

log

protected java.util.logging.Logger log
Constructor Detail

HTMLCompleteImageHandler

public HTMLCompleteImageHandler()
dummy constructor

Method Detail

onDesignImage

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

(non-Javadoc)

Specified by:
onDesignImage in interface IHTMLImageHandler
Overrides:
onDesignImage in class HTMLImageHandler
Parameters:
image - the image definition object
context - 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

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

(non-Javadoc)

Specified by:
onDocImage in interface IHTMLImageHandler
Overrides:
onDocImage in class HTMLImageHandler
Parameters:
image - the image definition object
context - 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

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

(non-Javadoc)

Specified by:
onURLImage in interface IHTMLImageHandler
Overrides:
onURLImage in class HTMLImageHandler
Parameters:
image - the image definition object
context - 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

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

(non-Javadoc)

Specified by:
onCustomImage in interface IHTMLImageHandler
Overrides:
onCustomImage in class HTMLImageHandler
Parameters:
image - the image definition object
context - 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

protected java.io.File createUniqueFile(java.lang.String imageDir,
                                        java.lang.String prefix,
                                        java.lang.String postfix)
Creates a unique temporary file to store an image

Parameters:
imageDir - directory to put image into
prefix - file name prefix
postfix - file name suffix
Returns:
a Java File Object

onFileImage

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

(non-Javadoc)

Specified by:
onFileImage in interface IHTMLImageHandler
Overrides:
onFileImage in class HTMLImageHandler
Parameters:
image - the image definition object
context - 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 information
context - context information
prefix - image prefix in URL
needMap - whether image map is needed
Returns:
URL for the image

getImageMapID

protected java.lang.String getImageMapID(IImage image)
returns the unique identifier for the image

Parameters:
image - the image object
Returns:
the image id


Copyright © 2008 Actuate Corp. All rights reserved.