JavaDoq 1.0 API

com.javadoq.html
Class DoqHTMLBody

java.lang.Object
  extended by com.javadoq.html.Doq
      extended by com.javadoq.html.DoqHTMLFile
          extended by com.javadoq.html.DoqHTMLBody
Direct Known Subclasses:
DoqHTMLAllFiles, DoqHTMLPackage, DoqHTMLPackages, DoqHTMLSourceFile

public abstract class DoqHTMLBody
extends DoqHTMLFile

An abstract base class of transformers that create target HTML files with bodies.

Author:
J.J.Liu (Jianjun Liu) at http://www.javadoq.com

Field Summary
 
Fields inherited from class com.javadoq.html.DoqHTMLFile
jdoq
 
Fields inherited from class com.javadoq.html.Doq
fileName, fileWriter, LINE_SEPARATOR, STYLE_SHEET
 
Constructor Summary
protected DoqHTMLBody(JavaDoq jdoq, java.lang.String fileName, java.lang.String title)
          Constructs a DoqHTMLBody transformer without style sheet.
protected DoqHTMLBody(JavaDoq jdoq, java.lang.String fileName, java.lang.String title, java.lang.String css)
          Constructs a DoqHTMLBody transformer with a given style sheet.
 
Method Summary
 void close()
          Closes the target HTML body.
 
Methods inherited from class com.javadoq.html.DoqHTMLFile
writeFrameItem
 
Methods inherited from class com.javadoq.html.Doq
write, write, writeLine
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DoqHTMLBody

protected DoqHTMLBody(JavaDoq jdoq,
                      java.lang.String fileName,
                      java.lang.String title)

Constructs a DoqHTMLBody transformer without style sheet.

This constructor invokes its super constructor to create and open the target file and HTML body.

Parameters:
jdoq - The JavaDoq environment for the transformer.
fileName - The absolute path of the source file to transform.
title - The title for the target HTML file.
Since:
1.0

DoqHTMLBody

protected DoqHTMLBody(JavaDoq jdoq,
                      java.lang.String fileName,
                      java.lang.String title,
                      java.lang.String css)

Constructs a DoqHTMLBody transformer with a given style sheet.

This constructor invokes its super constructor to create and open the target file and HTML body.

Parameters:
jdoq - The JavaDoq environment for the transformer.
fileName - The absolute path of the source file to transform.
title - The title for the target HTML file.
css - The name of the cascade style sheet file.
Since:
1.0
Method Detail

close

public void close()

Closes the target HTML body.

This method closes HTML body and invokes its super method to close HTML and the file.

Overrides:
close in class DoqHTMLFile
Since:
1.0

JavaDoq 1.0 API

Copyright © 2008-2011 J.J.Liu (www.javadoq.com). All Rights Reserved.