|
TPTP 4.6.0 Platform Project Public API Specification |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.eclipse.tptp.platform.report.extension.internal.DExtensible
org.eclipse.tptp.platform.report.tools.internal.DParser
org.eclipse.tptp.platform.report.drivers.html.DHtmlWriter
org.eclipse.tptp.platform.report.birt).
public class DHtmlWriter
This is the Html Generator driver. See DHtmlGraphic and DHtmlGraphicApplet class for DGraphic items translation details. It is a DParser, so it is extensible using the JScrib DExtensible extension mechanism. Do not forgot to set image provider.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class org.eclipse.tptp.platform.report.tools.internal.DParser |
|---|
org.eclipse.tptp.platform.report.tools.internal.DParser.ParserException |
| Field Summary | |
|---|---|
static java.lang.String |
GRAPHIC_APPLET
Deprecated. Constant to generate DGraphic item in an applet, this is the default graphic extension |
static java.lang.String |
GRAPHIC_IMAGE_AWT
Deprecated. Constant to generate DGraphic item in an image (require AWT classes available) |
static java.lang.String |
GRAPHIC_IMAGE_SWT
Deprecated. Constant to generate DGraphic item in an image (require SWT classes available) |
static java.lang.String |
GRAPHIC_SVG
Deprecated. Constant to generate DGraphic item in SVG format |
| Constructor Summary | |
|---|---|
DHtmlWriter()
Deprecated. Creates a HTML JScrib Generator and reads the HTML file configuration. |
|
| Method Summary | |
|---|---|
void |
clear()
Deprecated. Clears all data allocated. |
void |
doChildrenItem(org.eclipse.tptp.platform.report.core.internal.IDItem item,
org.eclipse.tptp.platform.report.drivers.internal.Item hitem,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
Deprecated. |
void |
doMethod(org.eclipse.tptp.platform.report.core.internal.DAxis item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
Deprecated. already made from the enclosing DGraphic |
void |
doMethod(org.eclipse.tptp.platform.report.core.internal.DBorder border,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
Deprecated. Write HTML for DBorder |
void |
doMethod(org.eclipse.tptp.platform.report.core.internal.DCell item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
Deprecated. Generates HTML tags for DCell. |
void |
doMethod(org.eclipse.tptp.platform.report.core.internal.DCellText item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
Deprecated. Generates HTML tags for DCellText. |
void |
doMethod(org.eclipse.tptp.platform.report.core.internal.DCurve item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
Deprecated. already made from the enclosing DGraphic |
void |
doMethod(org.eclipse.tptp.platform.report.core.internal.DCurveLink item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
Deprecated. already made from the enclosing DGraphic |
void |
doMethod(org.eclipse.tptp.platform.report.core.internal.DDocument item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
Deprecated. Generates HTML tags for DDocument. |
void |
doMethod(org.eclipse.tptp.platform.report.core.internal.DFolder folder,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
Deprecated. |
void |
doMethod(org.eclipse.tptp.platform.report.core.internal.DFooter item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
Deprecated. Do nothing, ignored |
void |
doMethod(org.eclipse.tptp.platform.report.core.internal.DGraphic item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
Deprecated. Generates HTML tags for DGraphic. |
void |
doMethod(org.eclipse.tptp.platform.report.core.internal.DHeader item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
Deprecated. Do nothing, ignored |
void |
doMethod(org.eclipse.tptp.platform.report.core.internal.DImage item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
Deprecated. Generates HTML tags for DImage. |
void |
doMethod(org.eclipse.tptp.platform.report.core.internal.DIndex item)
Deprecated. do nothing, ignored |
void |
doMethod(org.eclipse.tptp.platform.report.core.internal.DIndexEntry item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
Deprecated. Generates HTML tags for DIndexEntry. |
void |
doMethod(org.eclipse.tptp.platform.report.core.internal.DLine item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
Deprecated. Generates HTML tags for DLine. |
void |
doMethod(org.eclipse.tptp.platform.report.core.internal.DLink item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
Deprecated. Generates HTML tags for DLink. |
void |
doMethod(org.eclipse.tptp.platform.report.core.internal.DList item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
Deprecated. Generates HTML tags for DList. |
void |
doMethod(org.eclipse.tptp.platform.report.core.internal.DPageBreak item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
Deprecated. do noting, ignored |
void |
doMethod(org.eclipse.tptp.platform.report.core.internal.DPageCounter item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
Deprecated. do nothing, ignored |
void |
doMethod(org.eclipse.tptp.platform.report.core.internal.DParagraph item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
Deprecated. Generates HTML tags for DParagraph. |
void |
doMethod(org.eclipse.tptp.platform.report.core.internal.DPoint item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
Deprecated. already made from the enclosing DGraphic |
void |
doMethod(org.eclipse.tptp.platform.report.core.internal.DPointLink item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
Deprecated. already made from the enclosing DGraphic |
void |
doMethod(org.eclipse.tptp.platform.report.core.internal.DPopup item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
Deprecated. Generates HTML tags for DPopup. |
void |
doMethod(org.eclipse.tptp.platform.report.core.internal.DRow item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
Deprecated. Generates HTML tags for DRow. |
void |
doMethod(org.eclipse.tptp.platform.report.core.internal.DSection item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
Deprecated. Generates HTML tags for DSection. |
void |
doMethod(org.eclipse.tptp.platform.report.core.internal.DSummary item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
Deprecated. Generates HTML tags for DSummary. |
void |
doMethod(org.eclipse.tptp.platform.report.core.internal.DTable item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
Deprecated. Generates HTML tags for DTable. |
void |
doMethod(org.eclipse.tptp.platform.report.core.internal.DTag item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
Deprecated. Generates HTML tags for DTag. |
void |
doMethod(org.eclipse.tptp.platform.report.core.internal.DText item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
Deprecated. Generates HTML tags for DText. |
void |
doMethod(org.eclipse.tptp.platform.report.core.internal.DTitle item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
Deprecated. Generates HTML tags for DTitle. |
ConfParser |
getConfparser()
Deprecated. Returns the configuration parser module. |
java.lang.String |
getDirname()
Deprecated. |
IDGenerationPolicy |
getGenerationPolicy()
Deprecated. |
java.lang.String |
getGraphicExtensionClass()
Deprecated. |
org.eclipse.tptp.platform.report.tools.internal.IDIImageProvider |
getImageProvider()
Deprecated. |
org.eclipse.tptp.platform.report.drivers.internal.Item |
getItem(org.eclipse.tptp.platform.report.core.internal.IDItem item)
Deprecated. Returns the generation rules for an IDItem. |
java.io.OutputStream |
getOutputStream()
Deprecated. Returns the output stream used to generate HTML |
org.eclipse.tptp.platform.report.tools.internal.IDProgressMonitor |
getProgressMonitor()
Deprecated. |
java.lang.String |
getTitle()
Deprecated. |
void |
htmlConvertDump(java.lang.String string)
Deprecated. Converts and generates a String in HTML format. |
void |
htmlDump(int value)
Deprecated. Generates an int value in HTML format. |
void |
htmlDump(java.util.List list)
Deprecated. Generates a LinkedList in HTML format. |
void |
htmlDump(java.lang.String string)
Deprecated. Generates a String in HTML format. |
boolean |
isHtmlHeaderGenerated()
Deprecated. |
boolean |
isVerbose()
Deprecated. Returns true if the message output is actvate |
void |
setConfparser(ConfParser confparser)
Deprecated. Changes the configuration parser module. |
void |
setDirname(java.lang.String basePath)
Deprecated. sets the destination directory for HTML files. |
void |
setGraphicExtensionClass(java.lang.String graphic_type)
Deprecated. Change DGraphic generation mechanism, can be one of predefined constant: - DHtmlWriter.GRAPHIC_IMAGE_SWT to generate graphic in a image using SWT (require a valid setDirname()) - DHtmlWriter.GRAPHIC_APPLET to generate graphic in a applet (require a valid setDirname() only if jar file should be copied) or can be a valid class loaded using loadClass(), this class must define a method with the following signature: doMethod( DGraphic g, DExtensible ext, Object arg ) DExtensible is an instance of DHtmlWriter. |
void |
setHtmlHeaderGenerated(boolean b)
Deprecated. Change generation of HML/BODY element in stream, @see isHtmlHeaderGenerated() |
void |
setImageProvider(org.eclipse.tptp.platform.report.tools.internal.IDIImageProvider imageProvider)
Deprecated. sets the image provider |
void |
setOutputStream(java.io.OutputStream output)
Deprecated. Sets the output stream |
void |
setProgressMonitor(org.eclipse.tptp.platform.report.tools.internal.IDProgressMonitor progressMonitor)
Deprecated. Sets the progress monitor used by the html driver |
void |
setTitle(java.lang.String title)
Deprecated. Sets the html title |
void |
setVerbose(boolean verbose)
Deprecated. De/Activate the message output during the generation. |
void |
updateStyleVariables(org.eclipse.tptp.platform.report.core.internal.IDItem item)
Deprecated. |
void |
write(IDGenerationPolicy policy,
org.eclipse.tptp.platform.report.core.internal.IDObject object)
Deprecated. Generate the HTML with the current generation policy. |
void |
write(IDGenerationPolicy policy,
org.eclipse.tptp.platform.report.core.internal.IDObject[] objects)
Deprecated. Generate the HTML with the current generation policy. |
void |
write(java.io.OutputStream output,
org.eclipse.tptp.platform.report.core.internal.IDObject object)
Deprecated. Generates HTML for an IDObject in the OutputStream output and uses a DOneDocumentPolicy automatically to generate attachments |
void |
write(java.io.OutputStream output,
org.eclipse.tptp.platform.report.core.internal.IDObject[] objects)
Deprecated. Generates HTML for an IDObject array in the OutputStream output and uses a DOneDocumentPolicy automatically to generate attachments |
static void |
write(java.lang.String html_filepath,
org.eclipse.tptp.platform.report.core.internal.IDObject[] docs,
java.lang.String graphic_extension,
org.eclipse.tptp.platform.report.tools.internal.IDIImageProvider imgp)
Deprecated. generates the documents in only one HTML file by using DOneDocumentPolicy and a directory named _files to store images and charts into it. |
| Methods inherited from class org.eclipse.tptp.platform.report.tools.internal.DParser |
|---|
doChildrenItem, doMethod, doMethod, getListLevel, getTitleLevel |
| Methods inherited from class org.eclipse.tptp.platform.report.extension.internal.DExtensible |
|---|
doMethod, installDoMethod, installDoMethods, installDoMethods, invokeDoMethod, removeDoMethod, removeDoMethod, removeDoMethods, removeDoMethods |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String GRAPHIC_APPLET
public static final java.lang.String GRAPHIC_IMAGE_AWT
public static final java.lang.String GRAPHIC_IMAGE_SWT
public static final java.lang.String GRAPHIC_SVG
| Constructor Detail |
|---|
public DHtmlWriter()
throws DHtmlWriterException
DHtmlWriterExceptionDHtmlGraphic| Method Detail |
|---|
public boolean isHtmlHeaderGenerated()
public void setHtmlHeaderGenerated(boolean b)
public java.lang.String getGraphicExtensionClass()
public IDGenerationPolicy getGenerationPolicy()
public void setGraphicExtensionClass(java.lang.String graphic_type)
throws DHtmlWriterException
doMethod( DGraphic g, DExtensible ext, Object arg )DExtensible is an instance of DHtmlWriter.
DHtmlWriterExceptionpublic void setConfparser(ConfParser confparser)
public ConfParser getConfparser()
setConfparser(org.eclipse.tptp.platform.report.drivers.html.ConfParser)public void setVerbose(boolean verbose)
public boolean isVerbose()
setVerbose(boolean)public void setOutputStream(java.io.OutputStream output)
public java.io.OutputStream getOutputStream()
public void htmlConvertDump(java.lang.String string)
public void htmlDump(java.lang.String string)
public void htmlDump(int value)
public void htmlDump(java.util.List list)
public void updateStyleVariables(org.eclipse.tptp.platform.report.core.internal.IDItem item)
public org.eclipse.tptp.platform.report.drivers.internal.Item getItem(org.eclipse.tptp.platform.report.core.internal.IDItem item)
throws DHtmlWriterException
DHtmlWriterException
public void doChildrenItem(org.eclipse.tptp.platform.report.core.internal.IDItem item,
org.eclipse.tptp.platform.report.drivers.internal.Item hitem,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
public void doMethod(org.eclipse.tptp.platform.report.core.internal.DDocument item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
throws DHtmlWriterException
DHtmlWriterException
public void doMethod(org.eclipse.tptp.platform.report.core.internal.DSection item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
throws DHtmlWriterException
doMethod in class org.eclipse.tptp.platform.report.tools.internal.DParserDHtmlWriterException
public void doMethod(org.eclipse.tptp.platform.report.core.internal.DHeader item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
public void doMethod(org.eclipse.tptp.platform.report.core.internal.DFooter item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
public void doMethod(org.eclipse.tptp.platform.report.core.internal.DParagraph item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
throws DHtmlWriterException
DHtmlWriterException
public void doMethod(org.eclipse.tptp.platform.report.core.internal.DTag item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
throws DHtmlWriterException
DHtmlWriterException
public void doMethod(org.eclipse.tptp.platform.report.core.internal.DText item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
throws DHtmlWriterException
DHtmlWriterException
public void doMethod(org.eclipse.tptp.platform.report.core.internal.DImage item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
throws DHtmlWriterException
DHtmlWriterException
public void doMethod(org.eclipse.tptp.platform.report.core.internal.DList item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
throws DHtmlWriterException
DHtmlWriterException
public void doMethod(org.eclipse.tptp.platform.report.core.internal.DTable item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
throws DHtmlWriterException
DHtmlWriterException
public void doMethod(org.eclipse.tptp.platform.report.core.internal.DRow item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
throws DHtmlWriterException
DHtmlWriterException
public void doMethod(org.eclipse.tptp.platform.report.core.internal.DCell item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
throws DHtmlWriterException
DHtmlWriterException
public void doMethod(org.eclipse.tptp.platform.report.core.internal.DCellText item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
throws DHtmlWriterException
DHtmlWriterException
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
DHtmlWriterException
public void doMethod(org.eclipse.tptp.platform.report.core.internal.DLink item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
throws DHtmlWriterException
DHtmlWriterException
public void doMethod(org.eclipse.tptp.platform.report.core.internal.DLine item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
throws DHtmlWriterException
DHtmlWriterException
public void doMethod(org.eclipse.tptp.platform.report.core.internal.DPageBreak item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
public void doMethod(org.eclipse.tptp.platform.report.core.internal.DPageCounter item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
public void doMethod(org.eclipse.tptp.platform.report.core.internal.DSummary item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
throws DHtmlWriterException
DHtmlWriterException
public void doMethod(org.eclipse.tptp.platform.report.core.internal.DTitle item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
throws DHtmlWriterException
DHtmlWriterExceptionpublic void doMethod(org.eclipse.tptp.platform.report.core.internal.DIndex item)
public void doMethod(org.eclipse.tptp.platform.report.core.internal.DIndexEntry item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
throws DHtmlWriterException
DHtmlWriterException
public void doMethod(org.eclipse.tptp.platform.report.core.internal.DGraphic item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
throws DHtmlWriterException
DHtmlWriterException
public void doMethod(org.eclipse.tptp.platform.report.core.internal.DAxis item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
public void doMethod(org.eclipse.tptp.platform.report.core.internal.DCurve item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
public void doMethod(org.eclipse.tptp.platform.report.core.internal.DCurveLink item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
public void doMethod(org.eclipse.tptp.platform.report.core.internal.DPoint item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
public void doMethod(org.eclipse.tptp.platform.report.core.internal.DPointLink item,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
public void write(java.io.OutputStream output,
org.eclipse.tptp.platform.report.core.internal.IDObject[] objects)
throws DHtmlWriterException
write in interface org.eclipse.tptp.platform.report.drivers.internal.IWriterDHtmlWriterExceptionDOneDocumentPolicy
public void write(java.io.OutputStream output,
org.eclipse.tptp.platform.report.core.internal.IDObject object)
throws DHtmlWriterException
write in interface org.eclipse.tptp.platform.report.drivers.internal.IWriterDHtmlWriterExceptionDOneDocumentPolicy
public void write(IDGenerationPolicy policy,
org.eclipse.tptp.platform.report.core.internal.IDObject[] objects)
throws DHtmlWriterException
DHtmlWriterException#setGenerationPolicy(String)
public void write(IDGenerationPolicy policy,
org.eclipse.tptp.platform.report.core.internal.IDObject object)
throws DHtmlWriterException
DHtmlWriterException#setGenerationPolicy(String)public void clear()
clear in interface org.eclipse.tptp.platform.report.drivers.internal.IWriterclear in class org.eclipse.tptp.platform.report.tools.internal.DParser
public void doMethod(org.eclipse.tptp.platform.report.core.internal.DFolder folder,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
public void doMethod(org.eclipse.tptp.platform.report.core.internal.DBorder border,
org.eclipse.tptp.platform.report.extension.internal.DExtensible ext,
java.lang.Object arg)
public java.lang.String getTitle()
public void setTitle(java.lang.String title)
public org.eclipse.tptp.platform.report.tools.internal.IDProgressMonitor getProgressMonitor()
public void setProgressMonitor(org.eclipse.tptp.platform.report.tools.internal.IDProgressMonitor progressMonitor)
public java.lang.String getDirname()
public void setDirname(java.lang.String basePath)
public org.eclipse.tptp.platform.report.tools.internal.IDIImageProvider getImageProvider()
public void setImageProvider(org.eclipse.tptp.platform.report.tools.internal.IDIImageProvider imageProvider)
public static void write(java.lang.String html_filepath,
org.eclipse.tptp.platform.report.core.internal.IDObject[] docs,
java.lang.String graphic_extension,
org.eclipse.tptp.platform.report.tools.internal.IDIImageProvider imgp)
throws DHtmlWriterException
html_filepath - is the path to the html file which is generated. The parent's
file path is used as HTML target directory
DHtmlWriterException
|
TPTP 4.6.0 Platform Project Public API Specification |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||