Class PackageIndexWriter
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.PackageIndexWriter
Deprecated.
Generate the package index page "overview-summary.html" for the right-hand
frame. A click on the package name on this page will update the same frame
with the "package-summary.html" file for 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
FieldsModifier and TypeFieldDescriptionDeprecated.List to store the order groups as specified on the command line.private Map<String,
List<PackageDoc>> Deprecated.Map representing the group of packages as specified on the command line.private HtmlTree
Deprecated.HTML tree for main tag.private RootDoc
Deprecated.Root of the program structure.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
ConstructorsConstructorDescriptionPackageIndexWriter
(ConfigurationImpl configuration, DocPath filename) Deprecated.Construct the PackageIndexWriter. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
Deprecated.Depending upon the grouping information and their titles, add separate table indices for each package group.protected void
Deprecated.Adds the lower navigation bar and the bottom text (from the -bottom option) at the bottom of page.protected void
Deprecated.Adds the top text (from the -top option), the upper navigation bar, and then the title (from the"-title" option), at the top of page.protected void
addOverview
(Content body) Deprecated.Adds the tag information as provided in the file specified by the "-overview" option on the command line.protected void
addOverviewComment
(Content htmltree) Deprecated.Adds the overview comment as provided in the file specified by the "-overview" option on the command line.protected void
addOverviewHeader
(Content body) Deprecated.Adds the overview summary comment for this documentation.protected void
addPackagesList
(Collection<PackageDoc> packages, Content tbody) Deprecated.Adds list of packages in the index table.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 page for the right-hand frame.Methods inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.AbstractPackageIndexWriter
addAllClassesLink, addConfigurationTitle, addIndexContents, 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
-
Field Details
-
root
Deprecated.Root of the program structure. Used for "overview" documentation. -
groupPackageMap
Deprecated.Map representing the group of packages as specified on the command line.- See Also:
-
groupList
Deprecated.List to store the order groups as specified on the command line. -
htmlTree
Deprecated.HTML tree for main tag.
-
-
Constructor Details
-
PackageIndexWriter
Deprecated.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.- Throws:
IOException
- See Also:
-
-
Method Details
-
generate
Deprecated.Generate the package index page for the right-hand frame.- Parameters:
configuration
- the current configuration of the doclet.
-
addIndex
Deprecated.Depending upon the grouping information and their titles, add separate table indices for each package group.- Overrides:
addIndex
in classAbstractPackageIndexWriter
- Parameters:
body
- the documentation tree to which the index will be added
-
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 classAbstractPackageIndexWriter
- Parameters:
packages
- a collection of packagedoc objectstext
- caption for the tabletableSummary
- summary for the tablebody
- the document tree to which the packages list will be added
-
addPackagesList
Deprecated.Adds list of packages in the index table. Generate link to each package.- Parameters:
packages
- Packages to which link is to be generatedtbody
- the documentation tree to which the list will be added
-
addOverviewHeader
Deprecated.Adds the overview summary comment for this documentation. Add one line summary at the top of the page and generate a link to the description, which is added at the end of this page.- Specified by:
addOverviewHeader
in classAbstractPackageIndexWriter
- Parameters:
body
- the documentation tree to which the overview header will be added
-
addOverviewComment
Deprecated.Adds the overview comment as provided in the file specified by the "-overview" option on the command line.- Parameters:
htmltree
- the documentation tree to which the overview comment will be added
-
addOverview
Deprecated.Adds the tag information as provided in the file specified by the "-overview" option on the command line.- Overrides:
addOverview
in classAbstractPackageIndexWriter
- Parameters:
body
- the documentation tree to which the overview will be added- Throws:
IOException
-