Class AllClassesFrameWriter
- 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.AllClassesFrameWriter
-
@Deprecated public class AllClassesFrameWriter extends HtmlDocletWriter
Deprecated.Generate the file with list of all the classes in this run. This page will be used in the left-hand bottom frame, when "All Classes" link is clicked in the left-hand top frame. The name of the generated file is "allclasses-frame.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, Doug Kramer, Bhavesh Patel (Modified)
-
-
Field Summary
Fields Modifier and Type Field Description protected IndexBuilder
indexbuilder
Deprecated.Index of all the classes.-
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 AllClassesFrameWriter(ConfigurationImpl configuration, DocPath filename, IndexBuilder indexbuilder)
Deprecated.Construct AllClassesFrameWriter object.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected void
addAllClasses(Content content, boolean wantFrames)
Deprecated.Use the sorted index of all the classes and add all the classes to the content list.protected void
addContents(List<Doc> classlist, boolean wantFrames, Content content)
Deprecated.Given a list of classes, generate links for each class or interface.protected void
buildAllClassesFile(boolean wantFrames)
Deprecated.Print all the classes in the file.static void
generate(ConfigurationImpl configuration, IndexBuilder indexbuilder)
Deprecated.Create AllClassesFrameWriter object.-
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, 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 Detail
-
indexbuilder
protected IndexBuilder indexbuilder
Deprecated.Index of all the classes.
-
-
Constructor Detail
-
AllClassesFrameWriter
public AllClassesFrameWriter(ConfigurationImpl configuration, DocPath filename, IndexBuilder indexbuilder) throws IOException
Deprecated.Construct AllClassesFrameWriter object. Also initializes the indexbuilder variable in this class.- Parameters:
configuration
- The current configurationfilename
- Path to the file which is getting generated.indexbuilder
- Unicode based Index fromIndexBuilder
- Throws:
IOException
DocletAbortException
-
-
Method Detail
-
generate
public static void generate(ConfigurationImpl configuration, IndexBuilder indexbuilder)
Deprecated.Create AllClassesFrameWriter object. Then use it to generate the "allclasses-frame.html" file. Generate the file in the current or the destination directory.- Parameters:
indexbuilder
- IndexBuilder object for all classes index.- Throws:
DocletAbortException
-
buildAllClassesFile
protected void buildAllClassesFile(boolean wantFrames) throws IOException
Deprecated.Print all the classes in the file.- Parameters:
wantFrames
- True if we want frames.- Throws:
IOException
-
addAllClasses
protected void addAllClasses(Content content, boolean wantFrames)
Deprecated.Use the sorted index of all the classes and add all the classes to the content list.- Parameters:
content
- HtmlTree content to which all classes information will be addedwantFrames
- True if we want frames.
-
addContents
protected void addContents(List<Doc> classlist, boolean wantFrames, Content content)
Deprecated.Given a list of classes, generate links for each class or interface. If the class kind is interface, print it in the italics font. Also all links should target the right-hand frame. If clicked on any class name in this page, appropriate class page should get opened in the right-hand frame.- Parameters:
classlist
- Sorted list of classes.wantFrames
- True if we want frames.content
- HtmlTree content to which the links will be added
-
-