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

public Class SearchWriter

extends HtmlDocletWriter
Class Inheritance
Imports
jdk.javadoc.internal.doclets.formats.html.Navigation.PageMode, jdk.javadoc.internal.doclets.formats.html.markup.BodyContents, .HtmlStyles, jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException, .DocPaths, jdk.javadoc.internal.html.Content, .ContentBuilder, .Entity, .HtmlAttr, .HtmlId, .HtmlTag, .HtmlTree, .Text, javax.lang.model.element.ModuleElement

Generates the search landing page for the generated API documentation.

Field Summary

Inherited from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter:
comparatorsconfigurationcontentsdocPathshtmlIdsindexAnchorTablelinksmainBodyScriptmessagesoptionspathpathToRootresourcestableOfContentsutilswinTitle

Constructor Summary

AccessConstructor and Description
public
SearchWriter(HtmlConfiguration
the configuration
configuration
)

Constructor to construct SearchWriter object.

Method Summary

Modifier and TypeMethod and Description
protected void
addSearchFileContents(Content contentTree)

Adds the search file contents to the content tree.

public void
buildPage()

Implements abstract jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage.

The top-level method to generate and write the page represented by this writer.

private Content
private Content
Inherited from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter:
addInlineCommentaddInlineCommentaddInlineDeprecatedCommentaddPreQualifiedClassLinkaddPreQualifiedClassLinkaddPreQualifiedStrongClassLinkaddPreviewCommentaddPreviewInfoaddPreviewSummaryaddRestrictedInfoaddRestrictedSummaryaddSrcLinkaddSummaryCommentaddSummaryCommentaddSummaryDeprecatedCommentaddTagsInfocommentTagsToContentcommentTagsToContentcommentTagsToContentcreateTableOfContentsgetAnnotationInfogetAnnotationInfogetAnnotationsgetBlockTagOutputgetBlockTagOutputgetBodygetBodyStylegetCrossClassLinkgetCrossModuleLinkgetCrossPackageLinkgetCurrentTypeElementgetDeprecatedPhrasegetDescriptiongetDocLinkgetDocLinkgetDocLinkgetDocLinkgetDocLinkgetEnclosingPackageNamegetFileTitlegetFootergetGeneratorgetHeadergetHeadergetLinkgetLocalizedPackageNamegetLocalStylesheetsgetModuleLinkgetModuleLinkgetNavBargetNavLinkToOverviewTreegetPackageLabelgetPackageLinkgetPackageLinkgetPackageTableHeadergetPreQualifiedClassLinkgetQualifiedClassLinkgetTagletWriterInstancegetTagletWriterInstancegetTypeParameterLinksgetWindowTitlehasSerializationOverviewTagsignoreNonInlineTaginvalidTagOutputisIndexablepathStringpathStringprintHtmlDocumentprintHtmlDocumentprintHtmlDocumentreplaceDocRootDirresolveExternalSpecURIwriteGenerating

Constructor Detail

SearchWriterback to summary
public SearchWriter(HtmlConfiguration configuration)

Constructor to construct SearchWriter object.

Parameters
configuration:HtmlConfiguration

the configuration

Method Detail

addSearchFileContentsback to summary
protected void addSearchFileContents(Content contentTree)

Adds the search file contents to the content tree.

buildPageback to summary
public void buildPage() throws DocFileIOException

Implements abstract jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage.

Doc from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage.

The top-level method to generate and write the page represented by this writer.

Annotations
@Override
createModuleSelectorback to summary
private Content createModuleSelector()
createResourceSectionback to summary
private Content createResourceSection()