org.freehep.tools.doclet
Class ClassWriter

java.lang.Object
  java.io.Writer
      java.io.PrintWriter
          com.sun.tools.doclets.HtmlWriter
              com.sun.tools.doclets.HtmlDocWriter
                  org.freehep.tools.doclet.HtmlStandardWriter
                      org.freehep.tools.doclet.SubWriterHolderWriter
                          org.freehep.tools.doclet.ClassWriter

public class ClassWriter

extends SubWriterHolderWriter

Generate the Class Information Page.

Author:

Atul M Dambalkar, Robert Field

See Also:

ClassDoc, Collections, List, ArrayList, HashMap

Source Code:

ClassWriter.java

Field Summary

protected com.sun.javadoc.ClassDoc	classdoc
protected com.sun.tools.doclets.ClassTree	classtree
protected ConstructorSubWriter	constrSubWriter
protected static Set	containingPackagesSeen
protected FieldSubWriter	fieldSubWriter
protected MethodSubWriter	methodSubWriter
protected ClassSubWriter	nestedSubWriter
protected com.sun.javadoc.ClassDoc	next
protected com.sun.javadoc.ClassDoc	prev

Fields inherited from class org.freehep.tools.doclet.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

ClassWriter(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)

Method Summary

static void	generate(ConfigurationStandard configuration, com.sun.javadoc.ClassDoc classdoc, com.sun.javadoc.ClassDoc prev, com.sun.javadoc.ClassDoc next, com.sun.tools.doclets.ClassTree classtree, String srcURL) Generate a class page.
void	generateClassFile(String srcURL) Generate the class file contents.
protected void	navDetailLinks()
protected void	navGap()
protected void	navLinkClass() Print class page indicator
protected void	navLinkClassUse() Print class use link
protected void	navLinkNext() Print next package link
protected void	navLinkPackage() Print this package link
protected void	navLinkPrevious() Print previous package link
protected void	navLinkTree() Print "Tree" link in the navigation bar.
protected void	navSummaryLinks()
protected void	printAllMembers() Print summary and detail information for the specified members in the class.
protected void	printClassDescription() Print the class description regarding iterfaces implemented, classes inheritted.
protected void	printDeprecated() Mark the class as deprecated if it is.
protected void	printEnclosingInfo()
protected void	printImplementingClasses() If this is the interface which are the classes, that implement this?
protected void	printInfoHeader()
protected void	printStep(int indent) Generate the indent and get the line image for the class tree.
protected void	printSubClassInterfaceInfo() Which are the sub-classes or sub-interfaces for this class?
protected void	printSubClassLinkInfo(List list) Generate a link for the sub-classes.
protected void	printSummaryDetailLinks() Do nothing.
protected void	printSuperImplementedInterfacesInfo()
protected int	printTreeForClass(com.sun.javadoc.ClassDoc cd) Print the class hierarchy tree for this class only.

Methods inherited from class org.freehep.tools.doclet.SubWriterHolderWriter

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

Methods inherited from class org.freehep.tools.doclet.HtmlStandardWriter

boldText, boldText, boldText, commentTagsToString, configuration, copyDocFiles, error, error, frame, frameEnd, frameSet, frameSetEnd, generateTagInfo, 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, 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

checkError, close, flush, print, print, print, print, print, print, print, print, print, 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

classtree

protected com.sun.tools.doclets.ClassTree classtree

prev

protected com.sun.javadoc.ClassDoc prev

next

protected com.sun.javadoc.ClassDoc next

methodSubWriter

protected MethodSubWriter methodSubWriter

constrSubWriter

protected ConstructorSubWriter constrSubWriter

fieldSubWriter

protected FieldSubWriter fieldSubWriter

nestedSubWriter

protected ClassSubWriter nestedSubWriter

containingPackagesSeen

protected static Set containingPackagesSeen

Constructor Detail

ClassWriter

public ClassWriter(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)
            throws IOException

Throws:

IOException

com.sun.tools.doclets.DocletAbortException

Method Detail

generate

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

Generate a class page.

Parameters:

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

classdoc - the class to generate.

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

Throws:

com.sun.tools.doclets.DocletAbortException

navLinkPackage

protected void navLinkPackage()

Print this package link

Overrides:

navLinkPackage in class HtmlStandardWriter

navLinkClass

protected void navLinkClass()

Print class page indicator

Overrides:

navLinkClass in class HtmlStandardWriter

navLinkClassUse

protected void navLinkClassUse()

Print class use link

Overrides:

navLinkClassUse in class HtmlStandardWriter

navLinkPrevious

protected void navLinkPrevious()

Print previous package link

Overrides:

navLinkPrevious in class HtmlStandardWriter

navLinkNext

protected void navLinkNext()

Print next package link

Overrides:

navLinkNext in class HtmlStandardWriter

generateClassFile

public void generateClassFile(String srcURL)

Generate the class file contents.

printAllMembers

protected void printAllMembers()

Print summary and detail information for the specified members in the class.

printClassDescription

protected void printClassDescription()

Print the class description regarding iterfaces implemented, classes inheritted.

printDeprecated

protected void printDeprecated()

Mark the class as deprecated if it is.

printStep

protected void printStep(int indent)

Generate the indent and get the line image for the class tree. For user accessibility, the image includes the alt attribute "extended by". (This method is not intended for a class implementing an interface, where "implemented by" would be required.) indent integer indicating the number of spaces to indent

printTreeForClass

protected int printTreeForClass(com.sun.javadoc.ClassDoc cd)

Print the class hierarchy tree for this class only.

printSubClassInterfaceInfo

protected void printSubClassInterfaceInfo()

Which are the sub-classes or sub-interfaces for this class?

printImplementingClasses

protected void printImplementingClasses()

If this is the interface which are the classes, that implement this?

printSuperImplementedInterfacesInfo

protected void printSuperImplementedInterfacesInfo()

printInfoHeader

protected void printInfoHeader()

printSubClassLinkInfo

protected void printSubClassLinkInfo(List list)

Generate a link for the sub-classes.

navLinkTree

protected void navLinkTree()

Description copied from class: HtmlStandardWriter

Print "Tree" link in the navigation bar. If there is only one package specified on the command line, then the "Tree" link will be to the only "package-tree.html" file otherwise it will be to the "overview-tree.html" file.

Overrides:

navLinkTree in class HtmlStandardWriter

printSummaryDetailLinks

protected void printSummaryDetailLinks()

Description copied from class: HtmlStandardWriter

Do nothing. This is the default method.

Overrides:

printSummaryDetailLinks in class HtmlStandardWriter

navSummaryLinks

protected void navSummaryLinks()

navDetailLinks

protected void navDetailLinks()

navGap

protected void navGap()

printEnclosingInfo

protected void printEnclosingInfo()