org.freehep.tools.doclet
Class HtmlStandardWriter

java.lang.Object
  java.io.Writer
      java.io.PrintWriter
          com.sun.tools.doclets.HtmlWriter
              com.sun.tools.doclets.HtmlDocWriter
                  org.freehep.tools.doclet.HtmlStandardWriter

Direct Known Subclasses:

AbstractIndexWriter, AbstractPackageIndexWriter, AbstractPackageWriter, AbstractTreeWriter, AllClassesFrameWriter, FrameOutputWriter, HelpWriter, PackageListWriter, PackagesFileWriter, StylesheetWriter, SubWriterHolderWriter

public class HtmlStandardWriter

extends com.sun.tools.doclets.HtmlDocWriter

Class for the Html Format Code Generation specific to JavaDoc. This Class contains methods related to the Html Code Generation which are used extensively while generating the entire documentation.

Since:

JDK1.2

Author:

Atul M Dambalkar, Robert Field

Source Code:

HtmlStandardWriter.java

Field Summary

String	backpath Relative path from the destination directory to the current directory.
ConfigurationStandard	configuration The global configuration information for this run.
int	displayLength The display length used for indentation while generating the class page.
static String	DOC_FILES_DIR_NAME The name of the doc files directory.
String	filename Name of the file getting generated.
String	path Platform-dependent directory path from the current or the destination directory to the file getting generated.
String	relativepath Relative path from the file getting generated to the destination directory.
String	relativepathNoSlash Same as relativepath, but normalized to never be empty or end with a slash.

Fields inherited from class com.sun.tools.doclets.HtmlWriter

fileseparator, htmlFilename, winTitle

Fields inherited from class java.io.PrintWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

HtmlStandardWriter(ConfigurationStandard configuration, String filename)
Constructor to construct the HtmlStandardWriter object.

HtmlStandardWriter(ConfigurationStandard configuration, String path, String filename, String relativepath)
Constructor to construct the HtmlStandardWriter object.

Method Summary

void	boldText(String key)
void	boldText(String key, String a1)
void	boldText(String key, String a1, String a2)
String	commentTagsToString(com.sun.javadoc.Doc doc, com.sun.javadoc.Tag[] tags, boolean depr, boolean first) Converts inline tags and text to text strings, expanding the inline tags along the way.
com.sun.tools.doclets.Configuration	configuration()
static void	copyDocFiles(ConfigurationStandard configuration, String srcDirName, String path, boolean overwrite) Copy the given directory contents from the source package directory to the generated documentation directory.
void	error(com.sun.javadoc.SourcePosition pos, String key, String a1)
void	error(com.sun.javadoc.SourcePosition pos, String key, String a1, String a2)
void	frame(String arg) Print Html tag <FRAME=arg>.
void	frameEnd() Print Html closing tag </FRAME>.
void	frameSet(String arg) Print Html tag <FRAMESET=arg>.
void	frameSetEnd() Print Html closing tag </FRAMESET>.
void	generateTagInfo(com.sun.javadoc.Doc doc)
void	generateTagInfo(com.sun.javadoc.Doc doc, String path) Print tag information
String	getClassLink(com.sun.javadoc.ClassDoc cd)
String	getClassLink(com.sun.javadoc.ClassDoc cd, boolean bold)
String	getClassLink(com.sun.javadoc.ClassDoc cd, String label)
String	getClassLink(com.sun.javadoc.ClassDoc cd, String where, String label)
String	getClassLink(com.sun.javadoc.ClassDoc cd, String where, String label, boolean bold)
String	getClassLink(com.sun.javadoc.ClassDoc cd, String where, String label, boolean bold, String color, String target)
String	getCrossClassLink(String qualifiedClassName, String refMemName, String label, boolean bold, String style, boolean code) Return a class cross link to external class documentation.
String	getCrossPackageLink(String pkgName)
String	getDocLink(com.sun.javadoc.Doc doc, String label)
String	getDocLink(com.sun.javadoc.Doc doc, String label, boolean bold)
String	getPackageLink(com.sun.javadoc.PackageDoc pkg) Get link for individual package file.
String	getPackageLink(com.sun.javadoc.PackageDoc pkg, boolean bold)
String	getPackageLink(com.sun.javadoc.PackageDoc pkg, String label)
String	getPackageLink(com.sun.javadoc.PackageDoc pkg, String linklabel, boolean bold)
String	getPreQualifiedClassLink(com.sun.javadoc.ClassDoc cd)
String	getPreQualifiedClassLink(com.sun.javadoc.ClassDoc cd, boolean bold)
String	getQualifiedClassLink(com.sun.javadoc.ClassDoc cd)
protected static String	getSourcePath(com.sun.tools.doclets.Configuration configuration, com.sun.javadoc.PackageDoc pkgDoc) Given a PackageDoc, return the source path for that package.
String	getText(String key)
String	getText(String key, String a1)
String	getText(String key, String a1, String a2)
String	getText(String key, String a1, String a2, String a3)
boolean	isCoreClass(com.sun.javadoc.ClassDoc cd) According to the Java Language Specifications, all the outer classes and static nested classes are core classes.
boolean	isCrossClassIncluded(com.sun.javadoc.ClassDoc cd)
boolean	isGeneratedDoc(com.sun.javadoc.Doc doc) Return true if the doc element is getting documented, depending upon -nodeprecated option and @deprecated tag used.
String	italicsClassName(com.sun.javadoc.ClassDoc cd, boolean qual)
com.sun.tools.doclets.MessageRetriever	msg(boolean checkVersion) If checkVersion is true, print the version number before return the MessageRetriever.
protected void	navCellEnd() Closing tag for navigation bar cell.
protected void	navCellRevStart() Description for a cell in the navigation bar, but with reverse high-light effect.
protected void	navCellStart() Description for a cell in the navigation bar.
protected void	navDetail() Print the word "Detail" in the navigation bar.
protected void	navHideLists() Print "NO FRAMES" link, to switch to the non-frame version of the output.
protected void	navHideLists(String link) Print "NO FRAMES" link, to switch to the non-frame version of the output.
protected void	navLinkClass() Print the word "Class" in the navigation bar cell, to indicate that class link is not available.
protected void	navLinkClassIndex() Print link for generated index.
protected void	navLinkClassUse() Print the word "Use" in the navigation bar cell, to indicate that link is not available.
protected void	navLinkContents() Print link to the "overview-summary.html" page.
protected void	navLinkDeprecated() Print "Deprecated" API link in the navigation bar.
protected void	navLinkHelp() Print help file link.
protected void	navLinkIndex() Print link for generated class index.
protected void	navLinkMainTree(String label) Print "Tree" link to the "overview-tree.html" file.
protected void	navLinkNext() Print the word "NEXT" to indicate that no link is available.
void	navLinkNext(String next) Print link for next file.
protected void	navLinkPackage() Print the word "Package" in the navigation bar cell, to indicate that link is not available here.
protected void	navLinkPackage(com.sun.javadoc.PackageDoc pkg) Print link to the "package-summary.html" page for the package passed.
protected void	navLinkPrevious() Print the word "PREV" to indicate that no link is available.
void	navLinkPrevious(String prev) Print link for previous file.
protected void	navLinks(boolean header) Print the navigation bar for the Html page at the top and and the bottom.
protected void	navLinkTree() Print "Tree" link in the navigation bar.
protected void	navShowLists() Print "FRAMES" link, to switch to the frame version of the output.
protected void	navShowLists(String link) Print "FRAMES" link, to switch to the frame version of the output.
protected void	navSummary() Print the word "Summary" in the navigation bar.
void	notice(com.sun.javadoc.SourcePosition pos, String key, String a1)
void	notice(com.sun.javadoc.SourcePosition pos, String key, String a1, String a2)
protected String	pathString(com.sun.javadoc.ClassDoc cd, String name) Return the path to the class page for a classdoc.
protected String	pathString(com.sun.javadoc.PackageDoc pd, String name) Return path to the given file name in the given package.
protected String	pathToClass(com.sun.javadoc.ClassDoc cd) Return path to the class page for a classdoc.
void	printBoldTargetHyperLink(String link, String target, String label) Print bold Html Hyper Link, with target frame.
void	printBottom() Print the user specified bottom.
void	printClassLink(com.sun.javadoc.ClassDoc cd)
void	printClassLink(com.sun.javadoc.ClassDoc cd, boolean bold)
void	printClassLink(com.sun.javadoc.ClassDoc cd, String label)
void	printClassLink(com.sun.javadoc.ClassDoc cd, String label, boolean bold)
void	printClassLink(com.sun.javadoc.ClassDoc cd, String where, String label)
void	printClassLink(com.sun.javadoc.ClassDoc cd, String where, String label, boolean bold)
void	printClassLink(com.sun.javadoc.ClassDoc cd, String where, String label, boolean bold, String color)
void	printDocLink(com.sun.javadoc.Doc doc, String label)
void	printDocLink(com.sun.javadoc.Doc doc, String label, boolean bold) Print link for any doc element.
void	printHtmlHeader(String title) Print the html file header using no keywords for the META tag.
void	printHtmlHeader(String title, String[] metakeywords) Print the html file header.
void	printHtmlHeader(String title, String[] metakeywords, boolean includeScript) Print the html file header.
void	printIndexHeading(String str) Print the heading in Html <H2> format.
void	printInlineComment(com.sun.javadoc.Doc doc)
void	printInlineComment(com.sun.javadoc.Doc doc, com.sun.javadoc.Tag tag)
void	printInlineDeprecatedComment(com.sun.javadoc.Doc doc)
void	printInlineDeprecatedComment(com.sun.javadoc.Doc doc, com.sun.javadoc.Tag tag)
void	printNoFramesBoldTargetHyperLink(String link, String target, String label) Print bold Html Hyper Link, with target frame.
void	printNoFramesTargetHyperLink(String link, String where, String target, String label, boolean bold) Get Html Hyper Link, with target frame.
void	printPackageLink(com.sun.javadoc.PackageDoc pkg) Print link to the "pacakge-summary.html" file, depending upon the package name.
void	printPackageLink(com.sun.javadoc.PackageDoc pkg, boolean bold)
void	printPackageLink(com.sun.javadoc.PackageDoc pkg, String linklabel)
void	printPreQualifiedBoldClassLink(com.sun.javadoc.ClassDoc cd) Print Class link, with only class name as the bold link and prefixing plain package name.
void	printPreQualifiedClassLink(com.sun.javadoc.ClassDoc cd) Print Class link, with only class name as the link and prefixing plain package name.
void	printQualifiedClassLink(com.sun.javadoc.ClassDoc cd)
void	printSinceTag(com.sun.javadoc.Doc doc)
void	printSrcLink(com.sun.javadoc.ProgramElementDoc d, String label)
void	printStyleSheetProperties()
void	printSummaryComment(com.sun.javadoc.Doc doc)
void	printSummaryDeprecatedComment(com.sun.javadoc.Doc doc)
void	printSummaryDeprecatedComment(com.sun.javadoc.Doc doc, com.sun.javadoc.Tag tag)
protected void	printSummaryDetailLinks() Do nothing.
void	printTargetClassLink(com.sun.javadoc.ClassDoc cd, String target) Print Class link, with target frame.
void	printTargetHyperLink(String link, String target, String label) Print Html Hyper Link, with target frame.
void	printTargetHyperLink(String link, String target, String label, boolean bold) Print Html Hyper Link, with target frame.
void	printTargetHyperLink(String link, String where, String target, String label, boolean bold, String title) Print Html Hyper Link, with target frame.
void	printTargetPackageLink(com.sun.javadoc.PackageDoc pd, String target, String label) Print Package link, with target frame.
void	printText(String key)
void	printText(String key, String a1)
void	printText(String key, String a1, String a2)
void	printUserHeaderFooter(boolean header) Print user specified header and the footer.
String	removeNonInlineHtmlTags(String text)
String	replace(String text, String tobe, String by)
String	replaceDocRootDir(String htmlstr) Replace {@docRoot} tag used in options that accept HTML text, such as -header, -footer and -bottom, and when converting a relative HREF where commentTagsToString inserts a {@docRoot} where one was missing.
String	replaceInheritDoc(com.sun.javadoc.MethodDoc md, com.sun.javadoc.Tag tag, String text) Given a MethodDoc item, a Tag in the MethodDoc item and a String, replace all occurances of @inheritDoc with documentation from it's superclass or superinterface.
String	seeTagToString(com.sun.javadoc.SeeTag see)
static boolean	serialClassInclude(com.sun.javadoc.ClassDoc cd)
static boolean	serialDocInclude(com.sun.javadoc.Doc doc)
static boolean	serialInclude(com.sun.javadoc.Doc doc)
void	summaryRow(int width) Print the summary table row cell attribute width.
void	summaryRowEnd() Print the summary table row cell end tag.
void	tableHeaderEnd() Print table header end tags for font, column and row.
void	tableHeaderStart() Print table header with default column span 2 and default color #CCCCFF.
void	tableHeaderStart(int span) Print table header with the column span, with the default color #CCCCFF.
void	tableHeaderStart(String color) Print table header with the background color with default column span 2.
void	tableHeaderStart(String color, int span) Prine table header information about color, column span and the font.
void	tableIndexDetail() Same as tableIndexSummary().
void	tableIndexSummary() Print the Html table tag for the index summary tables.
void	tableInheritedHeaderEnd() Print table header end tags in inherited tables for column and row.
void	tableInheritedHeaderStart(String color) Print table header for the inherited members summary tables.
void	tableUseInfoHeaderStart(String color) Print "Use" table header.
void	tdIndex() Print Html tag for table elements.
void	warning(com.sun.javadoc.SourcePosition pos, String key, String a1)
void	warning(com.sun.javadoc.SourcePosition pos, String key, String a1, String a2)
void	warning(com.sun.javadoc.SourcePosition pos, String key, String a1, String a2, String a3)

Methods inherited from class com.sun.tools.doclets.HtmlDocWriter

getHyperLink, getHyperLink, getHyperLink, getHyperLink, getPkgName, printBodyHtmlEnd, printFooter, printFrameFooter, printFramesetHeader, printFramesetHeader, printHyperLink, printHyperLink, printHyperLink, printHyperLink, printNbsps, printPkgName, spaces, today

Methods inherited from class com.sun.tools.doclets.HtmlWriter

address, addressEnd, aEnd, aName, anchor, anchor, blockquote, blockquoteEnd, body, bodyEnd, bold, bold, boldEnd, br, center, centerEnd, code, codeEnd, codeText, commentEnd, commentStart, dd, ddEnd, dl, dlEnd, dt, em, emEnd, font, fontEnd, fontSizeStyle, fontStyle, genWriter, getBold, getBoldEnd, getCode, getCodeEnd, getFontColor, getFontEnd, 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, p, pEnd, pre, preEnd, printWinTitleScript, script, scriptEnd, space, sup, supEnd, table, table, table, table, tableEnd, td, tdAlign, tdAlignRowspan, tdAlignVAlign, tdAlignVAlignRowspan, tdBgcolorStyle, tdColspan, tdColspanBgcolorStyle, tdEnd, tdNowrap, tdVAlign, tdVAlignClass, tdWidth, title, title, titleEnd, tr, trAlignVAlign, trBgcolor, trBgcolorStyle, trEnd, ul, ulEnd

Methods inherited from class java.io.PrintWriter

checkError, close, flush, print, print, print, print, print, print, print, print, print, 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

Field Detail

relativepath

public String relativepath

Relative path from the file getting generated to the destination directory. For example, if the file getting generated is "java/lang/Object.html", then the relative path string is "../../". This string can be empty if the file getting generated is in the destination directory.

relativepathNoSlash

public String relativepathNoSlash

Same as relativepath, but normalized to never be empty or end with a slash.

path

public String path

Platform-dependent directory path from the current or the destination directory to the file getting generated. Used when creating the file. For example, if the file getting generated is "java/lang/Object.html", then the path string is "java/lang".

filename

public String filename

Name of the file getting generated. If the file getting generated is "java/lang/Object.html", then the filename is "Object.html".

backpath

public final String backpath

Relative path from the destination directory to the current directory. For example if the destination directory is "core/api/docs", then the backpath string will be "../../".

displayLength

public int displayLength

The display length used for indentation while generating the class page.

configuration

public ConfigurationStandard configuration

The global configuration information for this run.

DOC_FILES_DIR_NAME

public static final String DOC_FILES_DIR_NAME

The name of the doc files directory.

See Also:

Constant Field Values

Constructor Detail

HtmlStandardWriter

public HtmlStandardWriter(ConfigurationStandard configuration,
                          String filename)
                   throws IOException

Constructor to construct the HtmlStandardWriter object.

Parameters:

filename - File to be generated.

HtmlStandardWriter

public HtmlStandardWriter(ConfigurationStandard configuration,
                          String path,
                          String filename,
                          String relativepath)
                   throws IOException

Constructor to construct the HtmlStandardWriter object.

Parameters:

path - Platform-dependent path used when creating file.

filename - Name of file to be generated.

relativepath - Value for the variable relativepath.

Method Detail

copyDocFiles

public static void copyDocFiles(ConfigurationStandard configuration,
                                String srcDirName,
                                String path,
                                boolean overwrite)

Copy the given directory contents from the source package directory to the generated documentation directory. For example for a package java.lang this method find out the source location of the package using SourcePath and if given directory is found in the source directory structure, copy the entire directory, to the generated documentation hierarchy.

Parameters:

srcDirName - The original directory to copy from.

path - The relative path to the directory to be copied.

overwrite - Overwrite files if true.

Throws:

com.sun.tools.doclets.DocletAbortException

getSourcePath

protected static String getSourcePath(com.sun.tools.doclets.Configuration configuration,
                                      com.sun.javadoc.PackageDoc pkgDoc)

Given a PackageDoc, return the source path for that package.

Parameters:

pkgDoc - The package to seach the path for.

Returns:

A string representing the path to the given package.

replaceDocRootDir

public String replaceDocRootDir(String htmlstr)

Replace {@docRoot} tag used in options that accept HTML text, such as -header, -footer and -bottom, and when converting a relative HREF where commentTagsToString inserts a {@docRoot} where one was missing. (Also see DocRootTaglet for {@docRoot} tags in doc comments.)

Replace {@docRoot} tag in htmlstr with the relative path to the destination directory from the directory where the file is being written, looping to handle all such tags in htmlstr.

For example, for "-d docs" and -header containing {@docRoot}, when the HTML page for source file p/C1.java is being generated, the {@docRoot} tag would be inserted into the header as "../", the relative path from docs/p/ to docs/ (the document root).

Note: This doc comment was written with '@' representing '@' to prevent the inline tag from being interpreted.

printTargetHyperLink

public void printTargetHyperLink(String link,
                                 String where,
                                 String target,
                                 String label,
                                 boolean bold,
                                 String title)

Print Html Hyper Link, with target frame.

Parameters:

link - String name of the file.

where - Position in the file

target - Name of the target frame.

label - Tag for the link.

bold - Whether the label should be bold or not?

printNoFramesTargetHyperLink

public void printNoFramesTargetHyperLink(String link,
                                         String where,
                                         String target,
                                         String label,
                                         boolean bold)

Get Html Hyper Link, with target frame. This link will only appear if page is not in a frame.

Parameters:

link - String name of the file.

where - Position in the file

target - Name of the target frame.

label - Tag for the link.

bold - Whether the label should be bold or not?

printTargetHyperLink

public void printTargetHyperLink(String link,
                                 String target,
                                 String label,
                                 boolean bold)

Print Html Hyper Link, with target frame.

Parameters:

link - String name of the file.

target - Name of the target frame.

label - Tag for the link.

bold - Whether the label should be bold or not?

printBoldTargetHyperLink

public void printBoldTargetHyperLink(String link,
                                     String target,
                                     String label)

Print bold Html Hyper Link, with target frame. The label will be bold.

Parameters:

link - String name of the file.

target - Name of the target frame.

label - Tag for the link.

printNoFramesBoldTargetHyperLink

public void printNoFramesBoldTargetHyperLink(String link,
                                             String target,
                                             String label)

Print bold Html Hyper Link, with target frame. The label will be bold and the link will only show up if the page is not in a frame.

Parameters:

link - String name of the file.

target - Name of the target frame.

label - Tag for the link.

printTargetHyperLink

public void printTargetHyperLink(String link,
                                 String target,
                                 String label)

Print Html Hyper Link, with target frame.

Parameters:

link - String name of the file.

target - Name of the target frame.

label - Tag for the link.

printTargetClassLink

public void printTargetClassLink(com.sun.javadoc.ClassDoc cd,
                                 String target)

Print Class link, with target frame.

Parameters:

cd - The class to which link is.

target - Name of the target frame.

printTargetPackageLink

public void printTargetPackageLink(com.sun.javadoc.PackageDoc pd,
                                   String target,
                                   String label)

Print Package link, with target frame.

Parameters:

pd - The link will be to the "package-summary.html" page for this package.

target - Name of the target frame.

label - Tag for the link.

printHtmlHeader

public void printHtmlHeader(String title)

Print the html file header using no keywords for the META tag.

Parameters:

title - String title for the generated html file.

printHtmlHeader

public void printHtmlHeader(String title,
                            String[] metakeywords)

Print the html file header. Also print Html page title and stylesheet default properties.

Parameters:

title - String window title to go in the <TITLE> tag

metakeywords - Array of String keywords for META tag. Each element of the array is assigned to a separate META tag. Pass in null for no array.

printHtmlHeader

public void printHtmlHeader(String title,
                            String[] metakeywords,
                            boolean includeScript)

Print the html file header. Also print Html page title and stylesheet default properties.

Parameters:

title - String window title to go in the <TITLE> tag

metakeywords - Array of String keywords for META tag. Each element of the array is assigned to a separate META tag. Pass in null for no array.

includeScript - boolean true if printing windowtitle script. False for files that appear in the left-hand frames.

printUserHeaderFooter

public void printUserHeaderFooter(boolean header)

Print user specified header and the footer.

Parameters:

header - if true print the user provided header else print the user provided footer.

printBottom

public void printBottom()

Print the user specified bottom.

navLinks

protected void navLinks(boolean header)

Print the navigation bar for the Html page at the top and and the bottom.

Parameters:

header - If true print navigation bar at the top of the page else print the nevigation bar at the bottom.

printSummaryDetailLinks

protected void printSummaryDetailLinks()

Do nothing. This is the default method.

navLinkContents

protected void navLinkContents()

Print link to the "overview-summary.html" page.

navCellStart

protected void navCellStart()

Description for a cell in the navigation bar.

navCellRevStart

protected void navCellRevStart()

Description for a cell in the navigation bar, but with reverse high-light effect.

navCellEnd

protected void navCellEnd()

Closing tag for navigation bar cell.

navLinkPackage

protected void navLinkPackage(com.sun.javadoc.PackageDoc pkg)

Print link to the "package-summary.html" page for the package passed.

Parameters:

pkg - Package to which link will be generated.

navLinkPackage

protected void navLinkPackage()

Print the word "Package" in the navigation bar cell, to indicate that link is not available here.

navLinkClassUse

protected void navLinkClassUse()

Print the word "Use" in the navigation bar cell, to indicate that link is not available.

navLinkPrevious

public void navLinkPrevious(String prev)

Print link for previous file.

Parameters:

prev - File name for the prev link.

navLinkPrevious

protected void navLinkPrevious()

Print the word "PREV" to indicate that no link is available.

navLinkNext

public void navLinkNext(String next)

Print link for next file.

Parameters:

next - File name for the next link.

navLinkNext

protected void navLinkNext()

Print the word "NEXT" to indicate that no link is available.

navShowLists

protected void navShowLists(String link)

Print "FRAMES" link, to switch to the frame version of the output.

Parameters:

link - File to be linked, "index.html".

navShowLists

protected void navShowLists()

Print "FRAMES" link, to switch to the frame version of the output.

navHideLists

protected void navHideLists(String link)

Print "NO FRAMES" link, to switch to the non-frame version of the output.

Parameters:

link - File to be linked.

navHideLists

protected void navHideLists()

Print "NO FRAMES" link, to switch to the non-frame version of the output.

navLinkTree

protected void navLinkTree()

Print "Tree" link in the navigation bar. If there is only one package specified on the command line, then the "Tree" link will be to the only "package-tree.html" file otherwise it will be to the "overview-tree.html" file.

navLinkMainTree

protected void navLinkMainTree(String label)

Print "Tree" link to the "overview-tree.html" file.

navLinkClass

protected void navLinkClass()

Print the word "Class" in the navigation bar cell, to indicate that class link is not available.

navLinkDeprecated

protected void navLinkDeprecated()

Print "Deprecated" API link in the navigation bar.

navLinkClassIndex

protected void navLinkClassIndex()

Print link for generated index. If the user has used "-splitindex" command line option, then link to file "index-files/index-1.html" is generated otherwise link to file "index-all.html" is generated.

navLinkIndex

protected void navLinkIndex()

Print link for generated class index.

navLinkHelp

protected void navLinkHelp()

Print help file link. If user has provided a help file, then generate a link to the user given file, which is already copied to current or destination directory.

navDetail

protected void navDetail()

Print the word "Detail" in the navigation bar. No link is available.

navSummary

protected void navSummary()

Print the word "Summary" in the navigation bar. No link is available.

tableIndexSummary

public void tableIndexSummary()

Print the Html table tag for the index summary tables. The table tag printed is <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">

tableIndexDetail

public void tableIndexDetail()

Same as tableIndexSummary().

tdIndex

public void tdIndex()

Print Html tag for table elements. The tag printed is <TD ALIGN="right" VALIGN="top" WIDTH="1%">.

tableHeaderStart

public void tableHeaderStart(String color,
                             int span)

Prine table header information about color, column span and the font.

Parameters:

color - Background color.

span - Column span.

tableInheritedHeaderStart

public void tableInheritedHeaderStart(String color)

Print table header for the inherited members summary tables. Print the background color information.

Parameters:

color - Background color.

tableUseInfoHeaderStart

public void tableUseInfoHeaderStart(String color)

Print "Use" table header. Print the background color and the column span.

Parameters:

color - Background color.

tableHeaderStart

public void tableHeaderStart(String color)

Print table header with the background color with default column span 2.

Parameters:

color - Background color.

tableHeaderStart

public void tableHeaderStart(int span)

Print table header with the column span, with the default color #CCCCFF.

Parameters:

span - Column span.

tableHeaderStart

public void tableHeaderStart()

Print table header with default column span 2 and default color #CCCCFF.

tableHeaderEnd

public void tableHeaderEnd()

Print table header end tags for font, column and row.

tableInheritedHeaderEnd

public void tableInheritedHeaderEnd()

Print table header end tags in inherited tables for column and row.

summaryRow

public void summaryRow(int width)

Print the summary table row cell attribute width.

Parameters:

width - Width of the table cell.

summaryRowEnd

public void summaryRowEnd()

Print the summary table row cell end tag.

printIndexHeading

public void printIndexHeading(String str)

Print the heading in Html <H2> format.

Parameters:

str - The Header string.

frameSet

public void frameSet(String arg)

Print Html tag <FRAMESET=arg>.

Parameters:

arg - Argument for the tag.

frameSetEnd

public void frameSetEnd()

Print Html closing tag </FRAMESET>.

frame

public void frame(String arg)

Print Html tag <FRAME=arg>.

Parameters:

arg - Argument for the tag.

frameEnd

public void frameEnd()

Print Html closing tag </FRAME>.

pathToClass

protected String pathToClass(com.sun.javadoc.ClassDoc cd)

Return path to the class page for a classdoc. For example, the class name is "java.lang.Object" and if the current file getting generated is "java/io/File.html", then the path string to the class, returned is "../../java/lang.Object.html".

Parameters:

cd - Class to which the path is requested.

pathString

protected String pathString(com.sun.javadoc.ClassDoc cd,
                            String name)

Return the path to the class page for a classdoc. Works same as pathToClass(ClassDoc).

Parameters:

cd - Class to which the path is requested.

name - Name of the file(doesn't include path).

pathString

protected String pathString(com.sun.javadoc.PackageDoc pd,
                            String name)

Return path to the given file name in the given package. So if the name passed is "Object.html" and the name of the package is "java.lang", and if the relative path is "../.." then returned string will be "../../java/lang/Object.html"

Parameters:

pd - Package in which the file name is assumed to be.

name - File name, to which path string is.

printPackageLink

public void printPackageLink(com.sun.javadoc.PackageDoc pkg)

Print link to the "pacakge-summary.html" file, depending upon the package name.

printPackageLink

public void printPackageLink(com.sun.javadoc.PackageDoc pkg,
                             boolean bold)

printPackageLink

public void printPackageLink(com.sun.javadoc.PackageDoc pkg,
                             String linklabel)

getPackageLink

public String getPackageLink(com.sun.javadoc.PackageDoc pkg)

Get link for individual package file.

getPackageLink

public String getPackageLink(com.sun.javadoc.PackageDoc pkg,
                             boolean bold)

getPackageLink

public String getPackageLink(com.sun.javadoc.PackageDoc pkg,
                             String label)

getPackageLink

public String getPackageLink(com.sun.javadoc.PackageDoc pkg,
                             String linklabel,
                             boolean bold)

italicsClassName

public String italicsClassName(com.sun.javadoc.ClassDoc cd,
                               boolean qual)

printSrcLink

public void printSrcLink(com.sun.javadoc.ProgramElementDoc d,
                         String label)

printClassLink

public void printClassLink(com.sun.javadoc.ClassDoc cd)

getClassLink

public String getClassLink(com.sun.javadoc.ClassDoc cd)

printClassLink

public void printClassLink(com.sun.javadoc.ClassDoc cd,
                           String label)

getClassLink

public String getClassLink(com.sun.javadoc.ClassDoc cd,
                           String label)

printClassLink

public void printClassLink(com.sun.javadoc.ClassDoc cd,
                           String where,
                           String label)

printClassLink

public void printClassLink(com.sun.javadoc.ClassDoc cd,
                           String label,
                           boolean bold)

printClassLink

public void printClassLink(com.sun.javadoc.ClassDoc cd,
                           String where,
                           String label,
                           boolean bold,
                           String color)

getClassLink

public String getClassLink(com.sun.javadoc.ClassDoc cd,
                           String where,
                           String label)

printClassLink

public void printClassLink(com.sun.javadoc.ClassDoc cd,
                           boolean bold)

getClassLink

public String getClassLink(com.sun.javadoc.ClassDoc cd,
                           boolean bold)

printClassLink

public void printClassLink(com.sun.javadoc.ClassDoc cd,
                           String where,
                           String label,
                           boolean bold)

getClassLink

public String getClassLink(com.sun.javadoc.ClassDoc cd,
                           String where,
                           String label,
                           boolean bold,
                           String color,
                           String target)

getClassLink

public String getClassLink(com.sun.javadoc.ClassDoc cd,
                           String where,
                           String label,
                           boolean bold)

getCrossClassLink

public String getCrossClassLink(String qualifiedClassName,
                                String refMemName,
                                String label,
                                boolean bold,
                                String style,
                                boolean code)

Return a class cross link to external class documentation. The name must be fully qualified to determine which package the class is in. The -link option does not allow users to link to external classes in the "default" package.

Parameters:

qualifiedClassName - the qualified name of the external class.

refMemName - the name of the member being referenced. This should be null or empty string if no member is being referenced.

label - the label for the external link.

bold - true if the link should be bold.

style - the style of the link.

code - true if the label should be code font.

isCrossClassIncluded

public boolean isCrossClassIncluded(com.sun.javadoc.ClassDoc cd)

getCrossPackageLink

public String getCrossPackageLink(String pkgName)

printQualifiedClassLink

public void printQualifiedClassLink(com.sun.javadoc.ClassDoc cd)

getQualifiedClassLink

public String getQualifiedClassLink(com.sun.javadoc.ClassDoc cd)

printPreQualifiedClassLink

public void printPreQualifiedClassLink(com.sun.javadoc.ClassDoc cd)

Print Class link, with only class name as the link and prefixing plain package name.

getPreQualifiedClassLink

public String getPreQualifiedClassLink(com.sun.javadoc.ClassDoc cd)

getPreQualifiedClassLink

public String getPreQualifiedClassLink(com.sun.javadoc.ClassDoc cd,
                                       boolean bold)

printPreQualifiedBoldClassLink

public void printPreQualifiedBoldClassLink(com.sun.javadoc.ClassDoc cd)

Print Class link, with only class name as the bold link and prefixing plain package name.

printText

public void printText(String key)

printText

public void printText(String key,
                      String a1)

printText

public void printText(String key,
                      String a1,
                      String a2)

boldText

public void boldText(String key)

boldText

public void boldText(String key,
                     String a1)

boldText

public void boldText(String key,
                     String a1,
                     String a2)

getText

public String getText(String key)

getText

public String getText(String key,
                      String a1)

getText

public String getText(String key,
                      String a1,
                      String a2)

getText

public String getText(String key,
                      String a1,
                      String a2,
                      String a3)

notice

public void notice(com.sun.javadoc.SourcePosition pos,
                   String key,
                   String a1)

notice

public void notice(com.sun.javadoc.SourcePosition pos,
                   String key,
                   String a1,
                   String a2)

warning

public void warning(com.sun.javadoc.SourcePosition pos,
                    String key,
                    String a1)

warning

public void warning(com.sun.javadoc.SourcePosition pos,
                    String key,
                    String a1,
                    String a2)

warning

public void warning(com.sun.javadoc.SourcePosition pos,
                    String key,
                    String a1,
                    String a2,
                    String a3)

error

public void error(com.sun.javadoc.SourcePosition pos,
                  String key,
                  String a1)

error

public void error(com.sun.javadoc.SourcePosition pos,
                  String key,
                  String a1,
                  String a2)

printDocLink

public void printDocLink(com.sun.javadoc.Doc doc,
                         String label,
                         boolean bold)

Print link for any doc element.

getDocLink

public String getDocLink(com.sun.javadoc.Doc doc,
                         String label,
                         boolean bold)

isGeneratedDoc

public boolean isGeneratedDoc(com.sun.javadoc.Doc doc)

Return true if the doc element is getting documented, depending upon -nodeprecated option and @deprecated tag used. Return true if -nodeprecated is not used or @deprecated tag is not used.

printDocLink

public void printDocLink(com.sun.javadoc.Doc doc,
                         String label)

getDocLink

public String getDocLink(com.sun.javadoc.Doc doc,
                         String label)

serialInclude

public static boolean serialInclude(com.sun.javadoc.Doc doc)

serialClassInclude

public static boolean serialClassInclude(com.sun.javadoc.ClassDoc cd)

serialDocInclude

public static boolean serialDocInclude(com.sun.javadoc.Doc doc)

seeTagToString

public String seeTagToString(com.sun.javadoc.SeeTag see)

generateTagInfo

public void generateTagInfo(com.sun.javadoc.Doc doc)

generateTagInfo

public void generateTagInfo(com.sun.javadoc.Doc doc,
                            String path)

Print tag information

printSinceTag

public void printSinceTag(com.sun.javadoc.Doc doc)

printInlineComment

public void printInlineComment(com.sun.javadoc.Doc doc,
                               com.sun.javadoc.Tag tag)

printInlineDeprecatedComment

public void printInlineDeprecatedComment(com.sun.javadoc.Doc doc,
                                         com.sun.javadoc.Tag tag)

printSummaryComment

public void printSummaryComment(com.sun.javadoc.Doc doc)

printSummaryDeprecatedComment

public void printSummaryDeprecatedComment(com.sun.javadoc.Doc doc)

printSummaryDeprecatedComment

public void printSummaryDeprecatedComment(com.sun.javadoc.Doc doc,
                                          com.sun.javadoc.Tag tag)

printInlineComment

public void printInlineComment(com.sun.javadoc.Doc doc)

printInlineDeprecatedComment

public void printInlineDeprecatedComment(com.sun.javadoc.Doc doc)

commentTagsToString

public String commentTagsToString(com.sun.javadoc.Doc doc,
                                  com.sun.javadoc.Tag[] tags,
                                  boolean depr,
                                  boolean first)

Converts inline tags and text to text strings, expanding the inline tags along the way. Called wherever text can contain an inline tag, such as in comments or in free-form text arguments to non-inline tags.

Parameters:

doc - specific doc where comment resides

tags - array of text tags and inline tags (often alternating) present in the text of interest for this doc

depr - true if deprecated comment (to format it differently)

first - true if text is first sentence

removeNonInlineHtmlTags

public String removeNonInlineHtmlTags(String text)

replace

public String replace(String text,
                      String tobe,
                      String by)

printStyleSheetProperties

public void printStyleSheetProperties()

isCoreClass

public boolean isCoreClass(com.sun.javadoc.ClassDoc cd)

According to the Java Language Specifications, all the outer classes and static nested classes are core classes.

configuration

public com.sun.tools.doclets.Configuration configuration()

msg

public com.sun.tools.doclets.MessageRetriever msg(boolean checkVersion)

If checkVersion is true, print the version number before return the MessageRetriever.

replaceInheritDoc

public String replaceInheritDoc(com.sun.javadoc.MethodDoc md,
                                com.sun.javadoc.Tag tag,
                                String text)

Given a MethodDoc item, a Tag in the MethodDoc item and a String, replace all occurances of @inheritDoc with documentation from it's superclass or superinterface.