org.multijava.mjdoc.mjdoc_142
Class MjdocClassWriter

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.SubWriterHolderWriter
                          com.sun.tools.doclets.standard.ClassWriter
                              org.multijava.mjdoc.mjdoc_142.MjdocClassWriter

All Implemented Interfaces:

Appendable, Closeable, Flushable

public class MjdocClassWriter

extends com.sun.tools.doclets.standard.ClassWriter

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

 

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

classdoc, classtree, constrSubWriter, containingPackagesSeen, fieldSubWriter, methodSubWriter, nestedSubWriter, next, prev

 

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

MjdocClassWriter(com.sun.tools.doclets.standard.ConfigurationStandard configuration, String path, String filename, com.sun.javadoc.ClassDoc classdoc, com.sun.javadoc.ClassDoc prev, com.sun.javadoc.ClassDoc next, com.sun.tools.doclets.ClassTree classtree, boolean nopackage)

 

Method Summary
static void	generate(com.sun.tools.doclets.standard.ConfigurationStandard configuration, com.sun.javadoc.ClassDoc classdoc, com.sun.javadoc.ClassDoc prev, com.sun.javadoc.ClassDoc next, com.sun.tools.doclets.ClassTree classtree, boolean nopackage)           This generates an html page describing a class.
String	getEMLink(MjMethodDoc cd, String where, String label, boolean bold, String color)           This is used to generate a link to the file that contains the description of a external method unit.
String	getGFLink(MjMethodDoc cd, String where, String label, boolean bold, String color)
void	printHeader(String title, String metakeywords)
void	printHtmlHeader(String title, String[] metakeywords)           Print the html file header.
void	printScript(String title)
void	printSummaryLinkComment(com.sun.tools.doclets.standard.AbstractSubWriter mw, com.sun.javadoc.ProgramElementDoc member)

 

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

generate, generateClassFile, navDetailLinks, navGap, navLinkClass, navLinkClassUse, navLinkNext, navLinkPackage, navLinkPrevious, navLinkTree, navSummaryLinks, printAllMembers, printClassDescription, printDeprecated, printEnclosingInfo, printImplementingClasses, printInfoHeader, printStep, printSubClassInterfaceInfo, printSubClassLinkInfo, printSummaryDetailLinks, printSuperImplementedInterfacesInfo, printTreeForClass

 

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

printCommentDef, printIndexComment, printInheritedSummaryFooter, printInheritedSummaryHeader, printInheritedSummaryMember, printMemberFooter, printMemberHeader, printSummaryFooter, printSummaryHeader, printSummaryLinkType, printSummaryMember, printTableHeadingBackground, printTypeSummaryFooter, printTypeSummaryHeader

 

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, 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, printIndexHeading, printInlineComment, printInlineComment, printInlineDeprecatedComment, printInlineDeprecatedComment, printNoFramesBoldTargetHyperLink, printNoFramesTargetHyperLink, printPackageLink, printPackageLink, printPackageLink, printPreQualifiedBoldClassLink, printPreQualifiedClassLink, printQualifiedClassLink, printSinceTag, printSrcLink, printStyleSheetProperties, printSummaryComment, printSummaryDeprecatedComment, printSummaryDeprecatedComment, 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

MjdocClassWriter

public MjdocClassWriter(com.sun.tools.doclets.standard.ConfigurationStandard configuration,
                        String path,
                        String filename,
                        com.sun.javadoc.ClassDoc classdoc,
                        com.sun.javadoc.ClassDoc prev,
                        com.sun.javadoc.ClassDoc next,
                        com.sun.tools.doclets.ClassTree classtree,
                        boolean nopackage)
                 throws IOException

Throws:

IOException

generate

public static void generate(com.sun.tools.doclets.standard.ConfigurationStandard configuration,
                            com.sun.javadoc.ClassDoc classdoc,
                            com.sun.javadoc.ClassDoc prev,
                            com.sun.javadoc.ClassDoc next,
                            com.sun.tools.doclets.ClassTree classtree,
                            boolean nopackage)

This generates an html page describing a class.

printHtmlHeader

public void printHtmlHeader(String title,
                            String[] metakeywords)

Print the html file header. Also print Html page title and stylesheet default properties. This is overridden just to alter the application name.

Overrides:

printHtmlHeader in class com.sun.tools.doclets.standard.HtmlStandardWriter

Parameters:

title - String title for the generated html file.

metakeywords - String keywords for META tag.

printHeader

public void printHeader(String title,
                        String metakeywords)

printScript

public void printScript(String title)

printSummaryLinkComment

public void printSummaryLinkComment(com.sun.tools.doclets.standard.AbstractSubWriter mw,
                                    com.sun.javadoc.ProgramElementDoc member)

Overrides:

printSummaryLinkComment in class com.sun.tools.doclets.standard.SubWriterHolderWriter

getEMLink

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

This is used to generate a link to the file that contains the description of a external method unit. It is used by the PREF and NEXT buttons in the header of a generic function page.

getGFLink

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