org.eclipse.tptp.platform.report.drivers.html
Class DAbstractDocumentPolicy

java.lang.Object
  org.eclipse.tptp.platform.report.drivers.html.DAbstractDocumentPolicy

All Implemented Interfaces:

IDGenerationPolicy

Direct Known Subclasses:

DMultiDocumentPolicy, DOneDocumentPolicy

public abstract class DAbstractDocumentPolicy

extends java.lang.Object

implements IDGenerationPolicy

This interface provides the service to generate valid html link reference.

Constructor Summary

DAbstractDocumentPolicy(DHtmlWriter wh, java.lang.String basePath, org.eclipse.tptp.platform.report.tools.internal.IDIImageProvider imgp)

Method Summary

protected java.lang.String	copyImageFile(java.lang.String img)
void	doMethod(org.eclipse.tptp.platform.report.core.internal.DPopup item, org.eclipse.tptp.platform.report.extension.internal.DExtensible ext, java.lang.Object arg)
java.lang.String	getBaseDirectoryPath()
java.lang.String	getFileExtension()
java.lang.String	getImageDirectoryName()
java.lang.String	getImageDirectoryPath()
org.eclipse.tptp.platform.report.tools.internal.IDIImageProvider	getImageProvider()
java.lang.String	getImageUrl(org.eclipse.tptp.platform.report.core.internal.DImage image)
DHtmlWriter	getWriter()
void	setBaseDirectoryPath(java.lang.String dirname) Sets the destination directory for HTML files.
void	setFileExtension(java.lang.String fileExtension) Sets the file extension for the HTML file
void	setImageDirectoryName(java.lang.String imageDirectoryName) Sets the image directory name.
void	start() Creates the directory
protected void	writeInFile(DHtmlWriter writer, java.lang.String docTitle, org.eclipse.tptp.platform.report.core.internal.IDItem item, org.eclipse.tptp.platform.report.extension.internal.DExtensible ext, java.lang.Object arg)
protected java.lang.String	writeInFile(org.eclipse.tptp.platform.report.igc.internal.IImage img) Writes an IImage in the file

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.tptp.platform.report.drivers.html.IDGenerationPolicy

getLinkUrl

Constructor Detail

DAbstractDocumentPolicy

public DAbstractDocumentPolicy(DHtmlWriter wh,
                               java.lang.String basePath,
                               org.eclipse.tptp.platform.report.tools.internal.IDIImageProvider imgp)

Method Detail

getWriter

public DHtmlWriter getWriter()

Returns:

the Html writer

writeInFile

protected java.lang.String writeInFile(org.eclipse.tptp.platform.report.igc.internal.IImage img)
                                throws DHtmlWriterException

Writes an IImage in the file

Throws:

DHtmlWriterException

copyImageFile

protected java.lang.String copyImageFile(java.lang.String img)
                                  throws DHtmlWriterException

Throws:

DHtmlWriterException

getImageUrl

public java.lang.String getImageUrl(org.eclipse.tptp.platform.report.core.internal.DImage image)
                             throws DHtmlWriterException

Specified by:

getImageUrl in interface IDGenerationPolicy

Returns:

the valid url for the image

Throws:

DHtmlWriterException

writeInFile

protected void writeInFile(DHtmlWriter writer,
                           java.lang.String docTitle,
                           org.eclipse.tptp.platform.report.core.internal.IDItem item,
                           org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
                           java.lang.Object arg)
                    throws DHtmlWriterException

Throws:

DHtmlWriterException

doMethod

public void doMethod(org.eclipse.tptp.platform.report.core.internal.DPopup item,
                     org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
                     java.lang.Object arg)
              throws DHtmlWriterException

Throws:

DHtmlWriterException

getFileExtension

public java.lang.String getFileExtension()

Returns:

the file extension for the HTML file. By default return ".html"

setFileExtension

public void setFileExtension(java.lang.String fileExtension)

Sets the file extension for the HTML file

setBaseDirectoryPath

public void setBaseDirectoryPath(java.lang.String dirname)

Sets the destination directory for HTML files.

getBaseDirectoryPath

public java.lang.String getBaseDirectoryPath()

Specified by:

getBaseDirectoryPath in interface IDGenerationPolicy

Returns:

the destination directory for HTML files.

getImageDirectoryPath

public java.lang.String getImageDirectoryPath()

Specified by:

getImageDirectoryPath in interface IDGenerationPolicy

Returns:

the image directory path

start

public void start()

Creates the directory

Specified by:

start in interface IDGenerationPolicy

getImageDirectoryName

public java.lang.String getImageDirectoryName()

Returns:

the image directory name. By default returns 'images'.

setImageDirectoryName

public void setImageDirectoryName(java.lang.String imageDirectoryName)

Sets the image directory name.

getImageProvider

public org.eclipse.tptp.platform.report.tools.internal.IDIImageProvider getImageProvider()

Specified by:

getImageProvider in interface IDGenerationPolicy

Returns:

the Image provider