public Class TreeWriter

Class Inheritance

java.lang.Object
jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter
jdk.javadoc.internal.doclets.formats.html.AbstractTreeWriter
jdk.javadoc.internal.doclets.formats.html.TreeWriter

Imports

java.util.SortedSet, 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, .DocPath, .DocPaths, jdk.javadoc.internal.html.Content, .ContentBuilder, .HtmlTree

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.

Field Summary

Modifier and Type	Field and Description
protected BodyContents	bodyContents
private final boolean	classesOnly True if there are no packages specified on the command line, False otherwise.
pack-priv SortedSet<PackageElement>	packages Packages in this run.

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

Constructor Summary

Access	Constructor and Description
public	TreeWriter(HtmlConfiguration the current configuration of the doclet configuration, ClassTree the tree being built. classTree) Constructor to construct TreeWriter object.

Method Summary

Modifier and Type	Method and Description
protected void	addPackageTreeLinks(Content the content to which the links will be added content) Add the links to all the package tree files.
public void	buildPage() Implements abstract jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage. The top-level method to generate and write the page represented by this writer.
private HtmlTree	Returns: a new HTML BODY element getBody() Returns a new HTML BODY element.
private boolean	isUnnamedPackage()

Inherited from jdk.javadoc.internal.doclets.formats.html.AbstractTreeWriter:: addExtendsImplements addLevelInfo addPartialInfo addTree

Field Detail

bodyContents	back to summary
protected BodyContents bodyContents

classesOnly	back to summary
private final boolean classesOnly True if there are no packages specified on the command line, False otherwise.

packages	back to summary
pack-priv SortedSet<PackageElement> packages Packages in this run.

Constructor Detail

TreeWriter	back to summary
public TreeWriter(HtmlConfiguration configuration, ClassTree classTree) Constructor to construct TreeWriter object. Parameters configuration:HtmlConfiguration the current configuration of the doclet classTree:ClassTree the tree being built.

TreeWriter

back to summary

public TreeWriter(HtmlConfiguration configuration, ClassTree classTree)

Constructor to construct TreeWriter object.

Parameters

configuration:HtmlConfiguration: the current configuration of the doclet
classTree:ClassTree: the tree being built.

Method Detail

addPackageTreeLinks	back to summary
protected void addPackageTreeLinks(Content content) Add the links to all the package tree files. Parameters content:Content the content to which the links will be added

addPackageTreeLinks

back to summary

protected void addPackageTreeLinks(Content content)

Add the links to all the package tree files.

Parameters

content:Content: the content to which the links will be added

buildPage	back to summary
public void buildPage() throws DocFileIOException Implements abstract jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage. Doc from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage. The top-level method to generate and write the page represented by this writer. Annotations @Override

buildPage

back to summary

public void buildPage() throws DocFileIOException

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

Doc from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage.

The top-level method to generate and write the page represented by this writer.

Annotations

@Override

getBody	back to summary
private HtmlTree getBody() Returns a new HTML BODY element. Returns:HtmlTree a new HTML BODY element

getBody

back to summary

private HtmlTree getBody()

Returns a new HTML BODY element.

Returns:HtmlTree: a new HTML BODY element

isUnnamedPackage	back to summary
private boolean isUnnamedPackage()