Class AbstractTreeWriter
- java.lang.Object
-
- gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlWriter
-
- gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlDocWriter
-
- gw.gosudoc.com.sun.tools.doclets.formats.html.HtmlDocletWriter
-
- gw.gosudoc.com.sun.tools.doclets.formats.html.AbstractTreeWriter
-
- Direct Known Subclasses:
PackageTreeWriter
,TreeWriter
@Deprecated public abstract class AbstractTreeWriter extends HtmlDocletWriter
Deprecated.Abstract class to print the class hierarchy page for all the Classes. This is sub-classed byPackageTreeWriter
andTreeWriter
to generate the Package Tree and global Tree(for all the classes and packages) pages.This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.
- Author:
- Atul M Dambalkar
-
-
Field Summary
Fields Modifier and Type Field Description protected ClassTree
classtree
Deprecated.The class and interface tree built by usingClassTree
-
Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.HtmlDocletWriter
configuration, filename, path, pathToRoot, printedAnnotationFieldHeading, printedAnnotationHeading, utils
-
Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlDocWriter
CONTENT_TYPE
-
Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlWriter
allclassesLabel, allpackagesLabel, annotationTypeDetailsLabel, classLabel, constructorDetailsLabel, defaultPackageLabel, deprecatedLabel, deprecatedPhrase, descfrmClassLabel, descfrmInterfaceLabel, descriptionLabel, detailLabel, enumConstantsDetailsLabel, fieldDetailsLabel, framesLabel, helpLabel, indexLabel, memberDetailsListPrinted, methodDetailsLabel, modifierTypeHeader, nextclassLabel, nextLabel, nextpackageLabel, noframesLabel, overridesLabel, overviewLabel, packageLabel, packagesLabel, packageTableHeader, prevclassLabel, prevLabel, prevpackageLabel, propertyDetailsLabel, script, seeLabel, specifiedByLabel, summaryLabel, treeLabel, useLabel, useTableSummary, winTitle
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractTreeWriter(ConfigurationImpl configuration, DocPath filename, ClassTree classtree)
Deprecated.Constructor initializes classtree variable.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected void
addExtendsImplements(ClassDoc parent, ClassDoc cd, Content contentTree)
Deprecated.Add information regarding the classes which this class extends or implements.protected void
addLevelInfo(ClassDoc parent, Collection<ClassDoc> list, boolean isEnum, Content contentTree)
Deprecated.Add each level of the class tree.protected void
addPartialInfo(ClassDoc cd, Content contentTree)
Deprecated.Add information about the class kind, if it's a "class" or "interface".protected void
addTree(SortedSet<ClassDoc> list, String heading, HtmlTree div)
Deprecated.Add the heading for the tree depending upon tree type if it's a Class Tree or Interface tree.protected Content
getNavLinkTree()
Deprecated.Get the tree label for the navigation bar.-
Methods inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.HtmlDocletWriter
addAnnotationInfo, addAnnotationInfo, addAnnotationInfo, addBottom, addInlineComment, addInlineComment, addInlineDeprecatedComment, addNavLinks, addPackageDeprecatedAPI, addPreQualifiedClassLink, addPreQualifiedClassLink, addPreQualifiedStrongClassLink, addReceiverAnnotationInfo, addScriptProperties, addSrcLink, addStyleSheetProperties, addSummaryComment, addSummaryComment, addSummaryDeprecatedComment, addSummaryDetailLinks, addTagsInfo, addTop, commentTagsToContent, configuration, getAllClassesLinkScript, getAnchor, getAnchor, getAnnotations, getCrossClassLink, getCrossPackageLink, getDocLink, getDocLink, getDocLink, getDocLink, getDocLink, getDocLink, getDocLink, getLink, getMarkerAnchor, getMarkerAnchor, getMarkerAnchor, getMarkerAnchor, getNavHideLists, getNavLinkClass, getNavLinkClassIndex, getNavLinkClassUse, getNavLinkContents, getNavLinkDeprecated, getNavLinkHelp, getNavLinkIndex, getNavLinkMainTree, getNavLinkNext, getNavLinkNext, getNavLinkPackage, getNavLinkPackage, getNavLinkPrevious, getNavLinkPrevious, getNavShowLists, getNavShowLists, getPackageAnchorName, getPackageLabel, getPackageLink, getPackageLink, getPackageName, getPreQualifiedClassLink, getQualifiedClassLink, getSummaryTableHeader, getTableCaption, getTagletWriterInstance, getTargetPackageLink, getTypeParameterLinks, getUserHeaderFooter, getWindowTitle, hasSerializationOverviewTags, isClassLinkable, isCoreClass, italicsClassName, pathString, pathString, printHtmlDocument, removeNonInlineHtmlTags, replaceDocRootDir, seeTagToContent
-
Methods inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlDocWriter
getDocLink, getDocLink, getDocLink, getGeneratedBy, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getMemberDetailsListPrinted, getName, getPkgName, getStyleSheetProperties, printFramesDocument
-
Methods inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlWriter
addStyles, close, codeText, generateMethodTypesScript, getBody, getFramesJavaScript, getModifierTypeHeader, getNonBreakResource, getResource, getResource, getResource, getSpace, getTitle, getWinTitleScript, write
-
-
-
-
Constructor Detail
-
AbstractTreeWriter
protected AbstractTreeWriter(ConfigurationImpl configuration, DocPath filename, ClassTree classtree) throws IOException
Deprecated.Constructor initializes classtree variable. This constructor will be used while generating global tree file "overview-tree.html".- Parameters:
configuration
- The current configurationfilename
- File to be generated.classtree
- Tree built byClassTree
.- Throws:
IOException
DocletAbortException
-
-
Method Detail
-
addLevelInfo
protected void addLevelInfo(ClassDoc parent, Collection<ClassDoc> list, boolean isEnum, Content contentTree)
Deprecated.Add each level of the class tree. For each sub-class or sub-interface indents the next level information. Recurses itself to add subclasses info.- Parameters:
parent
- the superclass or superinterface of the listlist
- list of the sub-classes at this levelisEnum
- true if we are generating a tree for enumscontentTree
- the content tree to which the level information will be added
-
addTree
protected void addTree(SortedSet<ClassDoc> list, String heading, HtmlTree div)
Deprecated.Add the heading for the tree depending upon tree type if it's a Class Tree or Interface tree.- Parameters:
list
- List of classes which are at the most base level, all the other classes in this run will derive from these classesheading
- heading for the treediv
- the content tree to which the tree will be added
-
addExtendsImplements
protected void addExtendsImplements(ClassDoc parent, ClassDoc cd, Content contentTree)
Deprecated.Add information regarding the classes which this class extends or implements.- Parameters:
parent
- the parent class of the class being documentedcd
- the classdoc under considerationcontentTree
- the content tree to which the information will be added
-
addPartialInfo
protected void addPartialInfo(ClassDoc cd, Content contentTree)
Deprecated.Add information about the class kind, if it's a "class" or "interface".- Parameters:
cd
- the class being documentedcontentTree
- the content tree to which the information will be added
-
getNavLinkTree
protected Content getNavLinkTree()
Deprecated.Get the tree label for the navigation bar.- Overrides:
getNavLinkTree
in classHtmlDocletWriter
- Returns:
- a content tree for the tree label
-
-