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

public Class HelpWriter

extends HtmlDocletWriter
Class Inheritance
Imports
java.util.List, jdk.javadoc.internal.doclets.formats.html.markup.BodyContents, .HtmlStyles, jdk.javadoc.internal.doclets.formats.html.Navigation.PageMode, jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException, .DocPath, .DocPaths, jdk.javadoc.internal.html.Content, .ContentBuilder, .Entity, .HtmlId, .HtmlTree, .Text
Generate the Help File for the generated API documentation. The help file contents are helpful for browsing the generated documentation.

Field Summary

Modifier and TypeField and Description
pack-priv Content
allClassesLink

pack-priv Content
allPackagesLink

pack-priv Content
indexLink

pack-priv Content
overviewLink

private final String[][]
SEARCH_EXAMPLES

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

Constructor Summary

AccessConstructor and Description
public
HelpWriter(HtmlConfiguration
the configuration
configuration)

Constructor to construct HelpWriter object.

Method Summary

Modifier and TypeMethod and Description
protected void
addHelpFileContents(Content content)

Adds the help file contents from the resource file to the content.

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
getContent(String key)

private Content
getContent(String key, Object arg)

private Content
getContent(String key, Object arg1, Object arg2)

private Content

Returns:

the content containing the help
getNavigationSection()

Creates the navigation help, adding an entry into the main table-of-contents.

private Content

Returns:

the content containing the help
getPageKindSection()

Creates the page-specific help, adding an entry into the main table-of-contents.

private Content
getReleasesSection()

private HtmlTree
newHelpSection(Content headingContent, HtmlId id)

private HtmlTree
newHelpSection(Content headingContent, Navigation.PageMode pm)

private HtmlTree
newHelpSectionList(Content first, Content... rest)

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

Field Detail

SEARCH_EXAMPLESback to summary
private final String[][] SEARCH_EXAMPLES

Constructor Detail

HelpWriterback to summary
public HelpWriter(HtmlConfiguration configuration)

Constructor to construct HelpWriter object.

Parameters
configuration:HtmlConfiguration

the configuration

Method Detail

addHelpFileContentsback to summary
protected void addHelpFileContents(Content content)

Adds the help file contents from the resource file to the content. While adding the help file contents it also keeps track of user options. The general organization is:

  • Heading, and TOC
  • Navigation help
  • Page-specific help
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
getContentback to summary
private Content getContent(String key)
getContentback to summary
private Content getContent(String key, Object arg)
getContentback to summary
private Content getContent(String key, Object arg1, Object arg2)
getNavigationSectionback to summary
private Content getNavigationSection()

Creates the navigation help, adding an entry into the main table-of-contents. The general organization is:

  • General notes
  • Search
Returns:Content

the content containing the help

getPageKindSectionback to summary
private Content getPageKindSection()

Creates the page-specific help, adding an entry into the main table-of-contents. The general organization is:

  • Overview
  • Declaration pages: module, package, classes
  • Derived info for declarations: use and tree
  • General summary info: deprecated, preview
  • Detailed summary info: constant values, search tags, serialized form, system properties
  • Index info: all packages, all classes, full index
Returns:Content

the content containing the help

getReleasesSectionback to summary
private Content getReleasesSection()
newHelpSectionback to summary
private HtmlTree newHelpSection(Content headingContent, HtmlId id)
newHelpSectionback to summary
private HtmlTree newHelpSection(Content headingContent, Navigation.PageMode pm)
newHelpSectionListback to summary
private HtmlTree newHelpSectionList(Content first, Content... rest)