Package org.jdrupes.mdoclet.internal.doclets.formats.html

Klasse PackageTreeWriter

java.lang.Object

org.jdrupes.mdoclet.internal.doclets.formats.html.HtmlDocletWriter

org.jdrupes.mdoclet.internal.doclets.formats.html.AbstractTreeWriter

org.jdrupes.mdoclet.internal.doclets.formats.html.PackageTreeWriter

public class PackageTreeWriter
extends AbstractTreeWriter

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.

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected PackageElement	packageElement	Package for which tree is to be generated.

Von Klasse geerbte Felder org.jdrupes.mdoclet.internal.doclets.formats.html.AbstractTreeWriter

classTree

Von Klasse geerbte Felder org.jdrupes.mdoclet.internal.doclets.formats.html.HtmlDocletWriter

comparators, configuration, contents, docPaths, filename, htmlIds, links, mainBodyScript, messages, options, path, pathToRoot, resources, utils, winTitle

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
PackageTreeWriter(HtmlConfiguration configuration, DocPath path, PackageElement packageElement)	Constructor.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected void	addLinkToAllPackages(Content target)	Add a link to the tree for all the packages.
static void	generate(HtmlConfiguration configuration, PackageElement pkg, boolean noDeprecated)	Construct a PackageTreeWriter object and then use it to generate the package tree page.
protected void	generatePackageTreeFile()	Generate a separate tree file.
protected Navigation	getNavBar(Navigation.PageMode pageMode, Element element)	Returns a basic navigation bar for a kind of page and element.
protected HtmlTree	getPackageTreeHeader()	Get the package tree header.

Von Klasse geerbte Methoden org.jdrupes.mdoclet.internal.doclets.formats.html.AbstractTreeWriter

addExtendsImplements, addLevelInfo, addPartialInfo, addTree

Von Klasse geerbte Methoden org.jdrupes.mdoclet.internal.doclets.formats.html.HtmlDocletWriter

addInlineComment, addInlineComment, addInlineDeprecatedComment, addPreQualifiedClassLink, addPreQualifiedClassLink, addPreQualifiedStrongClassLink, addPreviewComment, addPreviewInfo, addPreviewSummary, addSrcLink, addSummaryComment, addSummaryComment, addSummaryDeprecatedComment, addTagsInfo, commentTagsToContent, commentTagsToContent, commentTagsToContent, getAnnotations, getBlockTagOutput, getBlockTagOutput, getBody, getBodyStyle, getCrossClassLink, getCrossModuleLink, getCrossPackageLink, getCurrentPageElement, getDeprecatedPhrase, getDocLink, getDocLink, getDocLink, getDocLink, getDocLink, getEnclosingPackageName, getFooter, getHeader, getHeader, getLink, getLocalizedPackageName, getModuleLink, getModuleLink, getNavLinkToOverviewTree, getPackageLabel, getPackageLink, getPackageLink, getPackageTableHeader, getPreQualifiedClassLink, getQualifiedClassLink, getTagletWriterInstance, getTagletWriterInstance, getTypeParameterLinks, getWindowTitle, hasSerializationOverviewTags, invalidTagOutput, pathString, pathString, printHtmlDocument, printHtmlDocument, printHtmlDocument, replaceDocRootDir, resolveExternalSpecURI

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

packageElement

protected PackageElement packageElement

Package for which tree is to be generated.

Konstruktordetails

PackageTreeWriter

public PackageTreeWriter(HtmlConfiguration configuration,
 DocPath path,
 PackageElement packageElement)

Constructor.

Parameter:

configuration - the configuration

path - the docpath to generate files into

packageElement - the current package

Methodendetails

generate

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.

Parameter:

configuration - the configuration for this run.

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

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

Löst aus:

DocFileIOException - if there is a problem generating the package tree page

generatePackageTreeFile

protected void generatePackageTreeFile()
                                throws DocFileIOException

Generate a separate tree file.

Löst aus:

DocFileIOException - if there is a problem generating the package tree file

getPackageTreeHeader

protected HtmlTree getPackageTreeHeader()

Get the package tree header.

Gibt zurück:

the package tree header

getNavBar

protected Navigation getNavBar(Navigation.PageMode pageMode,
 Element element)

Beschreibung aus Klasse kopiert: HtmlDocletWriter

Returns a basic navigation bar for a kind of page and element.

Setzt außer Kraft:

getNavBar in Klasse HtmlDocletWriter

Parameter:

pageMode - the page mode

element - the defining element for the navigation bar, or null if none

Gibt zurück:

the basic navigation bar

addLinkToAllPackages

protected void addLinkToAllPackages(Content target)

Add a link to the tree for all the packages.

Parameter:

target - the content to which the link will be added