Class TreeWriter
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
gw.gosudoc.com.sun.tools.doclets.formats.html.TreeWriter
Deprecated.
Generate Class Hierarchy page for all the Classes in this run. Use
ClassTree for building the Tree. The name of
the generated file is "overview-tree.html" and it is generated in the
current or the destination directory.
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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
Deprecated.True if there are no packages specified on the command line, False otherwise.(package private) SortedSet<PackageDoc>
Deprecated.Packages in this run.Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.AbstractTreeWriter
classtree
Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.HtmlDocletWriter
blockTags, configuration, filename, fixedNavDiv, 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
ConstructorsConstructorDescriptionTreeWriter
(ConfigurationImpl configuration, DocPath filename, ClassTree classtree) Deprecated.Constructor to construct TreeWriter object. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
addPackageTreeLinks
(Content contentTree) Deprecated.Add the links to all the package tree files.static void
generate
(ConfigurationImpl configuration, ClassTree classtree) Deprecated.Create a TreeWriter object and use it to generate the "overview-tree.html" file.void
Deprecated.Generate the interface hierarchy and class hierarchy.protected HtmlTree
Deprecated.Get the tree header.private boolean
Deprecated.Methods inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.AbstractTreeWriter
addExtendsImplements, addLevelInfo, addPartialInfo, addTree, getNavLinkTree
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, check, 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
-
Field Details
-
packages
SortedSet<PackageDoc> packagesDeprecated.Packages in this run. -
classesonly
private boolean classesonlyDeprecated.True if there are no packages specified on the command line, False otherwise.
-
-
Constructor Details
-
TreeWriter
public TreeWriter(ConfigurationImpl configuration, DocPath filename, ClassTree classtree) throws IOException Deprecated.Constructor to construct TreeWriter object.- Parameters:
configuration
- the current configuration of the doclet.filename
- String filenameclasstree
- the tree being built.- Throws:
IOException
-
-
Method Details
-
generate
Deprecated.Create a TreeWriter object and use it to generate the "overview-tree.html" file.- Parameters:
classtree
- the class tree being documented.- Throws:
DocletAbortException
-
generateTreeFile
Deprecated.Generate the interface hierarchy and class hierarchy.- Throws:
IOException
-
addPackageTreeLinks
Deprecated.Add the links to all the package tree files.- Parameters:
contentTree
- the content tree to which the links will be added
-
getTreeHeader
Deprecated.Get the tree header.- Returns:
- a content tree for the tree header
-
isUnnamedPackage
private boolean isUnnamedPackage()Deprecated.
-