org.multijava.mjdoc.mjdoc_142
Class MjdocPackageFrameWriter

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.AbstractPackageWriter
                          com.sun.tools.doclets.standard.PackageFrameWriter
                              org.multijava.mjdoc.mjdoc_142.MjdocPackageFrameWriter

All Implemented Interfaces:

Appendable, Closeable, Flushable

public class MjdocPackageFrameWriter

extends com.sun.tools.doclets.standard.PackageFrameWriter

Class to generate file for each package contents in the left-hand bottom frame. This will list all the Class Kinds in the package. A click on any class-kind will update the right-hand frame with the clicked class-kind page.

Author:

Atul M Dambalkar

Field Summary
protected  com.sun.javadoc.PackageDoc	packagedoc

 

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

documentedClasses

 

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

MjdocPackageFrameWriter(com.sun.tools.doclets.standard.ConfigurationStandard configuration, String path, String filename, com.sun.javadoc.PackageDoc packagedoc)           Constructor to construct PackageFrameWriter object and to generate "package-frame.html" file in the respective package directory.

 

Method Summary
static void	generate(com.sun.javadoc.PackageDoc pkg)           Generate a package summary page for the left-hand bottom frame.
protected  void	generateClassListing()           Generate class listing for all the classes in this package.
protected  void	generateGFListing(String label)           Generate specific class kind listing.
void	printHeader(String title)           Print the html file header.

 

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

generate, generateClassKindListing, printPackageDescription, printPackageFooter, printPackageHeader, printPackageTableFooter, printPackageTableHeader

 

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

generatePackageFile, navLinkPackage

 

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, 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

 

Field Detail

packagedoc

protected com.sun.javadoc.PackageDoc packagedoc

MjdocPackageFrameWriter

public MjdocPackageFrameWriter(com.sun.tools.doclets.standard.ConfigurationStandard configuration,
                               String path,
                               String filename,
                               com.sun.javadoc.PackageDoc packagedoc)
                        throws IOException,
                               com.sun.tools.doclets.DocletAbortException

Constructor to construct PackageFrameWriter object and to generate "package-frame.html" file in the respective package directory. For example for package "java.lang" this will generate file "package-frame.html" file in the "java/lang" directory. It will also create "java/lang" directory in the current or the destination directory if it doesen't exist.

Parameters:

path - Directories in this path will be created if they are not already there.

filename - Name of the package summary file to be generated, "package-frame.html".

packagedoc - PackageDoc under consideration.

Throws:

IOException

com.sun.tools.doclets.DocletAbortException

generate

public static void generate(com.sun.javadoc.PackageDoc pkg)
                     throws com.sun.tools.doclets.DocletAbortException

Generate a package summary page for the left-hand bottom frame. Construct the PackageFrameWriter object and then uses it generate the file.

Parameters:

pkg - The package for which "pacakge-frame.html" is to be generated.

Throws:

com.sun.tools.doclets.DocletAbortException

generateClassListing

protected void generateClassListing()

Generate class listing for all the classes in this package. Divide class listing as per the class kind and generate separate listing for Classes, Interfaces, Exceptions and Errors.

Overrides:

generateClassListing in class com.sun.tools.doclets.standard.PackageFrameWriter

generateGFListing

protected void generateGFListing(String label)

Generate specific class kind listing. Also add label to the listing.

Parameters:

label - Label for the listing

printHeader

public void printHeader(String title)

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.