Package gw.gosudoc.com.sun.tools.doclets.formats.html

Class PackageIndexFrameWriter

java.lang.Object

gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlWriter

gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlDocWriter

gw.gosudoc.com.sun.tools.doclets.formats.html.HtmlDocletWriter

gw.gosudoc.com.sun.tools.doclets.formats.html.AbstractPackageIndexWriter

gw.gosudoc.com.sun.tools.doclets.formats.html.PackageIndexFrameWriter

@Deprecated
public class PackageIndexFrameWriter
extends AbstractPackageIndexWriter

Deprecated.

Generate the package index for the left-hand frame in the generated output. A click on the package name in this frame will update the page in the bottom left hand frame with the listing of contents of the clicked package.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Field Summary

Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.AbstractPackageIndexWriter

packages

Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.HtmlDocletWriter

blockTags, configuration, filename, fixedNavDiv, path, pathToRoot, printedAnnotationFieldHeading, printedAnnotationHeading, utils

Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlDocWriter

CONTENT_TYPE

Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlWriter

allclassesLabel, allpackagesLabel, annotationTypeDetailsLabel, classLabel, constructorDetailsLabel, defaultPackageLabel, deprecatedLabel, deprecatedPhrase, descfrmClassLabel, descfrmInterfaceLabel, descriptionLabel, detailLabel, enumConstantsDetailsLabel, fieldDetailsLabel, framesLabel, helpLabel, indexLabel, memberDetailsListPrinted, methodDetailsLabel, modifierTypeHeader, nextclassLabel, nextLabel, nextpackageLabel, noframesLabel, overridesLabel, overviewLabel, packageLabel, packagesLabel, packageTableHeader, prevclassLabel, prevLabel, prevpackageLabel, propertyDetailsLabel, script, seeLabel, specifiedByLabel, summaryLabel, treeLabel, useLabel, useTableSummary, winTitle

Constructor Summary

Constructors

Constructor	Description
PackageIndexFrameWriter(ConfigurationImpl configuration, DocPath filename)	Deprecated. Construct the PackageIndexFrameWriter object.

Method Summary

Modifier and Type	Method	Description
protected void	addAllClassesLink(Content ul)	Deprecated. Adds "All Classes" link for the top of the left-hand frame page to the documentation tree.
protected void	addNavigationBarFooter(Content body)	Deprecated. Adds the navigation bar footer to the documentation tree.
protected void	addNavigationBarHeader(Content body)	Deprecated. Adds the navigation bar header to the documentation tree.
protected void	addOverviewHeader(Content body)	Deprecated. Do nothing as there is no overview information in this page.
protected void	addPackagesList(Collection<PackageDoc> packages, String text, String tableSummary, Content body)	Deprecated. Adds the packages list to the documentation tree.
static void	generate(ConfigurationImpl configuration)	Deprecated. Generate the package index file named "overview-frame.html".
protected Content	getPackage(PackageDoc pd)	Deprecated. Returns each package name as a separate link.

Methods inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.AbstractPackageIndexWriter

addConfigurationTitle, addIndex, addIndexContents, addOverview, buildPackageIndexFile, getNavLinkContents

Methods inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.HtmlDocletWriter

addAnnotationInfo, addAnnotationInfo, addAnnotationInfo, addBottom, addInlineComment, addInlineComment, addInlineDeprecatedComment, addNavLinks, addPackageDeprecatedAPI, addPreQualifiedClassLink, addPreQualifiedClassLink, addPreQualifiedStrongClassLink, addReceiverAnnotationInfo, addScriptProperties, addSrcLink, addStyleSheetProperties, addSummaryComment, addSummaryComment, addSummaryDeprecatedComment, addSummaryDetailLinks, addTagsInfo, addTop, check, commentTagsToContent, configuration, getAllClassesLinkScript, getAnchor, getAnchor, getAnnotations, getCrossClassLink, getCrossPackageLink, getDocLink, getDocLink, getDocLink, getDocLink, getDocLink, getDocLink, getDocLink, getLink, getMarkerAnchor, getMarkerAnchor, getMarkerAnchor, getMarkerAnchor, getNavHideLists, getNavLinkClass, getNavLinkClassIndex, getNavLinkClassUse, getNavLinkDeprecated, getNavLinkHelp, getNavLinkIndex, getNavLinkMainTree, getNavLinkNext, getNavLinkNext, getNavLinkPackage, getNavLinkPackage, getNavLinkPrevious, getNavLinkPrevious, getNavLinkTree, getNavShowLists, getNavShowLists, getPackageAnchorName, getPackageLabel, getPackageLink, getPackageLink, getPackageName, getPreQualifiedClassLink, getQualifiedClassLink, getSummaryTableHeader, getTableCaption, getTagletWriterInstance, getTargetPackageLink, getTypeParameterLinks, getUserHeaderFooter, getWindowTitle, hasSerializationOverviewTags, isClassLinkable, isCoreClass, italicsClassName, pathString, pathString, printHtmlDocument, removeNonInlineHtmlTags, replaceDocRootDir, seeTagToContent

Methods inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlDocWriter

getDocLink, getDocLink, getDocLink, getGeneratedBy, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getMemberDetailsListPrinted, getName, getPkgName, getStyleSheetProperties, printFramesDocument

Methods inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlWriter

addStyles, close, codeText, generateMethodTypesScript, getBody, getFramesJavaScript, getModifierTypeHeader, getNonBreakResource, getResource, getResource, getResource, getSpace, getTitle, getWinTitleScript, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PackageIndexFrameWriter

public PackageIndexFrameWriter(ConfigurationImpl configuration,
 DocPath filename)
                        throws IOException

Deprecated.

Construct the PackageIndexFrameWriter object.

Parameters:

filename - Name of the package index file to be generated.

Throws:

IOException

Method Details

generate

public static void generate(ConfigurationImpl configuration)

Deprecated.

Generate the package index file named "overview-frame.html".

Throws:

DocletAbortException

addPackagesList

protected void addPackagesList(Collection<PackageDoc> packages,
 String text,
 String tableSummary,
 Content body)

Deprecated.

Adds the packages list to the documentation tree.

Specified by:

addPackagesList in class AbstractPackageIndexWriter

Parameters:

packages - a collection of packagedoc objects

text - caption for the table

tableSummary - summary for the table

body - the document tree to which the packages list will be added

getPackage

protected Content getPackage(PackageDoc pd)

Deprecated.

Returns each package name as a separate link.

Parameters:

pd - PackageDoc

Returns:

content for the package link

addNavigationBarHeader

protected void addNavigationBarHeader(Content body)

Deprecated.

Adds the navigation bar header to the documentation tree.

Specified by:

addNavigationBarHeader in class AbstractPackageIndexWriter

Parameters:

body - the document tree to which the navigation bar header will be added

addOverviewHeader

protected void addOverviewHeader(Content body)

Deprecated.

Do nothing as there is no overview information in this page.

Specified by:

addOverviewHeader in class AbstractPackageIndexWriter

Parameters:

body - the document tree to which the overview header will be added

addAllClassesLink

protected void addAllClassesLink(Content ul)

Deprecated.

Adds "All Classes" link for the top of the left-hand frame page to the documentation tree.

Overrides:

addAllClassesLink in class AbstractPackageIndexWriter

Parameters:

ul - the Content object to which the "All Classes" link should be added

addNavigationBarFooter

protected void addNavigationBarFooter(Content body)

Deprecated.

Adds the navigation bar footer to the documentation tree.

Specified by:

addNavigationBarFooter in class AbstractPackageIndexWriter

Parameters:

body - the document tree to which the navigation bar footer will be added