APIdia Launch Partner
Top Description Fields Constructors Methods
jdk.javadoc.internal.doclets.formats.html

public Class PackageTreeWriter

extends AbstractTreeWriter
Class Inheritance
Imports
javax.lang.model.element.PackageElement, jdk.javadoc.internal.doclets.formats.html.Navigation.PageMode, jdk.javadoc.internal.doclets.formats.html.markup.BodyContents, .HtmlStyles, jdk.javadoc.internal.doclets.toolkit.util.ClassTree, .DocFileIOException, .DocPaths, jdk.javadoc.internal.html.Content, .ContentBuilder, .HtmlTree
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.

Field Summary

Modifier and TypeField and Description
private final BodyContents
bodyContents

protected PackageElement
packageElement

Package for which tree is to be generated.

Inherited from jdk.javadoc.internal.doclets.formats.html.AbstractTreeWriter:
classTree

Constructor Summary

AccessConstructor and Description
public
PackageTreeWriter(HtmlConfiguration
the configuration
configuration, PackageElement
the current package
packageElement)

Constructor.

Method Summary

Modifier and TypeMethod and Description
protected void
addLinkToAllPackages(Content
the content to which the link will be added
target)

Add a link to the tree for all the packages.

public void
buildPage()

Implements abstract jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage.

Generate a separate tree file.

public static void
generate(HtmlConfiguration
the configuration for this run.
configuration, PackageElement
Package for which tree file is to be generated.
pkg, boolean
If true, do not generate any information for deprecated classes or interfaces.
noDeprecated)

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

protected HtmlTree

Returns:

the package tree header
getPackageTreeHeader()

Get the package tree header.

Inherited from jdk.javadoc.internal.doclets.formats.html.AbstractTreeWriter:
addExtendsImplementsaddLevelInfoaddPartialInfoaddTree

Field Detail

bodyContentsback to summary
private final BodyContents bodyContents
packageElementback to summary
protected PackageElement packageElement

Package for which tree is to be generated.

Constructor Detail

PackageTreeWriterback to summary
public PackageTreeWriter(HtmlConfiguration configuration, PackageElement packageElement)

Constructor.

Parameters
configuration:HtmlConfiguration

the configuration

packageElement:PackageElement

the current package

Method Detail

addLinkToAllPackagesback to summary
protected void addLinkToAllPackages(Content target)

Add a link to the tree for all the packages.

Parameters
target:Content

the content to which the link will be added

buildPageback to summary
public void buildPage() throws DocFileIOException

Implements abstract jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage.

Generate a separate tree file.

Annotations
@Override
Exceptions
DocFileIOException:
if there is a problem generating the package tree file
generateback to summary
public static void generate(HtmlConfiguration configuration, PackageElement pkg, boolean noDeprecated) throws DocFileIOException

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

Parameters
configuration:HtmlConfiguration

the configuration for this run.

pkg:PackageElement

Package for which tree file is to be generated.

noDeprecated:boolean

If true, do not generate any information for deprecated classes or interfaces.

Exceptions
DocFileIOException:
if there is a problem generating the package tree page
getPackageTreeHeaderback to summary
protected HtmlTree getPackageTreeHeader()

Get the package tree header.

Returns:HtmlTree

the package tree header