JavaDoq 1.0 API

com.javadoq.html
Class DoqHTMLFile

java.lang.Object
  extended by com.javadoq.html.Doq
      extended by com.javadoq.html.DoqHTMLFile
Direct Known Subclasses:
DoqHTMLBody, DoqHTMLIndex

public abstract class DoqHTMLFile
extends Doq

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

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

Field Summary
 JavaDoq jdoq
          The JavaDoq environment of this transformer.
 
Fields inherited from class com.javadoq.html.Doq
fileName, fileWriter, LINE_SEPARATOR, STYLE_SHEET
 
Constructor Summary
protected DoqHTMLFile(JavaDoq jdoq, java.lang.String fileName, java.lang.String title)
          Constructs a DoqHTMLFile transformer without style sheet.
protected DoqHTMLFile(JavaDoq jdoq, java.lang.String fileName, java.lang.String title, java.lang.String css)
          Constructs a DoqHTMLFile transformer with a given style sheet.
 
Method Summary
 void close()
          Closes the target HTML file.
protected  void writeFrameItem(java.lang.String href, java.lang.String target, java.lang.String text)
          Writes a frame item to the target HTML file.
 
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
 

Field Detail

jdoq

public final JavaDoq jdoq

The JavaDoq environment of this transformer.

Since:
1.0
Constructor Detail

DoqHTMLFile

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

Constructs a DoqHTMLFile transformer without style sheet.

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

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

DoqHTMLFile

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

Constructs a DoqHTMLFile transformer with a given style sheet.

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

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

writeFrameItem

protected final void writeFrameItem(java.lang.String href,
                                    java.lang.String target,
                                    java.lang.String text)

Writes a frame item to the target HTML file.

Parameters:
href - The hyper link for the frame item.
target - The target for the frame item.
text - The text for the frame item.
Since:
1.0

close

public void close()

Closes the target HTML file.

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

Overrides:
close in class Doq
Since:
1.0

JavaDoq 1.0 API

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