com.sun.tools.doclets.formats.html
Class FrameOutputWriter

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
                  com.sun.tools.doclets.formats.html.HtmlDocletWriter
                      com.sun.tools.doclets.formats.html.FrameOutputWriter

All Implemented Interfaces:

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

public class FrameOutputWriter
extends HtmlDocletWriter

Generate the documentation in the Html "frame" format in the browser. The generated documentation will have two or three frames depending upon the number of packages on the command line. In general there will be three frames in the output, a left-hand top frame will have a list of all packages with links to target left-hand bottom frame. The left-hand bottom frame will have the particular package contents or the all-classes list, where as the single right-hand frame will have overview or package summary or class file. Also take care of browsers which do not support Html frames.

Field Summary

(package private) int

noOfPackages Number of packages specified on the command line.

Fields inherited from class com.sun.tools.doclets.formats.html.HtmlDocletWriter

configuration, displayLength, filename, path, relativePath, relativepathNoSlash

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

fileseparator, htmlFilename, winTitle

Fields inherited from class java.io.PrintWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

FrameOutputWriter(ConfigurationImpl configuration, java.lang.String filename)
Constructor to construct FrameOutputWriter object.

Method Summary

static void	generate(ConfigurationImpl configuration) Construct FrameOutputWriter object and then use it to generate the Html file which will have the description of all the frames in the documentation.
protected void	generateFrameFile() Generate the contants in the "index.html" file.
private void	printAllClassesFrameTag() Print the FRAME tag for the frame that lists all classes
private void	printAllPackagesFrameTag() Print the FRAME tag for the frame that lists all packages
private void	printClassFrameTag() Print the FRAME tag for the frame that describes the class in detail
protected void	printFrameDetails() Print the frame sizes and their contents.
protected void	printFrameWarning() Generate the code for issueing the warning for a non-frame capable web client.

Methods inherited from class com.sun.tools.doclets.formats.html.HtmlDocletWriter

anchor, commentTagsToString, configuration, frame, frameEnd, frameSet, frameSetEnd, getAnchor, getCrossClassLink, getCrossPackageLink, getDocLink, getDocLink, getLink, getPackageLink, getPackageLink, getPreQualifiedClassLink, getTagletWriterInstance, getTypeParameterLinks, isClassLinkable, isCoreClass, italicsClassName, navCellEnd, navCellRevStart, navCellStart, navDetail, navHideLists, navLinkClass, navLinkClassIndex, navLinkClassUse, navLinkContents, navLinkDeprecated, navLinkHelp, navLinkIndex, navLinkMainTree, navLinkNext, navLinkNext, navLinkPackage, navLinkPackage, navLinkPrevious, navLinkPrevious, navLinks, navLinkTree, navShowLists, navShowLists, navSummary, pathString, pathString, pathToClass, printBottom, printDocLink, printDocLink, printHtmlHeader, printIndexHeading, printInlineComment, printInlineComment, printInlineDeprecatedComment, printInlineDeprecatedComment, printLink, printNoFramesTargetHyperLink, printPackageLink, printPackageLink, printPreQualifiedClassLink, printPreQualifiedStrongClassLink, printQualifiedClassLink, printSrcLink, printStyleSheetProperties, printSummaryComment, printSummaryComment, printSummaryDeprecatedComment, printSummaryDeprecatedComment, printSummaryDetailLinks, printTags, printTagsInfoFooter, printTagsInfoHeader, printTargetPackageLink, printText, printText, printText, printTop, printUserHeaderFooter, removeNonInlineHtmlTags, replace, replaceDocRootDir, seeTagToString, strongText, strongText, strongText, summaryRow, summaryRowEnd, tableHeaderEnd, tableHeaderStart, tableHeaderStart, tableHeaderStart, tableHeaderStart, tableIndexDetail, tableIndexSummary, tableInheritedHeaderEnd, tableInheritedHeaderStart, tableUseInfoHeaderStart, tdIndex, writeAnnotationInfo, writeAnnotationInfo, writeAnnotationInfo

Methods inherited from class com.sun.tools.doclets.formats.html.markup.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.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

Field Detail

noOfPackages

int noOfPackages

Number of packages specified on the command line.

Constructor Detail

FrameOutputWriter

public FrameOutputWriter(ConfigurationImpl configuration,
                         java.lang.String filename)
                  throws java.io.IOException

Constructor to construct FrameOutputWriter object.

Parameters:

filename - File to be generated.

Throws:

java.io.IOException

Method Detail

generate

public static void generate(ConfigurationImpl configuration)

Construct FrameOutputWriter object and then use it to generate the Html file which will have the description of all the frames in the documentation. The name of the generated file is "index.html" which is the default first file for Html documents.

Throws:

DocletAbortException

generateFrameFile

protected void generateFrameFile()

Generate the contants in the "index.html" file. Print the frame details as well as warning if browser is not supporting the Html frames.

printFrameWarning

protected void printFrameWarning()

Generate the code for issueing the warning for a non-frame capable web client. Also provide links to the non-frame version documentation.

printFrameDetails

protected void printFrameDetails()

Print the frame sizes and their contents.

printAllPackagesFrameTag

private void printAllPackagesFrameTag()

Print the FRAME tag for the frame that lists all packages

printAllClassesFrameTag

private void printAllClassesFrameTag()

Print the FRAME tag for the frame that lists all classes

printClassFrameTag

private void printClassFrameTag()

Print the FRAME tag for the frame that describes the class in detail