com.sun.tools.doclets.formats.html.markup
Class HtmlDocWriter

java.lang.Object
  java.io.Writer
      java.io.PrintWriter
          com.sun.tools.doclets.formats.html.markup.HtmlWriter
              com.sun.tools.doclets.formats.html.markup.HtmlDocWriter

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.Appendable

Direct Known Subclasses:

HtmlDocletWriter

public abstract class HtmlDocWriter
extends HtmlWriter

Class for the Html Format Code Generation specific to JavaDoc. This Class contains methods related to the Html Code Generation which are used by the Sub-Classes in the package com.sun.tools.doclets.standard and com.sun.tools.doclets.oneone.

Since:

1.2

Field Summary

Fields inherited from class com.sun.tools.doclets.formats.html.markup.HtmlWriter

configuration, fileseparator, htmlFilename, winTitle

Fields inherited from class java.io.PrintWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

HtmlDocWriter(Configuration configuration, java.lang.String filename)
Constructor.

HtmlDocWriter(Configuration configuration, java.lang.String path, java.lang.String filename)

Method Summary

abstract Configuration	configuration() Accessor for configuration.
java.lang.String	getHyperLink(java.lang.String link, java.lang.String label) Get link string without positioning in the file.
java.lang.String	getHyperLink(java.lang.String link, java.lang.String where, java.lang.String label, boolean strong) Return Html Hyper Link string.
java.lang.String	getHyperLink(java.lang.String link, java.lang.String where, java.lang.String label, boolean strong, java.lang.String stylename) Get Html Hyper Link string.
java.lang.String	getHyperLink(java.lang.String link, java.lang.String where, java.lang.String label, boolean strong, java.lang.String stylename, java.lang.String title, java.lang.String target) Get Html Hyper Link string.
java.lang.String	getPkgName(ClassDoc cd) Get the name of the package, this class is in.
void	printBodyHtmlEnd() Print the closing </body> and </html> tags.
void	printFooter() Calls printBodyHtmlEnd() method.
void	printFrameFooter() Print closing </html> tag.
void	printFramesetHeader(java.lang.String title) Print the frameset version of the Html file header.
void	printFramesetHeader(java.lang.String title, boolean noTimeStamp) Print the frameset version of the Html file header.
void	printHyperLink(java.lang.String link, java.lang.String label) Print link without positioning in the file.
void	printHyperLink(java.lang.String link, java.lang.String where, java.lang.String label) Print Html Hyper Link.
void	printHyperLink(java.lang.String link, java.lang.String where, java.lang.String label, boolean strong) Print Html Hyper Link.
void	printHyperLink(java.lang.String link, java.lang.String where, java.lang.String label, boolean strong, java.lang.String stylename) Print Html Hyper Link.
void	printNbsps() Print ten non-breaking spaces("&nbsp;").
void	printPkgName(ClassDoc cd) Print the name of the package, this class is in.
java.lang.String	spaces(int len) Print the appropriate spaces to format the class tree in the class page.
java.lang.String	today() Get the day and date information for today, depending upon user option.

Methods inherited from class com.sun.tools.doclets.formats.html.markup.HtmlWriter

address, addressEnd, aEnd, aName, anchor, anchor, blockquote, blockquoteEnd, body, bodyEnd, br, center, centerEnd, code, codeEnd, codeText, commentEnd, commentStart, dd, ddEnd, dl, dlEnd, dt, em, emEnd, font, fontEnd, fontNoNewLine, fontSizeStyle, fontStyle, getCode, getCodeEnd, getFontColor, getFontEnd, getStrong, getStrongEnd, getWindowTitleOnload, h1, h1, h1End, h2, h2, h2End, h3, h3, h3End, h4, h4, h4End, h5, h5End, head, headEnd, hr, hr, hr, html, htmlEnd, img, italic, italicEnd, italics, italicsText, li, li, link, menu, menuEnd, noFrames, noFramesEnd, noScript, noScriptEnd, p, pEnd, pre, preEnd, preNoNewLine, printWinTitleScript, script, scriptEnd, space, strong, strong, strongEnd, sup, supEnd, table, table, table, table, tableEnd, td, tdAlign, tdAlignRowspan, tdAlignVAlign, tdAlignVAlignRowspan, tdBgcolorStyle, tdColspan, tdColspanBgcolorStyle, tdEnd, tdNowrap, tdVAlign, tdVAlignClass, tdWidth, thAlign, thAlignColspan, thAlignNowrap, thEnd, title, title, titleEnd, tr, trAlignVAlign, trBgcolor, trBgcolorStyle, trEnd, ul, ulEnd

Methods inherited from class java.io.PrintWriter

append, append, append, checkError, close, flush, format, format, print, print, print, print, print, print, print, print, print, printf, printf, println, println, println, println, println, println, println, println, println, println, setError, write, write, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlDocWriter

public HtmlDocWriter(Configuration configuration,
                     java.lang.String filename)
              throws java.io.IOException

Constructor. Initializes the destination file name through the super class HtmlWriter.

Parameters:

filename - String file name.

Throws:

java.io.IOException

HtmlDocWriter

public HtmlDocWriter(Configuration configuration,
                     java.lang.String path,
                     java.lang.String filename)
              throws java.io.IOException

Throws:

java.io.IOException

Method Detail

configuration

public abstract Configuration configuration()

Accessor for configuration.

printHyperLink

public void printHyperLink(java.lang.String link,
                           java.lang.String where,
                           java.lang.String label,
                           boolean strong)

Print Html Hyper Link.

Parameters:

link - String name of the file.

where - Position of the link in the file. Character '#' is not needed.

label - Tag for the link.

strong - Boolean that sets label to strong.

printHyperLink

public void printHyperLink(java.lang.String link,
                           java.lang.String where,
                           java.lang.String label)

Print Html Hyper Link.

Parameters:

link - String name of the file.

where - Position of the link in the file. Character '#' is not needed.

label - Tag for the link.

printHyperLink

public void printHyperLink(java.lang.String link,
                           java.lang.String where,
                           java.lang.String label,
                           boolean strong,
                           java.lang.String stylename)

Print Html Hyper Link.

Parameters:

link - String name of the file.

where - Position of the link in the file. Character '#' is not needed.

label - Tag for the link.

strong - Boolean that sets label to strong.

stylename - String style of text defined in style sheet.

getHyperLink

public java.lang.String getHyperLink(java.lang.String link,
                                     java.lang.String where,
                                     java.lang.String label,
                                     boolean strong)

Return Html Hyper Link string.

Parameters:

link - String name of the file.

where - Position of the link in the file. Character '#' is not needed.

label - Tag for the link.

strong - Boolean that sets label to strong.

Returns:

String Hyper Link.

getHyperLink

public java.lang.String getHyperLink(java.lang.String link,
                                     java.lang.String where,
                                     java.lang.String label,
                                     boolean strong,
                                     java.lang.String stylename)

Get Html Hyper Link string.

Parameters:

link - String name of the file.

where - Position of the link in the file. Character '#' is not needed.

label - Tag for the link.

strong - Boolean that sets label to strong.

stylename - String style of text defined in style sheet.

Returns:

String Hyper Link.

getHyperLink

public java.lang.String getHyperLink(java.lang.String link,
                                     java.lang.String where,
                                     java.lang.String label,
                                     boolean strong,
                                     java.lang.String stylename,
                                     java.lang.String title,
                                     java.lang.String target)

Get Html Hyper Link string.

Parameters:

link - String name of the file.

where - Position of the link in the file. Character '#' is not needed.

label - Tag for the link.

strong - Boolean that sets label to strong.

stylename - String style of text defined in style sheet.

title - String that describes the link's content for accessibility.

target - Target frame.

Returns:

String Hyper Link.

printHyperLink

public void printHyperLink(java.lang.String link,
                           java.lang.String label)

Print link without positioning in the file.

Parameters:

link - String name of the file.

label - Tag for the link.

getHyperLink

public java.lang.String getHyperLink(java.lang.String link,
                                     java.lang.String label)

Get link string without positioning in the file.

Parameters:

link - String name of the file.

label - Tag for the link.

Returns:

Strign Hyper link.

printPkgName

public void printPkgName(ClassDoc cd)

Print the name of the package, this class is in.

Parameters:

cd - ClassDoc.

getPkgName

public java.lang.String getPkgName(ClassDoc cd)

Get the name of the package, this class is in.

Parameters:

cd - ClassDoc.

printFramesetHeader

public void printFramesetHeader(java.lang.String title)

Print the frameset version of the Html file header. Called only when generating an HTML frameset file.

Parameters:

title - Title of this HTML document.

printFramesetHeader

public void printFramesetHeader(java.lang.String title,
                                boolean noTimeStamp)

Print the frameset version of the Html file header. Called only when generating an HTML frameset file.

Parameters:

title - Title of this HTML document.

noTimeStamp - If true, don't print time stamp in header.

spaces

public java.lang.String spaces(int len)

Print the appropriate spaces to format the class tree in the class page.

Parameters:

len - Number of spaces.

printBodyHtmlEnd

public void printBodyHtmlEnd()

Print the closing </body> and </html> tags.

printFooter

public void printFooter()

Calls printBodyHtmlEnd() method.

printFrameFooter

public void printFrameFooter()

Print closing </html> tag.

printNbsps

public void printNbsps()

Print ten non-breaking spaces("&nbsp;").

today

public java.lang.String today()

Get the day and date information for today, depending upon user option.

Returns:

String Today.

See Also:

Calendar, GregorianCalendar, TimeZone