org.multijava.mjdoc.mjdoc_142
Class MjdocMethodWriter

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

All Implemented Interfaces:

Appendable, Closeable, Flushable

Direct Known Subclasses:

MjdocEMWriter, MjdocGFWriter

public class MjdocMethodWriter

extends com.sun.tools.doclets.standard.SubWriterHolderWriter

This is just used as a common super class for MjdocEFWriter and MjdocGFWriter, both of which produce html pages containing a list of methods, but not as part of a class.

Author:

David Cok

See Also:

ClassDoc, Collection, List, ArrayList, HashMap

Field Summary
protected  com.sun.javadoc.ClassDoc	classdoc
protected  MjdocMethodSubWriter	methodSubWriter
protected  MjMethodDoc	next
protected  boolean	nopackage
protected  MjMethodDoc	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

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

 

Method Summary
void	generateGenericFunctionFile(MjMethodDoc top, ArrayList methods)           Generate the class 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.
protected  void	navDetailLinks()
protected  void	navLinkClass()           Print class page indicator
protected  void	navLinkGF()           Print class page indicator
protected  void	navLinkNext()           Print next package link
protected  void	navLinkPackage()           Print this 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.
protected  void	navSummaryLinks()
protected  void	printDeprecated()           Mark the class as deprecated if it is.
protected  void	printSummaryDetailLinks()
void	printSummaryLinkComment(com.sun.tools.doclets.standard.AbstractSubWriter mw, com.sun.javadoc.ProgramElementDoc member)

 

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

classdoc

protected com.sun.javadoc.ClassDoc classdoc

prev

protected MjMethodDoc prev

next

protected MjMethodDoc next

nopackage

protected boolean nopackage

methodSubWriter

protected MjdocMethodSubWriter methodSubWriter

MjdocMethodWriter

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

Throws:

IOException

navLinkPackage

protected void navLinkPackage()

Print this package link

Overrides:

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

navLinkClass

protected void navLinkClass()

Print class page indicator

Overrides:

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

navLinkGF

protected void navLinkGF()

Print class page indicator

navLinkPrevious

protected void navLinkPrevious()

Print previous package link

Overrides:

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

navLinkNext

protected void navLinkNext()

Print next package link

Overrides:

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

generateGenericFunctionFile

public void generateGenericFunctionFile(MjMethodDoc top,
                                        ArrayList methods)

Generate the class file contents.

printDeprecated

protected void printDeprecated()

Mark the class as deprecated if it is.

printSummaryDetailLinks

protected void printSummaryDetailLinks()

Overrides:

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

navSummaryLinks

protected void navSummaryLinks()

navDetailLinks

protected void navDetailLinks()

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.

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.

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

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 com.sun.tools.doclets.standard.HtmlStandardWriter

Parameters:

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