org.multijava.mjdoc.mjdoc_142
Class MjdocAllClassesFrameWriter

java.lang.Object
  java.io.Writer
      java.io.PrintWriter
          com.sun.tools.doclets.HtmlWriter
              com.sun.tools.doclets.HtmlDocWriter
                  com.sun.tools.doclets.standard.HtmlStandardWriter
                      com.sun.tools.doclets.standard.AllClassesFrameWriter
                          org.multijava.mjdoc.mjdoc_142.MjdocAllClassesFrameWriter

All Implemented Interfaces:

Appendable, Closeable, Flushable

public class MjdocAllClassesFrameWriter

extends com.sun.tools.doclets.standard.AllClassesFrameWriter

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

Field Summary

 

Fields inherited from class com.sun.tools.doclets.standard.AllClassesFrameWriter

indexbuilder, OUTPUT_FILE_NAME_FRAMES, OUTPUT_FILE_NAME_NOFRAMES

 

Fields inherited from class com.sun.tools.doclets.standard.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

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

 

Method Summary
static void	generate(com.sun.tools.doclets.standard.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	printAllGF(Iterator i)           Print links for all the GFs.
protected  void	printAllGFTableHeader()           Print the heading "All Classes" and also print Html table tag.
void	printHeader(String title, String metakeywords)           Print the html file header.

 

Methods inherited from class com.sun.tools.doclets.standard.AllClassesFrameWriter

generateContents, printAllClasses, printAllClassesTableFooter, printAllClassesTableHeader

 

Methods inherited from class com.sun.tools.doclets.standard.HtmlStandardWriter

boldText, boldText, boldText, commentTagsToString, configuration, copyDocFiles, error, error, frame, frameEnd, frameSet, frameSetEnd, 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

append, append, append, append, append, append, append, append, append, checkError, clearError, 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

MjdocAllClassesFrameWriter

public MjdocAllClassesFrameWriter(com.sun.tools.doclets.standard.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

generate

public static void generate(com.sun.tools.doclets.standard.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.

generateAllClassesFile

protected void generateAllClassesFile(boolean wantFrames)
                               throws IOException

Print all the classes in table format in the file. Overridden in order to write a table of all the external functions.

Overrides:

generateAllClassesFile in class com.sun.tools.doclets.standard.AllClassesFrameWriter

Throws:

IOException

printAllGF

protected void printAllGF(Iterator i)

Print links for all the GFs.

printAllGFTableHeader

protected void printAllGFTableHeader()

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

printHeader

public void printHeader(String title,
                        String metakeywords)

Print the html file header. Also print Html page title and stylesheet default properties. Only overridden to change 'javadoc' to 'mjdoc'.

Parameters:

title - String title for the generated html file.