jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/formats/html/HelpWriter.java@0e6577980181 (annotated)

src/share/classes/com/sun/tools/doclets/formats/html/HelpWriter.java@0e6577980181 (annotated)

src/share/classes/com/sun/tools/doclets/formats/html/HelpWriter.java

Thu, 29 Aug 2013 11:41:20 -0700

author: jjg
date: Thu, 29 Aug 2013 11:41:20 -0700
changeset 1985: 0e6577980181
parent 1936: 33294f02c9a5
child 2147: 130b8c0e570e
permissions: -rw-r--r--

8001669: javadoc internal DocletAbortException should set cause when appropriate
Reviewed-by: darcy

 /*
  * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
  * under the terms of the GNU General Public License version 2 only, as
  * published by the Free Software Foundation.  Oracle designates this
  * particular file as subject to the "Classpath" exception as provided
  * by Oracle in the LICENSE file that accompanied this code.
  *
  * This code is distributed in the hope that it will be useful, but WITHOUT
  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * version 2 for more details (a copy is included in the LICENSE file that
  * accompanied this code).
  *
  * You should have received a copy of the GNU General Public License version
  * 2 along with this work; if not, write to the Free Software Foundation,
  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  *
  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  * or visit www.oracle.com if you need additional information or have any
  * questions.
  */
 package com.sun.tools.doclets.formats.html;
 import java.io.*;
 import com.sun.tools.doclets.formats.html.markup.*;
 import com.sun.tools.doclets.internal.toolkit.*;
 import com.sun.tools.doclets.internal.toolkit.util.*;
 /**
  * Generate the Help File for the generated API documentation. The help file
  * contents are helpful for browsing the generated documentation.
  *
  *  <p><b>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.</b>
  *
  * @author Atul M Dambalkar
  */
 public class HelpWriter extends HtmlDocletWriter {
     /**
      * Constructor to construct HelpWriter object.
      * @param filename File to be generated.
      */
     public HelpWriter(ConfigurationImpl configuration,
                       DocPath filename) throws IOException {
         super(configuration, filename);
     }
     /**
      * Construct the HelpWriter object and then use it to generate the help
      * file. The name of the generated file is "help-doc.html". The help file
      * will get generated if and only if "-helpfile" and "-nohelp" is not used
      * on the command line.
      * @throws DocletAbortException
      */
     public static void generate(ConfigurationImpl configuration) {
         HelpWriter helpgen;
         DocPath filename = DocPath.empty;
         try {
             filename = DocPaths.HELP_DOC;
             helpgen = new HelpWriter(configuration, filename);
             helpgen.generateHelpFile();
             helpgen.close();
         } catch (IOException exc) {
             configuration.standardmessage.error(
                         "doclet.exception_encountered",
                         exc.toString(), filename);
             throw new DocletAbortException(exc);
         }
     }
     /**
      * Generate the help file contents.
      */
     protected void generateHelpFile() throws IOException {
         String title = configuration.getText("doclet.Window_Help_title");
         Content body = getBody(true, getWindowTitle(title));
         addTop(body);
         addNavLinks(true, body);
         addHelpFileContents(body);
         addNavLinks(false, body);
         addBottom(body);
         printHtmlDocument(null, true, body);
     }
     /**
      * Add the help file contents from the resource file to the content tree. While adding the
      * help file contents it also keeps track of user options. If "-notree"
      * is used, then the "overview-tree.html" will not get added and hence
      * help information also will not get added.
      *
      * @param contentTree the content tree to which the help file contents will be added
      */
     protected void addHelpFileContents(Content contentTree) {
         Content heading = HtmlTree.HEADING(HtmlConstants.TITLE_HEADING, false, HtmlStyle.title,
                 getResource("doclet.Help_line_1"));
         Content div = HtmlTree.DIV(HtmlStyle.header, heading);
         Content line2 = HtmlTree.DIV(HtmlStyle.subTitle,
                 getResource("doclet.Help_line_2"));
         div.addContent(line2);
         contentTree.addContent(div);
         HtmlTree ul = new HtmlTree(HtmlTag.UL);
         ul.addStyle(HtmlStyle.blockList);
         if (configuration.createoverview) {
             Content overviewHeading = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
                 getResource("doclet.Overview"));
             Content liOverview = HtmlTree.LI(HtmlStyle.blockList, overviewHeading);
             Content line3 = getResource("doclet.Help_line_3",
                     getHyperLink(DocPaths.OVERVIEW_SUMMARY,
                     configuration.getText("doclet.Overview")));
             Content overviewPara = HtmlTree.P(line3);
             liOverview.addContent(overviewPara);
             ul.addContent(liOverview);
         }
         Content packageHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
                 getResource("doclet.Package"));
         Content liPackage = HtmlTree.LI(HtmlStyle.blockList, packageHead);
         Content line4 = getResource("doclet.Help_line_4");
         Content packagePara = HtmlTree.P(line4);
         liPackage.addContent(packagePara);
         HtmlTree ulPackage = new HtmlTree(HtmlTag.UL);
         ulPackage.addContent(HtmlTree.LI(
                 getResource("doclet.Interfaces_Italic")));
         ulPackage.addContent(HtmlTree.LI(
                 getResource("doclet.Classes")));
         ulPackage.addContent(HtmlTree.LI(
                 getResource("doclet.Enums")));
         ulPackage.addContent(HtmlTree.LI(
                 getResource("doclet.Exceptions")));
         ulPackage.addContent(HtmlTree.LI(
                 getResource("doclet.Errors")));
         ulPackage.addContent(HtmlTree.LI(
                 getResource("doclet.AnnotationTypes")));
         liPackage.addContent(ulPackage);
         ul.addContent(liPackage);
         Content classHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
                 getResource("doclet.Help_line_5"));
         Content liClass = HtmlTree.LI(HtmlStyle.blockList, classHead);
         Content line6 = getResource("doclet.Help_line_6");
         Content classPara = HtmlTree.P(line6);
         liClass.addContent(classPara);
         HtmlTree ul1 = new HtmlTree(HtmlTag.UL);
         ul1.addContent(HtmlTree.LI(
                 getResource("doclet.Help_line_7")));
         ul1.addContent(HtmlTree.LI(
                 getResource("doclet.Help_line_8")));
         ul1.addContent(HtmlTree.LI(
                 getResource("doclet.Help_line_9")));
         ul1.addContent(HtmlTree.LI(
                 getResource("doclet.Help_line_10")));
         ul1.addContent(HtmlTree.LI(
                 getResource("doclet.Help_line_11")));
         ul1.addContent(HtmlTree.LI(
                 getResource("doclet.Help_line_12")));
         liClass.addContent(ul1);
         HtmlTree ul2 = new HtmlTree(HtmlTag.UL);
         ul2.addContent(HtmlTree.LI(
                 getResource("doclet.Nested_Class_Summary")));
         ul2.addContent(HtmlTree.LI(
                 getResource("doclet.Field_Summary")));
         ul2.addContent(HtmlTree.LI(
                 getResource("doclet.Constructor_Summary")));
         ul2.addContent(HtmlTree.LI(
                 getResource("doclet.Method_Summary")));
         liClass.addContent(ul2);
         HtmlTree ul3 = new HtmlTree(HtmlTag.UL);
         ul3.addContent(HtmlTree.LI(
                 getResource("doclet.Field_Detail")));
         ul3.addContent(HtmlTree.LI(
                 getResource("doclet.Constructor_Detail")));
         ul3.addContent(HtmlTree.LI(
                 getResource("doclet.Method_Detail")));
         liClass.addContent(ul3);
         Content line13 = getResource("doclet.Help_line_13");
         Content para = HtmlTree.P(line13);
         liClass.addContent(para);
         ul.addContent(liClass);
         //Annotation Types
         Content aHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
                 getResource("doclet.AnnotationType"));
         Content liAnnotation = HtmlTree.LI(HtmlStyle.blockList, aHead);
         Content aline1 = getResource("doclet.Help_annotation_type_line_1");
         Content aPara = HtmlTree.P(aline1);
         liAnnotation.addContent(aPara);
         HtmlTree aul = new HtmlTree(HtmlTag.UL);
         aul.addContent(HtmlTree.LI(
                 getResource("doclet.Help_annotation_type_line_2")));
         aul.addContent(HtmlTree.LI(
                 getResource("doclet.Help_annotation_type_line_3")));
         aul.addContent(HtmlTree.LI(
                 getResource("doclet.Annotation_Type_Required_Member_Summary")));
         aul.addContent(HtmlTree.LI(
                 getResource("doclet.Annotation_Type_Optional_Member_Summary")));
         aul.addContent(HtmlTree.LI(
                 getResource("doclet.Annotation_Type_Member_Detail")));
         liAnnotation.addContent(aul);
         ul.addContent(liAnnotation);
         //Enums
         Content enumHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
                 getResource("doclet.Enum"));
         Content liEnum = HtmlTree.LI(HtmlStyle.blockList, enumHead);
         Content eline1 = getResource("doclet.Help_enum_line_1");
         Content enumPara = HtmlTree.P(eline1);
         liEnum.addContent(enumPara);
         HtmlTree eul = new HtmlTree(HtmlTag.UL);
         eul.addContent(HtmlTree.LI(
                 getResource("doclet.Help_enum_line_2")));
         eul.addContent(HtmlTree.LI(
                 getResource("doclet.Help_enum_line_3")));
         eul.addContent(HtmlTree.LI(
                 getResource("doclet.Enum_Constant_Summary")));
         eul.addContent(HtmlTree.LI(
                 getResource("doclet.Enum_Constant_Detail")));
         liEnum.addContent(eul);
         ul.addContent(liEnum);
         if (configuration.classuse) {
             Content useHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
                     getResource("doclet.Help_line_14"));
             Content liUse = HtmlTree.LI(HtmlStyle.blockList, useHead);
             Content line15 = getResource("doclet.Help_line_15");
             Content usePara = HtmlTree.P(line15);
             liUse.addContent(usePara);
             ul.addContent(liUse);
         }
         if (configuration.createtree) {
             Content treeHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
                     getResource("doclet.Help_line_16"));
             Content liTree = HtmlTree.LI(HtmlStyle.blockList, treeHead);
             Content line17 = getResource("doclet.Help_line_17_with_tree_link",
                     getHyperLink(DocPaths.OVERVIEW_TREE,
                     configuration.getText("doclet.Class_Hierarchy")),
                     HtmlTree.CODE(new StringContent("java.lang.Object")));
             Content treePara = HtmlTree.P(line17);
             liTree.addContent(treePara);
             HtmlTree tul = new HtmlTree(HtmlTag.UL);
             tul.addContent(HtmlTree.LI(
                     getResource("doclet.Help_line_18")));
             tul.addContent(HtmlTree.LI(
                     getResource("doclet.Help_line_19")));
             liTree.addContent(tul);
             ul.addContent(liTree);
         }
         if (!(configuration.nodeprecatedlist ||
                   configuration.nodeprecated)) {
             Content dHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
                     getResource("doclet.Deprecated_API"));
             Content liDeprecated = HtmlTree.LI(HtmlStyle.blockList, dHead);
             Content line20 = getResource("doclet.Help_line_20_with_deprecated_api_link",
                     getHyperLink(DocPaths.DEPRECATED_LIST,
                     configuration.getText("doclet.Deprecated_API")));
             Content dPara = HtmlTree.P(line20);
             liDeprecated.addContent(dPara);
             ul.addContent(liDeprecated);
         }
         if (configuration.createindex) {
             Content indexlink;
             if (configuration.splitindex) {
                 indexlink = getHyperLink(DocPaths.INDEX_FILES.resolve(DocPaths.indexN(1)),
                         configuration.getText("doclet.Index"));
             } else {
                 indexlink = getHyperLink(DocPaths.INDEX_ALL,
                         configuration.getText("doclet.Index"));
             }
             Content indexHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
                     getResource("doclet.Help_line_21"));
             Content liIndex = HtmlTree.LI(HtmlStyle.blockList, indexHead);
             Content line22 = getResource("doclet.Help_line_22", indexlink);
             Content indexPara = HtmlTree.P(line22);
             liIndex.addContent(indexPara);
             ul.addContent(liIndex);
         }
         Content prevHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
                 getResource("doclet.Help_line_23"));
         Content liPrev = HtmlTree.LI(HtmlStyle.blockList, prevHead);
         Content line24 = getResource("doclet.Help_line_24");
         Content prevPara = HtmlTree.P(line24);
         liPrev.addContent(prevPara);
         ul.addContent(liPrev);
         Content frameHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
                 getResource("doclet.Help_line_25"));
         Content liFrame = HtmlTree.LI(HtmlStyle.blockList, frameHead);
         Content line26 = getResource("doclet.Help_line_26");
         Content framePara = HtmlTree.P(line26);
         liFrame.addContent(framePara);
         ul.addContent(liFrame);
         Content allclassesHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
                 getResource("doclet.All_Classes"));
         Content liAllClasses = HtmlTree.LI(HtmlStyle.blockList, allclassesHead);
         Content line27 = getResource("doclet.Help_line_27",
                 getHyperLink(DocPaths.ALLCLASSES_NOFRAME,
                 configuration.getText("doclet.All_Classes")));
         Content allclassesPara = HtmlTree.P(line27);
         liAllClasses.addContent(allclassesPara);
         ul.addContent(liAllClasses);
         Content sHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
                 getResource("doclet.Serialized_Form"));
         Content liSerial = HtmlTree.LI(HtmlStyle.blockList, sHead);
         Content line28 = getResource("doclet.Help_line_28");
         Content serialPara = HtmlTree.P(line28);
         liSerial.addContent(serialPara);
         ul.addContent(liSerial);
         Content constHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
                 getResource("doclet.Constants_Summary"));
         Content liConst = HtmlTree.LI(HtmlStyle.blockList, constHead);
         Content line29 = getResource("doclet.Help_line_29",
                 getHyperLink(DocPaths.CONSTANT_VALUES,
                 configuration.getText("doclet.Constants_Summary")));
         Content constPara = HtmlTree.P(line29);
         liConst.addContent(constPara);
         ul.addContent(liConst);
         Content divContent = HtmlTree.DIV(HtmlStyle.contentContainer, ul);
         Content line30 = HtmlTree.SPAN(HtmlStyle.italic, getResource("doclet.Help_line_30"));
         divContent.addContent(line30);
         contentTree.addContent(divContent);
     }
     /**
      * Get the help label.
      *
      * @return a content tree for the help label
      */
     @Override
     protected Content getNavLinkHelp() {
         Content li = HtmlTree.LI(HtmlStyle.navBarCell1Rev, helpLabel);
         return li;
     }
 }

Mercurial > jdk8-mips64-public > langtools / annotate

src/share/classes/com/sun/tools/doclets/formats/html/HelpWriter.java@0e6577980181 (annotated)

src/share/classes/com/sun/tools/doclets/formats/html/HelpWriter.java