Contents | Package | Class | Tree | Index
PREV | NEXT SHOW LISTS | HIDE LISTS

Class sun.tools.javadoc.doclets.AbstractTreeWriter

sun.tools.javadoc.doclets.HtmlWriter
    |
    +----sun.tools.javadoc.doclets.HtmlDocWriter
            |
            +----sun.tools.javadoc.doclets.AbstractTreeWriter
Subclasses:
PackageTreeWriter, TreeWriter

public class AbstractTreeWriter
extends HtmlDocWriter
Abstract class to print the class hierarchy page for all the Classes. Sub-classes to generate the Interface Tree and Class Tree Part.


Field Summary
ClassTree  classtree
           
 
Fields inherited from class sun.tools.javadoc.doclets.HtmlDocWriter
 configuration, htmlFilename
 

Constructor Summary
 AbstractTreeWriter(sun.tools.javadoc.doclets.String filename, ClassTree classtree)
          Constructor.
 

Method Summary
boolean  equalNames(sun.tools.javadoc.doclets.ClassDoc parent, sun.tools.javadoc.doclets.ClassDoc comp)
          Return true if two classes are same else false.
void  generateLevelInfo(sun.tools.javadoc.doclets.ClassDoc parent, sun.tools.javadoc.doclets.List list)
          Generate each line for level info regarding classes.
void  generateTree(sun.tools.javadoc.doclets.List list, sun.tools.javadoc.doclets.String heading)
          Generate Tree method, to be called by the TreeWriter.
void  navLinkTree()
          Print class/interface hierarchy link
void  printExtendsImplements(sun.tools.javadoc.doclets.ClassDoc parent, sun.tools.javadoc.doclets.ClassDoc cd)
          Print the information regarding the classes which this class extends or implements.
void  printPartialInfo(sun.tools.javadoc.doclets.ClassDoc cd)
          Print informatioon about the class kind.
void  printTreeHeading(sun.tools.javadoc.doclets.String heading)
          Print the heading for the tree depending upon if it's Interface Tree or Class Tree.
 
Methods inherited from class sun.tools.javadoc.doclets.HtmlDocWriter
 boldText, error, error, error, error, firstSentence, frame, frameEnd, frameSet, frameSetEnd, generateTagInfo, getText, getText, getText, getText, navGap, navHideLists, navHideLists, navLinkClass, navLinkContents, navLinkDeprecated, navLinkHelp, navLinkIndex, navLinkMainTree, navLinkNext, navLinkNext, navLinkPackage, navLinkPackage, navLinkPrevious, navLinkPrevious, navLinks, navLinkTree, navLinkTree, navShowLists, navShowLists, notice, notice, notice, notice, printBottom, printClassLink, printClassLink, printClassLink, printFooter, printHeader, printHyperLink, printHyperLink, printImage, printIndexHeading, printMemberHyperLink, printNbsps, printPackageLink, printPackageLink, printPartialHeader, printPreQualifiedClassLink, printQualifiedClassLink, printSeeTags, printTargetClassLink, printTargetHyperLink, printText, printText, printUserHeaderFooter, spaces, summaryRow, summaryRowEnd, table, tableEnd, tableHeaderEnd, tableHeaderStart, tableHeaderStart, tableHeaderStart, tableHeaderStart, tableIndexDetail, tableIndexSummary, tableInheritedHeaderStart, tablePackageFrame, td, td, tdIndex, today, warning, warning, warning, warning
 
Methods inherited from class sun.tools.javadoc.doclets.HtmlWriter
 address, addressEnd, aEnd, aName, anchor, anchor, body, body, bodyEnd, bold, bold, boldEnd, br, center, centerEnd, code, codeEnd, dd, ddEnd, dl, dlEnd, dt, em, emEnd, font, fontColor, fontEnd, h1, h1, h1End, h2, h2, h2End, h3, h3, h3End, h4, h4, h4End, h5, h5End, head, headEnd, hr, hr, html, htmlEnd, img, italics, li, li, menu, menuEnd, p, pre, preEnd, space, sup, supEnd, td, tdAlign, tdAlignRowspan, tdColspan, tdEnd, title, titleEnd, tr, trBgcolor, trEnd, ul, ulEnd
 

Field Detail

classtree

protected final ClassTree classtree
Constructor Detail

AbstractTreeWriter

protected AbstractTreeWriter(sun.tools.javadoc.doclets.String filename,
                             ClassTree classtree) throws sun.tools.javadoc.doclets.IOException
          Constructor.
Parameters:
file - String filename
Method Detail

generateLevelInfo

protected void generateLevelInfo(sun.tools.javadoc.doclets.ClassDoc parent,
                                 sun.tools.javadoc.doclets.List list)
          Generate each line for level info regarding classes. Recurses itself to generate subclasses info. To iterate is human, to recurse is divine - L. Peter Deutsch.
Parameters:
list - list of the sub-classes at this level.

generateTree

protected void generateTree(sun.tools.javadoc.doclets.List list,
                            sun.tools.javadoc.doclets.String heading)
          Generate Tree method, to be called by the TreeWriter. Call appropriate methods from the sub-classes.

printExtendsImplements

protected void printExtendsImplements(sun.tools.javadoc.doclets.ClassDoc parent,
                                      sun.tools.javadoc.doclets.ClassDoc cd)
          Print the information regarding the classes which this class extends or implements.
Parameters:
cd - The classdoc under consideration.

equalNames

protected boolean equalNames(sun.tools.javadoc.doclets.ClassDoc parent,
                             sun.tools.javadoc.doclets.ClassDoc comp)
          Return true if two classes are same else false.

printPartialInfo

protected void printPartialInfo(sun.tools.javadoc.doclets.ClassDoc cd)
          Print informatioon about the class kind.
Parameters:
cd - classdoc.

printTreeHeading

protected void printTreeHeading(sun.tools.javadoc.doclets.String heading)
          Print the heading for the tree depending upon if it's Interface Tree or Class Tree.

navLinkTree

protected void navLinkTree()
          Print class/interface hierarchy link
Overrides:
navLinkTree in class HtmlDocWriter

Contents | Package | Class | Tree | Index
PREV | NEXT SHOW LISTS | HIDE LISTS