Class AbstractPackageIndexWriter
- 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
-
- Direct Known Subclasses:
PackageIndexFrameWriter
,PackageIndexWriter
@Deprecated public abstract class AbstractPackageIndexWriter extends HtmlDocletWriter
Deprecated.Abstract class to generate the overview files in Frame and Non-Frame format. This will be sub-classed by to generate overview-frame.html as well as overview-summary.html.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.
- Author:
- Atul M Dambalkar, Bhavesh Patel (Modified)
-
-
Field Summary
Fields Modifier and Type Field Description protected SortedSet<PackageDoc>
packages
Deprecated.A Set of Packages to be documented.-
Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.HtmlDocletWriter
configuration, filename, 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 AbstractPackageIndexWriter(ConfigurationImpl configuration, DocPath filename)
Deprecated.Constructor.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected void
addAllClassesLink(Content div)
Deprecated.Do nothing.protected void
addConfigurationTitle(Content body)
Deprecated.Adds the doctitle to the documentation tree, if it is specified on the command line.protected void
addIndex(Content body)
Deprecated.Adds the frame or non-frame package index to the documentation tree.protected void
addIndexContents(Collection<PackageDoc> packages, String text, String tableSummary, Content body)
Deprecated.Adds package index contents.protected abstract void
addNavigationBarFooter(Content body)
Deprecated.Adds the navigation bar footer to the documentation tree.protected abstract void
addNavigationBarHeader(Content body)
Deprecated.Adds the navigation bar header to the documentation tree.protected void
addOverview(Content body)
Deprecated.Default to no overview, override to add overview.protected abstract void
addOverviewHeader(Content body)
Deprecated.Adds the overview header to the documentation tree.protected abstract void
addPackagesList(Collection<PackageDoc> packages, String text, String tableSummary, Content body)
Deprecated.Adds the packages list to the documentation tree.protected void
buildPackageIndexFile(String title, boolean includeScript)
Deprecated.Generate and prints the contents in the package index file.protected Content
getNavLinkContents()
Deprecated.Returns highlighted "Overview", in the navigation bar as this is the overview page.-
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, 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 Detail
-
packages
protected SortedSet<PackageDoc> packages
Deprecated.A Set of Packages to be documented.
-
-
Constructor Detail
-
AbstractPackageIndexWriter
public AbstractPackageIndexWriter(ConfigurationImpl configuration, DocPath filename) throws IOException
Deprecated.Constructor. Also initializes the packages variable.- Parameters:
configuration
- The current configurationfilename
- Name of the package index file to be generated.- Throws:
IOException
-
-
Method Detail
-
addNavigationBarHeader
protected abstract void addNavigationBarHeader(Content body)
Deprecated.Adds the navigation bar header to the documentation tree.- Parameters:
body
- the document tree to which the navigation bar header will be added
-
addNavigationBarFooter
protected abstract void addNavigationBarFooter(Content body)
Deprecated.Adds the navigation bar footer to the documentation tree.- Parameters:
body
- the document tree to which the navigation bar footer will be added
-
addOverviewHeader
protected abstract void addOverviewHeader(Content body)
Deprecated.Adds the overview header to the documentation tree.- Parameters:
body
- the document tree to which the overview header will be added
-
addPackagesList
protected abstract void addPackagesList(Collection<PackageDoc> packages, String text, String tableSummary, Content body)
Deprecated.Adds the packages list to the documentation tree.- 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
-
buildPackageIndexFile
protected void buildPackageIndexFile(String title, boolean includeScript) throws IOException
Deprecated.Generate and prints the contents in the package index file. Call appropriate methods from the sub-class in order to generate Frame or Non Frame format.- Parameters:
title
- the title of the window.includeScript
- boolean set true if windowtitle script is to be included- Throws:
IOException
-
addOverview
protected void addOverview(Content body) throws IOException
Deprecated.Default to no overview, override to add overview.- Parameters:
body
- the document tree to which the overview will be added- Throws:
IOException
-
addIndex
protected void addIndex(Content body)
Deprecated.Adds the frame or non-frame package index to the documentation tree.- Parameters:
body
- the document tree to which the index will be added
-
addIndexContents
protected void addIndexContents(Collection<PackageDoc> packages, String text, String tableSummary, Content body)
Deprecated.Adds package index contents. Call appropriate methods from the sub-classes. Adds it to the body HtmlTree- Parameters:
packages
- a collection of packages to be documentedtext
- string which will be used as the headingtableSummary
- summary for the tablebody
- the document tree to which the index contents will be added
-
addConfigurationTitle
protected void addConfigurationTitle(Content body)
Deprecated.Adds the doctitle to the documentation tree, if it is specified on the command line.- Parameters:
body
- the document tree to which the title will be added
-
getNavLinkContents
protected Content getNavLinkContents()
Deprecated.Returns highlighted "Overview", in the navigation bar as this is the overview page.- Overrides:
getNavLinkContents
in classHtmlDocletWriter
- Returns:
- a Content object to be added to the documentation tree
-
addAllClassesLink
protected void addAllClassesLink(Content div)
Deprecated.Do nothing. This will be overridden.- Parameters:
div
- the document tree to which the all classes link will be added
-
-