jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/formats/html/AllClassesFrameWriter.java@905e151a185a (annotated)

src/share/classes/com/sun/tools/doclets/formats/html/AllClassesFrameWriter.java@905e151a185a (annotated)

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

Tue, 13 Jan 2009 13:27:14 +0000

author: mcimadamore
date: Tue, 13 Jan 2009 13:27:14 +0000
changeset 184: 905e151a185a
parent 182: 47a62d8d98b4
child 554: 9d9f26857129
permissions: -rw-r--r--

6765045: Remove rawtypes warnings from langtools
Summary: Removed all occurrences of rawtypes warnings from langtools
Reviewed-by: jjg, bpatel

 /*
  * Copyright 1998-2003 Sun Microsystems, Inc.  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.  Sun designates this
  * particular file as subject to the "Classpath" exception as provided
  * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  * CA 95054 USA or visit www.sun.com if you need additional information or
  * have any questions.
  */
 package com.sun.tools.doclets.formats.html;
 import com.sun.tools.doclets.internal.toolkit.util.*;
 import com.sun.javadoc.*;
 import java.io.*;
 import java.util.*;
 /**
  * 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".
  *
  * @author Atul M Dambalkar
  * @author Doug Kramer
  */
 public class AllClassesFrameWriter extends HtmlDocletWriter {
     /**
      * The name of the output file with frames
      */
     public static final String OUTPUT_FILE_NAME_FRAMES = "allclasses-frame.html";
     /**
      * The name of the output file without frames
      */
     public static final String OUTPUT_FILE_NAME_NOFRAMES = "allclasses-noframe.html";
     /**
      * Index of all the classes.
      */
     protected IndexBuilder indexbuilder;
     /**
      * Construct AllClassesFrameWriter object. Also initilises the indexbuilder
      * variable in this class.
      * @throws IOException
      * @throws DocletAbortException
      */
     public AllClassesFrameWriter(ConfigurationImpl configuration,
                                  String filename, IndexBuilder indexbuilder)
                               throws IOException {
         super(configuration, filename);
         this.indexbuilder = indexbuilder;
     }
     /**
      * Create AllClassesFrameWriter object. Then use it to generate the
      * "allclasses-frame.html" file. Generate the file in the current or the
      * destination directory.
      *
      * @param indexbuilder IndexBuilder object for all classes index.
      * @throws DocletAbortException
      */
     public static void generate(ConfigurationImpl configuration,
                                 IndexBuilder indexbuilder) {
         AllClassesFrameWriter allclassgen;
         String filename = OUTPUT_FILE_NAME_FRAMES;
         try {
             allclassgen = new AllClassesFrameWriter(configuration,
                                                     filename, indexbuilder);
             allclassgen.generateAllClassesFile(true);
             allclassgen.close();
             filename = OUTPUT_FILE_NAME_NOFRAMES;
             allclassgen = new AllClassesFrameWriter(configuration,
                                                     filename, indexbuilder);
             allclassgen.generateAllClassesFile(false);
             allclassgen.close();
         } catch (IOException exc) {
             configuration.standardmessage.
                      error("doclet.exception_encountered",
                            exc.toString(), filename);
             throw new DocletAbortException();
         }
     }
     /**
      * Print all the classes in table format in the file.
      * @param wantFrames True if we want frames.
      */
     protected void generateAllClassesFile(boolean wantFrames) throws IOException {
         String label = configuration.getText("doclet.All_Classes");
         printHtmlHeader(label, null, false);
         printAllClassesTableHeader();
         printAllClasses(wantFrames);
         printAllClassesTableFooter();
         printBodyHtmlEnd();
     }
     /**
      * Use the sorted index of all the classes and print all the classes.
      *
      * @param wantFrames True if we want frames.
      */
     protected void printAllClasses(boolean wantFrames) {
         for (int i = 0; i < indexbuilder.elements().length; i++) {
             Character unicode = (Character)((indexbuilder.elements())[i]);
             generateContents(indexbuilder.getMemberList(unicode), wantFrames);
         }
     }
     /**
      * 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.
      *
      * @param classlist Sorted list of classes.
      * @param wantFrames True if we want frames.
      */
     protected void generateContents(List<Doc> classlist, boolean wantFrames) {
         for (int i = 0; i < classlist.size(); i++) {
             ClassDoc cd = (ClassDoc)classlist.get(i);
             if (!Util.isCoreClass(cd)) {
                 continue;
             }
             String label = italicsClassName(cd, false);
             if(wantFrames){
                 printLink(new LinkInfoImpl(LinkInfoImpl.ALL_CLASSES_FRAME, cd,
                     label, "classFrame")
                 );
             } else {
                 printLink(new LinkInfoImpl(cd, label));
             }
             br();
         }
     }
     /**
      * Print the heading "All Classes" and also print Html table tag.
      */
     protected void printAllClassesTableHeader() {
         fontSizeStyle("+1", "FrameHeadingFont");
         strongText("doclet.All_Classes");
         fontEnd();
         br();
         table();
         tr();
         tdNowrap();
         fontStyle("FrameItemFont");
     }
     /**
      * Print Html closing table tag.
      */
     protected void printAllClassesTableFooter() {
         fontEnd();
         tdEnd();
         trEnd();
         tableEnd();
     }
 }

Mercurial > jdk8-mips64-public > langtools / annotate

src/share/classes/com/sun/tools/doclets/formats/html/AllClassesFrameWriter.java@905e151a185a (annotated)

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