org.multijava.mjdoc.mjdoc_142
Class MjdocPackageWriter

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.PackageWriter
                              org.multijava.mjdoc.mjdoc_142.MjdocPackageWriter

All Implemented Interfaces:

Appendable, Closeable, Flushable

public class MjdocPackageWriter

extends com.sun.tools.doclets.standard.PackageWriter

A derivative of a class in the javadoc doclet API, so as to be able to instantiate a MjdocClassWriter instead of a ClassWriter and a MjdocMethodSubWriter instead of a MethodSubWriter.

Author:

David R. Cok

Field Summary
protected  MjPackageDoc	packagedoc

 

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

next, prev

 

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

MjdocPackageWriter(com.sun.tools.doclets.standard.ConfigurationStandard config, String path, String filename, com.sun.javadoc.PackageDoc packagedoc, com.sun.javadoc.PackageDoc prev, com.sun.javadoc.PackageDoc next)

 

Method Summary
static void	generate(com.sun.tools.doclets.standard.ConfigurationStandard configuration, com.sun.javadoc.PackageDoc pkg, com.sun.javadoc.PackageDoc prev, com.sun.javadoc.PackageDoc next)           Generate a package summary page for the right-hand frame.
protected  void	generateClassListing()
String	getGFLink(MjMethodDoc cd, String where, String label, boolean bold, String color)
void	printHeader(String title)           Print the html file header.

 

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

generateClassKindListing, navLinkClassUse, navLinkNext, navLinkPrevious, navLinkTree, printFirstRow, printPackageComment, printPackageDescription, printPackageFooter, printPackageHeader

 

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, navLinkContents, navLinkDeprecated, navLinkHelp, navLinkIndex, navLinkMainTree, navLinkNext, navLinkPackage, navLinkPrevious, navLinks, 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 MjPackageDoc packagedoc

MjdocPackageWriter

public MjdocPackageWriter(com.sun.tools.doclets.standard.ConfigurationStandard config,
                          String path,
                          String filename,
                          com.sun.javadoc.PackageDoc packagedoc,
                          com.sun.javadoc.PackageDoc prev,
                          com.sun.javadoc.PackageDoc next)
                   throws IOException,
                          com.sun.tools.doclets.DocletAbortException

Throws:

IOException

com.sun.tools.doclets.DocletAbortException

generate

public static void generate(com.sun.tools.doclets.standard.ConfigurationStandard configuration,
                            com.sun.javadoc.PackageDoc pkg,
                            com.sun.javadoc.PackageDoc prev,
                            com.sun.javadoc.PackageDoc next)
                     throws com.sun.tools.doclets.DocletAbortException

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

Parameters:

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

prev - Previous package in the sorted array.

next - Next package in the sorted array.

Throws:

com.sun.tools.doclets.DocletAbortException

generateClassListing

protected void generateClassListing()

Overrides:

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

printHeader

public void printHeader(String title)

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

Parameters:

title - String title for the generated html file.

getGFLink

public String getGFLink(MjMethodDoc cd,
                        String where,
                        String label,
                        boolean bold,
                        String color)