org.multijava.mjdoc.mjdoc_142
Class MjdocGFWriter

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
                          org.multijava.mjdoc.mjdoc_142.MjdocMethodWriter
                              org.multijava.mjdoc.mjdoc_142.MjdocGFWriter

All Implemented Interfaces:

Appendable, Closeable, Flushable

public class MjdocGFWriter

extends MjdocMethodWriter

This class takes care of writing html pages that document individual generic functions (a family of related external and internal methods). It was written by analogy with ClassWriter, which is proprietary information of Sun Microsystems, Inc.

Author:

David Cok

See Also:

ClassDoc, Collection, List, ArrayList, HashMap

Field Summary

 

Fields inherited from class org.multijava.mjdoc.mjdoc_142.MjdocMethodWriter

classdoc, methodSubWriter, next, nopackage, 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

MjdocGFWriter(com.sun.tools.doclets.standard.ConfigurationStandard configuration, String path, String filename, MjMethodDoc methoddoc, MjMethodDoc prev, MjMethodDoc next, ArrayList methods, boolean nopackage)

 

Method Summary
static void	generate(com.sun.tools.doclets.standard.ConfigurationStandard configuration, MjMethodDoc methoddoc, MjMethodDoc prev, MjMethodDoc next, ArrayList methods, boolean nopackage)           Generate a method page.
void	generateGenericFunctionFile(MjMethodDoc top, ArrayList methods)           Generate the file contents.
String	getGFLink(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 generic function.
(package private) static String	methodFilename(MjMethodDoc m)           This generates the filename (not the directory part) for the html file that holds the decription of the given top method.

 

Methods inherited from class org.multijava.mjdoc.mjdoc_142.MjdocMethodWriter

navDetailLinks, navLinkClass, navLinkGF, navLinkNext, navLinkPackage, navLinkPrevious, navLinks, navSummaryLinks, printDeprecated, printSummaryDetailLinks, printSummaryLinkComment

 

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

MjdocGFWriter

public MjdocGFWriter(com.sun.tools.doclets.standard.ConfigurationStandard configuration,
                     String path,
                     String filename,
                     MjMethodDoc methoddoc,
                     MjMethodDoc prev,
                     MjMethodDoc next,
                     ArrayList methods,
                     boolean nopackage)
              throws IOException

Throws:

IOException

generate

public static void generate(com.sun.tools.doclets.standard.ConfigurationStandard configuration,
                            MjMethodDoc methoddoc,
                            MjMethodDoc prev,
                            MjMethodDoc next,
                            ArrayList methods,
                            boolean nopackage)

Generate a method page.

Parameters:

prev - the previous method to generated, or null if no previous.

methoddoc - the method to generate.

next - the next method to be generated, or null if no next.

generateGenericFunctionFile

public void generateGenericFunctionFile(MjMethodDoc top,
                                        ArrayList methods)

Generate the file contents.

Overrides:

generateGenericFunctionFile in class MjdocMethodWriter

getGFLink

public String getGFLink(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 generic function. It is used by the PREF and NEXT buttons in the header of a generic function page.

Overrides:

getGFLink in class MjdocMethodWriter

methodFilename

static String methodFilename(MjMethodDoc m)

This generates the filename (not the directory part) for the html file that holds the decription of the given top method.