org.multijava.mjdoc.mjdoc_142
Class MjdocEMWriter

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.MjdocEMWriter

All Implemented Interfaces:

Appendable, Closeable, Flushable

public class MjdocEMWriter

extends MjdocMethodWriter

This class takes care of writing an html page for the contents of a compilation unit that contains external methods rather than classes. 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
(package private)  MjExtMethodsDoc	next
(package private)  MjExtMethodsDoc	prev

 

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

classdoc, methodSubWriter, nopackage

 

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

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

 

Method Summary
static void	generate(com.sun.tools.doclets.standard.ConfigurationStandard configuration, MjExtMethodsDoc methoddoc, MjExtMethodsDoc prev, MjExtMethodsDoc next, ArrayList methods, boolean nopackage)           Generate a external method compilation unit page.
void	generateExtMethodsFile(MjExtMethodsDoc top, ArrayList methods)           Generate the file contents.
String	getEMLink(MjExtMethodsDoc 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.
(package private) static String	methodFilename(MjExtMethodsDoc m, boolean nameOnly)           This generates the filename (not the directory part) for the html file that holds the decription of the given top method.
protected  void	navLinkGF()           Print class page indicator
protected  void	navLinkNext()           Print next package link
protected  void	navLinkPrevious()           Print previous package link
protected  void	navLinks(boolean header)           Print the navigation bar for the Html page at the top and and the bottom.

 

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

generateGenericFunctionFile, getGFLink, methodFilename, navDetailLinks, navLinkClass, navLinkPackage, 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

 

Field Detail

prev

MjExtMethodsDoc prev

next

MjExtMethodsDoc next

MjdocEMWriter

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

Throws:

IOException

generate

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

Generate a external method compilation unit page.

Parameters:

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

methoddoc - the class to generate.

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

navLinkGF

protected void navLinkGF()

Print class page indicator

Overrides:

navLinkGF in class MjdocMethodWriter

navLinkPrevious

protected void navLinkPrevious()

Print previous package link

Overrides:

navLinkPrevious in class MjdocMethodWriter

navLinkNext

protected void navLinkNext()

Print next package link

Overrides:

navLinkNext in class MjdocMethodWriter

generateExtMethodsFile

public void generateExtMethodsFile(MjExtMethodsDoc top,
                                   ArrayList methods)

Generate the file contents.

getEMLink

public String getEMLink(MjExtMethodsDoc 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.

methodFilename

static String methodFilename(MjExtMethodsDoc m,
                             boolean nameOnly)

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

navLinks

protected void navLinks(boolean header)

Print the navigation bar for the Html page at the top and and the bottom.

Overrides:

navLinks in class MjdocMethodWriter

Parameters:

header - If true print navigation bar at the top of the page else print the nevigation bar at the bottom.