Class FrameOutputWriter
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.FrameOutputWriter
Deprecated.
Generate the documentation in the Html "frame" format in the browser. The
generated documentation will have two or three frames depending upon the
number of packages on the command line. In general there will be three frames
in the output, a left-hand top frame will have a list of all packages with
links to target left-hand bottom frame. The left-hand bottom frame will have
the particular package contents or the all-classes list, where as the single
right-hand frame will have overview or package summary or class file. Also
take care of browsers which do not support Html frames.
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 TypeFieldDescription(package private) int
Deprecated.Number of packages specified on the command line.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
ConstructorsConstructorDescriptionFrameOutputWriter
(ConfigurationImpl configuration, DocPath filename) Deprecated.Constructor to construct FrameOutputWriter object. -
Method Summary
Modifier and TypeMethodDescriptionprivate void
addAllClassesFrameTag
(Content contentTree) Deprecated.Add the IFRAME tag for the frame that lists all classes.private void
addAllPackagesFrameTag
(Content contentTree) Deprecated.Add the IFRAME tag for the frame that lists all packages.private void
addClassFrameTag
(Content contentTree) Deprecated.Add the IFRAME tag for the frame that describes the class in detail.static void
generate
(ConfigurationImpl configuration) Deprecated.Construct FrameOutputWriter object and then use it to generate the Html file which will have the description of all the frames in the documentation.protected void
Deprecated.Generate the constants in the "index.html" file.protected Content
Deprecated.Get the frame sizes and their contents.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, getNavLinkContents, 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
-
noOfPackages
int noOfPackagesDeprecated.Number of packages specified on the command line.
-
-
Constructor Details
-
FrameOutputWriter
Deprecated.Constructor to construct FrameOutputWriter object.- Parameters:
filename
- File to be generated.- Throws:
IOException
-
-
Method Details
-
generate
Deprecated.Construct FrameOutputWriter object and then use it to generate the Html file which will have the description of all the frames in the documentation. The name of the generated file is "index.html" which is the default first file for Html documents.- Throws:
DocletAbortException
-
generateFrameFile
Deprecated.Generate the constants in the "index.html" file. Print the frame details as well as warning if browser is not supporting the Html frames.- Throws:
IOException
-
getFrameDetails
Deprecated.Get the frame sizes and their contents.- Returns:
- a content tree for the frame details
-
addAllPackagesFrameTag
Deprecated.Add the IFRAME tag for the frame that lists all packages.- Parameters:
contentTree
- the content tree to which the information will be added
-
addAllClassesFrameTag
Deprecated.Add the IFRAME tag for the frame that lists all classes.- Parameters:
contentTree
- the content tree to which the information will be added
-
addClassFrameTag
Deprecated.Add the IFRAME tag for the frame that describes the class in detail.- Parameters:
contentTree
- the content tree to which the information will be added
-