org.freehep.tools.doclet
Class AllClassesFrameWriter

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

public class AllClassesFrameWriter

extends HtmlStandardWriter

Generate the file with list of all the classes in this run. This page will be used in the left-hand bottom frame, when "All Classes" link is clicked in the left-hand top frame. The name of the generated file is "allclasses-frame.html".

Author:

Atul M Dambalkar, Doug Kramer

Source Code:

AllClassesFrameWriter.java

Field Summary

protected com.sun.tools.doclets.IndexBuilder	indexbuilder Index of all the classes.
static String	OUTPUT_FILE_NAME_FRAMES The name of the output file with frames
static String	OUTPUT_FILE_NAME_NOFRAMES The name of the output file without frames

Fields inherited from class org.freehep.tools.doclet.HtmlStandardWriter

backpath, configuration, displayLength, DOC_FILES_DIR_NAME, filename, path, relativepath, relativepathNoSlash

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

AllClassesFrameWriter(ConfigurationStandard configuration, String filename, com.sun.tools.doclets.IndexBuilder indexbuilder)
Construct AllClassesFrameWriter object.

Method Summary

static void	generate(ConfigurationStandard configuration, com.sun.tools.doclets.IndexBuilder indexbuilder) Create AllClassesFrameWriter object.
protected void	generateAllClassesFile(boolean wantFrames) Print all the classes in table format in the file.
protected void	generateContents(List classlist, boolean wantFrames) Given a list of classes, generate links for each class or interface.
protected void	printAllClasses(boolean wantFrames) Use the sorted index of all the classes and print all the classes.
protected void	printAllClassesTableFooter() Print Html closing table tag.
protected void	printAllClassesTableHeader() Print the heading "All Classes" and also print Html table tag.

Methods inherited from class org.freehep.tools.doclet.HtmlStandardWriter

boldText, boldText, boldText, commentTagsToString, configuration, copyDocFiles, error, error, frame, frameEnd, frameSet, frameSetEnd, generateTagInfo, generateTagInfo, getClassLink, getClassLink, getClassLink, getClassLink, getClassLink, getClassLink, getCrossClassLink, getCrossPackageLink, getDocLink, getDocLink, getPackageLink, getPackageLink, getPackageLink, getPackageLink, getPreQualifiedClassLink, getPreQualifiedClassLink, getQualifiedClassLink, getSourcePath, getText, getText, getText, getText, isCoreClass, isCrossClassIncluded, isGeneratedDoc, italicsClassName, msg, navCellEnd, navCellRevStart, navCellStart, navDetail, navHideLists, navHideLists, navLinkClass, navLinkClassIndex, navLinkClassUse, navLinkContents, navLinkDeprecated, navLinkHelp, navLinkIndex, navLinkMainTree, navLinkNext, navLinkNext, navLinkPackage, navLinkPackage, navLinkPrevious, navLinkPrevious, navLinks, navLinkTree, navShowLists, navShowLists, navSummary, notice, notice, pathString, pathString, pathToClass, printBoldTargetHyperLink, printBottom, printClassLink, printClassLink, printClassLink, printClassLink, printClassLink, printClassLink, printClassLink, printDocLink, printDocLink, printHtmlHeader, printHtmlHeader, printHtmlHeader, printIndexHeading, printInlineComment, printInlineComment, printInlineDeprecatedComment, printInlineDeprecatedComment, printNoFramesBoldTargetHyperLink, printNoFramesTargetHyperLink, printPackageLink, printPackageLink, printPackageLink, printPreQualifiedBoldClassLink, printPreQualifiedClassLink, printQualifiedClassLink, printSinceTag, printSrcLink, printStyleSheetProperties, printSummaryComment, printSummaryDeprecatedComment, printSummaryDeprecatedComment, printSummaryDetailLinks, printTargetClassLink, printTargetHyperLink, printTargetHyperLink, printTargetHyperLink, printTargetPackageLink, printText, printText, printText, printUserHeaderFooter, removeNonInlineHtmlTags, replace, replaceDocRootDir, replaceInheritDoc, seeTagToString, serialClassInclude, serialDocInclude, serialInclude, summaryRow, summaryRowEnd, tableHeaderEnd, tableHeaderStart, tableHeaderStart, tableHeaderStart, tableHeaderStart, tableIndexDetail, tableIndexSummary, tableInheritedHeaderEnd, tableInheritedHeaderStart, tableUseInfoHeaderStart, tdIndex, warning, warning, warning

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

OUTPUT_FILE_NAME_FRAMES

public static final String OUTPUT_FILE_NAME_FRAMES

The name of the output file with frames

See Also:

Constant Field Values

OUTPUT_FILE_NAME_NOFRAMES

public static final String OUTPUT_FILE_NAME_NOFRAMES

The name of the output file without frames

See Also:

Constant Field Values

indexbuilder

protected com.sun.tools.doclets.IndexBuilder indexbuilder

Index of all the classes.

Constructor Detail

AllClassesFrameWriter

public AllClassesFrameWriter(ConfigurationStandard configuration,
                             String filename,
                             com.sun.tools.doclets.IndexBuilder indexbuilder)
                      throws IOException

Construct AllClassesFrameWriter object. Also initilises the indexbuilder variable in this class.

Throws:

IOException

com.sun.tools.doclets.DocletAbortException

Method Detail

generate

public static void generate(ConfigurationStandard configuration,
                            com.sun.tools.doclets.IndexBuilder indexbuilder)

Create AllClassesFrameWriter object. Then use it to generate the "allclasses-frame.html" file. Generate the file in the current or the destination directory.

Parameters:

indexbuilder - IndexBuilder object for all classes index.

Throws:

com.sun.tools.doclets.DocletAbortException

generateAllClassesFile

protected void generateAllClassesFile(boolean wantFrames)
                               throws IOException

Print all the classes in table format in the file.

Parameters:

wantFrames - True if we want frames.

Throws:

IOException

printAllClasses

protected void printAllClasses(boolean wantFrames)

Use the sorted index of all the classes and print all the classes.

Parameters:

wantFrames - True if we want frames.

generateContents

protected void generateContents(List classlist,
                                boolean wantFrames)

Given a list of classes, generate links for each class or interface. If the class kind is interface, print it in the italics font. Also all links should target the right-hand frame. If clicked on any class name in this page, appropriate class page should get opened in the right-hand frame.

Parameters:

classlist - Sorted list of classes.

wantFrames - True if we want frames.

printAllClassesTableHeader

protected void printAllClassesTableHeader()

Print the heading "All Classes" and also print Html table tag.

printAllClassesTableFooter

protected void printAllClassesTableFooter()

Print Html closing table tag.