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

Klasse PreviewListWriter

java.lang.Object

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

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

org.jdrupes.mdoclet.internal.doclets.formats.html.SummaryListWriter<PreviewAPIListBuilder>

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

public class PreviewListWriter
extends SummaryListWriter<PreviewAPIListBuilder>

Generate File to list all the preview elements with the appropriate links.

Feldübersicht

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

builder

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

bodyContents

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
PreviewListWriter(HtmlConfiguration configuration, DocPath filename)	Constructor.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected void	addComments(Element e, Content desc)	Add summary text for the given element.
protected void	addContentSelectors(Content target)	Subclasses allow the user to show or hide parts of the content in the page.
protected void	addTableTabs(Table<Element> table, String headingKey)	Allow subclasses to add extra tabs to the element tables.
static void	generate(HtmlConfiguration configuration)	Get list of all the preview elements.
protected HtmlStyle[]	getColumnStyles()	Gets the array of styles to use for table columns.
protected Content	getExtraContent(Element element)	Some subclasses of this class display an extra column in their element tables.
protected TableHeader	getTableHeader(String headerKey)	Gets the table header to use for a table with the first column identified by headerKey.

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

addExtraIndexLink, addExtraSection, addIndexLink, addSummaryAPI, generateSummaryListFile, getContentsList, getHeader, getHeadingKey, getSummaryLink, getTableCaption

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

addAnnotationContent, addClassContent, addIndexComment, addIndexComment, addInheritedMemberSummary, addInheritedSummaryHeader, addSummary, addSummaryHeader, addSummaryLinkComment, addSummaryLinkComment, getContentHeader, getDetailsList, getDetailsListItem, getMember, getMember, getMemberDetailsContent, getMemberHeader, getMemberInherited, getMemberList, getMemberListItem, getMemberSummary, getSummariesList, getSummariesListItem

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

Konstruktordetails

PreviewListWriter

public PreviewListWriter(HtmlConfiguration configuration,
 DocPath filename)

Constructor.

Parameter:

configuration - the configuration for this doclet

filename - the file to be generated

Methodendetails

generate

public static void generate(HtmlConfiguration configuration)
                     throws DocFileIOException

Get list of all the preview elements.

Then instantiate PreviewListWriter and generate File.

Parameter:

configuration - the current configuration of the doclet.

Löst aus:

DocFileIOException - if there is a problem writing the preview list

addContentSelectors

protected void addContentSelectors(Content target)

Beschreibung aus Klasse kopiert: SummaryListWriter

Subclasses allow the user to show or hide parts of the content in the page.

This method should be used to add the UI to select the visible page content.

Angegeben von:

addContentSelectors in Klasse SummaryListWriter<PreviewAPIListBuilder>

Parameter:

target - the content to which the UI should be added

addComments

protected void addComments(Element e,
 Content desc)

Beschreibung aus Klasse kopiert: SummaryListWriter

Add summary text for the given element.

Setzt außer Kraft:

addComments in Klasse SummaryListWriter<PreviewAPIListBuilder>

Parameter:

e - the element for which the summary text should be added

desc - the content to which the text should be added

addTableTabs

protected void addTableTabs(Table<Element> table,
 String headingKey)

Beschreibung aus Klasse kopiert: SummaryListWriter

Allow subclasses to add extra tabs to the element tables.

Angegeben von:

addTableTabs in Klasse SummaryListWriter<PreviewAPIListBuilder>

Parameter:

table - the element table

headingKey - the key for the caption (default tab)

getExtraContent

protected Content getExtraContent(Element element)

Beschreibung aus Klasse kopiert: SummaryListWriter

Some subclasses of this class display an extra column in their element tables.

This methods allows them to return the content to show for element.

Angegeben von:

getExtraContent in Klasse SummaryListWriter<PreviewAPIListBuilder>

Parameter:

element - the element

Gibt zurück:

content for extra content or null

getTableHeader

protected TableHeader getTableHeader(String headerKey)

Beschreibung aus Klasse kopiert: SummaryListWriter

Gets the table header to use for a table with the first column identified by headerKey.

Setzt außer Kraft:

getTableHeader in Klasse SummaryListWriter<PreviewAPIListBuilder>

Parameter:

headerKey - the header key for the first table column

Gibt zurück:

the table header

getColumnStyles

protected HtmlStyle[] getColumnStyles()

Beschreibung aus Klasse kopiert: SummaryListWriter

Gets the array of styles to use for table columns.

The length of the returned array must match the number of column headers returned by SummaryListWriter.getTableHeader(String).

Setzt außer Kraft:

getColumnStyles in Klasse SummaryListWriter<PreviewAPIListBuilder>

Gibt zurück:

the styles to use for table columns