Class PackageWriterImpl
- 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.PackageWriterImpl
-
- All Implemented Interfaces:
PackageSummaryWriter
@Deprecated public class PackageWriterImpl extends HtmlDocletWriter implements PackageSummaryWriter
Deprecated.Class to generate file for each package contents in the right-hand frame. This will list all the Class Kinds in the package. A click on any class-kind will update the frame with the clicked class-kind page.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 HtmlTree
mainTree
Deprecated.The HTML tree for main tag.protected PackageDoc
next
Deprecated.The next package name in the alpha-order list.protected PackageDoc
packageDoc
Deprecated.The package being documented.protected PackageDoc
prev
Deprecated.The prev package name in the alpha-order list.protected HtmlTree
sectionTree
Deprecated.The HTML tree for section tag.-
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 PackageWriterImpl(ConfigurationImpl configuration, PackageDoc packageDoc, PackageDoc prev, PackageDoc next)
Deprecated.Constructor to construct PackageWriter object and to generate "package-summary.html" file in the respective package directory.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addClassesSummary(ClassDoc[] classes, String label, String tableSummary, String[] tableHeader, Content summaryContentTree)
Deprecated.Adds the table of classes to the documentation tree.void
addDeprecationInfo(Content div)
Deprecated.Add the package deprecation information to the documentation tree.void
addPackageContent(Content contentTree, Content packageContentTree)
Deprecated.Adds the tag information from the "packages.html" or "package-info.java" file to the documentation tree.void
addPackageDescription(Content packageContentTree)
Deprecated.Adds the package description from the "packages.html" file to the documentation tree.void
addPackageFooter(Content contentTree)
Deprecated.Adds the footer to the documentation tree.void
addPackageTags(Content packageContentTree)
Deprecated.Adds the tag information from the "packages.html" file to the documentation tree.Content
getContentHeader()
Deprecated.Get the header for the package content.protected Content
getNavLinkClassUse()
Deprecated.Get "Use" link for this pacakge in the navigation bar.Content
getNavLinkNext()
Deprecated.Get "NEXT PACKAGE" link in the navigation bar.protected Content
getNavLinkPackage()
Deprecated.Highlight "Package" in the navigation bar, as this is the package page.Content
getNavLinkPrevious()
Deprecated.Get "PREV PACKAGE" link in the navigation bar.protected Content
getNavLinkTree()
Deprecated.Get "Tree" link in the navigation bar.Content
getPackageHeader(String heading)
Deprecated.Get the header for the summary.Content
getSummaryHeader()
Deprecated.Get the header for the package summary.void
printDocument(Content contentTree)
Deprecated.Print the package summary document.-
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, getNavLinkContents, getNavLinkDeprecated, getNavLinkHelp, getNavLinkIndex, getNavLinkMainTree, getNavLinkNext, getNavLinkPackage, getNavLinkPrevious, 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
-
Methods inherited from interface gw.gosudoc.com.sun.tools.doclets.internal.toolkit.PackageSummaryWriter
close
-
-
-
-
Field Detail
-
prev
protected PackageDoc prev
Deprecated.The prev package name in the alpha-order list.
-
next
protected PackageDoc next
Deprecated.The next package name in the alpha-order list.
-
packageDoc
protected PackageDoc packageDoc
Deprecated.The package being documented.
-
mainTree
protected HtmlTree mainTree
Deprecated.The HTML tree for main tag.
-
sectionTree
protected HtmlTree sectionTree
Deprecated.The HTML tree for section tag.
-
-
Constructor Detail
-
PackageWriterImpl
public PackageWriterImpl(ConfigurationImpl configuration, PackageDoc packageDoc, PackageDoc prev, PackageDoc next) throws IOException
Deprecated.Constructor to construct PackageWriter object and to generate "package-summary.html" file in the respective package directory. For example for package "java.lang" this will generate file "package-summary.html" file in the "java/lang" directory. It will also create "java/lang" directory in the current or the destination directory if it doesn't exist.- Parameters:
configuration
- the configuration of the doclet.packageDoc
- PackageDoc under consideration.prev
- Previous package in the sorted array.next
- Next package in the sorted array.- Throws:
IOException
-
-
Method Detail
-
getPackageHeader
public Content getPackageHeader(String heading)
Deprecated.Get the header for the summary.- Specified by:
getPackageHeader
in interfacePackageSummaryWriter
- Parameters:
heading
- Package name.- Returns:
- the header to be added to the content tree
-
getContentHeader
public Content getContentHeader()
Deprecated.Get the header for the package content.- Specified by:
getContentHeader
in interfacePackageSummaryWriter
- Returns:
- a content tree for the package content header
-
addDeprecationInfo
public void addDeprecationInfo(Content div)
Deprecated.Add the package deprecation information to the documentation tree.- Parameters:
div
- the content tree to which the deprecation information will be added
-
getSummaryHeader
public Content getSummaryHeader()
Deprecated.Get the header for the package summary.- Specified by:
getSummaryHeader
in interfacePackageSummaryWriter
- Returns:
- a content tree with the package summary header
-
addClassesSummary
public void addClassesSummary(ClassDoc[] classes, String label, String tableSummary, String[] tableHeader, Content summaryContentTree)
Deprecated.Adds the table of classes to the documentation tree.- Specified by:
addClassesSummary
in interfacePackageSummaryWriter
- Parameters:
classes
- the array of classes to document.label
- the label for this table.tableSummary
- the summary string for the tabletableHeader
- array of table headerssummaryContentTree
- the content tree to which the summaries will be added
-
addPackageDescription
public void addPackageDescription(Content packageContentTree)
Deprecated.Adds the package description from the "packages.html" file to the documentation tree.- Specified by:
addPackageDescription
in interfacePackageSummaryWriter
- Parameters:
packageContentTree
- the content tree to which the package description will be added
-
addPackageTags
public void addPackageTags(Content packageContentTree)
Deprecated.Adds the tag information from the "packages.html" file to the documentation tree.- Specified by:
addPackageTags
in interfacePackageSummaryWriter
- Parameters:
packageContentTree
- the content tree to which the package tags will be added
-
addPackageContent
public void addPackageContent(Content contentTree, Content packageContentTree)
Deprecated.Adds the tag information from the "packages.html" or "package-info.java" file to the documentation tree.- Specified by:
addPackageContent
in interfacePackageSummaryWriter
- Parameters:
contentTree
- the content tree to which the package content tree will be addedpackageContentTree
- the package content tree to be added
-
addPackageFooter
public void addPackageFooter(Content contentTree)
Deprecated.Adds the footer to the documentation tree.- Specified by:
addPackageFooter
in interfacePackageSummaryWriter
- Parameters:
contentTree
- the tree to which the footer will be added
-
printDocument
public void printDocument(Content contentTree) throws IOException
Deprecated.Print the package summary document.- Specified by:
printDocument
in interfacePackageSummaryWriter
- Parameters:
contentTree
- the content tree that will be printed- Throws:
IOException
-
getNavLinkClassUse
protected Content getNavLinkClassUse()
Deprecated.Get "Use" link for this pacakge in the navigation bar.- Overrides:
getNavLinkClassUse
in classHtmlDocletWriter
- Returns:
- a content tree for the class use link
-
getNavLinkPrevious
public Content getNavLinkPrevious()
Deprecated.Get "PREV PACKAGE" link in the navigation bar.- Overrides:
getNavLinkPrevious
in classHtmlDocletWriter
- Returns:
- a content tree for the previous link
-
getNavLinkNext
public Content getNavLinkNext()
Deprecated.Get "NEXT PACKAGE" link in the navigation bar.- Overrides:
getNavLinkNext
in classHtmlDocletWriter
- Returns:
- a content tree for the next link
-
getNavLinkTree
protected Content getNavLinkTree()
Deprecated.Get "Tree" link in the navigation bar. This will be link to the package tree file.- Overrides:
getNavLinkTree
in classHtmlDocletWriter
- Returns:
- a content tree for the tree link
-
getNavLinkPackage
protected Content getNavLinkPackage()
Deprecated.Highlight "Package" in the navigation bar, as this is the package page.- Overrides:
getNavLinkPackage
in classHtmlDocletWriter
- Returns:
- a content tree for the package link
-
-