APIdia Launch Partner
Top Description Fields Constructors Methods
jdk.javadoc.internal.doclets.formats.html

public Class PreviewListWriter

extends SummaryListWriter<PreviewAPIListBuilder>
Class Inheritance
Imports
java.util.List, .Set, javax.lang.model.element.Element, com.sun.source.doctree.DocTree, .UnknownBlockTagTree, jdk.javadoc.internal.doclets.formats.html.Navigation.PageMode, jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyles, jdk.javadoc.internal.doclets.toolkit.util.DocPaths, .PreviewAPIListBuilder, jdk.javadoc.internal.html.Content, .ContentBuilder, .HtmlId, .HtmlStyle, .HtmlTree, .Text
Generate File to list all the preview elements with the appropriate links.

Field Summary

Inherited from jdk.javadoc.internal.doclets.formats.html.SummaryListWriter:
builderID_ALLID_OTHER

Constructor Summary

AccessConstructor and Description
public
PreviewListWriter(HtmlConfiguration
the configuration for this doclet
configuration)

Constructor.

Method Summary

Modifier and TypeMethod and Description
protected void
addComments(Element e, Content desc)

Overrides jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.addComments.

Add summary text for the given element.

protected void
addContentSelectors(Content target)

Overrides jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.addContentSelectors.

Allow Subclasses to add a content selector UI such as a row of radio buttons near the top of the page.

protected void
addSummaries(Content content)

Overrides jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.addSummaries.

Add all API summary tables to the main content of the page.

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

Overrides jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.addTableTabs.

Allow subclasses to add extra tabs to the element tables.

protected HtmlStyle[]
getColumnStyles()

Overrides jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getColumnStyles.

Gets the array of styles to use for table columns.

protected String
getDescription()

Implements abstract jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getDescription.

Returns the page descrition, for the <meta> element.

protected Content
getExtraContent(Element element)

Overrides jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getExtraContent.

Allow subclasses to add an extra table column for an element.

protected Content
getHeadContent()

Implements abstract jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getHeadContent.

Returns the heading for the page.

protected Navigation.PageMode
getPageMode()

Implements abstract jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getPageMode.

Returns the page mode to use.

protected TableHeader
getTableHeader(String headerKey)

Overrides jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getTableHeader.

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

protected String
getTitleKey()

Implements abstract jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getTitleKey.

Returns the title for the page.

Inherited from jdk.javadoc.internal.doclets.formats.html.SummaryListWriter:
addSummaryAPIbuildPagegetCheckboxgetHeadergetHeadingKeygetIndexLinkgetSummaryLinkgetTableCaptionshowContentsList

Constructor Detail

PreviewListWriterback to summary
public PreviewListWriter(HtmlConfiguration configuration)

Constructor.

Parameters
configuration:HtmlConfiguration

the configuration for this doclet

Method Detail

addCommentsback to summary
protected void addComments(Element e, Content desc)

Overrides jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.addComments.

Doc from jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.addComments.

Add summary text for the given element.

Annotations
@Override
addContentSelectorsback to summary
protected void addContentSelectors(Content target)

Overrides jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.addContentSelectors.

Doc from jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.addContentSelectors.

Allow Subclasses to add a content selector UI such as a row of radio buttons near the top of the page. This method does not add anything.

Annotations
@Override
addSummariesback to summary
protected void addSummaries(Content content)

Overrides jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.addSummaries.

Doc from jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.addSummaries.

Add all API summary tables to the main content of the page.

Annotations
@Override
addTableTabsback to summary
protected void addTableTabs(Table<Element> table, String headingKey)

Overrides jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.addTableTabs.

Doc from jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.addTableTabs.

Allow subclasses to add extra tabs to the element tables. This method does not add any tabs.

Annotations
@Override
getColumnStylesback to summary
protected HtmlStyle[] getColumnStyles()

Overrides jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getColumnStyles.

Doc from jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getColumnStyles.

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 getTableHeader(String).

Annotations
@Override
getDescriptionback to summary
protected String getDescription()

Implements abstract jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getDescription.

Doc from jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getDescription.

Returns the page descrition, for the <meta> element.

Annotations
@Override
getExtraContentback to summary
protected Content getExtraContent(Element element)

Overrides jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getExtraContent.

Doc from jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getExtraContent.

Allow subclasses to add an extra table column for an element. Return null for no extra content.

Annotations
@Override
getHeadContentback to summary
protected Content getHeadContent()

Implements abstract jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getHeadContent.

Doc from jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getHeadContent.

Returns the heading for the page.

Annotations
@Override
getIndexLinksback to summary
protected List<Content> getIndexLinks()

Overrides jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getIndexLinks.

Doc from jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getIndexLinks.

Returns a list of list items containing the links for the table of contents.

Annotations
@Override
getPageModeback to summary
protected Navigation.PageMode getPageMode()

Implements abstract jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getPageMode.

Doc from jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getPageMode.

Returns the page mode to use.

Annotations
@Override
getTableHeaderback to summary
protected TableHeader getTableHeader(String headerKey)

Overrides jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getTableHeader.

Doc from jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getTableHeader.

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

Annotations
@Override
getTitleKeyback to summary
protected String getTitleKey()

Implements abstract jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getTitleKey.

Doc from jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getTitleKey.

Returns the title for the page.

Annotations
@Override