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

Class sun.tools.javadoc.doclets.ClassWriter

sun.tools.javadoc.doclets.HtmlWriter
    |
    +----sun.tools.javadoc.doclets.HtmlDocWriter
            |
            +----sun.tools.javadoc.doclets.SubWriterHolderWriter
                    |
                    +----sun.tools.javadoc.doclets.ClassWriter

public class ClassWriter
extends SubWriterHolderWriter
Generate the Class Information Page.

See Also:
sun.tools.javadoc.ClassDoc, java.util.Collections, java.util.List, java.util.ArrayList, java.util.HashMap

Field Summary
sun.tools.javadoc.doclets.ClassDoc  classdoc
           
ClassTree  classtree
           
sun.tools.javadoc.doclets.String  next
           
sun.tools.javadoc.doclets.String  prev
           
 
Fields inherited from class sun.tools.javadoc.doclets.HtmlDocWriter
 configuration, htmlFilename
 

Constructor Summary
 ClassWriter(sun.tools.javadoc.doclets.String filename, sun.tools.javadoc.doclets.ClassDoc classdoc, sun.tools.javadoc.doclets.String prev, sun.tools.javadoc.doclets.String next, ClassTree classtree)
           
 

Method Summary
static void  generate(sun.tools.javadoc.doclets.ClassDoc classdoc, sun.tools.javadoc.doclets.String prev, sun.tools.javadoc.doclets.String next, ClassTree classtree)
          Generate a class page.
void  generateClassFile()
          Generate the class file contents.
void  generateNavBarFile(sun.tools.javadoc.doclets.String prev, sun.tools.javadoc.doclets.String next)
          Generate Navigation Bar information.
void  navLinkClass()
          Print class page indicator
void  navLinkNext()
          Print next item link
void  navLinkPackage()
          Print this package link
void  navLinkPrevious()
          Print previous item link
void  navLinkTree()
          Print class/interface hierarchy link
void  printAllMembers()
          Print summary and detail information for the specified members in the class.
void  printClassDescription()
          Print the class description regarding iterfaces implemented, classes inheritted.
void  printClassLink(sun.tools.javadoc.doclets.ClassDoc cd, sun.tools.javadoc.doclets.String where, sun.tools.javadoc.doclets.String tag)
           
void  printDeprecated()
          Mark the class as deprecated if it is.
void  printImplementingClasses()
          If this is the interface which are the classes, that implement this?
void  printSourceCodeLink(sun.tools.javadoc.doclets.ClassDoc classdoc)
          Generate the source code link.
void  printStep(int indent)
          Generate the step like diagram for the class hierarchy.
void  printSubClassInfoHeader(sun.tools.javadoc.doclets.List list)
           
void  printSubClassInterfaceInfo()
          Which are the sub-classes or sub-interfaces for this class?
void  printSubClassLinkInfo(sun.tools.javadoc.doclets.List list)
          Generate a link for the sub-classes.
int  printTreeForClass(sun.tools.javadoc.doclets.ClassDoc cd)
          Print the class hierarchy tree for this class only.
 
Methods inherited from class sun.tools.javadoc.doclets.SubWriterHolderWriter
 printCommentDef, printIndexComment, printInheritedSummaryFooter, printInheritedSummaryHeader, printInheritedSummaryMember, printMemberFooter, printMemberHeader, printSummaryFooter, printSummaryHeader, printSummaryMember, printTableHeadingBackground, printTypeSummaryFooter, printTypeSummaryHeader
 
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

classdoc

protected sun.tools.javadoc.doclets.ClassDoc classdoc

classtree

protected ClassTree classtree

prev

protected sun.tools.javadoc.doclets.String prev

next

protected sun.tools.javadoc.doclets.String next
Constructor Detail

ClassWriter

public ClassWriter(sun.tools.javadoc.doclets.String filename,
                   sun.tools.javadoc.doclets.ClassDoc classdoc,
                   sun.tools.javadoc.doclets.String prev,
                   sun.tools.javadoc.doclets.String next,
                   ClassTree classtree) throws sun.tools.javadoc.doclets.IOException
Method Detail

printClassLink

public void printClassLink(sun.tools.javadoc.doclets.ClassDoc cd,
                           sun.tools.javadoc.doclets.String where,
                           sun.tools.javadoc.doclets.String tag)
Overrides:
printClassLink in class HtmlDocWriter

generate

public static void generate(sun.tools.javadoc.doclets.ClassDoc classdoc,
                            sun.tools.javadoc.doclets.String prev,
                            sun.tools.javadoc.doclets.String next,
                            ClassTree classtree) throws DocletAbortException
          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.

navLinkPackage

protected void navLinkPackage()
          Print this package link
Overrides:
navLinkPackage in class HtmlDocWriter

navLinkTree

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

navLinkClass

protected void navLinkClass()
          Print class page indicator
Overrides:
navLinkClass in class HtmlDocWriter

navLinkPrevious

protected void navLinkPrevious()
          Print previous item link
Overrides:
navLinkPrevious in class HtmlDocWriter

navLinkNext

protected void navLinkNext()
          Print next item link
Overrides:
navLinkNext in class HtmlDocWriter

generateClassFile

public void generateClassFile()
          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.

printSourceCodeLink

protected void printSourceCodeLink(sun.tools.javadoc.doclets.ClassDoc classdoc)
          Generate the source code link.

printDeprecated

protected void printDeprecated()
          Mark the class as deprecated if it is.

printStep

protected void printStep(int indent)
          Generate the step like diagram for the class hierarchy.

printTreeForClass

protected int printTreeForClass(sun.tools.javadoc.doclets.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?

printSubClassInfoHeader

protected void printSubClassInfoHeader(sun.tools.javadoc.doclets.List list)

printSubClassLinkInfo

protected void printSubClassLinkInfo(sun.tools.javadoc.doclets.List list)
          Generate a link for the sub-classes.

generateNavBarFile

protected void generateNavBarFile(sun.tools.javadoc.doclets.String prev,
                                  sun.tools.javadoc.doclets.String next)
          Generate Navigation Bar information.

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