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

public Class PackageIndexWriter

extends AbstractOverviewIndexWriter
Class Inheritance
Imports
java.util.Map, .Set, .SortedSet, javax.lang.model.element.PackageElement, jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyles, jdk.javadoc.internal.doclets.toolkit.util.DocPaths, .Group, jdk.javadoc.internal.html.Content, .ContentBuilder, .Text
Generate the package index page "index.html".

Field Summary

Modifier and TypeField and Description
protected SortedSet<PackageElement>
packages

The Set of Packages to be documented.

Constructor Summary

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

Construct the PackageIndexWriter.

Method Summary

Modifier and TypeMethod and Description
protected void
addIndex(Content
the content to which the packages list will be added
target)

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractOverviewIndexWriter.addIndex.

Adds the packages list to the documentation tree.

public String
getDescription()

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

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

public String
getTitleKey()

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

Returns the title for the page.

Inherited from jdk.javadoc.internal.doclets.formats.html.AbstractOverviewIndexWriter:
addConfigurationTitleaddOverviewCommentaddOverviewHeaderaddOverviewTagsbuildPageisIndexable

Field Detail

packagesback to summary
protected SortedSet<PackageElement> packages

The Set of Packages to be documented.

Constructor Detail

PackageIndexWriterback to summary
public PackageIndexWriter(HtmlConfiguration configuration)

Construct the PackageIndexWriter. Also constructs the grouping information as provided on the command line by "-group" option. Stores the order of groups specified by the user.

Parameters
configuration:HtmlConfiguration

the configuration for this doclet

See Also
Group

Method Detail

addIndexback to summary
protected void addIndex(Content target)

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractOverviewIndexWriter.addIndex.

Adds the packages list to the documentation tree.

Parameters
target:Content

the content to which the packages list will be added

Annotations
@Override
getDescriptionback to summary
public String getDescription()

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

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

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

Annotations
@Override
getTitleKeyback to summary
public String getTitleKey()

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

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

Returns the title for the page.

Annotations
@Override