Package gw.gosudoc.com.sun.tools.doclets.formats.html

Class PackageTreeWriter

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.PackageTreeWriter

@Deprecated
public class PackageTreeWriter
extends AbstractTreeWriter

Deprecated.

Class to generate Tree page for a package. The name of the file generated is "package-tree.html" and it is generated in the respective package 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.

Author:

Atul M Dambalkar, Bhavesh Patel (Modified)

Field Summary

Fields

Modifier and Type	Field	Description
protected PackageDoc	next	Deprecated. The next package name in the alpha-order list.
protected PackageDoc	packagedoc	Deprecated. Package for which tree is to be generated.
protected PackageDoc	prev	Deprecated. The previous package name in the alpha-order list.

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

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

Constructor	Description
PackageTreeWriter(ConfigurationImpl configuration, DocPath path, PackageDoc packagedoc, PackageDoc prev, PackageDoc next)	Deprecated. Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	addLinkToMainTree(Content div)	Deprecated. Add a link to the tree for all the packages.
static void	generate(ConfigurationImpl configuration, PackageDoc pkg, PackageDoc prev, PackageDoc next, boolean noDeprecated)	Deprecated. Construct a PackageTreeWriter object and then use it to generate the package tree page.
protected void	generatePackageTreeFile()	Deprecated. Generate a separate tree file for each package.
protected Content	getNavLinkNext()	Deprecated. Get link for the next package tree file.
protected Content	getNavLinkPackage()	Deprecated. Get link to the package summary page for the package of this tree.
protected Content	getNavLinkPrevious()	Deprecated. Get link for the previous package tree file.
protected HtmlTree	getPackageTreeHeader()	Deprecated. Get the package tree header.

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, 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, getNavLinkPackage, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

packagedoc

protected PackageDoc packagedoc

Deprecated.

Package for which tree is to be generated.

prev

protected PackageDoc prev

Deprecated.

The previous package name in the alpha-order list.

next

protected PackageDoc next

Deprecated.

The next package name in the alpha-order list.

Constructor Detail

PackageTreeWriter

public PackageTreeWriter(ConfigurationImpl configuration,
                         DocPath path,
                         PackageDoc packagedoc,
                         PackageDoc prev,
                         PackageDoc next)
                  throws IOException

Deprecated.

Constructor.

Throws:

IOException

DocletAbortException

Method Detail

generate

public static void generate(ConfigurationImpl configuration,
                            PackageDoc pkg,
                            PackageDoc prev,
                            PackageDoc next,
                            boolean noDeprecated)

Deprecated.

Construct a PackageTreeWriter object and then use it to generate the package tree page.

Parameters:

pkg - Package for which tree file is to be generated.

prev - Previous package in the alpha-ordered list.

next - Next package in the alpha-ordered list.

noDeprecated - If true, do not generate any information for deprecated classe or interfaces.

Throws:

DocletAbortException

generatePackageTreeFile

protected void generatePackageTreeFile()
                                throws IOException

Deprecated.

Generate a separate tree file for each package.

Throws:

IOException

getPackageTreeHeader

protected HtmlTree getPackageTreeHeader()

Deprecated.

Get the package tree header.

Returns:

a content tree for the header

addLinkToMainTree

protected void addLinkToMainTree(Content div)

Deprecated.

Add a link to the tree for all the packages.

Parameters:

div - the content tree to which the link will be added

getNavLinkPrevious

protected Content getNavLinkPrevious()

Deprecated.

Get link for the previous package tree file.

Overrides:

getNavLinkPrevious in class HtmlDocletWriter

Returns:

a content tree for the link

getNavLinkNext

protected Content getNavLinkNext()

Deprecated.

Get link for the next package tree file.

Overrides:

getNavLinkNext in class HtmlDocletWriter

Returns:

a content tree for the link

getNavLinkPackage

protected Content getNavLinkPackage()

Deprecated.

Get link to the package summary page for the package of this tree.

Overrides:

getNavLinkPackage in class HtmlDocletWriter

Returns:

a content tree for the package link