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

Klasse AllClassesIndexWriter

java.lang.Object

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

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

public class AllClassesIndexWriter
extends HtmlDocletWriter

Generate the file with list of all the classes in this run.

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected IndexBuilder	indexBuilder	Index of all the classes.

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
AllClassesIndexWriter(HtmlConfiguration configuration, DocPath filename, IndexBuilder indexBuilder)	Construct AllClassesIndexWriter object.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected void	addContents(Content target)	Add all types to the content.
protected void	addTableRow(Table<TypeElement> table, TypeElement klass)	Add table row.
protected void	buildAllClassesFile()	Print all the classes in the file.
static void	generate(HtmlConfiguration configuration, IndexBuilder indexBuilder)	Create AllClassesIndexWriter object.

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

indexBuilder

protected IndexBuilder indexBuilder

Index of all the classes.

Konstruktordetails

AllClassesIndexWriter

public AllClassesIndexWriter(HtmlConfiguration configuration,
 DocPath filename,
 IndexBuilder indexBuilder)

Construct AllClassesIndexWriter object.

Also initializes the indexBuilder variable in this class.

Parameter:

configuration - The current configuration

filename - Path to the file which is getting generated.

indexBuilder - Unicode based Index from IndexBuilder

Methodendetails

generate

public static void generate(HtmlConfiguration configuration,
 IndexBuilder indexBuilder)
                     throws DocFileIOException

Create AllClassesIndexWriter object.

Parameter:

configuration - The current configuration

indexBuilder - IndexBuilder object for all classes index.

Löst aus:

DocFileIOException

buildAllClassesFile

protected void buildAllClassesFile()
                            throws DocFileIOException

Print all the classes in the file.

Löst aus:

DocFileIOException

addContents

protected void addContents(Content target)

Add all types to the content.

Parameter:

target - the content to which the links will be added

addTableRow

protected void addTableRow(Table<TypeElement> table,
 TypeElement klass)

Add table row.

Parameter:

table - the table to which the row will be added

klass - the type to be added to the table