duke@1: * Replace {@docRoot} tag in htmlstr with the relative path to the duke@1: * destination directory from the directory where the file is being duke@1: * written, looping to handle all such tags in htmlstr. duke@1: *
duke@1: * For example, for "-d docs" and -header containing {@docRoot}, when duke@1: * the HTML page for source file p/C1.java is being generated, the duke@1: * {@docRoot} tag would be inserted into the header as "../", duke@1: * the relative path from docs/p/ to docs/ (the document root). duke@1: *
duke@1: * Note: This doc comment was written with '@' representing '@' duke@1: * to prevent the inline tag from being interpreted. duke@1: */ duke@1: public String replaceDocRootDir(String htmlstr) { duke@1: // Return if no inline tags exist duke@1: int index = htmlstr.indexOf("{@"); duke@1: if (index < 0) { duke@1: return htmlstr; duke@1: } duke@1: String lowerHtml = htmlstr.toLowerCase(); duke@1: // Return index of first occurrence of {@docroot} duke@1: // Note: {@docRoot} is not case sensitive when passed in w/command line option duke@1: index = lowerHtml.indexOf("{@docroot}", index); duke@1: if (index < 0) { duke@1: return htmlstr; duke@1: } jjg@910: StringBuilder buf = new StringBuilder(); duke@1: int previndex = 0; duke@1: while (true) { bpatel@997: if (configuration.docrootparent.length() > 0) { bpatel@997: // Search for lowercase version of {@docRoot}/.. bpatel@997: index = lowerHtml.indexOf("{@docroot}/..", previndex); bpatel@997: // If next {@docRoot}/.. pattern not found, append rest of htmlstr and exit loop bpatel@997: if (index < 0) { bpatel@997: buf.append(htmlstr.substring(previndex)); bpatel@997: break; bpatel@997: } bpatel@997: // If next {@docroot}/.. pattern found, append htmlstr up to start of tag bpatel@997: buf.append(htmlstr.substring(previndex, index)); bpatel@997: previndex = index + 13; // length for {@docroot}/.. string bpatel@997: // Insert docrootparent absolute path where {@docRoot}/.. was located bpatel@997: bpatel@997: buf.append(configuration.docrootparent); bpatel@997: // Append slash if next character is not a slash bpatel@997: if (previndex < htmlstr.length() && htmlstr.charAt(previndex) != '/') { bpatel@997: buf.append(DirectoryManager.URL_FILE_SEPARATOR); bpatel@997: } bpatel@997: } else { bpatel@997: // Search for lowercase version of {@docRoot} bpatel@997: index = lowerHtml.indexOf("{@docroot}", previndex); bpatel@997: // If next {@docRoot} tag not found, append rest of htmlstr and exit loop bpatel@997: if (index < 0) { bpatel@997: buf.append(htmlstr.substring(previndex)); bpatel@997: break; bpatel@997: } bpatel@997: // If next {@docroot} tag found, append htmlstr up to start of tag bpatel@997: buf.append(htmlstr.substring(previndex, index)); bpatel@997: previndex = index + 10; // length for {@docroot} string bpatel@997: // Insert relative path where {@docRoot} was located bpatel@997: buf.append(relativepathNoSlash); bpatel@997: // Append slash if next character is not a slash bpatel@997: if (relativepathNoSlash.length() > 0 && previndex < htmlstr.length() && bpatel@997: htmlstr.charAt(previndex) != '/') { bpatel@997: buf.append(DirectoryManager.URL_FILE_SEPARATOR); bpatel@997: } duke@1: } duke@1: } duke@1: return buf.toString(); duke@1: } duke@1: duke@1: /** duke@1: * Print Html Hyper Link, with target frame. This duke@1: * link will only appear if page is not in a frame. duke@1: * duke@1: * @param link String name of the file. duke@1: * @param where Position in the file duke@1: * @param target Name of the target frame. duke@1: * @param label Tag for the link. bpatel@182: * @param strong Whether the label should be strong or not? duke@1: */ duke@1: public void printNoFramesTargetHyperLink(String link, String where, duke@1: String target, String label, bpatel@182: boolean strong) { duke@1: script(); duke@1: println(" "); duke@1: scriptEnd(); duke@1: noScript(); bpatel@766: println(" " + getHyperLinkString(link, where, label, strong, "", "", target)); duke@1: noScriptEnd(); duke@1: println(DocletConstants.NL); duke@1: } duke@1: bpatel@766: /** bpatel@766: * Get the script to show or hide the All classes link. bpatel@766: * bpatel@766: * @param id id of the element to show or hide bpatel@766: * @return a content tree for the script bpatel@766: */ bpatel@766: public Content getAllClassesLinkScript(String id) { bpatel@766: HtmlTree script = new HtmlTree(HtmlTag.SCRIPT); bpatel@766: script.addAttr(HtmlAttr.TYPE, "text/javascript"); bpatel@793: String scriptCode = "" + DocletConstants.NL; bpatel@766: Content scriptContent = new RawHtml(scriptCode); bpatel@766: script.addContent(scriptContent); bpatel@766: Content div = HtmlTree.DIV(script); bpatel@766: return div; bpatel@766: } bpatel@766: bpatel@766: /** bpatel@766: * Add method information. bpatel@766: * bpatel@766: * @param method the method to be documented bpatel@766: * @param dl the content tree to which the method information will be added bpatel@766: */ bpatel@766: private void addMethodInfo(MethodDoc method, Content dl) { duke@1: ClassDoc[] intfacs = method.containingClass().interfaces(); duke@1: MethodDoc overriddenMethod = method.overriddenMethod(); bpatel@233: // Check whether there is any implementation or overridden info to be bpatel@233: // printed. If no overridden or implementation info needs to be bpatel@233: // printed, do not print this section. bpatel@233: if ((intfacs.length > 0 && bpatel@233: new ImplementedMethods(method, this.configuration).build().length > 0) || bpatel@233: overriddenMethod != null) { bpatel@766: MethodWriterImpl.addImplementsInfo(this, method, dl); duke@1: if (overriddenMethod != null) { bpatel@766: MethodWriterImpl.addOverridden(this, bpatel@766: method.overriddenType(), overriddenMethod, dl); duke@1: } duke@1: } duke@1: } duke@1: bpatel@766: /** bpatel@766: * Adds the tags information. bpatel@766: * bpatel@766: * @param doc the doc for which the tags will be generated bpatel@766: * @param htmltree the documentation tree to which the tags will be added bpatel@766: */ bpatel@766: protected void addTagsInfo(Doc doc, Content htmltree) { bpatel@766: if (configuration.nocomment) { duke@1: return; duke@1: } bpatel@766: Content dl = new HtmlTree(HtmlTag.DL); duke@1: if (doc instanceof MethodDoc) { bpatel@766: addMethodInfo((MethodDoc) doc, dl); duke@1: } duke@1: TagletOutputImpl output = new TagletOutputImpl(""); duke@1: TagletWriter.genTagOuput(configuration.tagletManager, doc, duke@1: configuration.tagletManager.getCustomTags(doc), duke@1: getTagletWriterInstance(false), output); bpatel@233: String outputString = output.toString().trim(); bpatel@233: if (!outputString.isEmpty()) { bpatel@766: Content resultString = new RawHtml(outputString); bpatel@766: dl.addContent(resultString); duke@1: } bpatel@766: htmltree.addContent(dl); duke@1: } duke@1: duke@1: /** bpatel@233: * Check whether there are any tags for Serialization Overview bpatel@233: * section to be printed. bpatel@222: * bpatel@233: * @param field the FieldDoc object to check for tags. bpatel@222: * @return true if there are tags to be printed else return false. bpatel@222: */ bpatel@233: protected boolean hasSerializationOverviewTags(FieldDoc field) { bpatel@222: TagletOutputImpl output = new TagletOutputImpl(""); bpatel@233: TagletWriter.genTagOuput(configuration.tagletManager, field, bpatel@233: configuration.tagletManager.getCustomTags(field), bpatel@222: getTagletWriterInstance(false), output); bpatel@233: return (!output.toString().trim().isEmpty()); bpatel@222: } bpatel@222: bpatel@222: /** duke@1: * Returns a TagletWriter that knows how to write HTML. duke@1: * duke@1: * @return a TagletWriter that knows how to write HTML. duke@1: */ duke@1: public TagletWriter getTagletWriterInstance(boolean isFirstSentence) { duke@1: return new TagletWriterImpl(this, isFirstSentence); duke@1: } duke@1: duke@1: protected void printTagsInfoHeader() { duke@1: dl(); duke@1: } duke@1: duke@1: protected void printTagsInfoFooter() { duke@1: dlEnd(); duke@1: } duke@1: duke@1: /** bpatel@766: * Get Package link, with target frame. duke@1: * bpatel@766: * @param pd The link will be to the "package-summary.html" page for this package bpatel@766: * @param target name of the target frame bpatel@766: * @param label tag for the link bpatel@766: * @return a content for the target package link duke@1: */ bpatel@766: public Content getTargetPackageLink(PackageDoc pd, String target, bpatel@766: Content label) { bpatel@766: return getHyperLink(pathString(pd, "package-summary.html"), "", label, "", target); duke@1: } duke@1: duke@1: /** duke@1: * Print the html file header. Also print Html page title and stylesheet duke@1: * default properties. duke@1: * duke@1: * @param title String window title to go in the <TITLE> tag duke@1: * @param metakeywords Array of String keywords for META tag. Each element duke@1: * of the array is assigned to a separate META tag. duke@1: * Pass in null for no array. duke@1: * @param includeScript boolean true if printing windowtitle script. duke@1: * False for files that appear in the left-hand frames. duke@1: */ duke@1: public void printHtmlHeader(String title, String[] metakeywords, duke@1: boolean includeScript) { duke@1: println(""); duke@1: println(""); duke@1: html(); duke@1: head(); duke@1: if (! configuration.notimestamp) { duke@1: print(""); duke@1: } duke@1: if (configuration.charset.length() > 0) { duke@1: println(""); duke@1: } duke@1: if ( configuration.windowtitle.length() > 0 ) { duke@1: title += " (" + configuration.windowtitle + ")"; duke@1: } duke@1: title(title); duke@1: println(title); duke@1: titleEnd(); duke@1: println(""); duke@1: if (! configuration.notimestamp) { duke@1: SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd"); duke@1: println(""); duke@1: } duke@1: if ( metakeywords != null ) { duke@1: for ( int i=0; i < metakeywords.length; i++ ) { duke@1: println(""); duke@1: } duke@1: } duke@1: println(""); duke@1: printStyleSheetProperties(); duke@1: println(""); duke@1: // Don't print windowtitle script for overview-frame, allclasses-frame duke@1: // and package-frame duke@1: if (includeScript) { duke@1: printWinTitleScript(title); duke@1: } duke@1: println(""); duke@1: headEnd(); duke@1: println(""); duke@1: body("white", includeScript); duke@1: } duke@1: duke@1: /** bpatel@766: * Generates the HTML document tree and prints it out. bpatel@766: * bpatel@766: * @param metakeywords Array of String keywords for META tag. Each element bpatel@766: * of the array is assigned to a separate META tag. bpatel@766: * Pass in null for no array bpatel@766: * @param includeScript true if printing windowtitle script bpatel@766: * false for files that appear in the left-hand frames bpatel@766: * @param body the body htmltree to be included in the document bpatel@766: */ bpatel@766: public void printHtmlDocument(String[] metakeywords, boolean includeScript, bpatel@766: Content body) { bpatel@766: Content htmlDocType = DocType.Transitional(); bpatel@766: Content htmlComment = new Comment(configuration.getText("doclet.New_Page")); bpatel@766: Content head = new HtmlTree(HtmlTag.HEAD); bpatel@766: if (!configuration.notimestamp) { bpatel@766: Content headComment = new Comment("Generated by javadoc (version " + bpatel@766: ConfigurationImpl.BUILD_DATE + ") on " + today()); bpatel@766: head.addContent(headComment); bpatel@766: } bpatel@766: if (configuration.charset.length() > 0) { bpatel@766: Content meta = HtmlTree.META("Content-Type", "text/html", bpatel@766: configuration.charset); bpatel@766: head.addContent(meta); bpatel@766: } bpatel@766: head.addContent(getTitle()); bpatel@766: if (!configuration.notimestamp) { bpatel@766: SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd"); bpatel@766: Content meta = HtmlTree.META("date", dateFormat.format(new Date())); bpatel@766: head.addContent(meta); bpatel@766: } bpatel@766: if (metakeywords != null) { bpatel@766: for (int i=0; i < metakeywords.length; i++) { bpatel@766: Content meta = HtmlTree.META("keywords", metakeywords[i]); bpatel@766: head.addContent(meta); bpatel@766: } bpatel@766: } bpatel@766: head.addContent(getStyleSheetProperties()); bpatel@766: Content htmlTree = HtmlTree.HTML(configuration.getLocale().getLanguage(), bpatel@766: head, body); bpatel@766: Content htmlDocument = new HtmlDocument(htmlDocType, bpatel@766: htmlComment, htmlTree); bpatel@766: print(htmlDocument.toString()); bpatel@766: } bpatel@766: bpatel@766: /** bpatel@766: * Get the window title. bpatel@766: * bpatel@766: * @param title the title string to construct the complete window title bpatel@766: * @return the window title string bpatel@766: */ bpatel@766: public String getWindowTitle(String title) { bpatel@766: if (configuration.windowtitle.length() > 0) { bpatel@766: title += " (" + configuration.windowtitle + ")"; bpatel@766: } bpatel@766: return title; bpatel@766: } bpatel@766: bpatel@766: /** duke@1: * Print user specified header and the footer. duke@1: * duke@1: * @param header if true print the user provided header else print the duke@1: * user provided footer. duke@1: */ duke@1: public void printUserHeaderFooter(boolean header) { duke@1: em(); duke@1: if (header) { duke@1: print(replaceDocRootDir(configuration.header)); duke@1: } else { duke@1: if (configuration.footer.length() != 0) { duke@1: print(replaceDocRootDir(configuration.footer)); duke@1: } else { duke@1: print(replaceDocRootDir(configuration.header)); duke@1: } duke@1: } duke@1: emEnd(); duke@1: } duke@1: duke@1: /** bpatel@766: * Get user specified header and the footer. bpatel@766: * bpatel@766: * @param header if true print the user provided header else print the bpatel@766: * user provided footer. bpatel@766: */ bpatel@766: public Content getUserHeaderFooter(boolean header) { bpatel@766: String content; bpatel@766: if (header) { bpatel@766: content = replaceDocRootDir(configuration.header); bpatel@766: } else { bpatel@766: if (configuration.footer.length() != 0) { bpatel@766: content = replaceDocRootDir(configuration.footer); bpatel@766: } else { bpatel@766: content = replaceDocRootDir(configuration.header); bpatel@766: } bpatel@766: } bpatel@766: Content rawContent = new RawHtml(content); bpatel@766: Content em = HtmlTree.EM(rawContent); bpatel@766: return em; bpatel@766: } bpatel@766: bpatel@766: /** duke@1: * Print the user specified top. duke@1: */ duke@1: public void printTop() { duke@1: print(replaceDocRootDir(configuration.top)); duke@1: hr(); duke@1: } duke@1: duke@1: /** bpatel@766: * Adds the user specified top. bpatel@766: * bpatel@766: * @param body the content tree to which user specified top will be added bpatel@766: */ bpatel@766: public void addTop(Content body) { bpatel@766: Content top = new RawHtml(replaceDocRootDir(configuration.top)); bpatel@766: body.addContent(top); bpatel@766: } bpatel@766: bpatel@766: /** duke@1: * Print the user specified bottom. duke@1: */ duke@1: public void printBottom() { duke@1: hr(); duke@1: print(replaceDocRootDir(configuration.bottom)); duke@1: } duke@1: duke@1: /** bpatel@766: * Adds the user specified bottom. bpatel@766: * bpatel@766: * @param body the content tree to which user specified bottom will be added bpatel@766: */ bpatel@766: public void addBottom(Content body) { bpatel@766: Content bottom = new RawHtml(replaceDocRootDir(configuration.bottom)); bpatel@766: Content small = HtmlTree.SMALL(bottom); bpatel@766: Content p = HtmlTree.P(HtmlStyle.legalCopy, small); bpatel@766: body.addContent(p); bpatel@766: } bpatel@766: bpatel@766: /** duke@1: * Print the navigation bar for the Html page at the top and and the bottom. duke@1: * duke@1: * @param header If true print navigation bar at the top of the page else duke@1: * print the nevigation bar at the bottom. duke@1: */ duke@1: protected void navLinks(boolean header) { duke@1: println(""); duke@1: if (!configuration.nonavbar) { duke@1: if (header) { duke@1: println(DocletConstants.NL + ""); duke@1: anchor("navbar_top"); duke@1: println(); bpatel@766: print(getHyperLinkString("", "skip-navbar_top", "", false, "", duke@1: configuration.getText("doclet.Skip_navigation_links"), "")); duke@1: } else { duke@1: println(DocletConstants.NL + ""); duke@1: anchor("navbar_bottom"); duke@1: println(); bpatel@766: print(getHyperLinkString("", "skip-navbar_bottom", "", false, "", duke@1: configuration.getText("doclet.Skip_navigation_links"), "")); duke@1: } duke@1: table(0, "100%", 1, 0); duke@1: tr(); duke@1: tdColspanBgcolorStyle(2, "#EEEEFF", "NavBarCell1"); duke@1: println(""); duke@1: if (header) { duke@1: anchor("navbar_top_firstrow"); duke@1: } else { duke@1: anchor("navbar_bottom_firstrow"); duke@1: } duke@1: table(0, 0, 3); duke@1: print(" "); duke@1: trAlignVAlign("center", "top"); duke@1: duke@1: if (configuration.createoverview) { duke@1: navLinkContents(); duke@1: } duke@1: duke@1: if (configuration.packages.length == 1) { duke@1: navLinkPackage(configuration.packages[0]); duke@1: } else if (configuration.packages.length > 1) { duke@1: navLinkPackage(); duke@1: } duke@1: duke@1: navLinkClass(); duke@1: duke@1: if(configuration.classuse) { duke@1: navLinkClassUse(); duke@1: } duke@1: if(configuration.createtree) { duke@1: navLinkTree(); duke@1: } duke@1: if(!(configuration.nodeprecated || duke@1: configuration.nodeprecatedlist)) { duke@1: navLinkDeprecated(); duke@1: } duke@1: if(configuration.createindex) { duke@1: navLinkIndex(); duke@1: } duke@1: if (!configuration.nohelp) { duke@1: navLinkHelp(); duke@1: } duke@1: print(" "); duke@1: trEnd(); duke@1: tableEnd(); duke@1: tdEnd(); duke@1: duke@1: tdAlignVAlignRowspan("right", "top", 3); duke@1: duke@1: printUserHeaderFooter(header); duke@1: tdEnd(); duke@1: trEnd(); duke@1: println(""); duke@1: duke@1: tr(); duke@1: tdBgcolorStyle("white", "NavBarCell2"); duke@1: font("-2"); duke@1: space(); duke@1: navLinkPrevious(); duke@1: space(); duke@1: println(""); duke@1: space(); duke@1: navLinkNext(); duke@1: fontEnd(); duke@1: tdEnd(); duke@1: duke@1: tdBgcolorStyle("white", "NavBarCell2"); duke@1: font("-2"); duke@1: print(" "); duke@1: navShowLists(); duke@1: print(" "); duke@1: space(); duke@1: println(""); duke@1: space(); duke@1: navHideLists(filename); duke@1: print(" "); duke@1: space(); duke@1: println(""); duke@1: space(); duke@1: navLinkClassIndex(); duke@1: fontEnd(); duke@1: tdEnd(); duke@1: duke@1: trEnd(); duke@1: duke@1: printSummaryDetailLinks(); duke@1: duke@1: tableEnd(); duke@1: if (header) { duke@1: aName("skip-navbar_top"); duke@1: aEnd(); duke@1: println(DocletConstants.NL + ""); duke@1: } else { duke@1: aName("skip-navbar_bottom"); duke@1: aEnd(); duke@1: println(DocletConstants.NL + ""); duke@1: } duke@1: println(""); duke@1: } duke@1: } duke@1: duke@1: /** bpatel@766: * Adds the navigation bar for the Html page at the top and and the bottom. bpatel@766: * bpatel@766: * @param header If true print navigation bar at the top of the page else bpatel@766: * @param body the HtmlTree to which the nav links will be added bpatel@766: */ bpatel@766: protected void addNavLinks(boolean header, Content body) { bpatel@766: if (!configuration.nonavbar) { bpatel@766: String allClassesId = "allclasses_"; bpatel@766: HtmlTree navDiv = new HtmlTree(HtmlTag.DIV); bpatel@766: if (header) { bpatel@766: body.addContent(HtmlConstants.START_OF_TOP_NAVBAR); bpatel@766: navDiv.addStyle(HtmlStyle.topNav); bpatel@766: allClassesId += "navbar_top"; bpatel@766: Content a = getMarkerAnchor("navbar_top"); bpatel@766: navDiv.addContent(a); bpatel@766: Content skipLinkContent = getHyperLink("", bpatel@766: "skip-navbar_top", HtmlTree.EMPTY, configuration.getText( bpatel@766: "doclet.Skip_navigation_links"), ""); bpatel@766: navDiv.addContent(skipLinkContent); bpatel@766: } else { bpatel@766: body.addContent(HtmlConstants.START_OF_BOTTOM_NAVBAR); bpatel@766: navDiv.addStyle(HtmlStyle.bottomNav); bpatel@766: allClassesId += "navbar_bottom"; bpatel@766: Content a = getMarkerAnchor("navbar_bottom"); bpatel@766: navDiv.addContent(a); bpatel@766: Content skipLinkContent = getHyperLink("", bpatel@766: "skip-navbar_bottom", HtmlTree.EMPTY, configuration.getText( bpatel@766: "doclet.Skip_navigation_links"), ""); bpatel@766: navDiv.addContent(skipLinkContent); bpatel@766: } bpatel@766: if (header) { bpatel@766: navDiv.addContent(getMarkerAnchor("navbar_top_firstrow")); bpatel@766: } else { bpatel@766: navDiv.addContent(getMarkerAnchor("navbar_bottom_firstrow")); bpatel@766: } bpatel@766: HtmlTree navList = new HtmlTree(HtmlTag.UL); bpatel@766: navList.addStyle(HtmlStyle.navList); bpatel@766: navList.addAttr(HtmlAttr.TITLE, "Navigation"); bpatel@766: if (configuration.createoverview) { bpatel@766: navList.addContent(getNavLinkContents()); bpatel@766: } bpatel@766: if (configuration.packages.length == 1) { bpatel@766: navList.addContent(getNavLinkPackage(configuration.packages[0])); bpatel@766: } else if (configuration.packages.length > 1) { bpatel@766: navList.addContent(getNavLinkPackage()); bpatel@766: } bpatel@766: navList.addContent(getNavLinkClass()); bpatel@766: if(configuration.classuse) { bpatel@766: navList.addContent(getNavLinkClassUse()); bpatel@766: } bpatel@766: if(configuration.createtree) { bpatel@766: navList.addContent(getNavLinkTree()); bpatel@766: } bpatel@766: if(!(configuration.nodeprecated || bpatel@766: configuration.nodeprecatedlist)) { bpatel@766: navList.addContent(getNavLinkDeprecated()); bpatel@766: } bpatel@766: if(configuration.createindex) { bpatel@766: navList.addContent(getNavLinkIndex()); bpatel@766: } bpatel@766: if (!configuration.nohelp) { bpatel@766: navList.addContent(getNavLinkHelp()); bpatel@766: } bpatel@766: navDiv.addContent(navList); bpatel@766: Content aboutDiv = HtmlTree.DIV(HtmlStyle.aboutLanguage, getUserHeaderFooter(header)); bpatel@766: navDiv.addContent(aboutDiv); bpatel@766: body.addContent(navDiv); bpatel@766: Content ulNav = HtmlTree.UL(HtmlStyle.navList, getNavLinkPrevious()); bpatel@766: ulNav.addContent(getNavLinkNext()); bpatel@766: Content subDiv = HtmlTree.DIV(HtmlStyle.subNav, ulNav); bpatel@766: Content ulFrames = HtmlTree.UL(HtmlStyle.navList, getNavShowLists()); bpatel@766: ulFrames.addContent(getNavHideLists(filename)); bpatel@766: subDiv.addContent(ulFrames); bpatel@766: HtmlTree ulAllClasses = HtmlTree.UL(HtmlStyle.navList, getNavLinkClassIndex()); bpatel@766: ulAllClasses.addAttr(HtmlAttr.ID, allClassesId.toString()); bpatel@766: subDiv.addContent(ulAllClasses); bpatel@766: subDiv.addContent(getAllClassesLinkScript(allClassesId.toString())); bpatel@766: addSummaryDetailLinks(subDiv); bpatel@766: if (header) { bpatel@766: subDiv.addContent(getMarkerAnchor("skip-navbar_top")); bpatel@766: body.addContent(subDiv); bpatel@766: body.addContent(HtmlConstants.END_OF_TOP_NAVBAR); bpatel@766: } else { bpatel@766: subDiv.addContent(getMarkerAnchor("skip-navbar_bottom")); bpatel@766: body.addContent(subDiv); bpatel@766: body.addContent(HtmlConstants.END_OF_BOTTOM_NAVBAR); bpatel@766: } bpatel@766: } bpatel@766: } bpatel@766: bpatel@766: /** duke@1: * Print the word "NEXT" to indicate that no link is available. Override duke@1: * this method to customize next link. duke@1: */ duke@1: protected void navLinkNext() { duke@1: navLinkNext(null); duke@1: } duke@1: duke@1: /** bpatel@766: * Get the word "NEXT" to indicate that no link is available. Override bpatel@766: * this method to customize next link. bpatel@766: * bpatel@766: * @return a content tree for the link bpatel@766: */ bpatel@766: protected Content getNavLinkNext() { bpatel@766: return getNavLinkNext(null); bpatel@766: } bpatel@766: bpatel@766: /** duke@1: * Print the word "PREV" to indicate that no link is available. Override duke@1: * this method to customize prev link. duke@1: */ duke@1: protected void navLinkPrevious() { duke@1: navLinkPrevious(null); duke@1: } duke@1: duke@1: /** bpatel@766: * Get the word "PREV" to indicate that no link is available. Override bpatel@766: * this method to customize prev link. bpatel@766: * bpatel@766: * @return a content tree for the link bpatel@766: */ bpatel@766: protected Content getNavLinkPrevious() { bpatel@766: return getNavLinkPrevious(null); bpatel@766: } bpatel@766: bpatel@766: /** duke@1: * Do nothing. This is the default method. duke@1: */ duke@1: protected void printSummaryDetailLinks() { duke@1: } duke@1: duke@1: /** bpatel@766: * Do nothing. This is the default method. bpatel@766: */ bpatel@766: protected void addSummaryDetailLinks(Content navDiv) { bpatel@766: } bpatel@766: bpatel@766: /** duke@1: * Print link to the "overview-summary.html" page. duke@1: */ duke@1: protected void navLinkContents() { duke@1: navCellStart(); duke@1: printHyperLink(relativePath + "overview-summary.html", "", duke@1: configuration.getText("doclet.Overview"), true, "NavBarFont1"); duke@1: navCellEnd(); duke@1: } duke@1: duke@1: /** bpatel@766: * Get link to the "overview-summary.html" page. bpatel@766: * bpatel@766: * @return a content tree for the link bpatel@766: */ bpatel@766: protected Content getNavLinkContents() { bpatel@766: Content linkContent = getHyperLink(relativePath + bpatel@766: "overview-summary.html", "", overviewLabel, "", ""); bpatel@766: Content li = HtmlTree.LI(linkContent); bpatel@766: return li; bpatel@766: } bpatel@766: bpatel@766: /** duke@1: * Description for a cell in the navigation bar. duke@1: */ duke@1: protected void navCellStart() { duke@1: print(" "); duke@1: tdBgcolorStyle("#EEEEFF", "NavBarCell1"); duke@1: print(" "); duke@1: } duke@1: duke@1: /** duke@1: * Description for a cell in the navigation bar, but with reverse duke@1: * high-light effect. duke@1: */ duke@1: protected void navCellRevStart() { duke@1: print(" "); duke@1: tdBgcolorStyle("#FFFFFF", "NavBarCell1Rev"); duke@1: print(" "); duke@1: space(); duke@1: } duke@1: duke@1: /** duke@1: * Closing tag for navigation bar cell. duke@1: */ duke@1: protected void navCellEnd() { duke@1: space(); duke@1: tdEnd(); duke@1: } duke@1: duke@1: /** duke@1: * Print link to the "package-summary.html" page for the package passed. duke@1: * duke@1: * @param pkg Package to which link will be generated. duke@1: */ duke@1: protected void navLinkPackage(PackageDoc pkg) { duke@1: navCellStart(); duke@1: printPackageLink(pkg, configuration.getText("doclet.Package"), true, duke@1: "NavBarFont1"); duke@1: navCellEnd(); duke@1: } duke@1: duke@1: /** bpatel@766: * Get link to the "package-summary.html" page for the package passed. bpatel@766: * bpatel@766: * @param pkg Package to which link will be generated bpatel@766: * @return a content tree for the link bpatel@766: */ bpatel@766: protected Content getNavLinkPackage(PackageDoc pkg) { bpatel@766: Content linkContent = getPackageLink(pkg, bpatel@766: packageLabel); bpatel@766: Content li = HtmlTree.LI(linkContent); bpatel@766: return li; bpatel@766: } bpatel@766: bpatel@766: /** duke@1: * Print the word "Package" in the navigation bar cell, to indicate that duke@1: * link is not available here. duke@1: */ duke@1: protected void navLinkPackage() { duke@1: navCellStart(); duke@1: fontStyle("NavBarFont1"); duke@1: printText("doclet.Package"); duke@1: fontEnd(); duke@1: navCellEnd(); duke@1: } duke@1: duke@1: /** bpatel@766: * Get the word "Package" , to indicate that link is not available here. bpatel@766: * bpatel@766: * @return a content tree for the link bpatel@766: */ bpatel@766: protected Content getNavLinkPackage() { bpatel@766: Content li = HtmlTree.LI(packageLabel); bpatel@766: return li; bpatel@766: } bpatel@766: bpatel@766: /** duke@1: * Print the word "Use" in the navigation bar cell, to indicate that link duke@1: * is not available. duke@1: */ duke@1: protected void navLinkClassUse() { duke@1: navCellStart(); duke@1: fontStyle("NavBarFont1"); duke@1: printText("doclet.navClassUse"); duke@1: fontEnd(); duke@1: navCellEnd(); duke@1: } duke@1: duke@1: /** bpatel@766: * Get the word "Use", to indicate that link is not available. bpatel@766: * bpatel@766: * @return a content tree for the link bpatel@766: */ bpatel@766: protected Content getNavLinkClassUse() { bpatel@766: Content li = HtmlTree.LI(useLabel); bpatel@766: return li; bpatel@766: } bpatel@766: bpatel@766: /** duke@1: * Print link for previous file. duke@1: * duke@1: * @param prev File name for the prev link. duke@1: */ duke@1: public void navLinkPrevious(String prev) { duke@1: String tag = configuration.getText("doclet.Prev"); duke@1: if (prev != null) { duke@1: printHyperLink(prev, "", tag, true) ; duke@1: } else { duke@1: print(tag); duke@1: } duke@1: } duke@1: duke@1: /** bpatel@766: * Get link for previous file. bpatel@766: * bpatel@766: * @param prev File name for the prev link bpatel@766: * @return a content tree for the link bpatel@766: */ bpatel@766: public Content getNavLinkPrevious(String prev) { bpatel@766: Content li; bpatel@766: if (prev != null) { bpatel@766: li = HtmlTree.LI(getHyperLink(prev, "", prevLabel, "", "")); bpatel@766: } bpatel@766: else bpatel@766: li = HtmlTree.LI(prevLabel); bpatel@766: return li; bpatel@766: } bpatel@766: bpatel@766: /** duke@1: * Print link for next file. If next is null, just print the label duke@1: * without linking it anywhere. duke@1: * duke@1: * @param next File name for the next link. duke@1: */ duke@1: public void navLinkNext(String next) { duke@1: String tag = configuration.getText("doclet.Next"); duke@1: if (next != null) { duke@1: printHyperLink(next, "", tag, true); duke@1: } else { duke@1: print(tag); duke@1: } duke@1: } duke@1: duke@1: /** bpatel@766: * Get link for next file. If next is null, just print the label bpatel@766: * without linking it anywhere. bpatel@766: * bpatel@766: * @param next File name for the next link bpatel@766: * @return a content tree for the link bpatel@766: */ bpatel@766: public Content getNavLinkNext(String next) { bpatel@766: Content li; bpatel@766: if (next != null) { bpatel@766: li = HtmlTree.LI(getHyperLink(next, "", nextLabel, "", "")); bpatel@766: } bpatel@766: else bpatel@766: li = HtmlTree.LI(nextLabel); bpatel@766: return li; bpatel@766: } bpatel@766: bpatel@766: /** duke@1: * Print "FRAMES" link, to switch to the frame version of the output. duke@1: * duke@1: * @param link File to be linked, "index.html". duke@1: */ duke@1: protected void navShowLists(String link) { bpatel@766: print(getHyperLinkString(link + "?" + path + filename, "", duke@1: configuration.getText("doclet.FRAMES"), true, "", "", "_top")); duke@1: } duke@1: duke@1: /** bpatel@766: * Get "FRAMES" link, to switch to the frame version of the output. bpatel@766: * bpatel@766: * @param link File to be linked, "index.html" bpatel@766: * @return a content tree for the link bpatel@766: */ bpatel@766: protected Content getNavShowLists(String link) { bpatel@766: Content framesContent = getHyperLink(link + "?" + path + bpatel@766: filename, "", framesLabel, "", "_top"); bpatel@766: Content li = HtmlTree.LI(framesContent); bpatel@766: return li; bpatel@766: } bpatel@766: bpatel@766: /** duke@1: * Print "FRAMES" link, to switch to the frame version of the output. duke@1: */ duke@1: protected void navShowLists() { duke@1: navShowLists(relativePath + "index.html"); duke@1: } duke@1: duke@1: /** bpatel@766: * Get "FRAMES" link, to switch to the frame version of the output. bpatel@766: * bpatel@766: * @return a content tree for the link bpatel@766: */ bpatel@766: protected Content getNavShowLists() { bpatel@766: return getNavShowLists(relativePath + "index.html"); bpatel@766: } bpatel@766: bpatel@766: /** duke@1: * Print "NO FRAMES" link, to switch to the non-frame version of the output. duke@1: * duke@1: * @param link File to be linked. duke@1: */ duke@1: protected void navHideLists(String link) { bpatel@766: print(getHyperLinkString(link, "", configuration.getText("doclet.NO_FRAMES"), duke@1: true, "", "", "_top")); duke@1: } duke@1: duke@1: /** bpatel@766: * Get "NO FRAMES" link, to switch to the non-frame version of the output. bpatel@766: * bpatel@766: * @param link File to be linked bpatel@766: * @return a content tree for the link bpatel@766: */ bpatel@766: protected Content getNavHideLists(String link) { bpatel@766: Content noFramesContent = getHyperLink(link, "", noframesLabel, "", "_top"); bpatel@766: Content li = HtmlTree.LI(noFramesContent); bpatel@766: return li; bpatel@766: } bpatel@766: bpatel@766: /** duke@1: * Print "Tree" link in the navigation bar. If there is only one package duke@1: * specified on the command line, then the "Tree" link will be to the duke@1: * only "package-tree.html" file otherwise it will be to the duke@1: * "overview-tree.html" file. duke@1: */ duke@1: protected void navLinkTree() { duke@1: navCellStart(); duke@1: PackageDoc[] packages = configuration.root.specifiedPackages(); duke@1: if (packages.length == 1 && configuration.root.specifiedClasses().length == 0) { duke@1: printHyperLink(pathString(packages[0], "package-tree.html"), "", duke@1: configuration.getText("doclet.Tree"), true, "NavBarFont1"); duke@1: } else { duke@1: printHyperLink(relativePath + "overview-tree.html", "", duke@1: configuration.getText("doclet.Tree"), true, "NavBarFont1"); duke@1: } duke@1: navCellEnd(); duke@1: } duke@1: duke@1: /** bpatel@766: * Get "Tree" link in the navigation bar. If there is only one package bpatel@766: * specified on the command line, then the "Tree" link will be to the bpatel@766: * only "package-tree.html" file otherwise it will be to the bpatel@766: * "overview-tree.html" file. bpatel@766: * bpatel@766: * @return a content tree for the link duke@1: */ bpatel@766: protected Content getNavLinkTree() { bpatel@766: Content treeLinkContent; bpatel@766: PackageDoc[] packages = configuration.root.specifiedPackages(); bpatel@766: if (packages.length == 1 && configuration.root.specifiedClasses().length == 0) { bpatel@766: treeLinkContent = getHyperLink(pathString(packages[0], bpatel@766: "package-tree.html"), "", treeLabel, bpatel@766: "", ""); bpatel@766: } else { bpatel@766: treeLinkContent = getHyperLink(relativePath + "overview-tree.html", bpatel@766: "", treeLabel, "", ""); bpatel@766: } bpatel@766: Content li = HtmlTree.LI(treeLinkContent); bpatel@766: return li; bpatel@766: } bpatel@766: bpatel@766: /** bpatel@766: * Get the overview tree link for the main tree. bpatel@766: * bpatel@766: * @param label the label for the link bpatel@766: * @return a content tree for the link bpatel@766: */ bpatel@766: protected Content getNavLinkMainTree(String label) { bpatel@766: Content mainTreeContent = getHyperLink(relativePath + "overview-tree.html", bpatel@766: new StringContent(label)); bpatel@766: Content li = HtmlTree.LI(mainTreeContent); bpatel@766: return li; duke@1: } duke@1: duke@1: /** duke@1: * Print the word "Class" in the navigation bar cell, to indicate that duke@1: * class link is not available. duke@1: */ duke@1: protected void navLinkClass() { duke@1: navCellStart(); duke@1: fontStyle("NavBarFont1"); duke@1: printText("doclet.Class"); duke@1: fontEnd(); duke@1: navCellEnd(); duke@1: } duke@1: duke@1: /** bpatel@766: * Get the word "Class", to indicate that class link is not available. bpatel@766: * bpatel@766: * @return a content tree for the link bpatel@766: */ bpatel@766: protected Content getNavLinkClass() { bpatel@766: Content li = HtmlTree.LI(classLabel); bpatel@766: return li; bpatel@766: } bpatel@766: bpatel@766: /** duke@1: * Print "Deprecated" API link in the navigation bar. duke@1: */ duke@1: protected void navLinkDeprecated() { duke@1: navCellStart(); duke@1: printHyperLink(relativePath + "deprecated-list.html", "", duke@1: configuration.getText("doclet.navDeprecated"), true, "NavBarFont1"); duke@1: navCellEnd(); duke@1: } duke@1: duke@1: /** bpatel@766: * Get "Deprecated" API link in the navigation bar. bpatel@766: * bpatel@766: * @return a content tree for the link bpatel@766: */ bpatel@766: protected Content getNavLinkDeprecated() { bpatel@766: Content linkContent = getHyperLink(relativePath + bpatel@766: "deprecated-list.html", "", deprecatedLabel, "", ""); bpatel@766: Content li = HtmlTree.LI(linkContent); bpatel@766: return li; bpatel@766: } bpatel@766: bpatel@766: /** duke@1: * Print link for generated index. If the user has used "-splitindex" duke@1: * command line option, then link to file "index-files/index-1.html" is duke@1: * generated otherwise link to file "index-all.html" is generated. duke@1: */ duke@1: protected void navLinkClassIndex() { duke@1: printNoFramesTargetHyperLink(relativePath + duke@1: AllClassesFrameWriter.OUTPUT_FILE_NAME_NOFRAMES, duke@1: "", "", configuration.getText("doclet.All_Classes"), true); duke@1: } bpatel@766: bpatel@766: /** bpatel@766: * Get link for generated index. If the user has used "-splitindex" bpatel@766: * command line option, then link to file "index-files/index-1.html" is bpatel@766: * generated otherwise link to file "index-all.html" is generated. bpatel@766: * bpatel@766: * @return a content tree for the link bpatel@766: */ bpatel@766: protected Content getNavLinkClassIndex() { bpatel@766: Content allClassesContent = getHyperLink(relativePath + bpatel@766: AllClassesFrameWriter.OUTPUT_FILE_NAME_NOFRAMES, "", bpatel@766: allclassesLabel, "", ""); bpatel@766: Content li = HtmlTree.LI(allClassesContent); bpatel@766: return li; bpatel@766: } duke@1: /** duke@1: * Print link for generated class index. duke@1: */ duke@1: protected void navLinkIndex() { duke@1: navCellStart(); duke@1: printHyperLink(relativePath + duke@1: (configuration.splitindex? duke@1: DirectoryManager.getPath("index-files") + duke@1: fileseparator: "") + duke@1: (configuration.splitindex? duke@1: "index-1.html" : "index-all.html"), "", duke@1: configuration.getText("doclet.Index"), true, "NavBarFont1"); duke@1: navCellEnd(); duke@1: } duke@1: duke@1: /** bpatel@766: * Get link for generated class index. bpatel@766: * bpatel@766: * @return a content tree for the link bpatel@766: */ bpatel@766: protected Content getNavLinkIndex() { bpatel@766: Content linkContent = getHyperLink(relativePath +(configuration.splitindex? bpatel@766: DirectoryManager.getPath("index-files") + fileseparator: "") + bpatel@766: (configuration.splitindex?"index-1.html" : "index-all.html"), "", bpatel@766: indexLabel, "", ""); bpatel@766: Content li = HtmlTree.LI(linkContent); bpatel@766: return li; bpatel@766: } bpatel@766: bpatel@766: /** duke@1: * Print help file link. If user has provided a help file, then generate a duke@1: * link to the user given file, which is already copied to current or duke@1: * destination directory. duke@1: */ duke@1: protected void navLinkHelp() { duke@1: String helpfilenm = configuration.helpfile; duke@1: if (helpfilenm.equals("")) { duke@1: helpfilenm = "help-doc.html"; duke@1: } else { duke@1: int lastsep; duke@1: if ((lastsep = helpfilenm.lastIndexOf(File.separatorChar)) != -1) { duke@1: helpfilenm = helpfilenm.substring(lastsep + 1); duke@1: } duke@1: } duke@1: navCellStart(); duke@1: printHyperLink(relativePath + helpfilenm, "", duke@1: configuration.getText("doclet.Help"), true, "NavBarFont1"); duke@1: navCellEnd(); duke@1: } duke@1: duke@1: /** bpatel@766: * Get help file link. If user has provided a help file, then generate a bpatel@766: * link to the user given file, which is already copied to current or bpatel@766: * destination directory. bpatel@766: * bpatel@766: * @return a content tree for the link bpatel@766: */ bpatel@766: protected Content getNavLinkHelp() { bpatel@766: String helpfilenm = configuration.helpfile; bpatel@766: if (helpfilenm.equals("")) { bpatel@766: helpfilenm = "help-doc.html"; bpatel@766: } else { bpatel@766: int lastsep; bpatel@766: if ((lastsep = helpfilenm.lastIndexOf(File.separatorChar)) != -1) { bpatel@766: helpfilenm = helpfilenm.substring(lastsep + 1); bpatel@766: } bpatel@766: } bpatel@766: Content linkContent = getHyperLink(relativePath + helpfilenm, "", bpatel@766: helpLabel, "", ""); bpatel@766: Content li = HtmlTree.LI(linkContent); bpatel@766: return li; bpatel@766: } bpatel@766: bpatel@766: /** duke@1: * Print the word "Detail" in the navigation bar. No link is available. duke@1: */ duke@1: protected void navDetail() { duke@1: printText("doclet.Detail"); duke@1: } duke@1: duke@1: /** duke@1: * Print the word "Summary" in the navigation bar. No link is available. duke@1: */ duke@1: protected void navSummary() { duke@1: printText("doclet.Summary"); duke@1: } duke@1: duke@1: /** duke@1: * Print the Html table tag for the index summary tables. The table tag duke@1: * printed is jjg@1326: * {@code