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

Klasse PackageWriterImpl

java.lang.Object

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

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

Alle implementierten Schnittstellen:

PackageSummaryWriter

public class PackageWriterImpl
extends HtmlDocletWriter
implements PackageSummaryWriter

Class to generate file for each package contents in the right-hand frame.

This will list all the Class Kinds in the package. A click on any class-kind will update the frame with the clicked class-kind page.

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected PackageElement	packageElement	The package being documented.

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
PackageWriterImpl(HtmlConfiguration configuration, PackageElement packageElement)	Constructor to construct PackageWriter object and to generate “package-summary.html” file in the respective package directory.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	addAllClassesAndInterfacesSummary(Content target)	Add all types to the content.
void	addDeprecationInfo(Content div)	Add the package deprecation information to the documentation tree.
void	addPackageContent(Content packageContent)	Adds the tag information from the “packages.html” or “package-info.java” file to the documentation.
void	addPackageDescription(Content packageContent)	Adds the package description from the “packages.html” file to the documentation.
void	addPackageFooter()	Adds the footer to the documentation.
void	addPackageSignature(Content packageContent)	Adds the package signature.
void	addPackageSummary(List<PackageElement> packages, Content label, TableHeader tableHeader, Content summaryContent, boolean showModules)
void	addPackageTags(Content packageContent)	Adds the tag information from the “packages.html” file to the documentation.
void	addRelatedPackagesSummary(Content summaryContent)	Adds the table of related packages to the documentation.
Content	getContentHeader()	Get the header for the package content.
protected Navigation	getNavBar(Navigation.PageMode pageMode, Element element)	Returns a basic navigation bar for a kind of page and element.
Content	getPackageHeader()	Get the header for the summary.
Content	getPackageSummary(Content summaryContent)	Gets the package summary.
Content	getSummariesList()	Get the header for the package summary.
void	printDocument(Content content)	Print the package summary document.

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

The package being documented.

Konstruktordetails

PackageWriterImpl

public PackageWriterImpl(HtmlConfiguration configuration,
 PackageElement packageElement)

Constructor to construct PackageWriter object and to generate “package-summary.html” file in the respective package directory.

For example for package “java.lang” this will generate file “package-summary.html” file in the “java/lang” directory. It will also create “java/lang” directory in the current or the destination directory if it doesn’t exist.

Parameter:

configuration - the configuration of the doclet.

packageElement - PackageElement under consideration.

Methodendetails

getPackageHeader

public Content getPackageHeader()

Beschreibung aus Schnittstelle kopiert: PackageSummaryWriter

Get the header for the summary.

Angegeben von:

getPackageHeader in Schnittstelle PackageSummaryWriter

Gibt zurück:

the header to be added to the content

getContentHeader

public Content getContentHeader()

Beschreibung aus Schnittstelle kopiert: PackageSummaryWriter

Get the header for the package content.

Angegeben von:

getContentHeader in Schnittstelle PackageSummaryWriter

Gibt zurück:

the package content 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

addDeprecationInfo

public void addDeprecationInfo(Content div)

Add the package deprecation information to the documentation tree.

Parameter:

div - the content to which the deprecation information will be added

getSummariesList

public Content getSummariesList()

Beschreibung aus Schnittstelle kopiert: PackageSummaryWriter

Get the header for the package summary.

Angegeben von:

getSummariesList in Schnittstelle PackageSummaryWriter

Gibt zurück:

the package summary header

addRelatedPackagesSummary

public void addRelatedPackagesSummary(Content summaryContent)

Beschreibung aus Schnittstelle kopiert: PackageSummaryWriter

Adds the table of related packages to the documentation.

Angegeben von:

addRelatedPackagesSummary in Schnittstelle PackageSummaryWriter

Parameter:

summaryContent - the content to which the summaries will be added

addAllClassesAndInterfacesSummary

public void addAllClassesAndInterfacesSummary(Content target)

Add all types to the content.

Angegeben von:

addAllClassesAndInterfacesSummary in Schnittstelle PackageSummaryWriter

Parameter:

target - the content to which the links will be added

addPackageSummary

public void addPackageSummary(List<PackageElement> packages,
 Content label,
 TableHeader tableHeader,
 Content summaryContent,
 boolean showModules)

addPackageDescription

public void addPackageDescription(Content packageContent)

Beschreibung aus Schnittstelle kopiert: PackageSummaryWriter

Adds the package description from the “packages.html” file to the documentation.

Angegeben von:

addPackageDescription in Schnittstelle PackageSummaryWriter

Parameter:

packageContent - the content to which the package description will be added

addPackageTags

public void addPackageTags(Content packageContent)

Beschreibung aus Schnittstelle kopiert: PackageSummaryWriter

Adds the tag information from the “packages.html” file to the documentation.

Angegeben von:

addPackageTags in Schnittstelle PackageSummaryWriter

Parameter:

packageContent - the content to which the package tags will be added

addPackageSignature

public void addPackageSignature(Content packageContent)

Beschreibung aus Schnittstelle kopiert: PackageSummaryWriter

Adds the package signature.

Angegeben von:

addPackageSignature in Schnittstelle PackageSummaryWriter

Parameter:

packageContent - the content to which the package signature will be added

addPackageContent

public void addPackageContent(Content packageContent)

Beschreibung aus Schnittstelle kopiert: PackageSummaryWriter

Adds the tag information from the “packages.html” or “package-info.java” file to the documentation.

Angegeben von:

addPackageContent in Schnittstelle PackageSummaryWriter

Parameter:

packageContent - the package content to be added

addPackageFooter

public void addPackageFooter()

Beschreibung aus Schnittstelle kopiert: PackageSummaryWriter

Adds the footer to the documentation.

Angegeben von:

addPackageFooter in Schnittstelle PackageSummaryWriter

printDocument

public void printDocument(Content content)
                   throws DocFileIOException

Beschreibung aus Schnittstelle kopiert: PackageSummaryWriter

Print the package summary document.

Angegeben von:

printDocument in Schnittstelle PackageSummaryWriter

Parameter:

content - the content that will be printed

Löst aus:

DocFileIOException - if there is a problem while writing the document

getPackageSummary

public Content getPackageSummary(Content summaryContent)

Beschreibung aus Schnittstelle kopiert: PackageSummaryWriter

Gets the package summary.

Angegeben von:

getPackageSummary in Schnittstelle PackageSummaryWriter

Parameter:

summaryContent - the content representing the package summary

Gibt zurück:

the package summary