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

Klasse AbstractTreeWriter

java.lang.Object

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

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

Bekannte direkte Unterklassen:

PackageTreeWriter, TreeWriter

public abstract class AbstractTreeWriter
extends HtmlDocletWriter

Abstract class to print the class hierarchy page for all the Classes.

This is subclassed by PackageTreeWriter and TreeWriter to generate the Package Tree and global Tree(for all the classes and packages) pages.

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected final ClassTree	classTree	The class and interface tree built by using 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

Modifizierer	Konstruktor	Beschreibung
protected	AbstractTreeWriter(HtmlConfiguration configuration, DocPath filename, ClassTree classTree)	Constructor.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected void	addExtendsImplements(TypeElement parent, TypeElement typeElement, Content content)	Add information regarding the classes which this class extends or implements.
protected void	addLevelInfo(TypeElement parent, Collection<TypeElement> collection, ClassTree.Hierarchy hierarchy, Content content)	Add each level of the class tree.
protected void	addPartialInfo(TypeElement typeElement, Content content)	Add information about the class kind, if it’s a “class” or “interface”.
protected void	addTree(ClassTree.Hierarchy hierarchy, String heading, Content content)	Adds a class or interface hierarchy with a given heading to given content.

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

classTree

protected final ClassTree classTree

The class and interface tree built by using ClassTree

Konstruktordetails

AbstractTreeWriter

protected AbstractTreeWriter(HtmlConfiguration configuration,
 DocPath filename,
 ClassTree classTree)

Constructor.

This constructor will be used while generating global tree file “overview-tree.html”.

Parameter:

configuration - The current configuration

filename - File to be generated.

classTree - Tree built by ClassTree.

Methodendetails

addLevelInfo

protected void addLevelInfo(TypeElement parent,
 Collection<TypeElement> collection,
 ClassTree.Hierarchy hierarchy,
 Content content)

Add each level of the class tree.

For each subclass or subinterface indents the next level information. Recurses itself to add subclasses info.

Parameter:

parent - the superclass or superinterface of the sset

collection - a collection of the subclasses at this level

hierarchy - the hierarchy for which we are generating a tree

content - the content to which the level information will be added

addTree

protected void addTree(ClassTree.Hierarchy hierarchy,
 String heading,
 Content content)

Adds a class or interface hierarchy with a given heading to given content.

Parameter:

hierarchy - the hierarchy to add

heading - the heading

content - the content to which to add the hierarchy

addExtendsImplements

protected void addExtendsImplements(TypeElement parent,
 TypeElement typeElement,
 Content content)

Add information regarding the classes which this class extends or implements.

Parameter:

parent - the parent class of the class being documented

typeElement - the TypeElement under consideration

content - the content to which the information will be added

addPartialInfo

protected void addPartialInfo(TypeElement typeElement,
 Content content)

Add information about the class kind, if it’s a “class” or “interface”.

Parameter:

typeElement - the class being documented

content - the content to which the information will be added